Compartir a través de

OpenApiResponse Class

Definition

Namespace:
Microsoft.OpenApi
Assembly:
Microsoft.OpenApi.dll
Package:
Microsoft.OpenApi v3.1.1
Source:
OpenApiResponse.cs

Response object.

public class OpenApiResponse : Microsoft.OpenApi.IOpenApiExtensible, Microsoft.OpenApi.IOpenApiResponse, Microsoft.OpenApi.IShallowCopyable<Microsoft.OpenApi.IOpenApiResponse>
type OpenApiResponse = class
    interface IOpenApiExtensible
    interface IOpenApiElement
    interface IOpenApiResponse
    interface IOpenApiDescribedElement
    interface IOpenApiReadOnlyExtensible
    interface IShallowCopyable<IOpenApiResponse>
    interface IOpenApiReferenceable
    interface IOpenApiSerializable
    interface IOpenApiSummarizedElement
Public Class OpenApiResponse
Implements IOpenApiExtensible, IOpenApiResponse, IShallowCopyable(Of IOpenApiResponse)
Inheritance
Object
OpenApiResponse
Implements
IOpenApiDescribedElement IOpenApiElement IOpenApiExtensible IOpenApiReadOnlyExtensible IOpenApiReferenceable IOpenApiResponse IOpenApiSerializable IOpenApiSummarizedElement IShallowCopyable<IOpenApiResponse>

Constructors

Name Description
OpenApiResponse()

Parameterless constructor

Properties

Name Description
Content

A map containing descriptions of potential response payloads. The key is a media type or media type range and the value describes it.
Description

Long description for the example. CommonMark syntax MAY be used for rich text representation.
Extensions

Specification extensions.
Headers

Maps a header name to its definition.
Links

A map of operations links that can be followed from the response. The key of the map is a short name for the link, following the naming constraints of the names for Component Objects.
Summary

Short description for the example.

Methods

Name Description
CreateShallowCopy()

Create a shallow copy of the current instance.
SerializeAsV2(IOpenApiWriter)

Serialize to OpenAPI V2 document without using reference.
SerializeAsV3(IOpenApiWriter)

Serialize OpenApiResponse to Open Api v3.0.
SerializeAsV31(IOpenApiWriter)

Serialize OpenApiResponse to Open Api v3.1
SerializeAsV32(IOpenApiWriter)

Serialize OpenApiResponse to Open Api v3.2

Extension Methods

Name Description
Validate(IOpenApiElement, ValidationRuleSet)

Validate element and all child elements

Applies to