Skip to main content
FastAPI Docs

Search documentation

Type to search this documentation.

On this pageOverview

OpenAPI models¶

OpenAPI Pydantic models used to generate and validate the generated OpenAPI.

fastapi.openapi.models

Section titled “fastapi.openapi.models ¶”

SchemaType module-attribute

Section titled “SchemaType module-attribute ¶”
SchemaType = Literal[
    "array",
    "boolean",
    "integer",
    "null",
    "number",
    "object",
    "string",
]

SchemaOrBool module-attribute

Section titled “SchemaOrBool module-attribute ¶”
SchemaOrBool = Schema | bool

SecurityScheme module-attribute

Section titled “SecurityScheme module-attribute ¶”
SecurityScheme = (
    APIKey | HTTPBase | OAuth2 | OpenIdConnect | HTTPBearer
)

BaseModelWithConfig

Section titled “BaseModelWithConfig ¶”

Bases: BaseModel

model_config class-attribute instance-attribute

Section titled “model_config class-attribute instance-attribute ¶”
model_config = {'extra': 'allow'}

Contact

Section titled “Contact ¶”

Bases: BaseModelWithConfig

name class-attribute instance-attribute

Section titled “name class-attribute instance-attribute ¶”
name = None

url class-attribute instance-attribute

Section titled “url class-attribute instance-attribute ¶”
url = None

email class-attribute instance-attribute

Section titled “email class-attribute instance-attribute ¶”
email = None

model_config class-attribute instance-attribute

Section titled “model_config class-attribute instance-attribute ¶”
model_config = {'extra': 'allow'}

License

Section titled “License ¶”

Bases: BaseModelWithConfig

name instance-attribute

Section titled “name instance-attribute ¶”
name

identifier class-attribute instance-attribute

Section titled “identifier class-attribute instance-attribute ¶”
identifier = None

url class-attribute instance-attribute

Section titled “url class-attribute instance-attribute ¶”
url = None

model_config class-attribute instance-attribute

Section titled “model_config class-attribute instance-attribute ¶”
model_config = {'extra': 'allow'}

Info

Section titled “Info ¶”

Bases: BaseModelWithConfig

title instance-attribute

Section titled “title instance-attribute ¶”
title

summary class-attribute instance-attribute

Section titled “summary class-attribute instance-attribute ¶”
summary = None

description class-attribute instance-attribute

Section titled “description class-attribute instance-attribute ¶”
description = None

termsOfService class-attribute instance-attribute

Section titled “termsOfService class-attribute instance-attribute ¶”
termsOfService = None

contact class-attribute instance-attribute

Section titled “contact class-attribute instance-attribute ¶”
contact = None

license class-attribute instance-attribute

Section titled “license class-attribute instance-attribute ¶”
license = None

version instance-attribute

Section titled “version instance-attribute ¶”
version

model_config class-attribute instance-attribute

Section titled “model_config class-attribute instance-attribute ¶”
model_config = {'extra': 'allow'}

ServerVariable

Section titled “ServerVariable ¶”

Bases: BaseModelWithConfig

enum class-attribute instance-attribute

Section titled “enum class-attribute instance-attribute ¶”
enum = None

default instance-attribute

Section titled “default instance-attribute ¶”
default

description class-attribute instance-attribute

Section titled “description class-attribute instance-attribute ¶”
description = None

model_config class-attribute instance-attribute

Section titled “model_config class-attribute instance-attribute ¶”
model_config = {'extra': 'allow'}

Server

Section titled “Server ¶”

Bases: BaseModelWithConfig

url instance-attribute

Section titled “url instance-attribute ¶”
url

description class-attribute instance-attribute

Section titled “description class-attribute instance-attribute ¶”
description = None

variables class-attribute instance-attribute

Section titled “variables class-attribute instance-attribute ¶”
variables = None

model_config class-attribute instance-attribute

Section titled “model_config class-attribute instance-attribute ¶”
model_config = {'extra': 'allow'}

Reference

Section titled “Reference ¶”

Bases: BaseModel

ref class-attribute instance-attribute

Section titled “ref class-attribute instance-attribute ¶”
ref = Field(alias='$ref')

Discriminator

Section titled “Discriminator ¶”

Bases: BaseModel

propertyName instance-attribute

Section titled “propertyName instance-attribute ¶”
propertyName

mapping class-attribute instance-attribute

Section titled “mapping class-attribute instance-attribute ¶”
mapping = None

XML

Section titled “XML ¶”

Bases: BaseModelWithConfig

name class-attribute instance-attribute

Section titled “name class-attribute instance-attribute ¶”
name = None

namespace class-attribute instance-attribute

