Skip to main content

Interface: $Properties

Properties of a HeaderParameter.

Extended by​

Properties​

description?​

optional description?: string | null

Description is a short description of the header.

format?​

optional format?: string | null

Format The extending format for the previously mentioned type.

name?​

optional name?: string | null

Name is the header name.

required?​

optional required?: boolean | null

Required indicates if the header is optional

type?​

optional type?: Type | null

Type is the type of the object. The value MUST be one of "string", "number", "integer", or "boolean". The "array" type is not supported. See: https://swagger.io/specification/v2/#parameterType.