Interface IOperation

API operation metadata.

interface IOperation {
    deprecated?: boolean;
    description?: string;
    operationId?: string;
    parameters?: (
        | OpenApiV3.IOperation.IParameter
        | OpenApiV3.IJsonSchema.IReference<`#/components/headers/${string}`>
        | OpenApiV3.IJsonSchema.IReference<`#/components/parameters/${string}`>
    )[];
    requestBody?:
        | OpenApiV3.IOperation.IRequestBody
        | OpenApiV3.IJsonSchema.IReference<`#/components/requestBodies/${string}`>;
    responses?: Record<
        string,
        | OpenApiV3.IOperation.IResponse
        | OpenApiV3.IJsonSchema.IReference<`#/components/responses/${string}`>,
    >;
    security?: Record<string, string[]>[];
    servers?: OpenApiV3.IServer[];
    summary?: string;
    tags?: string[];
}

Index

Properties

deprecated? description? operationId? parameters? requestBody? responses? security? servers? summary? tags?

Properties

`Optional`deprecated

deprecated?: boolean

Whether deprecated.

`Optional`description

description?: string

Full description.

`Optional`operationId

operationId?: string

Unique operation identifier.

`Optional`parameters

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

Operation parameters.

`Optional`requestBody

requestBody?:
| OpenApiV3.IOperation.IRequestBody
| OpenApiV3.IJsonSchema.IReference<`#/components/requestBodies/${string}`>

Request body.

`Optional`responses

responses?: Record<
    string,
    | OpenApiV3.IOperation.IResponse
    | OpenApiV3.IJsonSchema.IReference<`#/components/responses/${string}`>,
>

Response definitions by status code.

`Optional`security

security?: Record<string, string[]>[]

Security requirements.

`Optional`servers

servers?: OpenApiV3.IServer[]

Operation-level servers.

`Optional`summary

summary?: string

Short summary.

`Optional`tags

tags?: string[]

Operation tags.