Interface IParameter

Path parameter metadata.

interface IParameter {
    key: string;
    name: string;
    parameter: () => OpenApi.IOperation.IParameter;
    schema: OpenApi.IJsonSchema;
}

Index

Properties

key name parameter schema

Properties

key

key: string

Parameter variable key.

name

name: string

Parameter name in path template.

parameter

parameter: () => OpenApi.IOperation.IParameter

Returns source parameter definition.

schema

schema: OpenApi.IJsonSchema

Parameter type schema.