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

Change default value of 'pathParamsAsVariables' config option #16404

Conversation

gcatanese
Copy link
Contributor

Path parameters are often modified by developers using the collection (ie to test different scenarios), therefore creating those path parameters as Postman (global) variables does not make much sense.

This PR changes the default value of the configuration pathParamsAsVariables to skip (by default) the path parameters. Developers can still decide to enable this behavior setting the property to true.

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.

@gcatanese @wing328

@gcatanese gcatanese changed the title Change default pathparamsvariables config Change default value of 'pathparamsvariables' config option Aug 24, 2023
@gcatanese gcatanese changed the title Change default value of 'pathparamsvariables' config option Change default value of 'pathParamsAsVariables' config option Aug 24, 2023
@wing328
Copy link
Member

wing328 commented Aug 28, 2023

Thanks for the PR. We'll include it in the upcoming v71.0 as it's a breaking change with fallback.

@wing328
Copy link
Member

wing328 commented Aug 28, 2023

@gcatanese can you please PM via Slack when you've time?

@wing328 wing328 added this to the 7.1.0 milestone Aug 28, 2023
@wing328 wing328 merged commit 254b359 into OpenAPITools:master Sep 20, 2023
16 checks passed
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.

None yet

2 participants