valid-example-value
Overview
This rule belongs to the apimatic-docs-linting ruleset and states that:
The sample value provided must be valid according to the type definition of the component to which it belongs.
| Property | Value |
|---|---|
| Enabled | Yes |
| Maximum Severity | Warning |
| Message | Sample value is invalid. |
| Code | APIMATICDOCS_L104 |
| Type | Linting |
| Rule System | Semantic |
| Broad Category | Examples |
| Products Impacted | Developer Experience Portal |
| Tags | portal generation portal docs linting apimatic sample value example |
Suggested Fixes
- Check that no required properties are missing in the sample value.
- Check that types of all properties match those specified in the type definition.