required-entity-description

Overview

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

Component must have a non-null non-empty description.

Property	Value
Enabled	Yes
Maximum Severity	Information
Message	Description is missing.
Code	APIMATICDOCS_L002
Type	Linting
Rule System	Semantic
Broad Category	Description
Products Impacted	Developer Experience Portal
Tags	portal generation portal docs linting apimatic description

Suggested Fixes

• Add a user-friendly description for the component.

For More Information

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