Skip to main content



This rule belongs to the apimatic-docs-linting ruleset and states that:

An example provided for a complex type response must not contain properties that are marked as write-only. Such properties may only be sent as part of the request but should not be set in the response.

Maximum SeverityWarning
MessageOne or more write-only properties found in the response example.
Rule SystemSemantic
Broad CategoryExamples
Products ImpactedDeveloper Experience Portal
Tagsportal generation portal docs linting apimatic value example write only response

Suggested Fixes

  • Remove all properties from the response example that are marked as write-only.
  • If the properties can be part of the response, disable the write-only flag for them in the global schema definition.

For More Information