IOpenApiTag Interface

Definition

Namespace:: Microsoft.OpenApi

Assembly:: Microsoft.OpenApi.dll

Package:: Microsoft.OpenApi v3.1.1

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

Defines the base properties for the path item object. This interface is provided for type assertions but should not be implemented by package consumers beyond automatic mocking.

public interface IOpenApiTag : Microsoft.OpenApi.IOpenApiReadOnlyDescribedElement, Microsoft.OpenApi.IOpenApiReadOnlyExtensible, Microsoft.OpenApi.IOpenApiReferenceable, Microsoft.OpenApi.IShallowCopyable<Microsoft.OpenApi.IOpenApiTag>

type IOpenApiTag = interface
    interface IOpenApiReadOnlyExtensible
    interface IOpenApiReadOnlyDescribedElement
    interface IOpenApiElement
    interface IShallowCopyable<IOpenApiTag>
    interface IOpenApiReferenceable
    interface IOpenApiSerializable

Public Interface IOpenApiTag
Implements IOpenApiReadOnlyDescribedElement, IOpenApiReadOnlyExtensible, IOpenApiReferenceable, IShallowCopyable(Of IOpenApiTag)

Derived: Microsoft.OpenApi.OpenApiTag

Microsoft.OpenApi.OpenApiTagReference

Implements: IOpenApiElement IOpenApiReadOnlyDescribedElement IOpenApiReadOnlyExtensible IOpenApiReferenceable IOpenApiSerializable IShallowCopyable<IOpenApiTag>

Properties

Name	Description
Description	Long description for the example. CommonMark syntax MAY be used for rich text representation. (Inherited from IOpenApiReadOnlyDescribedElement)
Extensions	Specification extensions. (Inherited from IOpenApiReadOnlyExtensible)
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.
Summary	A short summary of the tag, used for display purposes.

Methods

Name	Description
CreateShallowCopy()	Create a shallow copy of the current instance. (Inherited from IShallowCopyable<T>)
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