Section titled “namespace class-attribute instance-attribute ¶”
namespace = None

prefix class-attribute instance-attribute

Section titled “prefix class-attribute instance-attribute ¶”
prefix = None

attribute class-attribute instance-attribute

Section titled “attribute class-attribute instance-attribute ¶”
attribute = None

wrapped class-attribute instance-attribute

Section titled “wrapped class-attribute instance-attribute ¶”
wrapped = None

model_config class-attribute instance-attribute

Section titled “model_config class-attribute instance-attribute ¶”
model_config = {'extra': 'allow'}

ExternalDocumentation

Section titled “ExternalDocumentation ¶”

Bases: BaseModelWithConfig

description class-attribute instance-attribute

Section titled “description class-attribute instance-attribute ¶”
description = None

url instance-attribute

Section titled “url instance-attribute ¶”
url

model_config class-attribute instance-attribute

Section titled “model_config class-attribute instance-attribute ¶”
model_config = {'extra': 'allow'}

Schema

Section titled “Schema ¶”

Bases: BaseModelWithConfig

schema_ class-attribute instance-attribute

Section titled “schema_ class-attribute instance-attribute ¶”
schema_ = Field(default=None, alias='$schema')

vocabulary class-attribute instance-attribute

Section titled “vocabulary class-attribute instance-attribute ¶”
vocabulary = Field(default=None, alias='$vocabulary')

id class-attribute instance-attribute

Section titled “id class-attribute instance-attribute ¶”
id = Field(default=None, alias='$id')

anchor class-attribute instance-attribute

Section titled “anchor class-attribute instance-attribute ¶”
anchor = Field(default=None, alias='$anchor')

dynamicAnchor class-attribute instance-attribute

Section titled “dynamicAnchor class-attribute instance-attribute ¶”
dynamicAnchor = Field(default=None, alias='$dynamicAnchor')

ref class-attribute instance-attribute

Section titled “ref class-attribute instance-attribute ¶”
ref = Field(default=None, alias='$ref')

dynamicRef class-attribute instance-attribute

Section titled “dynamicRef class-attribute instance-attribute ¶”
dynamicRef = Field(default=None, alias='$dynamicRef')

defs class-attribute instance-attribute

Section titled “defs class-attribute instance-attribute ¶”
defs = Field(default=None, alias='$defs')

comment class-attribute instance-attribute

Section titled “comment class-attribute instance-attribute ¶”
comment = Field(default=None, alias='$comment')

allOf class-attribute instance-attribute

Section titled “allOf class-attribute instance-attribute ¶”
allOf = None

anyOf class-attribute instance-attribute

Section titled “anyOf class-attribute instance-attribute ¶”
anyOf = None

oneOf class-attribute instance-attribute

Section titled “oneOf class-attribute instance-attribute ¶”
oneOf = None

not_ class-attribute instance-attribute

Section titled “not_ class-attribute instance-attribute ¶”
not_ = Field(default=None, alias='not')

if_ class-attribute instance-attribute

Section titled “if_ class-attribute instance-attribute ¶”
if_ = Field(default=None, alias='if')

then class-attribute instance-attribute

Section titled “then class-attribute instance-attribute ¶”
then = None

else_ class-attribute instance-attribute

Section titled “else_ class-attribute instance-attribute ¶”
else_ = Field(default=None, alias='else')

dependentSchemas class-attribute instance-attribute

Section titled “dependentSchemas class-attribute instance-attribute ¶”
dependentSchemas = None

prefixItems class-attribute instance-attribute

Section titled “prefixItems class-attribute instance-attribute ¶”
prefixItems = None

items class-attribute instance-attribute

Section titled “items class-attribute instance-attribute ¶”
items = None

contains class-attribute instance-attribute

Section titled “contains class-attribute instance-attribute ¶”
contains = None

properties class-attribute instance-attribute

Section titled “properties class-attribute instance-attribute ¶”
properties = None

patternProperties class-attribute instance-attribute

Section titled “patternProperties class-attribute instance-attribute ¶”
patternProperties = None

additionalProperties class-attribute instance-attribute

Section titled “additionalProperties class-attribute instance-attribute ¶”
additionalProperties = None

propertyNames class-attribute instance-attribute

Section titled “propertyNames class-attribute instance-attribute ¶”
propertyNames = None

unevaluatedItems class-attribute instance-attribute

Section titled “unevaluatedItems class-attribute instance-attribute ¶”
unevaluatedItems = None

unevaluatedProperties class-attribute instance-attribute

Section titled “unevaluatedProperties class-attribute instance-attribute ¶”
unevaluatedProperties = None

type class-attribute instance-attribute

