Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[typescript-axios] single request param in factory #14358

Merged

Conversation

stropho
Copy link
Contributor

@stropho stropho commented Jan 2, 2023

typescript-axios generator uses an option useSingleRequestParameter as mentioned in https://github.com/OpenAPITools/openapi-generator/blob/master/docs/generators/typescript-axios.md

However, this option is used only in generated classes. This PR reuse the same logic in api factories.

PR checklist

  • Read the contribution guidelines.
  • Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community.
  • Run the following to build the project and update samples:
    ./mvnw clean package 
    ./bin/generate-samples.sh
    ./bin/utils/export_docs_generators.sh
    
    Commit all changed files.
    This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
    These must match the expectations made by your contribution.
    You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example ./bin/generate-samples.sh bin/configs/java*.
    For Windows users, please run the script in Git BASH.
  • File the PR against the correct branch: master (6.3.0) (minor release - breaking changes with fallbacks), 7.0.x (breaking changes without fallbacks)
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

@TiFu (2017/07) @taxpon (2017/07) @sebastianhaas (2017/07) @kenisteward (2017/07) @Vrolijkx (2017/09) @macjohnny (2018/01) @topce (2018/10) @akehir (2019/07) @petejohansonxo (2019/11) @amakhrov (2020/02) @davidgamero (2022/03) @mkusaka (2022/04)

Copy link
Member

@macjohnny macjohnny left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for your contribution!

@macjohnny macjohnny merged commit a6eb96e into OpenAPITools:master Jan 3, 2023
@macjohnny macjohnny added this to the 6.3.0 milestone Jan 3, 2023
@dbusacca
Copy link

dbusacca commented Feb 7, 2023

I think this fix must be applied also to the generated "functional programming interface" and the "axios parameter creator".

I've got an API with a parameter named "options" and it conflicts with the generated options?: AxiosRequestConfig parameter

@stropho
Copy link
Contributor Author

stropho commented Feb 7, 2023

I think this fix must be applied also to the generated "functional programming interface" and the "axios parameter creator".

I don't have a strong opinion about this, but I guess you can always file an issue or possibly a PR

I've got an API with a parameter named "options" and it conflicts with the generated options?: AxiosRequestConfig parameter

A quick workaround would be to rename your parameter ;) Or a simple PR to use a more unique name such as axiosRequestConfig?: AxiosRequestConfig

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants