Interface IPath

Path item containing operations by HTTP method.

interface IPath {
    delete?: OpenApiV3.IOperation;
    description?: string;
    get?: OpenApiV3.IOperation;
    head?: OpenApiV3.IOperation;
    options?: OpenApiV3.IOperation;
    parameters?: (
        | OpenApiV3.IOperation.IParameter
        | OpenApiV3.IJsonSchema.IReference<`#/components/headers/${string}`>
        | OpenApiV3.IJsonSchema.IReference<`#/components/parameters/${string}`>
    )[];
    patch?: OpenApiV3.IOperation;
    post?: OpenApiV3.IOperation;
    put?: OpenApiV3.IOperation;
    servers?: OpenApiV3.IServer[];
    summary?: string;
    trace?: OpenApiV3.IOperation;
    "x-additionalOperations"?: Record<string, OpenApiV3.IOperation>;
}

Hierarchy

Partial<Record<OpenApiV3.Method, OpenApiV3.IOperation | undefined>>
- IPath

Index

Properties

delete? description? get? head? options? parameters? patch? post? put? servers? summary? trace? x-additionalOperations?

Properties

`Optional`delete

delete?: OpenApiV3.IOperation

`Optional`description

description?: string

Path description.

`Optional`get

get?: OpenApiV3.IOperation

`Optional`head

head?: OpenApiV3.IOperation

`Optional`options

options?: OpenApiV3.IOperation

`Optional`parameters

parameters?: (
    | OpenApiV3.IOperation.IParameter
    | OpenApiV3.IJsonSchema.IReference<`#/components/headers/${string}`>
    | OpenApiV3.IJsonSchema.IReference<`#/components/parameters/${string}`>
)[]

Path-level parameters.

`Optional`patch

patch?: OpenApiV3.IOperation

`Optional`post

post?: OpenApiV3.IOperation

`Optional`put

put?: OpenApiV3.IOperation

`Optional`servers

servers?: OpenApiV3.IServer[]

Path-level servers.

`Optional`summary

summary?: string

Path summary.

`Optional`trace

trace?: OpenApiV3.IOperation

`Optional`x-additionalOperations

"x-additionalOperations"?: Record<string, OpenApiV3.IOperation>

Non-standard HTTP method operations (extension).

Used when downgrading from OpenAPI v3.2 to preserve non-standard methods like query or custom methods.