Enum Names

The OpenAPI schema can be extended to include enum names for enum values. This will let Orval generate enums with correct names.

Example of OpenAPI schema

1openapi: '3.1.0'
2info:
3  version: 1.0.0
4  title: Swagger Petstore
5  license:
6    name: MIT
7components:
8  schemas:
9    MyObject:
10      type: object
11      properties:
12        myEnum:
13          type: number
14          enum:
15            - 1
16            - 2
17            - 3
18            - 4
19          x-enumNames:
20            - One
21            - Two
22            - Three
23            - Four

The enum generated by Orval will as follows:

1export const MyEnum {
2  One: 1,
3  Two: 2,
4  Three: 3,
5  Four: 4
6} as const;

Valid Enum Name Extensions

Orval recognizes the following extensions:

• x-enumNames
• x-enumnames
• x-enum-varnames