Section titled “type class-attribute instance-attribute ¶”
type = None

enum class-attribute instance-attribute

Section titled “enum class-attribute instance-attribute ¶”
enum = None

const class-attribute instance-attribute

Section titled “const class-attribute instance-attribute ¶”
const = None

multipleOf class-attribute instance-attribute

Section titled “multipleOf class-attribute instance-attribute ¶”
multipleOf = Field(default=None, gt=0)

maximum class-attribute instance-attribute

Section titled “maximum class-attribute instance-attribute ¶”
maximum = None

exclusiveMaximum class-attribute instance-attribute

Section titled “exclusiveMaximum class-attribute instance-attribute ¶”
exclusiveMaximum = None

minimum class-attribute instance-attribute

Section titled “minimum class-attribute instance-attribute ¶”
minimum = None

exclusiveMinimum class-attribute instance-attribute

Section titled “exclusiveMinimum class-attribute instance-attribute ¶”
exclusiveMinimum = None

maxLength class-attribute instance-attribute

Section titled “maxLength class-attribute instance-attribute ¶”
maxLength = Field(default=None, ge=0)

minLength class-attribute instance-attribute

Section titled “minLength class-attribute instance-attribute ¶”
minLength = Field(default=None, ge=0)

pattern class-attribute instance-attribute

Section titled “pattern class-attribute instance-attribute ¶”
pattern = None

maxItems class-attribute instance-attribute

Section titled “maxItems class-attribute instance-attribute ¶”
maxItems = Field(default=None, ge=0)

minItems class-attribute instance-attribute

Section titled “minItems class-attribute instance-attribute ¶”
minItems = Field(default=None, ge=0)

uniqueItems class-attribute instance-attribute

Section titled “uniqueItems class-attribute instance-attribute ¶”
uniqueItems = None

maxContains class-attribute instance-attribute

Section titled “maxContains class-attribute instance-attribute ¶”
maxContains = Field(default=None, ge=0)

minContains class-attribute instance-attribute

Section titled “minContains class-attribute instance-attribute ¶”
minContains = Field(default=None, ge=0)

maxProperties class-attribute instance-attribute

Section titled “maxProperties class-attribute instance-attribute ¶”
maxProperties = Field(default=None, ge=0)

minProperties class-attribute instance-attribute

Section titled “minProperties class-attribute instance-attribute ¶”
minProperties = Field(default=None, ge=0)

required class-attribute instance-attribute

Section titled “required class-attribute instance-attribute ¶”
required = None

dependentRequired class-attribute instance-attribute

Section titled “dependentRequired class-attribute instance-attribute ¶”
dependentRequired = None

format class-attribute instance-attribute

Section titled “format class-attribute instance-attribute ¶”
format = None

contentEncoding class-attribute instance-attribute

Section titled “contentEncoding class-attribute instance-attribute ¶”
contentEncoding = None

contentMediaType class-attribute instance-attribute

Section titled “contentMediaType class-attribute instance-attribute ¶”
contentMediaType = None

contentSchema class-attribute instance-attribute

Section titled “contentSchema class-attribute instance-attribute ¶”
contentSchema = None

title class-attribute instance-attribute

Section titled “title class-attribute instance-attribute ¶”
title = None

description class-attribute instance-attribute

Section titled “description class-attribute instance-attribute ¶”
description = None

default class-attribute instance-attribute

Section titled “default class-attribute instance-attribute ¶”
default = None

deprecated class-attribute instance-attribute

Section titled “deprecated class-attribute instance-attribute ¶”
deprecated = None

readOnly class-attribute instance-attribute

Section titled “readOnly class-attribute instance-attribute ¶”
readOnly = None

writeOnly class-attribute instance-attribute

Section titled “writeOnly class-attribute instance-attribute ¶”
writeOnly = None

examples class-attribute instance-attribute

Section titled “examples class-attribute instance-attribute ¶”
examples = None

discriminator class-attribute instance-attribute

Section titled “discriminator class-attribute instance-attribute ¶”
discriminator = None

xml class-attribute instance-attribute

Section titled “xml class-attribute instance-attribute ¶”
xml = None

externalDocs class-attribute instance-attribute

Section titled “externalDocs class-attribute instance-attribute ¶”
externalDocs = None

example class-attribute instance-attribute

Section titled “example class-attribute instance-attribute ¶”
example = None
Deprecated in OpenAPI 3.1.0 that now uses JSON Schema 2020-12, although still supported. Use examples instead.

model_config class-attribute instance-attribute

Section titled “model_config class-attribute instance-attribute ¶”
model_config = {'extra': 'allow'}

Example

Section titled “Example ¶”

Bases: TypedDict

