Merge upstream/main

Author: forest-benchling

CHANGELOG.md

@@ -21,6 +21,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Attempt to detect and alert users if they are using an unsupported version of OpenAPI (#281).
 - Fixes `Enum` deserialization when the value is `UNSET`.
 - Add handling of application/vnd.api+json media type.
+- Support passing models into query parameters (#316). Thanks @forest-benchling!
 
 ### Changes
 

end_to_end_tests/golden-record-custom/custom_e2e/api/tests/defaults_tests_defaults_post.py

@@ -55,6 +55,7 @@ def httpx_request(
     union_prop_with_ref: Union[AnEnum, Unset, float] = 0.6,
     enum_prop: Union[Unset, AnEnum] = UNSET,
     model_prop: Union[Unset, ModelWithUnionProperty] = UNSET,
+    required_model_prop: ModelWithUnionProperty,
 ) -> Response[Union[None, HTTPValidationError]]:
 
     json_not_required_not_nullable_datetime_prop: Union[Unset, str] = UNSET
@@ -110,6 +111,8 @@ def httpx_request(
     if not isinstance(model_prop, Unset):
         json_model_prop = model_prop.to_dict()
 
+    json_required_model_prop = required_model_prop.to_dict()
+
     params: Dict[str, Any] = {
         "string_prop": string_prop,
         "not_required_not_nullable_datetime_prop": json_not_required_not_nullable_datetime_prop,
@@ -124,8 +127,10 @@ def httpx_request(
         "union_prop": json_union_prop,
         "union_prop_with_ref": json_union_prop_with_ref,
         "enum_prop": json_enum_prop,
-        "model_prop": json_model_prop,
     }
+    if not isinstance(json_model_prop, Unset):
+        params.update(json_model_prop)
+    params.update(json_required_model_prop)
     params = {k: v for k, v in params.items() if v is not UNSET and v is not None}
 
     response = client.request(

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

@@ -28,6 +28,7 @@ def _get_kwargs(
     union_prop_with_ref: Union[AnEnum, Unset, float] = 0.6,
     enum_prop: Union[Unset, AnEnum] = UNSET,
     model_prop: Union[Unset, ModelWithUnionProperty] = UNSET,
+    required_model_prop: ModelWithUnionProperty,
 ) -> Dict[str, Any]:
     url = "{}/tests/defaults".format(client.base_url)
 
@@ -86,6 +87,8 @@ def _get_kwargs(
     if not isinstance(model_prop, Unset):
         json_model_prop = model_prop.to_dict()
 
+    json_required_model_prop = required_model_prop.to_dict()
+
     params: Dict[str, Any] = {
         "string_prop": string_prop,
         "not_required_not_nullable_datetime_prop": json_not_required_not_nullable_datetime_prop,
@@ -100,8 +103,10 @@ def _get_kwargs(
         "union_prop": json_union_prop,
         "union_prop_with_ref": json_union_prop_with_ref,
         "enum_prop": json_enum_prop,
-        "model_prop": json_model_prop,
     }
+    if not isinstance(json_model_prop, Unset):
+        params.update(json_model_prop)
+    params.update(json_required_model_prop)
     params = {k: v for k, v in params.items() if v is not UNSET and v is not None}
 
     return {
@@ -151,6 +156,7 @@ def sync_detailed(
     union_prop_with_ref: Union[AnEnum, Unset, float] = 0.6,
     enum_prop: Union[Unset, AnEnum] = UNSET,
     model_prop: Union[Unset, ModelWithUnionProperty] = UNSET,
+    required_model_prop: ModelWithUnionProperty,
 ) -> Response[Union[None, HTTPValidationError]]:
     kwargs = _get_kwargs(
         client=client,
@@ -168,6 +174,7 @@ def sync_detailed(
         union_prop_with_ref=union_prop_with_ref,
         enum_prop=enum_prop,
         model_prop=model_prop,
+        required_model_prop=required_model_prop,
     )
 
     response = httpx.post(
@@ -194,6 +201,7 @@ def sync(
     union_prop_with_ref: Union[AnEnum, Unset, float] = 0.6,
     enum_prop: Union[Unset, AnEnum] = UNSET,
     model_prop: Union[Unset, ModelWithUnionProperty] = UNSET,
+    required_model_prop: ModelWithUnionProperty,
 ) -> Optional[Union[None, HTTPValidationError]]:
     """  """
 
@@ -213,6 +221,7 @@ def sync(
         union_prop_with_ref=union_prop_with_ref,
         enum_prop=enum_prop,
         model_prop=model_prop,
+        required_model_prop=required_model_prop,
     ).parsed
 
 
@@ -233,6 +242,7 @@ async def asyncio_detailed(
     union_prop_with_ref: Union[AnEnum, Unset, float] = 0.6,
     enum_prop: Union[Unset, AnEnum] = UNSET,
     model_prop: Union[Unset, ModelWithUnionProperty] = UNSET,
+    required_model_prop: ModelWithUnionProperty,
 ) -> Response[Union[None, HTTPValidationError]]:
     kwargs = _get_kwargs(
         client=client,
@@ -250,6 +260,7 @@ async def asyncio_detailed(
         union_prop_with_ref=union_prop_with_ref,
         enum_prop=enum_prop,
         model_prop=model_prop,
+        required_model_prop=required_model_prop,
     )
 
     async with httpx.AsyncClient() as _client:
@@ -275,6 +286,7 @@ async def asyncio(
     union_prop_with_ref: Union[AnEnum, Unset, float] = 0.6,
     enum_prop: Union[Unset, AnEnum] = UNSET,
     model_prop: Union[Unset, ModelWithUnionProperty] = UNSET,
+    required_model_prop: ModelWithUnionProperty,
 ) -> Optional[Union[None, HTTPValidationError]]:
     """  """
 
@@ -295,5 +307,6 @@ async def asyncio(
             union_prop_with_ref=union_prop_with_ref,
             enum_prop=enum_prop,
             model_prop=model_prop,
+            required_model_prop=required_model_prop,
         )
     ).parsed

end_to_end_tests/openapi.json

@@ -441,6 +441,14 @@
             },
             "name": "model_prop",
             "in": "query"
+          },
+          {
+            "required": true,
+            "schema": {
+              "$ref": "#/components/schemas/ModelWithUnionProperty"
+            },
+            "name": "required_model_prop",
+            "in": "query"
           }
         ],
         "responses": {

openapi_python_client/parser/properties/model_property.py

@@ -20,6 +20,7 @@ class ModelProperty(Property):
     _json_type_string: ClassVar[str] = "Dict[str, Any]"
 
     template: ClassVar[str] = "model_property.py.jinja"
+    json_is_dict: ClassVar[bool] = True
 
     def get_base_type_string(self, json: bool = False) -> str:
         return self.reference.class_name

openapi_python_client/parser/properties/property.py

@@ -29,6 +29,7 @@ class Property:
     python_name: str = attr.ib(init=False)
 
     template: ClassVar[Optional[str]] = None
+    json_is_dict: ClassVar[bool] = False
 
     def __attrs_post_init__(self) -> None:
         object.__setattr__(self, "python_name", utils.to_valid_python_identifier(utils.snake_case(self.name)))

openapi_python_client/templates/endpoint_macros.py.jinja

@@ -22,13 +22,26 @@ if {{ parameter.python_name }} is not UNSET:
     {% endfor %}
 params: Dict[str, Any] = {
     {% for property in endpoint.query_parameters %}
-        {% if property.template %}
+        {% if not property.json_is_dict %}
+            {% if property.template %}
     "{{ property.name }}": {{ "json_" + property.python_name }},
-        {% else %}
+            {% else %}
     "{{ property.name }}": {{ property.python_name }},
+            {% endif %}
         {% endif %}
     {% endfor %}
 }
+    {% for property in endpoint.query_parameters %}
+        {% if property.json_is_dict %}
+            {% set property_name = "json_" + property.python_name %}
+            {% if property.required and not property.nullable %}
+params.update({{ property_name }})
+            {% else %}
+if {% if not property.required %}not isinstance({{ property_name }}, Unset){% endif %}{% if not property.required and property.nullable %} and {% endif %}{% if property.nullable %}{{ property_name }} is not None{% endif %}:
+    params.update({{ property_name }})
+            {% endif %}
+        {% endif %}
+    {% endfor %}
 params = {k: v for k, v in params.items() if v is not UNSET and v is not None}
 {% endif %}
 {% endmacro %}