openapi3filter: fix array of primitives query parameter types (#921)

danicc097 · web-flow · commit 05453ef947bd · 2024-03-09T10:39:15.000+01:00
* fix array of primitives query parameter types

* update tests

* fix parameter checks

* add test cases
diff --git a/openapi3/schema.go b/openapi3/schema.go
@@ -1737,7 +1737,7 @@ func (schema *Schema) visitJSONString(settings *schemaValidationSettings, value
 				}
 			case f.regexp == nil && f.callback != nil:
 				if err := f.callback(value); err != nil {
-					var schemaErr = &SchemaError{}
+					schemaErr := &SchemaError{}
 					if errors.As(err, &schemaErr) {
 						formatStrErr = fmt.Sprintf(`string doesn't match the format %q (%s)`, format, schemaErr.Reason)
 					} else {
diff --git a/openapi3filter/req_resp_decoder.go b/openapi3filter/req_resp_decoder.go
@@ -914,6 +914,7 @@ func findNestedSchema(parentSchema *openapi3.SchemaRef, keys []string) (*openapi
 // The function returns an error when an error happened while parse object's properties.
 func makeObject(props map[string]string, schema *openapi3.SchemaRef) (map[string]interface{}, error) {
 	obj := make(map[string]interface{})
+
 	for propName, propSchema := range schema.Value.Properties {
 		switch {
 		case propSchema.Value.Type.Is("array"):
@@ -924,7 +925,12 @@ func makeObject(props map[string]string, schema *openapi3.SchemaRef) (map[string
 					return nil, handlePropParseError([]string{propName}, err)
 				}
 			}
-			obj[propName] = vals
+
+			ivals, err := convertArrayParameterToType(vals, propSchema.Value.Items.Value.Type)
+			if err != nil {
+				return nil, handlePropParseError([]string{propName}, err)
+			}
+			obj[propName] = ivals
 		case propSchema.Value.Type.Is("object"):
 			for prop := range props {
 				if !strings.HasPrefix(prop, propName+urlDecoderDelimiter) {
@@ -943,7 +949,11 @@ func makeObject(props map[string]string, schema *openapi3.SchemaRef) (map[string
 							return nil, handlePropParseError(mapKeys, err)
 						}
 					}
-					deepSet(obj, mapKeys, vals)
+					ivals, err := convertArrayParameterToType(vals, nestedSchema.Value.Items.Value.Type)
+					if err != nil {
+						return nil, handlePropParseError(mapKeys, err)
+					}
+					deepSet(obj, mapKeys, ivals)
 					continue
 				}
 				value, err := parsePrimitive(props[prop], nestedSchema)
@@ -960,9 +970,55 @@ func makeObject(props map[string]string, schema *openapi3.SchemaRef) (map[string
 			obj[propName] = value
 		}
 	}
+
 	return obj, nil
 }
 
+func convertArrayParameterToType(strArray []string, typ *openapi3.Types) (interface{}, error) {
+	var iarr []interface{}
+	switch {
+	case typ.Permits(openapi3.TypeBoolean):
+		for _, str := range strArray {
+			if str == "" {
+				continue
+			}
+			parsedBool, err := strconv.ParseBool(str)
+			if err != nil {
+				return nil, err
+			}
+			iarr = append(iarr, parsedBool)
+		}
+	case typ.Permits(openapi3.TypeInteger):
+		for _, str := range strArray {
+			if str == "" {
+				continue
+			}
+			parsedInt, err := strconv.Atoi(str)
+			if err != nil {
+				return nil, err
+			}
+			iarr = append(iarr, parsedInt)
+		}
+	case typ.Permits(openapi3.TypeNumber):
+		for _, str := range strArray {
+			if str == "" {
+				continue
+			}
+			parsedFloat, err := strconv.ParseFloat(str, 64)
+			if err != nil {
+				return nil, err
+			}
+			iarr = append(iarr, parsedFloat)
+		}
+	case typ.Permits(openapi3.TypeString):
+		return strArray, nil
+	default:
+		return nil, fmt.Errorf("unsupported parameter array type: %s", typ)
+	}
+
+	return iarr, nil
+}
+
 func handlePropParseError(path []string, err error) error {
 	if v, ok := err.(*ParseError); ok {
 		return &ParseError{path: pathFromKeys(path), Cause: v}
diff --git a/openapi3filter/testdata/fixtures/petstore.json b/openapi3filter/testdata/fixtures/petstore.json
@@ -140,6 +140,98 @@
         }
       }
     },
+    "/pet/filter": {
+      "get": {
+        "tags": [
+          "pet"
+        ],
+        "summary": "Finds Pets by status",
+        "operationId": "filterPets",
+        "parameters": [
+          {
+            "in": "query",
+            "name": "deepFilter",
+            "style": "deepObject",
+            "explode": true,
+            "allowReserved": true,
+            "schema": {
+              "type": "object",
+              "properties": {
+                "strings": {
+                  "type": "array",
+                  "items": {
+                    "type": "string"
+                  }
+                },
+                "booleans": {
+                  "type": "array",
+                  "items": {
+                    "type": "boolean"
+                  }
+                },
+                "numbers": {
+                  "type": "array",
+                  "items": {
+                    "type": "number"
+                  }
+                },
+                "integers": {
+                  "type": "array",
+                  "items": {
+                    "type": "integer"
+                  }
+                }
+              }
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "successful operation",
+            "content": {
+              "application/xml": {
+                "schema": {
+                  "type": "array",
+                  "items": {
+                    "allOf": [
+                      {
+                        "$ref": "#/components/schemas/Pet"
+                      },
+                      {
+                        "$ref": "#/components/schemas/PetRequiredProperties"
+                      }
+                    ]
+                  }
+                }
+              },
+              "application/json": {
+                "schema": {
+                  "type": "array",
+                  "items": {
+                    "allOf": [
+                      {
+                        "$ref": "#/components/schemas/Pet"
+                      },
+                      {
+                        "$ref": "#/components/schemas/PetRequiredProperties"
+                      }
+                    ]
+                  }
+                }
+              }
+            }
+          }
+        },
+        "security": [
+          {
+            "petstore_auth": [
+              "write:pets",
+              "read:pets"
+            ]
+          }
+        ]
+      }
+    },
     "/pet/findByStatus": {
       "get": {
         "tags": [
@@ -178,8 +270,12 @@
                   "type": "array",
                   "items": {
                     "allOf": [
-                      {"$ref": "#/components/schemas/Pet"},
-                      {"$ref": "#/components/schemas/PetRequiredProperties"}
+                      {
+                        "$ref": "#/components/schemas/Pet"
+                      },
+                      {
+                        "$ref": "#/components/schemas/PetRequiredProperties"
+                      }
                     ]
                   }
                 }
@@ -189,8 +285,12 @@
                   "type": "array",
                   "items": {
                     "allOf": [
-                      {"$ref": "#/components/schemas/Pet"},
-                      {"$ref": "#/components/schemas/PetRequiredProperties"}
+                      {
+                        "$ref": "#/components/schemas/Pet"
+                      },
+                      {
+                        "$ref": "#/components/schemas/PetRequiredProperties"
+                      }
                     ]
                   }
                 }
@@ -283,8 +383,12 @@
                   "type": "array",
                   "items": {
                     "allOf": [
-                      {"$ref": "#/components/schemas/Pet"},
-                      {"$ref": "#/components/schemas/PetRequiredProperties"}
+                      {
+                        "$ref": "#/components/schemas/Pet"
+                      },
+                      {
+                        "$ref": "#/components/schemas/PetRequiredProperties"
+                      }
                     ]
                   }
                 }
@@ -294,8 +398,12 @@
                   "type": "array",
                   "items": {
                     "allOf": [
-                      {"$ref": "#/components/schemas/Pet"},
-                      {"$ref": "#/components/schemas/PetRequiredProperties"}
+                      {
+                        "$ref": "#/components/schemas/Pet"
+                      },
+                      {
+                        "$ref": "#/components/schemas/PetRequiredProperties"
+                      }
                     ]
                   }
                 }
diff --git a/openapi3filter/validation_error_test.go b/openapi3filter/validation_error_test.go

Original file line number	Diff line number	Diff line change
`@@ -1737,7 +1737,7 @@ func (schema Schema) visitJSONString(settings schemaValidationSettings, value`
`1737`	`1737`	`}`
`1738`	`1738`	`case f.regexp == nil && f.callback != nil:`
`1739`	`1739`	`if err := f.callback(value); err != nil {`
`1740`		`- var schemaErr = &SchemaError{}`
	`1740`	`+ schemaErr := &SchemaError{}`
`1741`	`1741`	`if errors.As(err, &schemaErr) {`
`1742`	`1742`	formatStrErr = fmt.Sprintf(`string doesn't match the format %q (%s)`, format, schemaErr.Reason)
`1743`	`1743`	`} else {`