Interface IParameter

Metadata of path parameter.

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

Index

Properties

key name parameter schema

Properties

key

key: string

Key of the path parameter.

name

name: string

Name of the path parameter.

parameter

parameter: () => OpenApi.IOperation.IParameter

Original parameter info from the OpenAPI document.

The parameter is a function returning the original OpenApi.IOperation.IParameter from the OpenAPI document.

schema

schema: OpenApi.IJsonSchema

Metadata of path parameter data type.