Upgrades swagger parser to 2.1.1, allows ingestion of 3.1.0 specs (#13133)

* Upgrades swagger-parser

* Removes additional property and halting of spec processing

* Updates tests

* Docs updated

Author: spacether

modules/openapi-generator/pom.xml

@@ -247,11 +247,6 @@
         </plugins>
     </reporting>
     <dependencies>
-        <dependency>
-            <groupId>io.swagger.core.v3</groupId>
-            <artifactId>swagger-core</artifactId>
-            <version>${swagger-core.version}</version>
-        </dependency>
         <dependency>
             <groupId>${swagger-parser-groupid.version}</groupId>
             <artifactId>swagger-parser</artifactId>

modules/openapi-generator/src/main/java/org/openapitools/codegen/CodegenConstants.java

@@ -388,7 +388,10 @@ public static enum ENUM_PROPERTY_NAMING_TYPE {camelCase, PascalCase, snake_case,
     public static final String DISALLOW_ADDITIONAL_PROPERTIES_IF_NOT_PRESENT_DESC =
         "If false, the 'additionalProperties' implementation (set to true by default) is compliant with the OAS and JSON schema specifications. " +
         "If true (default), keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.";
-
+    public static final String UNSUPPORTED_V310_SPEC_MSG =
+                    "Generation using 3.1.0 specs is in development and is not officially supported yet. " +
+                    "If you would like to expedite development, please consider woking on the open issues in the 3.1.0 project: https://github.com/orgs/OpenAPITools/projects/4/views/1 " +
+                    "and reach out to our team on Slack at https://join.slack.com/t/openapi-generator/shared_invite/zt-12jxxd7p2-XUeQM~4pzsU9x~eGLQqX2g";
     public static final String ENUM_UNKNOWN_DEFAULT_CASE = "enumUnknownDefaultCase";
     public static final String ENUM_UNKNOWN_DEFAULT_CASE_DESC =
             "If the server adds new enum cases, that are unknown by an old spec/client, the client will fail to parse the network response." +

modules/openapi-generator/src/main/java/org/openapitools/codegen/DefaultCodegen.java

@@ -79,6 +79,7 @@
 import io.swagger.v3.oas.models.servers.ServerVariable;
 import io.swagger.v3.parser.util.SchemaTypeUtil;
 
+import static org.openapitools.codegen.CodegenConstants.UNSUPPORTED_V310_SPEC_MSG;
 import static org.openapitools.codegen.utils.OnceLogger.once;
 import static org.openapitools.codegen.utils.StringUtils.*;
 
@@ -820,6 +821,19 @@ public String toEnumVarName(String value, String datatype) {
      */
     @Override
     public void setOpenAPI(OpenAPI openAPI) {
+        String originalSpecVersion;
+        String xOriginalSwaggerVersion = "x-original-swagger-version";
+        if (openAPI.getExtensions() != null && !openAPI.getExtensions().isEmpty() && openAPI.getExtensions().containsValue(xOriginalSwaggerVersion)) {
+            originalSpecVersion = (String) openAPI.getExtensions().get(xOriginalSwaggerVersion);
+        } else {
+            originalSpecVersion = openAPI.getOpenapi();
+        }
+        Integer specMajorVersion = Integer.parseInt(originalSpecVersion.substring(0, 1));
+        Integer specMinorVersion = Integer.parseInt(originalSpecVersion.substring(2, 3));
+        boolean specVersionGreaterThanOrEqualTo310 = (specMajorVersion == 3 && specMinorVersion >= 1);
+        if (specVersionGreaterThanOrEqualTo310) {
+            LOGGER.warn(UNSUPPORTED_V310_SPEC_MSG);
+        }
         this.openAPI = openAPI;
         // Set global settings such that helper functions in ModelUtils can lookup the value
         // of the CLI option.

modules/openapi-generator/src/test/java/org/openapitools/codegen/DefaultCodegenTest.java

@@ -4245,4 +4245,12 @@ public void testFromPropertyRequiredAndOptional() {
         Assert.assertEquals(fooOptional.vars.get(0).name, "foo");
         Assert.assertEquals(fooOptional.requiredVars.size(), 0);
     }
+
+    @Test
+    public void testAssigning310SpecWorks() {
+        final OpenAPI openAPI = TestUtils.parseFlattenSpec("src/test/resources/3_1/petstore.yaml");
+        final DefaultCodegen codegen = new DefaultCodegen();
+        codegen.setOpenAPI(openAPI);
+        assertEquals(openAPI, codegen.openAPI);
+    }
 }

modules/openapi-generator/src/test/java/org/openapitools/codegen/confluencewiki/ConfluenceWikiTest.java

@@ -147,8 +147,8 @@ public void overrideEnumTest() {
         discriminator.setPropertyName("model_type");
         parentModel.setDiscriminator(discriminator);
 
-        final ComposedSchema composedSchema = new ComposedSchema()
-                .addAllOfItem(new Schema().$ref(parentModel.getName()));
+        final ComposedSchema composedSchema = new ComposedSchema();
+        composedSchema.addAllOfItem(new Schema().$ref(parentModel.getName()));
         composedSchema.setName("sample");
 
         final ConfluenceWikiCodegen codegen = new ConfluenceWikiCodegen();

modules/openapi-generator/src/test/java/org/openapitools/codegen/java/JavaModelEnumTest.java

@@ -146,8 +146,8 @@ public void overrideEnumTest() {
         discriminator.setPropertyName("model_type");
         parentModel.setDiscriminator(discriminator);
 
-        final ComposedSchema composedSchema = new ComposedSchema()
-                .addAllOfItem(new Schema().$ref(parentModel.getName()));
+        final ComposedSchema composedSchema = new ComposedSchema();
+        composedSchema.addAllOfItem(new Schema().$ref(parentModel.getName()));
         composedSchema.setName("sample");
 
         final JavaClientCodegen codegen = new JavaClientCodegen();

modules/openapi-generator/src/test/java/org/openapitools/codegen/utils/ModelUtilsTest.java

@@ -206,7 +206,8 @@ public void testReferencedParameter() {
      */
     @Test
     public void testComposedSchemasAreNotUnaliased() {
-        ComposedSchema composedSchema = new ComposedSchema().allOf(Arrays.asList(
+        ComposedSchema composedSchema = new ComposedSchema();
+        composedSchema.allOf(Arrays.asList(
                 new Schema<>().$ref("#/components/schemas/SomeSchema"),
                 new ObjectSchema()
         ));

modules/openapi-generator/src/test/java/org/openapitools/codegen/validations/oas/OpenApiSchemaValidationsTest.java

@@ -84,7 +84,8 @@ public Object[][] apacheNginxRecommendationExpectations() {
     }
 
     private ComposedSchema getOneOfSample(boolean withProperties) {
-        ComposedSchema schema = new ComposedSchema().oneOf(Arrays.asList(
+        ComposedSchema schema = new ComposedSchema();
+        schema.oneOf(Arrays.asList(
                 new StringSchema(),
                 new IntegerSchema().format("int64"))
         );
@@ -99,7 +100,8 @@ private ComposedSchema getOneOfSample(boolean withProperties) {
 
     private ComposedSchema getAllOfSample(boolean withProperties) {
         // This doesn't matter if it's realistic; it's a structural check
-        ComposedSchema schema = new ComposedSchema().allOf(Arrays.asList(
+        ComposedSchema schema = new ComposedSchema();
+        schema.allOf(Arrays.asList(
                 new StringSchema(),
                 new IntegerSchema().format("int64"))
         );
@@ -113,7 +115,8 @@ private ComposedSchema getAllOfSample(boolean withProperties) {
     }
 
     private ComposedSchema getAnyOfSample(boolean withProperties) {
-        ComposedSchema schema = new ComposedSchema().anyOf(Arrays.asList(
+        ComposedSchema schema = new ComposedSchema();
+        schema.anyOf(Arrays.asList(
                 new StringSchema(),
                 new IntegerSchema().format("int64"))
         );