required-entity-example-value
Overview
This rule belongs to the apimatic-docs-linting ruleset and states that:
Component must have a non-null, non-empty and valid example/sample value.
| Property | Value |
|---|---|
| Enabled | Yes |
| Maximum Severity | Information |
| Message | Example is missing. |
| Code | APIMATICDOCS_L101 |
| Type | Linting |
| Rule System | Semantic |
| Broad Category | Examples |
| Products Impacted | Developer Experience Portal |
| Tags | portal generation portal docs linting apimatic example sample value |
Suggested Fixes
- Add an example for the component which is valid according to the component's type.