OpenAPITools / OpenAPITools/openapi-generator
[REQ] [typescript-axios] Use generated enums in operations
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 26.8k
- Forks
- 7.7k
- PR merge metrics
- PR metrics pending
Description
Is your feature request related to a problem? Please describe.
When using API functions generated from this, I want to be able to also use the enum types. The enums are generated for models, but they should also be generated for operations too.
Describe the solution you'd like
Generate and use enum types in operations.
Describe alternatives you've considered
Just hard-coding the enum values when using operations, but that's not great.
Additional context
e.g.
findPetsByStatus: async (status: Array<'available' | 'pending' | 'sold'>, ...
should be
findPetsByStatus: async (status: Array<FindPetsByStatusStatusEnum>, ...
...
export const FindPetsByStatusStatusEnum = {
Available: 'available',
Pending: 'pending',
Sold: 'sold'
} as const;
export type FindPetsByStatusStatusEnum = typeof FindPetsByStatusStatusEnum[keyof typeof FindPetsByStatusStatusEnum];
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the typescript-axios generator's operation parameter generation and compare it with the existing model enum generation. Trace the example findPetsByStatus output and determine where operation enum types and constants should be emitted. Done means generated operations use named enum types instead of inline string unions and expose the corresponding enum values.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- api, tooling
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100