refs #3904 - annotations support for @JsonValue types

swagger-api · Apr 17, 2021 · c1b16e6 · c1b16e6
1 parent 3a8524c
commit c1b16e6
Show file tree

Hide file tree

Showing 5 changed files with 56 additions and 2 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
@@ -376,6 +376,7 @@ public Schema resolve(AnnotatedType annotatedType, ModelConverterContext context
                     .resolveAsRef(annotatedType.isResolveAsRef())
                     .jsonViewAnnotation(annotatedType.getJsonViewAnnotation())
                     .propertyName(annotatedType.getPropertyName())
+                    .ctxAnnotations(annotatedType.getCtxAnnotations())
                     .skipOverride(true);
             return context.resolve(aType);
         }

diff --git a/modules/swagger-core/src/test/java/io/swagger/v3/core/resolving/Ticket3904Test.java b/modules/swagger-core/src/test/java/io/swagger/v3/core/resolving/Ticket3904Test.java
@@ -0,0 +1,52 @@
+package io.swagger.v3.core.resolving;
+
+import com.fasterxml.jackson.annotation.JsonValue;
+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.oas.models.media.Schema;
+import org.testng.annotations.Test;
+
+public class Ticket3904Test extends SwaggerTestBase {
+
+    @Test
+    public void testJsonValueSchemaAnnotation() throws Exception {
+
+        final ModelResolver modelResolver = new ModelResolver(mapper());
+
+        ModelConverterContextImpl context = new ModelConverterContextImpl(modelResolver);
+
+        Schema model = context
+                .resolve(new AnnotatedType(Request.class));
+
+        SerializationMatchers.assertEqualsToYaml(context.getDefinedModels(), "Request:\n" +
+                "  type: object\n" +
+                "  properties:\n" +
+                "    id:\n" +
+                "      type: string\n" +
+                "      description: Description of ID.");
+
+    }
+
+    static class Request {
+        @io.swagger.v3.oas.annotations.media.Schema(description = "Description of ID.")
+        private Id id;
+
+        public Id getId() {
+            return id;
+        }
+
+        public void setId(Id id) {
+            this.id = id;
+        }
+    }
+    static class Id {
+        private String value;
+
+        @JsonValue
+        public String getValue() {
+            return value;
+        }
+    }
+}
diff --git a/modules/swagger-gradle-plugin/build.gradle b/modules/swagger-gradle-plugin/build.gradle
@@ -46,6 +46,7 @@ dependencies {
     testImplementation "org.eclipse.jetty:jetty-proxy:${project.jettyVersion}"
     testImplementation "org.apache.httpcomponents:httpclient:4.5.13"
     testImplementation "commons-codec:commons-codec:1.15"
+    testImplementation "commons-io:commons-io:2.7"
     testImplementation "org.apache.commons:commons-compress:1.20"
 }
 

diff --git a/modules/swagger-project-jakarta/pom.xml b/modules/swagger-project-jakarta/pom.xml
@@ -569,7 +569,7 @@
         <guava-version>30.1-jre</guava-version>
         <ant-version>1.10.9</ant-version>
         <commons-lang-version>3.7</commons-lang-version>
-        <commons-io-version>2.6</commons-io-version>
+        <commons-io-version>2.7</commons-io-version>
         <slf4j-version>1.7.25</slf4j-version>
         <jetty-version>9.4.39.v20210325</jetty-version>
         <testng-version>7.3.0</testng-version>

diff --git a/pom.xml b/pom.xml
@@ -630,7 +630,7 @@
         <guava-version>30.1-jre</guava-version>
         <ant-version>1.10.9</ant-version>
         <commons-lang-version>3.7</commons-lang-version>
-        <commons-io-version>2.6</commons-io-version>
+        <commons-io-version>2.7</commons-io-version>
         <slf4j-version>1.7.25</slf4j-version>
         <jetty-version>9.4.39.v20210325</jetty-version>
         <testng-version>7.3.0</testng-version>