Skip to main content

Module openapi

Module openapi 

Source

Structs§

Callback
OpenAPI Callback Object (H8). A map keyed by runtime-expression URL templates, with Path Item values.
Components
Discriminator
Encoding
OpenAPI Encoding Object (H4). Used inside multipart/form-data and application/x-www-form-urlencoded Media Type bodies.
Example
OpenAPI Example Object (H6).
ExternalDocs
OpenAPI External Documentation Object (H10).
Header
OpenAPI Header Object (H5). Structurally a Parameter minus the name and in fields. Used in Response.headers, Encoding.headers, and Components.headers.
Info
Link
OpenAPI Link Object (H7).
MediaType
OpenAPI Media Type Object
OAuthFlow
OAuthFlows
OpenApiSpec
Operation
OpenAPI Operation Object
Parameter
OpenAPI Parameter Object
PathItem
OpenAPI Path Item Object
RequestBody
OpenAPI Request Body Object
Response
OpenAPI Response Object
SchemaDetails
Server
OpenAPI Server Object (H1). Multiple servers, server variables, and 3.2’s name field are all modeled.
ServerVariable
Tag
OpenAPI Tag Object (H9 + D5 — 3.2 added summary/parent/kind).

Enums§

AdditionalProperties
ExclusiveBound
3.0 used exclusiveMinimum: true as a bool flag against minimum; 3.1 (JSON Schema 2020-12) uses exclusiveMinimum: <number>.
Schema
SchemaType
SecurityScheme
OpenAPI Security Scheme Object (H2). Covers all 3.x scheme types: apiKey, http (basic/bearer/digest), oauth2 (with flows), openIdConnect, and 3.1+ mutualTLS.

Functions§

is_form_urlencoded_media_type
Returns true for application/x-www-form-urlencoded (with optional parameters).
is_json_media_type
Returns true for media types whose payload is JSON.