]> git.ipfire.org Git - thirdparty/fastapi/fastapi.git/commitdiff
🐛 Fix edge case with repeated aliases names not shown in OpenAPI (#2351)
authorLuca Repetti <39653693+klaa97@users.noreply.github.com>
Thu, 18 Aug 2022 20:31:19 +0000 (22:31 +0200)
committerGitHub <noreply@github.com>
Thu, 18 Aug 2022 20:31:19 +0000 (20:31 +0000)
Co-authored-by: Sebastián Ramírez <tiangolo@gmail.com>
fastapi/openapi/utils.py
tests/test_repeated_parameter_alias.py [new file with mode: 0644]

index 5d3d95c2442cd091a6ce815eab547b68691c4faf..4d5741f30de1c45f90244ee70aa307cf274fac92 100644 (file)
@@ -223,7 +223,9 @@ def get_openapi_path(
             parameters.extend(operation_parameters)
             if parameters:
                 operation["parameters"] = list(
-                    {param["name"]: param for param in parameters}.values()
+                    {
+                        (param["in"], param["name"]): param for param in parameters
+                    }.values()
                 )
             if method in METHODS_WITH_BODY:
                 request_body_oai = get_openapi_operation_request_body(
diff --git a/tests/test_repeated_parameter_alias.py b/tests/test_repeated_parameter_alias.py
new file mode 100644 (file)
index 0000000..823f53a
--- /dev/null
@@ -0,0 +1,100 @@
+from fastapi import FastAPI, Path, Query, status
+from fastapi.testclient import TestClient
+
+app = FastAPI()
+
+
+@app.get("/{repeated_alias}")
+def get_parameters_with_repeated_aliases(
+    path: str = Path(..., alias="repeated_alias"),
+    query: str = Query(..., alias="repeated_alias"),
+):
+    return {"path": path, "query": query}
+
+
+client = TestClient(app)
+
+openapi_schema = {
+    "components": {
+        "schemas": {
+            "HTTPValidationError": {
+                "properties": {
+                    "detail": {
+                        "items": {"$ref": "#/components/schemas/ValidationError"},
+                        "title": "Detail",
+                        "type": "array",
+                    }
+                },
+                "title": "HTTPValidationError",
+                "type": "object",
+            },
+            "ValidationError": {
+                "properties": {
+                    "loc": {
+                        "items": {"anyOf": [{"type": "string"}, {"type": "integer"}]},
+                        "title": "Location",
+                        "type": "array",
+                    },
+                    "msg": {"title": "Message", "type": "string"},
+                    "type": {"title": "Error Type", "type": "string"},
+                },
+                "required": ["loc", "msg", "type"],
+                "title": "ValidationError",
+                "type": "object",
+            },
+        }
+    },
+    "info": {"title": "FastAPI", "version": "0.1.0"},
+    "openapi": "3.0.2",
+    "paths": {
+        "/{repeated_alias}": {
+            "get": {
+                "operationId": "get_parameters_with_repeated_aliases__repeated_alias__get",
+                "parameters": [
+                    {
+                        "in": "path",
+                        "name": "repeated_alias",
+                        "required": True,
+                        "schema": {"title": "Repeated Alias", "type": "string"},
+                    },
+                    {
+                        "in": "query",
+                        "name": "repeated_alias",
+                        "required": True,
+                        "schema": {"title": "Repeated Alias", "type": "string"},
+                    },
+                ],
+                "responses": {
+                    "200": {
+                        "content": {"application/json": {"schema": {}}},
+                        "description": "Successful Response",
+                    },
+                    "422": {
+                        "content": {
+                            "application/json": {
+                                "schema": {
+                                    "$ref": "#/components/schemas/HTTPValidationError"
+                                }
+                            }
+                        },
+                        "description": "Validation Error",
+                    },
+                },
+                "summary": "Get Parameters With Repeated Aliases",
+            }
+        }
+    },
+}
+
+
+def test_openapi_schema():
+    response = client.get("/openapi.json")
+    assert response.status_code == status.HTTP_200_OK
+    actual_schema = response.json()
+    assert actual_schema == openapi_schema
+
+
+def test_get_parameters():
+    response = client.get("/test_path", params={"repeated_alias": "test_query"})
+    assert response.status_code == 200, response.text
+    assert response.json() == {"path": "test_path", "query": "test_query"}