[Java] [vertx] Make supportVertxFuture compatible with vertx 5 by RickyRister · Pull Request #23660 · OpenAPITools/openapi-generator

RickyRister · 2026-04-29T19:16:20Z

In vertx 5, Promise no longer extends Handler<AsyncResult>, which means we can't directly pass in a promise into an arg that accepts a handler. However, promise::handle still works, in both versions of vertx.

Also added a new sample java-vertx5-supportVertxFuture to the samples.

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.

@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)

Summary by cubic

Make supportVertxFuture compatible with Vert.x 5 by switching generated calls to promise::handle, keeping Vert.x 4 support. Adds a Vert.x 5 Petstore sample and updates CI to build it.

Bug Fixes
- In Java/libraries/vertx/api.mustache, use promise::handle in default Future helpers (and auth variants) instead of passing the Promise directly.
- Update existing samples/client/petstore/java/vertx-supportVertxFuture APIs to use promise::handle.
New Features
- Add Vert.x 5 sample: samples/client/petstore/java/vertx5-supportVertxFuture with config bin/configs/java-vertx5-supportVertxFuture.yaml (useVertx5: "true", supportVertxFuture: "true").
- CI: include the new sample in .github/workflows/samples-java-client-jdk11.yaml.

^{Written for commit 5726692. Summary will update on new commits. Review in cubic}

cubic-dev-ai

7 issues found across 231 files

Note: This PR contains a large number of files. cubic only reviews up to 75 files per PR, so some files may not have been reviewed. cubic prioritises the most important files to review.

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="samples/client/petstore/java/vertx5-supportVertxFuture/docs/FakeClassnameTags123Api.md">

<violation number="1" location="samples/client/petstore/java/vertx5-supportVertxFuture/docs/FakeClassnameTags123Api.md:13">
P2: Vert.x future-mode docs still present a synchronous `Client` return and `ApiException` try/catch, but the generated API returns `Future<Client>`; the sample code is incorrect and will not compile as written.</violation>
</file>

<file name="samples/client/petstore/java/vertx5-supportVertxFuture/docs/EnumArrays.md">

<violation number="1" location="samples/client/petstore/java/vertx5-supportVertxFuture/docs/EnumArrays.md:11">
P3: Broken internal anchor for the `arrayEnum` enum section; the fragment will not match the generated heading id.</violation>
</file>

<file name="samples/client/petstore/java/vertx5-supportVertxFuture/docs/MapTest.md">

<violation number="1" location="samples/client/petstore/java/vertx5-supportVertxFuture/docs/MapTest.md:11">
P3: Broken intra-document enum link: the fragment does not match the generated heading anchor.</violation>
</file>

<file name="samples/client/petstore/java/vertx5-supportVertxFuture/docs/DefaultApi.md">

<violation number="1" location="samples/client/petstore/java/vertx5-supportVertxFuture/docs/DefaultApi.md:13">
P2: Docs for the Vert.x Future sample still show a synchronous `fooGet()`/`ApiException` example, but the actual API returns `Future<FooGetDefaultResponse>`, so the snippet is inaccurate and misleading.</violation>
</file>

<file name="samples/client/petstore/java/vertx5-supportVertxFuture/.travis.yml">

<violation number="1" location="samples/client/petstore/java/vertx5-supportVertxFuture/.travis.yml:9">
P2: The Travis matrix includes JDK 8/9/10 even though this Vert.x 5 sample is Java 11-only, so those CI jobs will fail deterministically.</violation>
</file>

<file name="samples/client/petstore/java/vertx5-supportVertxFuture/docs/AnotherFakeApi.md">

<violation number="1" location="samples/client/petstore/java/vertx5-supportVertxFuture/docs/AnotherFakeApi.md:37">
P2: Docs example uses a synchronous `Client`/`ApiException` pattern for a Future-returning Vert.x 5 API.</violation>
</file>

<file name="samples/client/petstore/java/vertx5-supportVertxFuture/git_push.sh">

<violation number="1" location="samples/client/petstore/java/vertx5-supportVertxFuture/git_push.sh:48">
P1: Embedding `GIT_TOKEN` in the remote URL stores the secret in Git config and can expose it through remote listings/logs.</violation>
</file>

_{Reply with feedback, questions, or to request a fix. Tag @cubic-dev-ai to re-run a review.}

cubic-dev-ai · 2026-04-29T19:21:20Z

+        echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment."
+        git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git
+    else
+        git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git


P1: Embedding GIT_TOKEN in the remote URL stores the secret in Git config and can expose it through remote listings/logs.

Prompt for AI agents

Check if this issue is valid — if so, understand the root cause and fix it. At samples/client/petstore/java/vertx5-supportVertxFuture/git_push.sh, line 48: <comment>Embedding `GIT_TOKEN` in the remote URL stores the secret in Git config and can expose it through remote listings/logs.</comment> <file context> @@ -0,0 +1,57 @@ + echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment." + git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git + else + git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git + fi + </file context>

cubic-dev-ai · 2026-04-29T19:21:21Z

@@ -0,0 +1,82 @@
+# FakeClassnameTags123Api


P2: Vert.x future-mode docs still present a synchronous Client return and ApiException try/catch, but the generated API returns Future<Client>; the sample code is incorrect and will not compile as written.

Prompt for AI agents

Check if this issue is valid — if so, understand the root cause and fix it. At samples/client/petstore/java/vertx5-supportVertxFuture/docs/FakeClassnameTags123Api.md, line 13: <comment>Vert.x future-mode docs still present a synchronous `Client` return and `ApiException` try/catch, but the generated API returns `Future<Client>`; the sample code is incorrect and will not compile as written.</comment> <file context> @@ -0,0 +1,82 @@ + +## testClassname + +> Client testClassname(client) + +To test class name in snake case </file context>

cubic-dev-ai · 2026-04-29T19:21:21Z

+
+## fooGet
+
+> FooGetDefaultResponse fooGet()


P2: Docs for the Vert.x Future sample still show a synchronous fooGet()/ApiException example, but the actual API returns Future<FooGetDefaultResponse>, so the snippet is inaccurate and misleading.

Prompt for AI agents

Check if this issue is valid — if so, understand the root cause and fix it. At samples/client/petstore/java/vertx5-supportVertxFuture/docs/DefaultApi.md, line 13: <comment>Docs for the Vert.x Future sample still show a synchronous `fooGet()`/`ApiException` example, but the actual API returns `Future<FooGetDefaultResponse>`, so the snippet is inaccurate and misleading.</comment> <file context> @@ -0,0 +1,69 @@ + +## fooGet + +> FooGetDefaultResponse fooGet() + + </file context>

cubic-dev-ai · 2026-04-29T19:21:21Z

@@ -0,0 +1,22 @@
+#


P2: The Travis matrix includes JDK 8/9/10 even though this Vert.x 5 sample is Java 11-only, so those CI jobs will fail deterministically.

Prompt for AI agents

Check if this issue is valid — if so, understand the root cause and fix it. At samples/client/petstore/java/vertx5-supportVertxFuture/.travis.yml, line 9: <comment>The Travis matrix includes JDK 8/9/10 even though this Vert.x 5 sample is Java 11-only, so those CI jobs will fail deterministically.</comment> <file context> @@ -0,0 +1,22 @@ +language: java +jdk: + - openjdk12 + - openjdk11 + - openjdk10 + - openjdk9 </file context>

Suggested change

#

- openjdk11

cubic-dev-ai · 2026-04-29T19:21:21Z

