Skip to main content

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.

PropertyValue
EnabledYes
Maximum SeverityInformation
MessageDescription is missing.
CodeAPIMATICDOCS_L002
TypeLinting
Rule SystemSemantic
Broad CategoryDescription
Products ImpactedDeveloper Experience Portal
Tagsportal generation portal docs linting apimatic description

Suggested Fixes

  • Add a user-friendly description for the component.

For More Information