fix(java-spring): expose requestBody named examples to Mustache template context (#23607) by anupamchaubey · Pull Request #24651 · OpenAPITools/openapi-generator

anupamchaubey · 2026-08-09T17:20:56Z

Description of Changes
Updated AbstractJavaCodegen to correctly populate named requestBody examples from mediaType.getExamples() into codegenParameter.examples, ensuring they are properly exposed to Mustache templates.

Added a unit test in SpringCodegenTest along with a test OpenAPI specification YAML (requestbody_named_examples.yaml) to verify that named request body examples are correctly mapped and available for template rendering.

PR checklist

Read the contribution guidelines.
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.
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

Expose named requestBody examples to Mustache templates for all generators via codegenParameter.examples. Previously templates could not access named examples; now they are populated from request body media types without changing existing example value fallbacks.

Add DefaultCodegen#setParameterExamples(RequestBody) and invoke it from both setParameterExampleValue(RequestBody) and fromRequestBody(...) to populate codegenParameter.examples from MediaType.getExamples().
Remove the Java-only override in AbstractJavaCodegen to centralize behavior in DefaultCodegen.
Update SpringCodegenTest: preprocess and set the OpenAPI; add requestbody_named_examples.yaml; assert named examples “Jessica” and “Ron” are exposed.

^{Written for commit 0ef86e7. Summary will update on new commits.}

cubic-dev-ai

All reported issues were addressed across 3 files

_{Reply with feedback, questions, or to request a fix.

Re-trigger cubic}

…ate context (OpenAPITools#23607)

wing328 · 2026-08-13T08:16:08Z

thanks for the PR

did you have a chance to review the feedback from cubic-dev-ai?

calling generator.opts(input).generate(); seems not necessary?

Mattias-Sehlstedt · 2026-08-13T10:20:04Z

Any particular reason as to why this is placed within the JavaCodegen and not in the DefaultCodegen? I would assume that this is something that all code generators most likely would want to access?

Mattias-Sehlstedt · 2026-08-13T10:22:03Z

+   @Override
    public void setParameterExampleValue(CodegenParameter codegenParameter, RequestBody requestBody) {
-        boolean isModel = (codegenParameter.isModel || (codegenParameter.isContainer && codegenParameter.getItems().isModel));
+        if (requestBody.getContent() != null && !requestBody.getContent().isEmpty()) {


Is it an intentional change that we now silently continue processing rather than throwing an exception if the request body does not contain any content?

Thanks for the thorough review, @Mattias-Sehlstedt!

Why AbstractJavaCodegen instead of DefaultCodegen? You make a great point; exposing named examples is likely useful for other generators too. I implemented it here as a focused fix for Java, but I can look into shifting this up to DefaultCodegen to align with setParameterExamples if you think it belongs globally.

Silent continue on empty content: Yes, that was an intentional adjustment to avoid abrupt runtime exceptions on non-standard specs, allowing the generator to proceed smoothly. However, if a strict check or warning is preferred there, I'd be happy to add it back!

To clarify if it was not clear to begin with: I am not affiliated with the project in any sense, and that these are my personal opinions.

I would argue that it definitely belongs as a global configuration so that any language generator can utilize the data to construct better examples locally with the mustache files.

Given that no one has raised any issue with a NPE being thrown unexpectedly I would leave that behavior as-is since I would argue that its age might even be an indicator of it not even being something that is possible (and if it is an issue, then someone will have to raise an issue specifically for that and highlight exactly when it occurs and what is a proper way of handling it).

Additionally, the current logic does not prevent any issues, since a null content will just defer to the setParameterExampleValue(CodegenParameter codegenParameter, RequestBody requestBody) in DefaultCodegen, which does not have null handling, and thus we get the same issue.

Note that the @Override on the method also seems to have fallen back one space.

Thanks again for the clear feedback, @Mattias-Sehlstedt! I will refactor this to move the logic up into DefaultCodegen so all generators can benefit from it, restore the original null handling behavior, and fix the @OverRide indentation spacing. I'll push the updates shortly.

Mattias-Sehlstedt · 2026-08-13T10:24:23Z

+            }
+
+            // FIX for #23607: Assign all named examples to the parameter so Mustache templates can access them
+            if (mediaType.getExamples() != null && !mediaType.getExamples().isEmpty()) {


DefaultCodegen has setParameterExamples(CodegenParameter codegenParameter, Parameter parameter) which does basically the same as this. Is that something we should mimic for clarity?

Thanks for pointing that out! Mimicking DefaultCodegen#setParameterExamples makes total sense for consistency and clarity. I can refactor this to align with that pattern.

cubic-dev-ai

All reported issues were addressed across 1 file (changes from recent commits).

_{Reply with feedback, questions, or to request a fix.

Re-trigger cubic}

anupamchaubey · 2026-08-13T13:01:22Z

thanks for the PR

did you have a chance to review the feedback from cubic-dev-ai?

calling generator.opts(input).generate(); seems not necessary?

Thanks, @wing328! Yes, you were spot on—I've removed the unnecessary generator.opts(input).generate() call and cleaned up the test scaffolding.

…ultGenerator

Mattias-Sehlstedt · 2026-08-13T14:30:28Z

-            if (hasExample) {
-                once(LOGGER).warn("Ignoring complex example on request body");
+                if (!isModel) {
+                    Example example = mediaType.getExamples().values().iterator().next();


This logic seems to duplicate what is done in the DefaultCodegen? Would it be possible to instead keep the logic so that it just defers to super.setParameterExampleValue(codegenParameter, requestBody); as it did before?

Thanks, @Mattias-Sehlstedt! I completely removed the custom override from AbstractJavaCodegen so that it relies purely on the global logic in DefaultCodegen now.

…ultCodegen

cubic-dev-ai

1 issue found across 2 files (changes from recent commits).

Prompt for AI agents (unresolved issues)


Check if these issues are valid — if so, understand the root cause of each and fix them. If appropriate, use sub-agents to investigate and fix each issue separately.


<file name="modules/openapi-generator/src/main/java/org/openapitools/codegen/DefaultCodegen.java">

<violation number="1" location="modules/openapi-generator/src/main/java/org/openapitools/codegen/DefaultCodegen.java:2467">
P2: TypeScript generators still do not expose named request-body examples because their override bypasses this base implementation. Apply the shared examples population in that override as well, or refactor the body-processing path so every override receives it.</violation>
</file>

_{Tip: Review your code locally with the cubic CLI to iterate faster.

Re-trigger cubic}

cubic-dev-ai · 2026-08-13T16:46:32Z

+        if (requestBody.getContent() != null && !requestBody.getContent().isEmpty()) {
+            for (MediaType mediaType : requestBody.getContent().values()) {
+                if (mediaType.getExamples() != null && !mediaType.getExamples().isEmpty()) {
+                    codegenParameter.examples = mediaType.getExamples();


P2: TypeScript generators still do not expose named request-body examples because their override bypasses this base implementation. Apply the shared examples population in that override as well, or refactor the body-processing path so every override receives it.

Prompt for AI agents

Check if this issue is valid — if so, understand the root cause and fix it. At modules/openapi-generator/src/main/java/org/openapitools/codegen/DefaultCodegen.java, line 2467: <comment>TypeScript generators still do not expose named request-body examples because their override bypasses this base implementation. Apply the shared examples population in that override as well, or refactor the body-processing path so every override receives it.</comment> <file context> @@ -2454,6 +2454,23 @@ public void setParameterExamples(CodegenParameter codegenParameter, Parameter pa + if (requestBody.getContent() != null && !requestBody.getContent().isEmpty()) { + for (MediaType mediaType : requestBody.getContent().values()) { + if (mediaType.getExamples() != null && !mediaType.getExamples().isEmpty()) { + codegenParameter.examples = mediaType.getExamples(); + break; + } </file context>

…alue and update samples

…Body

Mattias-Sehlstedt · 2026-08-14T10:59:27Z

Hello again, I have created a more targeted change for the issue #24707 since this PR currently seems to leak logic with how the samples have changed.

anupamchaubey · 2026-08-14T11:22:17Z

Thanks, @Mattias-Sehlstedt! That makes total sense. I appreciate you taking it across the finish line with a cleaner, more targeted approach.

cubic-dev-ai Bot reviewed Aug 9, 2026

View reviewed changes

Comment thread .../openapi-generator/src/test/java/org/openapitools/codegen/java/spring/SpringCodegenTest.java Outdated

fix(java-spring): expose requestBody named examples to Mustache templ…

c4a41aa

…ate context (OpenAPITools#23607)

anupamchaubey force-pushed the fix/requestbody-examples-23607 branch from 3b09844 to c4a41aa Compare August 9, 2026 17:38

Mattias-Sehlstedt mentioned this pull request Aug 9, 2026

refactor: unify handling of content examples parsing #24653

Merged

3 tasks

Merge branch 'master' into fix/requestbody-examples-23607

a1c0096

wing328 added Issue: Bug Server: Java Server: Spring Client: Java and removed Server: Spring labels Aug 13, 2026

wing328 added this to the 7.25.0 milestone Aug 13, 2026

Mattias-Sehlstedt reviewed Aug 13, 2026

View reviewed changes

fix(java-spring): preprocess OpenAPI in unit test to avoid NPE

5ec4bff

cubic-dev-ai Bot reviewed Aug 13, 2026

View reviewed changes

Comment thread .../openapi-generator/src/test/java/org/openapitools/codegen/java/spring/SpringCodegenTest.java

fix(java-spring): call codegen.setOpenAPI in unit test to mirror Defa…

5f90fdd

…ultGenerator

anupamchaubey requested a review from Mattias-Sehlstedt August 13, 2026 13:11

Mattias-Sehlstedt reviewed Aug 13, 2026

View reviewed changes

feat(codegen): move requestbody named examples logic globally to Defa…

ee46e4b

…ultCodegen

cubic-dev-ai Bot reviewed Aug 13, 2026

View reviewed changes

anupamchaubey added 2 commits August 13, 2026 22:25

fix(codegen): use setParameterExamples helper in setParameterExampleV…

37b4154

…alue and update samples

fix(codegen): invoke setParameterExamples globally inside fromRequest…

0ef86e7

…Body

anupamchaubey closed this Aug 14, 2026

anupamchaubey deleted the fix/requestbody-examples-23607 branch August 14, 2026 11:23

Uh oh!

Uh oh!

Conversation

anupamchaubey commented Aug 9, 2026 • edited by cubic-dev-ai Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PR checklist

Summary by cubic

Uh oh!

cubic-dev-ai Bot left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

wing328 commented Aug 13, 2026

Uh oh!

Mattias-Sehlstedt commented Aug 13, 2026

Uh oh!

Mattias-Sehlstedt Aug 13, 2026

Choose a reason for hiding this comment

Uh oh!

anupamchaubey Aug 13, 2026

Choose a reason for hiding this comment

Uh oh!

Mattias-Sehlstedt Aug 13, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

anupamchaubey Aug 13, 2026

Choose a reason for hiding this comment

Uh oh!

Mattias-Sehlstedt Aug 13, 2026

Choose a reason for hiding this comment

Uh oh!

anupamchaubey Aug 13, 2026

Choose a reason for hiding this comment

Uh oh!

cubic-dev-ai Bot left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

anupamchaubey commented Aug 13, 2026

Uh oh!

Mattias-Sehlstedt Aug 13, 2026

Choose a reason for hiding this comment

Uh oh!

anupamchaubey Aug 13, 2026

Choose a reason for hiding this comment

Uh oh!

cubic-dev-ai Bot left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

cubic-dev-ai Bot Aug 13, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Mattias-Sehlstedt commented Aug 14, 2026

Uh oh!

anupamchaubey commented Aug 14, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

anupamchaubey commented Aug 9, 2026 •

edited by cubic-dev-ai Bot

Loading

cubic-dev-ai Bot left a comment •

edited

Loading

Mattias-Sehlstedt Aug 13, 2026 •

edited

Loading

cubic-dev-ai Bot left a comment •

edited

Loading

cubic-dev-ai Bot left a comment •

edited

Loading