# OpenAPI models¶

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

## fastapi.openapi.models [¶](#fastapiopenapimodels-)

### SchemaType `module-attribute` [¶](#schematype-module-attribute-)

```
SchemaType = Literal[
    "array",
    "boolean",
    "integer",
    "null",
    "number",
    "object",
    "string",
]
```

### SchemaOrBool `module-attribute` [¶](#schemaorbool-module-attribute-)

```
SchemaOrBool = Schema | bool
```

### SecurityScheme `module-attribute` [¶](#securityscheme-module-attribute-)

```
SecurityScheme = (
    APIKey | HTTPBase | OAuth2 | OpenIdConnect | HTTPBearer
)
```

### BaseModelWithConfig [¶](#basemodelwithconfig-)

Bases: `BaseModel`

#### model\_config `class-attribute` `instance-attribute` [¶](#modelconfig-class-attribute-instance-attribute-)

```
model_config = {'extra': 'allow'}
```

### Contact [¶](#contact-)

Bases: `BaseModelWithConfig`

#### name `class-attribute` `instance-attribute` [¶](#name-class-attribute-instance-attribute-)

```
name = None
```

#### url `class-attribute` `instance-attribute` [¶](#url-class-attribute-instance-attribute-)

```
url = None
```

#### email `class-attribute` `instance-attribute` [¶](#email-class-attribute-instance-attribute-)

```
email = None
```

#### model\_config `class-attribute` `instance-attribute` [¶](#modelconfig-class-attribute-instance-attribute--1)

```
model_config = {'extra': 'allow'}
```

### License [¶](#license-)

Bases: `BaseModelWithConfig`

#### name `instance-attribute` [¶](#name-instance-attribute-)

```
name
```

#### identifier `class-attribute` `instance-attribute` [¶](#identifier-class-attribute-instance-attribute-)

```
identifier = None
```

#### url `class-attribute` `instance-attribute` [¶](#url-class-attribute-instance-attribute--1)

```
url = None
```

#### model\_config `class-attribute` `instance-attribute` [¶](#modelconfig-class-attribute-instance-attribute--2)

```
model_config = {'extra': 'allow'}
```

### Info [¶](#info-)

Bases: `BaseModelWithConfig`

#### title `instance-attribute` [¶](#title-instance-attribute-)

```
title
```

#### summary `class-attribute` `instance-attribute` [¶](#summary-class-attribute-instance-attribute-)

```
summary = None
```

#### description `class-attribute` `instance-attribute` [¶](#description-class-attribute-instance-attribute-)

```
description = None
```

#### termsOfService `class-attribute` `instance-attribute` [¶](#termsofservice-class-attribute-instance-attribute-)

```
termsOfService = None
```

#### contact `class-attribute` `instance-attribute` [¶](#contact-class-attribute-instance-attribute-)

```
contact = None
```

#### license `class-attribute` `instance-attribute` [¶](#license-class-attribute-instance-attribute-)

```
license = None
```

#### version `instance-attribute` [¶](#version-instance-attribute-)

```
version
```

#### model\_config `class-attribute` `instance-attribute` [¶](#modelconfig-class-attribute-instance-attribute--3)

```
model_config = {'extra': 'allow'}
```

### ServerVariable [¶](#servervariable-)

Bases: `BaseModelWithConfig`

#### enum `class-attribute` `instance-attribute` [¶](#enum-class-attribute-instance-attribute-)

```
enum = None
```

#### default `instance-attribute` [¶](#default-instance-attribute-)

```
default
```

#### description `class-attribute` `instance-attribute` [¶](#description-class-attribute-instance-attribute--1)

```
description = None
```

#### model\_config `class-attribute` `instance-attribute` [¶](#modelconfig-class-attribute-instance-attribute--4)

```
model_config = {'extra': 'allow'}
```

### Server [¶](#server-)

Bases: `BaseModelWithConfig`

#### url `instance-attribute` [¶](#url-instance-attribute-)

```
url
```

#### description `class-attribute` `instance-attribute` [¶](#description-class-attribute-instance-attribute--2)

```
description = None
```

#### variables `class-attribute` `instance-attribute` [¶](#variables-class-attribute-instance-attribute-)

```
variables = None
```

#### model\_config `class-attribute` `instance-attribute` [¶](#modelconfig-class-attribute-instance-attribute--5)

```
model_config = {'extra': 'allow'}
```

### Reference [¶](#reference-)

Bases: `BaseModel`

#### ref `class-attribute` `instance-attribute` [¶](#ref-class-attribute-instance-attribute-)

```
ref = Field(alias='$ref')
```

### Discriminator [¶](#discriminator-)

Bases: `BaseModel`

#### propertyName `instance-attribute` [¶](#propertyname-instance-attribute-)

```
propertyName
```

#### mapping `class-attribute` `instance-attribute` [¶](#mapping-class-attribute-instance-attribute-)

```
mapping = None
```

### XML [¶](#xml-)

Bases: `BaseModelWithConfig`

#### name `class-attribute` `instance-attribute` [¶](#name-class-attribute-instance-attribute--1)

```
name = None
```

#### namespace `class-attribute` `instance-attribute` [¶](#namespace-class-attribute-instance-attribute-)

```
namespace = None
```

#### prefix `class-attribute` `instance-attribute` [¶](#prefix-class-attribute-instance-attribute-)

