Package-level declarations

Represents the OpenAPI Schema Object's additionalProperties field. It can be either a boolean that allows or forbids additional properties, or a schema reference describing the type of those additional properties.

Describes an API Key-based security scheme for OpenAPI 3.0+ specifications.

A map of possible out-of band callbacks related to the parent operation. Each value in the map is a PathItem Object that describes a set of requests that may be initiated by the API provider and the expected responses. The key value used to identify the path item object is an expression, evaluated at runtime, that identifies a URL to use for the callback operation.

Holds a set of reusable objects for different aspects of the OAS. All objects defined within the component object will have no effect on the API unless they are explicitly referenced from properties outside the component object.

Serializer for ContentType that uses ContentType.toString and ContentType.parse

A single encoding definition applied to a single schema property.

Example Object (OpenAPI). Represents an example payload/value for a schema.

A map of arbitrary extension properties, each key starting with "x-".

Allows referencing an external resource for extended documentation.

A generalized element for deferred deserialization for use as an interoperable stand in for JSON and YAML nodes.

Adapter for custom GenericElement types when using different encoders / decoders.

A GenericElement serializer that delegates to the first registered GenericElementSerialAdapter that can deserialize the element.

A GenericElement implementation that wraps a string value.

A GenericElement implementation that wraps a value of type T.

Header fields have the same meaning as for 'Param'. Style is always treated as Style.simple, as it is the only value allowed for headers.

Container for named headers attached to a response.

Describes an HTTP-based security scheme.

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 an extended subset of the JSON Schema Specification Wright Draft 00. For more information about the properties, see JSON Schema Core and JSON Schema Validation. Unless stated otherwise, the property definitions follow the JSON Schema.

Adds support for polymorphism. The discriminator is the schema property name that is used to differentiate between other schema that inherit this schema. The property name used MUST be defined at this schema and it MUST be in the required property list. When used, the value MUST be the name of this schema or any schema that inherits it.

Context interface for creating schema from type metadata.

Represents the base data types defined in the JSON Schema specification.

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, but it does provide a known relationship and traversal mechanism between responses and other operations.

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

Configuration details for a supported OAuth Flow.

Allows configuration of the supported OAuth Flows.

A small interface exposing the OpenAPI document builder state.

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.

Describes a single API operation on a path item as defined by the OpenAPI Specification. Use Operation.Builder or Operation.build to create instances in a type-safe DSL.

Describes a single operation parameter (path, query, header, or cookie).

A container for multiple operation Parameter definitions created via Parameters.Builder.

Describes the operations, parameters, and servers available for a single API path, as defined by the OpenAPI Specification Path Item Object. This is a container that aggregates the HTTP operations (GET, PUT, POST, DELETE, OPTIONS, HEAD, PATCH, TRACE) and common metadata that apply to the path.

Defines Union A | Reference. A lot of types like Header, Schema, MediaType, etc. can be either a direct value or a reference to a definition.

Describes the request body for an operation including content types, schemas, and whether it is required.

Describes a response returned by an operation including description, headers, content, and links.

A container for named response objects keyed by HTTP status code or "default".

Represents a list of security requirements (schemes with optional scopes) for an operation.

Lists the required security schemes to execute this operation. The object can have multiple security schemes declared in it which are all required (that is, there is a logical AND between the schemes).

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

The location of the API key for apiKey type security schemes.

The type of the security scheme.

Describes a server that hosts the API.

A container for multiple Server definitions used by an operation.

Allows adding metadata to a single tag that is used by @Operation@. It is not mandatory to have a @Tag@ per tag used there.

Infers JSON schema from kotlinx-serialization descriptors.

Deserialize an element to the given type T.

Generates a JSON Schema representation from a Kotlinx Serialization SerialDescriptor.

Convenience function for creating a GenericElement from a value of type T.

Create an object node GenericElement from the given entries.

Create an object node GenericElement from the given map.

Generates a JSON Schema representation for the given type T.

Create an instance of JsonSchema from the provided properties and supplied annotations.