Interface ParameterObject

interface ParameterObject {
    allowEmptyValue?: boolean;
    allowReserved?: boolean;
    content?: Record<string, MediaTypeObject>;
    deprecated?: boolean;
    description?: string;
    example?: unknown;
    examples?: Record<string, ReferenceObject | ExampleObject>;
    explode?: boolean;
    in: string;
    name: string;
    required?: boolean;
    schema?: SchemaObject | ReferenceObject;
    style?: string;
}

Hierarchy (view full)

HeaderObject
- 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?: Record<string, MediaTypeObject>

`Optional` deprecated

deprecated?: boolean

`Optional` description

description?: string

`Optional` example

example?: unknown

`Optional` examples

examples?: Record<string, ReferenceObject | ExampleObject>

`Optional` explode

explode?: boolean

in

in: string

name

name: string

`Optional` required

required?: boolean

`Optional` schema

schema?: SchemaObject | ReferenceObject

`Optional` style

style?: string