# no-invalid-schema-examples

Disallow invalid schema examples.

| OAS | Compatibility |
|  --- | --- |
| 2.0 | ✅ |
| 3.0 | ✅ |
| 3.1 | ✅ |



```mermaid
flowchart TD

Root ==> Paths --> PathItem --> Operation --> Parameter --> Example
PathItem --> Parameter
Parameter --> Schema
Operation --> MediaType --> Schema
Root ==> components

NamedSchema --> Parameter

Schema -.compares schema\nto example.- Example

subgraph components
NamedSchema
end


style Example fill:#codaf9,stroke:#0044d4,stroke-width:5px
style Schema fill:#codaf9,stroke:#0044d4,stroke-width:5px
style NamedSchema fill:#codaf9,stroke:#0044d4,stroke-width:5px
```

## 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.

## Configuration

| 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:


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

## Examples

Given the following configuration:


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

Example of **incorrect** schema example:


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

Example of **correct** parameter example:


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

## Related rules

- [no-invalid-media-type-examples](/docs/cli/rules/oas/no-invalid-media-type-examples)
- [no-invalid-parameter-examples](/docs/cli/rules/oas/no-invalid-parameter-examples)


## Resources

- [Rule source](https://github.com/Redocly/redocly-cli/blob/main/packages/core/src/rules/common/no-invalid-schema-examples.ts)
- [Schema docs](https://redocly.com/docs/openapi-visual-reference/schemas/)