+        AnotherFakeApi apiInstance = new AnotherFakeApi(defaultClient);
+        Client client = new Client(); // Client | client model
+        try {
+            Client result = apiInstance.call123testSpecialTags(client);


P2: Docs example uses a synchronous Client/ApiException pattern for a Future-returning Vert.x 5 API.

Prompt for AI agents

Check if this issue is valid — if so, understand the root cause and fix it. At samples/client/petstore/java/vertx5-supportVertxFuture/docs/AnotherFakeApi.md, line 37: <comment>Docs example uses a synchronous `Client`/`ApiException` pattern for a Future-returning Vert.x 5 API.</comment> <file context> @@ -0,0 +1,75 @@ + AnotherFakeApi apiInstance = new AnotherFakeApi(defaultClient); + Client client = new Client(); // Client | client model + try { + Client result = apiInstance.call123testSpecialTags(client); + System.out.println(result); + } catch (ApiException e) { </file context>

cubic-dev-ai · 2026-04-29T19:21:21Z

+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**justSymbol** | [**JustSymbolEnum**](#JustSymbolEnum) |  |  [optional] |
+|**arrayEnum** | [**List&lt;ArrayEnumEnum&gt;**](#List&lt;ArrayEnumEnum&gt;) |  |  [optional] |


P3: Broken internal anchor for the arrayEnum enum section; the fragment will not match the generated heading id.

Prompt for AI agents

Check if this issue is valid — if so, understand the root cause and fix it. At samples/client/petstore/java/vertx5-supportVertxFuture/docs/EnumArrays.md, line 11: <comment>Broken internal anchor for the `arrayEnum` enum section; the fragment will not match the generated heading id.</comment> <file context> @@ -0,0 +1,32 @@ +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +|**justSymbol** | [**JustSymbolEnum**](#JustSymbolEnum) | | [optional] | +|**arrayEnum** | [**List<ArrayEnumEnum>**](#List<ArrayEnumEnum>) | | [optional] | + + </file context>

Suggested change

|**arrayEnum** | [**List<ArrayEnumEnum>**](#List<ArrayEnumEnum>) | | [optional] |

|**arrayEnum** | [**List<ArrayEnumEnum>**](#enum-listarrayenumenum) | | [optional] |

cubic-dev-ai · 2026-04-29T19:21:21Z

+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+|**mapMapOfString** | **Map&lt;String, Map&lt;String, String&gt;&gt;** |  |  [optional] |
+|**mapOfEnumString** | [**Map&lt;String, InnerEnum&gt;**](#Map&lt;String, InnerEnum&gt;) |  |  [optional] |


P3: Broken intra-document enum link: the fragment does not match the generated heading anchor.

Prompt for AI agents

Check if this issue is valid — if so, understand the root cause and fix it. At samples/client/petstore/java/vertx5-supportVertxFuture/docs/MapTest.md, line 11: <comment>Broken intra-document enum link: the fragment does not match the generated heading anchor.</comment> <file context> @@ -0,0 +1,25 @@ +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +|**mapMapOfString** | **Map<String, Map<String, String>>** | | [optional] | +|**mapOfEnumString** | [**Map<String, InnerEnum>**](#Map<String, InnerEnum>) | | [optional] | +|**directMap** | **Map<String, Boolean>** | | [optional] | +|**indirectMap** | **Map<String, Boolean>** | | [optional] | </file context>

Suggested change

|**mapOfEnumString** | [**Map<String, InnerEnum>**](#Map<String, InnerEnum>) | | [optional] |

|**mapOfEnumString** | [**Map<String, InnerEnum>**](#enum-mapstring-innerenum) | | [optional] |

RickyRister added 4 commits April 29, 2026 10:16

add sample for vertx5-supportVertxFuture

8e2a6b2

generate sample

38eee55

call promise::handle

a90c0e7

update samples

5726692

cubic-dev-ai Bot reviewed Apr 29, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

[Java] [vertx] Make supportVertxFuture compatible with vertx 5#23660

[Java] [vertx] Make supportVertxFuture compatible with vertx 5#23660
RickyRister wants to merge 4 commits intoOpenAPITools:masterfrom
RickyRister:vertx5-supportVertxFuture

RickyRister commented Apr 29, 2026 •

edited

Loading

Uh oh!

cubic-dev-ai Bot left a comment

Uh oh!

cubic-dev-ai Bot Apr 29, 2026

Uh oh!

cubic-dev-ai Bot Apr 29, 2026

Uh oh!

cubic-dev-ai Bot Apr 29, 2026

Uh oh!

cubic-dev-ai Bot Apr 29, 2026

Uh oh!

cubic-dev-ai Bot Apr 29, 2026

Uh oh!

cubic-dev-ai Bot Apr 29, 2026

Uh oh!

cubic-dev-ai Bot Apr 29, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

	\|arrayEnum \| [List<ArrayEnumEnum>](#List<ArrayEnumEnum>) \| \| [optional] \|
	\|arrayEnum \| [List<ArrayEnumEnum>](#enum-listarrayenumenum) \| \| [optional] \|

	\|mapOfEnumString \| [Map<String, InnerEnum>](#Map<String, InnerEnum>) \| \| [optional] \|
	\|mapOfEnumString \| [Map<String, InnerEnum>](#enum-mapstring-innerenum) \| \| [optional] \|

Uh oh!

Conversation

RickyRister commented Apr 29, 2026 • edited 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

Choose a reason for hiding this comment

Uh oh!

cubic-dev-ai Bot Apr 29, 2026

Choose a reason for hiding this comment

Uh oh!

cubic-dev-ai Bot Apr 29, 2026

Choose a reason for hiding this comment

Uh oh!

cubic-dev-ai Bot Apr 29, 2026

Choose a reason for hiding this comment

Uh oh!

cubic-dev-ai Bot Apr 29, 2026

Choose a reason for hiding this comment

Uh oh!

cubic-dev-ai Bot Apr 29, 2026

Choose a reason for hiding this comment

Uh oh!

cubic-dev-ai Bot Apr 29, 2026

Choose a reason for hiding this comment

Uh oh!

cubic-dev-ai Bot Apr 29, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

RickyRister commented Apr 29, 2026 •

edited

Loading