Interface OperationSchemas

interface OperationSchemas {
    body?: SchemaObject;
    cookie?: ParameterSchema;
    header?: ParameterSchema;
    path?: ParameterSchema;
    query?: ParameterSchema;
    response?: SchemaObject;
}

Properties

body? cookie? header? path? query? response?

Properties

Optional body

body?: SchemaObject

Schema for the request body.

Optional cookie

cookie?: ParameterSchema

Schema for the cookie parameters in JSON object. Key as the name of the parameter and value is the schema.

Optional header

header?: ParameterSchema

Schema for the header parameters in JSON object. Key as the name of the parameter and value is the schema.

Optional path

path?: ParameterSchema

Schema for the path parameters in JSON object. Key as the name of the parameter and value is the schema.

Optional query

query?: ParameterSchema

Schema for the query parameters in JSON object. Key as the name of the parameter and value is the schema.

Optional response

response?: SchemaObject

Schema for the response.

Settings

Member Visibility

Theme

On This Page

bodycookieheaderpathqueryresponse