Merge pull request #3921 from swagger-api/ticket-3920

swagger-api · Apr 9, 2021 · 6b518c9 · 6b518c9
2 parents 438230d + b295b11
commit 6b518c9
Show file tree

Hide file tree

Showing 13 changed files with 133 additions and 35 deletions.
diff --git a/modules/swagger-core/src/main/java/io/swagger/v3/core/jackson/ModelResolver.java b/modules/swagger-core/src/main/java/io/swagger/v3/core/jackson/ModelResolver.java
@@ -865,6 +865,7 @@ public Schema resolve(AnnotatedType annotatedType, ModelConverterContext context
         }
 
         resolveDiscriminatorProperty(type, context, model);
+        model = resolveWrapping(type, context, model);
 
         return model;
     }
@@ -1770,6 +1771,32 @@ protected void resolveDiscriminatorProperty(JavaType type, ModelConverterContext
         }
     }
 
+    /*
+     TODO partial implementation supporting WRAPPER_OBJECT with JsonTypeInfo.Id.CLASS and JsonTypeInfo.Id.NAME
+
+     Also note that JsonTypeInfo on interfaces are not considered as multiple interfaces might have conflicting
+     annotations, although Jackson seems to apply them if present on an interface
+     */
+    protected Schema resolveWrapping(JavaType type, ModelConverterContext context, Schema model) {
+        // add JsonTypeInfo.property if not member of bean
+        JsonTypeInfo typeInfo = type.getRawClass().getDeclaredAnnotation(JsonTypeInfo.class);
+        if (typeInfo != null) {
+            JsonTypeInfo.Id id = typeInfo.use();
+            JsonTypeInfo.As as = typeInfo.include();
+            if (JsonTypeInfo.As.WRAPPER_OBJECT.equals(as)) {
+                String name = model.getName();
+                if (JsonTypeInfo.Id.CLASS.equals(id)) {
+                    name = type.getRawClass().getName();
+                }
+                Schema wrapperSchema = new ObjectSchema();
+                wrapperSchema.name(model.getName());
+                wrapperSchema.addProperties(name, model);
+                return wrapperSchema;
+            }
+        }
+        return model;
+    }
+
     protected Discriminator resolveDiscriminator(JavaType type, ModelConverterContext context) {
 
         io.swagger.v3.oas.annotations.media.Schema declaredSchemaAnnotation = AnnotationsUtils.getSchemaDeclaredAnnotation(type.getRawClass());

diff --git a/modules/swagger-core/src/test/java/io/swagger/v3/core/converting/ModelConverterTest.java b/modules/swagger-core/src/test/java/io/swagger/v3/core/converting/ModelConverterTest.java
@@ -130,7 +130,7 @@ public void maintainPropertyNames() {
     public void serializeParameterizedType() {
         final Map<String, Schema> schemas = readAll(Employee.class);
 
-        final Schema employee = (Schema) schemas.get("employee");
+        final Schema employee = (Schema) schemas.get("employee").getProperties().get("employee");
         final Map<String, Schema> props = employee.getProperties();
         final Iterator<String> et = props.keySet().iterator();
 

diff --git a/modules/swagger-core/src/test/java/io/swagger/v3/core/resolving/Ticket2862SubtypeTest.java b/modules/swagger-core/src/test/java/io/swagger/v3/core/resolving/Ticket2862SubtypeTest.java
@@ -20,13 +20,16 @@ public void testSubType() throws Exception {
 
         SerializationMatchers.assertEqualsToYaml(context.getDefinedModels(), "Ticket2862Model:\n" +
                 "  type: object\n" +
+                "  properties:\n" +
+                "    Ticket2862Model:\n" +
+                "      type: object\n" +
                 "Ticket2862ModelImpl:\n" +
                 "  type: string\n" +
                 "  allOf:\n" +
                 "  - $ref: '#/components/schemas/Ticket2862Model'\n" +
                 "  enum:\n" +
                 "  - VALUE1\n" +
-                "  - VALUE2");
+                "  - VALUE2\n");
     }
 
 }
diff --git a/modules/swagger-core/src/test/java/io/swagger/v3/core/resolving/Ticket2884Test.java b/modules/swagger-core/src/test/java/io/swagger/v3/core/resolving/Ticket2884Test.java
@@ -0,0 +1,48 @@
+package io.swagger.v3.core.resolving;
+
+import io.swagger.v3.core.converter.AnnotatedType;
+import io.swagger.v3.core.converter.ModelConverterContextImpl;
+import io.swagger.v3.core.jackson.ModelResolver;
+import io.swagger.v3.core.matchers.SerializationMatchers;
+import io.swagger.v3.core.resolving.resources.Ticket2884Model;
+import io.swagger.v3.core.resolving.resources.Ticket2884ModelClass;
+import io.swagger.v3.oas.models.media.Schema;
+import org.testng.annotations.Test;
+
+public class Ticket2884Test extends SwaggerTestBase {
+    @Test
+    public void test2884() throws Exception {
+        final ModelResolver modelResolver = new ModelResolver(mapper());
+
+        ModelConverterContextImpl context = new ModelConverterContextImpl(modelResolver);
+
+        Ticket2884ModelClass a = new Ticket2884ModelClass();
+
+        Schema model = context
+                .resolve(new AnnotatedType(Ticket2884Model.class));
+
+        SerializationMatchers.assertEqualsToYaml(context.getDefinedModels(), "Ticket2884Model:\n" +
+                "  type: object\n" +
+                "  properties:\n" +
+                "    Ticket2884Model:\n" +
+                "      type: object");
+
+        context = new ModelConverterContextImpl(modelResolver);
+        model = context
+                .resolve(new AnnotatedType(Ticket2884ModelClass.class));
+
+        SerializationMatchers.assertEqualsToYaml(context.getDefinedModels(), "Ticket2884ModelClass:\n" +
+                "  type: object\n" +
+                "  properties:\n" +
+                "    Ticket2884ModelClass:\n" +
+                "      type: object\n" +
+                "      properties:\n" +
+                "        bar:\n" +
+                "          type: string\n" +
+                "        foo:\n" +
+                "          type: array\n" +
+                "          items:\n" +
+                "            type: string\n");
+    }
+
+}
diff --git a/modules/swagger-core/src/test/java/io/swagger/v3/core/resolving/Ticket2915Test.java b/modules/swagger-core/src/test/java/io/swagger/v3/core/resolving/Ticket2915Test.java
@@ -5,7 +5,6 @@
 import io.swagger.v3.core.jackson.ModelResolver;
 import io.swagger.v3.core.matchers.SerializationMatchers;
 import io.swagger.v3.core.resolving.resources.TestObject2915;
-import io.swagger.v3.core.resolving.resources.Ticket2862Model;
 import io.swagger.v3.oas.models.media.Schema;
 import org.testng.annotations.Test;
 

diff --git a/...es/swagger-core/src/test/java/io/swagger/v3/core/resolving/resources/Ticket2884Model.java b/...es/swagger-core/src/test/java/io/swagger/v3/core/resolving/resources/Ticket2884Model.java
@@ -0,0 +1,6 @@
+package io.swagger.v3.core.resolving.resources;
+
+@com.fasterxml.jackson.annotation.JsonTypeInfo(
+        use = com.fasterxml.jackson.annotation.JsonTypeInfo.Id.NAME,
+        include = com.fasterxml.jackson.annotation.JsonTypeInfo.As.WRAPPER_OBJECT)
+public interface Ticket2884Model {}
diff --git a/...agger-core/src/test/java/io/swagger/v3/core/resolving/resources/Ticket2884ModelClass.java b/...agger-core/src/test/java/io/swagger/v3/core/resolving/resources/Ticket2884ModelClass.java
@@ -0,0 +1,13 @@
+package io.swagger.v3.core.resolving.resources;
+
+import java.util.List;
+
+@com.fasterxml.jackson.annotation.JsonTypeInfo(
+        use = com.fasterxml.jackson.annotation.JsonTypeInfo.Id.NAME,
+        include = com.fasterxml.jackson.annotation.JsonTypeInfo.As.WRAPPER_OBJECT)
+public class Ticket2884ModelClass {
+
+    public String bar;
+    public List<String> foo;
+
+}
diff --git a/modules/swagger-gradle-plugin/build.gradle b/modules/swagger-gradle-plugin/build.gradle
@@ -25,7 +25,15 @@ dependencies {
     implementation 'org.apache.commons:commons-lang3:3.7'
 
     testImplementation gradleTestKit()
-    testImplementation 'com.github.tomakehurst:wiremock:2.27.2'
+    testImplementation('com.github.tomakehurst:wiremock:2.27.2') {
+        exclude group: 'com.jayway.jsonpath', module: 'json-path'
+        exclude group: 'org.eclipse.jetty', module: 'jetty-server'
+        exclude group: 'org.eclipse.jetty', module: 'jetty-servlet'
+        exclude group: 'org.eclipse.jetty', module: 'jetty-servlets'
+        exclude group: 'org.eclipse.jetty', module: 'jetty-webapp'
+        exclude group: 'org.eclipse.jetty', module: 'jetty-proxy'
+        exclude group: 'commons-codec', module: 'commons-codec'
+    }
     testImplementation 'javax.servlet:javax.servlet-api:3.1.0'
     testImplementation 'com.google.guava:guava:30.1-jre'
     testImplementation 'javax.ws.rs:javax.ws.rs-api:2.1'
@@ -39,15 +47,6 @@ dependencies {
     testImplementation "org.apache.httpcomponents:httpclient:4.5.13"
     testImplementation "commons-codec:commons-codec:1.15"
     testImplementation "org.apache.commons:commons-compress:1.20"
-
-    testImplementation('com.github.tomakehurst:wiremock:2.27.2') {
-        exclude group: 'org.eclipse.jetty', module: 'jetty-server'
-        exclude group: 'org.eclipse.jetty', module: 'jetty-servlet'
-        exclude group: 'org.eclipse.jetty', module: 'jetty-servlets'
-        exclude group: 'org.eclipse.jetty', module: 'jetty-webapp'
-        exclude group: 'org.eclipse.jetty', module: 'jetty-proxy'
-        exclude group: 'commons-codec', module: 'commons-codec'
-    }
 }
 
 // * * * * * * * * * * * *

diff --git a/modules/swagger-gradle-plugin/gradle.properties b/modules/swagger-gradle-plugin/gradle.properties
@@ -1,2 +1,2 @@
 version=2.1.8-SNAPSHOT
-jettyVersion=9.4.35.v20201120
+jettyVersion=9.4.39.v20210325
diff --git a/modules/swagger-jaxrs2/pom.xml b/modules/swagger-jaxrs2/pom.xml
@@ -57,24 +57,6 @@
                     </execution>
                 </executions>
             </plugin>
-            <plugin>
-                <groupId>org.apache.maven.plugins</groupId>
-                <artifactId>maven-failsafe-plugin</artifactId>
-                <version>${failsafe-plugin-version}</version>
-                <executions>
-                    <execution>
-                        <goals>
-                            <goal>integration-test</goal>
-                            <goal>verify</goal>
-                        </goals>
-                        <configuration>
-                            <systemPropertyVariables>
-                                <jetty.port>${jetty.port}</jetty.port>
-                            </systemPropertyVariables>
-                        </configuration>
-                    </execution>
-                </executions>
-            </plugin>
             <plugin>
                 <groupId>org.eclipse.jetty</groupId>
                 <artifactId>jetty-maven-plugin</artifactId>
@@ -83,6 +65,9 @@
                     <httpConnector><port>${jetty.port}</port></httpConnector>
                     <stopKey>a</stopKey>
                     <stopPort>${jetty.port.stop}</stopPort>
+                    <supportedPackagings>
+                        <supportedPackaging>jar</supportedPackaging>
+                    </supportedPackagings>
                     <useTestScope>true</useTestScope>
                     <webAppSourceDirectory>${project.basedir}/src/test/webapp</webAppSourceDirectory>
                 </configuration>
@@ -106,6 +91,24 @@
                     </execution>
                 </executions>
             </plugin>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-failsafe-plugin</artifactId>
+                <version>${failsafe-plugin-version}</version>
+                <executions>
+                    <execution>
+                        <goals>
+                            <goal>integration-test</goal>
+                            <goal>verify</goal>
+                        </goals>
+                        <configuration>
+                            <systemPropertyVariables>
+                                <jetty.port>${jetty.port}</jetty.port>
+                            </systemPropertyVariables>
+                        </configuration>
+                    </execution>
+                </executions>
+            </plugin>
             <plugin>
                 <groupId>io.swagger.core.v3</groupId>
                 <artifactId>swagger-eclipse-transformer-maven-plugin</artifactId>

diff --git a/modules/swagger-maven-plugin/pom.xml b/modules/swagger-maven-plugin/pom.xml
@@ -273,7 +273,7 @@
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
         <maven.version>3.6.3</maven.version>
         <junit.version>4.13.1</junit.version>
-        <wiremock-jetty-version>9.4.35.v20201120</wiremock-jetty-version>
+        <wiremock-jetty-version>9.4.39.v20210325</wiremock-jetty-version>
         <commons-compress-version>1.20</commons-compress-version>
     </properties>
 </project>
diff --git a/modules/swagger-project-jakarta/pom.xml b/modules/swagger-project-jakarta/pom.xml
@@ -571,7 +571,7 @@
         <commons-lang-version>3.7</commons-lang-version>
         <commons-io-version>2.6</commons-io-version>
         <slf4j-version>1.7.25</slf4j-version>
-        <jetty-version>9.4.9.v20180320</jetty-version>
+        <jetty-version>9.4.39.v20210325</jetty-version>
         <testng-version>7.3.0</testng-version>
         <mockito-version>2.28.2</mockito-version>
         <rest-assured-version>4.3.2</rest-assured-version>

diff --git a/pom.xml b/pom.xml
@@ -632,7 +632,7 @@
         <commons-lang-version>3.7</commons-lang-version>
         <commons-io-version>2.6</commons-io-version>
         <slf4j-version>1.7.25</slf4j-version>
-        <jetty-version>9.4.9.v20180320</jetty-version>
+        <jetty-version>9.4.39.v20210325</jetty-version>
         <testng-version>7.3.0</testng-version>
         <mockito-version>2.28.2</mockito-version>
         <rest-assured-version>4.3.2</rest-assured-version>