OpenApiTag Class

Reference

Definition

Namespace:: Microsoft.OpenApi.Models

Assembly:: Microsoft.OpenApi.dll

Package:: Microsoft.OpenApi v1.6.0

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.Interfaces.IOpenApiExtensible, Microsoft.OpenApi.Interfaces.IOpenApiReferenceable

type OpenApiTag = class
    interface IOpenApiSerializable
    interface IOpenApiElement
    interface IOpenApiReferenceable
    interface IOpenApiExtensible

Public Class OpenApiTag
Implements IOpenApiExtensible, IOpenApiReferenceable

Inheritance: Object
OpenApiTag

Implements: IOpenApiElement IOpenApiExtensible IOpenApiReferenceable IOpenApiSerializable

Constructors

OpenApiTag()	Parameterless constructor
OpenApiTag(OpenApiTag)	Initializes a copy of an OpenApiTag object

Properties

Description	A short description for the tag.
Extensions	This object MAY be extended with Specification Extensions.
ExternalDocs	Additional external documentation for this tag.
Name	The name of the tag.
Reference	Reference.
UnresolvedReference	Indicates if object is populated with data or is just a reference to the data

Methods

SerializeAsV2(IOpenApiWriter)	Serialize OpenApiTag to Open Api v2.0
SerializeAsV2WithoutReference(IOpenApiWriter)	Serialize to OpenAPI V2 document without using reference.
SerializeAsV3(IOpenApiWriter)	Serialize OpenApiTag to Open Api v3.0
SerializeAsV3WithoutReference(IOpenApiWriter)	Serialize to OpenAPI V3 document without using reference.

Extension Methods

Validate(IOpenApiElement, ValidationRuleSet)	Validate element and all child elements
ResolveReference(IOpenApiReferenceable, JsonPointer)	Resolves a JSON Pointer with respect to an element, returning the referenced element.

Applies to

Share via