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
This commit is contained in:
Ross Bender
2024-03-09 01:52:08 -06:00
committed by GitHub
parent c87ad561f1
commit cf2435f335
5612 changed files with 34853 additions and 5131 deletions

View File

@@ -22,7 +22,7 @@ import java.util.Map;
import java.util.Optional;
import javax.annotation.Generated;
@Generated(value = "org.openapitools.codegen.languages.SpringCodegen")
@Generated(value = "org.openapitools.codegen.languages.SpringCodegen", comments = "Generator version: 7.4.0-SNAPSHOT")
@Validated
@Api(value = "$another-fake?", description = "the $another-fake? API")
public interface AnotherFakeApi {

View File

@@ -34,7 +34,7 @@ import java.util.Map;
import java.util.Optional;
import javax.annotation.Generated;
@Generated(value = "org.openapitools.codegen.languages.SpringCodegen")
@Generated(value = "org.openapitools.codegen.languages.SpringCodegen", comments = "Generator version: 7.4.0-SNAPSHOT")
@Validated
@Api(value = "fake", description = "the fake API")
public interface FakeApi {

View File

@@ -22,7 +22,7 @@ import java.util.Map;
import java.util.Optional;
import javax.annotation.Generated;
@Generated(value = "org.openapitools.codegen.languages.SpringCodegen")
@Generated(value = "org.openapitools.codegen.languages.SpringCodegen", comments = "Generator version: 7.4.0-SNAPSHOT")
@Validated
@Api(value = "fake_classname_tags 123#$%^", description = "the fake_classname_tags 123#$%^ API")
public interface FakeClassnameTestApi {

View File

@@ -24,7 +24,7 @@ import java.util.Map;
import java.util.Optional;
import javax.annotation.Generated;
@Generated(value = "org.openapitools.codegen.languages.SpringCodegen")
@Generated(value = "org.openapitools.codegen.languages.SpringCodegen", comments = "Generator version: 7.4.0-SNAPSHOT")
@Validated
@Api(value = "pet", description = "Everything about your Pets")
public interface PetApi {

View File

@@ -23,7 +23,7 @@ import java.util.Map;
import java.util.Optional;
import javax.annotation.Generated;
@Generated(value = "org.openapitools.codegen.languages.SpringCodegen")
@Generated(value = "org.openapitools.codegen.languages.SpringCodegen", comments = "Generator version: 7.4.0-SNAPSHOT")
@Validated
@Api(value = "store", description = "Access to Petstore orders")
public interface StoreApi {

View File

@@ -23,7 +23,7 @@ import java.util.Map;
import java.util.Optional;
import javax.annotation.Generated;
@Generated(value = "org.openapitools.codegen.languages.SpringCodegen")
@Generated(value = "org.openapitools.codegen.languages.SpringCodegen", comments = "Generator version: 7.4.0-SNAPSHOT")
@Validated
@Api(value = "user", description = "Operations about user")
public interface UserApi {

View File

@@ -18,7 +18,7 @@ import springfox.documentation.swagger2.annotations.EnableSwagger2;
import javax.annotation.Generated;
import javax.servlet.ServletContext;
@Generated(value = "org.openapitools.codegen.languages.SpringCodegen")
@Generated(value = "org.openapitools.codegen.languages.SpringCodegen", comments = "Generator version: 7.4.0-SNAPSHOT")
@Configuration
@EnableSwagger2
public class SpringFoxConfiguration {

View File

@@ -22,7 +22,7 @@ import com.fasterxml.jackson.annotation.JsonAnySetter;
* AdditionalPropertiesAnyType
*/
@Generated(value = "org.openapitools.codegen.languages.SpringCodegen")
@Generated(value = "org.openapitools.codegen.languages.SpringCodegen", comments = "Generator version: 7.4.0-SNAPSHOT")
public class AdditionalPropertiesAnyType {
private String name;

View File

@@ -23,7 +23,7 @@ import com.fasterxml.jackson.annotation.JsonAnySetter;
* AdditionalPropertiesArray
*/
@Generated(value = "org.openapitools.codegen.languages.SpringCodegen")
@Generated(value = "org.openapitools.codegen.languages.SpringCodegen", comments = "Generator version: 7.4.0-SNAPSHOT")
public class AdditionalPropertiesArray {
private String name;

View File

@@ -22,7 +22,7 @@ import com.fasterxml.jackson.annotation.JsonAnySetter;
* AdditionalPropertiesBoolean
*/
@Generated(value = "org.openapitools.codegen.languages.SpringCodegen")
@Generated(value = "org.openapitools.codegen.languages.SpringCodegen", comments = "Generator version: 7.4.0-SNAPSHOT")
public class AdditionalPropertiesBoolean {
private String name;

View File

@@ -22,7 +22,7 @@ import javax.annotation.Generated;
* AdditionalPropertiesClass
*/
@Generated(value = "org.openapitools.codegen.languages.SpringCodegen")
@Generated(value = "org.openapitools.codegen.languages.SpringCodegen", comments = "Generator version: 7.4.0-SNAPSHOT")
public class AdditionalPropertiesClass {
@Valid

View File

@@ -22,7 +22,7 @@ import com.fasterxml.jackson.annotation.JsonAnySetter;
* AdditionalPropertiesInteger
*/
@Generated(value = "org.openapitools.codegen.languages.SpringCodegen")
@Generated(value = "org.openapitools.codegen.languages.SpringCodegen", comments = "Generator version: 7.4.0-SNAPSHOT")
public class AdditionalPropertiesInteger {
private String name;

View File

@@ -23,7 +23,7 @@ import com.fasterxml.jackson.annotation.JsonAnySetter;
* AdditionalPropertiesNumber
*/
@Generated(value = "org.openapitools.codegen.languages.SpringCodegen")
@Generated(value = "org.openapitools.codegen.languages.SpringCodegen", comments = "Generator version: 7.4.0-SNAPSHOT")
public class AdditionalPropertiesNumber {
private String name;

View File

@@ -23,7 +23,7 @@ import com.fasterxml.jackson.annotation.JsonAnySetter;
* AdditionalPropertiesObject
*/
@Generated(value = "org.openapitools.codegen.languages.SpringCodegen")
@Generated(value = "org.openapitools.codegen.languages.SpringCodegen", comments = "Generator version: 7.4.0-SNAPSHOT")
public class AdditionalPropertiesObject {
private String name;

View File

@@ -22,7 +22,7 @@ import com.fasterxml.jackson.annotation.JsonAnySetter;
* AdditionalPropertiesString
*/
@Generated(value = "org.openapitools.codegen.languages.SpringCodegen")
@Generated(value = "org.openapitools.codegen.languages.SpringCodegen", comments = "Generator version: 7.4.0-SNAPSHOT")
public class AdditionalPropertiesString {
private String name;

View File

@@ -32,7 +32,7 @@ import javax.annotation.Generated;
@JsonSubTypes.Type(value = Dog.class, name = "Dog")
})
@Generated(value = "org.openapitools.codegen.languages.SpringCodegen")
@Generated(value = "org.openapitools.codegen.languages.SpringCodegen", comments = "Generator version: 7.4.0-SNAPSHOT")
public class Animal {
private String className;

View File

@@ -22,7 +22,7 @@ import javax.annotation.Generated;
* ArrayOfArrayOfNumberOnly
*/
@Generated(value = "org.openapitools.codegen.languages.SpringCodegen")
@Generated(value = "org.openapitools.codegen.languages.SpringCodegen", comments = "Generator version: 7.4.0-SNAPSHOT")
public class ArrayOfArrayOfNumberOnly {
@Valid

View File

@@ -22,7 +22,7 @@ import javax.annotation.Generated;
* ArrayOfNumberOnly
*/
@Generated(value = "org.openapitools.codegen.languages.SpringCodegen")
@Generated(value = "org.openapitools.codegen.languages.SpringCodegen", comments = "Generator version: 7.4.0-SNAPSHOT")
public class ArrayOfNumberOnly {
@Valid

View File

@@ -22,7 +22,7 @@ import javax.annotation.Generated;
* ArrayTest
*/
@Generated(value = "org.openapitools.codegen.languages.SpringCodegen")
@Generated(value = "org.openapitools.codegen.languages.SpringCodegen", comments = "Generator version: 7.4.0-SNAPSHOT")
public class ArrayTest {
@Valid

View File

@@ -24,7 +24,7 @@ import javax.annotation.Generated;
*/
@Generated(value = "org.openapitools.codegen.languages.SpringCodegen")
@Generated(value = "org.openapitools.codegen.languages.SpringCodegen", comments = "Generator version: 7.4.0-SNAPSHOT")
public class BigCat extends Cat {
/**

View File

@@ -18,7 +18,7 @@ import javax.annotation.Generated;
* Capitalization
*/
@Generated(value = "org.openapitools.codegen.languages.SpringCodegen")
@Generated(value = "org.openapitools.codegen.languages.SpringCodegen", comments = "Generator version: 7.4.0-SNAPSHOT")
public class Capitalization {
private String smallCamel;

View File

@@ -31,7 +31,7 @@ import javax.annotation.Generated;
@JsonSubTypes.Type(value = BigCat.class, name = "BigCat")
})
@Generated(value = "org.openapitools.codegen.languages.SpringCodegen")
@Generated(value = "org.openapitools.codegen.languages.SpringCodegen", comments = "Generator version: 7.4.0-SNAPSHOT")
public class Cat extends Animal {
private Boolean declawed;

View File

@@ -18,7 +18,7 @@ import javax.annotation.Generated;
* Category
*/
@Generated(value = "org.openapitools.codegen.languages.SpringCodegen")
@Generated(value = "org.openapitools.codegen.languages.SpringCodegen", comments = "Generator version: 7.4.0-SNAPSHOT")
public class Category {
private Long id;

View File

@@ -24,7 +24,7 @@ import javax.annotation.Generated;
*/
@Generated(value = "org.openapitools.codegen.languages.SpringCodegen")
@Generated(value = "org.openapitools.codegen.languages.SpringCodegen", comments = "Generator version: 7.4.0-SNAPSHOT")
public class ChildWithNullable extends ParentWithNullable {
private String otherProperty;

View File

@@ -19,7 +19,7 @@ import javax.annotation.Generated;
*/
@ApiModel(description = "Model for testing model with \"_class\" property")
@Generated(value = "org.openapitools.codegen.languages.SpringCodegen")
@Generated(value = "org.openapitools.codegen.languages.SpringCodegen", comments = "Generator version: 7.4.0-SNAPSHOT")
public class ClassModel {
private String propertyClass;

View File

@@ -18,7 +18,7 @@ import javax.annotation.Generated;
* Client
*/
@Generated(value = "org.openapitools.codegen.languages.SpringCodegen")
@Generated(value = "org.openapitools.codegen.languages.SpringCodegen", comments = "Generator version: 7.4.0-SNAPSHOT")
public class Client {
private String client;

View File

@@ -21,7 +21,7 @@ import javax.annotation.Generated;
* ContainerDefaultValue
*/
@Generated(value = "org.openapitools.codegen.languages.SpringCodegen")
@Generated(value = "org.openapitools.codegen.languages.SpringCodegen", comments = "Generator version: 7.4.0-SNAPSHOT")
public class ContainerDefaultValue {
@Valid

View File

@@ -23,7 +23,7 @@ import javax.annotation.Generated;
*/
@Generated(value = "org.openapitools.codegen.languages.SpringCodegen")
@Generated(value = "org.openapitools.codegen.languages.SpringCodegen", comments = "Generator version: 7.4.0-SNAPSHOT")
public class Dog extends Animal {
private String breed;

View File

@@ -22,7 +22,7 @@ import javax.annotation.Generated;
* EnumArrays
*/
@Generated(value = "org.openapitools.codegen.languages.SpringCodegen")
@Generated(value = "org.openapitools.codegen.languages.SpringCodegen", comments = "Generator version: 7.4.0-SNAPSHOT")
public class EnumArrays {
/**

View File

@@ -18,7 +18,7 @@ import com.fasterxml.jackson.annotation.JsonValue;
* Gets or Sets EnumClass
*/
@Generated(value = "org.openapitools.codegen.languages.SpringCodegen")
@Generated(value = "org.openapitools.codegen.languages.SpringCodegen", comments = "Generator version: 7.4.0-SNAPSHOT")
public enum EnumClass {
_ABC("_abc"),

View File

@@ -22,7 +22,7 @@ import javax.annotation.Generated;
*/
@JsonTypeName("Enum_Test")
@Generated(value = "org.openapitools.codegen.languages.SpringCodegen")
@Generated(value = "org.openapitools.codegen.languages.SpringCodegen", comments = "Generator version: 7.4.0-SNAPSHOT")
public class EnumTest {
/**

View File

@@ -19,7 +19,7 @@ import javax.annotation.Generated;
*/
@ApiModel(description = "Must be named `File` for test.")
@Generated(value = "org.openapitools.codegen.languages.SpringCodegen")
@Generated(value = "org.openapitools.codegen.languages.SpringCodegen", comments = "Generator version: 7.4.0-SNAPSHOT")
public class File {
private String sourceURI;

View File

@@ -22,7 +22,7 @@ import javax.annotation.Generated;
* FileSchemaTestClass
*/
@Generated(value = "org.openapitools.codegen.languages.SpringCodegen")
@Generated(value = "org.openapitools.codegen.languages.SpringCodegen", comments = "Generator version: 7.4.0-SNAPSHOT")
public class FileSchemaTestClass {
private File file;

View File

@@ -26,7 +26,7 @@ import javax.annotation.Generated;
*/
@JsonTypeName("format_test")
@Generated(value = "org.openapitools.codegen.languages.SpringCodegen")
@Generated(value = "org.openapitools.codegen.languages.SpringCodegen", comments = "Generator version: 7.4.0-SNAPSHOT")
public class FormatTest {
private Integer integer;

View File

@@ -20,7 +20,7 @@ import javax.annotation.Generated;
*/
@JsonTypeName("hasOnlyReadOnly")
@Generated(value = "org.openapitools.codegen.languages.SpringCodegen")
@Generated(value = "org.openapitools.codegen.languages.SpringCodegen", comments = "Generator version: 7.4.0-SNAPSHOT")
public class HasOnlyReadOnly {
private String bar;

View File

@@ -21,7 +21,7 @@ import javax.annotation.Generated;
* MapTest
*/
@Generated(value = "org.openapitools.codegen.languages.SpringCodegen")
@Generated(value = "org.openapitools.codegen.languages.SpringCodegen", comments = "Generator version: 7.4.0-SNAPSHOT")
public class MapTest {
@Valid

View File

@@ -24,7 +24,7 @@ import javax.annotation.Generated;
* MixedPropertiesAndAdditionalPropertiesClass
*/
@Generated(value = "org.openapitools.codegen.languages.SpringCodegen")
@Generated(value = "org.openapitools.codegen.languages.SpringCodegen", comments = "Generator version: 7.4.0-SNAPSHOT")
public class MixedPropertiesAndAdditionalPropertiesClass {
private UUID uuid;

View File

@@ -21,7 +21,7 @@ import javax.annotation.Generated;
@ApiModel(description = "Model for testing model name starting with number")
@JsonTypeName("200_response")
@Generated(value = "org.openapitools.codegen.languages.SpringCodegen")
@Generated(value = "org.openapitools.codegen.languages.SpringCodegen", comments = "Generator version: 7.4.0-SNAPSHOT")
public class Model200Response {
private Integer name;

View File

@@ -20,7 +20,7 @@ import javax.annotation.Generated;
*/
@JsonTypeName("ApiResponse")
@Generated(value = "org.openapitools.codegen.languages.SpringCodegen")
@Generated(value = "org.openapitools.codegen.languages.SpringCodegen", comments = "Generator version: 7.4.0-SNAPSHOT")
public class ModelApiResponse {
private Integer code;

View File

@@ -20,7 +20,7 @@ import javax.annotation.Generated;
*/
@JsonTypeName("List")
@Generated(value = "org.openapitools.codegen.languages.SpringCodegen")
@Generated(value = "org.openapitools.codegen.languages.SpringCodegen", comments = "Generator version: 7.4.0-SNAPSHOT")
public class ModelList {
private String _123list;

View File

@@ -21,7 +21,7 @@ import javax.annotation.Generated;
@ApiModel(description = "Model for testing reserved words")
@JsonTypeName("Return")
@Generated(value = "org.openapitools.codegen.languages.SpringCodegen")
@Generated(value = "org.openapitools.codegen.languages.SpringCodegen", comments = "Generator version: 7.4.0-SNAPSHOT")
public class ModelReturn {
private Integer _return;

View File

@@ -19,7 +19,7 @@ import javax.annotation.Generated;
*/
@ApiModel(description = "Model for testing model name same as property name")
@Generated(value = "org.openapitools.codegen.languages.SpringCodegen")
@Generated(value = "org.openapitools.codegen.languages.SpringCodegen", comments = "Generator version: 7.4.0-SNAPSHOT")
public class Name {
private Integer name;

View File

@@ -20,7 +20,7 @@ import javax.annotation.Generated;
* NullableMapProperty
*/
@Generated(value = "org.openapitools.codegen.languages.SpringCodegen")
@Generated(value = "org.openapitools.codegen.languages.SpringCodegen", comments = "Generator version: 7.4.0-SNAPSHOT")
public class NullableMapProperty {
@Valid

View File

@@ -19,7 +19,7 @@ import javax.annotation.Generated;
* NumberOnly
*/
@Generated(value = "org.openapitools.codegen.languages.SpringCodegen")
@Generated(value = "org.openapitools.codegen.languages.SpringCodegen", comments = "Generator version: 7.4.0-SNAPSHOT")
public class NumberOnly {
private BigDecimal justNumber;

View File

@@ -21,7 +21,7 @@ import javax.annotation.Generated;
* Order
*/
@Generated(value = "org.openapitools.codegen.languages.SpringCodegen")
@Generated(value = "org.openapitools.codegen.languages.SpringCodegen", comments = "Generator version: 7.4.0-SNAPSHOT")
public class Order {
private Long id;

View File

@@ -19,7 +19,7 @@ import javax.annotation.Generated;
* OuterComposite
*/
@Generated(value = "org.openapitools.codegen.languages.SpringCodegen")
@Generated(value = "org.openapitools.codegen.languages.SpringCodegen", comments = "Generator version: 7.4.0-SNAPSHOT")
public class OuterComposite {
private BigDecimal myNumber;

View File

@@ -18,7 +18,7 @@ import com.fasterxml.jackson.annotation.JsonValue;
* Gets or Sets OuterEnum
*/
@Generated(value = "org.openapitools.codegen.languages.SpringCodegen")
@Generated(value = "org.openapitools.codegen.languages.SpringCodegen", comments = "Generator version: 7.4.0-SNAPSHOT")
public enum OuterEnum {
PLACED("placed"),

View File

@@ -31,7 +31,7 @@ import javax.annotation.Generated;
@JsonSubTypes.Type(value = ChildWithNullable.class, name = "ChildWithNullable")
})
@Generated(value = "org.openapitools.codegen.languages.SpringCodegen")
@Generated(value = "org.openapitools.codegen.languages.SpringCodegen", comments = "Generator version: 7.4.0-SNAPSHOT")
public class ParentWithNullable {
/**

View File

@@ -27,7 +27,7 @@ import javax.annotation.Generated;
* Pet
*/
@Generated(value = "org.openapitools.codegen.languages.SpringCodegen")
@Generated(value = "org.openapitools.codegen.languages.SpringCodegen", comments = "Generator version: 7.4.0-SNAPSHOT")
public class Pet {
private Long id;

View File

@@ -18,7 +18,7 @@ import javax.annotation.Generated;
* ReadOnlyFirst
*/
@Generated(value = "org.openapitools.codegen.languages.SpringCodegen")
@Generated(value = "org.openapitools.codegen.languages.SpringCodegen", comments = "Generator version: 7.4.0-SNAPSHOT")
public class ReadOnlyFirst {
private String bar;

View File

@@ -18,7 +18,7 @@ import javax.annotation.Generated;
* ResponseObjectWithDifferentFieldNames
*/
@Generated(value = "org.openapitools.codegen.languages.SpringCodegen")
@Generated(value = "org.openapitools.codegen.languages.SpringCodegen", comments = "Generator version: 7.4.0-SNAPSHOT")
public class ResponseObjectWithDifferentFieldNames {
private String normalPropertyName;

View File

@@ -20,7 +20,7 @@ import javax.annotation.Generated;
*/
@JsonTypeName("_special_model.name_")
@Generated(value = "org.openapitools.codegen.languages.SpringCodegen")
@Generated(value = "org.openapitools.codegen.languages.SpringCodegen", comments = "Generator version: 7.4.0-SNAPSHOT")
public class SpecialModelName {
private Long $specialPropertyName;

View File

@@ -18,7 +18,7 @@ import javax.annotation.Generated;
* Tag
*/
@Generated(value = "org.openapitools.codegen.languages.SpringCodegen")
@Generated(value = "org.openapitools.codegen.languages.SpringCodegen", comments = "Generator version: 7.4.0-SNAPSHOT")
public class Tag {
private Long id;

View File

@@ -22,7 +22,7 @@ import javax.annotation.Generated;
* TypeHolderDefault
*/
@Generated(value = "org.openapitools.codegen.languages.SpringCodegen")
@Generated(value = "org.openapitools.codegen.languages.SpringCodegen", comments = "Generator version: 7.4.0-SNAPSHOT")
public class TypeHolderDefault {
private String stringItem = "what";

View File

@@ -22,7 +22,7 @@ import javax.annotation.Generated;
* TypeHolderExample
*/
@Generated(value = "org.openapitools.codegen.languages.SpringCodegen")
@Generated(value = "org.openapitools.codegen.languages.SpringCodegen", comments = "Generator version: 7.4.0-SNAPSHOT")
public class TypeHolderExample {
private String stringItem;

View File

@@ -18,7 +18,7 @@ import javax.annotation.Generated;
* User
*/
@Generated(value = "org.openapitools.codegen.languages.SpringCodegen")
@Generated(value = "org.openapitools.codegen.languages.SpringCodegen", comments = "Generator version: 7.4.0-SNAPSHOT")
public class User {
private Long id;

View File

@@ -22,7 +22,7 @@ import javax.annotation.Generated;
* XmlItem
*/
@Generated(value = "org.openapitools.codegen.languages.SpringCodegen")
@Generated(value = "org.openapitools.codegen.languages.SpringCodegen", comments = "Generator version: 7.4.0-SNAPSHOT")
public class XmlItem {
private String attributeString;