feat: Added support for text/yaml in OpenAPI to be used in benchling-api-client BNCH-37249

Author: Alfonso Tankia

end_to_end_tests/golden-record-custom/pyproject.toml

@@ -14,8 +14,8 @@ include = ["CHANGELOG.md", "custom_e2e/py.typed"]
 
 [tool.poetry.dependencies]
 python = "^3.6"
-httpx = "^0.15.0"
-attrs = "^20.1.0"
+httpx = ">=0.15.0, <=0.22.0"
+attrs = ">=20.1.0, <22.0"
 python-dateutil = "^2.8.0"
 
 [tool.black]

end_to_end_tests/golden-record/pyproject.toml

@@ -14,8 +14,8 @@ include = ["CHANGELOG.md", "my_test_api_client/py.typed"]
 
 [tool.poetry.dependencies]
 python = "^3.6"
-httpx = "^0.15.0"
-attrs = "^20.1.0"
+httpx = ">=0.15.0, <=0.22.0"
+attrs = ">=20.1.0, <22.0"
 python-dateutil = "^2.8.0"
 
 [tool.black]

openapi_python_client/parser/openapi.py

@@ -177,7 +177,7 @@ def _add_responses(*, endpoint: "Endpoint", data: oai.Responses, schemas: Schema
                     ParseError(
                         detail=(
                             f"Cannot parse response for status code {code}, "
-                            f"response will be ommitted from generated client"
+                            f"response will be omitted from generated client"
                         ),
                         data=response.data,
                     )

openapi_python_client/parser/responses.py

@@ -22,6 +22,7 @@ class Response:
     "application/json": "response.json()",
     "application/octet-stream": "response.content",
     "text/html": "response.text",
+    "text/yaml": "response.text",
 }
 
 

tests/test_parser/test_openapi.py

@@ -312,12 +312,12 @@ def test__add_responses(self, mocker):
         response_1 = Response(
             status_code=200,
             source="source",
-            prop=DateTimeProperty(name="datetime", required=True, nullable=False, default=None),
+            prop=DateTimeProperty(name="datetime", required=True, nullable=False, default=None, description=None),
         )
         response_2 = Response(
             status_code=404,
             source="source",
-            prop=DateProperty(name="date", required=True, nullable=False, default=None),
+            prop=DateProperty(name="date", required=True, nullable=False, default=None, description=None),
         )
         response_from_data = mocker.patch(
             f"{MODULE_NAME}.response_from_data", side_effect=[(response_1, schemas_1), (response_2, schemas_2)]

tests/test_parser/test_responses.py

@@ -9,20 +9,20 @@ def test_response_from_data_no_content():
     from openapi_python_client.parser.responses import Response, response_from_data
 
     response, schemas = response_from_data(
-        status_code=200, data=oai.Response.construct(description=""), schemas=Schemas(), parent_name="parent"
+        status_code=200, data=oai.Response.construct(description="description"), schemas=Schemas(), parent_name="parent"
     )
 
     assert response == Response(
         status_code=200,
-        prop=NoneProperty(name="response_200", default=None, nullable=False, required=True),
+        prop=NoneProperty(name="response_200", default=None, nullable=False, required=True, description=None),
         source="None",
     )
 
 
 def test_response_from_data_unsupported_content_type():
     from openapi_python_client.parser.responses import response_from_data
 
-    data = oai.Response.construct(description="", content={"blah": None})
+    data = oai.Response.construct(description="description", content={"blah": None})
     response, schemas = response_from_data(status_code=200, data=data, schemas=Schemas(), parent_name="parent")
 
     assert response == ParseError(data=data, detail="Unsupported content_type {'blah': None}")
@@ -33,10 +33,9 @@ def test_response_from_data_no_content_schema():
 
     data = oai.Response.construct(description="", content={"application/json": oai.MediaType.construct()})
     response, schemas = response_from_data(status_code=200, data=data, schemas=Schemas(), parent_name="parent")
-
     assert response == Response(
         status_code=200,
-        prop=NoneProperty(name="response_200", default=None, nullable=False, required=True),
+        prop=NoneProperty(name="response_200", default=None, nullable=False, required=True, description=None),
         source="None",
     )
 
@@ -46,7 +45,7 @@ def test_response_from_data_property_error(mocker):
 
     property_from_data = mocker.patch.object(responses, "property_from_data", return_value=(PropertyError(), Schemas()))
     data = oai.Response.construct(
-        description="", content={"application/json": oai.MediaType.construct(media_type_schema="something")}
+        description="description", content={"application/json": oai.MediaType.construct(media_type_schema="something")}
     )
     response, schemas = responses.response_from_data(
         status_code=400, data=data, schemas=Schemas(), parent_name="parent"
@@ -61,7 +60,7 @@ def test_response_from_data_property_error(mocker):
 def test_response_from_data_property(mocker):
     from openapi_python_client.parser import responses
 
-    prop = StringProperty(name="prop", required=True, nullable=False, default=None)
+    prop = StringProperty(name="prop", required=True, nullable=False, default=None, description=None)
     property_from_data = mocker.patch.object(responses, "property_from_data", return_value=(prop, Schemas()))
     data = oai.Response.construct(
         description="", content={"application/json": oai.MediaType.construct(media_type_schema="something")}
@@ -78,3 +77,25 @@ def test_response_from_data_property(mocker):
     property_from_data.assert_called_once_with(
         name="response_400", required=True, data="something", schemas=Schemas(), parent_name="parent"
     )
+
+
+def test_response_from_data_property_of_type_text_yaml(mocker):
+    from openapi_python_client.parser import responses
+
+    prop = StringProperty(name="prop", required=True, nullable=False, default=None, description=None)
+    property_from_data = mocker.patch.object(responses, "property_from_data", return_value=(prop, Schemas()))
+    data = oai.Response.construct(
+        description="", content={"text/yaml": oai.MediaType.construct(media_type_schema="something")}
+    )
+    response, schemas = responses.response_from_data(
+        status_code=400, data=data, schemas=Schemas(), parent_name="parent"
+    )
+
+    assert response == responses.Response(
+        status_code=400,
+        prop=prop,
+        source="response.text",
+    )
+    property_from_data.assert_called_once_with(
+        name="response_400", required=True, data="something", schemas=Schemas(), parent_name="parent"
+    )