summary instance-attribute

Section titled “summary instance-attribute ¶”
summary

description instance-attribute

Section titled “description instance-attribute ¶”
description

value instance-attribute

Section titled “value instance-attribute ¶”
value

externalValue instance-attribute

Section titled “externalValue instance-attribute ¶”
externalValue

ParameterInType

Section titled “ParameterInType ¶”

Bases: Enum

query class-attribute instance-attribute

Section titled “query class-attribute instance-attribute ¶”
query = 'query'

header class-attribute instance-attribute

Section titled “header class-attribute instance-attribute ¶”
header = 'header'

path class-attribute instance-attribute

Section titled “path class-attribute instance-attribute ¶”
path = 'path'

cookie class-attribute instance-attribute

Section titled “cookie class-attribute instance-attribute ¶”
cookie = 'cookie'

Encoding

Section titled “Encoding ¶”

Bases: BaseModelWithConfig

contentType class-attribute instance-attribute

Section titled “contentType class-attribute instance-attribute ¶”
contentType = None

headers class-attribute instance-attribute

Section titled “headers class-attribute instance-attribute ¶”
headers = None

style class-attribute instance-attribute

Section titled “style class-attribute instance-attribute ¶”
style = None

explode class-attribute instance-attribute

Section titled “explode class-attribute instance-attribute ¶”
explode = None

allowReserved class-attribute instance-attribute

Section titled “allowReserved class-attribute instance-attribute ¶”
allowReserved = None

model_config class-attribute instance-attribute

Section titled “model_config class-attribute instance-attribute ¶”
model_config = {'extra': 'allow'}

MediaType

Section titled “MediaType ¶”

Bases: BaseModelWithConfig

schema_ class-attribute instance-attribute

Section titled “schema_ class-attribute instance-attribute ¶”
schema_ = Field(default=None, alias='schema')

example class-attribute instance-attribute

Section titled “example class-attribute instance-attribute ¶”
example = None

examples class-attribute instance-attribute

Section titled “examples class-attribute instance-attribute ¶”
examples = None

encoding class-attribute instance-attribute

Section titled “encoding class-attribute instance-attribute ¶”
encoding = None

model_config class-attribute instance-attribute

Section titled “model_config class-attribute instance-attribute ¶”
model_config = {'extra': 'allow'}

ParameterBase

Section titled “ParameterBase ¶”

Bases: BaseModelWithConfig

description class-attribute instance-attribute

Section titled “description class-attribute instance-attribute ¶”
description = None

required class-attribute instance-attribute

Section titled “required class-attribute instance-attribute ¶”
required = None

deprecated class-attribute instance-attribute

Section titled “deprecated class-attribute instance-attribute ¶”
deprecated = None

style class-attribute instance-attribute

Section titled “style class-attribute instance-attribute ¶”
style = None

explode class-attribute instance-attribute

Section titled “explode class-attribute instance-attribute ¶”
explode = None

allowReserved class-attribute instance-attribute

Section titled “allowReserved class-attribute instance-attribute ¶”
allowReserved = None

schema_ class-attribute instance-attribute

Section titled “schema_ class-attribute instance-attribute ¶”
schema_ = Field(default=None, alias='schema')

example class-attribute instance-attribute

Section titled “example class-attribute instance-attribute ¶”
example = None

examples class-attribute instance-attribute

Section titled “examples class-attribute instance-attribute ¶”
examples = None

content class-attribute instance-attribute

Section titled “content class-attribute instance-attribute ¶”
content = None

model_config class-attribute instance-attribute

Section titled “model_config class-attribute instance-attribute ¶”
model_config = {'extra': 'allow'}

Parameter

Section titled “Parameter ¶”

Bases: ParameterBase

name instance-attribute

Section titled “name instance-attribute ¶”
name

in_ class-attribute instance-attribute

Section titled “in_ class-attribute instance-attribute ¶”
in_ = Field(alias='in')

model_config class-attribute instance-attribute

Section titled “model_config class-attribute instance-attribute ¶”
model_config = {'extra': 'allow'}

description class-attribute instance-attribute

Section titled “description class-attribute instance-attribute ¶”
description = None

required class-attribute instance-attribute

Section titled “required class-attribute instance-attribute ¶”
required = None

deprecated class-attribute instance-attribute

Section titled “deprecated class-attribute instance-attribute ¶”
deprecated = None

style class-attribute instance-attribute

Section titled “style class-attribute instance-attribute ¶”
style = None

explode class-attribute instance-attribute

Section titled “explode class-attribute instance-attribute ¶”
explode = None

allowReserved class-attribute instance-attribute

Section titled “allowReserved class-attribute instance-attribute ¶”
allowReserved = None

