OpenApiResponseReference Class

Definition

Namespace:: Microsoft.OpenApi

Assembly:: Microsoft.OpenApi.dll

Package:: Microsoft.OpenApi v3.1.1

Source:: OpenApiResponseReference.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Response Object Reference.

public class OpenApiResponseReference : Microsoft.OpenApi.BaseOpenApiReferenceHolder<Microsoft.OpenApi.OpenApiResponse,Microsoft.OpenApi.IOpenApiResponse,Microsoft.OpenApi.OpenApiReferenceWithDescriptionAndSummary>, Microsoft.OpenApi.IOpenApiResponse, Microsoft.OpenApi.IShallowCopyable<Microsoft.OpenApi.IOpenApiResponse>

type OpenApiResponseReference = class
    inherit BaseOpenApiReferenceHolder<OpenApiResponse, IOpenApiResponse, OpenApiReferenceWithDescriptionAndSummary>
    interface IOpenApiResponse
    interface IOpenApiDescribedElement
    interface IOpenApiElement
    interface IOpenApiReadOnlyExtensible
    interface IShallowCopyable<IOpenApiResponse>
    interface IOpenApiReferenceable
    interface IOpenApiSerializable
    interface IOpenApiSummarizedElement

Public Class OpenApiResponseReference
Inherits BaseOpenApiReferenceHolder(Of OpenApiResponse, IOpenApiResponse, OpenApiReferenceWithDescriptionAndSummary)
Implements IOpenApiResponse, IShallowCopyable(Of IOpenApiResponse)

Inheritance: Object

BaseOpenApiReferenceHolder<OpenApiResponse,IOpenApiResponse,OpenApiReferenceWithDescriptionAndSummary>
OpenApiResponseReference

Implements: IOpenApiDescribedElement IOpenApiElement IOpenApiReadOnlyExtensible IOpenApiReferenceable IOpenApiResponse IOpenApiSerializable IOpenApiSummarizedElement IShallowCopyable<IOpenApiResponse>

Constructors

Name	Description
OpenApiResponseReference(String, OpenApiDocument, String)	Constructor initializing the reference object.

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.
RecursiveTarget	Gets the recursively resolved target object. (Inherited from BaseOpenApiReferenceHolder<T,U,V>)
Reference	Reference object. (Inherited from BaseOpenApiReferenceHolder<T,U,V>)
Summary	Short description for the example.
Target	Gets the resolved target object. (Inherited from BaseOpenApiReferenceHolder<T,U,V>)
UnresolvedReference	Indicates if object is populated with data or is just a reference to the data (Inherited from BaseOpenApiReferenceHolder<T,U,V>)

Methods

Name	Description
CopyReference(OpenApiReferenceWithDescriptionAndSummary)	Copy the reference as a target element with overrides.
CopyReference(V)	Copy the reference as a target element with overrides. (Inherited from BaseOpenApiReferenceHolder<T,U,V>)
CopyReferenceAsTargetElementWithOverrides(IOpenApiResponse)	Copy the reference as a target element with overrides.
CopyReferenceAsTargetElementWithOverrides(U)	Copy the reference as a target element with overrides. (Inherited from BaseOpenApiReferenceHolder<T,U,V>)
CreateShallowCopy()	Create a shallow copy of the current instance.
SerializeAsV2(IOpenApiWriter)	Serialize Open API element to v2.0. (Inherited from BaseOpenApiReferenceHolder<T,U,V>)
SerializeAsV3(IOpenApiWriter)	Serialize Open API element to v3.0. (Inherited from BaseOpenApiReferenceHolder<T,U,V>)
SerializeAsV31(IOpenApiWriter)	Serialize OpenAPI element into v3.1 (Inherited from BaseOpenApiReferenceHolder<T,U,V>)
SerializeAsV32(IOpenApiWriter)	Serialize OpenAPI element into v3.2 (Inherited from BaseOpenApiReferenceHolder<T,U,V>)

Extension Methods

Name	Description
Validate(IOpenApiElement, ValidationRuleSet)	Validate element and all child elements

Applies to

Share via