Interface ParameterObject

interface ParameterObject {
    allowEmptyValue?: boolean;
    allowReserved?: boolean;
    content?: {
        [media: string]: MediaTypeObject;
    };
    deprecated?: boolean;
    description?: string;
    example?: any;
    examples?: {
        [media: string]: ReferenceObject | ExampleObject;
    };
    explode?: boolean;
    in: string;
    name: string;
    required?: boolean;
    schema?: ReferenceObject | SchemaObject;
    style?: string;
}

Hierarchy

ParameterBaseObject
- ParameterObject

Index

Properties

allowEmptyValue? allowReserved? content? deprecated? description? example? examples? explode? in name required? schema? style?

Properties

`Optional` allowEmptyValue

allowEmptyValue?: boolean

`Optional` allowReserved

allowReserved?: boolean

`Optional` content

content?: {
[media: string]: MediaTypeObject;
}

Type declaration

[media: string]: MediaTypeObject

`Optional` deprecated

deprecated?: boolean

`Optional` description

description?: string

`Optional` example

example?: any

`Optional` examples

examples?: {
[media: string]: ReferenceObject | ExampleObject;
}

Type declaration

[media: string]: ReferenceObject | ExampleObject

`Optional` explode

explode?: boolean

in

in: string

name

name: string

`Optional` required

required?: boolean

`Optional` schema

schema?: ReferenceObject | SchemaObject

`Optional` style

style?: string

Generated using TypeDoc