feat: New and improved docstrings in generated functions and classes

end_to_end_tests/custom-templates-golden-record/my_test_api_client/api/parameters/__init__.py

@@ -13,6 +13,9 @@
 class ParametersEndpoints:
     @classmethod
     def get_common_parameters_overriding_param(cls) -> types.ModuleType:
+        """
+        Test that if you have an overriding property from `PathItem` in `Operation`, it produces valid code
+        """
         return get_common_parameters_overriding_param
 
     @classmethod

end_to_end_tests/golden-record/my_test_api_client/api/default/get_common_parameters.py

@@ -44,6 +44,14 @@ def sync_detailed(
     client: Client,
     common: Union[Unset, None, str] = UNSET,
 ) -> Response[Any]:
+    """
+    Args:
+        common (Union[Unset, None, str]):
+
+    Returns:
+        Response[Any]
+    """
+
     kwargs = _get_kwargs(
         client=client,
         common=common,
@@ -62,6 +70,14 @@ async def asyncio_detailed(
     client: Client,
     common: Union[Unset, None, str] = UNSET,
 ) -> Response[Any]:
+    """
+    Args:
+        common (Union[Unset, None, str]):
+
+    Returns:
+        Response[Any]
+    """
+
     kwargs = _get_kwargs(
         client=client,
         common=common,

end_to_end_tests/golden-record/my_test_api_client/api/default/post_common_parameters.py

@@ -44,6 +44,14 @@ def sync_detailed(
     client: Client,
     common: Union[Unset, None, str] = UNSET,
 ) -> Response[Any]:
+    """
+    Args:
+        common (Union[Unset, None, str]):
+
+    Returns:
+        Response[Any]
+    """
+
     kwargs = _get_kwargs(
         client=client,
         common=common,
@@ -62,6 +70,14 @@ async def asyncio_detailed(
     client: Client,
     common: Union[Unset, None, str] = UNSET,
 ) -> Response[Any]:
+    """
+    Args:
+        common (Union[Unset, None, str]):
+
+    Returns:
+        Response[Any]
+    """
+
     kwargs = _get_kwargs(
         client=client,
         common=common,

end_to_end_tests/golden-record/my_test_api_client/api/location/get_location_query_optionality.py

@@ -68,6 +68,17 @@ def sync_detailed(
     null_not_required: Union[Unset, None, datetime.datetime] = UNSET,
     not_null_not_required: Union[Unset, None, datetime.datetime] = UNSET,
 ) -> Response[Any]:
+    """
+    Args:
+        not_null_required (datetime.datetime):
+        null_required (Union[Unset, None, datetime.datetime]):
+        null_not_required (Union[Unset, None, datetime.datetime]):
+        not_null_not_required (Union[Unset, None, datetime.datetime]):
+
+    Returns:
+        Response[Any]
+    """
+
     kwargs = _get_kwargs(
         client=client,
         not_null_required=not_null_required,
@@ -92,6 +103,17 @@ async def asyncio_detailed(
     null_not_required: Union[Unset, None, datetime.datetime] = UNSET,
     not_null_not_required: Union[Unset, None, datetime.datetime] = UNSET,
 ) -> Response[Any]:
+    """
+    Args:
+        not_null_required (datetime.datetime):
+        null_required (Union[Unset, None, datetime.datetime]):
+        null_not_required (Union[Unset, None, datetime.datetime]):
+        not_null_not_required (Union[Unset, None, datetime.datetime]):
+
+    Returns:
+        Response[Any]
+    """
+
     kwargs = _get_kwargs(
         client=client,
         not_null_required=not_null_required,

end_to_end_tests/golden-record/my_test_api_client/api/parameters/delete_common_parameters_overriding_param.py

@@ -46,6 +46,15 @@ def sync_detailed(
     client: Client,
     param_query: Union[Unset, None, str] = UNSET,
 ) -> Response[Any]:
+    """
+    Args:
+        param_path (str):
+        param_query (Union[Unset, None, str]):
+
+    Returns:
+        Response[Any]
+    """
+
     kwargs = _get_kwargs(
         param_path=param_path,
         client=client,
@@ -66,6 +75,15 @@ async def asyncio_detailed(
     client: Client,
     param_query: Union[Unset, None, str] = UNSET,
 ) -> Response[Any]:
+    """
+    Args:
+        param_path (str):
+        param_query (Union[Unset, None, str]):
+
+    Returns:
+        Response[Any]
+    """
+
     kwargs = _get_kwargs(
         param_path=param_path,
         client=client,

end_to_end_tests/golden-record/my_test_api_client/api/parameters/get_common_parameters_overriding_param.py

@@ -10,7 +10,7 @@ def _get_kwargs(
     param_path: str,
     *,
     client: Client,
-    param_query: str = "overriden_in_GET",
+    param_query: str = "overridden_in_GET",
 ) -> Dict[str, Any]:
     url = "{}/common_parameters_overriding/{param}".format(client.base_url, param=param_path)
 
@@ -44,8 +44,19 @@ def sync_detailed(
     param_path: str,
     *,
     client: Client,
-    param_query: str = "overriden_in_GET",
+    param_query: str = "overridden_in_GET",
 ) -> Response[Any]:
+    """Test that if you have an overriding property from `PathItem` in `Operation`, it produces valid code
+
+    Args:
+        param_path (str):
+        param_query (str): A parameter with the same name as another. Default:
+            'overridden_in_GET'. Example: an example string.
+
+    Returns:
+        Response[Any]
+    """
+
     kwargs = _get_kwargs(
         param_path=param_path,
         client=client,
@@ -64,8 +75,19 @@ async def asyncio_detailed(
     param_path: str,
     *,
     client: Client,
-    param_query: str = "overriden_in_GET",
+    param_query: str = "overridden_in_GET",
 ) -> Response[Any]:
+    """Test that if you have an overriding property from `PathItem` in `Operation`, it produces valid code
+
+    Args:
+        param_path (str):
+        param_query (str): A parameter with the same name as another. Default:
+            'overridden_in_GET'. Example: an example string.
+
+    Returns:
+        Response[Any]
+    """
+
     kwargs = _get_kwargs(
         param_path=param_path,
         client=client,

end_to_end_tests/golden-record/my_test_api_client/api/parameters/get_same_name_multiple_locations_param.py

@@ -56,6 +56,17 @@ def sync_detailed(
     param_header: Union[Unset, str] = UNSET,
     param_cookie: Union[Unset, str] = UNSET,
 ) -> Response[Any]:
+    """
+    Args:
+        param_path (str):
+        param_query (Union[Unset, None, str]):
+        param_header (Union[Unset, str]):
+        param_cookie (Union[Unset, str]):
+
+    Returns:
+        Response[Any]
+    """
+
     kwargs = _get_kwargs(
         param_path=param_path,
         client=client,
@@ -80,6 +91,17 @@ async def asyncio_detailed(
     param_header: Union[Unset, str] = UNSET,
     param_cookie: Union[Unset, str] = UNSET,
 ) -> Response[Any]:
+    """
+    Args:
+        param_path (str):
+        param_query (Union[Unset, None, str]):
+        param_header (Union[Unset, str]):
+        param_cookie (Union[Unset, str]):
+
+    Returns:
+        Response[Any]
+    """
+
     kwargs = _get_kwargs(
         param_path=param_path,
         client=client,

end_to_end_tests/golden-record/my_test_api_client/api/parameters/multiple_path_parameters.py

@@ -46,6 +46,17 @@ def sync_detailed(
     *,
     client: Client,
 ) -> Response[Any]:
+    """
+    Args:
+        param4 (str):
+        param2 (int):
+        param1 (str):
+        param3 (int):
+
+    Returns:
+        Response[Any]
+    """
+
     kwargs = _get_kwargs(
         param4=param4,
         param2=param2,
@@ -70,6 +81,17 @@ async def asyncio_detailed(
     *,
     client: Client,
 ) -> Response[Any]:
+    """
+    Args:
+        param4 (str):
+        param2 (int):
+        param1 (str):
+        param3 (int):
+
+    Returns:
+        Response[Any]
+    """
+
     kwargs = _get_kwargs(
         param4=param4,
         param2=param2,

end_to_end_tests/golden-record/my_test_api_client/api/tag1/get_tag_with_number.py

@@ -36,6 +36,11 @@ def sync_detailed(
     *,
     client: Client,
 ) -> Response[Any]:
+    """
+    Returns:
+        Response[Any]
+    """
+
     kwargs = _get_kwargs(
         client=client,
     )
@@ -52,6 +57,11 @@ async def asyncio_detailed(
     *,
     client: Client,
 ) -> Response[Any]:
+    """
+    Returns:
+        Response[Any]
+    """
+
     kwargs = _get_kwargs(
         client=client,
     )

end_to_end_tests/golden-record/my_test_api_client/api/tests/defaults_tests_defaults_post.py

@@ -119,6 +119,25 @@ def sync_detailed(
     model_prop: ModelWithUnionProperty,
     required_model_prop: ModelWithUnionProperty,
 ) -> Response[Union[Any, HTTPValidationError]]:
+    """Defaults
+
+    Args:
+        string_prop (str):  Default: 'the default string'.
+        date_prop (datetime.date):  Default: isoparse('1010-10-10').date().
+        float_prop (float):  Default: 3.14.
+        int_prop (int):  Default: 7.
+        boolean_prop (bool):
+        list_prop (List[AnEnum]):
+        union_prop (Union[float, str]):  Default: 'not a float'.
+        union_prop_with_ref (Union[AnEnum, None, Unset, float]):  Default: 0.6.
+        enum_prop (AnEnum): For testing Enums in all the ways they can be used
+        model_prop (ModelWithUnionProperty):
+        required_model_prop (ModelWithUnionProperty):
+
+    Returns:
+        Response[Union[Any, HTTPValidationError]]
+    """
+
     kwargs = _get_kwargs(
         client=client,
         string_prop=string_prop,
@@ -157,7 +176,24 @@ def sync(
     model_prop: ModelWithUnionProperty,
     required_model_prop: ModelWithUnionProperty,
 ) -> Optional[Union[Any, HTTPValidationError]]:
-    """ """
+    """Defaults
+
+    Args:
+        string_prop (str):  Default: 'the default string'.
+        date_prop (datetime.date):  Default: isoparse('1010-10-10').date().
+        float_prop (float):  Default: 3.14.
+        int_prop (int):  Default: 7.
+        boolean_prop (bool):
+        list_prop (List[AnEnum]):
+        union_prop (Union[float, str]):  Default: 'not a float'.
+        union_prop_with_ref (Union[AnEnum, None, Unset, float]):  Default: 0.6.
+        enum_prop (AnEnum): For testing Enums in all the ways they can be used
+        model_prop (ModelWithUnionProperty):
+        required_model_prop (ModelWithUnionProperty):
+
+    Returns:
+        Response[Union[Any, HTTPValidationError]]
+    """
 
     return sync_detailed(
         client=client,
@@ -190,6 +226,25 @@ async def asyncio_detailed(
     model_prop: ModelWithUnionProperty,
     required_model_prop: ModelWithUnionProperty,
 ) -> Response[Union[Any, HTTPValidationError]]:
+    """Defaults
+
+    Args:
+        string_prop (str):  Default: 'the default string'.
+        date_prop (datetime.date):  Default: isoparse('1010-10-10').date().
+        float_prop (float):  Default: 3.14.
+        int_prop (int):  Default: 7.
+        boolean_prop (bool):
+        list_prop (List[AnEnum]):
+        union_prop (Union[float, str]):  Default: 'not a float'.
+        union_prop_with_ref (Union[AnEnum, None, Unset, float]):  Default: 0.6.
+        enum_prop (AnEnum): For testing Enums in all the ways they can be used
+        model_prop (ModelWithUnionProperty):
+        required_model_prop (ModelWithUnionProperty):
+
+    Returns:
+        Response[Union[Any, HTTPValidationError]]
+    """
+
     kwargs = _get_kwargs(
         client=client,
         string_prop=string_prop,
@@ -226,7 +281,24 @@ async def asyncio(
     model_prop: ModelWithUnionProperty,
     required_model_prop: ModelWithUnionProperty,
 ) -> Optional[Union[Any, HTTPValidationError]]:
-    """ """
+    """Defaults
+
+    Args:
+        string_prop (str):  Default: 'the default string'.
+        date_prop (datetime.date):  Default: isoparse('1010-10-10').date().
+        float_prop (float):  Default: 3.14.
+        int_prop (int):  Default: 7.
+        boolean_prop (bool):
+        list_prop (List[AnEnum]):
+        union_prop (Union[float, str]):  Default: 'not a float'.
+        union_prop_with_ref (Union[AnEnum, None, Unset, float]):  Default: 0.6.
+        enum_prop (AnEnum): For testing Enums in all the ways they can be used
+        model_prop (ModelWithUnionProperty):
+        required_model_prop (ModelWithUnionProperty):
+
+    Returns:
+        Response[Union[Any, HTTPValidationError]]
+    """
 
     return (
         await asyncio_detailed(