Skip to content

[Go]Add Value suffix to Golang types#20645

Closed
Sander0542 wants to merge 1 commit intoOpenAPITools:masterfrom
Sander0542:fix/golang-type-names
Closed

[Go]Add Value suffix to Golang types#20645
Sander0542 wants to merge 1 commit intoOpenAPITools:masterfrom
Sander0542:fix/golang-type-names

Conversation

@Sander0542
Copy link
Contributor

The Go client library generates Parameter structs for OneOf and AnyOf types. When one of the types is a string, then the property name will be String. This prevents us from creating a String() method which can be used with the fmt package.

By adding a Value suffix to the property names, we don't change any logic while allowing for more flexibility with the generated client.

This however requires existing clients to update calls to the implementations they made.

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 || exit
    ./bin/generate-samples.sh ./bin/configs/*.yaml || exit
    ./bin/utils/export_docs_generators.sh || exit
    
    (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.x.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.

@antihax (2017/11) @grokify (2018/07) @kemokemo (2018/09) @jirikuncar (2021/01) @ph4r5h4d (2021/04) @lwj5 (2023/04)

@Sander0542
Copy link
Contributor Author

Closed in favour of #20663

@Sander0542 Sander0542 closed this Feb 13, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant