Skip to main content



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

Example Value represents the actual example value, while External Value is used to reference an external file or URL containing the example. Each example object should include either an Example Value or an External Value.

Maximum SeverityWarning
MessageExample Value and External Value are missing from the example object.
Rule SystemSemantic
Broad CategoryOpenAPI Examples
Products ImpactedDeveloper Experience Portal
Tagsdocumentation generation documentation docs openapi3 openapi semantic linting apimatic example examples value extenal value

Suggested Fixes

  • Check each example object and ensure that it includes either an Example Value or an External Value.
  • Ensure that the Example Value or External Value accurately reflect the expected data format and content.

For More Information