feat: Support common parameters for paths (#376). Thanks @ramnes!

* Support common parameters

https://swagger.io/docs/specification/describing-parameters/#common

* test: Added e2e snapshot test for common path parameters

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

Author: ramnes

end_to_end_tests/golden-record/my_test_api_client/api/default/__init__.py

@@ -0,0 +1,72 @@
+from typing import Any, Dict, Union
+
+import httpx
+
+from ...client import Client
+from ...types import UNSET, Response, Unset
+
+
+def _get_kwargs(
+    *,
+    client: Client,
+    common: Union[Unset, str] = UNSET,
+) -> Dict[str, Any]:
+    url = "{}/common_parameters".format(client.base_url)
+
+    headers: Dict[str, Any] = client.get_headers()
+    cookies: Dict[str, Any] = client.get_cookies()
+
+    params: Dict[str, Any] = {
+        "common": common,
+    }
+    params = {k: v for k, v in params.items() if v is not UNSET and v is not None}
+
+    return {
+        "url": url,
+        "headers": headers,
+        "cookies": cookies,
+        "timeout": client.get_timeout(),
+        "params": params,
+    }
+
+
+def _build_response(*, response: httpx.Response) -> Response[None]:
+    return Response(
+        status_code=response.status_code,
+        content=response.content,
+        headers=response.headers,
+        parsed=None,
+    )
+
+
+def sync_detailed(
+    *,
+    client: Client,
+    common: Union[Unset, str] = UNSET,
+) -> Response[None]:
+    kwargs = _get_kwargs(
+        client=client,
+        common=common,
+    )
+
+    response = httpx.get(
+        **kwargs,
+    )
+
+    return _build_response(response=response)
+
+
+async def asyncio_detailed(
+    *,
+    client: Client,
+    common: Union[Unset, str] = UNSET,
+) -> Response[None]:
+    kwargs = _get_kwargs(
+        client=client,
+        common=common,
+    )
+
+    async with httpx.AsyncClient() as _client:
+        response = await _client.get(**kwargs)
+
+    return _build_response(response=response)

end_to_end_tests/golden-record/my_test_api_client/api/default/get_common_parameters.py

@@ -0,0 +1,72 @@
+from typing import Any, Dict, Union
+
+import httpx
+
+from ...client import Client
+from ...types import UNSET, Response, Unset
+
+
+def _get_kwargs(
+    *,
+    client: Client,
+    common: Union[Unset, str] = UNSET,
+) -> Dict[str, Any]:
+    url = "{}/common_parameters".format(client.base_url)
+
+    headers: Dict[str, Any] = client.get_headers()
+    cookies: Dict[str, Any] = client.get_cookies()
+
+    params: Dict[str, Any] = {
+        "common": common,
+    }
+    params = {k: v for k, v in params.items() if v is not UNSET and v is not None}
+
+    return {
+        "url": url,
+        "headers": headers,
+        "cookies": cookies,
+        "timeout": client.get_timeout(),
+        "params": params,
+    }
+
+
+def _build_response(*, response: httpx.Response) -> Response[None]:
+    return Response(
+        status_code=response.status_code,
+        content=response.content,
+        headers=response.headers,
+        parsed=None,
+    )
+
+
+def sync_detailed(
+    *,
+    client: Client,
+    common: Union[Unset, str] = UNSET,
+) -> Response[None]:
+    kwargs = _get_kwargs(
+        client=client,
+        common=common,
+    )
+
+    response = httpx.post(
+        **kwargs,
+    )
+
+    return _build_response(response=response)
+
+
+async def asyncio_detailed(
+    *,
+    client: Client,
+    common: Union[Unset, str] = UNSET,
+) -> Response[None]:
+    kwargs = _get_kwargs(
+        client=client,
+        common=common,
+    )
+
+    async with httpx.AsyncClient() as _client:
+        response = await _client.post(**kwargs)
+
+    return _build_response(response=response)

end_to_end_tests/golden-record/my_test_api_client/api/default/post_common_parameters.py

@@ -739,6 +739,27 @@
           }
         }
       }
+    },
+    "/common_parameters": {
+      "parameters": [
+        {
+          "schema": {
+            "type": "string"
+          },
+          "name": "common",
+          "in": "query"
+        }
+      ],
+      "get": {
+        "responses": {
+          "200": {"description": "Success"}
+        }
+      },
+      "post": {
+        "responses": {
+          "200": {"description": "Success"}
+        }
+      }
     }
   },
   "components": {

end_to_end_tests/openapi.json

@@ -54,6 +54,10 @@ def from_data(
                 endpoint, schemas = Endpoint.from_data(
                     data=operation, path=path, method=method, tag=tag, schemas=schemas, config=config
                 )
+                if not isinstance(endpoint, ParseError):
+                    endpoint, schemas = Endpoint._add_parameters(
+                        endpoint=endpoint, data=path_data, schemas=schemas, config=config
+                    )
                 if isinstance(endpoint, ParseError):
                     endpoint.header = (
                         f"ERROR parsing {method.upper()} {path} within {tag}. Endpoint will not be generated."
@@ -209,7 +213,7 @@ def _add_responses(
 
     @staticmethod
     def _add_parameters(
-        *, endpoint: "Endpoint", data: oai.Operation, schemas: Schemas, config: Config
+        *, endpoint: "Endpoint", data: Union[oai.Operation, oai.PathItem], schemas: Schemas, config: Config
     ) -> Tuple[Union["Endpoint", ParseError], Schemas]:
         endpoint = deepcopy(endpoint)
         if data.parameters is None: