Interface: IOpenApiPathMethod
An OpenAPI Operation Object.
See
https://spec.openapis.org/oas/latest.html#operation-object
Properties
tags?
optionaltags?:string[]
Tags for the operation.
See
https://spec.openapis.org/oas/latest.html#fixed-fields-7
summary?
optionalsummary?:string
A short summary of the operation.
See
https://spec.openapis.org/oas/latest.html#fixed-fields-7
description?
optionaldescription?:string
A verbose description of the operation.
See
https://spec.openapis.org/oas/latest.html#fixed-fields-7
externalDocs?
optionalexternalDocs?:IOpenApiExternalDocumentation
Additional external documentation for the operation.
See
https://spec.openapis.org/oas/latest.html#fixed-fields-7
operationId?
optionaloperationId?:string
A unique identifier for the operation.
See
https://spec.openapis.org/oas/latest.html#fixed-fields-7
parameters?
optionalparameters?: (IOpenApiReference|IOpenApiParameter)[]
Parameters for the operation.
See
https://spec.openapis.org/oas/latest.html#fixed-fields-7
requestBody?
optionalrequestBody?:IOpenApiReference|IOpenApiRequestBody
The request body for the operation.
See
https://spec.openapis.org/oas/latest.html#fixed-fields-7
responses
responses:
IOpenApiResponses
The responses for the operation.
See
https://spec.openapis.org/oas/latest.html#fixed-fields-7
callbacks?
optionalcallbacks?:object
Callbacks related to the operation.
Index Signature
[id: string]: unknown
See
https://spec.openapis.org/oas/latest.html#fixed-fields-7
deprecated?
optionaldeprecated?:boolean
Whether the operation is deprecated.
See
https://spec.openapis.org/oas/latest.html#fixed-fields-7
security?
optionalsecurity?:IOpenApiSecurityRequirement[]
Security requirements for the operation.
See
https://spec.openapis.org/oas/latest.html#fixed-fields-7
servers?
optionalservers?:IOpenApiServer[]
Alternative servers for the operation.