tag-description

Global Tags define meta-data that can then be used by Operations and Paths Rules

Tags are used as navigation/taxonomy meta-data for documentation and code generation tooling. Descriptions are really important for consumers.

Why did this violation appear?

One or more global tags does not contain a description

Bad example

openapi: 3.0.1
tags:
  - name: "Tag1"
  - name: "Tag2"  
info:
    ...

Good Example

openapi: 3.0.1
tags:
  - name: "Tag1"
    description: "Tag1 is a tag for group 1, and related things"
  - name: "Tag2"
    description: "Tag2 is a tag for group 2, which is only for one thing."
info:
  ...

How do I fix this violation?

Ensure global tags each have a description defined.

Spectral Equivalent

The rule is equivalent to tag-description