Skip to content

allow check for path parameters in matrix style#16331

Merged
wing328 merged 2 commits intoOpenAPITools:masterfrom
mkresse:matrix-support-for-templates
Aug 22, 2023
Merged

allow check for path parameters in matrix style#16331
wing328 merged 2 commits intoOpenAPITools:masterfrom
mkresse:matrix-support-for-templates

Conversation

@mkresse
Copy link
Copy Markdown
Contributor

@mkresse mkresse commented Aug 15, 2023

Fixes #16330 by adding a boolean variable isMatrix to mustache parameter context. This allows custom template code like:

{{#isPathParam}}{{#isMatrix}}@MatrixParam{{/isMatrix}}{{^isMatrix}}@PathParam{{/isMatrix}}

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
    
    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.

@wing328
Copy link
Copy Markdown
Member

wing328 commented Aug 15, 2023

Thanks for the PR but your commit (as shown in the Commits tab) is not linked to your Github account, which means this PR won't count as your contribution in https://github.com/OpenAPITools/openapi-generator/graphs/contributors.

Let me know if you need help fixing it.

Ref: https://github.com/OpenAPITools/openapi-generator/wiki/FAQ#how-can-i-update-commits-that-are-not-linked-to-my-github-account

@wing328
Copy link
Copy Markdown
Member

wing328 commented Aug 15, 2023

can you please also add a test or two to cover the new flag?

@mkresse mkresse force-pushed the matrix-support-for-templates branch from e90660b to 2ea6470 Compare August 15, 2023 13:22
@mkresse
Copy link
Copy Markdown
Contributor Author

mkresse commented Aug 15, 2023

@wing328, thanks for your very quick reply. Also thanks for your hint regarding the author - just fixed that with a force push. I also added a simple unit test for the new flag, I hope this is sufficient.

@wing328
Copy link
Copy Markdown
Member

wing328 commented Aug 20, 2023

cc @OpenAPITools/generator-core-team

@wing328 wing328 added this to the 7.0.0 milestone Aug 22, 2023
@wing328 wing328 merged commit bb507d5 into OpenAPITools:master Aug 22, 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.

[REQ] Allow mustache templates to support matrix parameters

2 participants