Skip to content

Conversation

ReallyVirtual
Copy link
Contributor

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=property

Solution

Added special handling for both inline enums (isEnum) and referenced enums (isEnumRef) in the api-body.mustache template to use asJson() 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

  • [x ] Read the contribution guidelines.
  • [ x] 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 || exit
    ./bin/generate-samples.sh ./bin/configs/*.yaml || exit
    ./bin/utils/export_docs_generators.sh || exit
    
    (For Windows users, please run the script in WSL)
    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.
  • [x ] File the PR against the correct branch: master (upcoming 7.x.0 minor release - breaking changes with fallbacks), 8.0.x (breaking changes without fallbacks)
  • If your PR solves a reported issue, reference it using GitHub's linking syntax (e.g., having "fixes #123" present in the PR description)
  • [x ] If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

…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.
@wing328
Copy link
Member

wing328 commented Sep 2, 2025

thanks for the PR

what about adding some fake endpoints to modules/openapi-generator/src/test/resources/3_0/cpp-qt/petstore.yaml to cover this change?

for example https://github.com/OpenAPITools/openapi-generator/blob/master/modules/openapi-generator/src/test/resources/3_0/petstore-with-fake-endpoints-models-for-testing.yaml#L1280-L1305

@ReallyVirtual
Copy link
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.

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.

2 participants