OpenApiTag Class

Definition

Namespace:: Microsoft.OpenApi

Assembly:: Microsoft.OpenApi.dll

Package:: Microsoft.OpenApi v3.1.1

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

public class OpenApiTag : Microsoft.OpenApi.IOpenApiDescribedElement, Microsoft.OpenApi.IOpenApiExtensible, Microsoft.OpenApi.IOpenApiTag, Microsoft.OpenApi.IShallowCopyable<Microsoft.OpenApi.IOpenApiTag>

type OpenApiTag = class
    interface IOpenApiExtensible
    interface IOpenApiElement
    interface IOpenApiTag
    interface IOpenApiReadOnlyExtensible
    interface IOpenApiReadOnlyDescribedElement
    interface IShallowCopyable<IOpenApiTag>
    interface IOpenApiReferenceable
    interface IOpenApiSerializable
    interface IOpenApiDescribedElement

Public Class OpenApiTag
Implements IOpenApiDescribedElement, IOpenApiExtensible, IOpenApiTag, IShallowCopyable(Of IOpenApiTag)

Inheritance: Object
OpenApiTag

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

Constructors

Name	Description
OpenApiTag()	Parameterless constructor

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.
Summary	A short summary of the tag, used for display purposes.

Methods

Name	Description
CreateShallowCopy()	Create a shallow copy of the current instance.
SerializeAsV2(IOpenApiWriter)	Serialize OpenApiTag to Open Api v2.0
SerializeAsV3(IOpenApiWriter)	Serialize OpenApiTag to Open Api v3.0
SerializeAsV31(IOpenApiWriter)	Serialize OpenApiTag to Open Api v3.1
SerializeAsV32(IOpenApiWriter)	Serialize OpenApiTag to Open Api v3.2

Extension Methods

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

Applies to

Share via