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] Update API naming to follow Golang standard pkg (1 line change) #15331

Merged
merged 9 commits into from
May 13, 2023

Conversation

lwj5
Copy link
Contributor

@lwj5 lwj5 commented Apr 27, 2023

Following the naming conventions of Go standard packages, Acronyms should be all caps.

Api thus should be API instead

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.

@lwj5 lwj5 changed the title [Go] Update API naming to adhere to Golang standards [Go] Update API naming to adhere to Golang standards (1 line change) Apr 27, 2023
@lwj5 lwj5 changed the title [Go] Update API naming to adhere to Golang standards (1 line change) [Go] Update API naming to follow Golang standard pkg (1 line change) Apr 27, 2023
@wing328 wing328 added this to the 7.0.0 milestone May 3, 2023
@wing328 wing328 changed the base branch from 7.0.x to master May 13, 2023 01:27
@wing328
Copy link
Member

wing328 commented May 13, 2023

CircleCI failure not related to this change.

@wing328
Copy link
Member

wing328 commented May 13, 2023

LGTM. Let's give it a try.

In case users need to fall back to Api for easier upgrade, they can use the option apiNameSuffix (e.g. --api-name-suffix in CLI) to do that.

@wing328 wing328 merged commit 78bffff into OpenAPITools:master May 13, 2023
9 checks passed
@wing328
Copy link
Member

wing328 commented May 14, 2023

FYI. Merged #15505 to fix tests

@jablan
Copy link

jablan commented Oct 6, 2023

@wing328 it took us quite a while to find this discussion and learn about apiNameSuffix. Any reason why it's not listed when I invoke

openapi-generator-cli config-help -g go

? Thanks!

@lwj5 lwj5 deleted the standards branch May 6, 2024 11:29
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

3 participants