OpenAPITools / OpenAPITools/openapi-generator
[REQ] [Axios-Typescript] Create enumerator for parameters
Open
Nobody has claimed this yet.
Enhancement: Feature
- 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 we have some parameter which is a enum, the generator is not creating and enumerator which can be used as a model. For example, for the following parameter (imageType) which is an enumerator:
/v1/users/settings/photo:
get:
operationId: getUserPhoto
summary: Get User Photo
tags:
- Users
parameters:
- name: imageType
in: query
type: string
enum:
- b64
- uri
It generates the following code:
getUserPhoto(imageType?: 'b64' | 'uri', options: any = {}): RequestArgs {
...
and it should generate something like this:
import { imageTypeEnum } from 'api/models' // pseudo import
getUserPhoto(imageType?: imageTypeEnum, options: any = {}): RequestArgs {
...
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
No file or test is named. Start by locating the Axios TypeScript generator and its handling of inline enum query parameters; compare generated output with the issue's example. Done means enum parameters are represented by an exported model and used in the generated method signature.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi, typescript
- Domain
- api, tooling
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100