schema_ class-attribute instance-attribute

Section titled “schema_ class-attribute instance-attribute ¶”
schema_ = Field(default=None, alias='schema')

example class-attribute instance-attribute

Section titled “example class-attribute instance-attribute ¶”
example = None

examples class-attribute instance-attribute

Section titled “examples class-attribute instance-attribute ¶”
examples = None

content class-attribute instance-attribute

Section titled “content class-attribute instance-attribute ¶”
content = None

Header

Section titled “Header ¶”

Bases: ParameterBase

model_config class-attribute instance-attribute

Section titled “model_config class-attribute instance-attribute ¶”
model_config = {'extra': 'allow'}

description class-attribute instance-attribute

Section titled “description class-attribute instance-attribute ¶”
description = None

required class-attribute instance-attribute

Section titled “required class-attribute instance-attribute ¶”
required = None

deprecated class-attribute instance-attribute

Section titled “deprecated class-attribute instance-attribute ¶”
deprecated = None

style class-attribute instance-attribute

Section titled “style class-attribute instance-attribute ¶”
style = None

explode class-attribute instance-attribute

Section titled “explode class-attribute instance-attribute ¶”
explode = None

allowReserved class-attribute instance-attribute

Section titled “allowReserved class-attribute instance-attribute ¶”
allowReserved = None

schema_ class-attribute instance-attribute

Section titled “schema_ class-attribute instance-attribute ¶”
schema_ = Field(default=None, alias='schema')

example class-attribute instance-attribute

Section titled “example class-attribute instance-attribute ¶”
example = None

examples class-attribute instance-attribute

Section titled “examples class-attribute instance-attribute ¶”
examples = None

content class-attribute instance-attribute

Section titled “content class-attribute instance-attribute ¶”
content = None

RequestBody

Section titled “RequestBody ¶”

Bases: BaseModelWithConfig

description class-attribute instance-attribute

Section titled “description class-attribute instance-attribute ¶”
description = None

content instance-attribute

Section titled “content instance-attribute ¶”
content

required class-attribute instance-attribute

Section titled “required class-attribute instance-attribute ¶”
required = None

model_config class-attribute instance-attribute

Section titled “model_config class-attribute instance-attribute ¶”
model_config = {'extra': 'allow'}

Link

Section titled “Link ¶”

Bases: BaseModelWithConfig

operationRef class-attribute instance-attribute

Section titled “operationRef class-attribute instance-attribute ¶”
operationRef = None

operationId class-attribute instance-attribute

Section titled “operationId class-attribute instance-attribute ¶”
operationId = None

parameters class-attribute instance-attribute

Section titled “parameters class-attribute instance-attribute ¶”
parameters = None

requestBody class-attribute instance-attribute

Section titled “requestBody class-attribute instance-attribute ¶”
requestBody = None

description class-attribute instance-attribute

Section titled “description class-attribute instance-attribute ¶”
description = None

server class-attribute instance-attribute

Section titled “server class-attribute instance-attribute ¶”
server = None

model_config class-attribute instance-attribute

Section titled “model_config class-attribute instance-attribute ¶”
model_config = {'extra': 'allow'}

Response

Section titled “Response ¶”

Bases: BaseModelWithConfig

description instance-attribute

Section titled “description instance-attribute ¶”
description

headers class-attribute instance-attribute

Section titled “headers class-attribute instance-attribute ¶”
headers = None

content class-attribute instance-attribute

Section titled “content class-attribute instance-attribute ¶”
content = None

links class-attribute instance-attribute

Section titled “links class-attribute instance-attribute ¶”
links = None

model_config class-attribute instance-attribute

Section titled “model_config class-attribute instance-attribute ¶”
model_config = {'extra': 'allow'}

Operation

Section titled “Operation ¶”

Bases: BaseModelWithConfig

tags class-attribute instance-attribute

Section titled “tags class-attribute instance-attribute ¶”
tags = None

summary class-attribute instance-attribute

Section titled “summary class-attribute instance-attribute ¶”
summary = None

description class-attribute instance-attribute

Section titled “description class-attribute instance-attribute ¶”
description = None

externalDocs class-attribute instance-attribute

Section titled “externalDocs class-attribute instance-attribute ¶”
externalDocs = None

operationId class-attribute instance-attribute

Section titled “operationId class-attribute instance-attribute ¶”
operationId = None

parameters class-attribute instance-attribute

Section titled “parameters class-attribute instance-attribute ¶”
parameters = None

requestBody class-attribute instance-attribute

Section titled “requestBody class-attribute instance-attribute ¶”
requestBody = None

responses class-attribute instance-attribute

