fix(cpp-qt): Fix enum query parameter serialization for both inline and referenced enums#21863
Open
ReallyVirtual wants to merge 1 commit intoOpenAPITools:masterfrom
Open
Conversation
…nd referenced enums
For enum query parameters, the template was incorrectly using asJsonObject()
which returns {"value": "enumValue"} and then iterating over keys, using
"value" as the parameter name instead of the actual parameter name.
This fix adds special handling for both inline enums (isEnum) and referenced
enums (isEnumRef) to use asJson() directly, which returns the correct enum
string value for URL serialization.
Fixes enum query parameters like ?scope=property instead of ?value=property.
Completes the fix started in PR OpenAPITools#21211 which added the asJsonObject() method
to make enum code compile, but the template logic was still incorrect for URL
query parameter serialization.
Note: The petstore samples don't contain enum query parameter tests to
demonstrate this fix (they use string arrays). Future contributors may want
to add enum query parameter examples to better showcase this functionality.
Member
|
thanks for the PR what about adding some fake endpoints to |
Contributor
Author
|
@wing328 Sure. I'm using my fork with the change to generate usable code for enums (that doesn't require a .value), and will add something similar to my use case next weekend. |
Merged
6 tasks
Member
|
closed via #22559 (you listed as co-author) with updated samples |
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.
Fixes enum query parameter serialization for cpp-qt-client generator.
Problem
For enum query parameters, the template was incorrectly using
asJsonObject()which returns{"value": "enumValue"}and then iterating over keys, using "value" as the parameter name instead of the actual parameter name.This resulted in incorrect URLs like:
?value=property instead of ?scope=propertySolution
Added special handling for both inline enums (isEnum) and referenced enums (isEnumRef) in the
api-body.mustache templateto useasJson()directly, which returns the correct enum string value for URL serialization.Changes
Modified modules/openapi-generator/src/main/resources/cpp-qt-client/api-body.mustache to detect both enum types and use direct string serialization
Updated cpp-qt-client samples (though petstore samples don't contain enum query parameter tests to demonstrate this specific fix)
Context
Completes the fix started in PR #21211 which added the
asJsonObject()method to make enum code compile, but the template logic was still incorrect for URL query parameter serialization.Testing
✅ Built OpenAPI Generator successfully
✅ Generated cpp-qt-client samples without errors
✅ Verified enum parameters now serialize correctly in generated code
Note
The petstore samples don't contain enum query parameter examples to showcase this functionality. Future contributors may want to add enum query parameter tests to better demonstrate this fix.
PR checklist
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.
master(upcoming7.x.0minor release - breaking changes with fallbacks),8.0.x(breaking changes without fallbacks)"fixes #123"present in the PR description)