Module paths

Structs

Callback

A map of possible out-of band callbacks related to the parent operation. Each value in the map is a Path Item 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.

Encoding

A single encoding definition applied to a single schema property.

Example

ExternalDocumentation

Allows referencing an external resource for extended documentation.

Header

The Header Object follows the structure of the Parameter Object with the following changes:

Link

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.

MediaType

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

Operation

Describes a single API operation on a path.

Parameter

Describes a single operation parameter. A unique parameter is defined by a combination of a name and location. Parameter Locations

PathItem

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.

Paths

RequestBody

Describes a single request body.

Response

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

Responses

A container for the expected responses of an operation. The container maps a HTTP response code to the expected response.

Enums

AnyOrExpression

ExampleValue

Examples

OperationIdentifier

OperationType

ParameterDefinition

ParameterIn

ParameterStyle