Interface IPath

Path item containing operations by HTTP method.

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

Hierarchy

Partial<Record<OpenApi.Method, OpenApi.IOperation>>
- IPath

Index

Properties

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

Properties

`Optional`additionalOperations

additionalOperations?: Record<string, OpenApi.IOperation>

Additional non-standard HTTP method operations (e.g., LINK, UNLINK, PURGE).

`Optional`delete

delete?: OpenApi.IOperation

`Optional`description

description?: string

Path description.

`Optional`get

get?: OpenApi.IOperation

`Optional`head

head?: OpenApi.IOperation

`Optional`options

options?: OpenApi.IOperation

`Optional`patch

patch?: OpenApi.IOperation

`Optional`post

post?: OpenApi.IOperation

`Optional`put

put?: OpenApi.IOperation

`Optional`query

query?: OpenApi.IOperation

`Optional`servers

servers?: OpenApi.IServer[]

Path-level servers.

`Optional`summary

summary?: string

Path summary.

`Optional`trace

trace?: OpenApi.IOperation