Articles
Author
vacuum
Quick Start
💥 Try It Now
About vacuum
Installing
Why?
Concepts
FAQ
AsyncAPI
Ignoring Violations
JSON Schema
Changelog
Configuring
Generate API Docs
VSCode Plugin
GitHub Action
CLI Commands
Lint
vacuum Report
Dashboard
Generate Docs
HTML Report
Spectral Report
References
Upgrade vacuum
Version
Bundle Spec
Generate RuleSet
Language Server
Apply Overlay
Schema
Open Collection
Change Detection
Exit Codes
Developer API
API Quick Start
Spec Index
RuleResultSet
Loading RuleSet
Custom Go Functions
Custom JS Functions
Non-OpenAPI Files
Functions
Core Functions
OpenAPI Functions
OWASP Functions
JSON Schema Funcs
AsyncAPI Funcs
Rules
Examples
OWASP
Channels
Operations/Paths
Messages
Schemas
Spec Information
Servers
Validation
Descriptions
Tags
Security
RuleSets
What are they?
Sharing RuleSets
No Rules/Off
OpenAPI Default
Custom RuleSets
OWASP Rules
JSON Schema Rules
AsyncAPI Default
AsyncAPI All Rules
  • GitHub GitHub Repo stars
  • Discord Discord Server
    • ✨ New! Try the OpenAPI Doctor ✨ The OpenAPI Doctor

    asyncapi-3-tag-description

    Formats: Severity:

    asyncapi-3-tag-description checks tag objects for explanatory description values.

    Why did this violation appear?

    A tag has a name but no description.

    Bad example

    asyncapi: 3.1.0
tags:
  - name: users

    Good example

    asyncapi: 3.1.0
tags:
  - name: users
    description: User lifecycle events.

    How do I fix this violation?

    Add a short description to each tag so readers understand the grouping.