Section titled “responses class-attribute instance-attribute ¶”
responses = None

callbacks class-attribute instance-attribute

Section titled “callbacks class-attribute instance-attribute ¶”
callbacks = None

deprecated class-attribute instance-attribute

Section titled “deprecated class-attribute instance-attribute ¶”
deprecated = None

security class-attribute instance-attribute

Section titled “security class-attribute instance-attribute ¶”
security = None

servers class-attribute instance-attribute

Section titled “servers class-attribute instance-attribute ¶”
servers = None

model_config class-attribute instance-attribute

Section titled “model_config class-attribute instance-attribute ¶”
model_config = {'extra': 'allow'}

PathItem

Section titled “PathItem ¶”

Bases: BaseModelWithConfig

ref class-attribute instance-attribute

Section titled “ref class-attribute instance-attribute ¶”
ref = Field(default=None, alias='$ref')

summary class-attribute instance-attribute

Section titled “summary class-attribute instance-attribute ¶”
summary = None

description class-attribute instance-attribute

Section titled “description class-attribute instance-attribute ¶”
description = None

get class-attribute instance-attribute

Section titled “get class-attribute instance-attribute ¶”
get = None

put class-attribute instance-attribute

Section titled “put class-attribute instance-attribute ¶”
put = None

post class-attribute instance-attribute

Section titled “post class-attribute instance-attribute ¶”
post = None

delete class-attribute instance-attribute

Section titled “delete class-attribute instance-attribute ¶”
delete = None

options class-attribute instance-attribute

Section titled “options class-attribute instance-attribute ¶”
options = None

head class-attribute instance-attribute

Section titled “head class-attribute instance-attribute ¶”
head = None

patch class-attribute instance-attribute

Section titled “patch class-attribute instance-attribute ¶”
patch = None

trace class-attribute instance-attribute

Section titled “trace class-attribute instance-attribute ¶”
trace = None

servers class-attribute instance-attribute

Section titled “servers class-attribute instance-attribute ¶”
servers = None

parameters class-attribute instance-attribute

Section titled “parameters class-attribute instance-attribute ¶”
parameters = None

model_config class-attribute instance-attribute

Section titled “model_config class-attribute instance-attribute ¶”
model_config = {'extra': 'allow'}

SecuritySchemeType

Section titled “SecuritySchemeType ¶”

Bases: Enum

apiKey class-attribute instance-attribute

Section titled “apiKey class-attribute instance-attribute ¶”
apiKey = 'apiKey'

http class-attribute instance-attribute

Section titled “http class-attribute instance-attribute ¶”
http = 'http'

oauth2 class-attribute instance-attribute

Section titled “oauth2 class-attribute instance-attribute ¶”
oauth2 = 'oauth2'

openIdConnect class-attribute instance-attribute

Section titled “openIdConnect class-attribute instance-attribute ¶”
openIdConnect = 'openIdConnect'

SecurityBase

Section titled “SecurityBase ¶”

Bases: BaseModelWithConfig

type_ class-attribute instance-attribute

Section titled “type_ class-attribute instance-attribute ¶”
type_ = Field(alias='type')

description class-attribute instance-attribute

Section titled “description class-attribute instance-attribute ¶”
description = None

model_config class-attribute instance-attribute

Section titled “model_config class-attribute instance-attribute ¶”
model_config = {'extra': 'allow'}

APIKeyIn

Section titled “APIKeyIn ¶”

Bases: Enum

query class-attribute instance-attribute

Section titled “query class-attribute instance-attribute ¶”
query = 'query'

header class-attribute instance-attribute

Section titled “header class-attribute instance-attribute ¶”
header = 'header'

cookie class-attribute instance-attribute

Section titled “cookie class-attribute instance-attribute ¶”
cookie = 'cookie'

APIKey

Section titled “APIKey ¶”

Bases: SecurityBase

type_ class-attribute instance-attribute

Section titled “type_ class-attribute instance-attribute ¶”
type_ = Field(default=apiKey, alias='type')

in_ class-attribute instance-attribute

Section titled “in_ class-attribute instance-attribute ¶”
in_ = Field(alias='in')

name instance-attribute

Section titled “name instance-attribute ¶”
name

model_config class-attribute instance-attribute

Section titled “model_config class-attribute instance-attribute ¶”
model_config = {'extra': 'allow'}

description class-attribute instance-attribute

Section titled “description class-attribute instance-attribute ¶”
description = None

HTTPBase

Section titled “HTTPBase ¶”

Bases: SecurityBase

type_ class-attribute instance-attribute

Section titled “type_ class-attribute instance-attribute ¶”
type_ = Field(default=http, alias='type')

