Skip to main content



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

Each of the example provided for a Schema Object using the examples property should be valid for the type definition of that schema.

Maximum SeverityWarning
MessageExample value provided in the Schema Object examples list is not valid.
Rule SystemSemantic
Broad CategorySchemas
Products ImpactedAPI Transformer, Code Generation, Developer Experience Portal
Tagsopenapi3 openapi standards semantic linting examples example schema

Suggested Fixes

  • Ensure that the example provided in the schema examples list conforms to the schema type definition.
  • Check that no required properties are missing in the example value.
  • Check that types of all properties match those specified in the schema definition.

For More Information