Merge pull request #4612 from swagger-api/SWG-9981-Fix-explode-bug

micryc · web-flow · commit 2344ce4c9c0c · 2024-02-05T12:15:09.000+01:00
Fix isExplode method and explode tests
diff --git a/modules/swagger-core/src/main/java/io/swagger/v3/core/util/AnnotationsUtils.java b/modules/swagger-core/src/main/java/io/swagger/v3/core/util/AnnotationsUtils.java
@@ -1411,7 +1411,7 @@ public static void setHeaderExplode (Header header, io.swagger.v3.oas.annotation
     }
 
     private static boolean isHeaderExplodable(io.swagger.v3.oas.annotations.headers.Header h, Header header) {
-        io.swagger.v3.oas.annotations.media.Schema schema = h.schema();
+        io.swagger.v3.oas.annotations.media.Schema schema = hasArrayAnnotation(h.array()) ? h.array().schema() : h.schema();
         boolean explode = true;
         if (schema != null) {
             Class implementation = schema.implementation();
diff --git a/modules/swagger-core/src/main/java/io/swagger/v3/core/util/ParameterProcessor.java b/modules/swagger-core/src/main/java/io/swagger/v3/core/util/ParameterProcessor.java
@@ -234,7 +234,7 @@ public static void setParameterExplode(Parameter parameter, io.swagger.v3.oas.an
     }
 
     private static boolean isExplodable(io.swagger.v3.oas.annotations.Parameter p, Parameter parameter) {
-        io.swagger.v3.oas.annotations.media.Schema schema = p.schema();
+        io.swagger.v3.oas.annotations.media.Schema schema = AnnotationsUtils.hasArrayAnnotation(p.array()) ? p.array().schema() : p.schema();
         boolean explode = true;
         if ("form".equals(parameter.getIn())){
             return true;
diff --git a/modules/swagger-jaxrs2/src/test/java/io/swagger/v3/jaxrs2/annotations/operations/AnnotatedOperationMethodTest.java b/modules/swagger-jaxrs2/src/test/java/io/swagger/v3/jaxrs2/annotations/operations/AnnotatedOperationMethodTest.java
@@ -582,6 +582,7 @@ public void testOperationWithResponseMultipleHeadersImplementationSchema() {
                 "            Rate-Limit-Limit:\n" +
                 "              description: The number of allowed requests in the current period\n" +
                 "              style: simple\n" +
+                "              explode: true\n" +
                 "              schema:\n" +
                 "                maxItems: 10\n" +
                 "                minItems: 1\n" +
diff --git a/modules/swagger-jaxrs2/src/test/java/io/swagger/v3/jaxrs2/annotations/parameters/ParametersTest.java b/modules/swagger-jaxrs2/src/test/java/io/swagger/v3/jaxrs2/annotations/parameters/ParametersTest.java
@@ -88,6 +88,7 @@ public void testParameters() {
                 "      - name: arrayParameter\n" +
                 "        in: query\n" +
                 "        required: true\n" +
+                "        explode: true\n" +
                 "        content:\n" +
                 "          application/json:\n" +
                 "            schema:\n" +
@@ -102,6 +103,7 @@ public void testParameters() {
                 "      - name: arrayParameterImplementation\n" +
                 "        in: query\n" +
                 "        required: true\n" +
+                "        explode: true\n" +
                 "        schema:\n" +
                 "          maxItems: 10\n" +
                 "          minItems: 1\n" +
@@ -148,6 +150,7 @@ public void testArraySchemaParameters() {
                 "      - name: arrayParameter\n" +
                 "        in: query\n" +
                 "        required: true\n" +
+                "        explode: true\n" +
                 "        schema:\n" +
                 "          maxItems: 10\n" +
                 "          minItems: 1\n" +
@@ -220,6 +223,7 @@ public void testRepeatableParameters() {
                 "      - name: arrayParameter\n" +
                 "        in: query\n" +
                 "        required: true\n" +
+                "        explode: true\n" +
                 "        content:\n" +
                 "          application/json:\n" +
                 "            schema:\n" +
@@ -234,6 +238,7 @@ public void testRepeatableParameters() {
                 "      - name: arrayParameterImplementation\n" +
                 "        in: query\n" +
                 "        required: true\n" +
+                "        explode: true\n" +
                 "        schema:\n" +
                 "          maxItems: 10\n" +
                 "          minItems: 1\n" +
diff --git a/modules/swagger-jaxrs2/src/test/resources/petstore/FullPetResource.yaml b/modules/swagger-jaxrs2/src/test/resources/petstore/FullPetResource.yaml
@@ -631,6 +631,7 @@ paths:
       - name: arrayParameter
         in: query
         required: true
+        explode: true
         schema:
           maxItems: 10
           minItems: 1
@@ -787,6 +788,7 @@ paths:
       - name: arrayParameter
         in: query
         required: true
+        explode: true
         content:
           application/json:
             schema:
@@ -801,6 +803,7 @@ paths:
       - name: arrayParameterImplementation
         in: query
         required: true
+        explode: true
         schema:
           maxItems: 10
           minItems: 1
@@ -868,6 +871,7 @@ paths:
       - name: arrayParameter
         in: query
         required: true
+        explode: true
         content:
           application/json:
             schema:
@@ -882,6 +886,7 @@ paths:
       - name: arrayParameterImplementation
         in: query
         required: true
+        explode: true
         schema:
           maxItems: 10
           minItems: 1
diff --git a/modules/swagger-jaxrs2/src/test/resources/petstore/parameters/ArraySchemaResource.yaml b/modules/swagger-jaxrs2/src/test/resources/petstore/parameters/ArraySchemaResource.yaml
@@ -10,6 +10,7 @@ paths:
       - name: arrayParameter
         in: query
         required: true
+        explode: true
         schema:
           maxItems: 10
           minItems: 1
diff --git a/modules/swagger-jaxrs2/src/test/resources/petstore/parameters/Parameters31Resource.yaml b/modules/swagger-jaxrs2/src/test/resources/petstore/parameters/Parameters31Resource.yaml
@@ -44,6 +44,7 @@ paths:
         - name: arrayParameter
           in: query
           required: true
+          explode: true
           content:
             application/json:
               schema:
@@ -58,6 +59,7 @@ paths:
         - name: arrayParameterImplementation
           in: query
           required: true
+          explode: true
           schema:
             type: array
             contains: {}
diff --git a/modules/swagger-jaxrs2/src/test/resources/petstore/parameters/ParametersResource.yaml b/modules/swagger-jaxrs2/src/test/resources/petstore/parameters/ParametersResource.yaml
@@ -42,6 +42,7 @@ paths:
       - name: arrayParameter
         in: query
         required: true
+        explode: true
         content:
           application/json:
             schema:
@@ -56,6 +57,7 @@ paths:
       - name: arrayParameterImplementation
         in: query
         required: true
+        explode: true
         schema:
           maxItems: 10
           minItems: 1
diff --git a/modules/swagger-jaxrs2/src/test/resources/petstore/parameters/RepeatableParametersResource.yaml b/modules/swagger-jaxrs2/src/test/resources/petstore/parameters/RepeatableParametersResource.yaml
@@ -42,6 +42,7 @@ paths:
       - name: arrayParameter
         in: query
         required: true
+        explode: true
         content:
           application/json:
             schema:
@@ -56,6 +57,7 @@ paths:
       - name: arrayParameterImplementation
         in: query
         required: true
+        explode: true
         schema:
           maxItems: 10
           minItems: 1

Original file line number	Diff line number	Diff line change
`@@ -1411,7 +1411,7 @@ public static void setHeaderExplode (Header header, io.swagger.v3.oas.annotation`
`1411`	`1411`	`}`
`1412`	`1412`
`1413`	`1413`	`private static boolean isHeaderExplodable(io.swagger.v3.oas.annotations.headers.Header h, Header header) {`
`1414`		`- io.swagger.v3.oas.annotations.media.Schema schema = h.schema();`
	`1414`	`+ io.swagger.v3.oas.annotations.media.Schema schema = hasArrayAnnotation(h.array()) ? h.array().schema() : h.schema();`
`1415`	`1415`	`boolean explode = true;`
`1416`	`1416`	`if (schema != null) {`
`1417`	`1417`	`Class implementation = schema.implementation();`
Original file line number	Diff line number	Diff line change
`@@ -234,7 +234,7 @@ public static void setParameterExplode(Parameter parameter, io.swagger.v3.oas.an`
`234`	`234`	`}`
`235`	`235`
`236`	`236`	`private static boolean isExplodable(io.swagger.v3.oas.annotations.Parameter p, Parameter parameter) {`
`237`		`- io.swagger.v3.oas.annotations.media.Schema schema = p.schema();`
	`237`	`+ io.swagger.v3.oas.annotations.media.Schema schema = AnnotationsUtils.hasArrayAnnotation(p.array()) ? p.array().schema() : p.schema();`
`238`	`238`	`boolean explode = true;`
`239`	`239`	`if ("form".equals(parameter.getIn())){`
`240`	`240`	`return true;`