feat: add support for referenced request bodies

Author: supermihi

openapi_python_client/parser/openapi.py

@@ -21,10 +21,11 @@
     Property,
     Schemas,
     build_parameters,
+    build_request_bodies,
     build_schemas,
     property_from_data,
 )
-from .properties.schemas import parameter_from_reference
+from .properties.schemas import RequestBodies, parameter_from_reference
 from .responses import Response, response_from_data
 
 _PATH_PARAM_REGEX = re.compile("{([a-zA-Z_][a-zA-Z0-9_]*)}")
@@ -45,7 +46,12 @@ class EndpointCollection:
 
     @staticmethod
     def from_data(
-        *, data: Dict[str, oai.PathItem], schemas: Schemas, parameters: Parameters, config: Config
+        *,
+        data: Dict[str, oai.PathItem],
+        schemas: Schemas,
+        parameters: Parameters,
+        request_bodies: RequestBodies,
+        config: Config,
     ) -> Tuple[Dict[utils.PythonIdentifier, "EndpointCollection"], Schemas, Parameters]:
         """Parse the openapi paths data to get EndpointCollections by tag"""
         endpoints_by_tag: Dict[utils.PythonIdentifier, EndpointCollection] = {}
@@ -66,6 +72,7 @@ def from_data(
                     tag=tag,
                     schemas=schemas,
                     parameters=parameters,
+                    request_bodies=request_bodies,
                     config=config,
                 )
                 # Add `PathItem` parameters
@@ -192,15 +199,27 @@ def _add_body(
         endpoint: "Endpoint",
         data: oai.Operation,
         schemas: Schemas,
+        request_bodies: RequestBodies,
         config: Config,
     ) -> Tuple[Union[ParseError, "Endpoint"], Schemas]:
         """Adds form or JSON body to Endpoint if included in data"""
         endpoint = deepcopy(endpoint)
-        if data.requestBody is None or isinstance(data.requestBody, oai.Reference):
+        if data.requestBody is None:
             return endpoint, schemas
-
+        if isinstance(data.requestBody, oai.Reference):
+            request_body = request_bodies.bodies_by_reference.get(data.requestBody.ref, None)
+            if request_body is None:
+                return (
+                    ParseError(
+                        header=f"Cannot resolve request body reference {data.requestBody.ref}",
+                        data=data.requestBody,
+                    ),
+                    schemas,
+                )
+        else:
+            request_body = data.requestBody
         form_body, schemas = Endpoint.parse_request_form_body(
-            body=data.requestBody, schemas=schemas, parent_name=endpoint.name, config=config
+            body=request_body, schemas=schemas, parent_name=endpoint.name, config=config
         )
 
         if isinstance(form_body, ParseError):
@@ -214,7 +233,7 @@ def _add_body(
             )
 
         json_body, schemas = Endpoint.parse_request_json_body(
-            body=data.requestBody, schemas=schemas, parent_name=endpoint.name, config=config
+            body=request_body, schemas=schemas, parent_name=endpoint.name, config=config
         )
         if isinstance(json_body, ParseError):
             return (
@@ -227,7 +246,7 @@ def _add_body(
             )
 
         multipart_body, schemas = Endpoint.parse_multipart_body(
-            body=data.requestBody, schemas=schemas, parent_name=endpoint.name, config=config
+            body=request_body, schemas=schemas, parent_name=endpoint.name, config=config
         )
         if isinstance(multipart_body, ParseError):
             return (
@@ -467,6 +486,7 @@ def from_data(
         tag: str,
         schemas: Schemas,
         parameters: Parameters,
+        request_bodies: RequestBodies,
         config: Config,
     ) -> Tuple[Union["Endpoint", ParseError], Schemas, Parameters]:
         """Construct an endpoint from the OpenAPI data"""
@@ -492,7 +512,9 @@ def from_data(
         if isinstance(result, ParseError):
             return result, schemas, parameters
         result, schemas = Endpoint._add_responses(endpoint=result, data=data.responses, schemas=schemas, config=config)
-        result, schemas = Endpoint._add_body(endpoint=result, data=data, schemas=schemas, config=config)
+        result, schemas = Endpoint._add_body(
+            endpoint=result, data=data, schemas=schemas, request_bodies=request_bodies, config=config
+        )
 
         return result, schemas, parameters
 
@@ -547,12 +569,15 @@ def from_dict(data: Dict[str, Any], *, config: Config) -> Union["GeneratorData",
             return GeneratorError(header="Failed to parse OpenAPI document", detail=detail)
         schemas = Schemas()
         parameters = Parameters()
+        request_bodies = RequestBodies()
         if openapi.components and openapi.components.schemas:
             schemas = build_schemas(components=openapi.components.schemas, schemas=schemas, config=config)
         if openapi.components and openapi.components.parameters:
             parameters = build_parameters(components=openapi.components.parameters, parameters=parameters)
+        if openapi.components and openapi.components.requestBodies:
+            request_bodies = build_request_bodies(components=openapi.components.requestBodies)
         endpoint_collections_by_tag, schemas, parameters = EndpointCollection.from_data(
-            data=openapi.paths, schemas=schemas, parameters=parameters, config=config
+            data=openapi.paths, schemas=schemas, parameters=parameters, request_bodies=request_bodies, config=config
         )
 
         enums = (prop for prop in schemas.classes_by_name.values() if isinstance(prop, EnumProperty))

openapi_python_client/parser/properties/__init__.py

@@ -8,6 +8,7 @@
     "Schemas",
     "build_schemas",
     "build_parameters",
+    "build_request_bodies",
     "property_from_data",
 ]
 
@@ -19,6 +20,7 @@
 from ... import Config
 from ... import schema as oai
 from ... import utils
+from ...schema import Reference, RequestBody
 from ..errors import ParameterError, ParseError, PropertyError, ValidationError
 from .converter import convert, convert_chain
 from .enum_property import EnumProperty
@@ -27,6 +29,7 @@
 from .schemas import (
     Class,
     Parameters,
+    RequestBodies,
     Schemas,
     parse_reference_path,
     update_parameters_with_data,
@@ -776,3 +779,15 @@ def build_parameters(
 
     parameters.errors.extend(errors)
     return parameters
+
+
+def build_request_bodies(*, components: Dict[str, Union[RequestBody, Reference]]):
+
+    direct_entries = {
+        f"#/components/requestBodies/{name}": body for name, body in components.items() if isinstance(body, RequestBody)
+    }
+    result = RequestBodies(bodies_by_reference=direct_entries)
+    ref_entries: Dict[str, Reference] = {name: body for name, body in components.items() if isinstance(body, Reference)}
+    for name, ref in ref_entries.items():
+        result.errors.append(ParseError(detail=f"Unimplemented support for reference request body: {name}"))
+    return result

openapi_python_client/parser/properties/schemas.py

@@ -16,6 +16,7 @@
 
 from ... import Config
 from ... import schema as oai
+from ...schema import RequestBody
 from ...schema.openapi_schema_pydantic import Parameter
 from ...utils import ClassName, PythonIdentifier
 from ..errors import ParameterError, ParseError, PropertyError
@@ -126,6 +127,14 @@ class Parameters:
     errors: List[ParseError] = attr.ib(factory=list)
 
 
+@attr.s(auto_attribs=True, frozen=True)
+class RequestBodies:
+    """Structure for containing all defined, shareable, and reusable request bodies"""
+
+    bodies_by_reference: Dict[str, RequestBody] = attr.ib(factory=dict)
+    errors: List[ParseError] = attr.ib(factory=list)
+
+
 def parameter_from_data(
     *,
     name: str,