OpenApiCallbackReference Class

Definition

Namespace:: Microsoft.OpenApi

Assembly:: Microsoft.OpenApi.dll

Package:: Microsoft.OpenApi v3.1.1

Source:: OpenApiCallbackReference.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.

Callback Object Reference: A reference to a map of possible out-of band callbacks related to the parent operation.

public class OpenApiCallbackReference : Microsoft.OpenApi.BaseOpenApiReferenceHolder<Microsoft.OpenApi.OpenApiCallback,Microsoft.OpenApi.IOpenApiCallback,Microsoft.OpenApi.BaseOpenApiReference>, Microsoft.OpenApi.IOpenApiCallback, Microsoft.OpenApi.IShallowCopyable<Microsoft.OpenApi.IOpenApiCallback>

type OpenApiCallbackReference = class
    inherit BaseOpenApiReferenceHolder<OpenApiCallback, IOpenApiCallback, BaseOpenApiReference>
    interface IOpenApiCallback
    interface IOpenApiReadOnlyExtensible
    interface IShallowCopyable<IOpenApiCallback>
    interface IOpenApiReferenceable
    interface IOpenApiSerializable
    interface IOpenApiElement

Public Class OpenApiCallbackReference
Inherits BaseOpenApiReferenceHolder(Of OpenApiCallback, IOpenApiCallback, BaseOpenApiReference)
Implements IOpenApiCallback, IShallowCopyable(Of IOpenApiCallback)

Inheritance: Object

BaseOpenApiReferenceHolder<OpenApiCallback,IOpenApiCallback,BaseOpenApiReference>
OpenApiCallbackReference

Implements: IOpenApiCallback IOpenApiElement IOpenApiReadOnlyExtensible IOpenApiReferenceable IOpenApiSerializable IShallowCopyable<IOpenApiCallback>

Constructors

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

Properties

Name	Description
Extensions	Specification extensions.
PathItems	A Path Item Object used to define a callback request and expected responses.
RecursiveTarget	Gets the recursively resolved target object. (Inherited from BaseOpenApiReferenceHolder<T,U,V>)
Reference	Reference object. (Inherited from BaseOpenApiReferenceHolder<T,U,V>)
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(BaseOpenApiReference)	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(IOpenApiCallback)	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.
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