Browse Source

more signature consistency

pull/13767/head
Konstantin Zangerle 1 month ago
parent
commit
0226b66f38
  1. 36
      fastapi/applications.py

36
fastapi/applications.py

@ -1064,7 +1064,7 @@ class FastAPI(Starlette):
dependencies: Optional[Sequence[Depends]] = None, dependencies: Optional[Sequence[Depends]] = None,
summary: Optional[str] = None, summary: Optional[str] = None,
description: Optional[str] = None, description: Optional[str] = None,
response_description: str = "Successful Response", response_description: Optional[str] = None,
responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None, responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,
deprecated: Optional[bool] = None, deprecated: Optional[bool] = None,
methods: Optional[List[str]] = None, methods: Optional[List[str]] = None,
@ -1122,7 +1122,7 @@ class FastAPI(Starlette):
dependencies: Optional[Sequence[Depends]] = None, dependencies: Optional[Sequence[Depends]] = None,
summary: Optional[str] = None, summary: Optional[str] = None,
description: Optional[str] = None, description: Optional[str] = None,
response_description: str = "Successful Response", response_description: Optional[str] = None,
responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None, responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,
deprecated: Optional[bool] = None, deprecated: Optional[bool] = None,
methods: Optional[List[str]] = None, methods: Optional[List[str]] = None,
@ -1574,7 +1574,7 @@ class FastAPI(Starlette):
), ),
] = None, ] = None,
response_description: Annotated[ response_description: Annotated[
str, Optional[str],
Doc( Doc(
""" """
The description for the default response. The description for the default response.
@ -1582,7 +1582,7 @@ class FastAPI(Starlette):
It will be added to the generated OpenAPI (e.g. visible at `/docs`). It will be added to the generated OpenAPI (e.g. visible at `/docs`).
""" """
), ),
] = "Successful Response", ] = None,
responses: Annotated[ responses: Annotated[
Optional[Dict[Union[int, str], Dict[str, Any]]], Optional[Dict[Union[int, str], Dict[str, Any]]],
Doc( Doc(
@ -1947,7 +1947,7 @@ class FastAPI(Starlette):
), ),
] = None, ] = None,
response_description: Annotated[ response_description: Annotated[
str, Optional[str],
Doc( Doc(
""" """
The description for the default response. The description for the default response.
@ -1955,7 +1955,7 @@ class FastAPI(Starlette):
It will be added to the generated OpenAPI (e.g. visible at `/docs`). It will be added to the generated OpenAPI (e.g. visible at `/docs`).
""" """
), ),
] = "Successful Response", ] = None,
responses: Annotated[ responses: Annotated[
Optional[Dict[Union[int, str], Dict[str, Any]]], Optional[Dict[Union[int, str], Dict[str, Any]]],
Doc( Doc(
@ -2325,7 +2325,7 @@ class FastAPI(Starlette):
), ),
] = None, ] = None,
response_description: Annotated[ response_description: Annotated[
str, Optional[str],
Doc( Doc(
""" """
The description for the default response. The description for the default response.
@ -2333,7 +2333,7 @@ class FastAPI(Starlette):
It will be added to the generated OpenAPI (e.g. visible at `/docs`). It will be added to the generated OpenAPI (e.g. visible at `/docs`).
""" """
), ),
] = "Successful Response", ] = None,
responses: Annotated[ responses: Annotated[
Optional[Dict[Union[int, str], Dict[str, Any]]], Optional[Dict[Union[int, str], Dict[str, Any]]],
Doc( Doc(
@ -2703,7 +2703,7 @@ class FastAPI(Starlette):
), ),
] = None, ] = None,
response_description: Annotated[ response_description: Annotated[
str, Optional[str],
Doc( Doc(
""" """
The description for the default response. The description for the default response.
@ -2711,7 +2711,7 @@ class FastAPI(Starlette):
It will be added to the generated OpenAPI (e.g. visible at `/docs`). It will be added to the generated OpenAPI (e.g. visible at `/docs`).
""" """
), ),
] = "Successful Response", ] = None,
responses: Annotated[ responses: Annotated[
Optional[Dict[Union[int, str], Dict[str, Any]]], Optional[Dict[Union[int, str], Dict[str, Any]]],
Doc( Doc(
@ -3076,7 +3076,7 @@ class FastAPI(Starlette):
), ),
] = None, ] = None,
response_description: Annotated[ response_description: Annotated[
str, Optional[str],
Doc( Doc(
""" """
The description for the default response. The description for the default response.
@ -3084,7 +3084,7 @@ class FastAPI(Starlette):
It will be added to the generated OpenAPI (e.g. visible at `/docs`). It will be added to the generated OpenAPI (e.g. visible at `/docs`).
""" """
), ),
] = "Successful Response", ] = None,
responses: Annotated[ responses: Annotated[
Optional[Dict[Union[int, str], Dict[str, Any]]], Optional[Dict[Union[int, str], Dict[str, Any]]],
Doc( Doc(
@ -3449,7 +3449,7 @@ class FastAPI(Starlette):
), ),
] = None, ] = None,
response_description: Annotated[ response_description: Annotated[
str, Optional[str],
Doc( Doc(
""" """
The description for the default response. The description for the default response.
@ -3457,7 +3457,7 @@ class FastAPI(Starlette):
It will be added to the generated OpenAPI (e.g. visible at `/docs`). It will be added to the generated OpenAPI (e.g. visible at `/docs`).
""" """
), ),
] = "Successful Response", ] = None,
responses: Annotated[ responses: Annotated[
Optional[Dict[Union[int, str], Dict[str, Any]]], Optional[Dict[Union[int, str], Dict[str, Any]]],
Doc( Doc(
@ -3822,7 +3822,7 @@ class FastAPI(Starlette):
), ),
] = None, ] = None,
response_description: Annotated[ response_description: Annotated[
str, Optional[str],
Doc( Doc(
""" """
The description for the default response. The description for the default response.
@ -3830,7 +3830,7 @@ class FastAPI(Starlette):
It will be added to the generated OpenAPI (e.g. visible at `/docs`). It will be added to the generated OpenAPI (e.g. visible at `/docs`).
""" """
), ),
] = "Successful Response", ] = None,
responses: Annotated[ responses: Annotated[
Optional[Dict[Union[int, str], Dict[str, Any]]], Optional[Dict[Union[int, str], Dict[str, Any]]],
Doc( Doc(
@ -4200,7 +4200,7 @@ class FastAPI(Starlette):
), ),
] = None, ] = None,
response_description: Annotated[ response_description: Annotated[
str, Optional[str],
Doc( Doc(
""" """
The description for the default response. The description for the default response.
@ -4208,7 +4208,7 @@ class FastAPI(Starlette):
It will be added to the generated OpenAPI (e.g. visible at `/docs`). It will be added to the generated OpenAPI (e.g. visible at `/docs`).
""" """
), ),
] = "Successful Response", ] = None,
responses: Annotated[ responses: Annotated[
Optional[Dict[Union[int, str], Dict[str, Any]]], Optional[Dict[Union[int, str], Dict[str, Any]]],
Doc( Doc(

Loading…
Cancel
Save