Interface: IHeader

protoc_gen_openapiv2.options.IHeader

Properties of a Header.

Hierarchy

• $Properties

  ↳ IHeader

Properties

default

• Optional default: null | string

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: null | string

Description is a short description of the header.

Inherited from

$Properties.description

---

format

• Optional format: null | string

Format The extending format for the previously mentioned type.

Inherited from

$Properties.format

---

pattern

• Optional pattern: null | string

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

Inherited from

$Properties.pattern

---

type

• Optional type: null | string

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