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

[Go] Set Default Values for Required Variables when a default is defined #19232

Merged
merged 8 commits into from
Jul 30, 2024

Conversation

vvb
Copy link
Contributor

@vvb vvb commented Jul 24, 2024

Fixes #19107

  • useDefaultValuesForRequiredVars flag is added to enable this behavior. It is disabled by default.
  • Samples that have a required value would have some diff from before if the flag is set 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/configs/*.yaml
    ./bin/utils/export_docs_generators.sh
    
    (For Windows users, please run the script in Git BASH)
    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*.
    IMPORTANT: Do NOT purge/delete any folders/files (e.g. tests) when regenerating the samples as manually written tests may be removed.
  • File the PR against the correct branch: master (upcoming 7.6.0 minor release - breaking changes with fallbacks), 8.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.

Copy link
Contributor

@Ghufz Ghufz left a comment

Choose a reason for hiding this comment

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

Looks good to me

@vvb vvb force-pushed the feature/vvb_go_defaults branch from f373304 to 25c2656 Compare July 29, 2024 05:12
@wing328
Copy link
Member

wing328 commented Jul 29, 2024

for the failing test, please update the assertion accordingly as the Category name will have the default value after this change (with the option enabled)

@vvb
Copy link
Contributor Author

vvb commented Jul 29, 2024

for the failing test, please update the assertion accordingly as the Category name will have the default value after this change (with the option enabled)

I have removed the setting of the value and Getter is a pure getter as it should have been. So, this is not required anymore.

@wing328
Copy link
Member

wing328 commented Jul 29, 2024

@vvb
Copy link
Contributor Author

vvb commented Jul 29, 2024

please run https://github.com/OpenAPITools/openapi-generator/blob/master/bin/utils/ensure-up-to-date to update the doc as well

@wing328 I had missed out running the exporting of docs post resolving the comments. It is done now. And all the tests are passing.

@wing328
Copy link
Member

wing328 commented Jul 30, 2024

looks good. let's give it a try

@wing328 wing328 merged commit 5d48d22 into OpenAPITools:master Jul 30, 2024
16 checks passed
vvb added a commit to CiscoM31/openapi-generator that referenced this pull request Aug 1, 2024
…ned (OpenAPITools#19232)

* use default values for required vars when available

* update tests to existing config file

* cleanup OAS test

* Remove setting value in Get.

* Use Pascal Case for variable naming in Getter Function

* add a CLI option

* add a CLI option

* add a CLI option
mohamuni pushed a commit to mohamuni/openapi-generator that referenced this pull request Aug 1, 2024
…ned (OpenAPITools#19232)

* use default values for required vars when available

* update tests to existing config file

* cleanup OAS test

* Remove setting value in Get.

* Use Pascal Case for variable naming in Getter Function

* add a CLI option

* add a CLI option

* add a CLI option
vvb added a commit to CiscoM31/openapi-generator that referenced this pull request Aug 2, 2024
…ned (OpenAPITools#19232)

* use default values for required vars when available

* update tests to existing config file

* cleanup OAS test

* Remove setting value in Get.

* Use Pascal Case for variable naming in Getter Function

* add a CLI option

* add a CLI option

* add a CLI option
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] [Go] Set Default Values for Required Variables where only one value is possible.
3 participants