no-read-only-property-in-parameter-example
Overview
This rule belongs to the apimatic-docs-linting ruleset and states that:
An example provided for a complex type parameter must not contain properties that are marked as read-only. Such properties may only be set in a response but should not be part of the request.
| Property | Value |
|---|---|
| Enabled | Yes |
| Maximum Severity | Warning |
| Message | One or more read-only properties found in the parameter example. |
| Code | APIMATICDOCS_L110 |
| Type | Linting |
| Rule System | Semantic |
| Broad Category | Examples |
| Products Impacted | Developer Experience Portal |
| Tags | portal generation portal docs linting apimatic value example read only parameter |
Suggested Fixes
- Remove all properties from the parameter example that are marked as read-only.
- If the properties can be part of the request, disable the read-only flag for them in the global schema definition.