Interface HeaderParameter

interface HeaderParameter {
    $ref?: string;
    default?: unknown;
    deprecated?: boolean;
    description?: string;
    enum?: (null | string | number | boolean)[];
    example?: unknown;
    examples?: {
        [name: string]: Swagger.Example3 | string;
    };
    exclusiveMaximum?: number;
    exclusiveMinimum?: number;
    format?: Swagger.DataFormat;
    in: "header";
    items?: Swagger.BaseSchema;
    maxItems?: number;
    maxLength?: number;
    maxProperties?: number;
    maximum?: number;
    minItems?: number;
    minLength?: number;
    minProperties?: number;
    minimum?: number;
    multipleOf?: number;
    name: string;
    pattern?: string;
    required?: boolean;
    schema: Swagger.Schema;
    title?: string;
    type: Swagger.DataType;
    uniqueItems?: boolean;
    x-enum-varnames?: string[];
}

Hierarchy (view full)

Properties

$ref? default? deprecated? description? enum? example? examples? exclusiveMaximum? exclusiveMinimum? format? in items? maxItems? maxLength? maxProperties? maximum? minItems? minLength? minProperties? minimum? multipleOf? name pattern? required? schema title? type uniqueItems? x-enum-varnames?

Properties

Optional $ref

$ref?: string

Optional default

default?: unknown

Optional deprecated

deprecated?: boolean

Optional description

description?: string

Optional enum

enum?: (null | string | number | boolean)[]

Optional example

example?: unknown

Optional examples

examples?: {
    [name: string]: Swagger.Example3 | string;
}

Type declaration

Optional exclusiveMaximum

exclusiveMaximum?: number

Optional exclusiveMinimum

exclusiveMinimum?: number

Optional format

format?: Swagger.DataFormat

in

in: "header"

Optional items

items?: Swagger.BaseSchema

Optional maxItems

maxItems?: number

Optional maxLength

maxLength?: number

Optional maxProperties

maxProperties?: number

Optional maximum

maximum?: number

Optional minItems

minItems?: number

Optional minLength

minLength?: number

Optional minProperties

minProperties?: number

Optional minimum

minimum?: number

Optional multipleOf

multipleOf?: number

name

name: string

Optional pattern

pattern?: string

Optional required

required?: boolean

schema

schema: Swagger.Schema

Optional title

title?: string

type

type: Swagger.DataType

Optional uniqueItems

uniqueItems?: boolean

Optional x-enum-varnames

x-enum-varnames?: string[]

Settings

Member Visibility

Theme

On This Page

$refdefaultdeprecateddescriptionenumexampleexamplesexclusiveMaximumexclusiveMinimumformatinitemsmaxItemsmaxLengthmaxPropertiesmaximumminItemsminLengthminPropertiesminimummultipleOfnamepatternrequiredschematitletypeuniqueItemsx-enum-varnames

Generated using TypeDoc