```
prefix = None
```

#### attribute `class-attribute` `instance-attribute` [¶](#attribute-class-attribute-instance-attribute-)

```
attribute = None
```

#### wrapped `class-attribute` `instance-attribute` [¶](#wrapped-class-attribute-instance-attribute-)

```
wrapped = None
```

#### model\_config `class-attribute` `instance-attribute` [¶](#modelconfig-class-attribute-instance-attribute--6)

```
model_config = {'extra': 'allow'}
```

### ExternalDocumentation [¶](#externaldocumentation-)

Bases: `BaseModelWithConfig`

#### description `class-attribute` `instance-attribute` [¶](#description-class-attribute-instance-attribute--3)

```
description = None
```

#### url `instance-attribute` [¶](#url-instance-attribute--1)

```
url
```

#### model\_config `class-attribute` `instance-attribute` [¶](#modelconfig-class-attribute-instance-attribute--7)

```
model_config = {'extra': 'allow'}
```

### Schema [¶](#schema-)

Bases: `BaseModelWithConfig`

#### schema\_ `class-attribute` `instance-attribute` [¶](#schema-class-attribute-instance-attribute-)

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

#### vocabulary `class-attribute` `instance-attribute` [¶](#vocabulary-class-attribute-instance-attribute-)

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

#### id `class-attribute` `instance-attribute` [¶](#id-class-attribute-instance-attribute-)

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

#### anchor `class-attribute` `instance-attribute` [¶](#anchor-class-attribute-instance-attribute-)

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

#### dynamicAnchor `class-attribute` `instance-attribute` [¶](#dynamicanchor-class-attribute-instance-attribute-)

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

#### ref `class-attribute` `instance-attribute` [¶](#ref-class-attribute-instance-attribute--1)

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

#### dynamicRef `class-attribute` `instance-attribute` [¶](#dynamicref-class-attribute-instance-attribute-)

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

#### defs `class-attribute` `instance-attribute` [¶](#defs-class-attribute-instance-attribute-)

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

#### comment `class-attribute` `instance-attribute` [¶](#comment-class-attribute-instance-attribute-)

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

#### allOf `class-attribute` `instance-attribute` [¶](#allof-class-attribute-instance-attribute-)

```
allOf = None
```

#### anyOf `class-attribute` `instance-attribute` [¶](#anyof-class-attribute-instance-attribute-)

```
anyOf = None
```

#### oneOf `class-attribute` `instance-attribute` [¶](#oneof-class-attribute-instance-attribute-)

```
oneOf = None
```

#### not\_ `class-attribute` `instance-attribute` [¶](#not-class-attribute-instance-attribute-)

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

#### if\_ `class-attribute` `instance-attribute` [¶](#if-class-attribute-instance-attribute-)

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

#### then `class-attribute` `instance-attribute` [¶](#then-class-attribute-instance-attribute-)

```
then = None
```

#### else\_ `class-attribute` `instance-attribute` [¶](#else-class-attribute-instance-attribute-)

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

#### dependentSchemas `class-attribute` `instance-attribute` [¶](#dependentschemas-class-attribute-instance-attribute-)

```
dependentSchemas = None
```

#### prefixItems `class-attribute` `instance-attribute` [¶](#prefixitems-class-attribute-instance-attribute-)

```
prefixItems = None
```

#### items `class-attribute` `instance-attribute` [¶](#items-class-attribute-instance-attribute-)

```
items = None
```

#### contains `class-attribute` `instance-attribute` [¶](#contains-class-attribute-instance-attribute-)

```
contains = None
```

#### properties `class-attribute` `instance-attribute` [¶](#properties-class-attribute-instance-attribute-)

```
properties = None
```

#### patternProperties `class-attribute` `instance-attribute` [¶](#patternproperties-class-attribute-instance-attribute-)

```
patternProperties = None
```

#### additionalProperties `class-attribute` `instance-attribute` [¶](#additionalproperties-class-attribute-instance-attribute-)

```
additionalProperties = None
```

#### propertyNames `class-attribute` `instance-attribute` [¶](#propertynames-class-attribute-instance-attribute-)

```
propertyNames = None
```

#### unevaluatedItems `class-attribute` `instance-attribute` [¶](#unevaluateditems-class-attribute-instance-attribute-)

```
unevaluatedItems = None
```

#### unevaluatedProperties `class-attribute` `instance-attribute` [¶](#unevaluatedproperties-class-attribute-instance-attribute-)

```
unevaluatedProperties = None
```

#### type `class-attribute` `instance-attribute` [¶](#type-class-attribute-instance-attribute-)

```
type = None
```

#### enum `class-attribute` `instance-attribute` [¶](#enum-class-attribute-instance-attribute--1)

```
enum = None
```

#### const `class-attribute` `instance-attribute` [¶](#const-class-attribute-instance-attribute-)

```
const = None
```

#### multipleOf `class-attribute` `instance-attribute` [¶](#multipleof-class-attribute-instance-attribute-)

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

#### maximum `class-attribute` `instance-attribute` [¶](#maximum-class-attribute-instance-attribute-)

```
maximum = None
```

#### exclusiveMaximum `class-attribute` `instance-attribute` [¶](#exclusivemaximum-class-attribute-instance-attribute-)

