Interface: IHeaderParameter

Properties of a HeaderParameter.

Extends

• $Properties

Properties

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

---

name?

optional name?: string | null

Name is the header name.

Inherited from

$Properties.name

---

required?

optional required?: boolean | null

Required indicates if the header is optional

Inherited from

$Properties.required

---

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.

Inherited from

$Properties.type