Skip to main content

Interface: $Properties

Properties of a Response.

Extended by​

Properties​

description?​

optional description?: string | null

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

examples?​

optional examples?: {[k: string]: string; } | null

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?: {[k: string]: $Properties; } | null

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?: {[k: string]: $Properties; } | null

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?: $Properties | null

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