Skip to main content

Interface: $Properties

options.Response.$Properties

Properties of a Response.

Hierarchy​

Properties​

description​

• Optional description: null | string

Description is a short description of the response. GFM syntax can be used for rich text representation.

examples​

• Optional examples: null | { [k: string]: string; }

Examples gives per-mimetype response examples. See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#example-object

extensions​

• Optional extensions: null | { [k: string]: $Properties; }

Custom properties that start with "x-" such as "x-foo" used to describe extra functionality that is not covered by the standard OpenAPI Specification. See: https://swagger.io/docs/specification/2-0/swagger-extensions/

headers​

• Optional headers: null | { [k: string]: $Properties; }

Headers A list of headers that are sent with the response. Header name is expected to be a string in the canonical format of the MIME header key See: https://golang.org/pkg/net/textproto/#CanonicalMIMEHeaderKey

schema​

• Optional schema: null | $Properties

Schema optionally defines the structure of the response. If Schema is not provided, it means there is no content to the response.