tag-description-override

Replaces the tag description with the designated Markdown in the corresponding file.

API design principles

Sometimes developers generate OpenAPI and the descriptions need to be improved after the fact. This generally happens when you have no permission to edit the source. This decorator provides a way to "overlay" a new description over the source so that as the source changes you won't lose your modifications.

Configuration

Option Type Description
tagNames object REQUIRED. List of key values pairs with tag names as the key and paths to Markdown files as the value.

Example of a configuration:

Copy
Copied
styleguide:
  decorators:
    tag-description-override:
      tagNames:
        planet: ./my-planet-description.md
        star: ./my-star-description.md

Examples

tag-description-override

See a repository with info, operation, and tag description overrides.

Related decorators

Resources