OpenAPI models¶

model_config = {'extra': 'allow'}

name = None

url = None

email = None

model_config = {'extra': 'allow'}

name

identifier = None

url = None

model_config = {'extra': 'allow'}

title

summary = None

description = None

termsOfService = None

contact = None

license = None

version

model_config = {'extra': 'allow'}

enum = None

default

description = None

model_config = {'extra': 'allow'}

url

description = None

variables = None

model_config = {'extra': 'allow'}

ref = Field(alias='$ref')

propertyName

mapping = None

name = None

namespace = None

prefix = None

attribute = None

wrapped = None

model_config = {'extra': 'allow'}

description = None

url

model_config = {'extra': 'allow'}

schema_ = Field(default=None, alias='$schema')

vocabulary = Field(default=None, alias='$vocabulary')

id = Field(default=None, alias='$id')

anchor = Field(default=None, alias='$anchor')

dynamicAnchor = Field(default=None, alias='$dynamicAnchor')

ref = Field(default=None, alias='$ref')

dynamicRef = Field(default=None, alias='$dynamicRef')

defs = Field(default=None, alias='$defs')

comment = Field(default=None, alias='$comment')

allOf = None

anyOf = None

oneOf = None

not_ = Field(default=None, alias='not')

if_ = Field(default=None, alias='if')

then = None

else_ = Field(default=None, alias='else')

dependentSchemas = None

prefixItems = None

items = None

contains = None

properties = None

patternProperties = None

additionalProperties = None

propertyNames = None

unevaluatedItems = None

unevaluatedProperties = None

type = None

enum = None

const = None

multipleOf = Field(default=None, gt=0)

maximum = None

exclusiveMaximum = None

minimum = None

exclusiveMinimum = None

maxLength = Field(default=None, ge=0)

minLength = Field(default=None, ge=0)

pattern = None

maxItems = Field(default=None, ge=0)

minItems = Field(default=None, ge=0)

uniqueItems = None

maxContains = Field(default=None, ge=0)

minContains = Field(default=None, ge=0)

maxProperties = Field(default=None, ge=0)

minProperties = Field(default=None, ge=0)

required = None

dependentRequired = None

format = None

contentEncoding = None

contentMediaType = None

contentSchema = None

title = None

description = None

default = None

deprecated = None

readOnly = None

writeOnly = None

examples = None

discriminator = None

xml = None

externalDocs = None

example = None

model_config = {'extra': 'allow'}

summary

description

value

externalValue

query = 'query'

header = 'header'

path = 'path'

cookie = 'cookie'

contentType = None

headers = None

style = None

explode = None

allowReserved = None

model_config = {'extra': 'allow'}

schema_ = Field(default=None, alias='schema')

example = None

examples = None

encoding = None

model_config = {'extra': 'allow'}

description = None

required = None

deprecated = None

style = None

explode = None

allowReserved = None

schema_ = Field(default=None, alias='schema')

example = None

examples = None

content = None

model_config = {'extra': 'allow'}

name

in_ = Field(alias='in')

model_config = {'extra': 'allow'}

description = None

required = None

deprecated = None

style = None

explode = None

allowReserved = None

schema_ = Field(default=None, alias='schema')

example = None

examples = None

content = None

model_config = {'extra': 'allow'}

description = None

required = None

deprecated = None

style = None

explode = None

allowReserved = None

schema_ = Field(default=None, alias='schema')

example = None

examples = None

content = None

description = None

content

required = None

model_config = {'extra': 'allow'}

operationRef = None

operationId = None

parameters = None

requestBody = None

description = None

server = None

model_config = {'extra': 'allow'}

description

headers = None

content = None

links = None

model_config = {'extra': 'allow'}

tags = None

summary = None

description = None

externalDocs = None

operationId = None

parameters = None

requestBody = None

responses = None

callbacks = None

deprecated = None

security = None

servers = None

model_config = {'extra': 'allow'}

ref = Field(default=None, alias='$ref')

summary = None

description = None

get = None

put = None

post = None

delete = None

options = None

head = None

patch = None

trace = None

servers = None

parameters = None

model_config = {'extra': 'allow'}

apiKey = 'apiKey'

http = 'http'

oauth2 = 'oauth2'

openIdConnect = 'openIdConnect'

type_ = Field(alias='type')

description = None

model_config = {'extra': 'allow'}

query = 'query'

header = 'header'

cookie = 'cookie'

type_ = Field(default=apiKey , alias='type')

in_ = Field(alias='in')

name

model_config = {'extra': 'allow'}

description = None

type_ = Field(default=http , alias='type')

scheme

model_config = {'extra': 'allow'}

description = None

scheme = 'bearer'

bearerFormat = None

model_config = {'extra': 'allow'}

type_ = Field(default=http , alias='type')

description = None

refreshUrl = None

scopes = {}

model_config = {'extra': 'allow'}

authorizationUrl

model_config = {'extra': 'allow'}

refreshUrl = None

scopes = {}

tokenUrl

model_config = {'extra': 'allow'}

refreshUrl = None

scopes = {}

tokenUrl

model_config = {'extra': 'allow'}

refreshUrl = None

scopes = {}

authorizationUrl

tokenUrl

model_config = {'extra': 'allow'}

refreshUrl = None

scopes = {}

implicit = None

password = None

clientCredentials = None

authorizationCode = None

model_config = {'extra': 'allow'}

type_ = Field(default=oauth2 , alias='type')

flows

model_config = {'extra': 'allow'}

description = None

type_ = Field(default=openIdConnect , alias='type')

openIdConnectUrl

model_config = {'extra': 'allow'}

description = None

schemas = None

responses = None

parameters = None

examples = None

requestBodies = None

headers = None

securitySchemes = None

links = None

callbacks = None

pathItems = None

model_config = {'extra': 'allow'}

name

description = None

externalDocs = None

model_config = {'extra': 'allow'}

openapi

info

jsonSchemaDialect = None

servers = None

paths = None

webhooks = None

components = None

security = None

tags = None

externalDocs = None

model_config = {'extra': 'allow'}