Interface IHeaders

Metadata of headers.

interface IHeaders {
    description: () => undefined | string;
    example: () => any;
    examples: () => undefined | Record<string, any>;
    key: string;
    name: string;
    schema: OpenApi.IJsonSchema;
    title: () => undefined | string;
}

Properties

description example examples key name schema title

Properties

description

description: () => undefined | string

example

example: () => any

examples

examples: () => undefined | Record<string, any>

key

key: string

Key of the headers parameter.

name

name: string

Name of the headers parameter.

schema

schema: OpenApi.IJsonSchema

Metadata of headers data type.

title

title: () => undefined | string

Settings

Member Visibility

On This Page

Properties