fix: Parsing requestBody with $ref (openapi-generators#633)

Fixes openapi-generators#595

Perhaps similar solution can be applied to openapi-generators#605

## Description
The requestBody with $ref was not handled. `requestBodies` in components
should be injected into `_add_body` function.

---------

Co-authored-by: Dylan Anthony <[email protected]>

Author: 2 people

.changeset/support_request_body_refs.md

@@ -0,0 +1,26 @@
+---
+default: minor
+---
+
+# Support request body refs
+
+You can now define and reuse bodies via refs, with a document like this:
+
+```yaml
+paths:
+  /something:
+    post:
+      requestBody:
+        "$ref": "#/components/requestBodies/SharedBody"
+components:
+  requestBodies:
+    SharedBody:
+      content:
+        application/json:
+          schema:
+            type: string
+```
+
+Thanks to @kigawas and @supermihi for initial implementations and @RockyMM for the initial request.
+
+Closes #633, closes #664, resolves #595.

end_to_end_tests/__snapshots__/test_end_to_end.ambr

@@ -0,0 +1,44 @@
+# serializer version: 1
+# name: test_documents_with_errors[circular-body-ref]
+  '''
+  Generating /test-documents-with-errors
+  Warning(s) encountered while generating. Client was generated, but some pieces may be missing
+  
+  WARNING parsing POST / within default. Endpoint will not be generated.
+  
+  Circular $ref in request body
+  
+  
+  If you believe this was a mistake or this tool is missing a feature you need, please open an issue at https://github.com/openapi-generators/openapi-python-client/issues/new/choose
+  
+  '''
+# ---
+# name: test_documents_with_errors[missing-body-ref]
+  '''
+  Generating /test-documents-with-errors
+  Warning(s) encountered while generating. Client was generated, but some pieces may be missing
+  
+  WARNING parsing POST / within default. Endpoint will not be generated.
+  
+  Could not resolve $ref #/components/requestBodies/body in request body
+  
+  
+  If you believe this was a mistake or this tool is missing a feature you need, please open an issue at https://github.com/openapi-generators/openapi-python-client/issues/new/choose
+  
+  '''
+# ---
+# name: test_documents_with_errors[optional-path-param]
+  '''
+  Generating /test-documents-with-errors
+  Warning(s) encountered while generating. Client was generated, but some pieces may be missing
+  
+  WARNING parsing GET /{optional} within default. Endpoint will not be generated.
+  
+  Path parameter must be required
+  
+  Parameter(name='optional', param_in=<ParameterLocation.PATH: 'path'>, description=None, required=False, deprecated=False, allowEmptyValue=False, style=None, explode=False, allowReserved=False, param_schema=Schema(title=None, multipleOf=None, maximum=None, exclusiveMaximum=None, minimum=None, exclusiveMinimum=None, maxLength=None, minLength=None, pattern=None, maxItems=None, minItems=None, uniqueItems=None, maxProperties=None, minProperties=None, required=None, enum=None, const=None, type=<DataType.STRING: 'string'>, allOf=[], oneOf=[], anyOf=[], schema_not=None, items=None, properties=None, additionalProperties=None, description=None, schema_format=None, default=None, nullable=False, discriminator=None, readOnly=None, writeOnly=None, xml=None, externalDocs=None, example=None, deprecated=None), example=None, examples=None, content=None)
+  
+  If you believe this was a mistake or this tool is missing a feature you need, please open an issue at https://github.com/openapi-generators/openapi-python-client/issues/new/choose
+  
+  '''
+# ---

end_to_end_tests/baseline_openapi_3.0.json

@@ -87,6 +87,23 @@
         }
       }
     },
+    "/bodies/refs": {
+      "post": {
+        "tags": [
+          "bodies"
+        ],
+        "description": "Test request body defined via ref",
+        "operationId": "refs",
+        "requestBody": {
+          "$ref": "#/components/requestBodies/NestedRef"
+        },
+        "responses": {
+          "200": {
+            "description": "OK"
+          }
+        }
+      }
+    },
     "/bodies/multipart/multiple-files-in-object": {
       "post": {
         "tags": [
@@ -2812,6 +2829,20 @@
           "type": "string"
         }
       }
+    },
+    "requestBodies": {
+      "NestedRef": {
+        "$ref": "#/components/requestBodies/ARequestBody"
+      },
+      "ARequestBody": {
+        "content": {
+          "application/json": {
+            "schema": {
+              "$ref": "#/components/schemas/AModel"
+            }
+          }
+        }
+      }
     }
   }
 }

end_to_end_tests/baseline_openapi_3.1.yaml

@@ -83,6 +83,23 @@ info:
       }
     }
   },
+  "/bodies/refs": {
+    "post": {
+      "tags": [
+        "bodies"
+      ],
+      "description": "Test request body defined via ref",
+      "operationId": "refs",
+      "requestBody": {
+        "$ref": "#/components/requestBodies/NestedRef"
+      },
+      "responses": {
+        "200": {
+          "description": "OK"
+        }
+      }
+    }
+  },
   "/bodies/multipart/multiple-files-in-object": {
     "post": {
       "tags": [
@@ -1655,7 +1672,7 @@ info:
     }
   }
 }
-"components": {
+"components":
   "schemas": {
     "AFormData": {
       "type": "object",
@@ -2755,7 +2772,7 @@ info:
         }
       }
     }
-  },
+  }
   "parameters": {
     "integer-param": {
       "name": "integer param",
@@ -2823,5 +2840,11 @@ info:
       }
     }
   }
