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

[K6] Enhancement: Make operationId accessible inside requests #14787

Merged

Conversation

JasonMejane
Copy link
Contributor

  • Add the operationId to the request to make it accessible in template in K6ClientGenerator.java
  • Add example in comment in script.mustache

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.
  • In case you are adding a new generator, run the following additional script :
    ./bin/utils/ensure-up-to-date.sh
    
    Commit all changed files.
  • 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.

Visiblity @mostafa

@agilob
Copy link
Contributor

agilob commented Feb 24, 2023

What does it do?

No changes in the sample project?

@mostafa
Copy link
Contributor

mostafa commented Feb 27, 2023

Hey @JasonMejane,

thanks for your contribution! Please update the example test script by regenerating the samples, as also mentioned by @agilob.

@JasonMejane
Copy link
Contributor Author

@mostafa @agilob I updated the sample script, thanks for pointing it out :)

The operationId is really helpful to create named functions in a client, instead of groups. So this change helps ones who would like to use their own template instead of the default one to generate a client, whitout the need to create a custom k6 client, providing the operationId to be used if needed.

@mostafa
Copy link
Contributor

mostafa commented Mar 1, 2023

@JasonMejane Perfect! Thank you. 🙏

@wing328 wing328 merged commit 350fb82 into OpenAPITools:master Mar 1, 2023
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.

4 participants