Interface IBodyParameter

Body parameter.

interface IBodyParameter {
    description?: string;
    in: string;
    name: string;
    required?: boolean;
    schema: SwaggerV2.IJsonSchema;
}

Index

Properties

description? in name required? schema

Properties

`Optional`description

description?: string

Parameter description.

in

in: string

Parameter location (always "body").

name

name: string

Parameter name.

`Optional`required

required?: boolean

Whether required.

schema

schema: SwaggerV2.IJsonSchema

Body schema.