Optional callbacksA map of possible out-of band callbacks related to the parent operation. The key is a unique identifier for the Callback Object. Each value in the map is a Callback Object that describes a request that may be initiated by the API provider and the expected responses.
Optional deprecatedDeclares this operation to be deprecated. Consumers SHOULD refrain from
usage of the declared operation. Default value is false.
Optional descriptionA verbose explanation of the operation behavior. CommonMark syntax MAY be used for rich text representation.
Optional externalAdditional external documentation for this operation.
Optional operationUnique string used to identify the operation. The id MUST be unique among all operations described in the API. The operationId value is case-sensitive. Tools and libraries MAY use the operationId to uniquely identify an operation, therefore, it is RECOMMENDED to follow common programming naming conventions.
Optional securityA declaration of which security mechanisms can be used for this operation.
The list of values includes alternative security requirement objects that
can be used. Only one of the security requirement objects need to be
satisfied to authorize a request. To make security optional, an empty
security requirement ({}) can be included in the array. This definition
overrides any declared top-level
security. To
remove a top-level security declaration, an empty array can be used.
Optional serversAn alternative server array to service this operation. If an alternative
server object is specified at the Path Item Object or Root level, it will
be overridden by this value.
Optional summaryA short summary of what the operation does.
Optional tagsA list of tags for API documentation control. Tags can be used for logical grouping of operations by resources or any other qualifier.
Options or overwrites to the result OperationObject when transforming.