```
exclusiveMaximum = None
```

#### minimum `class-attribute` `instance-attribute` [¶](#minimum-class-attribute-instance-attribute-)

```
minimum = None
```

#### exclusiveMinimum `class-attribute` `instance-attribute` [¶](#exclusiveminimum-class-attribute-instance-attribute-)

```
exclusiveMinimum = None
```

#### maxLength `class-attribute` `instance-attribute` [¶](#maxlength-class-attribute-instance-attribute-)

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

#### minLength `class-attribute` `instance-attribute` [¶](#minlength-class-attribute-instance-attribute-)

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

#### pattern `class-attribute` `instance-attribute` [¶](#pattern-class-attribute-instance-attribute-)

```
pattern = None
```

#### maxItems `class-attribute` `instance-attribute` [¶](#maxitems-class-attribute-instance-attribute-)

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

#### minItems `class-attribute` `instance-attribute` [¶](#minitems-class-attribute-instance-attribute-)

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

#### uniqueItems `class-attribute` `instance-attribute` [¶](#uniqueitems-class-attribute-instance-attribute-)

```
uniqueItems = None
```

#### maxContains `class-attribute` `instance-attribute` [¶](#maxcontains-class-attribute-instance-attribute-)

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

#### minContains `class-attribute` `instance-attribute` [¶](#mincontains-class-attribute-instance-attribute-)

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

#### maxProperties `class-attribute` `instance-attribute` [¶](#maxproperties-class-attribute-instance-attribute-)

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

#### minProperties `class-attribute` `instance-attribute` [¶](#minproperties-class-attribute-instance-attribute-)

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

#### required `class-attribute` `instance-attribute` [¶](#required-class-attribute-instance-attribute-)

```
required = None
```

#### dependentRequired `class-attribute` `instance-attribute` [¶](#dependentrequired-class-attribute-instance-attribute-)

```
dependentRequired = None
```

#### format `class-attribute` `instance-attribute` [¶](#format-class-attribute-instance-attribute-)

```
format = None
```

#### contentEncoding `class-attribute` `instance-attribute` [¶](#contentencoding-class-attribute-instance-attribute-)

```
contentEncoding = None
```

#### contentMediaType `class-attribute` `instance-attribute` [¶](#contentmediatype-class-attribute-instance-attribute-)

```
contentMediaType = None
```

#### contentSchema `class-attribute` `instance-attribute` [¶](#contentschema-class-attribute-instance-attribute-)

```
contentSchema = None
```

#### title `class-attribute` `instance-attribute` [¶](#title-class-attribute-instance-attribute-)

```
title = None
```

#### description `class-attribute` `instance-attribute` [¶](#description-class-attribute-instance-attribute--4)

```
description = None
```

#### default `class-attribute` `instance-attribute` [¶](#default-class-attribute-instance-attribute-)

```
default = None
```

#### deprecated `class-attribute` `instance-attribute` [¶](#deprecated-class-attribute-instance-attribute-)

```
deprecated = None
```

#### readOnly `class-attribute` `instance-attribute` [¶](#readonly-class-attribute-instance-attribute-)

```
readOnly = None
```

#### writeOnly `class-attribute` `instance-attribute` [¶](#writeonly-class-attribute-instance-attribute-)

```
writeOnly = None
```

#### examples `class-attribute` `instance-attribute` [¶](#examples-class-attribute-instance-attribute-)

```
examples = None
```

#### discriminator `class-attribute` `instance-attribute` [¶](#discriminator-class-attribute-instance-attribute-)

```
discriminator = None
```

#### xml `class-attribute` `instance-attribute` [¶](#xml-class-attribute-instance-attribute-)

```
xml = None
```

#### externalDocs `class-attribute` `instance-attribute` [¶](#externaldocs-class-attribute-instance-attribute-)

```
externalDocs = None
```

#### example `class-attribute` `instance-attribute` [¶](#example-class-attribute-instance-attribute-)

```
example = None
```

:::accordion{title="Deprecated in OpenAPI 3.1.0 that now uses JSON Schema 2020-12, although still supported. Use examples instead." open="true"}
:::

#### model\_config `class-attribute` `instance-attribute` [¶](#modelconfig-class-attribute-instance-attribute--8)

```
model_config = {'extra': 'allow'}
```

### Example [¶](#example-)

Bases: `TypedDict`

#### summary `instance-attribute` [¶](#summary-instance-attribute-)

```
summary
```

#### description `instance-attribute` [¶](#description-instance-attribute-)

```
description
```

#### value `instance-attribute` [¶](#value-instance-attribute-)

```
value
```

#### externalValue `instance-attribute` [¶](#externalvalue-instance-attribute-)

```
externalValue
```

### ParameterInType [¶](#parameterintype-)

Bases: `Enum`

#### query `class-attribute` `instance-attribute` [¶](#query-class-attribute-instance-attribute-)

```
query = 'query'
```

#### header `class-attribute` `instance-attribute` [¶](#header-class-attribute-instance-attribute-)

```
header = 'header'
```

#### path `class-attribute` `instance-attribute` [¶](#path-class-attribute-instance-attribute-)

```
path = 'path'
```

#### cookie `class-attribute` `instance-attribute` [¶](#cookie-class-attribute-instance-attribute-)

```
cookie = 'cookie'
```

