Skip to main content



This rule belongs to the openapi-v3-docsgen-linting ruleset and states that:

Examples within parameters or request body media types should not contain any properties marked as readOnly. Similarly, when providing examples for response object media types, it is important to avoid including any properties marked as writeOnly.

Maximum SeverityWarning
MessageInvalid example value found.
Rule SystemSemantic
Broad CategoryOpenAPI Examples
Products ImpactedDeveloper Experience Portal
Tagsdocumentation generation documentation docs openapi3 openapi semantic linting apimatic example examples value readonly writeonly

Suggested Fixes

  • Remove any readOnly property from the example defined within parameter or request body media type examples.
  • Remove any writeOnly properties from the example defined within response object media type examples.

For More Information