-}
-
+  requestBodies:
+    NestedRef:
+      "$ref": "#/components/requestBodies/ARequestBody"
+    ARequestBody:
+      content:
+        "application/json":
+          "schema":
+            "$ref": "#/components/schemas/AModel"

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

@@ -2,7 +2,7 @@
 
 import types
 
-from . import json_like, post_bodies_multiple
+from . import json_like, post_bodies_multiple, refs
 
 
 class BodiesEndpoints:
@@ -19,3 +19,10 @@ def json_like(cls) -> types.ModuleType:
         A content type that works like json but isn't application/json
         """
         return json_like
+
+    @classmethod
+    def refs(cls) -> types.ModuleType:
+        """
+        Test request body defined via ref
+        """
+        return refs

end_to_end_tests/documents_with_errors/circular-body-ref.yaml

@@ -0,0 +1,20 @@
+openapi: "3.1.0"
+info:
+  title: "Circular Body Ref"
+  version: "0.1.0"
+paths:
+  /:
+    post:
+      requestBody:
+        $ref: "#/components/requestBodies/body"
+      responses:
+        "200":
+          description: "Successful Response"
+          content:
+            "application/json":
+              schema:
+                const: "Why have a fixed response? I dunno"
+components:
+    requestBodies:
+        body:
+          $ref: "#/components/requestBodies/body"

end_to_end_tests/documents_with_errors/missing-body-ref.yaml

@@ -0,0 +1,16 @@
+openapi: "3.1.0"
+info:
+  title: "Trying to use a request body ref that does not exist"
+  version: "0.1.0"
+paths:
+  /:
+    post:
+      requestBody:
+        $ref: "#/components/requestBodies/body"
+      responses:
+        "200":
+          description: "Successful Response"
+          content:
+            "application/json":
+              schema:
+                const: "Why have a fixed response? I dunno"

end_to_end_tests/invalid_openapi.yaml renamed to end_to_end_tests/documents_with_errors/optional-path-param.yaml

@@ -0,0 +1,103 @@
+from http import HTTPStatus
+from typing import Any, Dict, Optional, Union
+
+import httpx
+
+from ... import errors
+from ...client import AuthenticatedClient, Client
+from ...models.a_model import AModel
+from ...types import Response
+
+
+def _get_kwargs(
+    *,
+    body: AModel,
+) -> Dict[str, Any]:
+    headers: Dict[str, Any] = {}
+
+    _kwargs: Dict[str, Any] = {
+        "method": "post",
+        "url": "/bodies/refs",
+    }
+
+    _body = body.to_dict()
+
+    _kwargs["json"] = _body
+    headers["Content-Type"] = "application/json"
+
+    _kwargs["headers"] = headers
+    return _kwargs
+
+
+def _parse_response(*, client: Union[AuthenticatedClient, Client], response: httpx.Response) -> Optional[Any]:
+    if response.status_code == HTTPStatus.OK:
+        return None
+    if client.raise_on_unexpected_status:
+        raise errors.UnexpectedStatus(response.status_code, response.content)
+    else:
+        return None
+
+
+def _build_response(*, client: Union[AuthenticatedClient, Client], response: httpx.Response) -> Response[Any]:
+    return Response(
+        status_code=HTTPStatus(response.status_code),
+        content=response.content,
+        headers=response.headers,
+        parsed=_parse_response(client=client, response=response),
+    )
+
+
+def sync_detailed(
+    *,
+    client: Union[AuthenticatedClient, Client],
+    body: AModel,
+) -> Response[Any]:
+    """Test request body defined via ref
+
+    Args:
+        body (AModel): A Model for testing all the ways custom objects can be used
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[Any]
+    """
+
+    kwargs = _get_kwargs(
+        body=body,
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio_detailed(
+    *,
+    client: Union[AuthenticatedClient, Client],
+    body: AModel,
+) -> Response[Any]:
+    """Test request body defined via ref
+
+    Args:
+        body (AModel): A Model for testing all the ways custom objects can be used
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[Any]
+    """
+
+    kwargs = _get_kwargs(
+        body=body,
+    )
+
+    response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(client=client, response=response)

end_to_end_tests/golden-record/my_test_api_client/api/bodies/refs.py

@@ -222,12 +222,18 @@ def test_bad_url():
     assert "Could not get OpenAPI document from provided URL" in result.stdout
 
 
-def test_invalid_document():
+ERROR_DOCUMENTS = [path for path in Path(__file__).parent.joinpath("documents_with_errors").iterdir() if path.is_file()]
+
+
+@pytest.mark.parametrize("document", ERROR_DOCUMENTS, ids=[path.stem for path in ERROR_DOCUMENTS])
+def test_documents_with_errors(snapshot, document):
     runner = CliRunner()
-    path = Path(__file__).parent / "invalid_openapi.yaml"
-    result = runner.invoke(app, ["generate", f"--path={path}", "--fail-on-warning"])
+    output_path = Path.cwd() / "test-documents-with-errors"
+    shutil.rmtree(output_path, ignore_errors=True)
+    result = runner.invoke(app, ["generate", f"--path={document}", "--fail-on-warning", f"--output-path={output_path}"])
     assert result.exit_code == 1
-    assert "Warning(s) encountered while generating" in result.stdout
+    assert result.stdout.replace(str(output_path), "/test-documents-with-errors") == snapshot
+    shutil.rmtree(output_path, ignore_errors=True)
 
 
 def test_custom_post_hooks():