Interface IPath

Path item containing operations by HTTP method.

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

Hierarchy

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

Index

Properties

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

Properties

`Optional`delete

delete?: SwaggerV2.IOperation

`Optional`get

get?: SwaggerV2.IOperation

`Optional`head

head?: SwaggerV2.IOperation

`Optional`options

options?: SwaggerV2.IOperation

`Optional`parameters

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

Path-level parameters.

`Optional`patch

patch?: SwaggerV2.IOperation

`Optional`post

post?: SwaggerV2.IOperation

`Optional`put

put?: SwaggerV2.IOperation

`Optional`trace

trace?: SwaggerV2.IOperation

`Optional`x-additionalOperations

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

Non-standard HTTP method operations (extension).

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