Skip to content

FIX #21407 - use referenced string enum schema in requestBody if available #21410

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 1 commit into
base: master
Choose a base branch
from

Conversation

WannabeSoftwareEngineer
Copy link

@WannabeSoftwareEngineer WannabeSoftwareEngineer commented Jun 13, 2025

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 || 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.
  • 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 is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

Description

This PR fixes the issue raised in #21407.
The core of this change is to treat a referenced string enum schema as a model rather than a primitive.

To achieve this, the updateRequestBodyForString method has been updated to accept the schema's component name. When this name is present, we delegate processing to addBodyModelSchema. This mirrors the existing logic that is already present in updateRequestBodyForObject, resulting in the proper enum type in the generated API.

The behavior for primitive or inline strings remains unchanged.

Breaking change

Since this modifies the generated method signatures, the new behavior is introduced behind a feature flag named useStringEnumSchemaRefForRequestBody to ensure back compatibility with existing clients.

@WannabeSoftwareEngineer
Copy link
Author

Tagging some members of the Java committee
@martin-mfg @lwlee2608

I would appreciate a few moments of your time to share any feedback on the proposed changes. Thank you.

@Mattias-Sehlstedt
Copy link
Contributor

Hello, could you please adjust the message so that it aligns with this? It would be helpful since it would make the issues page show that there already exists a suggested solution for the raised issue.

image
(the icon marked in red is what is added)

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