Interface IPath

Path item.

OpenApi.IPath represents a path item of emended OpenAPI v3.1, collecting multiple method operations under a single path.

interface IPath {
    delete?: OpenApi.IOperation;
    description?: string;
    get?: OpenApi.IOperation;
    head?: OpenApi.IOperation;
    options?: OpenApi.IOperation;
    patch?: OpenApi.IOperation;
    post?: OpenApi.IOperation;
    put?: OpenApi.IOperation;
    servers?: OpenApi.IServer[];
    summary?: string;
    trace?: OpenApi.IOperation;
}

Hierarchy

Properties

delete? description? get? head? options? patch? post? put? servers? summary? trace?

Properties

Optionaldelete

delete?: OpenApi.IOperation

Optionaldescription

description?: string

Description of the path.

Optionalget

get?: OpenApi.IOperation

Optionalhead

head?: OpenApi.IOperation

Optionaloptions

options?: OpenApi.IOperation

Optionalpatch

patch?: OpenApi.IOperation

Optionalpost

post?: OpenApi.IOperation

Optionalput

put?: OpenApi.IOperation

Optionalservers

servers?: OpenApi.IServer[]

Servers that provide the path operations.

Optionalsummary

summary?: string

Summary of the path.

Optionaltrace

trace?: OpenApi.IOperation

Settings

Member Visibility

On This Page

Properties