Merge pull request #91 from MarketSquare/17_support_parameters_at_path_level

update operation parameters with path parameters

Author: robinmackaij

src/OpenApiLibCore/models.py

@@ -711,10 +711,13 @@ class OperationObject(BaseModel):
     summary: str = ""
     description: str = ""
     tags: list[str] = []
-    parameters: list[ParameterObject] | None = None
+    parameters: list[ParameterObject] = []
     requestBody: RequestBodyObject | None = None
     responses: dict[str, ResponseObject] = {}
 
+    def update_parameters(self, parameters: list[ParameterObject]) -> None:
+        self.parameters.extend(parameters)
+
 
 class PathItemObject(BaseModel):
     get: OperationObject | None = None
@@ -724,13 +727,21 @@ class PathItemObject(BaseModel):
     delete: OperationObject | None = None
     summary: str = ""
     description: str = ""
-    parameters: list[ParameterObject] | None = None
+    parameters: list[ParameterObject] = []
 
     def get_operations(self) -> dict[str, OperationObject]:
         return {
             k: v for k, v in self.__dict__.items() if isinstance(v, OperationObject)
         }
 
+    def update_operation_parameters(self) -> None:
+        if not self.parameters:
+            return
+
+        operations_to_update = self.get_operations()
+        for operation_object in operations_to_update.values():
+            operation_object.update_parameters(self.parameters)
+
 
 class InfoObject(BaseModel):
     title: str
@@ -742,3 +753,7 @@ class InfoObject(BaseModel):
 class OpenApiObject(BaseModel):
     info: InfoObject
     paths: dict[str, PathItemObject]
+
+    def model_post_init(self, context: object) -> None:
+        for path_object in self.paths.values():
+            path_object.update_operation_parameters()

src/OpenApiLibCore/parameter_utils.py

@@ -86,10 +86,6 @@ def _register_path_parameter(parameter_object: ParameterObject) -> None:
             _ = get_safe_name_for_oas_name(parameter_object.name)
 
     for path_item in paths_data.values():
-        if parameters := path_item.parameters:
-            for parameter in path_item.parameters:
-                _register_path_parameter(parameter_object=parameter)
-
         operations = path_item.get_operations()
         for operation in operations.values():
             if parameters := operation.parameters:

tests/files/altered_openapi.json

@@ -363,20 +363,20 @@
             }
         },
         "/wagegroups/{wagegroup_id}": {
+            "parameters": [
+                {
+                    "name": "wagegroup_id",
+                    "in": "path",
+                    "required": true,
+                    "schema": {
+                        "type": "string",
+                        "title": "Wagegroup Id"
+                    }
+                }
+            ],
             "get": {
                 "summary": "Get Wagegroup",
                 "operationId": "get_wagegroup_wagegroups__wagegroup_id__get",
-                "parameters": [
-                    {
-                        "name": "wagegroup_id",
-                        "in": "path",
-                        "required": true,
-                        "schema": {
-                            "type": "string",
-                            "title": "Wagegroup Id"
-                        }
-                    }
-                ],
                 "responses": {
                     "200": {
                         "description": "Successful Response",
@@ -413,17 +413,6 @@
             "put": {
                 "summary": "Put Wagegroup",
                 "operationId": "put_wagegroup_wagegroups__wagegroup_id__put",
-                "parameters": [
-                    {
-                        "name": "wagegroup_id",
-                        "in": "path",
-                        "required": true,
-                        "schema": {
-                            "type": "string",
-                            "title": "Wagegroup Id"
-                        }
-                    }
-                ],
                 "requestBody": {
                     "required": true,
                     "content": {
@@ -480,17 +469,6 @@
             "delete": {
                 "summary": "Delete Wagegroup",
                 "operationId": "delete_wagegroup_wagegroups__wagegroup_id__delete",
-                "parameters": [
-                    {
-                        "name": "wagegroup_id",
-                        "in": "path",
-                        "required": true,
-                        "schema": {
-                            "type": "string",
-                            "title": "Wagegroup Id"
-                        }
-                    }
-                ],
                 "responses": {
                     "204": {
                         "description": "Successful Response"