Skip to main contentModule openapi
Source - 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).
- AdditionalProperties
- ExclusiveBound
- 3.0 used
exclusiveMinimum: true as a bool flag against minimum;
3.1 (JSON Schema 2020-12) uses exclusiveMinimum: <number>. - ResponseMediaKind
- Semantic representation used for a response media entry.
- 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.
- classify_response_media_type
- Classify one declared response representation for client/server analysis.
- is_binary_media_type
- Returns true when a response representation must be handled as raw bytes.
- is_event_stream_media_type
- Returns true only for the
text/event-stream media type essence. - 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.
- is_text_media_type
- Returns true for non-SSE media types in the
text top-level family. - is_wildcard_media_type
- Returns true for OpenAPI media ranges with a wildcard subtype.
- media_type_essence
- Return the media type essence, excluding parameters and surrounding space.