From 08c4f565f77e65d39c0d2a7ab6d9a759278c6272 Mon Sep 17 00:00:00 2001 From: Ruben Hoenle Date: Tue, 9 Sep 2025 18:10:33 +0200 Subject: [PATCH 1/2] java-client: fix some javadoc comments --- .../resources/Java/libraries/okhttp-gson/ApiClient.mustache | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/modules/openapi-generator/src/main/resources/Java/libraries/okhttp-gson/ApiClient.mustache b/modules/openapi-generator/src/main/resources/Java/libraries/okhttp-gson/ApiClient.mustache index 256c0e2ec036..2907e7518eeb 100644 --- a/modules/openapi-generator/src/main/resources/Java/libraries/okhttp-gson/ApiClient.mustache +++ b/modules/openapi-generator/src/main/resources/Java/libraries/okhttp-gson/ApiClient.mustache @@ -289,8 +289,8 @@ public class ApiClient { /** * Set base path * - * @param basePath Base path of the URL (e.g {{{basePath}}} - * @return An instance of OkHttpClient + * @param basePath Base path of the URL (e.g {{{basePath}}}) + * @return An instance of ApiClient */ public ApiClient setBasePath(String basePath) { this.basePath = basePath; @@ -338,7 +338,7 @@ public class ApiClient { * Set HTTP client, which must never be null. * * @param newHttpClient An instance of OkHttpClient - * @return Api Client + * @return ApiClient * @throws java.lang.NullPointerException when newHttpClient is null */ public ApiClient setHttpClient(OkHttpClient newHttpClient) { From 436e29c1c04541b993597df89b4abf129684c0e8 Mon Sep 17 00:00:00 2001 From: Ruben Hoenle Date: Tue, 9 Sep 2025 18:18:42 +0200 Subject: [PATCH 2/2] update samples --- .../src/main/java/org/openapitools/client/ApiClient.java | 6 +++--- .../src/main/java/org/openapitools/client/ApiClient.java | 6 +++--- .../src/main/java/org/openapitools/client/ApiClient.java | 6 +++--- .../src/main/java/org/openapitools/client/ApiClient.java | 6 +++--- .../src/main/java/org/openapitools/client/ApiClient.java | 6 +++--- .../src/main/java/org/openapitools/client/ApiClient.java | 6 +++--- .../src/main/java/org/openapitools/client/ApiClient.java | 6 +++--- .../src/main/java/org/openapitools/client/ApiClient.java | 6 +++--- .../src/main/java/org/openapitools/client/ApiClient.java | 6 +++--- .../src/main/java/org/openapitools/client/ApiClient.java | 6 +++--- .../src/main/java/org/openapitools/client/ApiClient.java | 6 +++--- .../src/main/java/org/openapitools/client/ApiClient.java | 6 +++--- .../src/main/java/org/openapitools/client/ApiClient.java | 6 +++--- .../src/main/java/org/openapitools/client/ApiClient.java | 6 +++--- .../src/main/java/org/openapitools/client/ApiClient.java | 6 +++--- 15 files changed, 45 insertions(+), 45 deletions(-) diff --git a/samples/client/echo_api/java/okhttp-gson-user-defined-templates/src/main/java/org/openapitools/client/ApiClient.java b/samples/client/echo_api/java/okhttp-gson-user-defined-templates/src/main/java/org/openapitools/client/ApiClient.java index c7b5a4c8667f..66fdcc77daf6 100644 --- a/samples/client/echo_api/java/okhttp-gson-user-defined-templates/src/main/java/org/openapitools/client/ApiClient.java +++ b/samples/client/echo_api/java/okhttp-gson-user-defined-templates/src/main/java/org/openapitools/client/ApiClient.java @@ -232,8 +232,8 @@ public String getBasePath() { /** * Set base path * - * @param basePath Base path of the URL (e.g http://petstore.swagger.io/v2 - * @return An instance of OkHttpClient + * @param basePath Base path of the URL (e.g http://petstore.swagger.io/v2) + * @return An instance of ApiClient */ public ApiClient setBasePath(String basePath) { this.basePath = basePath; @@ -281,7 +281,7 @@ public OkHttpClient getHttpClient() { * Set HTTP client, which must never be null. * * @param newHttpClient An instance of OkHttpClient - * @return Api Client + * @return ApiClient * @throws java.lang.NullPointerException when newHttpClient is null */ public ApiClient setHttpClient(OkHttpClient newHttpClient) { diff --git a/samples/client/echo_api/java/okhttp-gson/src/main/java/org/openapitools/client/ApiClient.java b/samples/client/echo_api/java/okhttp-gson/src/main/java/org/openapitools/client/ApiClient.java index bc3c3ea3b39a..b0712ff29b39 100644 --- a/samples/client/echo_api/java/okhttp-gson/src/main/java/org/openapitools/client/ApiClient.java +++ b/samples/client/echo_api/java/okhttp-gson/src/main/java/org/openapitools/client/ApiClient.java @@ -160,8 +160,8 @@ public String getBasePath() { /** * Set base path * - * @param basePath Base path of the URL (e.g http://localhost:3000 - * @return An instance of OkHttpClient + * @param basePath Base path of the URL (e.g http://localhost:3000) + * @return An instance of ApiClient */ public ApiClient setBasePath(String basePath) { this.basePath = basePath; @@ -209,7 +209,7 @@ public OkHttpClient getHttpClient() { * Set HTTP client, which must never be null. * * @param newHttpClient An instance of OkHttpClient - * @return Api Client + * @return ApiClient * @throws java.lang.NullPointerException when newHttpClient is null */ public ApiClient setHttpClient(OkHttpClient newHttpClient) { diff --git a/samples/client/others/java/okhttp-gson-oneOf-array/src/main/java/org/openapitools/client/ApiClient.java b/samples/client/others/java/okhttp-gson-oneOf-array/src/main/java/org/openapitools/client/ApiClient.java index 3af0915ba20f..2532a6ff87b3 100644 --- a/samples/client/others/java/okhttp-gson-oneOf-array/src/main/java/org/openapitools/client/ApiClient.java +++ b/samples/client/others/java/okhttp-gson-oneOf-array/src/main/java/org/openapitools/client/ApiClient.java @@ -156,8 +156,8 @@ public String getBasePath() { /** * Set base path * - * @param basePath Base path of the URL (e.g http://localhost - * @return An instance of OkHttpClient + * @param basePath Base path of the URL (e.g http://localhost) + * @return An instance of ApiClient */ public ApiClient setBasePath(String basePath) { this.basePath = basePath; @@ -205,7 +205,7 @@ public OkHttpClient getHttpClient() { * Set HTTP client, which must never be null. * * @param newHttpClient An instance of OkHttpClient - * @return Api Client + * @return ApiClient * @throws java.lang.NullPointerException when newHttpClient is null */ public ApiClient setHttpClient(OkHttpClient newHttpClient) { diff --git a/samples/client/others/java/okhttp-gson-oneOf/src/main/java/org/openapitools/client/ApiClient.java b/samples/client/others/java/okhttp-gson-oneOf/src/main/java/org/openapitools/client/ApiClient.java index 3d5820a0d01c..8e7970739c45 100644 --- a/samples/client/others/java/okhttp-gson-oneOf/src/main/java/org/openapitools/client/ApiClient.java +++ b/samples/client/others/java/okhttp-gson-oneOf/src/main/java/org/openapitools/client/ApiClient.java @@ -156,8 +156,8 @@ public String getBasePath() { /** * Set base path * - * @param basePath Base path of the URL (e.g http://localhost - * @return An instance of OkHttpClient + * @param basePath Base path of the URL (e.g http://localhost) + * @return An instance of ApiClient */ public ApiClient setBasePath(String basePath) { this.basePath = basePath; @@ -205,7 +205,7 @@ public OkHttpClient getHttpClient() { * Set HTTP client, which must never be null. * * @param newHttpClient An instance of OkHttpClient - * @return Api Client + * @return ApiClient * @throws java.lang.NullPointerException when newHttpClient is null */ public ApiClient setHttpClient(OkHttpClient newHttpClient) { diff --git a/samples/client/others/java/okhttp-gson-streaming/src/main/java/org/openapitools/client/ApiClient.java b/samples/client/others/java/okhttp-gson-streaming/src/main/java/org/openapitools/client/ApiClient.java index 0136cbce25ed..befde72b5f61 100644 --- a/samples/client/others/java/okhttp-gson-streaming/src/main/java/org/openapitools/client/ApiClient.java +++ b/samples/client/others/java/okhttp-gson-streaming/src/main/java/org/openapitools/client/ApiClient.java @@ -156,8 +156,8 @@ public String getBasePath() { /** * Set base path * - * @param basePath Base path of the URL (e.g http://localhost:8082 - * @return An instance of OkHttpClient + * @param basePath Base path of the URL (e.g http://localhost:8082) + * @return An instance of ApiClient */ public ApiClient setBasePath(String basePath) { this.basePath = basePath; @@ -205,7 +205,7 @@ public OkHttpClient getHttpClient() { * Set HTTP client, which must never be null. * * @param newHttpClient An instance of OkHttpClient - * @return Api Client + * @return ApiClient * @throws java.lang.NullPointerException when newHttpClient is null */ public ApiClient setHttpClient(OkHttpClient newHttpClient) { diff --git a/samples/client/petstore/java/okhttp-gson-3.1-duplicated-operationid/src/main/java/org/openapitools/client/ApiClient.java b/samples/client/petstore/java/okhttp-gson-3.1-duplicated-operationid/src/main/java/org/openapitools/client/ApiClient.java index c7b5a4c8667f..66fdcc77daf6 100644 --- a/samples/client/petstore/java/okhttp-gson-3.1-duplicated-operationid/src/main/java/org/openapitools/client/ApiClient.java +++ b/samples/client/petstore/java/okhttp-gson-3.1-duplicated-operationid/src/main/java/org/openapitools/client/ApiClient.java @@ -232,8 +232,8 @@ public String getBasePath() { /** * Set base path * - * @param basePath Base path of the URL (e.g http://petstore.swagger.io/v2 - * @return An instance of OkHttpClient + * @param basePath Base path of the URL (e.g http://petstore.swagger.io/v2) + * @return An instance of ApiClient */ public ApiClient setBasePath(String basePath) { this.basePath = basePath; @@ -281,7 +281,7 @@ public OkHttpClient getHttpClient() { * Set HTTP client, which must never be null. * * @param newHttpClient An instance of OkHttpClient - * @return Api Client + * @return ApiClient * @throws java.lang.NullPointerException when newHttpClient is null */ public ApiClient setHttpClient(OkHttpClient newHttpClient) { diff --git a/samples/client/petstore/java/okhttp-gson-3.1/src/main/java/org/openapitools/client/ApiClient.java b/samples/client/petstore/java/okhttp-gson-3.1/src/main/java/org/openapitools/client/ApiClient.java index c7b5a4c8667f..66fdcc77daf6 100644 --- a/samples/client/petstore/java/okhttp-gson-3.1/src/main/java/org/openapitools/client/ApiClient.java +++ b/samples/client/petstore/java/okhttp-gson-3.1/src/main/java/org/openapitools/client/ApiClient.java @@ -232,8 +232,8 @@ public String getBasePath() { /** * Set base path * - * @param basePath Base path of the URL (e.g http://petstore.swagger.io/v2 - * @return An instance of OkHttpClient + * @param basePath Base path of the URL (e.g http://petstore.swagger.io/v2) + * @return An instance of ApiClient */ public ApiClient setBasePath(String basePath) { this.basePath = basePath; @@ -281,7 +281,7 @@ public OkHttpClient getHttpClient() { * Set HTTP client, which must never be null. * * @param newHttpClient An instance of OkHttpClient - * @return Api Client + * @return ApiClient * @throws java.lang.NullPointerException when newHttpClient is null */ public ApiClient setHttpClient(OkHttpClient newHttpClient) { diff --git a/samples/client/petstore/java/okhttp-gson-awsv4signature/src/main/java/org/openapitools/client/ApiClient.java b/samples/client/petstore/java/okhttp-gson-awsv4signature/src/main/java/org/openapitools/client/ApiClient.java index 48657e8f4cd4..c94b814a27f7 100644 --- a/samples/client/petstore/java/okhttp-gson-awsv4signature/src/main/java/org/openapitools/client/ApiClient.java +++ b/samples/client/petstore/java/okhttp-gson-awsv4signature/src/main/java/org/openapitools/client/ApiClient.java @@ -236,8 +236,8 @@ public String getBasePath() { /** * Set base path * - * @param basePath Base path of the URL (e.g http://petstore.swagger.io/v2 - * @return An instance of OkHttpClient + * @param basePath Base path of the URL (e.g http://petstore.swagger.io/v2) + * @return An instance of ApiClient */ public ApiClient setBasePath(String basePath) { this.basePath = basePath; @@ -285,7 +285,7 @@ public OkHttpClient getHttpClient() { * Set HTTP client, which must never be null. * * @param newHttpClient An instance of OkHttpClient - * @return Api Client + * @return ApiClient * @throws java.lang.NullPointerException when newHttpClient is null */ public ApiClient setHttpClient(OkHttpClient newHttpClient) { diff --git a/samples/client/petstore/java/okhttp-gson-dynamicOperations/src/main/java/org/openapitools/client/ApiClient.java b/samples/client/petstore/java/okhttp-gson-dynamicOperations/src/main/java/org/openapitools/client/ApiClient.java index 6d00abd5b2a4..1b3c14258b9a 100644 --- a/samples/client/petstore/java/okhttp-gson-dynamicOperations/src/main/java/org/openapitools/client/ApiClient.java +++ b/samples/client/petstore/java/okhttp-gson-dynamicOperations/src/main/java/org/openapitools/client/ApiClient.java @@ -249,8 +249,8 @@ public String getBasePath() { /** * Set base path * - * @param basePath Base path of the URL (e.g http://petstore.swagger.io:80/v2 - * @return An instance of OkHttpClient + * @param basePath Base path of the URL (e.g http://petstore.swagger.io:80/v2) + * @return An instance of ApiClient */ public ApiClient setBasePath(String basePath) { this.basePath = basePath; @@ -298,7 +298,7 @@ public OkHttpClient getHttpClient() { * Set HTTP client, which must never be null. * * @param newHttpClient An instance of OkHttpClient - * @return Api Client + * @return ApiClient * @throws java.lang.NullPointerException when newHttpClient is null */ public ApiClient setHttpClient(OkHttpClient newHttpClient) { diff --git a/samples/client/petstore/java/okhttp-gson-group-parameter/src/main/java/org/openapitools/client/ApiClient.java b/samples/client/petstore/java/okhttp-gson-group-parameter/src/main/java/org/openapitools/client/ApiClient.java index c7b5a4c8667f..66fdcc77daf6 100644 --- a/samples/client/petstore/java/okhttp-gson-group-parameter/src/main/java/org/openapitools/client/ApiClient.java +++ b/samples/client/petstore/java/okhttp-gson-group-parameter/src/main/java/org/openapitools/client/ApiClient.java @@ -232,8 +232,8 @@ public String getBasePath() { /** * Set base path * - * @param basePath Base path of the URL (e.g http://petstore.swagger.io/v2 - * @return An instance of OkHttpClient + * @param basePath Base path of the URL (e.g http://petstore.swagger.io/v2) + * @return An instance of ApiClient */ public ApiClient setBasePath(String basePath) { this.basePath = basePath; @@ -281,7 +281,7 @@ public OkHttpClient getHttpClient() { * Set HTTP client, which must never be null. * * @param newHttpClient An instance of OkHttpClient - * @return Api Client + * @return ApiClient * @throws java.lang.NullPointerException when newHttpClient is null */ public ApiClient setHttpClient(OkHttpClient newHttpClient) { diff --git a/samples/client/petstore/java/okhttp-gson-nullable-required/src/main/java/org/openapitools/client/ApiClient.java b/samples/client/petstore/java/okhttp-gson-nullable-required/src/main/java/org/openapitools/client/ApiClient.java index e241564472ae..339331c770d8 100644 --- a/samples/client/petstore/java/okhttp-gson-nullable-required/src/main/java/org/openapitools/client/ApiClient.java +++ b/samples/client/petstore/java/okhttp-gson-nullable-required/src/main/java/org/openapitools/client/ApiClient.java @@ -235,8 +235,8 @@ public String getBasePath() { /** * Set base path * - * @param basePath Base path of the URL (e.g http://petstore.swagger.io/v2 - * @return An instance of OkHttpClient + * @param basePath Base path of the URL (e.g http://petstore.swagger.io/v2) + * @return An instance of ApiClient */ public ApiClient setBasePath(String basePath) { this.basePath = basePath; @@ -284,7 +284,7 @@ public OkHttpClient getHttpClient() { * Set HTTP client, which must never be null. * * @param newHttpClient An instance of OkHttpClient - * @return Api Client + * @return ApiClient * @throws java.lang.NullPointerException when newHttpClient is null */ public ApiClient setHttpClient(OkHttpClient newHttpClient) { diff --git a/samples/client/petstore/java/okhttp-gson-parcelableModel/src/main/java/org/openapitools/client/ApiClient.java b/samples/client/petstore/java/okhttp-gson-parcelableModel/src/main/java/org/openapitools/client/ApiClient.java index 8756448a8672..bad71b8297ff 100644 --- a/samples/client/petstore/java/okhttp-gson-parcelableModel/src/main/java/org/openapitools/client/ApiClient.java +++ b/samples/client/petstore/java/okhttp-gson-parcelableModel/src/main/java/org/openapitools/client/ApiClient.java @@ -238,8 +238,8 @@ public String getBasePath() { /** * Set base path * - * @param basePath Base path of the URL (e.g http://petstore.swagger.io:80/v2 - * @return An instance of OkHttpClient + * @param basePath Base path of the URL (e.g http://petstore.swagger.io:80/v2) + * @return An instance of ApiClient */ public ApiClient setBasePath(String basePath) { this.basePath = basePath; @@ -287,7 +287,7 @@ public OkHttpClient getHttpClient() { * Set HTTP client, which must never be null. * * @param newHttpClient An instance of OkHttpClient - * @return Api Client + * @return ApiClient * @throws java.lang.NullPointerException when newHttpClient is null */ public ApiClient setHttpClient(OkHttpClient newHttpClient) { diff --git a/samples/client/petstore/java/okhttp-gson-swagger1/src/main/java/org/openapitools/client/ApiClient.java b/samples/client/petstore/java/okhttp-gson-swagger1/src/main/java/org/openapitools/client/ApiClient.java index c7b5a4c8667f..66fdcc77daf6 100644 --- a/samples/client/petstore/java/okhttp-gson-swagger1/src/main/java/org/openapitools/client/ApiClient.java +++ b/samples/client/petstore/java/okhttp-gson-swagger1/src/main/java/org/openapitools/client/ApiClient.java @@ -232,8 +232,8 @@ public String getBasePath() { /** * Set base path * - * @param basePath Base path of the URL (e.g http://petstore.swagger.io/v2 - * @return An instance of OkHttpClient + * @param basePath Base path of the URL (e.g http://petstore.swagger.io/v2) + * @return An instance of ApiClient */ public ApiClient setBasePath(String basePath) { this.basePath = basePath; @@ -281,7 +281,7 @@ public OkHttpClient getHttpClient() { * Set HTTP client, which must never be null. * * @param newHttpClient An instance of OkHttpClient - * @return Api Client + * @return ApiClient * @throws java.lang.NullPointerException when newHttpClient is null */ public ApiClient setHttpClient(OkHttpClient newHttpClient) { diff --git a/samples/client/petstore/java/okhttp-gson-swagger2/src/main/java/org/openapitools/client/ApiClient.java b/samples/client/petstore/java/okhttp-gson-swagger2/src/main/java/org/openapitools/client/ApiClient.java index c7b5a4c8667f..66fdcc77daf6 100644 --- a/samples/client/petstore/java/okhttp-gson-swagger2/src/main/java/org/openapitools/client/ApiClient.java +++ b/samples/client/petstore/java/okhttp-gson-swagger2/src/main/java/org/openapitools/client/ApiClient.java @@ -232,8 +232,8 @@ public String getBasePath() { /** * Set base path * - * @param basePath Base path of the URL (e.g http://petstore.swagger.io/v2 - * @return An instance of OkHttpClient + * @param basePath Base path of the URL (e.g http://petstore.swagger.io/v2) + * @return An instance of ApiClient */ public ApiClient setBasePath(String basePath) { this.basePath = basePath; @@ -281,7 +281,7 @@ public OkHttpClient getHttpClient() { * Set HTTP client, which must never be null. * * @param newHttpClient An instance of OkHttpClient - * @return Api Client + * @return ApiClient * @throws java.lang.NullPointerException when newHttpClient is null */ public ApiClient setHttpClient(OkHttpClient newHttpClient) { diff --git a/samples/client/petstore/java/okhttp-gson/src/main/java/org/openapitools/client/ApiClient.java b/samples/client/petstore/java/okhttp-gson/src/main/java/org/openapitools/client/ApiClient.java index fb8b2af002fa..f75ac337c119 100644 --- a/samples/client/petstore/java/okhttp-gson/src/main/java/org/openapitools/client/ApiClient.java +++ b/samples/client/petstore/java/okhttp-gson/src/main/java/org/openapitools/client/ApiClient.java @@ -284,8 +284,8 @@ public String getBasePath() { /** * Set base path * - * @param basePath Base path of the URL (e.g http://petstore.swagger.io:80/v2 - * @return An instance of OkHttpClient + * @param basePath Base path of the URL (e.g http://petstore.swagger.io:80/v2) + * @return An instance of ApiClient */ public ApiClient setBasePath(String basePath) { this.basePath = basePath; @@ -333,7 +333,7 @@ public OkHttpClient getHttpClient() { * Set HTTP client, which must never be null. * * @param newHttpClient An instance of OkHttpClient - * @return Api Client + * @return ApiClient * @throws java.lang.NullPointerException when newHttpClient is null */ public ApiClient setHttpClient(OkHttpClient newHttpClient) {