Skip to main content

Interface: IHeader

Properties of a Header.

Extends​

Properties​

default?​

optional default?: string | null

Default Declares the value of the header that the server will use if none is provided. See: https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-6.2. Unlike JSON Schema this value MUST conform to the defined type for the header.

Inherited from​

$Properties.default

description?​

optional description?: string | null

Description is a short description of the header.

Inherited from​

$Properties.description

format?​

optional format?: string | null

Format The extending format for the previously mentioned type.

Inherited from​

$Properties.format

pattern?​

optional pattern?: string | null

'Pattern' See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.3.

Inherited from​

$Properties.pattern

type?​

optional type?: string | null

The type of the object. The value MUST be one of "string", "number", "integer", or "boolean". The "array" type is not supported.

Inherited from​

$Properties.type