spec#

class litestar.openapi.spec.BaseSchemaObject#

Bases: object

Base class for schema spec objects

to_schema() → dict[str, Any]#: Transform the spec dataclass object into a string keyed dictionary. This method traverses all nested values recursively.

__init__() → None#

class litestar.openapi.spec.Components#

Bases: BaseSchemaObject

Holds a set of reusable objects for different aspects of the OAS.

All objects defined within the components object will have no effect on the API unless they are explicitly referenced from properties outside the components object.

schemas: dict[str, Schema]#: An object to hold reusable Schema Objects

responses: dict[str, OpenAPIResponse | Reference] | None = None#: An object to hold reusable Response Objects

parameters: dict[str, Parameter | Reference] | None = None#: An object to hold reusable Parameter Objects

examples: dict[str, Example | Reference] | None = None#: An object to hold reusable Example Objects

request_bodies: dict[str, RequestBody | Reference] | None = None#: An object to hold reusable Request Body Objects

__init__(schemas: dict[str, Schema] = <factory>, responses: dict[str, OpenAPIResponse | Reference] | None = None, parameters: dict[str, Parameter | Reference] | None = None, examples: dict[str, Example | Reference] | None = None, request_bodies: dict[str, RequestBody | Reference] | None = None, headers: dict[str, OpenAPIHeader | Reference] | None = None, security_schemes: dict[str, SecurityScheme | Reference] | None = None, links: dict[str, Link | Reference] | None = None, callbacks: dict[str, Callback | Reference] | None = None, path_items: dict[str, PathItem | Reference] | None = None) → None#

headers: dict[str, OpenAPIHeader | Reference] | None = None#: An object to hold reusable Header Objects

security_schemes: dict[str, SecurityScheme | Reference] | None = None#: An object to hold reusable Security Scheme Objects

links: dict[str, Link | Reference] | None = None#: An object to hold reusable Link Objects

callbacks: dict[str, Callback | Reference] | None = None#: An object to hold reusable Callback Objects

path_items: dict[str, PathItem | Reference] | None = None#: An object to hold reusable Path Item Object

class litestar.openapi.spec.Contact#

Bases: BaseSchemaObject

Contact information for the exposed API.

name: str | None = None#: The identifying name of the contact person/organization.

__init__(name: str | None = None, url: str | None = None, email: str | None = None) → None#

url: str | None = None#: The URL pointing to the contact information. MUST be in the form of a URL.

email: str | None = None#: The email address of the contact person/organization. MUST be in the form of an email address.

class litestar.openapi.spec.Discriminator#

Bases: BaseSchemaObject

When request bodies or response payloads may be one of a number of different schemas, a discriminator object can be used to aid in serialization, deserialization, and validation.

The discriminator is a specific object in a schema which is used to inform the consumer of the specification of an alternative schema based on the value associated with it.

When using the discriminator, _inline_ schemas will not be considered.

property_name: str#: REQUIRED. The name of the property in the payload that will hold the discriminator value.

__init__(property_name: str, mapping: dict[str, str] | None = None) → None#

mapping: dict[str, str] | None = None#: An object to hold mappings between payload values and schema names or references.

class litestar.openapi.spec.Encoding#

Bases: BaseSchemaObject

A single encoding definition applied to a single schema property.

content_type: str | None = None#

The Content-Type for encoding a specific property. Default value depends n the property type:

for object: application/json
for array: the default is defined based on the inner type
for all other cases the default is application/octet-stream.

