example-value-restrictions
Overview
This rule belongs to the apimatic-docs-linting ruleset and states that:
The sample value provided must obey all restrictions placed in the corresponding type definition.
| Property | Value |
|---|---|
| Enabled | Yes |
| Maximum Severity | Warning |
| Message | Sample value violates type restrictions. |
| Code | APIMATICDOCS_L105 |
| 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
- Adjust the sample value so that it meets all type restrictions present in the corresponding type definition.
- Remove the restrictions from the corresponding type definition.