Merge pull request #1517 from OscarVanL/fix/1505/append-openapi-extra-lists

fix: Merge openapi_extra list elements instead of overwrite

Author: vitalik

ninja/openapi/schema.py

@@ -99,6 +99,12 @@ def deep_dict_update(
                 self.deep_dict_update(
                     main_dict[key], update_dict[key]
                 )  # pragma: no cover
+            elif (
+                key in main_dict
+                and isinstance(main_dict[key], list)
+                and isinstance(update_dict[key], list)
+            ):
+                main_dict[key].extend(update_dict[key])
             else:
                 main_dict[key] = update_dict[key]
 

tests/test_openapi_extra.py

@@ -1,4 +1,4 @@
-from ninja import NinjaAPI
+from ninja import NinjaAPI, Router
 
 
 def test_openapi_info_defined():
@@ -47,3 +47,43 @@ def test_openapi_extra():
             "url": "https://example.com",
         },
     }
+
+
+def test_router_openapi_extra_extends():
+    """
+    Test for #1505.
+    When adding an extra parameter to a route via openapi_extra, this should be combined with the route's own parameters.
+    """
+    api = NinjaAPI()
+    test_router = Router()
+    api.add_router("", test_router)
+
+    extra_param = {
+        "in": "header",
+        "name": "X-HelloWorld",
+        "required": False,
+        "schema": {
+            "type": "string",
+            "format": "uuid",
+        },
+    }
+
+    @test_router.get("/path/{item_id}", openapi_extra={"parameters": [extra_param]})
+    def get_path_item_id(request, item_id: int):
+        pass
+
+    schema = api.get_openapi_schema()
+
+    assert len(schema["paths"]["/api/path/{item_id}"]["get"]["parameters"]) == 2
+    assert schema["paths"]["/api/path/{item_id}"]["get"]["parameters"] == [
+        {
+            "in": "path",
+            "name": "item_id",
+            "required": True,
+            "schema": {
+                "title": "Item Id",
+                "type": "integer",
+            },
+        },
+        extra_param,
+    ]