Merge pull request #1204 from MikeEdgar/issue-1174

Parse `@Schema`'s defaultValue and enum entries for non-string schemas
smallrye · Aug 3, 2022 · 7fbdb4e · 7fbdb4e
2 parents 45690b0 + 94729a9
commit 7fbdb4e
Show file tree

Hide file tree

Showing 4 changed files with 76 additions and 31 deletions.
diff --git a/core/src/main/java/io/smallrye/openapi/runtime/io/schema/SchemaFactory.java b/core/src/main/java/io/smallrye/openapi/runtime/io/schema/SchemaFactory.java
@@ -181,7 +181,8 @@ public static Schema readSchema(final AnnotationScannerContext context,
         schema.setDeprecated(readAttr(annotation, SchemaConstant.PROP_DEPRECATED, defaults));
         schema.setType(readSchemaType(annotation, schema, defaults));
         schema.setExample(parseSchemaAttr(context, annotation, SchemaConstant.PROP_EXAMPLE, defaults, schema.getType()));
-        schema.setDefaultValue(readAttr(annotation, SchemaConstant.PROP_DEFAULT_VALUE, defaults));
+        schema.setDefaultValue(
+                parseSchemaAttr(context, annotation, SchemaConstant.PROP_DEFAULT_VALUE, defaults, schema.getType()));
         schema.setDiscriminator(
                 readDiscriminator(context,
                         JandexUtil.value(annotation, SchemaConstant.PROP_DISCRIMINATOR_PROPERTY),
@@ -218,7 +219,22 @@ public static Schema readSchema(final AnnotationScannerContext context,
             }
         }
 
-        List<Object> enumeration = readAttr(annotation, SchemaConstant.PROP_ENUMERATION, defaults);
+        final Schema.SchemaType type = schema.getType();
+
+        List<Object> enumeration = readAttr(annotation, SchemaConstant.PROP_ENUMERATION, (Object[] values) -> {
+            List<Object> parsed = new ArrayList<>(values.length);
+
+            if (type == Schema.SchemaType.STRING) {
+                parsed.addAll(Arrays.asList(values));
+            } else {
+                Arrays.stream(values)
+                        .map(String.class::cast)
+                        .map(v -> parseValue(context, v, type))
+                        .forEach(parsed::add);
+            }
+
+            return parsed;
+        }, defaults);
 
         if (enumeration != null && !enumeration.isEmpty()) {
             schema.setEnumeration(enumeration);
@@ -323,21 +339,24 @@ static <T> T readAttr(AnnotationInstance annotation, String propertyName, T defa
     static Object parseSchemaAttr(AnnotationScannerContext context, AnnotationInstance annotation, String propertyName,
             Map<String, Object> defaults, SchemaType schemaType) {
         return readAttr(annotation, propertyName, value -> {
-            if (!(value instanceof String)) {
-                return value;
+            if (value instanceof String) {
+                return parseValue(context, (String) value, schemaType);
             }
-            String stringValue = ((String) value);
-            if (schemaType != SchemaType.STRING) {
-                Object parsedValue;
-                for (AnnotationScannerExtension e : context.getExtensions()) {
-                    parsedValue = e.parseValue(stringValue);
-                    if (parsedValue != null) {
-                        return parsedValue;
-                    }
+            return value;
+        }, defaults);
+    }
+
+    static Object parseValue(AnnotationScannerContext context, String stringValue, SchemaType schemaType) {
+        if (schemaType != SchemaType.STRING) {
+            Object parsedValue;
+            for (AnnotationScannerExtension e : context.getExtensions()) {
+                parsedValue = e.parseValue(stringValue);
+                if (parsedValue != null) {
+                    return parsedValue;
                 }
             }
-            return stringValue;
-        }, defaults);
+        }
+        return stringValue;
     }
 
     /**

diff --git a/...java/test/io/smallrye/openapi/runtime/scanner/jakarta/MethodTargetParametersResource.java b/...java/test/io/smallrye/openapi/runtime/scanner/jakarta/MethodTargetParametersResource.java
@@ -53,8 +53,13 @@ public static class PagedResponse<T> {
             @Parameter(name = "filter:op[description]", in = ParameterIn.QUERY, description = "Operations used with the filter", schema = @Schema(type = SchemaType.STRING, enumeration = {
                     "equal", "like", "ilike", "not_equal" }, defaultValue = "equal")),
             @Parameter(name = "filter[is_enabled]", in = ParameterIn.QUERY, description = "Filtering policies by the is_enabled field."
-                    + "Defaults to true if no operand is given.", schema = @Schema(type = SchemaType.STRING, defaultValue = "true", enumeration = {
-                            "true", "false" })) })
+                    + "Defaults to true if no operand is given.", schema = @Schema(type = SchemaType.BOOLEAN, defaultValue = "true", enumeration = {
+                            "true", "false" })),
+            @Parameter(name = "X-Session-Info", in = ParameterIn.COOKIE, description = "Data about the session", schema = @Schema(type = SchemaType.OBJECT, enumeration = {
+                    "{ \"status\": \"active\" }",
+                    "{ \"status\": \"expired\" }"
+            })),
+    })
     @APIResponse(responseCode = "400", description = "Bad parameter for sorting was passed")
     @APIResponse(responseCode = "404", description = "No policies found for customer")
     @APIResponse(responseCode = "403", description = "Individual permissions missing to complete action")

diff --git a/...t/java/test/io/smallrye/openapi/runtime/scanner/javax/MethodTargetParametersResource.java b/...t/java/test/io/smallrye/openapi/runtime/scanner/javax/MethodTargetParametersResource.java
@@ -53,8 +53,13 @@ public static class PagedResponse<T> {
             @Parameter(name = "filter:op[description]", in = ParameterIn.QUERY, description = "Operations used with the filter", schema = @Schema(type = SchemaType.STRING, enumeration = {
                     "equal", "like", "ilike", "not_equal" }, defaultValue = "equal")),
             @Parameter(name = "filter[is_enabled]", in = ParameterIn.QUERY, description = "Filtering policies by the is_enabled field."
-                    + "Defaults to true if no operand is given.", schema = @Schema(type = SchemaType.STRING, defaultValue = "true", enumeration = {
-                            "true", "false" })) })
+                    + "Defaults to true if no operand is given.", schema = @Schema(type = SchemaType.BOOLEAN, defaultValue = "true", enumeration = {
+                            "true", "false" })),
+            @Parameter(name = "X-Session-Info", in = ParameterIn.COOKIE, description = "Data about the session", schema = @Schema(type = SchemaType.OBJECT, enumeration = {
+                    "{ \"status\": \"active\" }",
+                    "{ \"status\": \"expired\" }"
+            })),
+    })
     @APIResponse(responseCode = "400", description = "Bad parameter for sorting was passed")
     @APIResponse(responseCode = "404", description = "No policies found for customer")
     @APIResponse(responseCode = "403", description = "Individual permissions missing to complete action")

diff --git a/.../src/test/resources/io/smallrye/openapi/runtime/scanner/params.method-target-nojaxrs.json b/.../src/test/resources/io/smallrye/openapi/runtime/scanner/params.method-target-nojaxrs.json
@@ -48,12 +48,12 @@
             "in": "query",
             "description": "Filtering policies by the is_enabled field.Defaults to true if no operand is given.",
             "schema": {
-              "default": "true",
+              "default": true,
               "enum": [
-                "true",
-                "false"
+                true,
+                false
               ],
-              "type": "string"
+              "type": "boolean"
             }
           },
           {
@@ -105,6 +105,22 @@
               ],
               "type": "string"
             }
+          },
+          {
+            "name": "X-Session-Info",
+            "in": "cookie",
+            "description": "Data about the session",
+            "schema": {
+              "enum": [
+                {
+                  "status": "active"
+                },
+                {
+                  "status": "expired"
+                }
+              ],
+              "type": "object"
+            }
           }
         ],
         "responses": {
@@ -145,10 +161,11 @@
       "PagedResponse": {
         "type": "object",
         "properties": {
-          "data": {
-            "type": "array",
-            "items": {
-              "type": "object"
+          "meta": {
+            "type": "object",
+            "additionalProperties": {
+              "format": "int64",
+              "type": "integer"
             }
           },
           "links": {
@@ -157,11 +174,10 @@
               "type": "string"
             }
           },
-          "meta": {
-            "type": "object",
-            "additionalProperties": {
-              "format": "int64",
-              "type": "integer"
+          "data": {
+            "type": "array",
+            "items": {
+              "type": "object"
             }
           }
         }