Interface OpenApiOperation

An operation of an OpenApiDocument, i.e. one method on one path.

interface OpenApiOperation {
    description?: string;
    operationId?: string;
    parameters?: OpenApiParameter[];
    requestBody?: { content: OpenApiContent; required: true };
    responses: Record<string, OpenApiResponse>;
    security?: { [scheme: string]: string[] }[];
    summary?: string;
    tags?: string[];
}

Index

Properties

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

Properties

`Optional`description

description?: string

`Optional`operationId

operationId?: string

`Optional`parameters

parameters?: OpenApiParameter[]

`Optional`requestBody

requestBody?: { content: OpenApiContent; required: true }

responses

responses: Record<string, OpenApiResponse>

`Optional`security

security?: { [scheme: string]: string[] }[]

`Optional`summary

summary?: string

`Optional`tags

tags?: string[]