[haskell-servant][haskell-yesod] Use table-based conversion for field name conversion #16232
Merged
wing328 merged 2 commits intoOpenAPITools:masterfrom Aug 3, 2023
Merged
Conversation
… name conversion Current fieldLabelModifier implementation always produces uncapitalize name, but it is inappropriate if the original JSON field name begins with a capital letter.
Member
|
@msakai thanks for the PR. Can you please PM me via https://join.slack.com/t/openapi-generator/shared_invite/zt-12jxxd7p2-XUeQM~4pzsU9x~eGLQqX2g when you've time? |
Contributor
Author
|
@wing328 Sure! |
Member
|
yes please |
Member
|
tested locally and the result is good: |
6 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
I noticed that
haskell(haskell-servant) andhaskell-yesodgenerators cannot handle field names starting with upper case characters. For example, the following spec contains theMessagefield, and the generatedToJSON/FromJSONinstances ofHelloResponsedo not work.For example, the following test program failed to convert JSON string into
HelloResponsevalue.The problem is that those instances call the
uncapitalizefunction even when the JSON field name starts with an upper-case letter.To resolve this problem, this PR proposes to change the field name conversion to the one based on the conversion table.
(However, I'm curious if there is a better way or how other generators handle this issue.)
With the changes in this PR, generated code looks like this:
and, the above-mentioned test program succeeds to convert JSON string and
HelloResponsevalue:PR checklist
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.
master(6.3.0) (minor release - breaking changes with fallbacks),7.0.x(breaking changes without fallbacks)cc: @f-f @Drezil