Models
APISpec
⚓︎
Bases: BaseModel
https://spec.openapis.org/oas/v3.0.3#openapi-object
Source code in flask_openapi3/models/__init__.py
48 49 50 51 52 53 54 55 56 57 58 59 60 |
|
OAuthConfig
⚓︎
Bases: BaseModel
https://github.com/swagger-api/swagger-ui/blob/master/docs/usage/oauth2.md#oauth-20-configuration
Source code in flask_openapi3/models/__init__.py
72 73 74 75 76 77 78 79 80 81 82 83 84 |
|
Callback = Dict[str, PathItem]
module-attribute
⚓︎
Components
⚓︎
Bases: BaseModel
https://spec.openapis.org/oas/v3.0.3#components-object
Source code in flask_openapi3/models/components.py
21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 |
|
Contact
⚓︎
Bases: BaseModel
https://spec.openapis.org/oas/v3.0.3#contact-object
Source code in flask_openapi3/models/contact.py
9 10 11 12 13 14 15 16 17 18 19 |
|
Discriminator
⚓︎
Bases: BaseModel
https://spec.openapis.org/oas/v3.0.3#discriminator-object
Source code in flask_openapi3/models/discriminator.py
9 10 11 12 13 14 15 16 17 18 |
|
Encoding
⚓︎
Bases: BaseModel
https://spec.openapis.org/oas/v3.0.3#encoding-object
Source code in flask_openapi3/models/encoding.py
16 17 18 19 20 21 22 23 24 25 26 27 28 |
|
Example
⚓︎
Bases: BaseModel
https://spec.openapis.org/oas/v3.0.3#example-object
Source code in flask_openapi3/models/example.py
9 10 11 12 13 14 15 16 17 18 19 20 |
|
ExternalDocumentation
⚓︎
Bases: BaseModel
https://spec.openapis.org/oas/v3.0.3#external-documentation-object
Source code in flask_openapi3/models/external_documentation.py
9 10 11 12 13 14 15 16 17 18 |
|
FileStorage
⚓︎
Bases: FileStorage
An uploaded file included as part of the request data.
Source code in flask_openapi3/models/file.py
9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 |
|
Header
⚓︎
Bases: Parameter
https://spec.openapis.org/oas/v3.0.3#header-object
Source code in flask_openapi3/models/header.py
10 11 12 13 14 15 16 17 18 19 |
|
Info
⚓︎
Bases: BaseModel
https://spec.openapis.org/oas/v3.0.3#info-object
Source code in flask_openapi3/models/info.py
12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 |
|
License
⚓︎
Bases: BaseModel
https://spec.openapis.org/oas/v3.0.3#license-object
Source code in flask_openapi3/models/license.py
9 10 11 12 13 14 15 16 17 18 19 |
|
Link
⚓︎
Bases: BaseModel
https://spec.openapis.org/oas/v3.0.3#link-object
Source code in flask_openapi3/models/link.py
11 12 13 14 15 16 17 18 19 20 21 22 23 24 |
|
MediaType
⚓︎
Bases: BaseModel
https://spec.openapis.org/oas/v3.0.3#media-type-object
Source code in flask_openapi3/models/media_type.py
14 15 16 17 18 19 20 21 22 23 24 25 |
|
OAuthFlow
⚓︎
Bases: BaseModel
https://spec.openapis.org/oas/v3.0.3#oauth-flow-object
Source code in flask_openapi3/models/oauth_flow.py
9 10 11 12 13 14 15 16 17 18 19 20 |
|
OAuthFlows
⚓︎
Bases: BaseModel
https://spec.openapis.org/oas/v3.0.3#oauth-flows-object
Source code in flask_openapi3/models/oauth_flows.py
11 12 13 14 15 16 17 18 19 20 21 22 |
|
Operation
⚓︎
Bases: BaseModel
https://spec.openapis.org/oas/v3.0.3#operation-object
Source code in flask_openapi3/models/operation.py
18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 |
|
Parameter
⚓︎
Bases: BaseModel
https://spec.openapis.org/oas/v3.0.3#parameter-object
Source code in flask_openapi3/models/parameter.py
15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 |
|
ParameterInType
⚓︎
Bases: str
, Enum
The places Parameters can be put when calling an Endpoint
Source code in flask_openapi3/models/parameter_in_type.py
7 8 9 10 11 12 13 |
|
PathItem
⚓︎
Bases: BaseModel
https://spec.openapis.org/oas/v3.0.3#path-item-object
Source code in flask_openapi3/models/path_item.py
17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 |
|
Paths = Dict[str, PathItem]
module-attribute
⚓︎
Reference
⚓︎
Bases: BaseModel
https://spec.openapis.org/oas/v3.0.3#reference-object
Source code in flask_openapi3/models/reference.py
7 8 9 10 11 12 13 14 15 |
|
RequestBody
⚓︎
Bases: BaseModel
https://spec.openapis.org/oas/v3.0.3#request-body-object
Source code in flask_openapi3/models/request_body.py
11 12 13 14 15 16 17 18 19 20 21 |
|
Response
⚓︎
Bases: BaseModel
https://spec.openapis.org/oas/v3.0.3#response-object
Source code in flask_openapi3/models/response.py
14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 |
|
merge_with(other_response)
⚓︎
Merge content from both responses.
Source code in flask_openapi3/models/response.py
27 28 29 30 31 32 33 34 35 36 37 38 |
|
Responses = Dict[str, Union[Response, Reference]]
module-attribute
⚓︎
Schema
⚓︎
Bases: BaseModel
https://spec.openapis.org/oas/v3.0.3#schema-object
Source code in flask_openapi3/models/schema.py
15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 |
|
SecurityRequirement = Dict[str, List[str]]
module-attribute
⚓︎
SecurityScheme
⚓︎
Bases: BaseModel
https://spec.openapis.org/oas/v3.0.3#security-scheme-object
Source code in flask_openapi3/models/security_scheme.py
12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 |
|
Server
⚓︎
Bases: BaseModel
https://spec.openapis.org/oas/v3.0.3#server-object
Source code in flask_openapi3/models/server.py
11 12 13 14 15 16 17 18 19 20 21 |
|
ServerVariable
⚓︎
Bases: BaseModel
https://spec.openapis.org/oas/v3.0.3#server-variable-object
Source code in flask_openapi3/models/server_variable.py
9 10 11 12 13 14 15 16 17 18 19 |
|
StyleValues
⚓︎
Bases: str
, Enum
Source code in flask_openapi3/models/style_values.py
7 8 9 10 11 12 13 14 |
|
Tag
⚓︎
Bases: BaseModel
https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#tag-object
Source code in flask_openapi3/models/tag.py
11 12 13 14 15 16 17 18 19 20 21 |
|
ValidationErrorModel
⚓︎
Bases: BaseModel
Source code in flask_openapi3/models/validation_error.py
9 10 11 12 13 14 15 16 17 18 |
|
XML
⚓︎
Bases: BaseModel
https://spec.openapis.org/oas/v3.0.3#xml-object
Source code in flask_openapi3/models/xml.py
9 10 11 12 13 14 15 16 17 18 19 20 21 |
|