# tag-description-defined

Source: https://apigenie.pl/docs/linter/openapi/rules/tag-description-defined

A rule of the OpenAPI linter, which reads OpenAPI 3.0, 3.1 and 3.2 documents. Since 0.0.1. In the rulesets: Recommended at warning, Strict at warning, All at warning.

This rule checks that every tag has a description of at least 10 characters that is not a
placeholder.

## Rule details

Tags are the sections of the documentation and the classes of a generated client; the
description is the sentence at the top of the section that says what the group is for. A tag
named `Users` with no description is a heading over a list.

The rule reports `Tag '...' has no meaningful description defined` when the description is
missing, shorter than the minimum, white space only, or one of `TBD`, `TODO` and `FIXME`.

## Configuration

A positive integer: the minimal length of a description. 10 by default.

**Configuration example**. Descriptions of at least 20 characters.

```yaml
commands:
  lint:
    rules:
      tag-description-defined:
        - warning
        - 20
```

## Examples

**Good**.

```yaml
tags:
  - name: User
    description: Operations on user accounts.
  - name: Product
    description: Operations on the product catalog.
```

**Bad**. An empty description and a missing one.

```yaml
tags:
  - name: User
    description: ""
  - name: Product
```
