Skip to content

[Java][jaxrs-spec] Fix generated JsonTypeName when using underscore in schema names#23689

Open
BB223 wants to merge 1 commit intoOpenAPITools:masterfrom
BB223:fix/jsontypename
Open

[Java][jaxrs-spec] Fix generated JsonTypeName when using underscore in schema names#23689
BB223 wants to merge 1 commit intoOpenAPITools:masterfrom
BB223:fix/jsontypename

Conversation

@BB223
Copy link
Copy Markdown

@BB223 BB223 commented May 4, 2026

Description

When using underscores in schema names and using discriminator mappings, the JsonTypeName wasn't correctly generated. This fixes the issue I mentioned in #10822

The name field in CodegenModel and the modelName field in CodegenDiscriminator.MappedModel are not equal when using underscores. The CodegenDiscriminator.MappedModel field uses the sanitized name, which is equal to the classname field of CodgenModel. I don't know if the non equality is intended or not, since from the naming of the fields i would also assume they would be equal. I opted for using the raw schemaName in both classes to check for equality.

Open Question

When i added the undescores in the test file, the jaxrs-cxf-cdi sample suddenly included the JsonTypeName import. I couldn't figure out why this is happening. It would be great, if someone could help me avoid this unused import.

@bbdouglas (2017/07) @sreeshas (2017/08) @jfiala (2017/08) @lukoyanov (2017/09) @cbornet (2017/09) @jeff9finger (2018/01) @karismann (2019/03) @Zomzog (2019/04) @lwlee2608 (2019/10) @martin-mfg (2023/08)

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 solves a reported issue, reference it using GitHub's linking syntax (e.g., having "fixes #123" present in the PR description)
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

Summary by cubic

Fixes incorrect @JsonTypeName generation in the JAX-RS (jaxrs-spec) generator when schemas with underscores are used in discriminator mappings. Ensures the correct discriminator value by matching on raw schema names.

  • Bug Fixes
    • In JavaJAXRSSpecServerCodegen, compare mappedModel.schemaName to model.schemaName to set x-discriminator-value.
    • Updated test spec to use Dog_Request in oneOf and mapping; regenerated sample adds JsonTypeName import in DogRequest.

Written for commit dd89576. Summary will update on new commits.

Copy link
Copy Markdown
Contributor

@cubic-dev-ai cubic-dev-ai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No issues found across 3 files

@BB223 BB223 force-pushed the fix/jsontypename branch from 448b6fc to dd89576 Compare May 4, 2026 20:12
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.

1 participant