no-invalid-schema-examples
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Disallow invalid schema examples.

API design principles

If your schema and example conflict, there is a problem in the definition of the schema or the example. Solve it before you ship it.

Option	Type	Description
severity	string	Possible values: `off`, `warn`, `error`. Default `warn`.
allowAdditionalProperties	boolean	Determines if additional properties are allowed in examples. Default `false`.

An example configuration:

rules:
  no-invalid-schema-examples:
    severity: error
    allowAdditionalProperties: false

Given the following configuration:

rules:
  no-invalid-schema-examples:
    severity: error
    allowAdditionalProperties: false

Example of incorrect schema example:

components:
  schemas:
    Car:
      type: object
      properties:
        color:
          type: string
          example: 3.14

Example of correct parameter example:

components:
  schemas:
    Car:
      type: object
      properties:
        color:
          type: string
          example: red