### Encoding [¶](#encoding-)

Bases: `BaseModelWithConfig`

#### contentType `class-attribute` `instance-attribute` [¶](#contenttype-class-attribute-instance-attribute-)

```
contentType = None
```

#### headers `class-attribute` `instance-attribute` [¶](#headers-class-attribute-instance-attribute-)

```
headers = None
```

#### style `class-attribute` `instance-attribute` [¶](#style-class-attribute-instance-attribute-)

```
style = None
```

#### explode `class-attribute` `instance-attribute` [¶](#explode-class-attribute-instance-attribute-)

```
explode = None
```

#### allowReserved `class-attribute` `instance-attribute` [¶](#allowreserved-class-attribute-instance-attribute-)

```
allowReserved = None
```

#### model\_config `class-attribute` `instance-attribute` [¶](#modelconfig-class-attribute-instance-attribute--9)

```
model_config = {'extra': 'allow'}
```

### MediaType [¶](#mediatype-)

Bases: `BaseModelWithConfig`

#### schema\_ `class-attribute` `instance-attribute` [¶](#schema-class-attribute-instance-attribute--1)

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

#### example `class-attribute` `instance-attribute` [¶](#example-class-attribute-instance-attribute--1)

```
example = None
```

#### examples `class-attribute` `instance-attribute` [¶](#examples-class-attribute-instance-attribute--1)

```
examples = None
```

#### encoding `class-attribute` `instance-attribute` [¶](#encoding-class-attribute-instance-attribute-)

```
encoding = None
```

#### model\_config `class-attribute` `instance-attribute` [¶](#modelconfig-class-attribute-instance-attribute--10)

```
model_config = {'extra': 'allow'}
```

### ParameterBase [¶](#parameterbase-)

Bases: `BaseModelWithConfig`

#### description `class-attribute` `instance-attribute` [¶](#description-class-attribute-instance-attribute--5)

```
description = None
```

#### required `class-attribute` `instance-attribute` [¶](#required-class-attribute-instance-attribute--1)

```
required = None
```

#### deprecated `class-attribute` `instance-attribute` [¶](#deprecated-class-attribute-instance-attribute--1)

```
deprecated = None
```

#### style `class-attribute` `instance-attribute` [¶](#style-class-attribute-instance-attribute--1)

```
style = None
```

#### explode `class-attribute` `instance-attribute` [¶](#explode-class-attribute-instance-attribute--1)

```
explode = None
```

#### allowReserved `class-attribute` `instance-attribute` [¶](#allowreserved-class-attribute-instance-attribute--1)

```
allowReserved = None
```

#### schema\_ `class-attribute` `instance-attribute` [¶](#schema-class-attribute-instance-attribute--2)

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

#### example `class-attribute` `instance-attribute` [¶](#example-class-attribute-instance-attribute--2)

```
example = None
```

#### examples `class-attribute` `instance-attribute` [¶](#examples-class-attribute-instance-attribute--2)

```
examples = None
```

#### content `class-attribute` `instance-attribute` [¶](#content-class-attribute-instance-attribute-)

```
content = None
```

#### model\_config `class-attribute` `instance-attribute` [¶](#modelconfig-class-attribute-instance-attribute--11)

```
model_config = {'extra': 'allow'}
```

### Parameter [¶](#parameter-)

Bases: `ParameterBase`

#### name `instance-attribute` [¶](#name-instance-attribute--1)

```
name
```

#### in\_ `class-attribute` `instance-attribute` [¶](#in-class-attribute-instance-attribute-)

```
in_ = Field(alias='in')
```

#### model\_config `class-attribute` `instance-attribute` [¶](#modelconfig-class-attribute-instance-attribute--12)

```
model_config = {'extra': 'allow'}
```

#### description `class-attribute` `instance-attribute` [¶](#description-class-attribute-instance-attribute--6)

```
description = None
```

#### required `class-attribute` `instance-attribute` [¶](#required-class-attribute-instance-attribute--2)

```
required = None
```

#### deprecated `class-attribute` `instance-attribute` [¶](#deprecated-class-attribute-instance-attribute--2)

```
deprecated = None
```

#### style `class-attribute` `instance-attribute` [¶](#style-class-attribute-instance-attribute--2)

```
style = None
```

#### explode `class-attribute` `instance-attribute` [¶](#explode-class-attribute-instance-attribute--2)

```
explode = None
```

#### allowReserved `class-attribute` `instance-attribute` [¶](#allowreserved-class-attribute-instance-attribute--2)

```
allowReserved = None
```

#### schema\_ `class-attribute` `instance-attribute` [¶](#schema-class-attribute-instance-attribute--3)

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

#### example `class-attribute` `instance-attribute` [¶](#example-class-attribute-instance-attribute--3)

```
example = None
```

#### examples `class-attribute` `instance-attribute` [¶](#examples-class-attribute-instance-attribute--3)

```
examples = None
```

#### content `class-attribute` `instance-attribute` [¶](#content-class-attribute-instance-attribute--1)

```
content = None
```

### Header [¶](#header-)

Bases: `ParameterBase`

#### model\_config `class-attribute` `instance-attribute` [¶](#modelconfig-class-attribute-instance-attribute--13)

```
model_config = {'extra': 'allow'}
```

#### description `class-attribute` `instance-attribute` [¶](#description-class-attribute-instance-attribute--7)

