Added schema to parameters.

Signed-off-by: Pavel Kirilin <[email protected]>

Author: s3rius

aiohttp_deps/swagger.py

@@ -85,6 +85,17 @@ def dummy(_var: annotation.annotation) -> None:  # type: ignore
     return var == Optional[var]
 
 
+def _get_param_schema(annotation: Optional[inspect.Parameter]) -> Dict[str, Any]:
+    if annotation is None or annotation.annotation == annotation.empty:
+        return {}
+
+    def dummy(_var: annotation.annotation) -> None:  # type: ignore
+        """Dummy function to use for type resolution."""
+
+    var = get_type_hints(dummy).get("_var")
+    return pydantic.TypeAdapter(var).json_schema(ref_template=REF_TEMPLATE)
+
+
 def _add_route_def(  # noqa: C901, WPS210, WPS211
     openapi_schema: Dict[str, Any],
     route: web.ResourceRoute,
@@ -140,32 +151,41 @@ def _insert_in_params(data: Dict[str, Any]) -> None:
                     "content": {content_type: {}},
                 }
         elif isinstance(dependency.dependency, Query):
+            schema = _get_param_schema(dependency.signature)
+            openapi_schema["components"]["schemas"].update(schema.pop("$defs", {}))
             _insert_in_params(
                 {
                     "name": dependency.dependency.alias or dependency.param_name,
                     "in": "query",
                     "description": dependency.dependency.description,
                     "required": not _is_optional(dependency.signature),
+                    "schema": schema,
                 },
             )
         elif isinstance(dependency.dependency, Header):
             name = dependency.dependency.alias or dependency.param_name
+            schema = _get_param_schema(dependency.signature)
+            openapi_schema["components"]["schemas"].update(schema.pop("$defs", {}))
             _insert_in_params(
                 {
                     "name": name.capitalize(),
                     "in": "header",
                     "description": dependency.dependency.description,
                     "required": not _is_optional(dependency.signature),
+                    "schema": schema,
                 },
             )
         elif isinstance(dependency.dependency, Path):
+            schema = _get_param_schema(dependency.signature)
+            openapi_schema["components"]["schemas"].update(schema.pop("$defs", {}))
             _insert_in_params(
                 {
                     "name": dependency.dependency.alias or dependency.param_name,
                     "in": "path",
                     "description": dependency.dependency.description,
                     "required": not _is_optional(dependency.signature),
                     "allowEmptyValue": _is_optional(dependency.signature),
+                    "schema": schema,
                 },
             )
 

tests/test_swagger.py

@@ -215,6 +215,7 @@ async def my_handler(my_var: int = Depends(Query(description="desc"))):
         "required": True,
         "in": "query",
         "description": "desc",
+        "schema": {"type": "integer"},
     }
 
 
@@ -242,6 +243,7 @@ async def my_handler(my_var: Optional[int] = Depends(Query())):
         "required": False,
         "in": "query",
         "description": "",
+        "schema": {"anyOf": [{"type": "integer"}, {"type": "null"}]},
     }
 
 
@@ -269,6 +271,7 @@ async def my_handler(my_var: int = Depends(Query(alias="qqq"))):
         "required": True,
         "in": "query",
         "description": "",
+        "schema": {"type": "integer"},
     }
 
 
@@ -278,7 +281,13 @@ async def my_handler(my_var: int = Depends(Query(alias="qqq"))):
     (
         (
             Query(),
-            {"name": "my_var", "required": True, "in": "query", "description": ""},
+            {
+                "name": "my_var",
+                "required": True,
+                "in": "query",
+                "description": "",
+                "schema": {"type": "integer"},
+            },
         ),
         (
             Query(description="my query"),
@@ -287,15 +296,28 @@ async def my_handler(my_var: int = Depends(Query(alias="qqq"))):
                 "required": True,
                 "in": "query",
                 "description": "my query",
+                "schema": {"type": "integer"},
             },
         ),
         (
             Query(alias="a"),
-            {"name": "a", "required": True, "in": "query", "description": ""},
+            {
+                "name": "a",
+                "required": True,
+                "in": "query",
+                "description": "",
+                "schema": {"type": "integer"},
+            },
         ),
         (
             Header(),
-            {"name": "My_var", "required": True, "in": "header", "description": ""},
+            {
+                "name": "My_var",
+                "required": True,
+                "in": "header",
+                "description": "",
+                "schema": {"type": "integer"},
+            },
         ),
         (
             Header(description="my header"),
@@ -304,11 +326,18 @@ async def my_handler(my_var: int = Depends(Query(alias="qqq"))):
                 "required": True,
                 "in": "header",
                 "description": "my header",
+                "schema": {"type": "integer"},
             },
         ),
         (
             Header(alias="a"),
-            {"name": "A", "required": True, "in": "header", "description": ""},
+            {
+                "name": "A",
+                "required": True,
+                "in": "header",
+                "description": "",
+                "schema": {"type": "integer"},
+            },
         ),
         (
             Path(),
@@ -318,6 +347,7 @@ async def my_handler(my_var: int = Depends(Query(alias="qqq"))):
                 "in": "path",
                 "description": "",
                 "allowEmptyValue": False,
+                "schema": {"type": "integer"},
             },
         ),
         (
@@ -328,6 +358,7 @@ async def my_handler(my_var: int = Depends(Query(alias="qqq"))):
                 "in": "path",
                 "description": "my path",
                 "allowEmptyValue": False,
+                "schema": {"type": "integer"},
             },
         ),
         (
@@ -338,6 +369,7 @@ async def my_handler(my_var: int = Depends(Query(alias="qqq"))):
                 "in": "path",
                 "description": "",
                 "allowEmptyValue": False,
+                "schema": {"type": "integer"},
             },
         ),
     ),