[T] OpenAPI3Operation

type OpenAPI3Operation = Extensions & object;

An operation attached to an HTTP method on a path, with its inputs, responses and security overrides.

Type Declaration

Name	Type	Description
deprecated?	boolean	Marks an operation that consumers should stop using; absence means false.
description?	string	Detailed explanation of the operation, which may use CommonMark.
operationId?	string	Identifier that must be unique among operations in the API.
parameters	Refable<OpenAPI3Parameter>[]	Operation parameters; matching name/location pairs override path-level parameters.
requestBody?	Refable<OpenAPI3RequestBody>	Payload accepted by this operation, separate from path, query, header and cookie parameters.
responses?	Refable<OpenAPI3Responses>	Possible responses, including status-specific entries and an optional default.
security?	Record<string, string[]>[]	Overrides document-level security. Entries are alternatives; schemes within an entry are all required. An empty array removes inherited requirements.
summary?	string	Short explanation suitable for operation lists.
tags?	string[]	Tag names used to group this operation; document-level tag metadata is optional.