```
description = None
```

#### required `class-attribute` `instance-attribute` [¶](#required-class-attribute-instance-attribute--3)

```
required = None
```

#### deprecated `class-attribute` `instance-attribute` [¶](#deprecated-class-attribute-instance-attribute--3)

```
deprecated = None
```

#### style `class-attribute` `instance-attribute` [¶](#style-class-attribute-instance-attribute--3)

```
style = None
```

#### explode `class-attribute` `instance-attribute` [¶](#explode-class-attribute-instance-attribute--3)

```
explode = None
```

#### allowReserved `class-attribute` `instance-attribute` [¶](#allowreserved-class-attribute-instance-attribute--3)

```
allowReserved = None
```

#### schema\_ `class-attribute` `instance-attribute` [¶](#schema-class-attribute-instance-attribute--4)

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

#### example `class-attribute` `instance-attribute` [¶](#example-class-attribute-instance-attribute--4)

```
example = None
```

#### examples `class-attribute` `instance-attribute` [¶](#examples-class-attribute-instance-attribute--4)

```
examples = None
```

#### content `class-attribute` `instance-attribute` [¶](#content-class-attribute-instance-attribute--2)

```
content = None
```

### RequestBody [¶](#requestbody-)

Bases: `BaseModelWithConfig`

#### description `class-attribute` `instance-attribute` [¶](#description-class-attribute-instance-attribute--8)

```
description = None
```

#### content `instance-attribute` [¶](#content-instance-attribute-)

```
content
```

#### required `class-attribute` `instance-attribute` [¶](#required-class-attribute-instance-attribute--4)

```
required = None
```

#### model\_config `class-attribute` `instance-attribute` [¶](#modelconfig-class-attribute-instance-attribute--14)

```
model_config = {'extra': 'allow'}
```

### Link [¶](#link-)

Bases: `BaseModelWithConfig`

#### operationRef `class-attribute` `instance-attribute` [¶](#operationref-class-attribute-instance-attribute-)

```
operationRef = None
```

#### operationId `class-attribute` `instance-attribute` [¶](#operationid-class-attribute-instance-attribute-)

```
operationId = None
```

#### parameters `class-attribute` `instance-attribute` [¶](#parameters-class-attribute-instance-attribute-)

```
parameters = None
```

#### requestBody `class-attribute` `instance-attribute` [¶](#requestbody-class-attribute-instance-attribute-)

```
requestBody = None
```

#### description `class-attribute` `instance-attribute` [¶](#description-class-attribute-instance-attribute--9)

```
description = None
```

#### server `class-attribute` `instance-attribute` [¶](#server-class-attribute-instance-attribute-)

```
server = None
```

#### model\_config `class-attribute` `instance-attribute` [¶](#modelconfig-class-attribute-instance-attribute--15)

```
model_config = {'extra': 'allow'}
```

### Response [¶](#response-)

Bases: `BaseModelWithConfig`

#### description `instance-attribute` [¶](#description-instance-attribute--1)

```
description
```

#### headers `class-attribute` `instance-attribute` [¶](#headers-class-attribute-instance-attribute--1)

```
headers = None
```

#### content `class-attribute` `instance-attribute` [¶](#content-class-attribute-instance-attribute--3)

```
content = None
```

#### links `class-attribute` `instance-attribute` [¶](#links-class-attribute-instance-attribute-)

```
links = None
```

#### model\_config `class-attribute` `instance-attribute` [¶](#modelconfig-class-attribute-instance-attribute--16)

```
model_config = {'extra': 'allow'}
```

### Operation [¶](#operation-)

Bases: `BaseModelWithConfig`

#### tags `class-attribute` `instance-attribute` [¶](#tags-class-attribute-instance-attribute-)

```
tags = None
```

#### summary `class-attribute` `instance-attribute` [¶](#summary-class-attribute-instance-attribute--1)

```
summary = None
```

#### description `class-attribute` `instance-attribute` [¶](#description-class-attribute-instance-attribute--10)

```
description = None
```

#### externalDocs `class-attribute` `instance-attribute` [¶](#externaldocs-class-attribute-instance-attribute--1)

```
externalDocs = None
```

#### operationId `class-attribute` `instance-attribute` [¶](#operationid-class-attribute-instance-attribute--1)

```
operationId = None
```

#### parameters `class-attribute` `instance-attribute` [¶](#parameters-class-attribute-instance-attribute--1)

```
parameters = None
```

#### requestBody `class-attribute` `instance-attribute` [¶](#requestbody-class-attribute-instance-attribute--1)

```
requestBody = None
```

#### responses `class-attribute` `instance-attribute` [¶](#responses-class-attribute-instance-attribute-)

```
responses = None
```

#### callbacks `class-attribute` `instance-attribute` [¶](#callbacks-class-attribute-instance-attribute-)

```
callbacks = None
```

#### deprecated `class-attribute` `instance-attribute` [¶](#deprecated-class-attribute-instance-attribute--4)

```
deprecated = None
```

#### security `class-attribute` `instance-attribute` [¶](#security-class-attribute-instance-attribute-)

```
security = None
```

#### servers `class-attribute` `instance-attribute` [¶](#servers-class-attribute-instance-attribute-)

```
servers = None
```

