fix: resolve PrimitiveType casting for OpenAPI 3.1 schemas (#4963) #4989
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -38,7 +38,7 @@ public Schema createProperty() { | |
| } | ||
| @Override | ||
| public Schema createProperty31() { | ||
| return new JsonSchema().typesItem("string").type("string"); | ||
| } | ||
| }, | ||
| BOOLEAN(Boolean.class, "boolean") { | ||
|
|
@@ -48,7 +48,7 @@ public Schema createProperty() { | |
| } | ||
| @Override | ||
| public Schema createProperty31() { | ||
| return new JsonSchema().typesItem("boolean").type("boolean"); | ||
| } | ||
| }, | ||
| BYTE(Byte.class, "byte") { | ||
|
|
@@ -63,7 +63,7 @@ public Schema createProperty() { | |
| } | ||
| @Override | ||
| public Schema createProperty31() { | ||
| return new JsonSchema().typesItem("string").type("string").format("byte"); | ||
| } | ||
| }, | ||
| BINARY(Byte.class, "binary") { | ||
|
|
@@ -78,7 +78,7 @@ public Schema createProperty() { | |
| } | ||
| @Override | ||
| public Schema createProperty31() { | ||
| return new JsonSchema().typesItem("string").type("string").format("binary"); | ||
| } | ||
| }, | ||
| URI(java.net.URI.class, "uri") { | ||
|
|
@@ -88,7 +88,7 @@ public Schema createProperty() { | |
| } | ||
| @Override | ||
| public Schema createProperty31() { | ||
| return new JsonSchema().typesItem("string").type("string").format("uri"); | ||
| } | ||
| }, | ||
| URL(java.net.URL.class, "url") { | ||
|
|
@@ -98,7 +98,7 @@ public Schema createProperty() { | |
| } | ||
| @Override | ||
| public Schema createProperty31() { | ||
| return new JsonSchema().typesItem("string").type("string").format("url"); | ||
| } | ||
| }, | ||
| EMAIL(String.class, "email") { | ||
|
|
@@ -108,7 +108,7 @@ public Schema createProperty() { | |
| } | ||
| @Override | ||
| public Schema createProperty31() { | ||
| return new JsonSchema().typesItem("string").type("string").format("email"); | ||
| } | ||
| }, | ||
| UUID(java.util.UUID.class, "uuid") { | ||
|
|
@@ -118,7 +118,7 @@ public UUIDSchema createProperty() { | |
| } | ||
| @Override | ||
| public Schema createProperty31() { | ||
| return new JsonSchema().typesItem("string").type("string").format("uuid"); | ||
| } | ||
| }, | ||
| INT(Integer.class, "integer") { | ||
|
|
@@ -128,7 +128,7 @@ public IntegerSchema createProperty() { | |
| } | ||
| @Override | ||
| public Schema createProperty31() { | ||
| return new JsonSchema().typesItem("integer").type("integer").format("int32"); | ||
| } | ||
| }, | ||
| LONG(Long.class, "long") { | ||
|
|
@@ -138,7 +138,7 @@ public Schema createProperty() { | |
| } | ||
| @Override | ||
| public Schema createProperty31() { | ||
| return new JsonSchema().typesItem("integer").type("integer").format("int64"); | ||
| } | ||
| }, | ||
| FLOAT(Float.class, "float") { | ||
|
|
@@ -148,7 +148,7 @@ public Schema createProperty() { | |
| } | ||
| @Override | ||
| public Schema createProperty31() { | ||
| return new JsonSchema().typesItem("number").type("number").format("float"); | ||
| } | ||
| }, | ||
| DOUBLE(Double.class, "double") { | ||
|
|
@@ -158,7 +158,7 @@ public Schema createProperty() { | |
| } | ||
| @Override | ||
| public Schema createProperty31() { | ||
| return new JsonSchema().typesItem("number").type("number").format("double"); | ||
| } | ||
| }, | ||
| INTEGER(java.math.BigInteger.class) { | ||
|
|
@@ -168,7 +168,7 @@ public Schema createProperty() { | |
| } | ||
| @Override | ||
| public Schema createProperty31() { | ||
| return new JsonSchema().typesItem("integer").type("integer"); | ||
| } | ||
| }, | ||
| DECIMAL(java.math.BigDecimal.class, "number") { | ||
|
|
@@ -178,7 +178,7 @@ public Schema createProperty() { | |
| } | ||
| @Override | ||
| public Schema createProperty31() { | ||
| return new JsonSchema().typesItem("number").type("number"); | ||
| } | ||
| }, | ||
| NUMBER(Number.class, "number") { | ||
|
|
@@ -188,7 +188,7 @@ public Schema createProperty() { | |
| } | ||
| @Override | ||
| public Schema createProperty31() { | ||
| return new JsonSchema().typesItem("number").type("number"); | ||
| } | ||
| }, | ||
| DATE(DateStub.class, "date") { | ||
|
|
@@ -198,7 +198,7 @@ public DateSchema createProperty() { | |
| } | ||
| @Override | ||
| public Schema createProperty31() { | ||
| return new JsonSchema().typesItem("object").type("object").format("date"); | ||
| } | ||
| }, | ||
| DATE_TIME(java.util.Date.class, "date-time") { | ||
|
|
@@ -208,7 +208,7 @@ public DateTimeSchema createProperty() { | |
| } | ||
| @Override | ||
| public Schema createProperty31() { | ||
| return new JsonSchema().typesItem("object").type("object").format("date-time"); | ||
| } | ||
| }, | ||
| PARTIAL_TIME(java.time.LocalTime.class, "partial-time") { | ||
|
|
@@ -218,7 +218,7 @@ public Schema createProperty() { | |
| } | ||
| @Override | ||
| public Schema createProperty31() { | ||
| return new JsonSchema().typesItem("object").type("object").format("partial-time"); | ||
| } | ||
| }, | ||
| FILE(java.io.File.class, "file") { | ||
|
|
@@ -228,7 +228,7 @@ public FileSchema createProperty() { | |
| } | ||
| @Override | ||
| public Schema createProperty31() { | ||
| return new JsonSchema().typesItem("string").type("string").format("binary"); | ||
| } | ||
| }, | ||
| OBJECT(Object.class) { | ||
|
|
@@ -239,7 +239,7 @@ public Schema createProperty() { | |
| } | ||
| @Override | ||
| public Schema createProperty31() { | ||
| return new JsonSchema().typesItem("object").type("object"); | ||
| } | ||
| }; | ||
|
|
||
|
|
@@ -337,6 +337,7 @@ public Schema createProperty31() { | |
| addKeys(keyClasses, NUMBER, Number.class); | ||
| addKeys(keyClasses, DATE, DateStub.class); | ||
| addKeys(keyClasses, DATE_TIME, java.util.Date.class); | ||
| // addKeys(keyClasses, PARTIAL_TIME, java.time.LocalTime.class); | ||
|
There was a problem hiding this comment. Please remove this comment |
||
| addKeys(keyClasses, FILE, java.io.File.class); | ||
| addKeys(keyClasses, OBJECT, Object.class); | ||
| KEY_CLASSES = Collections.unmodifiableMap(keyClasses); | ||
|
|
@@ -374,6 +375,9 @@ public Schema createProperty31() { | |
| addKeys(names, OBJECT, "object"); | ||
| NAMES = Collections.unmodifiableMap(names); | ||
|
|
||
| // Add "LocalTime" class mappings | ||
| enablePartialTime(); | ||
|
There was a problem hiding this comment. I think this is not a part of the solution to the #4963. Please consider creating a feature request for this change and describing why this change should be introduced. Some analysis would be necessary to confirm it's align with JSON Schema. For now please remove it |
||
|
|
||
| if (System.getenv(Schema.EXPLICIT_OBJECT_SCHEMA_PROPERTY) != null) { | ||
| explicitObjectType = Boolean.parseBoolean(System.getenv(Schema.EXPLICIT_OBJECT_SCHEMA_PROPERTY)); | ||
| } else if (System.getProperty(Schema.EXPLICIT_OBJECT_SCHEMA_PROPERTY) != null) { | ||
|
|
@@ -572,7 +576,7 @@ private static <K> void addMultiKeys(Map<K, Collection<PrimitiveType>> map, Prim | |
| } | ||
| } | ||
|
|
||
| public static class DateStub { | ||
| private DateStub() { | ||
| } | ||
| } | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,61 @@ | ||
| package io.swagger.v3.jaxrs2; | ||
|
|
||
| import io.swagger.v3.jaxrs2.resources.APIResponsesResource; | ||
| import io.swagger.v3.oas.integration.SwaggerConfiguration; | ||
| import io.swagger.v3.oas.models.OpenAPI; | ||
| import io.swagger.v3.oas.models.Operation; | ||
| import io.swagger.v3.oas.models.media.Schema; | ||
| import org.testng.annotations.BeforeMethod; | ||
| import org.testng.annotations.DataProvider; | ||
| import org.testng.annotations.Test; | ||
|
|
||
| import static org.testng.AssertJUnit.assertEquals; | ||
|
|
||
| public class APIResponsesResourceTest { | ||
| private OpenAPI openAPI; | ||
|
|
||
| // Prepare list of resource schema URLs | ||
| @DataProvider(name = "schemas") | ||
| public String[] getSchemas() { | ||
| return new String[] { | ||
| "/postStringOrEmailSchemaContent", | ||
| "/postBooleanSchemaContent", | ||
| "/postByteOrBinarySchemaContent", | ||
| "/postURISchemaContent", | ||
| "/postURLSchemaContent", | ||
| "/postUUIDSchemaContent", | ||
| "/postIntegerSchemaContent", | ||
| "/postLongSchemaContent", | ||
| "/postFloatSchemaContent", | ||
| "/postDoubleSchemaContent", | ||
| "/postBigIntegerSchemaContent", | ||
| "/postBigDecimalSchemaContent", | ||
| "/postNumberSchemaContent", | ||
| "/postDateStubSchemaContent", | ||
| "/postDateSchemaContent", | ||
| "/postLocalTimeSchemaContent", | ||
| "/postFileSchemaContent", | ||
| "/postObjectSchemaContent" | ||
| }; | ||
| } | ||
|
|
||
| @BeforeMethod | ||
| public void setUp() { | ||
| SwaggerConfiguration config = new SwaggerConfiguration().openAPI31(true); | ||
| Reader reader = new Reader(config); | ||
| openAPI = reader.read(APIResponsesResource.class); | ||
| } | ||
|
|
||
| private Schema getResponseSchema(String path) { | ||
| Operation postOperation = openAPI.getPaths().get(path).getPost(); | ||
| return postOperation.getResponses().get("200").getContent().get("*/*").getSchema(); | ||
| } | ||
|
|
||
| @Test(dataProvider = "schemas") | ||
| public void testSchemaAPIResource31(String schema) { | ||
| Schema responseSchema = getResponseSchema(schema); | ||
|
|
||
| // Value of field "type" must equal value of field "types" | ||
| assertEquals(responseSchema.getType(), responseSchema.getTypes().iterator().next()); | ||
| } | ||
| } |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The name of the method here is misleading. It returns true when empty/ null. Please rename it