Add support for controlling output of OpenAPI Generator version in generated files (#17952)

* add initial openapi config and java generated files * add java implementation for adding generator version * regenerate sample client files * remove tabs * only show generated version if build info exists * set build info for batch generation * update generator doc for new global flag * use existing property for generator version * update templates to include generator version * update templates for better generator version syntax * revert undesired changes * regenerate samples for openapi client * update templates to correct formatting/newlines * correct description text and add to usage doc * add generator cli option for all codegen types * use more concise version info; update existing codegens to support new prop * correct wrong prop reference * add initial test coverage for new prop * update last (scala) templates with new prop * update samples after upstream merge * use consistent version output * use better sample project id/name * revert using option for generator version in templates
2025-12-19 20:57:08 +00:00 · 2024-03-09 01:52:08 -06:00
parent c87ad561f1
commit cf2435f335
5612 changed files with 34853 additions and 5131 deletions
--- a/samples/client/echo_api/java/resteasy/src/main/java/org/openapitools/client/ApiClient.java
+++ b/samples/client/echo_api/java/resteasy/src/main/java/org/openapitools/client/ApiClient.java
@@ -47,7 +47,7 @@ import org.openapitools.client.auth.HttpBasicAuth;
 import org.openapitools.client.auth.HttpBearerAuth;
 import org.openapitools.client.auth.ApiKeyAuth;

-@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen")
+@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.4.0-SNAPSHOT")
 public class ApiClient extends JavaTimeFormatter {
  private Map<String, String> defaultHeaderMap = new HashMap<String, String>();
  private Map<String, String> defaultCookieMap = new HashMap<String, String>();
--- a/samples/client/echo_api/java/resteasy/src/main/java/org/openapitools/client/ApiException.java
+++ b/samples/client/echo_api/java/resteasy/src/main/java/org/openapitools/client/ApiException.java
@@ -16,7 +16,7 @@ package org.openapitools.client;
 import java.util.Map;
 import java.util.List;

-@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen")
+@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.4.0-SNAPSHOT")
 public class ApiException extends Exception {
    private static final long serialVersionUID = 1L;

--- a/samples/client/echo_api/java/resteasy/src/main/java/org/openapitools/client/Configuration.java
+++ b/samples/client/echo_api/java/resteasy/src/main/java/org/openapitools/client/Configuration.java
@@ -13,7 +13,7 @@

 package org.openapitools.client;

-@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen")
+@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.4.0-SNAPSHOT")
 public class Configuration {
    public static final String VERSION = "0.1.0";

--- a/samples/client/echo_api/java/resteasy/src/main/java/org/openapitools/client/JSON.java
+++ b/samples/client/echo_api/java/resteasy/src/main/java/org/openapitools/client/JSON.java
@@ -9,7 +9,7 @@ import java.text.DateFormat;

 import javax.ws.rs.ext.ContextResolver;

-@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen")
+@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.4.0-SNAPSHOT")
 public class JSON implements ContextResolver<ObjectMapper> {
  private ObjectMapper mapper;

--- a/samples/client/echo_api/java/resteasy/src/main/java/org/openapitools/client/JavaTimeFormatter.java
+++ b/samples/client/echo_api/java/resteasy/src/main/java/org/openapitools/client/JavaTimeFormatter.java
@@ -20,7 +20,7 @@ import java.time.format.DateTimeParseException;
 * Class that add parsing/formatting support for Java 8+ {@code OffsetDateTime} class.
 * It's generated for java clients when {@code AbstractJavaCodegen#dateLibrary} specified as {@code java8}.
 */
-@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen")
+@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.4.0-SNAPSHOT")
 public class JavaTimeFormatter {

    private DateTimeFormatter offsetDateTimeFormatter = DateTimeFormatter.ISO_OFFSET_DATE_TIME;
--- a/samples/client/echo_api/java/resteasy/src/main/java/org/openapitools/client/Pair.java
+++ b/samples/client/echo_api/java/resteasy/src/main/java/org/openapitools/client/Pair.java
@@ -13,7 +13,7 @@

 package org.openapitools.client;

-@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen")
+@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.4.0-SNAPSHOT")
 public class Pair {
    private String name = "";
    private String value = "";
--- a/samples/client/echo_api/java/resteasy/src/main/java/org/openapitools/client/StringUtil.java
+++ b/samples/client/echo_api/java/resteasy/src/main/java/org/openapitools/client/StringUtil.java
@@ -16,7 +16,7 @@ package org.openapitools.client;
 import java.util.Collection;
 import java.util.Iterator;

-@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen")
+@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.4.0-SNAPSHOT")
 public class StringUtil {
  /**
   * Check if the given array contains the given value (with case-insensitive comparison).
--- a/samples/client/echo_api/java/resteasy/src/main/java/org/openapitools/client/api/AuthApi.java
+++ b/samples/client/echo_api/java/resteasy/src/main/java/org/openapitools/client/api/AuthApi.java
@@ -13,7 +13,7 @@ import java.util.HashMap;
 import java.util.List;
 import java.util.Map;

-@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen")
+@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.4.0-SNAPSHOT")
 public class AuthApi {
  private ApiClient apiClient;

--- a/samples/client/echo_api/java/resteasy/src/main/java/org/openapitools/client/api/BodyApi.java
+++ b/samples/client/echo_api/java/resteasy/src/main/java/org/openapitools/client/api/BodyApi.java
@@ -17,7 +17,7 @@ import java.util.HashMap;
 import java.util.List;
 import java.util.Map;

-@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen")
+@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.4.0-SNAPSHOT")
 public class BodyApi {
  private ApiClient apiClient;

--- a/samples/client/echo_api/java/resteasy/src/main/java/org/openapitools/client/api/FormApi.java
+++ b/samples/client/echo_api/java/resteasy/src/main/java/org/openapitools/client/api/FormApi.java
@@ -13,7 +13,7 @@ import java.util.HashMap;
 import java.util.List;
 import java.util.Map;

-@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen")
+@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.4.0-SNAPSHOT")
 public class FormApi {
  private ApiClient apiClient;

--- a/samples/client/echo_api/java/resteasy/src/main/java/org/openapitools/client/api/HeaderApi.java
+++ b/samples/client/echo_api/java/resteasy/src/main/java/org/openapitools/client/api/HeaderApi.java
@@ -14,7 +14,7 @@ import java.util.HashMap;
 import java.util.List;
 import java.util.Map;

-@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen")
+@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.4.0-SNAPSHOT")
 public class HeaderApi {
  private ApiClient apiClient;

--- a/samples/client/echo_api/java/resteasy/src/main/java/org/openapitools/client/api/PathApi.java
+++ b/samples/client/echo_api/java/resteasy/src/main/java/org/openapitools/client/api/PathApi.java
@@ -14,7 +14,7 @@ import java.util.HashMap;
 import java.util.List;
 import java.util.Map;

-@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen")
+@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.4.0-SNAPSHOT")
 public class PathApi {
  private ApiClient apiClient;

--- a/samples/client/echo_api/java/resteasy/src/main/java/org/openapitools/client/api/QueryApi.java
+++ b/samples/client/echo_api/java/resteasy/src/main/java/org/openapitools/client/api/QueryApi.java
@@ -20,7 +20,7 @@ import java.util.HashMap;
 import java.util.List;
 import java.util.Map;

-@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen")
+@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.4.0-SNAPSHOT")
 public class QueryApi {
  private ApiClient apiClient;

--- a/samples/client/echo_api/java/resteasy/src/main/java/org/openapitools/client/auth/ApiKeyAuth.java
+++ b/samples/client/echo_api/java/resteasy/src/main/java/org/openapitools/client/auth/ApiKeyAuth.java
@@ -18,7 +18,7 @@ import org.openapitools.client.Pair;
 import java.util.Map;
 import java.util.List;

-@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen")
+@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.4.0-SNAPSHOT")
 public class ApiKeyAuth implements Authentication {
  private final String location;
  private final String paramName;
--- a/samples/client/echo_api/java/resteasy/src/main/java/org/openapitools/client/auth/HttpBasicAuth.java
+++ b/samples/client/echo_api/java/resteasy/src/main/java/org/openapitools/client/auth/HttpBasicAuth.java
@@ -21,7 +21,7 @@ import java.nio.charset.StandardCharsets;
 import java.util.Map;
 import java.util.List;

-@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen")
+@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.4.0-SNAPSHOT")
 public class HttpBasicAuth implements Authentication {
  private String username;
  private String password;
--- a/samples/client/echo_api/java/resteasy/src/main/java/org/openapitools/client/auth/HttpBearerAuth.java
+++ b/samples/client/echo_api/java/resteasy/src/main/java/org/openapitools/client/auth/HttpBearerAuth.java
@@ -20,7 +20,7 @@ import java.util.Map;
 import java.util.Optional;
 import java.util.function.Supplier;

-@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen")
+@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.4.0-SNAPSHOT")
 public class HttpBearerAuth implements Authentication {
  private final String scheme;
  private Supplier<String> tokenSupplier;
--- a/samples/client/echo_api/java/resteasy/src/main/java/org/openapitools/client/model/Bird.java
+++ b/samples/client/echo_api/java/resteasy/src/main/java/org/openapitools/client/model/Bird.java
@@ -30,7 +30,7 @@ import com.fasterxml.jackson.annotation.JsonTypeName;
  Bird.JSON_PROPERTY_SIZE,
  Bird.JSON_PROPERTY_COLOR
 })
-@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen")
+@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.4.0-SNAPSHOT")
 public class Bird {
  public static final String JSON_PROPERTY_SIZE = "size";
  private String size;
--- a/samples/client/echo_api/java/resteasy/src/main/java/org/openapitools/client/model/Category.java
+++ b/samples/client/echo_api/java/resteasy/src/main/java/org/openapitools/client/model/Category.java
@@ -30,7 +30,7 @@ import com.fasterxml.jackson.annotation.JsonTypeName;
  Category.JSON_PROPERTY_ID,
  Category.JSON_PROPERTY_NAME
 })
-@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen")
+@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.4.0-SNAPSHOT")
 public class Category {
  public static final String JSON_PROPERTY_ID = "id";
  private Long id;
--- a/samples/client/echo_api/java/resteasy/src/main/java/org/openapitools/client/model/DataQuery.java
+++ b/samples/client/echo_api/java/resteasy/src/main/java/org/openapitools/client/model/DataQuery.java
@@ -36,7 +36,7 @@ import com.fasterxml.jackson.annotation.JsonTypeName;
  DataQuery.JSON_PROPERTY_TEXT,
  DataQuery.JSON_PROPERTY_DATE
 })
-@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen")
+@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.4.0-SNAPSHOT")
 public class DataQuery extends Query {
  public static final String JSON_PROPERTY_SUFFIX = "suffix";
  private String suffix;
--- a/samples/client/echo_api/java/resteasy/src/main/java/org/openapitools/client/model/DefaultValue.java
+++ b/samples/client/echo_api/java/resteasy/src/main/java/org/openapitools/client/model/DefaultValue.java
@@ -44,7 +44,7 @@ import com.fasterxml.jackson.annotation.JsonTypeName;
  DefaultValue.JSON_PROPERTY_ARRAY_STRING_EXTENSION_NULLABLE,
  DefaultValue.JSON_PROPERTY_STRING_NULLABLE
 })
-@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen")
+@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.4.0-SNAPSHOT")
 public class DefaultValue {
  public static final String JSON_PROPERTY_ARRAY_STRING_ENUM_REF_DEFAULT = "array_string_enum_ref_default";
  private List<StringEnumRef> arrayStringEnumRefDefault = new ArrayList<>(Arrays.asList(StringEnumRef.SUCCESS, StringEnumRef.FAILURE));
--- a/samples/client/echo_api/java/resteasy/src/main/java/org/openapitools/client/model/NumberPropertiesOnly.java
+++ b/samples/client/echo_api/java/resteasy/src/main/java/org/openapitools/client/model/NumberPropertiesOnly.java
@@ -32,7 +32,7 @@ import com.fasterxml.jackson.annotation.JsonTypeName;
  NumberPropertiesOnly.JSON_PROPERTY_FLOAT,
  NumberPropertiesOnly.JSON_PROPERTY_DOUBLE
 })
-@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen")
+@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.4.0-SNAPSHOT")
 public class NumberPropertiesOnly {
  public static final String JSON_PROPERTY_NUMBER = "number";
  private BigDecimal number;
--- a/samples/client/echo_api/java/resteasy/src/main/java/org/openapitools/client/model/Pet.java
+++ b/samples/client/echo_api/java/resteasy/src/main/java/org/openapitools/client/model/Pet.java
@@ -39,7 +39,7 @@ import com.fasterxml.jackson.annotation.JsonTypeName;
  Pet.JSON_PROPERTY_TAGS,
  Pet.JSON_PROPERTY_STATUS
 })
-@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen")
+@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.4.0-SNAPSHOT")
 public class Pet {
  public static final String JSON_PROPERTY_ID = "id";
  private Long id;
--- a/samples/client/echo_api/java/resteasy/src/main/java/org/openapitools/client/model/Query.java
+++ b/samples/client/echo_api/java/resteasy/src/main/java/org/openapitools/client/model/Query.java
@@ -33,7 +33,7 @@ import com.fasterxml.jackson.annotation.JsonTypeName;
  Query.JSON_PROPERTY_ID,
  Query.JSON_PROPERTY_OUTCOMES
 })
-@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen")
+@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.4.0-SNAPSHOT")
 public class Query {
  public static final String JSON_PROPERTY_ID = "id";
  private Long id;
--- a/samples/client/echo_api/java/resteasy/src/main/java/org/openapitools/client/model/Tag.java
+++ b/samples/client/echo_api/java/resteasy/src/main/java/org/openapitools/client/model/Tag.java
@@ -30,7 +30,7 @@ import com.fasterxml.jackson.annotation.JsonTypeName;
  Tag.JSON_PROPERTY_ID,
  Tag.JSON_PROPERTY_NAME
 })
-@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen")
+@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.4.0-SNAPSHOT")
 public class Tag {
  public static final String JSON_PROPERTY_ID = "id";
  private Long id;
--- a/samples/client/echo_api/java/resteasy/src/main/java/org/openapitools/client/model/TestQueryStyleDeepObjectExplodeTrueObjectAllOfQueryObjectParameter.java
+++ b/samples/client/echo_api/java/resteasy/src/main/java/org/openapitools/client/model/TestQueryStyleDeepObjectExplodeTrueObjectAllOfQueryObjectParameter.java
@@ -33,7 +33,7 @@ import com.fasterxml.jackson.annotation.JsonTypeName;
  TestQueryStyleDeepObjectExplodeTrueObjectAllOfQueryObjectParameter.JSON_PROPERTY_NAME
 })
@JsonTypeName("test_query_style_deepObject_explode_true_object_allOf_query_object_parameter")
-@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen")
+@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.4.0-SNAPSHOT")
 public class TestQueryStyleDeepObjectExplodeTrueObjectAllOfQueryObjectParameter {
  public static final String JSON_PROPERTY_SIZE = "size";
  private String size;
--- a/samples/client/echo_api/java/resteasy/src/main/java/org/openapitools/client/model/TestQueryStyleFormExplodeTrueArrayStringQueryObjectParameter.java
+++ b/samples/client/echo_api/java/resteasy/src/main/java/org/openapitools/client/model/TestQueryStyleFormExplodeTrueArrayStringQueryObjectParameter.java
@@ -33,7 +33,7 @@ import com.fasterxml.jackson.annotation.JsonTypeName;
  TestQueryStyleFormExplodeTrueArrayStringQueryObjectParameter.JSON_PROPERTY_VALUES
 })
@JsonTypeName("test_query_style_form_explode_true_array_string_query_object_parameter")
-@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen")
+@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.4.0-SNAPSHOT")
 public class TestQueryStyleFormExplodeTrueArrayStringQueryObjectParameter {
  public static final String JSON_PROPERTY_VALUES = "values";
  private List<String> values;