Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix default extra response #489

Merged
merged 3 commits into from
Aug 30, 2019
Merged

Fix default extra response #489

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4672e2f
:bug: Fix lowercase "default" extra response
tiangolo Aug 30, 2019
b7fda51
:bug: Fix model for responses, to allow "default" plus status codes
tiangolo Aug 30, 2019
848569b
:white_check_mark: Add test for "default" extra response
tiangolo Aug 30, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 1 addition & 5 deletions fastapi/openapi/models.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -210,10 +210,6 @@ class Response(BaseModel):
links: Optional[Dict[str, Union[Link, Reference]]] = None


class Responses(BaseModel):
default: Response


class Operation(BaseModel):
tags: Optional[List[str]] = None
summary: Optional[str] = None
Expand All @@ -222,7 +218,7 @@ class Operation(BaseModel):
operationId: Optional[str] = None
parameters: Optional[List[Union[Parameter, Reference]]] = None
requestBody: Optional[Union[RequestBody, Reference]] = None
responses: Union[Responses, Dict[str, Response]]
responses: Dict[str, Response]
# Workaround OpenAPI recursive reference
callbacks: Optional[Dict[str, Union[Dict[str, Any], Reference]]] = None
deprecated: Optional[bool] = None
Expand Down
9 changes: 5 additions & 4 deletions fastapi/openapi/utils.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@
"3XX": "Redirection",
"4XX": "Client Error",
"5XX": "Server Error",
"default": "Default Response",
"DEFAULT": "Default Response",
}


Expand Down Expand Up @@ -205,9 +205,10 @@ def get_openapi_path(
response.setdefault(
"description", status_text or "Additional Response"
)
operation.setdefault("responses", {})[
str(additional_status_code).upper()
] = response
status_code_key = str(additional_status_code).upper()
if status_code_key == "DEFAULT":
status_code_key = "default"
operation.setdefault("responses", {})[status_code_key] = response
status_code = str(route.status_code)
response_schema = {"type": "string"}
if lenient_issubclass(route.response_class, JSONResponse):
Expand Down
2 changes: 2 additions & 0 deletions tests/test_additional_responses_router.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ async def b():
responses={
"400": {"description": "Error with str"},
"5xx": {"description": "Error with range, lower"},
"default": {"description": "A default response"},
},
)
async def c():
Expand Down Expand Up @@ -74,6 +75,7 @@ async def c():
"description": "Successful Response",
"content": {"application/json": {"schema": {}}},
},
"default": {"description": "A default response"},
},
"summary": "C",
"operationId": "c_c_get",
Expand Down