tag-description-exists

Overview

This rule belongs to the openapi-v3-docsgen-linting ruleset and states that:

Tag Object must have a non-null non-empty description.

Property	Value
Enabled	Yes
Maximum Severity	Information
Message	Description is missing in tag object
Code	OPENAPI3DOCSGEN_L710
Type	Linting
Rule System	Semantic
Broad Category	OpenAPI Tags
Products Impacted	Developer Experience Portal
Tags	documentation generation documentation docs openapi3 openapi semantic linting apimatic description tag

Suggested Fixes

• Add a user-friendly description of the tag object.

For More Information

• https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#tag-object
• https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md
• https://docs.apimatic.io/rulesets/overview/