Skip to main content

Interface: IOperation

Properties of an Operation.

Extends​

Properties​

consumes?​

optional consumes?: string[] | null

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​

$Properties.consumes

deprecated?​

optional deprecated?: boolean | null

Declares this operation to be deprecated. Usage of the declared operation should be refrained. Default value is false.

Inherited from​

$Properties.deprecated

description?​

optional description?: string | null

A verbose explanation of the operation behavior. GFM syntax can be used for rich text representation.

Inherited from​

$Properties.description

extensions?​

optional extensions?: {[k: string]: $Properties; } | null

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​

$Properties.extensions

externalDocs?​

optional externalDocs?: $Properties | null

Additional external documentation for this operation.

Inherited from​

$Properties.externalDocs

operationId?​

optional operationId?: string | null

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​

$Properties.operationId

parameters?​

optional parameters?: $Properties | null

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​

$Properties.parameters

produces?​

optional produces?: string[] | null

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​

$Properties.produces

responses?​

optional responses?: {[k: string]: $Properties; } | null

The list of possible responses as they are returned from executing this operation.

Inherited from​

$Properties.responses

schemes?​

optional schemes?: Scheme[] | null

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​

$Properties.schemes

security?​

optional security?: $Properties[] | null

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​

$Properties.security

summary?​

optional summary?: string | null

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​

$Properties.summary

tags?​

optional tags?: string[] | null

A list of tags for API documentation control. Tags can be used for logical grouping of operations by resources or any other qualifier.

Inherited from​

$Properties.tags