# no-enum-type-mismatch

Requires that the contents of every `enum` value in your API description conform to the corresponding schema's specified `type`.

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



```mermaid
flowchart TD

Root ==> Paths --> PathItem --> Operation --> Parameter --> Schema
PathItem --> Parameter
NamedParameter --> Parameter
Operation --> RequestBody --> MediaType --> Schema
Operation --> Responses --> MediaType
NamedSchema --> Schema
Root ==> components

subgraph components
NamedParameter
NamedSchema
end

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

| AsyncAPI | Compatibility |
|  --- | --- |
| 2.6 | ✅ |
| 3.0 | ✅ |


| Arazzo | Compatibility |
|  --- | --- |
| 1.0 | ✅ |


## API design principles

If a property is defined for a certain type, then its corresponding `enum` values should comply with that type.
Lack of compliance is most likely the result of a typo.

## Configuration

| Option | Type | Description |
|  --- | --- | --- |
| severity | string | Possible values: `off`, `warn`, `error`. Default `error` (in `recommended` configuration). |


An example configuration:


```yaml
rules:
  no-enum-type-mismatch: error
```

## Examples

Given this configuration:


```yaml
rules:
  no-enum-type-mismatch: error
```

Example of **incorrect** enum values given the enum type:


```yaml
properties:
  huntingSkill:
    type: string
    description: The measured skill for hunting
    enum:
      - adventurous
      - 12
      - 3.14
```

Example of **correct** enum values given the enum type:


```yaml
properties:
  huntingSkill:
    type: string
    description: The measured skill for hunting
    enum:
      - adventurous
      - aggressive
      - passive
```

## Related rules

- [no-schema-type-mismatch](/docs/cli/rules/common/no-schema-type-mismatch)
- [no-required-schema-properties-undefined](/docs/cli/rules/common/no-required-schema-properties-undefined)
- [configurable rules](/docs/cli/rules/configurable-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)
- [no-invalid-schema-examples](/docs/cli/rules/oas/no-invalid-schema-examples)


## Resources

- [Rule source](https://github.com/Redocly/redocly-cli/blob/main/packages/core/src/rules/common/no-enum-type-mismatch.ts)
- [Enum documentation](https://redocly.com/docs/openapi-visual-reference/schemas/#enum)