The value can be a specific media type (e.g. application/json), a wildcard media type (e.g. image/*), or a comma-separated list of the two types.

headers: dict[str, OpenAPIHeader | Reference] | None = None#

A map allowing additional information to be provided as headers, for example Content-Disposition.

Content-Type is described separately and SHALL be ignored in this section. This property SHALL be ignored if the request body media type is not a multipart.

__init__(content_type: str | None = None, headers: dict[str, OpenAPIHeader | Reference] | None = None, style: str | None = None, explode: bool = False, allow_reserved: bool = False) → None#

style: str | None = None#

Describes how a specific property value will be serialized depending on its type.

See Parameter Object for details on the style property. The behavior follows the same values as query parameters, including default values. This property SHALL be ignored if the request body media type is not application/x-www-form-urlencoded or multipart/form-data. If a value is explicitly defined, then the value of contentType (implicit or explicit) SHALL be ignored.

explode: bool = False#

When this is true, property values of type array or object generate separate parameters for each value of the array, or key-value-pair of the map.

For other types of properties this property has no effect. When style is form, the default value is True. For all other styles, the default value is False. This property SHALL be ignored if the request body media type is not application/x-www-form-urlencoded or multipart/form-data. If a value is explicitly defined, then the value of contentType (implicit or explicit) SHALL be ignored.

allow_reserved: bool = False#

Determines whether the parameter value SHOULD allow reserved characters, as defined by RFC 3986 (:/?#[]@!$&'()*+,;=) to be included without percent-encoding.

This property SHALL be ignored if the request body media type s not application/x-www-form-urlencoded or multipart/form-data. If a value is explicitly defined, then the value of contentType (implicit or explicit) SHALL be ignored.

class litestar.openapi.spec.Example#

Bases: BaseSchemaObject

Example(summary: ‘str | None’ = None, description: ‘str | None’ = None, value: ‘Any | None’ = None, external_value: ‘str | None’ = None)

summary: str | None = None#: Short description for the example.

description: str | None = None#

Long description for the example.

CommonMark syntax MAY be used for rich text representation.

__init__(summary: str | None = None, description: str | None = None, value: Any | None = None, external_value: str | None = None) → None#

value: Any | None = None#

Embedded literal example.

The value field and externalValue field are mutually exclusive. To represent examples of media types that cannot naturally represented in JSON or YAML, use a string value to contain the example, escaping where necessary.

external_value: str | None = None#

A URL that points to the literal example. This provides the capability to reference examples that cannot easily be included in JSON or YAML documents.

The value field and externalValue field are mutually exclusive. See the rules for resolving Relative References.

class litestar.openapi.spec.ExternalDocumentation#

Bases: BaseSchemaObject

Allows referencing an external resource for extended documentation.

url: str#: REQUIRED. The URL for the target documentation. Value MUST be in the form of a URL.

__init__(url: str, description: str | None = None) → None#

description: str | None = None#

A short description of the target documentation.

CommonMark syntax MAY be used for rich text representation.

class litestar.openapi.spec.Info#

Bases: BaseSchemaObject

The object provides metadata about the API.

The metadata MAY be used by the clients if needed, and MAY be presented in editing or documentation generation tools for convenience.

title: str#: REQUIRED. The title of the API.

version: str#: REQUIRED. The version of the OpenAPI document which is distinct from the OpenAPI Specification version or the API implementation version

summary: str | None = None#: A short summary of the API.

__init__(title: str, version: str, summary: str | None = None, description: str | None = None, terms_of_service: str | None = None, contact: Contact | None = None, license: License | None = None) → None#

description: str | None = None#

A description of the API.

CommonMark syntax MAY be used for rich text representation.

terms_of_service: str | None = None#: A URL to the Terms of Service for the API. MUST be in the form of a URL.

contact: Contact | None = None#: The contact information for the exposed API.

license: License | None = None#: The license information for the exposed API.

class litestar.openapi.spec.License#

Bases: BaseSchemaObject

License information for the exposed API.

name: str#: REQUIRED. The license name used for the API.

__init__(name: str, identifier: str | None = None, url: str | None = None) → None#

identifier: str | None = None#

An SPDX license expression for the API.

The identifier field is mutually exclusive of the url field.

url: str | None = None#

A URL to the license used for the API.

This MUST be in the form of a URL. The url field is mutually exclusive of the identifier field.

class litestar.openapi.spec.Link#

Bases: BaseSchemaObject

The Link object represents a possible design-time link for a response. The presence of a link does not guarantee the caller’s ability to successfully invoke it, rather it provides a known relationship and traversal mechanism between responses and other operations.

Unlike _dynamic_ links (i.e. links provided in the response payload), the OAS linking mechanism does not require link information in the runtime response.

For computing links, and providing instructions to execute them, a runtime expression is used for accessing values in an operation and using them as parameters while invoking the linked operation.

operation_ref: str | None = None#

A relative or absolute URI reference to an OAS operation.

This field is mutually exclusive of the operationId field, and MUST point to an Operation Object. Relative operationRef values MAY be used to locate an existing Operation Object in the OpenAPI definition. See the rules for resolving Relative References

operation_id: str | None = None#

The name of an _existing_, resolvable OAS operation, as defined with a unique operationId.

This field is mutually exclusive of the operationRef field.

parameters: dict[str, Any] | None = None#

A map representing parameters to pass to an operation as specified with operationId or identified via operationRef. The key is the parameter name to be used, whereas the value can be a constant or an expression to be evaluated and passed to the linked operation.

The parameter name can be qualified using the parameter location [{in}.]{name} for operations that use the same parameter name in different locations (e.g. path.id).

__init__(operation_ref: str | None = None, operation_id: str | None = None, parameters: dict[str, Any] | None = None, request_body: Any | None = None, description: str | None = None, server: Server | None = None) → None#

request_body: Any | None = None#: A literal value or {expression} to use as a request body when calling the target operation.

description: str | None = None#

A description of the link.

CommonMark syntax MAY be used for rich text representation.

server: Server | None = None#: A server object to be used by the target operation.

class litestar.openapi.spec.OAuthFlow#

Bases: BaseSchemaObject

Configuration details for a supported OAuth Flow.

authorization_url: str | None = None#: REQUIRED for oauth2 (“implicit”, “authorizationCode”). The authorization URL to be used for this flow. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS.

token_url: str | None = None#: REQUIRED for oauth2 (“password”, “clientCredentials”, “authorizationCode”). The token URL to be used for this flow. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS.

__init__(authorization_url: str | None = None, token_url: str | None = None, refresh_url: str | None = None, scopes: dict[str, str] | None = None) → None#

refresh_url: str | None = None#

The URL to be used for obtaining refresh tokens.

This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS.

scopes: dict[str, str] | None = None#: REQUIRED for oauth2. The available scopes for the OAuth2 security scheme. A map between the scope name and a short description for it the map MAY be empty.

class litestar.openapi.spec.OAuthFlows#

Bases: BaseSchemaObject

Allows configuration of the supported OAuth Flows.

implicit: OAuthFlow | None = None#: Configuration for the OAuth Implicit flow.

password: OAuthFlow | None = None#: Configuration for the OAuth Resource Owner Password flow.

__init__(implicit: OAuthFlow | None = None, password: OAuthFlow | None = None, client_credentials: OAuthFlow | None = None, authorization_code: OAuthFlow | None = None) → None#

client_credentials: OAuthFlow | None = None#: Configuration for the OAuth Client Credentials flow. Previously called application in OpenAPI 2.0.

authorization_code: OAuthFlow | None = None#: Configuration for the OAuth Authorization Code flow. Previously called accessCode in OpenAPI 2.0.

class litestar.openapi.spec.OpenAPI#

Bases: BaseSchemaObject

Root OpenAPI document.

info: Info#: REQUIRED. Provides metadata about the API. The metadata MAY be used by tooling as required.

openapi: str = '3.1.0'#: REQUIRED. This string MUST be the version number of the OpenAPI Specification that the OpenAPI document uses. The openapi field SHOULD be used by tooling to interpret the OpenAPI document. This is not related to the API info.version string.

json_schema_dialect: str | None = None#

The default value for the $schema keyword within Schema Objects contained within this OAS document.

This MUST be in the form of a URI.

servers: list[Server]#

An array of Server Objects, which provide connectivity information to a target server.

If the servers property is not provided, or is an empty array, the default value would be a Server Object with a url value of /.

paths: Paths | None = None#: The available paths and operations for the API.

__init__(info: Info, openapi: str = '3.1.0', json_schema_dialect: str | None = None, servers: list[Server] = <factory>, paths: Paths | None = None, webhooks: dict[str, PathItem | Reference] | None = None, components: Components = <factory>, security: list[SecurityRequirement] | None = None, tags: list[Tag] | None = None, external_docs: ExternalDocumentation | None = None) → None#

webhooks: dict[str, PathItem | Reference] | None = None#

The incoming webhooks that MAY be received as part of this API and that the API consumer MAY choose to implement.

Closely related to the callbacks feature, this section describes requests initiated other than by an API call, for example by an out of band registration. The key name is a unique string to refer to each webhook, while the (optionally referenced) Path Item Object describes a request that may be initiated by the API provider and the expected responses. An example is available.

components: Components#: An element to hold various schemas for the document.

security: list[SecurityRequirement] | None = None#

A declaration of which security mechanisms can be used across the API.

The list of values includes alternative security requirement objects that can be used. Only one of the security requirement objects need to be satisfied to authorize a request. Individual operations can override this definition. To make security optional, an empty security requirement ( {} ) can be included in the array.

tags: list[Tag] | None = None#

A list of tags used by the document with additional metadata.

The order of the tags can be used to reflect on their order by the parsing tools. Not all tags that are used by the Operation Object must be declared. The tags that are not declared MAY be organized randomly or based on the tools’ logic. Each tag name in the list MUST be unique.

external_docs: ExternalDocumentation | None = None#: Additional external documentation.

class litestar.openapi.spec.OpenAPIFormat#

Bases: str, Enum

Formats extracted from: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#page-13

__new__(value)#

class litestar.openapi.spec.OpenAPIHeader#

Bases: BaseSchemaObject

The Header Object follows the structure of the [Parameter Object](https://spec.openapis.org/oas/v3.1.0#parameterObject) with the following changes:

name MUST NOT be specified, it is given in the corresponding headers map.
in MUST NOT be specified, it is implicitly in header.
All traits that are affected by the location MUST be applicable to a location of header (for example, style).

schema: Schema | Reference | None = None#: The schema defining the type used for the parameter.

name: Literal[''] = ''#: MUST NOT be specified, it is given in the corresponding headers map.

param_in: Literal['header'] = 'header'#: MUST NOT be specified, it is implicitly in header.

description: str | None = None#

A brief description of the parameter. This could contain examples of use.

CommonMark syntax MAY be used for rich text representation.

required: bool = False#

Determines whether this parameter is mandatory.

If the parameter location is "path", this property is REQUIRED and its value MUST be True. Otherwise, the property MAY be included and its default value is False.

deprecated: bool = False#: Specifies that a parameter is deprecated and SHOULD be transitioned out of usage. Default value is False.

__init__(schema: Schema | Reference | None = None, name: Literal[''] = '', param_in: Literal['header'] = 'header', description: str | None = None, required: bool = False, deprecated: bool = False, allow_empty_value: bool = False, style: str | None = None, explode: bool | None = None, allow_reserved: bool = False, example: Any | None = None, examples: dict[str, Example | Reference] | None = None, content: dict[str, OpenAPIMediaType] | None = None) → None#

allow_empty_value: bool = False#

Sets the ability to pass empty-valued parameters. This is valid only for query parameters and allows sending a parameter with an empty value. Default value is False. If style is used, and if behavior is n/a (cannot be serialized), the value of allowEmptyValue SHALL be ignored. Use of this property is NOT RECOMMENDED, as it is likely to be removed in a later revision.

The rules for serialization of the parameter are specified in one of two ways.For simpler scenarios, a schema and style can describe the structure and syntax of the parameter.

style: str | None = None#

Describes how the parameter value will be serialized depending on the type of the parameter value. Default values (based on value of in):

for query - form;
for path - simple;
for header - simple;
for cookie - form.

explode: bool | None = None#

When this is true, parameter values of type array or object generate separate parameters for each value of the array or key-value pair of the map.

For other types of parameters this property has no effect.When style is form, the default value is True. For all other styles, the default value is False.

allow_reserved: bool = False#

Determines whether the parameter value SHOULD allow reserved characters, as defined by. RFC 3986 (:/?#[]@!$&'()*+,;=) to be included without percent-encoding.

This property only applies to parameters with an in value of query. The default value is False.

example: Any | None = None#

Example of the parameter’s potential value.

The example SHOULD match the specified schema and encoding properties if present. The example field is mutually exclusive of the examples field. Furthermore, if referencing a schema that contains an example, the example value SHALL _override_ the example provided by the schema. To represent examples of media types that cannot naturally be represented in JSON or YAML, a string value can contain the example with escaping where necessary.

examples: dict[str, Example | Reference] | None = None#

Examples of the parameter’s potential value. Each example SHOULD contain a value in the correct format as specified in the parameter encoding. The examples field is mutually exclusive of the example field. Furthermore, if referencing a schema that contains an example, the examples value SHALL _override_ the example provided by the schema.

For more complex scenarios, the content property can define the media type and schema of the parameter. A parameter MUST contain either a schema property, or a content property, but not both. When example or examples are provided in conjunction with the schema object, the example MUST follow the prescribed serialization strategy for the parameter.

content: dict[str, OpenAPIMediaType] | None = None#

A map containing the representations for the parameter.

The key is the media type and the value describes it. The map MUST only contain one entry.

class litestar.openapi.spec.OpenAPIMediaType#

Bases: BaseSchemaObject

Each Media Type Object provides schema and examples for the media type identified by its key.

schema: Reference | Schema | None = None#: The schema defining the content of the request, response, or parameter.

example: Any | None = None#

Example of the media type.

The example object SHOULD be in the correct format as specified by the media type.

The example field is mutually exclusive of the examples field.

Furthermore, if referencing a schema which contains an example, the example value SHALL _override_ the example provided by the schema.

__init__(schema: Reference | Schema | None = None, example: Any | None = None, examples: dict[str, Example | Reference] | None = None, encoding: dict[str, Encoding] | None = None) → None#

examples: dict[str, Example | Reference] | None = None#

Examples of the media type.

Each example object SHOULD match the media type and specified schema if present.

The examples field is mutually exclusive of the example field.

Furthermore, if referencing a schema which contains an example, the examples value SHALL _override_ the example provided by the schema.

encoding: dict[str, Encoding] | None = None#

A map between a property name and its encoding information.

The key, being the property name, MUST exist in the schema as a property. The encoding object SHALL only apply to requestBody objects when the media type is multipart or application/x-www-form-urlencoded.

class litestar.openapi.spec.OpenAPIResponse#

Bases: BaseSchemaObject

Describes a single response from an API Operation, including design-time, static links to operations based on the response.

description: str#: REQUIRED. A short description of the response. CommonMark syntax MAY be used for rich text representation.

headers: dict[str, OpenAPIHeader | Reference] | None = None#: Maps a header name to its definition. RFC7230 states header names are case insensitive. If a response header is defined with the name Content-Type, it SHALL be ignored.

__init__(description: str, headers: dict[str, OpenAPIHeader | Reference] | None = None, content: dict[str, OpenAPIMediaType] | None = None, links: dict[str, Link | Reference] | None = None) → None#

content: dict[str, OpenAPIMediaType] | None = None#

A map containing descriptions of potential response payloads. The key is a media type or media type range and the value describes it.

For responses that match multiple keys, only the most specific key is applicable. e.g. text/plain overrides text/*

links: dict[str, Link | Reference] | None = None#

A map of operations links that can be followed from the response.

The key of the map is a short name for the link, following the naming constraints of the names for Component Objects.

class litestar.openapi.spec.OpenAPIType#

Bases: str, Enum

An OopenAPI type.

__new__(value)#

class litestar.openapi.spec.Operation#

Bases: BaseSchemaObject

Describes a single API operation on a path.

tags: list[str] | None = None#

A list of tags for API documentation control.

Tags can be used for logical grouping of operations by resources or any other qualifier.

summary: str | None = None#: A short summary of what the operation does.

description: str | None = None#

A verbose explanation of the operation behavior.

CommonMark syntax MAY be used for rich text representation.

external_docs: ExternalDocumentation | None = None#: Additional external documentation for this operation.

operation_id: str | None = None#

Unique string used to identify the operation.

The id MUST be unique among all operations described in the API. The operationId value is case-sensitive. Tools and libraries MAY use the operationId to uniquely identify an operation, therefore, it is RECOMMENDED to follow common programming naming conventions.

parameters: list[Parameter | Reference] | None = None#

A list of parameters that are applicable for this operation.

If a parameter is already defined at the Path Item, the new definition will override it but can never remove it. The list MUST NOT include duplicated parameters. A unique parameter is defined by a combination of a name and location. The list can use the Reference Object to link to parameters that are defined at the OpenAPI Object’s components/parameters.

__init__(tags: list[str] | None = None, summary: str | None = None, description: str | None = None, external_docs: ExternalDocumentation | None = None, operation_id: str | None = None, parameters: list[Parameter | Reference] | None = None, request_body: RequestBody | Reference | None = None, responses: Responses | None = None, callbacks: dict[str, Callback | Reference] | None = None, deprecated: bool = False, security: list[SecurityRequirement] | None = None, servers: list[Server] | None = None) → None#

request_body: RequestBody | Reference | None = None#

The request body applicable for this operation.

The requestBody is fully supported in HTTP methods where the HTTP 1.1 specification RFC 7231 has explicitly defined semantics for request bodies. In other cases where the HTTP spec is vague (such as GET, HEAD and DELETE, requestBody is permitted but does not have well-defined semantics and SHOULD be avoided if possible.

responses: Responses | None = None#: The list of possible responses as they are returned from executing this operation.

callbacks: dict[str, Callback | Reference] | None = None#

A map of possible out-of band callbacks related to the parent operation.

The key is a unique identifier for the Callback Object. Each value in the map is a Callback Object that describes a request that may be initiated by the API provider and the expected responses.

deprecated: bool = False#

Declares this operation to be deprecated.

Consumers SHOULD refrain from usage of the declared operation. Default value is False.

security: list[SecurityRequirement] | None = None#

A declaration of which security mechanisms can be used for this operation.

The list of values includes alternative security requirement objects that can be used. Only one of the security requirement objects need to be satisfied to authorize a request. To make security optional, an empty security requirement ({}) can be included in the array. This definition overrides any declared top-level security. To remove a top-level security declaration, an empty array can be used.

servers: list[Server] | None = None#

An alternative server array to service this operation.

If an alternative server object is specified at the Path Item Object or Root level, it will be overridden by this value.

class litestar.openapi.spec.Parameter#

Bases: BaseSchemaObject

Describes a single operation parameter.

A unique parameter is defined by a combination of a name and location.

name: str#

REQUIRED. The name of the parameter. Parameter names are case sensitive.

If in is "path", the name field MUST correspond to a template expression occurring within the path field in the Paths Object. See Path Templating for further information.
If in is "header" and the name field is "Accept", "Content-Type" or "Authorization", the parameter definition SHALL be ignored.
For all other cases, the name corresponds to the parameter name used by the in property.

param_in: str#: REQUIRED. The location of the parameter. Possible values are "query", "header", "path" or "cookie".

schema: Schema | Reference | None = None#: The schema defining the type used for the parameter.

description: str | None = None#

A brief description of the parameter. This could contain examples of use.

CommonMark syntax MAY be used for rich text representation.

required: bool = False#

Determines whether this parameter is mandatory.

If the parameter location is "path", this property is REQUIRED and its value MUST be True. Otherwise, the property MAY be included and its default value is False.

deprecated: bool = False#

Specifies that a parameter is deprecated and SHOULD be transitioned out of usage.

Default value is False.

__init__(name: str, param_in: str, schema: Schema | Reference | None = None, description: str | None = None, required: bool = False, deprecated: bool = False, allow_empty_value: bool = False, style: str | None = None, explode: bool | None = None, allow_reserved: bool = False, example: Any | None = None, examples: Mapping[str, Example | Reference] | None = None, content: dict[str, OpenAPIMediaType] | None = None) → None#

allow_empty_value: bool = False#

Sets the ability to pass empty-valued parameters. This is valid only for query parameters and allows sending a parameter with an empty value. Default value is False. If style is used, and if behavior is n/a (cannot be serialized), the value of allowEmptyValue SHALL be ignored. Use of this property is NOT RECOMMENDED, as it is likely to be removed in a later revision.

The rules for serialization of the parameter are specified in one of two ways. For simpler scenarios, a schema and style can describe the structure and syntax of the parameter.

style: str | None = None#

Describes how the parameter value will be serialized depending on the ype of the parameter value. Default values (based on value of in):

for query - form
for path - simple
for header - simple
for cookie - form

explode: bool | None = None#

When this is true, parameter values of type array or object generate separate parameters for each value of the array or key-value pair of the map.

For other types of parameters this property has no effect. When style is form, the default value is True. For all other styles, the default value is False.

allow_reserved: bool = False#

Determines whether the parameter value SHOULD allow reserved characters, as defined by.

RFC 3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding.

This property only applies to parameters with an in value of query. The default value is False.

example: Any | None = None#

Example of the parameter’s potential value.

The example SHOULD match the specified schema and encoding properties if present. The example field is mutually exclusive of the examples field. Furthermore, if referencing a schema that contains an example, the example value SHALL _override_ the example provided by the schema. To represent examples of media types that cannot naturally be represented in JSON or YAML, a string value can contain the example with escaping where necessary.

examples: Mapping[str, Example | Reference] | None = None#

Examples of the parameter’s potential value. Each example SHOULD contain a value in the correct format as specified in the parameter encoding. The examples field is mutually exclusive of the example field. Furthermore, if referencing a schema that contains an example, the examples value SHALL _override_ the example provided by the schema.

For more complex scenarios, the content property can define the media type and schema of the parameter. A parameter MUST contain either a schema property, or a content property, but not both. When example or examples are provided in conjunction with the schema object, the example MUST follow the prescribed serialization strategy for the parameter.

content: dict[str, OpenAPIMediaType] | None = None#

A map containing the representations for the parameter.

The key is the media type and the value describes it. The map MUST only contain one entry.

class litestar.openapi.spec.PathItem#

Bases: BaseSchemaObject

Describes the operations available on a single path.

A Path Item MAY be empty, due to ACL constraints. The path itself is still exposed to the documentation viewer, but they will not know which operations and parameters are available.

ref: str | None = None#

Allows for an external definition of this path item. The referenced structure MUST be in the format of a Path Item Object <https://spec.openapis.org/oas/v3.1.0#pathItemObject>.

In case a Path Item Object field appears both in the defined object and the referenced object, the behavior is undefined. See the rules for resolving Relative References.

summary: str | None = None#: An optional, string summary, intended to apply to all operations in this path.

description: str | None = None#

An optional, string description, intended to apply to all operations in this path.

CommonMark syntax MAY be used for rich text representation.

get: Operation | None = None#: A definition of a GET operation on this path.

put: Operation | None = None#: A definition of a PUT operation on this path.

post: Operation | None = None#: A definition of a POST operation on this path.

__init__(ref: str | None = None, summary: str | None = None, description: str | None = None, get: Operation | None = None, put: Operation | None = None, post: Operation | None = None, delete: Operation | None = None, options: Operation | None = None, head: Operation | None = None, patch: Operation | None = None, trace: Operation | None = None, servers: list[Server] | None = None, parameters: list[Parameter | Reference] | None = None) → None#

delete: Operation | None = None#: A definition of a DELETE operation on this path.

options: Operation | None = None#: A definition of a OPTIONS operation on this path.

head: Operation | None = None#: A definition of a HEAD operation on this path.

patch: Operation | None = None#: A definition of a PATCH operation on this path.

trace: Operation | None = None#: A definition of a TRACE operation on this path.

servers: list[Server] | None = None#: An alternative server array to service all operations in this path.

parameters: list[Parameter | Reference] | None = None#: A list of parameters that are applicable for all the operations described under this path. These parameters can be overridden at the operation level, but cannot be removed there. The list MUST NOT include duplicated parameters. A unique parameter is defined by a combination of a name and location. The list can use the Reference Object to link to parameters that are defined at the OpenAPI Object’s components/parameters.

class litestar.openapi.spec.Reference#

Bases: BaseSchemaObject

A simple object to allow referencing other components in the OpenAPI document, internally and externally.

The $ref string value contains a URI RFC3986 , which identifies the location of the value being referenced.

See the rules for resolving Relative References.

ref: str#: REQUIRED. The reference identifier. This MUST be in the form of a URI.

summary: str | None = None#

A short summary which by default SHOULD override that of the referenced component.

If the referenced object-type does not allow a summary field, then this field has no effect.

__init__(ref: str, summary: str | None = None, description: str | None = None) → None#

description: str | None = None#

A description which by default SHOULD override that of the referenced component.

CommonMark syntax MAY be used for rich text representation. If the referenced object-type does not allow a description field, then this field has no effect.

class litestar.openapi.spec.RequestBody#

Bases: BaseSchemaObject

Describes a single request body.

content: dict[str, OpenAPIMediaType]#

REQUIRED. The content of the request body. The key is a media type or media type range and the value describes it.

For requests that match multiple keys, only the most specific key is applicable. e.g. text/plain overrides text/*

__init__(content: dict[str, OpenAPIMediaType], description: str | None = None, required: bool = False) → None#

description: str | None = None#

A brief description of the request body. This could contain examples of use.

CommonMark syntax MAY be used for rich text representation.

required: bool = False#

Determines if the request body is required in the request.

Defaults to False.

class litestar.openapi.spec.Schema#

Bases: BaseSchemaObject

The Schema Object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. This object is a superset of the JSON Schema Specification Draft 2020-12.

For more information about the properties, see JSON Schema Core and JSON Schema Validation.

Unless stated otherwise, the property definitions follow those of JSON Schema and do not add any additional semantics. Where JSON Schema indicates that behavior is defined by the application (e.g. for annotations), OAS also defers the definition of semantics to the application consuming the OpenAPI document.

The following properties are taken directly from the JSON Schema Core and follow the same specifications.

all_of: Sequence[Reference | Schema] | None = None#

This keyword’s value MUST be a non-empty array. Each item of the array MUST be a valid JSON Schema.

An instance validates successfully against this keyword if it validates successfully against all schemas defined by this keyword’s value.

any_of: Sequence[Reference | Schema] | None = None#

This keyword’s value MUST be a non-empty array. Each item of the array MUST be a valid JSON Schema.

An instance validates successfully against this keyword if it validates successfully against at least one schema defined by this keyword’s value. Note that when annotations are being collected, all subschemas MUST be examined so that annotations are collected from each subschema that validates successfully.

one_of: Sequence[Reference | Schema] | None = None#

This keyword’s value MUST be a non-empty array. Each item of the array MUST be a valid JSON Schema.

An instance validates successfully against this keyword if it validates successfully against exactly one schema defined by this keyword’s value.

schema_not: Reference | Schema | None = None#

This keyword’s value MUST be a valid JSON Schema.

An instance is valid against this keyword if it fails to validate successfully against the schema defined by this keyword.

schema_if: Reference | Schema | None = None#

This keyword’s value MUST be a valid JSON Schema.

This validation outcome of this keyword’s subschema has no direct effect on the overall validation result. Rather, it controls which of the “then” or “else” keywords are evaluated.

Instances that successfully validate against this keyword’s subschema MUST also be valid against the subschema value of the “then” keyword, if present.

Instances that fail to validate against this keyword’s subschema MUST also be valid against the subschema value of the “else” keyword, if present.

If annotations (Section 7.7) are being collected, they are collected rom this keyword’s subschema in the usual way, including when the keyword is present without either “then” or “else”.

then: Reference | Schema | None = None#

This keyword’s value MUST be a valid JSON Schema.

When “if” is present, and the instance successfully validates against its subschema, then validation succeeds against this keyword if the instance also successfully validates against this keyword’s subschema.

This keyword has no effect when “if” is absent, or when the instance fails to validate against its subschema. Implementations MUST NOT evaluate the instance against this keyword, for either validation or annotation collection purposes, in such cases.

schema_else: Reference | Schema | None = None#

This keyword’s value MUST be a valid JSON Schema.

When “if” is present, and the instance fails to validate against its subschema, then validation succeeds against this keyword if the instance successfully validates against this keyword’s subschema.

This keyword has no effect when “if” is absent, or when the instance successfully validates against its subschema. Implementations MUST NOT evaluate the instance against this keyword, for either validation or annotation collection purposes, in such cases.

dependent_schemas: dict[str, Reference | Schema] | None = None#

This keyword specifies subschemas that are evaluated if the instance is an object and contains a certain property.

This keyword’s value MUST be an object. Each value in the object MUST be a valid JSON Schema.

If the object key is a property in the instance, the entire instance must validate against the subschema. Its use is dependent on the presence of the property.

Omitting this keyword has the same behavior as an empty object.

prefix_items: Sequence[Reference | Schema] | None = None#

The value of “prefixItems” MUST be a non-empty array of valid JSON Schemas.

Validation succeeds if each element of the instance validates against the schema at the same position, if any. This keyword does not constrain the length of the array. If the array is longer than this keyword’s value, this keyword validates only the prefix of matching length.

This keyword produces an annotation value which is the largest index to which this keyword applied a subschema. he value MAY be a boolean true if a subschema was applied to every index of the instance, such as is produced by the “items” keyword. This annotation affects the behavior of “items” and “unevaluatedItems”.

Omitting this keyword has the same assertion behavior as an empty array.

items: Reference | Schema | None = None#

The value of “items” MUST be a valid JSON Schema.

This keyword applies its subschema to all instance elements at indexes greater than the length of the “prefixItems” array in the same schema object, as reported by the annotation result of that “prefixItems” keyword. If no such annotation result exists, “items” applies its subschema to all instance array elements. [[CREF11: Note that the behavior of “items” without “prefixItems” is identical to that of the schema form of “items” in prior drafts. When “prefixItems” is present, the behavior of “items” is identical to the former “additionalItems” keyword. ]]

If the “items” subschema is applied to any positions within the instance array, it produces an annotation result of boolean true, indicating that all remaining array elements have been evaluated against this keyword’s subschema.

Omitting this keyword has the same assertion behavior as an empty schema.

Implementations MAY choose to implement or optimize this keyword in another way that produces the same effect, such as by directly checking for the presence and size of a “prefixItems” array. Implementations that do not support annotation collection MUST do so.

contains: Reference | Schema | None = None#

The value of this keyword MUST be a valid JSON Schema.

An array instance is valid against “contains” if at least one of its elements is valid against the given schema. The subschema MUST be applied to every array element even after the first match has been found, in order to collect annotations for use by other keywords. This is to ensure that all possible annotations are collected.

Logically, the validation result of applying the value subschema to each item in the array MUST be ORed with “false”, resulting in an overall validation result.

This keyword produces an annotation value which is an array of the indexes to which this keyword validates successfully when applying its subschema, in ascending order. The value MAY be a boolean “true” if the subschema validates successfully when applied to every index of the instance. The annotation MUST be present if the instance array to which this keyword’s schema applies is empty.

properties: dict[str, Reference | Schema] | None = None#

The value of “properties” MUST be an object. Each value of this object MUST be a valid JSON Schema.

Validation succeeds if, for each name that appears in both the instance and as a name within this keyword’s value, the child instance for that name successfully validates against the corresponding schema.

The annotation result of this keyword is the set of instance property names matched by this keyword.

Omitting this keyword has the same assertion behavior as an empty object.

pattern_properties: dict[str, Reference | Schema] | None = None#

The value of “patternProperties” MUST be an object. Each property name of this object SHOULD be a valid regular expression, according to the ECMA-262 regular expression dialect. Each property value of this object MUST be a valid JSON Schema.

Validation succeeds if, for each instance name that matches any regular expressions that appear as a property name in this keyword’s value, the child instance for that name successfully validates against each schema that corresponds to a matching regular expression.

The annotation result of this keyword is the set of instance property names matched by this keyword.

Omitting this keyword has the same assertion behavior as an empty object.

additional_properties: Reference | Schema | bool | None = None#

The value of “additionalProperties” MUST be a valid JSON Schema.

The behavior of this keyword depends on the presence and annotation results of “properties” and “patternProperties” within the same schema object. Validation with “additionalProperties” applies only to the child values of instance names that do not appear in the annotation results of either “properties” or “patternProperties”.

For all such properties, validation succeeds if the child instance validates against the “additionalProperties” schema.

The annotation result of this keyword is the set of instance property names validated by this keyword’s subschema.

Omitting this keyword has the same assertion behavior as an empty schema.

Implementations MAY choose to implement or optimize this keyword in another way that produces the same effect, such as by directly checking the names in “properties” and the patterns in “patternProperties” against the instance property set. Implementations that do not support annotation collection MUST do so.

property_names: Reference | Schema | None = None#

The value of “propertyNames” MUST be a valid JSON Schema.

If the instance is an object, this keyword validates if every property name in the instance validates against the provided schema. Note the property name that the schema is testing will always be a string.

Omitting this keyword has the same behavior as an empty schema.

unevaluated_items: Reference | Schema | None = None#

The value of “unevaluatedItems” MUST be a valid JSON Schema.

The behavior of this keyword depends on the annotation results of adjacent keywords that apply to the instance location being validated. Specifically, the annotations from “prefixItems” items”, and “contains”, which can come from those keywords when they are adjacent to the “unevaluatedItems” keyword. Those three annotations, as well as “unevaluatedItems”, can also result from any and all adjacent in-place applicator (Section 10.2) keywords. This includes but is not limited to the in-place applicators defined in this document.

If no relevant annotations are present, the “unevaluatedItems” subschema MUST be applied to all locations in the array. If a boolean true value is present from any of the relevant annotations, unevaluatedItems” MUST be ignored. Otherwise, the subschema MUST be applied to any index greater than the largest annotation value for “prefixItems”, which does not appear in any annotation value for “contains”.

This means that “prefixItems”, “items”, “contains”, and all in-place applicators MUST be evaluated before this keyword can be evaluated. Authors of extension keywords MUST NOT define an in-place applicator that would need to be evaluated after this keyword.

If the “unevaluatedItems” subschema is applied to any positions within the instance array, it produces an annotation result of boolean true, analogous to the behavior of “items”.

Omitting this keyword has the same assertion behavior as an empty schema.

unevaluated_properties: Reference | Schema | None = None#

The value of “unevaluatedProperties” MUST be a valid JSON Schema.

The behavior of this keyword depends on the annotation results of adjacent keywords that apply to the instance location being validated. Specifically, the annotations from “properties”, “patternProperties”, and “additionalProperties”, which can come from those keywords when they are adjacent to the “unevaluatedProperties” keyword. Those three annotations, as well as “unevaluatedProperties”, can also result from any and all adjacent in-place applicator (Section 10.2) keywords. This includes but is not limited to the in-place applicators defined in this document.

Validation with “unevaluatedProperties” applies only to the child values of instance names that do not appear in the “properties”, “patternProperties”, “additionalProperties”, or “unevaluatedProperties” annotation results that apply to the instance location being validated.

For all such properties, validation succeeds if the child instance validates against the “unevaluatedProperties” schema.

This means that “properties”, “patternProperties”, “additionalProperties”, and all in-place applicators MUST be evaluated before this keyword can be evaluated. Authors of extension keywords MUST NOT define an in-place applicator that would need to be evaluated after this keyword.

The annotation result of this keyword is the set of instance property names validated by this keyword’s subschema.

Omitting this keyword has the same assertion behavior as an empty schema.

The following properties are taken directly from the JSON Schema Validation and follow the same specifications:

type: OpenAPIType | Sequence[OpenAPIType] | None = None#

The value of this keyword MUST be either a string or an array. If it is an array, elements of the array MUST be strings and MUST be unique.

String values MUST be one of the six primitive types ("null", "boolean", "object", "array", "number", and "string"), or "integer" which matches any number with a zero fractional part.

An instance validates if and only if the instance is in any of the sets listed for this keyword.

enum: Sequence[Any] | None = None#

The value of this keyword MUST be an array. This array SHOULD have at least one element. Elements in the array SHOULD be unique.

An instance validates successfully against this keyword if its value is equal to one of the elements in this keyword’s array value.

Elements in the array might be of any type, including null.

const: Any | None = None#

The value of this keyword MAY be of any type, including null.

Use of this keyword is functionally equivalent to an “enum” (Section 6.1.2) with a single value.

An instance validates successfully against this keyword if its value is equal to the value of the keyword.

multiple_of: float | None = None#

The value of “multipleOf” MUST be a number, strictly greater than 0.

A numeric instance is only valid if division by this keyword’s value results in an integer.

maximum: float | None = None#

The value of “maximum” MUST be a number, representing an inclusive upper limit for a numeric instance.

If the instance is a number, then this keyword validates only if the instance is less than or exactly equal to “maximum”.

exclusive_maximum: float | None = None#

The value of “exclusiveMaximum” MUST be a number, representing an exclusive upper limit for a numeric instance.

If the instance is a number, then the instance is valid only if it has a value strictly less than (not equal to) “exclusiveMaximum”.

minimum: float | None = None#

The value of “minimum” MUST be a number, representing an inclusive lower limit for a numeric instance.

If the instance is a number, then this keyword validates only if the instance is greater than or exactly equal to “minimum”.

exclusive_minimum: float | None = None#

The value of “exclusiveMinimum” MUST be a number, representing an exclusive lower limit for a numeric instance.

If the instance is a number, then the instance is valid only if it has a value strictly greater than (not equal to) “exclusiveMinimum”.

max_length: int | None = None#

The value of this keyword MUST be a non-negative integer.

A string instance is valid against this keyword if its length is less than, or equal to, the value of this keyword.

The length of a string instance is defined as the number of its characters as defined by RFC 8259.

min_length: int | None = None#

The value of this keyword MUST be a non-negative integer.

A string instance is valid against this keyword if its length is greater than, or equal to, the value of this keyword.

The length of a string instance is defined as the number of its characters as defined by RFC 8259.

Omitting this keyword has the same behavior as a value of 0.

__init__(all_of: Sequence[Reference | Schema] | None = None, any_of: Sequence[Reference | Schema] | None = None, one_of: Sequence[Reference | Schema] | None = None, schema_not: Reference | Schema | None = None, schema_if: Reference | Schema | None = None, then: Reference | Schema | None = None, schema_else: Reference | Schema | None = None, dependent_schemas: dict[str, Reference | Schema] | None = None, prefix_items: Sequence[Reference | Schema] | None = None, items: Reference | Schema | None = None, contains: Reference | Schema | None = None, properties: dict[str, Reference | Schema] | None = None, pattern_properties: dict[str, Reference | Schema] | None = None, additional_properties: Reference | Schema | bool | None = None, property_names: Reference | Schema | None = None, unevaluated_items: Reference | Schema | None = None, unevaluated_properties: Reference | Schema | None = None, type: OpenAPIType | Sequence[OpenAPIType] | None = None, enum: Sequence[Any] | None = None, const: Any | None = None, multiple_of: float | None = None, maximum: float | None = None, exclusive_maximum: float | None = None, minimum: float | None = None, exclusive_minimum: float | None = None, max_length: int | None = None, min_length: int | None = None, pattern: str | None = None, max_items: int | None = None, min_items: int | None = None, unique_items: bool | None = None, max_contains: int | None = None, min_contains: int | None = None, max_properties: int | None = None, min_properties: int | None = None, required: Sequence[str] | None = None, dependent_required: dict[str, Sequence[str]] | None = None, format: OpenAPIFormat | None = None, content_encoding: str | None = None, content_media_type: str | None = None, content_schema: Reference | Schema | None = None, title: str | None = None, description: str | None = None, default: Any | None = None, deprecated: bool | None = None, read_only: bool | None = None, write_only: bool | None = None, examples: list[Any] | None = None, discriminator: Discriminator | None = None, xml: XML | None = None, external_docs: ExternalDocumentation | None = None, example: Any | None = None) → None#

pattern: str | None = None#

The value of this keyword MUST be a string. This string SHOULD be a valid regular expression, according to the ECMA-262 regular expression dialect.

A string instance is considered valid if the regular expression matches the instance successfully. Recall: regular expressions are not implicitly anchored.

max_items: int | None = None#

The value of this keyword MUST be a non-negative integer.

An array instance is valid against “maxItems” if its size is less than, or equal to, the value of this keyword.

min_items: int | None = None#

The value of this keyword MUST be a non-negative integer.

An array instance is valid against “minItems” if its size is greater than, or equal to, the value of this keyword.

Omitting this keyword has the same behavior as a value of 0.

unique_items: bool | None = None#

The value of this keyword MUST be a boolean.

If this keyword has boolean value false, the instance validates successfully. If it has boolean value true, the instance validates successfully if all of its elements are unique.

Omitting this keyword has the same behavior as a value of false.

max_contains: int | None = None#

The value of this keyword MUST be a non-negative integer.

If “contains” is not present within the same schema object, then this keyword has no effect.

An instance array is valid against “maxContains” in two ways, depending on the form of the annotation result of an adjacent “contains” [json-schema] keyword. The first way is if the annotation result is an array and the length of that array is less than or equal to the “maxContains” value. The second way is if the annotation result is a boolean “true” and the instance array length is less than r equal to the “maxContains” value.

min_contains: int | None = None#

The value of this keyword MUST be a non-negative integer.

If “contains” is not present within the same schema object, then this keyword has no effect.

An instance array is valid against “minContains” in two ways, depending on the form of the annotation result of an adjacent “contains” [json-schema] keyword. The first way is if the annotation result is an array and the length of that array is greater than or equal to the “minContains” value. The second way is if the annotation result is a boolean “true” and the instance array length is greater than or equal to the “minContains” value.

A value of 0 is allowed, but is only useful for setting a range of occurrences from 0 to the value of “maxContains”. A value of 0 with no “maxContains” causes “contains” to always pass validation.

Omitting this keyword has the same behavior as a value of 1.

max_properties: int | None = None#

The value of this keyword MUST be a non-negative integer.

An object instance is valid against “maxProperties” if its number of properties is less than, or equal to, the value of this keyword.

min_properties: int | None = None#

The value of this keyword MUST be a non-negative integer.

An object instance is valid against “minProperties” if its number of properties is greater than, or equal to, the value of this keyword.

Omitting this keyword has the same behavior as a value of 0.

required: Sequence[str] | None = None#

The value of this keyword MUST be an array. Elements of this array, if any, MUST be strings, and MUST be unique.

An object instance is valid against this keyword if every item in the rray is the name of a property in the instance.

Omitting this keyword has the same behavior as an empty array.

dependent_required: dict[str, Sequence[str]] | None = None#

The value of this keyword MUST be an object. Properties in this object, f any, MUST be arrays. Elements in each array, if any, MUST be strings, and MUST be unique.

This keyword specifies properties that are required if a specific other property is present. Their requirement is dependent on the presence of the other property.

Validation succeeds if, for each name that appears in both the instance and as a name within this keyword’s value, every item in the corresponding array is also the name of a property in the instance.

Omitting this keyword has the same behavior as an empty object.

format: OpenAPIFormat | None = None#

From OpenAPI:

See Data Type Formats for further details. While relying on JSON Schema’s defined formats, the OAS offers a few additional predefined formats.

From JSON Schema:

Structural validation alone may be insufficient to allow an application to correctly utilize certain values. The “format” annotation keyword is defined to allow schema authors to convey semantic information for a fixed subset of values which are accurately described by authoritative resources, be they RFCs or other external specifications.

The value of this keyword is called a format attribute. It MUST be a string. A format attribute can generally only validate a given set of instance types. If the type of the instance to validate is not in this set, validation for this format attribute and instance SHOULD succeed. All format attributes defined in this section apply to strings, but a format attribute can be specified to apply to any instance types defined in the data model defined in the core JSON Schema. [json-schema] [[CREF1: Note that the “type” keyword in this specification defines an “integer” type which is not part of the data model. Therefore a format attribute can be limited to numbers, but not specifically to integers. However, a numeric format can be used alongside the “type” keyword with a value of “integer”, or could be explicitly defined to always pass if the number is not an integer, which produces essentially the same behavior as only applying to integers. ]]

content_encoding: str | None = None#

If the instance value is a string, this property defines that the string SHOULD be interpreted as binary data and decoded using the encoding named by this property.

Possible values indicating base 16, 32, and 64 encodings with several variations are listed in RFC 4648. Additionally, sections 6.7 and 6.8 of RFC 2045 provide encodings used in MIME. As “base64” is defined in both RFCs, the definition from RFC 4648 SHOULD be assumed unless the string is specifically intended for use in a MIME context. Note that all of these encodings result in strings consisting only of 7-bit ASCII characters. therefore, this keyword has no meaning for strings containing characters outside of that range.

If this keyword is absent, but “contentMediaType” is present, this indicates that the encoding is the identity encoding, meaning that no transformation was needed in order to represent the content in a UTF-8 string.

content_media_type: str | None = None#

If the instance is a string, this property indicates the media type of the contents of the string. If “contentEncoding” is present, this property describes the decoded string.

The value of this property MUST be a string, which MUST be a media type, as defined by RFC 2046

content_schema: Reference | Schema | None = None#

If the instance is a string, and if “contentMediaType” is present, this property contains a schema which describes the structure of the string.

This keyword MAY be used with any media type that can be mapped into JSON Schema’s data model.

The value of this property MUST be a valid JSON schema. It SHOULD be ignored if “contentMediaType” is not present.

title: str | None = None#

The value of “title” MUST be a string.

The title can be used to decorate a user interface with information about the data produced by this user interface. A title will preferably be short.

description: str | None = None#

From OpenAPI:

CommonMark syntax MAY be used for rich text representation.

From JSON Schema: The value “description” MUST be a string.

The description can be used to decorate a user interface with information about the data produced by this user interface. A description will provide explanation about the purpose of the instance described by this schema.

default: Any | None = None#

There are no restrictions placed on the value of this keyword. When multiple occurrences of this keyword are applicable to a single sub-instance, implementations SHOULD remove duplicates.

This keyword can be used to supply a default JSON value associated with a particular schema. It is RECOMMENDED that a default value be valid against the associated schema.

deprecated: bool | None = None#

The value of this keyword MUST be a boolean. When multiple occurrences of this keyword are applicable to a single sub-instance, applications SHOULD consider the instance location to be deprecated if any occurrence specifies a true value.

If “deprecated” has a value of boolean true, it indicates that applications SHOULD refrain from usage of the declared property. It MAY mean the property is going to be removed in the future.

A root schema containing “deprecated” with a value of true indicates that the entire resource being described MAY be removed in the future.

The “deprecated” keyword applies to each instance location to which the schema object containing the keyword successfully applies. This can result in scenarios where every array item or object property is deprecated even though the containing array or object is not.

Omitting this keyword has the same behavior as a value of false.

read_only: bool | None = None#

The value of “readOnly” MUST be a boolean. When multiple occurrences of this keyword are applicable to a single sub-instance, the resulting behavior SHOULD be as for a true value if any occurrence specifies a true value, and SHOULD be as for a false value otherwise.

If “readOnly” has a value of boolean true, it indicates that the value of the instance is managed exclusively by the owning authority, and attempts by an application to modify the value of this property are expected to be ignored or rejected by that owning authority.

An instance document that is marked as “readOnly” for the entire document MAY be ignored if sent to the owning authority, or MAY result in an error, at the authority’s discretion.

For example, “readOnly” would be used to mark a database-generated serial number as read-only, while “writeOnly” would be used to mark a password input field.

This keyword can be used to assist in user interface instance generation. In particular, an application MAY choose to use a widget that hides input values as they are typed for write-only fields.

Omitting these keywords has the same behavior as values of false.

write_only: bool | None = None#

The value of “writeOnly” MUST be a boolean. When multiple occurrences of this keyword are applicable to a single sub-instance, the resulting behavior SHOULD be as for a true value if any occurrence specifies a true value, and SHOULD be as for a false value otherwise.

If “writeOnly” has a value of boolean true, it indicates that the value is never present when the instance is retrieved from the owning authority. It can be present when sent to the owning authority to update or create the document (or the resource it represents), but it will not be included in any updated or newly created version of the instance.

An instance document that is marked as “writeOnly” for the entire document MAY be returned as a blank document of some sort, or MAY produce an error upon retrieval, or have the retrieval request ignored, at the authority’s discretion.

For example, “readOnly” would be used to mark a database-generated serial number as read-only, while “writeOnly” would be used to mark a password input field.

This keyword can be used to assist in user interface instance generation. In particular, an application MAY choose to use a widget that hides input values as they are typed for write-only fields.

Omitting these keywords has the same behavior as values of false.

examples: list[Any] | None = None#: The value of this must be an array containing the example values.

discriminator: Discriminator | None = None#

Adds support for polymorphism.

The discriminator is an object name that is used to differentiate between other schemas which may satisfy the payload description. See Composition and Inheritance for more details.

xml: XML | None = None#

This MAY be used only on properties schemas.

It has no effect on root schemas. Adds additional metadata to describe the XML representation of this property.

external_docs: ExternalDocumentation | None = None#: Additional external documentation for this schema.

example: Any | None = None#

A free-form property to include an example of an instance for this schema. To represent examples that cannot be naturally represented in JSON or YAML, a string value can be used to contain the example with escaping where necessary.

Deprecated: The example property has been deprecated in favor of the JSON Schema examples keyword. Use of example is discouraged, and later versions of this specification may remove it.

class litestar.openapi.spec.SecurityScheme#

Bases: BaseSchemaObject

Defines a security scheme that can be used by the operations.

Supported schemes are HTTP authentication, an API key (either as a header, a cookie parameter or as a query parameter), mutual TLS (use of a client certificate), OAuth2’s common flows (implicit, password, client credentials and authorization code) as defined in :rfc`6749`, and OpenID Connect Discovery.

Please note that as of 2020, the implicit flow is about to be deprecated by OAuth 2.0 Security Best Current Practice. Recommended for most use case is Authorization Code Grant flow with PKCE.

type: Literal['apiKey', 'http', 'mutualTLS', 'oauth2', 'openIdConnect']#: REQUIRED. The type of the security scheme.

description: str | None = None#

A description for security scheme.

CommonMark syntax MAY be used for rich text representation.

name: str | None = None#: REQUIRED for apiKey. The name of the header, query or cookie parameter to be used.

security_scheme_in: Literal['query', 'header', 'cookie'] | None = None#: REQUIRED for apiKey. The location of the API key.

__init__(type: Literal['apiKey', 'http', 'mutualTLS', 'oauth2', 'openIdConnect'], description: str | None = None, name: str | None = None, security_scheme_in: Literal['query', 'header', 'cookie'] | None = None, scheme: str | None = None, bearer_format: str | None = None, flows: OAuthFlows | None = None, open_id_connect_url: str | None = None) → None#

scheme: str | None = None#

REQUIRED for http. The name of the HTTP Authorization scheme to be used in the authorization header as defined in RFC 7235.

The values used SHOULD be registered in the IANA Authentication Scheme registry

bearer_format: str | None = None#

A hint to the client to identify how the bearer token is formatted.

Bearer tokens are usually generated by an authorization server, so this information is primarily for documentation purposes.

flows: OAuthFlows | None = None#: REQUIRED for oauth2. An object containing configuration information for the flow types supported.

open_id_connect_url: str | None = None#: REQUIRED for openIdConnect. OpenId Connect URL to discover OAuth2 configuration values. This MUST be in the form of a URL. The OpenID Connect standard requires the use of TLS.

class litestar.openapi.spec.Server#

Bases: BaseSchemaObject

An object representing a Server.

url: str#

REQUIRED. A URL to the target host.

This URL supports Server Variables and MAY be relative, to indicate that the host location is relative to the location where the OpenAPI document is being served. Variable substitutions will be made when a variable is named in {brackets}.

__init__(url: str, description: str | None = None, variables: dict[str, ServerVariable] | None = None) → None#

description: str | None = None#

An optional string describing the host designated by the URL.

CommonMark syntax MAY be used for rich text representation.

variables: dict[str, ServerVariable] | None = None#: A map between a variable name and its value. The value is used for substitution in the server’s URL template.

class litestar.openapi.spec.ServerVariable#

Bases: BaseSchemaObject

An object representing a Server Variable for server URL template substitution.

default: str#: REQUIRED. The default value to use for substitution, which SHALL be sent if an alternate value is _not_ supplied. Note this behavior is different than the Schema Object’s treatment of default values, because in those cases parameter values are optional. If the enum is defined, the value MUST exist in the enum’s values.

__init__(default: str, enum: list[str] | None = None, description: str | None = None) → None#

enum: list[str] | None = None#

An enumeration of string values to be used if the substitution options are from a limited set.

The array SHOULD NOT be empty.

description: str | None = None#

An optional description for the server variable.

CommonMark syntax MAY be used for rich text representation.

class litestar.openapi.spec.Tag#

Bases: BaseSchemaObject

Adds metadata to a single tag that is used by the Operation Object.

It is not mandatory to have a Tag Object per tag defined in the Operation Object instances.

name: str#: REQUIRED. The name of the tag.

__init__(name: str, description: str | None = None, external_docs: ExternalDocumentation | None = None) → None#

description: str | None = None#

A short description for the tag.

CommonMark syntax MAY be used for rich text representation.

external_docs: ExternalDocumentation | None = None#: Additional external documentation for this tag.

class litestar.openapi.spec.XML#

Bases: BaseSchemaObject

A metadata object that allows for more fine-tuned XML model definitions.

When using arrays, XML element names are not inferred (for singular/plural forms) and the name property SHOULD be used to add that information. See examples for expected behavior.

name: str | None = None#: Replaces the name of the element/attribute used for the described schema property. When defined within items, it will affect the name of the individual XML elements within the list. When defined alongside type being array (outside the items), it will affect the wrapping element and only if wrapped is True. If wrapped is False, it will be ignored.

namespace: str | None = None#: The URI of the namespace definition. Value MUST be in the form of an absolute URI.

__init__(name: str | None = None, namespace: str | None = None, prefix: str | None = None, attribute: bool = False, wrapped: bool = False) → None#

prefix: str | None = None#: The prefix to be used for the xmlName

attribute: bool = False#: Declares whether the property definition translates to an attribute instead of an element. Default value is False.

wrapped: bool = False#: MAY be used only for an array definition. Signifies whether the array is wrapped (for example, <books><book/><book/></books>) or unwrapped (<book/><book/>). Default value is False. The definition takes effect only when defined alongside type being array (outside the items).

litestar.openapi.spec.SecurityRequirement#: alias of Dict[str, List[str]]