no-undeclared-fields-in-example-value
Overview
This rule belongs to the apimatic-docs-linting ruleset and states that:
All undeclared fields from the component's example must be defined in the component's type definition. If any fields are extra, they should be removed from the example.
| Property | Value |
|---|---|
| Enabled | Yes |
| Maximum Severity | Warning |
| Message | The example specified contains undeclared fields. |
| Code | APIMATICDOCS_L106 |
| 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
- Make sure that all properties that are shown in your example are also defined in the corresponding type definition of the component.