IOpenApiReferenceHolder<T,U,V> Interface

Definition

Namespace:: Microsoft.OpenApi

Assembly:: Microsoft.OpenApi.dll

Package:: Microsoft.OpenApi v3.1.1

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

A generic interface for OpenApiReferenceable objects that have a target.

public interface IOpenApiReferenceHolder<out T,U,V> : Microsoft.OpenApi.IOpenApiReferenceHolder<V> where T : IOpenApiReferenceable, U where V : BaseOpenApiReference, new()

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

Public Interface IOpenApiReferenceHolder(Of Out T, U, V)
Implements IOpenApiReferenceHolder(Of V)

Type Parameters

T

The type of the target being referenced

This type parameter is covariant. That is, you can use either the type you specified or any type that is more derived. For more information about covariance and contravariance, see Covariance and Contravariance in Generics.

U

The type of the interface implemented by both the target and the reference type

V

The type for the reference holding the additional fields and annotations

Derived: Microsoft.OpenApi.BaseOpenApiReferenceHolder<T,U,V>

Implements: IOpenApiElement IOpenApiReferenceHolder IOpenApiReferenceHolder<V> IOpenApiSerializable

Properties

Name	Description
RecursiveTarget	Gets the recursively resolved target object.
Reference	Reference object. (Inherited from IOpenApiReferenceHolder<V>)
Target	Gets the resolved target object.
UnresolvedReference	Indicates if object is populated with data or is just a reference to the data (Inherited from IOpenApiReferenceHolder)

Methods

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

Extension Methods

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

Applies to

Share via