Merge pull request #3271 from swagger-api/swos-126

fix DateSchema and DateTimeSchema example serialization

Author: frantuma

modules/swagger-core/src/main/java/io/swagger/v3/core/jackson/mixin/DateSchemaMixin.java

@@ -0,0 +1,9 @@
+package io.swagger.v3.core.jackson.mixin;
+
+import com.fasterxml.jackson.annotation.JsonFormat;
+
+public abstract class DateSchemaMixin {
+
+    @JsonFormat (shape = JsonFormat.Shape.STRING, pattern = "yyyy-MM-dd")
+    public abstract Object getExample();
+}

modules/swagger-core/src/main/java/io/swagger/v3/core/jackson/mixin/DateTimeSchemaMixin.java

@@ -0,0 +1,9 @@
+package io.swagger.v3.core.jackson.mixin;
+
+import com.fasterxml.jackson.annotation.JsonFormat;
+
+public abstract class DateTimeSchemaMixin {
+
+    @JsonFormat (shape = JsonFormat.Shape.STRING, pattern = "yyyy-MM-dd'T'HH:mm:ssXXX")
+    public abstract Object getExample();
+}

modules/swagger-core/src/main/java/io/swagger/v3/core/util/ObjectMapperFactory.java

@@ -15,6 +15,8 @@
 import com.fasterxml.jackson.dataformat.yaml.YAMLGenerator;
 import io.swagger.v3.core.jackson.SchemaSerializer;
 import io.swagger.v3.core.jackson.mixin.ComponentsMixin;
+import io.swagger.v3.core.jackson.mixin.DateSchemaMixin;
+import io.swagger.v3.core.jackson.mixin.DateTimeSchemaMixin;
 import io.swagger.v3.core.jackson.mixin.ExtensionsMixin;
 import io.swagger.v3.core.jackson.mixin.OpenAPIMixin;
 import io.swagger.v3.core.jackson.mixin.OperationMixin;
@@ -32,6 +34,8 @@
 import io.swagger.v3.oas.models.info.License;
 import io.swagger.v3.oas.models.links.Link;
 import io.swagger.v3.oas.models.links.LinkParameter;
+import io.swagger.v3.oas.models.media.DateSchema;
+import io.swagger.v3.oas.models.media.DateTimeSchema;
 import io.swagger.v3.oas.models.media.Encoding;
 import io.swagger.v3.oas.models.media.EncodingProperty;
 import io.swagger.v3.oas.models.media.MediaType;
@@ -126,6 +130,8 @@ public JsonSerializer<?> modifySerializer(
         sourceMixins.put(Tag.class, ExtensionsMixin.class);
         sourceMixins.put(XML.class, ExtensionsMixin.class);
         sourceMixins.put(Schema.class, ExtensionsMixin.class);
+        sourceMixins.put(DateSchema.class, DateSchemaMixin.class);
+        sourceMixins.put(DateTimeSchema.class, DateTimeSchemaMixin.class);
 
         mapper.setMixIns(sourceMixins);
         mapper.configure(SerializationFeature.FAIL_ON_EMPTY_BEANS, false);

modules/swagger-core/src/test/java/io/swagger/v3/core/deserialization/JsonDeserializationTest.java

@@ -258,6 +258,18 @@ public void deserializeLongSchema() throws IOException {
         assertEquals(s.getEnum().get(2), 31474836475505055L);
     }
 
+    @Test
+    public void deserializeDateExample() throws IOException {
+
+        final String jsonString = ResourceUtils.loadClassResource(getClass(), "specFiles/swos-126.yaml");
+        final OpenAPI swagger = Yaml.mapper().readValue(jsonString, OpenAPI.class);
+        assertNotNull(swagger);
+        Map<String, Schema> props = swagger.getComponents().getSchemas().get("MyModel").getProperties();
+        assertTrue(Yaml.pretty().writeValueAsString(props.get("date")).contains("example: 2019-08-05"));
+        assertTrue(Yaml.pretty().writeValueAsString(props.get("dateTime")).contains("example: 2019-08-05T12:34:56Z"));
+
+    }
+
     @Test(description = "Deserialize ref callback")
     public void testDeserializeRefCallback() throws Exception {
         String yaml = "openapi: 3.0.1\n" +

modules/swagger-core/src/test/resources/specFiles/swos-126.yaml

@@ -0,0 +1,19 @@
+openapi: 3.0.0
+info:
+  title: ExampleBuilder and date-time examples
+  version: 0.0.0
+paths: {}
+
+components:
+  schemas:
+    MyModel:
+      type: object
+      properties:
+        date:
+          type: string
+          format: date
+          example: '2019-08-05'
+        dateTime:
+          type: string
+          format: date-time
+          example: '2019-08-05T12:34:56Z'

modules/swagger-models/src/main/java/io/swagger/v3/oas/models/media/DateSchema.java

@@ -16,6 +16,7 @@
 
 package io.swagger.v3.oas.models.media;
 
+import java.text.SimpleDateFormat;
 import java.util.Date;
 import java.util.Objects;
 
@@ -50,6 +51,8 @@ protected Date cast(Object value) {
             try {
                 if (value instanceof Date) {
                     return (Date) value;
+                } else if (value instanceof String) {
+                    return new SimpleDateFormat("yyyy-MM-dd Z").parse((String)value + " UTC");
                 }
             } catch (Exception e) {
             }

modules/swagger-models/src/main/java/io/swagger/v3/oas/models/media/DateTimeSchema.java

@@ -16,6 +16,7 @@
 
 package io.swagger.v3.oas.models.media;
 
+import java.text.SimpleDateFormat;
 import java.util.Date;
 import java.util.List;
 import java.util.Objects;
@@ -51,6 +52,8 @@ protected Date cast(Object value) {
             try {
                 if (value instanceof Date) {
                     return (Date) value;
+                } else if (value instanceof String) {
+                    return new SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ssXXX").parse((String) value);
                 }
             } catch (Exception e) {
             }

modules/swagger-models/src/main/java/io/swagger/v3/oas/models/media/Schema.java

@@ -691,7 +691,7 @@ public void setExample(Object example) {
     }
 
     public Schema example(Object example) {
-        this.example = cast(example);
+        setExample(example);
         return this;
     }