scheme instance-attribute

Section titled “scheme instance-attribute ¶”
scheme

model_config class-attribute instance-attribute

Section titled “model_config class-attribute instance-attribute ¶”
model_config = {'extra': 'allow'}

description class-attribute instance-attribute

Section titled “description class-attribute instance-attribute ¶”
description = None

HTTPBearer

Section titled “HTTPBearer ¶”

Bases: HTTPBase

scheme class-attribute instance-attribute

Section titled “scheme class-attribute instance-attribute ¶”
scheme = 'bearer'

bearerFormat class-attribute instance-attribute

Section titled “bearerFormat class-attribute instance-attribute ¶”
bearerFormat = None

model_config class-attribute instance-attribute

Section titled “model_config class-attribute instance-attribute ¶”
model_config = {'extra': 'allow'}

type_ class-attribute instance-attribute

Section titled “type_ class-attribute instance-attribute ¶”
type_ = Field(default=http, alias='type')

description class-attribute instance-attribute

Section titled “description class-attribute instance-attribute ¶”
description = None

OAuthFlow

Section titled “OAuthFlow ¶”

Bases: BaseModelWithConfig

refreshUrl class-attribute instance-attribute

Section titled “refreshUrl class-attribute instance-attribute ¶”
refreshUrl = None

scopes class-attribute instance-attribute

Section titled “scopes class-attribute instance-attribute ¶”
scopes = {}

model_config class-attribute instance-attribute

Section titled “model_config class-attribute instance-attribute ¶”
model_config = {'extra': 'allow'}

OAuthFlowImplicit

Section titled “OAuthFlowImplicit ¶”

Bases: OAuthFlow

authorizationUrl instance-attribute

Section titled “authorizationUrl instance-attribute ¶”
authorizationUrl

model_config class-attribute instance-attribute

Section titled “model_config class-attribute instance-attribute ¶”
model_config = {'extra': 'allow'}

refreshUrl class-attribute instance-attribute

Section titled “refreshUrl class-attribute instance-attribute ¶”
refreshUrl = None

scopes class-attribute instance-attribute

Section titled “scopes class-attribute instance-attribute ¶”
scopes = {}

OAuthFlowPassword

Section titled “OAuthFlowPassword ¶”

Bases: OAuthFlow

tokenUrl instance-attribute

Section titled “tokenUrl instance-attribute ¶”
tokenUrl

model_config class-attribute instance-attribute

Section titled “model_config class-attribute instance-attribute ¶”
model_config = {'extra': 'allow'}

refreshUrl class-attribute instance-attribute

Section titled “refreshUrl class-attribute instance-attribute ¶”
refreshUrl = None

scopes class-attribute instance-attribute

Section titled “scopes class-attribute instance-attribute ¶”
scopes = {}

OAuthFlowClientCredentials

Section titled “OAuthFlowClientCredentials ¶”

Bases: OAuthFlow

tokenUrl instance-attribute

Section titled “tokenUrl instance-attribute ¶”
tokenUrl

model_config class-attribute instance-attribute

Section titled “model_config class-attribute instance-attribute ¶”
model_config = {'extra': 'allow'}

refreshUrl class-attribute instance-attribute

Section titled “refreshUrl class-attribute instance-attribute ¶”
refreshUrl = None

scopes class-attribute instance-attribute

Section titled “scopes class-attribute instance-attribute ¶”
scopes = {}

OAuthFlowAuthorizationCode

Section titled “OAuthFlowAuthorizationCode ¶”

Bases: OAuthFlow

authorizationUrl instance-attribute

Section titled “authorizationUrl instance-attribute ¶”
authorizationUrl

tokenUrl instance-attribute

Section titled “tokenUrl instance-attribute ¶”
tokenUrl

model_config class-attribute instance-attribute

Section titled “model_config class-attribute instance-attribute ¶”
model_config = {'extra': 'allow'}

refreshUrl class-attribute instance-attribute

Section titled “refreshUrl class-attribute instance-attribute ¶”
refreshUrl = None

scopes class-attribute instance-attribute

Section titled “scopes class-attribute instance-attribute ¶”
scopes = {}

OAuthFlows

Section titled “OAuthFlows ¶”

Bases: BaseModelWithConfig

implicit class-attribute instance-attribute

Section titled “implicit class-attribute instance-attribute ¶”
implicit = None

password class-attribute instance-attribute

Section titled “password class-attribute instance-attribute ¶”
password = None

clientCredentials class-attribute instance-attribute

Section titled “clientCredentials class-attribute instance-attribute ¶”
clientCredentials = None

authorizationCode class-attribute instance-attribute

