required-description-all-entities

Overview

This rule belongs to the apimatic-docs-linting ruleset and states that:

Each element in the API specification must have a non-null non-empty description.

Property	Value
Enabled	Yes
Maximum Severity	Information
Message	One or more elements in the API specification has a missing description.
Code	APIMATICDOCS_L001
Type	Linting
Rule System	Semantic
Broad Category	Description
Products Impacted	Developer Experience Portal
Tags	portal generation portal docs linting apimatic description

Suggested Fixes

• Make sure all components translated into APIMatic have a description set.

For More Information

• https://www.apimatic.io/developer-experience-portal/
• https://docs.apimatic.io/rulesets/overview/