[PHP] Allow strings with only whitespaces in enums#12783
Merged
wing328 merged 1 commit intoOpenAPITools:masterfrom Jul 11, 2022
Merged
Conversation
Member
|
LGTM. Thanks for the contribution. |
Contributor
Author
|
My pleasure! 😄 |
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.
The current implementation of the PHP client doesn't allow strings containing only white spaces (like
' ') as values for enum, despite they being valid in OpenAPI specification (or, at least not forbidden). This is a fragment of Microsoft Business Central API for reading/posting a Journal Entry (I'm only showing the relevant field):Microsoft Business Central API demands the default value to be a string with exactly one space character inside it, otherwise it fails.
The current PHP generator sanitizes the enum options, removing all white spaces - even if the option contain only white spaces.
This PR changes the generator, so that it accepts whitespace-only strings as valid enum options and name them as
SPACE_X, whereXis the number of spaces inside that string. The change does NOT affect the trimming of enum options containing characters other than spaces - which means, this should not be a BC: it only affect a currently unsupported scenario.We already use this change in our own branch of openapi-generator - I'm creating some PRs upstream, so that we can share the small bugs we have fixed, and this is one of them! 😄
The immediate benefit of this PR is to allow the OpenAPIGenerator PHP client to work with Microsoft Business Central, but it will surely benefit other APIs using space-only strings as enum values. 😉
Cheers!
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.1.0) (minor release - breaking changes with fallbacks),7.0.x(breaking changes without fallbacks)@jebentier, @dkarlovi, @mandrean, @jfastnacht, @ybelenko, @renepardon