Package-level declarations

The locations of the API key.

The authentication scheme. https://www.iana.org/assignments/http-authschemes/http-authschemes.xhtml

The type of security schemes

Describes a single request/response body with a single schema.

Contact information for the exposed API.

Configuration for examples

An object representing external documentation.

Encoder to produce the final example value. Return the unmodified example to fall back to the default encoder.

Function to generate swagger schemas for any given type

Describes a single header.

Basic information for the exposed API.

License information for the exposed API.

Describes a single request/response body with multipart content. See https://swagger.io/docs/specification/describing-request-body/multipart-requests/ for more info

Describes one section of a multipart-body. See https://swagger.io/docs/specification/describing-request-body/multipart-requests/ for more info

Main-Configuration of the "OpenApi"-Plugin

Configuration details for a supported OAuth Flow

An object containing configuration information for the oauth flow types supported

Locations for request parameters.

Filters paths to determine which to include (return 'true') in the spec and which to hide (return 'true').

Function executed after building the openapi-spec.

Describes a single request.

Describes a single request parameter.

A container for the expected responses of an operation. The container maps an HTTP response code to the expected response. A response code can only have one response object.

All possible responses of an operation

Describes a single route including request and responses.

Configuration for schemas

Overwrite specific types with custom schemas

Configuration for security and authentication.

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), OAuth2's common flows (implicit, password, client credentials and authorization code)

An object representing a Server.

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

Describes the base of a single request/response body.

Assigns (unassigned) routes to api-specs. url - the parts of the route-url split at all /. tags - the tags assigned to the route

Adds metadata to a single tag.

Generates additional tags for routes. url - the parts of the route-url split at all /. return a collection of tags. "Null"-entries will be ignored.

Configuration for tags