Section titled “authorizationCode class-attribute instance-attribute ¶”
authorizationCode = None

model_config class-attribute instance-attribute

Section titled “model_config class-attribute instance-attribute ¶”
model_config = {'extra': 'allow'}

OAuth2

Section titled “OAuth2 ¶”

Bases: SecurityBase

type_ class-attribute instance-attribute

Section titled “type_ class-attribute instance-attribute ¶”
type_ = Field(default=oauth2, alias='type')

flows instance-attribute

Section titled “flows instance-attribute ¶”
flows

model_config class-attribute instance-attribute

Section titled “model_config class-attribute instance-attribute ¶”
model_config = {'extra': 'allow'}

description class-attribute instance-attribute

Section titled “description class-attribute instance-attribute ¶”
description = None

OpenIdConnect

Section titled “OpenIdConnect ¶”

Bases: SecurityBase

type_ class-attribute instance-attribute

Section titled “type_ class-attribute instance-attribute ¶”
type_ = Field(default=openIdConnect, alias='type')

openIdConnectUrl instance-attribute

Section titled “openIdConnectUrl instance-attribute ¶”
openIdConnectUrl

model_config class-attribute instance-attribute

Section titled “model_config class-attribute instance-attribute ¶”
model_config = {'extra': 'allow'}

description class-attribute instance-attribute

Section titled “description class-attribute instance-attribute ¶”
description = None

Components

Section titled “Components ¶”

Bases: BaseModelWithConfig

schemas class-attribute instance-attribute

Section titled “schemas class-attribute instance-attribute ¶”
schemas = None

responses class-attribute instance-attribute

Section titled “responses class-attribute instance-attribute ¶”
responses = None

parameters class-attribute instance-attribute

Section titled “parameters class-attribute instance-attribute ¶”
parameters = None

examples class-attribute instance-attribute

Section titled “examples class-attribute instance-attribute ¶”
examples = None

requestBodies class-attribute instance-attribute

Section titled “requestBodies class-attribute instance-attribute ¶”
requestBodies = None

headers class-attribute instance-attribute

Section titled “headers class-attribute instance-attribute ¶”
headers = None

securitySchemes class-attribute instance-attribute

Section titled “securitySchemes class-attribute instance-attribute ¶”
securitySchemes = None

links class-attribute instance-attribute

Section titled “links class-attribute instance-attribute ¶”
links = None

callbacks class-attribute instance-attribute

Section titled “callbacks class-attribute instance-attribute ¶”
callbacks = None

pathItems class-attribute instance-attribute

Section titled “pathItems class-attribute instance-attribute ¶”
pathItems = None

model_config class-attribute instance-attribute

Section titled “model_config class-attribute instance-attribute ¶”
model_config = {'extra': 'allow'}

Tag

Section titled “Tag ¶”

Bases: BaseModelWithConfig

name instance-attribute

Section titled “name instance-attribute ¶”
name

description class-attribute instance-attribute

Section titled “description class-attribute instance-attribute ¶”
description = None

externalDocs class-attribute instance-attribute

Section titled “externalDocs class-attribute instance-attribute ¶”
externalDocs = None

model_config class-attribute instance-attribute

Section titled “model_config class-attribute instance-attribute ¶”
model_config = {'extra': 'allow'}

OpenAPI

Section titled “OpenAPI ¶”

Bases: BaseModelWithConfig

openapi instance-attribute

Section titled “openapi instance-attribute ¶”
openapi

info instance-attribute

Section titled “info instance-attribute ¶”
info

jsonSchemaDialect class-attribute instance-attribute

Section titled “jsonSchemaDialect class-attribute instance-attribute ¶”
jsonSchemaDialect = None

servers class-attribute instance-attribute

Section titled “servers class-attribute instance-attribute ¶”
servers = None

paths class-attribute instance-attribute

Section titled “paths class-attribute instance-attribute ¶”
paths = None

webhooks class-attribute instance-attribute

Section titled “webhooks class-attribute instance-attribute ¶”
webhooks = None

components class-attribute instance-attribute

Section titled “components class-attribute instance-attribute ¶”
components = None

security class-attribute instance-attribute

Section titled “security class-attribute instance-attribute ¶”
security = None

tags class-attribute instance-attribute

Section titled “tags class-attribute instance-attribute ¶”
tags = None

externalDocs class-attribute instance-attribute

Section titled “externalDocs class-attribute instance-attribute ¶”
externalDocs = None

model_config class-attribute instance-attribute

Section titled “model_config class-attribute instance-attribute ¶”
model_config = {'extra': 'allow'}
Suggest an edit

Propose a replacement for this page. The site team reviews it before applying any changes.

Export
Documentation menu