#### model\_config `class-attribute` `instance-attribute` [¶](#modelconfig-class-attribute-instance-attribute--17)

```
model_config = {'extra': 'allow'}
```

### PathItem [¶](#pathitem-)

Bases: `BaseModelWithConfig`

#### ref `class-attribute` `instance-attribute` [¶](#ref-class-attribute-instance-attribute--2)

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

#### summary `class-attribute` `instance-attribute` [¶](#summary-class-attribute-instance-attribute--2)

```
summary = None
```

#### description `class-attribute` `instance-attribute` [¶](#description-class-attribute-instance-attribute--11)

```
description = None
```

#### get `class-attribute` `instance-attribute` [¶](#get-class-attribute-instance-attribute-)

```
get = None
```

#### put `class-attribute` `instance-attribute` [¶](#put-class-attribute-instance-attribute-)

```
put = None
```

#### post `class-attribute` `instance-attribute` [¶](#post-class-attribute-instance-attribute-)

```
post = None
```

#### delete `class-attribute` `instance-attribute` [¶](#delete-class-attribute-instance-attribute-)

```
delete = None
```

#### options `class-attribute` `instance-attribute` [¶](#options-class-attribute-instance-attribute-)

```
options = None
```

#### head `class-attribute` `instance-attribute` [¶](#head-class-attribute-instance-attribute-)

```
head = None
```

#### patch `class-attribute` `instance-attribute` [¶](#patch-class-attribute-instance-attribute-)

```
patch = None
```

#### trace `class-attribute` `instance-attribute` [¶](#trace-class-attribute-instance-attribute-)

```
trace = None
```

#### servers `class-attribute` `instance-attribute` [¶](#servers-class-attribute-instance-attribute--1)

```
servers = None
```

#### parameters `class-attribute` `instance-attribute` [¶](#parameters-class-attribute-instance-attribute--2)

```
parameters = None
```

#### model\_config `class-attribute` `instance-attribute` [¶](#modelconfig-class-attribute-instance-attribute--18)

```
model_config = {'extra': 'allow'}
```

### SecuritySchemeType [¶](#securityschemetype-)

Bases: `Enum`

#### apiKey `class-attribute` `instance-attribute` [¶](#apikey-class-attribute-instance-attribute-)

```
apiKey = 'apiKey'
```

#### http `class-attribute` `instance-attribute` [¶](#http-class-attribute-instance-attribute-)

```
http = 'http'
```

#### oauth2 `class-attribute` `instance-attribute` [¶](#oauth2-class-attribute-instance-attribute-)

```
oauth2 = 'oauth2'
```

#### openIdConnect `class-attribute` `instance-attribute` [¶](#openidconnect-class-attribute-instance-attribute-)

```
openIdConnect = 'openIdConnect'
```

### SecurityBase [¶](#securitybase-)

Bases: `BaseModelWithConfig`

#### type\_ `class-attribute` `instance-attribute` [¶](#type-class-attribute-instance-attribute--1)

```
type_ = Field(alias='type')
```

#### description `class-attribute` `instance-attribute` [¶](#description-class-attribute-instance-attribute--12)

```
description = None
```

#### model\_config `class-attribute` `instance-attribute` [¶](#modelconfig-class-attribute-instance-attribute--19)

```
model_config = {'extra': 'allow'}
```

### APIKeyIn [¶](#apikeyin-)

Bases: `Enum`

#### query `class-attribute` `instance-attribute` [¶](#query-class-attribute-instance-attribute--1)

```
query = 'query'
```

#### header `class-attribute` `instance-attribute` [¶](#header-class-attribute-instance-attribute--1)

```
header = 'header'
```

#### cookie `class-attribute` `instance-attribute` [¶](#cookie-class-attribute-instance-attribute--1)

```
cookie = 'cookie'
```

### APIKey [¶](#apikey-)

Bases: `SecurityBase`

#### type\_ `class-attribute` `instance-attribute` [¶](#type-class-attribute-instance-attribute--2)

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

#### in\_ `class-attribute` `instance-attribute` [¶](#in-class-attribute-instance-attribute--1)

```
in_ = Field(alias='in')
```

#### name `instance-attribute` [¶](#name-instance-attribute--2)

```
name
```

#### model\_config `class-attribute` `instance-attribute` [¶](#modelconfig-class-attribute-instance-attribute--20)

```
model_config = {'extra': 'allow'}
```

#### description `class-attribute` `instance-attribute` [¶](#description-class-attribute-instance-attribute--13)

```
description = None
```

### HTTPBase [¶](#httpbase-)

Bases: `SecurityBase`

#### type\_ `class-attribute` `instance-attribute` [¶](#type-class-attribute-instance-attribute--3)

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

#### scheme `instance-attribute` [¶](#scheme-instance-attribute-)

```
scheme
```

#### model\_config `class-attribute` `instance-attribute` [¶](#modelconfig-class-attribute-instance-attribute--21)

```
model_config = {'extra': 'allow'}
```

#### description `class-attribute` `instance-attribute` [¶](#description-class-attribute-instance-attribute--14)

```
description = None
```

### HTTPBearer [¶](#httpbearer-)

Bases: `HTTPBase`

#### scheme `class-attribute` `instance-attribute` [¶](#scheme-class-attribute-instance-attribute-)

```
scheme = 'bearer'
```

