From b6b160260e9229daa5f590809a0660789ea54d53 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Vin=C3=ADcius=20Aguiar?= Date: Fri, 1 Mar 2024 19:13:01 -0300 Subject: [PATCH 1/6] test: superimposing an additional response's media_type over the default route's response class's media_type --- ...additional_responses_default_media_type.py | 190 ++++++++++++++++++ 1 file changed, 190 insertions(+) create mode 100644 tests/test_additional_responses_default_media_type.py diff --git a/tests/test_additional_responses_default_media_type.py b/tests/test_additional_responses_default_media_type.py new file mode 100644 index 000000000..58c430b4f --- /dev/null +++ b/tests/test_additional_responses_default_media_type.py @@ -0,0 +1,190 @@ +""" + This test is about the possibility of superimposing an additional response's media_type + over the default route's response class's media_type. +""" + +from pydantic import BaseModel +from starlette.status import HTTP_200_OK, HTTP_500_INTERNAL_SERVER_ERROR + +from fastapi import FastAPI +from fastapi.testclient import TestClient + +app = FastAPI() +client = TestClient(app) + + +class Error(BaseModel): + status: str + title: str + + +@app.get( + "/a", + responses={ + HTTP_200_OK: {"superimpose": True, "content": {"text/event-stream": {}}}, + HTTP_500_INTERNAL_SERVER_ERROR: {"description": "Error", "model": Error} + }, +) +def a(): + pass # pragma: no cover + + +@app.get( + "/b", + responses={ + str(HTTP_200_OK): {"content": {"text/event-stream": {}}}, + HTTP_500_INTERNAL_SERVER_ERROR: {"description": "Error", "model": Error} + } +) +def b(): + pass # pragma: no cover + + +@app.get("/c", responses={HTTP_500_INTERNAL_SERVER_ERROR: {"description": "Error", "model": Error}}) +def c(): + pass # pragma: no cover + + +@app.get("/d") +def d(): + pass # pragma: no cover + + +def test_openapi_schema(): + response = client.get("/openapi.json") + + assert response.status_code == 200, response.text + assert response.json() == { + "openapi": "3.1.0", + "info": { + "title": "FastAPI", + "version": "0.1.0" + }, + "paths": { + "/a": { + "get": { + "summary": "A", + "operationId": "a_a_get", + "responses": { + "200": { + "description": "Successful Response", + "content": { + "text/event-stream": { + + } + } + }, + "500": { + "description": "Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/b": { + "get": { + "summary": "B", + "operationId": "b_b_get", + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + + } + }, + "text/event-stream": { + + } + } + }, + "500": { + "description": "Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/c": { + "get": { + "summary": "C", + "operationId": "c_c_get", + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + + } + } + } + }, + "500": { + "description": "Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/d": { + "get": { + "summary": "D", + "operationId": "d_d_get", + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + + } + } + } + } + } + } + } + }, + "components": { + "schemas": { + "Error": { + "properties": { + "status": { + "type": "string", + "title": "Status" + }, + "title": { + "type": "string", + "title": "Title" + } + }, + "type": "object", + "required": [ + "status", + "title" + ], + "title": "Error" + } + } + } + } From 932659f49ba5b27487c0cd3380d9a2c4eab7a8c2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Vin=C3=ADcius=20Aguiar?= Date: Fri, 1 Mar 2024 19:13:37 -0300 Subject: [PATCH 2/6] feat(openapi.utils): checks whether to superimpose an additional response's media_type over the default route's response class's media_type --- fastapi/openapi/utils.py | 15 ++++++++++----- 1 file changed, 10 insertions(+), 5 deletions(-) diff --git a/fastapi/openapi/utils.py b/fastapi/openapi/utils.py index 947eca948..6489441d8 100644 --- a/fastapi/openapi/utils.py +++ b/fastapi/openapi/utils.py @@ -345,11 +345,15 @@ def get_openapi_path( ) else: response_schema = {} - operation.setdefault("responses", {}).setdefault( - status_code, {} - ).setdefault("content", {}).setdefault(route_response_media_type, {})[ - "schema" - ] = response_schema + + route_responses = dict((str(k), v) for k, v in route.responses.items()) + if status_code not in route_responses or not route_responses.get(status_code).get('superimpose'): + operation.setdefault("responses", {}).setdefault( + status_code, {} + ).setdefault("content", {}).setdefault(route_response_media_type, {})[ + "schema" + ] = response_schema + if route.responses: operation_responses = operation.setdefault("responses", {}) for ( @@ -358,6 +362,7 @@ def get_openapi_path( ) in route.responses.items(): process_response = additional_response.copy() process_response.pop("model", None) + process_response.pop("superimpose", None) status_code_key = str(additional_status_code).upper() if status_code_key == "DEFAULT": status_code_key = "default" From 0cb111e4b8e2cbc50a2d5411da41e04d8f57ae3a Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Fri, 1 Mar 2024 22:41:12 +0000 Subject: [PATCH 3/6] =?UTF-8?q?=F0=9F=8E=A8=20[pre-commit.ci]=20Auto=20for?= =?UTF-8?q?mat=20from=20pre-commit.com=20hooks?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- fastapi/openapi/utils.py | 10 +- ...additional_responses_default_media_type.py | 110 ++++++------------ 2 files changed, 43 insertions(+), 77 deletions(-) diff --git a/fastapi/openapi/utils.py b/fastapi/openapi/utils.py index 6489441d8..cd9bb92ef 100644 --- a/fastapi/openapi/utils.py +++ b/fastapi/openapi/utils.py @@ -347,12 +347,14 @@ def get_openapi_path( response_schema = {} route_responses = dict((str(k), v) for k, v in route.responses.items()) - if status_code not in route_responses or not route_responses.get(status_code).get('superimpose'): + if status_code not in route_responses or not route_responses.get( + status_code + ).get("superimpose"): operation.setdefault("responses", {}).setdefault( status_code, {} - ).setdefault("content", {}).setdefault(route_response_media_type, {})[ - "schema" - ] = response_schema + ).setdefault("content", {}).setdefault( + route_response_media_type, {} + )["schema"] = response_schema if route.responses: operation_responses = operation.setdefault("responses", {}) diff --git a/tests/test_additional_responses_default_media_type.py b/tests/test_additional_responses_default_media_type.py index 58c430b4f..6f0253009 100644 --- a/tests/test_additional_responses_default_media_type.py +++ b/tests/test_additional_responses_default_media_type.py @@ -3,11 +3,10 @@ over the default route's response class's media_type. """ -from pydantic import BaseModel -from starlette.status import HTTP_200_OK, HTTP_500_INTERNAL_SERVER_ERROR - from fastapi import FastAPI from fastapi.testclient import TestClient +from pydantic import BaseModel +from starlette.status import HTTP_200_OK, HTTP_500_INTERNAL_SERVER_ERROR app = FastAPI() client = TestClient(app) @@ -22,7 +21,7 @@ class Error(BaseModel): "/a", responses={ HTTP_200_OK: {"superimpose": True, "content": {"text/event-stream": {}}}, - HTTP_500_INTERNAL_SERVER_ERROR: {"description": "Error", "model": Error} + HTTP_500_INTERNAL_SERVER_ERROR: {"description": "Error", "model": Error}, }, ) def a(): @@ -33,14 +32,19 @@ def a(): "/b", responses={ str(HTTP_200_OK): {"content": {"text/event-stream": {}}}, - HTTP_500_INTERNAL_SERVER_ERROR: {"description": "Error", "model": Error} - } + HTTP_500_INTERNAL_SERVER_ERROR: {"description": "Error", "model": Error}, + }, ) def b(): pass # pragma: no cover -@app.get("/c", responses={HTTP_500_INTERNAL_SERVER_ERROR: {"description": "Error", "model": Error}}) +@app.get( + "/c", + responses={ + HTTP_500_INTERNAL_SERVER_ERROR: {"description": "Error", "model": Error} + }, +) def c(): pass # pragma: no cover @@ -56,10 +60,7 @@ def test_openapi_schema(): assert response.status_code == 200, response.text assert response.json() == { "openapi": "3.1.0", - "info": { - "title": "FastAPI", - "version": "0.1.0" - }, + "info": {"title": "FastAPI", "version": "0.1.0"}, "paths": { "/a": { "get": { @@ -68,23 +69,17 @@ def test_openapi_schema(): "responses": { "200": { "description": "Successful Response", - "content": { - "text/event-stream": { - - } - } + "content": {"text/event-stream": {}}, }, "500": { "description": "Error", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/Error" - } + "schema": {"$ref": "#/components/schemas/Error"} } - } - } - } + }, + }, + }, } }, "/b": { @@ -95,27 +90,19 @@ def test_openapi_schema(): "200": { "description": "Successful Response", "content": { - "application/json": { - "schema": { - - } - }, - "text/event-stream": { - - } - } + "application/json": {"schema": {}}, + "text/event-stream": {}, + }, }, "500": { "description": "Error", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/Error" - } + "schema": {"$ref": "#/components/schemas/Error"} } - } - } - } + }, + }, + }, } }, "/c": { @@ -125,25 +112,17 @@ def test_openapi_schema(): "responses": { "200": { "description": "Successful Response", - "content": { - "application/json": { - "schema": { - - } - } - } + "content": {"application/json": {"schema": {}}}, }, "500": { "description": "Error", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/Error" - } + "schema": {"$ref": "#/components/schemas/Error"} } - } - } - } + }, + }, + }, } }, "/d": { @@ -153,38 +132,23 @@ def test_openapi_schema(): "responses": { "200": { "description": "Successful Response", - "content": { - "application/json": { - "schema": { - - } - } - } + "content": {"application/json": {"schema": {}}}, } - } + }, } - } + }, }, "components": { "schemas": { "Error": { "properties": { - "status": { - "type": "string", - "title": "Status" - }, - "title": { - "type": "string", - "title": "Title" - } + "status": {"type": "string", "title": "Status"}, + "title": {"type": "string", "title": "Title"}, }, "type": "object", - "required": [ - "status", - "title" - ], - "title": "Error" + "required": ["status", "title"], + "title": "Error", } } - } + }, } From d6914c3944975c0b19e059df8b5952b51dbf4881 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Vin=C3=ADcius=20Aguiar?= Date: Fri, 1 Mar 2024 19:55:50 -0300 Subject: [PATCH 4/6] refactor: satisfying ruff and mypy lint --- fastapi/openapi/utils.py | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/fastapi/openapi/utils.py b/fastapi/openapi/utils.py index cd9bb92ef..271acd931 100644 --- a/fastapi/openapi/utils.py +++ b/fastapi/openapi/utils.py @@ -346,10 +346,8 @@ def get_openapi_path( else: response_schema = {} - route_responses = dict((str(k), v) for k, v in route.responses.items()) - if status_code not in route_responses or not route_responses.get( - status_code - ).get("superimpose"): + route_responses = {str(k): v for k, v in route.responses.items()} + if status_code not in route_responses or not route_responses.get(status_code, {}).get('superimpose'): operation.setdefault("responses", {}).setdefault( status_code, {} ).setdefault("content", {}).setdefault( From 8637d5801dcf98cf6a6297d20331dd8f2de1a7b5 Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Fri, 1 Mar 2024 22:59:38 +0000 Subject: [PATCH 5/6] =?UTF-8?q?=F0=9F=8E=A8=20[pre-commit.ci]=20Auto=20for?= =?UTF-8?q?mat=20from=20pre-commit.com=20hooks?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- fastapi/openapi/utils.py | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/fastapi/openapi/utils.py b/fastapi/openapi/utils.py index 271acd931..dc35124ee 100644 --- a/fastapi/openapi/utils.py +++ b/fastapi/openapi/utils.py @@ -347,7 +347,9 @@ def get_openapi_path( response_schema = {} route_responses = {str(k): v for k, v in route.responses.items()} - if status_code not in route_responses or not route_responses.get(status_code, {}).get('superimpose'): + if status_code not in route_responses or not route_responses.get( + status_code, {} + ).get("superimpose"): operation.setdefault("responses", {}).setdefault( status_code, {} ).setdefault("content", {}).setdefault( From e646e1e09fb21a8f1d0b4560392ebc82b2772ac0 Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Fri, 27 Sep 2024 12:29:11 +0000 Subject: [PATCH 6/6] =?UTF-8?q?=F0=9F=8E=A8=20[pre-commit.ci]=20Auto=20for?= =?UTF-8?q?mat=20from=20pre-commit.com=20hooks?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- tests/test_additional_responses_default_media_type.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/tests/test_additional_responses_default_media_type.py b/tests/test_additional_responses_default_media_type.py index 6f0253009..8e92356e8 100644 --- a/tests/test_additional_responses_default_media_type.py +++ b/tests/test_additional_responses_default_media_type.py @@ -1,6 +1,6 @@ """ - This test is about the possibility of superimposing an additional response's media_type - over the default route's response class's media_type. +This test is about the possibility of superimposing an additional response's media_type +over the default route's response class's media_type. """ from fastapi import FastAPI