OpenApiTagReference Class

Definition

Namespace:: Microsoft.OpenApi

Assembly:: Microsoft.OpenApi.dll

Package:: Microsoft.OpenApi v3.1.1

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

Tag Object Reference

public class OpenApiTagReference : Microsoft.OpenApi.BaseOpenApiReferenceHolder<Microsoft.OpenApi.OpenApiTag,Microsoft.OpenApi.IOpenApiTag,Microsoft.OpenApi.BaseOpenApiReference>, Microsoft.OpenApi.IOpenApiTag, Microsoft.OpenApi.IShallowCopyable<Microsoft.OpenApi.IOpenApiTag>

type OpenApiTagReference = class
    inherit BaseOpenApiReferenceHolder<OpenApiTag, IOpenApiTag, BaseOpenApiReference>
    interface IOpenApiTag
    interface IOpenApiReadOnlyExtensible
    interface IOpenApiReadOnlyDescribedElement
    interface IOpenApiElement
    interface IShallowCopyable<IOpenApiTag>
    interface IOpenApiReferenceable
    interface IOpenApiSerializable

Public Class OpenApiTagReference
Inherits BaseOpenApiReferenceHolder(Of OpenApiTag, IOpenApiTag, BaseOpenApiReference)
Implements IOpenApiTag, IShallowCopyable(Of IOpenApiTag)

Inheritance: Object

BaseOpenApiReferenceHolder<OpenApiTag,IOpenApiTag,BaseOpenApiReference>
OpenApiTagReference

Implements: IOpenApiElement IOpenApiReadOnlyDescribedElement IOpenApiReadOnlyExtensible IOpenApiReferenceable IOpenApiSerializable IOpenApiTag IShallowCopyable<IOpenApiTag>

Constructors

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

Properties

Name	Description
Description	Long description for the example. CommonMark syntax MAY be used for rich text representation.
Extensions	Specification extensions.
ExternalDocs	Additional external documentation for this tag.
Kind	A machine-readable string to categorize what sort of tag it is.
Name	The name of the tag.
Parent	The tag that this tag is nested under.
RecursiveTarget	Gets the recursively resolved target object. (Inherited from BaseOpenApiReferenceHolder<T,U,V>)
Reference	Reference object. (Inherited from BaseOpenApiReferenceHolder<T,U,V>)
Summary	A short summary of the tag, used for display purposes.
Target	Resolved target of the reference.
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(IOpenApiTag)	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