BaseOpenApiReferenceHolder<T,U,V> Class

Definition

Namespace:: Microsoft.OpenApi

Assembly:: Microsoft.OpenApi.dll

Package:: Microsoft.OpenApi v3.1.1

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

Base class for OpenApiReferenceHolder.

public abstract class BaseOpenApiReferenceHolder<T,U,V> : Microsoft.OpenApi.IOpenApiReferenceHolder<T,U,V>, Microsoft.OpenApi.IOpenApiReferenceHolder<V> where T : class, IOpenApiReferenceable, U where U : IOpenApiReferenceable, IOpenApiSerializable where V : BaseOpenApiReference, new()

type BaseOpenApiReferenceHolder<'T, 'U, 'V (requires 'T : null and 'T :> IOpenApiReferenceable and 'T :> 'U and 'U :> IOpenApiReferenceable and 'U :> IOpenApiSerializable and 'V :> BaseOpenApiReference and 'V : (new : unit -> 'V))> = class
    interface IOpenApiReferenceHolder<'T, 'U, 'V (requires 'T : null and 'T :> IOpenApiReferenceable and 'T :> 'U and 'U :> IOpenApiReferenceable and 'U :> IOpenApiSerializable and 'V :> BaseOpenApiReference and 'V : (new : unit -> 'V))>
    interface IOpenApiReferenceHolder<'V (requires 'V :> BaseOpenApiReference and 'V : (new : unit -> 'V))>
    interface IOpenApiReferenceHolder
    interface IOpenApiSerializable
    interface IOpenApiElement

Public MustInherit Class BaseOpenApiReferenceHolder(Of T, U, V)
Implements IOpenApiReferenceHolder(Of T, U, V), IOpenApiReferenceHolder(Of V)

Type Parameters

T

The concrete class implementation type for the model.

U

The interface type for the model.

V

The type for the reference holding the additional fields and annotations

Inheritance: Object
BaseOpenApiReferenceHolder<T,U,V>

Derived: Microsoft.OpenApi.OpenApiCallbackReference

Microsoft.OpenApi.OpenApiExampleReference

Microsoft.OpenApi.OpenApiHeaderReference

Microsoft.OpenApi.OpenApiLinkReference

Microsoft.OpenApi.OpenApiMediaTypeReference

More…

Implements: IOpenApiElement IOpenApiReferenceHolder IOpenApiReferenceHolder<T,U,V> IOpenApiReferenceHolder<V> IOpenApiSerializable

Constructors

Name	Description
BaseOpenApiReferenceHolder<T,U,V>(BaseOpenApiReferenceHolder<T,U,V>)	Copy constructor
BaseOpenApiReferenceHolder<T,U,V>(String, OpenApiDocument, ReferenceType, String)	Constructor initializing the reference object.

Properties

Name	Description
RecursiveTarget	Gets the recursively resolved target object.
Reference	Reference object.
Target	Gets the resolved target object.
UnresolvedReference	Indicates if object is populated with data or is just a reference to the data

Methods

Name	Description
CopyReference(V)	Copy the reference as a target element with overrides.
CopyReferenceAsTargetElementWithOverrides(U)	Copy the reference as a target element with overrides.
SerializeAsV2(IOpenApiWriter)	Serialize Open API element to v2.0.
SerializeAsV3(IOpenApiWriter)	Serialize Open API element to v3.0.
SerializeAsV31(IOpenApiWriter)	Serialize OpenAPI element into v3.1
SerializeAsV32(IOpenApiWriter)	Serialize OpenAPI element into v3.2

Extension Methods

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

Applies to

Share via