modelsSchemaTypeSchemaOrBoolSecuritySchemeBaseModelWithConfigContactLicenseInfoServerVariableServerReferenceDiscriminatorXMLExternalDocumentationSchemaschema_vocabularyidanchordynamicAnchorrefdynamicRefdefscommentallOfanyOfoneOfnot_if_thenelse_dependentSchemasprefixItemsitemscontainspropertiespatternPropertiesadditionalPropertiespropertyNamesunevaluatedItemsunevaluatedPropertiestypeenumconstmultipleOfmaximumexclusiveMaximumminimumexclusiveMinimummaxLengthminLengthpatternmaxItemsminItemsuniqueItemsmaxContainsminContainsmaxPropertiesminPropertiesrequireddependentRequiredformatcontentEncodingcontentMediaTypecontentSchematitledescriptiondefaultdeprecatedreadOnlywriteOnlyexamplesdiscriminatorxmlexternalDocsexamplemodel_config
ExampleParameterInTypeEncodingMediaTypeParameterBaseParameterHeaderRequestBodyLinkResponseOperationPathItemSecuritySchemeTypeSecurityBaseAPIKeyInAPIKeyHTTPBaseHTTPBearerOAuthFlowOAuthFlowImplicitOAuthFlowPasswordOAuthFlowClientCredentialsOAuthFlowAuthorizationCodeOAuthFlowsOAuth2OpenIdConnectComponentsTagOpenAPI
OpenAPImodels¶
OpenAPI Pydantic models used to generate and validate the generated OpenAPI.
fastapi.openapi.models¶
SchemaTypemodule-attribute¶
SchemaType=Literal["array","boolean","integer","null","number","object","string",]SecuritySchememodule-attribute¶
SecurityScheme=(APIKey|HTTPBase|OAuth2|OpenIdConnect|HTTPBearer)BaseModelWithConfig¶
Bases:BaseModel
model_configclass-attributeinstance-attribute¶
model_config={'extra':'allow'}Contact¶
Bases:BaseModelWithConfig
License¶
Bases:BaseModelWithConfig
Info¶
Bases:BaseModelWithConfig
titleinstance-attribute¶
titlesummaryclass-attributeinstance-attribute¶
summary=Nonedescriptionclass-attributeinstance-attribute¶
description=NonetermsOfServiceclass-attributeinstance-attribute¶
termsOfService=Nonecontactclass-attributeinstance-attribute¶
contact=Nonelicenseclass-attributeinstance-attribute¶
license=Noneversioninstance-attribute¶
versionmodel_configclass-attributeinstance-attribute¶
model_config={'extra':'allow'}ServerVariable¶
Bases:BaseModelWithConfig
Server¶
Bases:BaseModelWithConfig
Discriminator¶
XML¶
Bases:BaseModelWithConfig
nameclass-attributeinstance-attribute¶
name=Nonenamespaceclass-attributeinstance-attribute¶
namespace=Noneprefixclass-attributeinstance-attribute¶
prefix=Noneattributeclass-attributeinstance-attribute¶
attribute=Nonewrappedclass-attributeinstance-attribute¶
wrapped=Nonemodel_configclass-attributeinstance-attribute¶
model_config={'extra':'allow'}ExternalDocumentation¶
Bases:BaseModelWithConfig
Schema¶
Bases:BaseModelWithConfig
schema_class-attributeinstance-attribute¶
schema_=Field(default=None,alias='$schema')vocabularyclass-attributeinstance-attribute¶
vocabulary=Field(default=None,alias='$vocabulary')idclass-attributeinstance-attribute¶
id=Field(default=None,alias='$id')anchorclass-attributeinstance-attribute¶
anchor=Field(default=None,alias='$anchor')dynamicAnchorclass-attributeinstance-attribute¶
dynamicAnchor=Field(default=None,alias='$dynamicAnchor')refclass-attributeinstance-attribute¶
ref=Field(default=None,alias='$ref')dynamicRefclass-attributeinstance-attribute¶
dynamicRef=Field(default=None,alias='$dynamicRef')defsclass-attributeinstance-attribute¶
defs=Field(default=None,alias='$defs')commentclass-attributeinstance-attribute¶
comment=Field(default=None,alias='$comment')allOfclass-attributeinstance-attribute¶
allOf=NoneanyOfclass-attributeinstance-attribute¶
anyOf=NoneoneOfclass-attributeinstance-attribute¶
oneOf=Nonenot_class-attributeinstance-attribute¶
not_=Field(default=None,alias='not')if_class-attributeinstance-attribute¶
if_=Field(default=None,alias='if')thenclass-attributeinstance-attribute¶
then=Noneelse_class-attributeinstance-attribute¶
else_=Field(default=None,alias='else')dependentSchemasclass-attributeinstance-attribute¶
dependentSchemas=NoneprefixItemsclass-attributeinstance-attribute¶
prefixItems=Noneitemsclass-attributeinstance-attribute¶
items=Nonecontainsclass-attributeinstance-attribute¶
contains=Nonepropertiesclass-attributeinstance-attribute¶
properties=NonepatternPropertiesclass-attributeinstance-attribute¶
patternProperties=NoneadditionalPropertiesclass-attributeinstance-attribute¶
additionalProperties=NonepropertyNamesclass-attributeinstance-attribute¶
propertyNames=NoneunevaluatedItemsclass-attributeinstance-attribute¶
unevaluatedItems=NoneunevaluatedPropertiesclass-attributeinstance-attribute¶
unevaluatedProperties=Nonetypeclass-attributeinstance-attribute¶
type=Noneenumclass-attributeinstance-attribute¶
enum=Noneconstclass-attributeinstance-attribute¶
const=NonemultipleOfclass-attributeinstance-attribute¶
multipleOf=Field(default=None,gt=0)maximumclass-attributeinstance-attribute¶
maximum=NoneexclusiveMaximumclass-attributeinstance-attribute¶
exclusiveMaximum=Noneminimumclass-attributeinstance-attribute¶
minimum=NoneexclusiveMinimumclass-attributeinstance-attribute¶
exclusiveMinimum=NonemaxLengthclass-attributeinstance-attribute¶
maxLength=Field(default=None,ge=0)minLengthclass-attributeinstance-attribute¶
minLength=Field(default=None,ge=0)patternclass-attributeinstance-attribute¶
pattern=NonemaxItemsclass-attributeinstance-attribute¶
maxItems=Field(default=None,ge=0)minItemsclass-attributeinstance-attribute¶
minItems=Field(default=None,ge=0)uniqueItemsclass-attributeinstance-attribute¶
uniqueItems=NonemaxContainsclass-attributeinstance-attribute¶
maxContains=Field(default=None,ge=0)minContainsclass-attributeinstance-attribute¶
minContains=Field(default=None,ge=0)maxPropertiesclass-attributeinstance-attribute¶
maxProperties=Field(default=None,ge=0)minPropertiesclass-attributeinstance-attribute¶
minProperties=Field(default=None,ge=0)requiredclass-attributeinstance-attribute¶
required=NonedependentRequiredclass-attributeinstance-attribute¶
dependentRequired=Noneformatclass-attributeinstance-attribute¶
format=NonecontentEncodingclass-attributeinstance-attribute¶
contentEncoding=NonecontentMediaTypeclass-attributeinstance-attribute¶
contentMediaType=NonecontentSchemaclass-attributeinstance-attribute¶
contentSchema=Nonetitleclass-attributeinstance-attribute¶
title=Nonedescriptionclass-attributeinstance-attribute¶
description=Nonedefaultclass-attributeinstance-attribute¶
default=Nonedeprecatedclass-attributeinstance-attribute¶
deprecated=NonereadOnlyclass-attributeinstance-attribute¶
readOnly=NonewriteOnlyclass-attributeinstance-attribute¶
writeOnly=Noneexamplesclass-attributeinstance-attribute¶
examples=Nonediscriminatorclass-attributeinstance-attribute¶
discriminator=Nonexmlclass-attributeinstance-attribute¶
xml=NoneexternalDocsclass-attributeinstance-attribute¶
externalDocs=Noneexampleclass-attributeinstance-attribute¶
example=NoneDeprecated in OpenAPI 3.1.0 that now uses JSON Schema 2020-12, although still supported. Use examples instead.
model_configclass-attributeinstance-attribute¶
model_config={'extra':'allow'}Example¶
ParameterInType¶
Encoding¶
Bases:BaseModelWithConfig
contentTypeclass-attributeinstance-attribute¶
contentType=Noneheadersclass-attributeinstance-attribute¶
headers=Nonestyleclass-attributeinstance-attribute¶
style=Noneexplodeclass-attributeinstance-attribute¶
explode=NoneallowReservedclass-attributeinstance-attribute¶
allowReserved=Nonemodel_configclass-attributeinstance-attribute¶
model_config={'extra':'allow'}MediaType¶
Bases:BaseModelWithConfig
schema_class-attributeinstance-attribute¶
schema_=Field(default=None,alias='schema')exampleclass-attributeinstance-attribute¶
example=Noneexamplesclass-attributeinstance-attribute¶
examples=Noneencodingclass-attributeinstance-attribute¶
encoding=Nonemodel_configclass-attributeinstance-attribute¶
model_config={'extra':'allow'}ParameterBase¶
Bases:BaseModelWithConfig
descriptionclass-attributeinstance-attribute¶
description=Nonerequiredclass-attributeinstance-attribute¶
required=Nonedeprecatedclass-attributeinstance-attribute¶
deprecated=Nonestyleclass-attributeinstance-attribute¶
style=Noneexplodeclass-attributeinstance-attribute¶
explode=NoneallowReservedclass-attributeinstance-attribute¶
allowReserved=Noneschema_class-attributeinstance-attribute¶
schema_=Field(default=None,alias='schema')exampleclass-attributeinstance-attribute¶
example=Noneexamplesclass-attributeinstance-attribute¶
examples=Nonecontentclass-attributeinstance-attribute¶
content=Nonemodel_configclass-attributeinstance-attribute¶
model_config={'extra':'allow'}Parameter¶
Bases:ParameterBase
nameinstance-attribute¶
namein_class-attributeinstance-attribute¶
in_=Field(alias='in')model_configclass-attributeinstance-attribute¶
model_config={'extra':'allow'}descriptionclass-attributeinstance-attribute¶
description=Nonerequiredclass-attributeinstance-attribute¶
required=Nonedeprecatedclass-attributeinstance-attribute¶
deprecated=Nonestyleclass-attributeinstance-attribute¶
style=Noneexplodeclass-attributeinstance-attribute¶
explode=NoneallowReservedclass-attributeinstance-attribute¶
allowReserved=Noneschema_class-attributeinstance-attribute¶
schema_=Field(default=None,alias='schema')exampleclass-attributeinstance-attribute¶
example=Noneexamplesclass-attributeinstance-attribute¶
examples=Nonecontentclass-attributeinstance-attribute¶
content=NoneHeader¶
Bases:ParameterBase
model_configclass-attributeinstance-attribute¶
model_config={'extra':'allow'}descriptionclass-attributeinstance-attribute¶
description=Nonerequiredclass-attributeinstance-attribute¶
required=Nonedeprecatedclass-attributeinstance-attribute¶
deprecated=Nonestyleclass-attributeinstance-attribute¶
style=Noneexplodeclass-attributeinstance-attribute¶
explode=NoneallowReservedclass-attributeinstance-attribute¶
allowReserved=Noneschema_class-attributeinstance-attribute¶
schema_=Field(default=None,alias='schema')exampleclass-attributeinstance-attribute¶
example=Noneexamplesclass-attributeinstance-attribute¶
examples=Nonecontentclass-attributeinstance-attribute¶
content=NoneRequestBody¶
Bases:BaseModelWithConfig
Link¶
Bases:BaseModelWithConfig
operationRefclass-attributeinstance-attribute¶
operationRef=NoneoperationIdclass-attributeinstance-attribute¶
operationId=Noneparametersclass-attributeinstance-attribute¶
parameters=NonerequestBodyclass-attributeinstance-attribute¶
requestBody=Nonedescriptionclass-attributeinstance-attribute¶
description=Noneserverclass-attributeinstance-attribute¶
server=Nonemodel_configclass-attributeinstance-attribute¶
model_config={'extra':'allow'}Response¶
Operation¶
Bases:BaseModelWithConfig
tagsclass-attributeinstance-attribute¶
tags=Nonesummaryclass-attributeinstance-attribute¶
summary=Nonedescriptionclass-attributeinstance-attribute¶
description=NoneexternalDocsclass-attributeinstance-attribute¶
externalDocs=NoneoperationIdclass-attributeinstance-attribute¶
operationId=Noneparametersclass-attributeinstance-attribute¶
parameters=NonerequestBodyclass-attributeinstance-attribute¶
requestBody=Noneresponsesclass-attributeinstance-attribute¶
responses=Nonecallbacksclass-attributeinstance-attribute¶
callbacks=Nonedeprecatedclass-attributeinstance-attribute¶
deprecated=Nonesecurityclass-attributeinstance-attribute¶
security=Noneserversclass-attributeinstance-attribute¶
servers=Nonemodel_configclass-attributeinstance-attribute¶
model_config={'extra':'allow'}PathItem¶
Bases:BaseModelWithConfig
refclass-attributeinstance-attribute¶
ref=Field(default=None,alias='$ref')summaryclass-attributeinstance-attribute¶
summary=Nonedescriptionclass-attributeinstance-attribute¶
description=Nonegetclass-attributeinstance-attribute¶
get=Noneputclass-attributeinstance-attribute¶
put=Nonepostclass-attributeinstance-attribute¶
post=Nonedeleteclass-attributeinstance-attribute¶
delete=Noneoptionsclass-attributeinstance-attribute¶
options=Noneheadclass-attributeinstance-attribute¶
head=Nonepatchclass-attributeinstance-attribute¶
patch=Nonetraceclass-attributeinstance-attribute¶
trace=Noneserversclass-attributeinstance-attribute¶
servers=Noneparametersclass-attributeinstance-attribute¶
parameters=Nonemodel_configclass-attributeinstance-attribute¶
model_config={'extra':'allow'}SecuritySchemeType¶
SecurityBase¶
Bases:BaseModelWithConfig
APIKeyIn¶
APIKey¶
Bases:SecurityBase
HTTPBase¶
HTTPBearer¶
OAuthFlow¶
Bases:BaseModelWithConfig
OAuthFlowImplicit¶
OAuthFlowPassword¶
OAuthFlowClientCredentials¶
OAuthFlowAuthorizationCode¶
OAuthFlows¶
Bases:BaseModelWithConfig
implicitclass-attributeinstance-attribute¶
implicit=Nonepasswordclass-attributeinstance-attribute¶
password=NoneclientCredentialsclass-attributeinstance-attribute¶
clientCredentials=NoneauthorizationCodeclass-attributeinstance-attribute¶
authorizationCode=Nonemodel_configclass-attributeinstance-attribute¶
model_config={'extra':'allow'}OAuth2¶
OpenIdConnect¶
Bases:SecurityBase
type_class-attributeinstance-attribute¶
type_=Field(default=openIdConnect,alias='type')openIdConnectUrlinstance-attribute¶
openIdConnectUrlmodel_configclass-attributeinstance-attribute¶
model_config={'extra':'allow'}descriptionclass-attributeinstance-attribute¶
description=NoneComponents¶
Bases:BaseModelWithConfig
schemasclass-attributeinstance-attribute¶
schemas=Noneresponsesclass-attributeinstance-attribute¶
responses=Noneparametersclass-attributeinstance-attribute¶
parameters=Noneexamplesclass-attributeinstance-attribute¶
examples=NonerequestBodiesclass-attributeinstance-attribute¶
requestBodies=Noneheadersclass-attributeinstance-attribute¶
headers=NonesecuritySchemesclass-attributeinstance-attribute¶
securitySchemes=Nonelinksclass-attributeinstance-attribute¶
links=Nonecallbacksclass-attributeinstance-attribute¶
callbacks=NonepathItemsclass-attributeinstance-attribute¶
pathItems=Nonemodel_configclass-attributeinstance-attribute¶
model_config={'extra':'allow'}Tag¶
Bases:BaseModelWithConfig
OpenAPI¶
Bases:BaseModelWithConfig
openapiinstance-attribute¶
openapiinfoinstance-attribute¶
infojsonSchemaDialectclass-attributeinstance-attribute¶
jsonSchemaDialect=Noneserversclass-attributeinstance-attribute¶
servers=Nonepathsclass-attributeinstance-attribute¶
paths=Nonewebhooksclass-attributeinstance-attribute¶
webhooks=Nonecomponentsclass-attributeinstance-attribute¶
components=Nonesecurityclass-attributeinstance-attribute¶
security=Nonetagsclass-attributeinstance-attribute¶
tags=NoneexternalDocsclass-attributeinstance-attribute¶
externalDocs=Nonemodel_configclass-attributeinstance-attribute¶
model_config={'extra':'allow'}






