Skip to content

Improve camelization for words starting with acronym #15798

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

Open
wants to merge 5 commits into
base: master
Choose a base branch
from

Conversation

timcbaoth
Copy link

These changes want to improve camelization for words that start with capital letters.

When we tried creating a client for Elixir, we would get functions named d_elete_invoice, where we would have expected delete_invoice. The reason being the operationId "DELETE_Invoice" being camelized to dELETEInvoice.

It also applies to words that start with an acronym, like "VATRate" or "ID", which were previously camelized to "vATRate" and "iDxyz", but now should be "vatRate" and "id".

There is also an open issue addressing the unexpected former behaviour: #6559

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
Member

wing328 commented Jul 27, 2023

@timcbaoth thanks for the PR. Can you please PM me via Slack when you've time?

https://join.slack.com/t/openapi-generator/shared_invite/zt-12jxxd7p2-XUeQM~4pzsU9x~eGLQqX2g

@ghe-bm
Copy link

ghe-bm commented Jan 16, 2024

When will this PR be merged into the master? I need this for the jaxrs-spec generator.

@wing328
Copy link
Member

wing328 commented Jan 31, 2024

will try to get it merge into the next version (7.4.0)

we need some ways for operation Id to fall back to avoid breaking changes. will try to add an option for that.

@wing328
Copy link
Member

wing328 commented Mar 24, 2024

I've filed #18218 and to enable the new camelization, one will need to set system property openapi.generator.fix.camelize to true

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.

4 participants