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?: string
default?: unknown
deprecated?: boolean
description?: string
enum?: (null | string | number | boolean)[]
example?: unknown
examples?: {
    [name: string]: Swagger.Example3 | string;
}

Type declaration

exclusiveMaximum?: number
exclusiveMinimum?: number
in: "header"
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
uniqueItems?: boolean
x-enum-varnames?: string[]

Generated using TypeDoc