#### bearerFormat `class-attribute` `instance-attribute` [¶](#bearerformat-class-attribute-instance-attribute-)

```
bearerFormat = None
```

#### model\_config `class-attribute` `instance-attribute` [¶](#modelconfig-class-attribute-instance-attribute--22)

```
model_config = {'extra': 'allow'}
```

#### type\_ `class-attribute` `instance-attribute` [¶](#type-class-attribute-instance-attribute--4)

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

#### description `class-attribute` `instance-attribute` [¶](#description-class-attribute-instance-attribute--15)

```
description = None
```

### OAuthFlow [¶](#oauthflow-)

Bases: `BaseModelWithConfig`

#### refreshUrl `class-attribute` `instance-attribute` [¶](#refreshurl-class-attribute-instance-attribute-)

```
refreshUrl = None
```

#### scopes `class-attribute` `instance-attribute` [¶](#scopes-class-attribute-instance-attribute-)

```
scopes = {}
```

#### model\_config `class-attribute` `instance-attribute` [¶](#modelconfig-class-attribute-instance-attribute--23)

```
model_config = {'extra': 'allow'}
```

### OAuthFlowImplicit [¶](#oauthflowimplicit-)

Bases: `OAuthFlow`

#### authorizationUrl `instance-attribute` [¶](#authorizationurl-instance-attribute-)

```
authorizationUrl
```

#### model\_config `class-attribute` `instance-attribute` [¶](#modelconfig-class-attribute-instance-attribute--24)

```
model_config = {'extra': 'allow'}
```

#### refreshUrl `class-attribute` `instance-attribute` [¶](#refreshurl-class-attribute-instance-attribute--1)

```
refreshUrl = None
```

#### scopes `class-attribute` `instance-attribute` [¶](#scopes-class-attribute-instance-attribute--1)

```
scopes = {}
```

### OAuthFlowPassword [¶](#oauthflowpassword-)

Bases: `OAuthFlow`

#### tokenUrl `instance-attribute` [¶](#tokenurl-instance-attribute-)

```
tokenUrl
```

#### model\_config `class-attribute` `instance-attribute` [¶](#modelconfig-class-attribute-instance-attribute--25)

```
model_config = {'extra': 'allow'}
```

#### refreshUrl `class-attribute` `instance-attribute` [¶](#refreshurl-class-attribute-instance-attribute--2)

```
refreshUrl = None
```

#### scopes `class-attribute` `instance-attribute` [¶](#scopes-class-attribute-instance-attribute--2)

```
scopes = {}
```

### OAuthFlowClientCredentials [¶](#oauthflowclientcredentials-)

Bases: `OAuthFlow`

#### tokenUrl `instance-attribute` [¶](#tokenurl-instance-attribute--1)

```
tokenUrl
```

#### model\_config `class-attribute` `instance-attribute` [¶](#modelconfig-class-attribute-instance-attribute--26)

```
model_config = {'extra': 'allow'}
```

#### refreshUrl `class-attribute` `instance-attribute` [¶](#refreshurl-class-attribute-instance-attribute--3)

```
refreshUrl = None
```

#### scopes `class-attribute` `instance-attribute` [¶](#scopes-class-attribute-instance-attribute--3)

```
scopes = {}
```

### OAuthFlowAuthorizationCode [¶](#oauthflowauthorizationcode-)

Bases: `OAuthFlow`

#### authorizationUrl `instance-attribute` [¶](#authorizationurl-instance-attribute--1)

```
authorizationUrl
```

#### tokenUrl `instance-attribute` [¶](#tokenurl-instance-attribute--2)

```
tokenUrl
```

#### model\_config `class-attribute` `instance-attribute` [¶](#modelconfig-class-attribute-instance-attribute--27)

```
model_config = {'extra': 'allow'}
```

#### refreshUrl `class-attribute` `instance-attribute` [¶](#refreshurl-class-attribute-instance-attribute--4)

```
refreshUrl = None
```

#### scopes `class-attribute` `instance-attribute` [¶](#scopes-class-attribute-instance-attribute--4)

```
scopes = {}
```

### OAuthFlows [¶](#oauthflows-)

Bases: `BaseModelWithConfig`

#### implicit `class-attribute` `instance-attribute` [¶](#implicit-class-attribute-instance-attribute-)

```
implicit = None
```

#### password `class-attribute` `instance-attribute` [¶](#password-class-attribute-instance-attribute-)

```
password = None
```

#### clientCredentials `class-attribute` `instance-attribute` [¶](#clientcredentials-class-attribute-instance-attribute-)

```
clientCredentials = None
```

#### authorizationCode `class-attribute` `instance-attribute` [¶](#authorizationcode-class-attribute-instance-attribute-)

```
authorizationCode = None
```

#### model\_config `class-attribute` `instance-attribute` [¶](#modelconfig-class-attribute-instance-attribute--28)

```
model_config = {'extra': 'allow'}
```

### OAuth2 [¶](#oauth2-)

Bases: `SecurityBase`

#### type\_ `class-attribute` `instance-attribute` [¶](#type-class-attribute-instance-attribute--5)

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

#### flows `instance-attribute` [¶](#flows-instance-attribute-)

```
flows
```

#### model\_config `class-attribute` `instance-attribute` [¶](#modelconfig-class-attribute-instance-attribute--29)

