OpenApiOperation Class

Definition

Namespace:

Microsoft.OpenApi.Models

Assembly:

Microsoft.OpenApi.dll

Package:

Microsoft.OpenApi v1.6.0

Operation Object.

public class OpenApiOperation : Microsoft.OpenApi.Interfaces.IOpenApiExtensible, Microsoft.OpenApi.Interfaces.IOpenApiSerializable

type OpenApiOperation = class
    interface IOpenApiSerializable
    interface IOpenApiElement
    interface IOpenApiExtensible

Public Class OpenApiOperation
Implements IOpenApiExtensible, IOpenApiSerializable

Inheritance

Object

OpenApiOperation

Implements

IOpenApiElement IOpenApiExtensible IOpenApiSerializable

Constructors

OpenApiOperation()	Parameterless constructor
OpenApiOperation(OpenApiOperation)	Initializes a copy of an OpenApiOperation object

Fields

DeprecatedDefault

Default value for Deprecated.

Properties

Callbacks	A 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. The key value used to identify the callback object is an expression, evaluated at runtime, that identifies a URL to use for the callback operation.
Deprecated	Declares this operation to be deprecated. Consumers SHOULD refrain from usage of the declared operation.
Description	A verbose explanation of the operation behavior. CommonMark syntax MAY be used for rich text representation.
Extensions	This object MAY be extended with Specification Extensions.
ExternalDocs	Additional external documentation for this operation.
OperationId	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.
Parameters	A list of parameters that are applicable for this operation. If a parameter is already defined at the Path Item, the new definition will override it but can never remove it. The list MUST NOT include duplicated parameters. A unique parameter is defined by a combination of a name and location. The list can use the Reference Object to link to parameters that are defined at the OpenAPI Object's components/parameters.
RequestBody	The request body applicable for this operation. The requestBody is only supported in HTTP methods where the HTTP 1.1 specification RFC7231 has explicitly defined semantics for request bodies. In other cases where the HTTP spec is vague, requestBody SHALL be ignored by consumers.
Responses	REQUIRED. The list of possible responses as they are returned from executing this operation.
Security	A 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. This definition overrides any declared top-level security. To remove a top-level security declaration, an empty array can be used.
Servers	An 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.
Summary	A short summary of what the operation does.
Tags	A list of tags for API documentation control. Tags can be used for logical grouping of operations by resources or any other qualifier.

Methods

SerializeAsV2(IOpenApiWriter)	Serialize OpenApiOperation to Open Api v2.0.
SerializeAsV3(IOpenApiWriter)	Serialize OpenApiOperation to Open Api v3.0.

Extension Methods

Validate(IOpenApiElement, ValidationRuleSet)

Validate element and all child elements