fix: Include JSON body parameters in docstrings when that's the only param.

Author: dbanty

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

@@ -59,6 +59,9 @@ def sync_detailed(
 
      Try sending a JSON body
 
+    Args:
+        json_body (AModel): A Model for testing all the ways custom objects can be used
+
     Returns:
         Response[Union[Any, HTTPValidationError]]
     """
@@ -85,6 +88,9 @@ def sync(
 
      Try sending a JSON body
 
+    Args:
+        json_body (AModel): A Model for testing all the ways custom objects can be used
+
     Returns:
         Response[Union[Any, HTTPValidationError]]
     """
@@ -104,6 +110,9 @@ async def asyncio_detailed(
 
      Try sending a JSON body
 
+    Args:
+        json_body (AModel): A Model for testing all the ways custom objects can be used
+
     Returns:
         Response[Union[Any, HTTPValidationError]]
     """
@@ -128,6 +137,9 @@ async def asyncio(
 
      Try sending a JSON body
 
+    Args:
+        json_body (AModel): A Model for testing all the ways custom objects can be used
+
     Returns:
         Response[Union[Any, HTTPValidationError]]
     """

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

@@ -55,6 +55,9 @@ def sync_detailed(
 ) -> Response[Union[HTTPValidationError, str]]:
     """Json Body Which is String
 
+    Args:
+        json_body (str):
+
     Returns:
         Response[Union[HTTPValidationError, str]]
     """
@@ -79,6 +82,9 @@ def sync(
 ) -> Optional[Union[HTTPValidationError, str]]:
     """Json Body Which is String
 
+    Args:
+        json_body (str):
+
     Returns:
         Response[Union[HTTPValidationError, str]]
     """
@@ -96,6 +102,9 @@ async def asyncio_detailed(
 ) -> Response[Union[HTTPValidationError, str]]:
     """Json Body Which is String
 
+    Args:
+        json_body (str):
+
     Returns:
         Response[Union[HTTPValidationError, str]]
     """
@@ -118,6 +127,9 @@ async def asyncio(
 ) -> Optional[Union[HTTPValidationError, str]]:
     """Json Body Which is String
 
+    Args:
+        json_body (str):
+
     Returns:
         Response[Union[HTTPValidationError, str]]
     """

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

@@ -53,6 +53,9 @@ def sync_detailed(
 ) -> Response[TestInlineObjectsResponse200]:
     """Test Inline Objects
 
+    Args:
+        json_body (TestInlineObjectsJsonBody):
+
     Returns:
         Response[TestInlineObjectsResponse200]
     """
@@ -77,6 +80,9 @@ def sync(
 ) -> Optional[TestInlineObjectsResponse200]:
     """Test Inline Objects
 
+    Args:
+        json_body (TestInlineObjectsJsonBody):
+
     Returns:
         Response[TestInlineObjectsResponse200]
     """
@@ -94,6 +100,9 @@ async def asyncio_detailed(
 ) -> Response[TestInlineObjectsResponse200]:
     """Test Inline Objects
 
+    Args:
+        json_body (TestInlineObjectsJsonBody):
+
     Returns:
         Response[TestInlineObjectsResponse200]
     """
@@ -116,6 +125,9 @@ async def asyncio(
 ) -> Optional[TestInlineObjectsResponse200]:
     """Test Inline Objects
 
+    Args:
+        json_body (TestInlineObjectsJsonBody):
+
     Returns:
         Response[TestInlineObjectsResponse200]
     """

openapi_python_client/parser/openapi.py

@@ -416,7 +416,7 @@ def response_type(self) -> str:
             return self.responses[0].prop.get_type_string()
         return f"Union[{', '.join(types)}]"
 
-    def all_parameters(self) -> Iterator[Property]:
+    def iter_all_parameters(self) -> Iterator[Property]:
         """Iterate through all the parameters of this endpoint"""
         yield from self.path_parameters.values()
         yield from self.query_parameters.values()
@@ -427,6 +427,10 @@ def all_parameters(self) -> Iterator[Property]:
         if self.json_body:
             yield self.json_body
 
+    def list_all_parameters(self) -> List[Property]:
+        """Return a List of all the parameters of this endpoint"""
+        return list(self.iter_all_parameters())
+
 
 @dataclass
 class GeneratorData:

openapi_python_client/templates/endpoint_macros.py.jinja

@@ -159,9 +159,10 @@ json_body=json_body,
 {# Leave extra space so that Args or Returns isn't at the top #}
 
 {% endif %}
-{% if endpoint.path_parameters or endpoint.query_parameters or endpoint.header_parameters or endpoint.cookie_parameters %}
+{% set all_parameters = endpoint.list_all_parameters() %}
+{% if all_parameters %}
 Args:
-    {% for parameter in endpoint.all_parameters() %}
+    {% for parameter in all_parameters %}
     {{ parameter.to_docstring() | wordwrap(90) | indent(8) }}
     {% endfor %}