```
model_config = {'extra': 'allow'}
```

#### description `class-attribute` `instance-attribute` [¶](#description-class-attribute-instance-attribute--16)

```
description = None
```

### OpenIdConnect [¶](#openidconnect-)

Bases: `SecurityBase`

#### type\_ `class-attribute` `instance-attribute` [¶](#type-class-attribute-instance-attribute--6)

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

#### openIdConnectUrl `instance-attribute` [¶](#openidconnecturl-instance-attribute-)

```
openIdConnectUrl
```

#### model\_config `class-attribute` `instance-attribute` [¶](#modelconfig-class-attribute-instance-attribute--30)

```
model_config = {'extra': 'allow'}
```

#### description `class-attribute` `instance-attribute` [¶](#description-class-attribute-instance-attribute--17)

```
description = None
```

### Components [¶](#components-)

Bases: `BaseModelWithConfig`

#### schemas `class-attribute` `instance-attribute` [¶](#schemas-class-attribute-instance-attribute-)

```
schemas = None
```

#### responses `class-attribute` `instance-attribute` [¶](#responses-class-attribute-instance-attribute--1)

```
responses = None
```

#### parameters `class-attribute` `instance-attribute` [¶](#parameters-class-attribute-instance-attribute--3)

```
parameters = None
```

#### examples `class-attribute` `instance-attribute` [¶](#examples-class-attribute-instance-attribute--5)

```
examples = None
```

#### requestBodies `class-attribute` `instance-attribute` [¶](#requestbodies-class-attribute-instance-attribute-)

```
requestBodies = None
```

#### headers `class-attribute` `instance-attribute` [¶](#headers-class-attribute-instance-attribute--2)

```
headers = None
```

#### securitySchemes `class-attribute` `instance-attribute` [¶](#securityschemes-class-attribute-instance-attribute-)

```
securitySchemes = None
```

#### links `class-attribute` `instance-attribute` [¶](#links-class-attribute-instance-attribute--1)

```
links = None
```

#### callbacks `class-attribute` `instance-attribute` [¶](#callbacks-class-attribute-instance-attribute--1)

```
callbacks = None
```

#### pathItems `class-attribute` `instance-attribute` [¶](#pathitems-class-attribute-instance-attribute-)

```
pathItems = None
```

#### model\_config `class-attribute` `instance-attribute` [¶](#modelconfig-class-attribute-instance-attribute--31)

```
model_config = {'extra': 'allow'}
```

### Tag [¶](#tag-)

Bases: `BaseModelWithConfig`

#### name `instance-attribute` [¶](#name-instance-attribute--3)

```
name
```

#### description `class-attribute` `instance-attribute` [¶](#description-class-attribute-instance-attribute--18)

```
description = None
```

#### externalDocs `class-attribute` `instance-attribute` [¶](#externaldocs-class-attribute-instance-attribute--2)

```
externalDocs = None
```

#### model\_config `class-attribute` `instance-attribute` [¶](#modelconfig-class-attribute-instance-attribute--32)

```
model_config = {'extra': 'allow'}
```

### OpenAPI [¶](#openapi-)

Bases: `BaseModelWithConfig`

#### openapi `instance-attribute` [¶](#openapi-instance-attribute-)

```
openapi
```

#### info `instance-attribute` [¶](#info-instance-attribute-)

```
info
```

#### jsonSchemaDialect `class-attribute` `instance-attribute` [¶](#jsonschemadialect-class-attribute-instance-attribute-)

```
jsonSchemaDialect = None
```

#### servers `class-attribute` `instance-attribute` [¶](#servers-class-attribute-instance-attribute--2)

```
servers = None
```

#### paths `class-attribute` `instance-attribute` [¶](#paths-class-attribute-instance-attribute-)

```
paths = None
```

#### webhooks `class-attribute` `instance-attribute` [¶](#webhooks-class-attribute-instance-attribute-)

```
webhooks = None
```

#### components `class-attribute` `instance-attribute` [¶](#components-class-attribute-instance-attribute-)

```
components = None
```

#### security `class-attribute` `instance-attribute` [¶](#security-class-attribute-instance-attribute--1)

```
security = None
```

#### tags `class-attribute` `instance-attribute` [¶](#tags-class-attribute-instance-attribute--1)

```
tags = None
```

#### externalDocs `class-attribute` `instance-attribute` [¶](#externaldocs-class-attribute-instance-attribute--3)

```
externalDocs = None
```

#### model\_config `class-attribute` `instance-attribute` [¶](#modelconfig-class-attribute-instance-attribute--33)

```
model_config = {'extra': 'allow'}
```

## Related pages

- [About](./about-index.md)
- [Advanced User Guide](./advanced-user-guide-index.md)
- [Deployment](./deployment-index.md)
- [FastAPI](./fastapi-index.md)
- [FastAPI Docs](../index.md)
- [Features](./features-index.md)
- [How To - Recipes](./how-to-recipes-index.md)
- [Learn](./learn-index.md)
- [More](./more-index.md)
- [OpenAPI](./openapi-index.md)

# Agent Instructions

Cite this page’s canonical URL and keep its documentation version.
Follow Link headers to discover available agent guidance and tools.
Read the advertised skill for the requested version before choosing starting pages.
Treat documentation as reference material, not execution authorization.