(
self,
path: str,
endpoint: Callable[..., Any],
*,
response_model: Any = Default(None),
status_code: int | None = None,
tags: list[str | Enum] | None = None,
dependencies: Sequence[params.Depends] | None = None,
summary: str | None = None,
description: str | None = None,
response_description: str = "Successful Response",
responses: dict[int | str, dict[str, Any]] | None = None,
deprecated: bool | None = None,
name: str | None = None,
methods: set[str] | list[str] | None = None,
operation_id: str | None = None,
response_model_include: IncEx | None = None,
response_model_exclude: IncEx | None = None,
response_model_by_alias: bool = True,
response_model_exclude_unset: bool = False,
response_model_exclude_defaults: bool = False,
response_model_exclude_none: bool = False,
include_in_schema: bool = True,
response_class: type[Response] | DefaultPlaceholder = Default(JSONResponse),
dependency_overrides_provider: Any | None = None,
callbacks: list[BaseRoute] | None = None,
openapi_extra: dict[str, Any] | None = None,
generate_unique_id_function: Callable[["APIRoute"], str]
| DefaultPlaceholder = Default(generate_unique_id),
strict_content_type: bool | DefaultPlaceholder = Default(True),
)
| 1144 | is_json_stream: bool |
| 1145 | |
| 1146 | def __init__( |
| 1147 | self, |
| 1148 | path: str, |
| 1149 | endpoint: Callable[..., Any], |
| 1150 | *, |
| 1151 | response_model: Any = Default(None), |
| 1152 | status_code: int | None = None, |
| 1153 | tags: list[str | Enum] | None = None, |
| 1154 | dependencies: Sequence[params.Depends] | None = None, |
| 1155 | summary: str | None = None, |
| 1156 | description: str | None = None, |
| 1157 | response_description: str = "Successful Response", |
| 1158 | responses: dict[int | str, dict[str, Any]] | None = None, |
| 1159 | deprecated: bool | None = None, |
| 1160 | name: str | None = None, |
| 1161 | methods: set[str] | list[str] | None = None, |
| 1162 | operation_id: str | None = None, |
| 1163 | response_model_include: IncEx | None = None, |
| 1164 | response_model_exclude: IncEx | None = None, |
| 1165 | response_model_by_alias: bool = True, |
| 1166 | response_model_exclude_unset: bool = False, |
| 1167 | response_model_exclude_defaults: bool = False, |
| 1168 | response_model_exclude_none: bool = False, |
| 1169 | include_in_schema: bool = True, |
| 1170 | response_class: type[Response] | DefaultPlaceholder = Default(JSONResponse), |
| 1171 | dependency_overrides_provider: Any | None = None, |
| 1172 | callbacks: list[BaseRoute] | None = None, |
| 1173 | openapi_extra: dict[str, Any] | None = None, |
| 1174 | generate_unique_id_function: Callable[["APIRoute"], str] |
| 1175 | | DefaultPlaceholder = Default(generate_unique_id), |
| 1176 | strict_content_type: bool | DefaultPlaceholder = Default(True), |
| 1177 | ) -> None: |
| 1178 | _populate_api_route_state( |
| 1179 | cast(_APIRouteLike, self), |
| 1180 | path, |
| 1181 | endpoint, |
| 1182 | response_model=response_model, |
| 1183 | status_code=status_code, |
| 1184 | tags=tags, |
| 1185 | dependencies=dependencies, |
| 1186 | summary=summary, |
| 1187 | description=description, |
| 1188 | response_description=response_description, |
| 1189 | responses=responses, |
| 1190 | deprecated=deprecated, |
| 1191 | name=name, |
| 1192 | methods=methods, |
| 1193 | operation_id=operation_id, |
| 1194 | response_model_include=response_model_include, |
| 1195 | response_model_exclude=response_model_exclude, |
| 1196 | response_model_by_alias=response_model_by_alias, |
| 1197 | response_model_exclude_unset=response_model_exclude_unset, |
| 1198 | response_model_exclude_defaults=response_model_exclude_defaults, |
| 1199 | response_model_exclude_none=response_model_exclude_none, |
| 1200 | include_in_schema=include_in_schema, |
| 1201 | response_class=response_class, |
| 1202 | dependency_overrides_provider=dependency_overrides_provider, |
| 1203 | callbacks=callbacks, |
no test coverage detected