OpenAPIMetadata record

Metadata for OpenAPI documentation related to the route.

public record OpenAPIMetadata : IEquatable<OpenAPICommonMetadata>

Public Members

name description
OpenAPIMetadata() Initializes a new instance of the OpenAPIMetadata class.
OpenAPIMetadata(…) Initializes a new instance of the OpenAPIMetadata class with the specified pattern.
Callbacks { get; set; } 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 { get; set; } Indicates whether the operation is deprecated in OpenAPI documentation.
ExternalDocs { get; set; } External documentation reference for the route.
OperationId { get; set; } The unique operation ID for the route in OpenAPI documentation.
RequestBody { get; set; } 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 { get; set; } REQUIRED. The list of possible responses as they are returned from executing this operation.
SecuritySchemes { get; set; } 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.
Tags { get; set; } Comma-separated tags for OpenAPI documentation.

See Also