flask-ast-openapi 0.2.1__tar.gz → 0.2.2__tar.gz

{flask_ast_openapi-0.2.1/src/flask_ast_openapi.egg-info → flask_ast_openapi-0.2.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: flask-ast-openapi
-Version: 0.2.1
+Version: 0.2.2
 Summary: Generate OpenAPI specifications from Flask source code using AST
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown

{flask_ast_openapi-0.2.1 → flask_ast_openapi-0.2.2}/pyproject.toml

@@ -5,7 +5,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "flask-ast-openapi"
-version = "0.2.1"
+version = "0.2.2"
 description = "Generate OpenAPI specifications from Flask source code using AST"
 readme = "README.md"
 requires-python = ">=3.10"

{flask_ast_openapi-0.2.1 → flask_ast_openapi-0.2.2}/src/flask_ast_openapi/generator.py

@@ -430,11 +430,12 @@ class FlaskASTOpenAPI:
             route.path
         )
 
-        parameters.extend(
-            self.build_query_parameters_from_names(
-                route.query_parameter_names
-            )
-        )
+        parameters.extend(
+            self.build_query_parameters_from_names(
+                route.query_parameter_names,
+                route.request_schema,
+            )
+        )
         response_status_codes = list(
             route.response_status_codes
         )
@@ -793,20 +794,33 @@ class FlaskASTOpenAPI:
             )
 
         return parameters
-    def build_query_parameters_from_names(self,names: list[str],) -> list[dict[str, Any]]:
-        """Build OpenAPI query parameters from their names."""
-
-        return [
-            {
-                "name": name,
-                "in": "query",
-                "required": False,
-                "schema": {
-                    "type": "string",
-                },
-            }
-            for name in names
-        ]
+    def build_query_parameters_from_names(
+        self,
+        names: list[str],
+        request_schema: dict[str, Any] | None = None,
+    ) -> list[dict[str, Any]]:
+        """Build OpenAPI query parameters from their names."""
+
+        schema_properties = (
+            request_schema.get("properties", {})
+            if request_schema
+            else {}
+        )
+        required_names = set(
+            request_schema.get("required", [])
+            if request_schema
+            else []
+        )
+
+        return [
+            {
+                "name": name,
+                "in": "query",
+                "required": name in required_names,
+                "schema": schema_properties.get(name, {"type": "string"}),
+            }
+            for name in names
+        ]
     def function_uses_json_body(self,function: ast.FunctionDef | ast.AsyncFunctionDef,) -> bool:
         """Check whether a route function reads a JSON request body."""
 

{flask_ast_openapi-0.2.1 → flask_ast_openapi-0.2.2/src/flask_ast_openapi.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: flask-ast-openapi
-Version: 0.2.1
+Version: 0.2.2
 Summary: Generate OpenAPI specifications from Flask source code using AST
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown

{flask_ast_openapi-0.2.1 → flask_ast_openapi-0.2.2}/tests/test_generator.py

@@ -908,7 +908,7 @@ def get_users():
     ]
 
 
-def test_build_openapi_operation_includes_query_parameters(tmp_path):
+def test_build_openapi_operation_includes_query_parameters(tmp_path):
     generator = FlaskASTOpenAPI(tmp_path)
 
     route = RouteDefinition(
@@ -920,7 +920,7 @@ def test_build_openapi_operation_includes_query_parameters(tmp_path):
 
     operation = generator.build_openapi_operation(route)
 
-    assert operation["parameters"] == [
+    assert operation["parameters"] == [
         {
             "name": "page",
             "in": "query",
@@ -937,10 +937,47 @@ def test_build_openapi_operation_includes_query_parameters(tmp_path):
                 "type": "string",
             },
         },
-    ]
-
-
-def test_build_openapi_operation_combines_path_and_query_parameters(
+    ]
+
+
+def test_build_openapi_operation_uses_request_schema_for_query_parameters(
+    tmp_path,
+):
+    generator = FlaskASTOpenAPI(tmp_path)
+
+    route = RouteDefinition(
+        function_name="get_users",
+        path="/users",
+        methods=["GET"],
+        query_parameter_names=["page", "page_size"],
+        request_schema={
+            "type": "object",
+            "properties": {
+                "page": {"type": "integer"},
+                "page_size": {"type": "integer"},
+            },
+        },
+    )
+
+    operation = generator.build_openapi_operation(route)
+
+    assert operation["parameters"] == [
+        {
+            "name": "page",
+            "in": "query",
+            "required": False,
+            "schema": {"type": "integer"},
+        },
+        {
+            "name": "page_size",
+            "in": "query",
+            "required": False,
+            "schema": {"type": "integer"},
+        },
+    ]
+
+
+def test_build_openapi_operation_combines_path_and_query_parameters(
     tmp_path,
 ):
     generator = FlaskASTOpenAPI(tmp_path)