no-invalid-schema-examples

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:

Copy

Copied

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

Given the following configuration:

Copy

Copied

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

Example of incorrect schema example:

Copy

Copied

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

Example of correct parameter example:

Copy

Copied

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