Skip to main content



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.

Maximum SeverityWarning
MessageOne or more read-only properties found in the parameter example.
Rule SystemSemantic
Broad CategoryExamples
Products ImpactedDeveloper Experience Portal
Tagsportal 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.

For More Information