Skip to main content

Interface: $Properties

options.HeaderParameter.$Properties

Properties of a HeaderParameter.

Hierarchy​

Properties​

description​

• Optional description: null | string

Description is a short description of the header.

format​

• Optional format: null | string

Format The extending format for the previously mentioned type.

name​

• Optional name: null | string

Name is the header name.

required​

• Optional required: null | boolean

Required indicates if the header is optional

type​

• Optional type: null | Type

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.