Interface: IOperation
protoc_gen_openapiv2.options.IOperation
Properties of an Operation.
Hierarchy
-
↳
IOperation
Properties
consumes
• Optional consumes: null | string[]
A list of MIME types the operation can consume. This overrides the consumes definition at the OpenAPI Object. An empty value MAY be used to clear the global definition. Value MUST be as described under Mime Types.
Inherited from
deprecated
• Optional deprecated: null | boolean
Declares this operation to be deprecated. Usage of the declared operation should be refrained. Default value is false.
Inherited from
description
• Optional description: null | string
A verbose explanation of the operation behavior. GFM syntax can be used for rich text representation.
Inherited from
extensions
• Optional extensions: null | { [k: string]: $Properties; }
Custom properties that start with "x-" such as "x-foo" used to describe extra functionality that is not covered by the standard OpenAPI Specification. See: https://swagger.io/docs/specification/2-0/swagger-extensions/
Inherited from
externalDocs
• Optional externalDocs: null | $Properties
Additional external documentation for this operation.
Inherited from
operationId
• Optional operationId: null | string
Unique string used to identify the operation. The id MUST be unique among all operations described in the API. Tools and libraries MAY use the operationId to uniquely identify an operation, therefore, it is recommended to follow common programming naming conventions.
Inherited from
parameters
• Optional parameters: null | $Properties
Custom parameters such as HTTP request headers. See: https://swagger.io/docs/specification/2-0/describing-parameters/ and https://swagger.io/specification/v2/#parameter-object.
Inherited from
produces
• Optional produces: null | string[]
A list of MIME types the operation can produce. This overrides the produces definition at the OpenAPI Object. An empty value MAY be used to clear the global definition. Value MUST be as described under Mime Types.
Inherited from
responses
• Optional responses: null | { [k: string]: $Properties; }
The list of possible responses as they are returned from executing this operation.
Inherited from
schemes
• Optional schemes: null | Scheme[]
The transfer protocol for the operation. Values MUST be from the list: "http", "https", "ws", "wss". The value overrides the OpenAPI Object schemes definition.
Inherited from
security
• Optional security: null | $Properties[]
A declaration of which security schemes are applied for this operation. The list of values describes alternative security schemes that can be used (that is, there is a logical OR between the security requirements). This definition overrides any declared top-level security. To remove a top-level security declaration, an empty array can be used.
Inherited from
summary
• Optional summary: null | string
A short summary of what the operation does. For maximum readability in the swagger-ui, this field SHOULD be less than 120 characters.
Inherited from
tags
• Optional tags: null | string[]
A list of tags for API documentation control. Tags can be used for logical grouping of operations by resources or any other qualifier.