feat: use openapi array to validate filter parameters

src/Api/QueryParameterValidator/Validator/ArrayItems.php

@@ -15,6 +15,8 @@
 
 final class ArrayItems implements ValidatorInterface
 {
+    use CheckFilterDeprecationsTrait;
+
     /**
      * {@inheritdoc}
      */
@@ -24,9 +26,11 @@ public function validate(string $name, array $filterDescription, array $queryPar
             return [];
         }
 
-        $maxItems = $filterDescription['swagger']['maxItems'] ?? null;
-        $minItems = $filterDescription['swagger']['minItems'] ?? null;
-        $uniqueItems = $filterDescription['swagger']['uniqueItems'] ?? false;
+        $this->checkFilterDeprecations($filterDescription);
+
+        $maxItems = $filterDescription['openapi']['maxItems'] ?? $filterDescription['swagger']['maxItems'] ?? null;
+        $minItems = $filterDescription['openapi']['minItems'] ?? $filterDescription['swagger']['minItems'] ?? null;
+        $uniqueItems = $filterDescription['openapi']['uniqueItems'] ?? $filterDescription['swagger']['uniqueItems'] ?? false;
 
         $errorList = [];
 
@@ -60,7 +64,7 @@ private function getValue(string $name, array $filterDescription, array $queryPa
             return $value;
         }
 
-        $collectionFormat = $filterDescription['swagger']['collectionFormat'] ?? 'csv';
+        $collectionFormat = $filterDescription['openapi']['collectionFormat'] ?? $filterDescription['swagger']['collectionFormat'] ?? 'csv';
 
         return explode(self::getSeparator($collectionFormat), (string) $value) ?: []; // @phpstan-ignore-line
     }

src/Api/QueryParameterValidator/Validator/Bounds.php

@@ -15,6 +15,8 @@
 
 final class Bounds implements ValidatorInterface
 {
+    use CheckFilterDeprecationsTrait;
+
     /**
      * {@inheritdoc}
      */
@@ -25,21 +27,23 @@ public function validate(string $name, array $filterDescription, array $queryPar
             return [];
         }
 
-        $maximum = $filterDescription['swagger']['maximum'] ?? null;
-        $minimum = $filterDescription['swagger']['minimum'] ?? null;
+        $this->checkFilterDeprecations($filterDescription);
+
+        $maximum = $filterDescription['openapi']['maximum'] ?? $filterDescription['swagger']['maximum'] ?? null;
+        $minimum = $filterDescription['openapi']['minimum'] ?? $filterDescription['swagger']['minimum'] ?? null;
 
         $errorList = [];
 
         if (null !== $maximum) {
-            if (($filterDescription['swagger']['exclusiveMaximum'] ?? false) && $value >= $maximum) {
+            if (($filterDescription['openapi']['exclusiveMaximum'] ?? $filterDescription['swagger']['exclusiveMaximum'] ?? false) && $value >= $maximum) {
                 $errorList[] = sprintf('Query parameter "%s" must be less than %s', $name, $maximum);
             } elseif ($value > $maximum) {
                 $errorList[] = sprintf('Query parameter "%s" must be less than or equal to %s', $name, $maximum);
             }
         }
 
         if (null !== $minimum) {
-            if (($filterDescription['swagger']['exclusiveMinimum'] ?? false) && $value <= $minimum) {
+            if (($filterDescription['openapi']['exclusiveMinimum'] ?? $filterDescription['swagger']['exclusiveMinimum'] ?? false) && $value <= $minimum) {
                 $errorList[] = sprintf('Query parameter "%s" must be greater than %s', $name, $minimum);
             } elseif ($value < $minimum) {
                 $errorList[] = sprintf('Query parameter "%s" must be greater than or equal to %s', $name, $minimum);

src/Api/QueryParameterValidator/Validator/CheckFilterDeprecationsTrait.php

@@ -0,0 +1,31 @@
+<?php
+
+/*
+ * This file is part of the API Platform project.
+ *
+ * (c) Kévin Dunglas <dunglas@gmail.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace ApiPlatform\Api\QueryParameterValidator\Validator;
+
+/**
+ * @internal
+ */
+trait CheckFilterDeprecationsTrait
+{
+    protected function checkFilterDeprecations(array $filterDescription): void
+    {
+        if (\array_key_exists('swagger', $filterDescription)) {
+            trigger_deprecation(
+                'api-platform/core',
+                '3.0',
+                'Using the "swagger" key in filters description is deprecated, use "openapi" instead.'
+            );
+        }
+    }
+}

src/Api/QueryParameterValidator/Validator/Enum.php

@@ -15,6 +15,8 @@
 
 final class Enum implements ValidatorInterface
 {
+    use CheckFilterDeprecationsTrait;
+
     /**
      * {@inheritdoc}
      */
@@ -25,7 +27,9 @@ public function validate(string $name, array $filterDescription, array $queryPar
             return [];
         }
 
-        $enum = $filterDescription['swagger']['enum'] ?? null;
+        $this->checkFilterDeprecations($filterDescription);
+
+        $enum = $filterDescription['openapi']['enum'] ?? $filterDescription['swagger']['enum'] ?? null;
 
         if (null !== $enum && !\in_array($value, $enum, true)) {
             return [

src/Api/QueryParameterValidator/Validator/Length.php

@@ -15,6 +15,8 @@
 
 final class Length implements ValidatorInterface
 {
+    use CheckFilterDeprecationsTrait;
+
     /**
      * {@inheritdoc}
      */
@@ -25,8 +27,10 @@ public function validate(string $name, array $filterDescription, array $queryPar
             return [];
         }
 
-        $maxLength = $filterDescription['swagger']['maxLength'] ?? null;
-        $minLength = $filterDescription['swagger']['minLength'] ?? null;
+        $this->checkFilterDeprecations($filterDescription);
+
+        $maxLength = $filterDescription['openapi']['maxLength'] ?? $filterDescription['swagger']['maxLength'] ?? null;
+        $minLength = $filterDescription['openapi']['minLength'] ?? $filterDescription['swagger']['minLength'] ?? null;
 
         $errorList = [];
 

src/Api/QueryParameterValidator/Validator/MultipleOf.php

@@ -15,6 +15,8 @@
 
 final class MultipleOf implements ValidatorInterface
 {
+    use CheckFilterDeprecationsTrait;
+
     /**
      * {@inheritdoc}
      */
@@ -25,7 +27,9 @@ public function validate(string $name, array $filterDescription, array $queryPar
             return [];
         }
 
-        $multipleOf = $filterDescription['swagger']['multipleOf'] ?? null;
+        $this->checkFilterDeprecations($filterDescription);
+
+        $multipleOf = $filterDescription['openapi']['multipleOf'] ?? $filterDescription['swagger']['multipleOf'] ?? null;
 
         if (null !== $multipleOf && 0 !== ($value % $multipleOf)) {
             return [

src/Api/QueryParameterValidator/Validator/Pattern.php

@@ -15,6 +15,8 @@
 
 final class Pattern implements ValidatorInterface
 {
+    use CheckFilterDeprecationsTrait;
+
     /**
      * {@inheritdoc}
      */
@@ -25,7 +27,9 @@ public function validate(string $name, array $filterDescription, array $queryPar
             return [];
         }
 
-        $pattern = $filterDescription['swagger']['pattern'] ?? null;
+        $this->checkFilterDeprecations($filterDescription);
+
+        $pattern = $filterDescription['openapi']['pattern'] ?? $filterDescription['swagger']['pattern'] ?? null;
 
         if (null !== $pattern && !preg_match($pattern, $value)) {
             return [

src/Api/QueryParameterValidator/Validator/Required.php

@@ -17,6 +17,8 @@
 
 final class Required implements ValidatorInterface
 {
+    use CheckFilterDeprecationsTrait;
+
     /**
      * {@inheritdoc}
      */
@@ -34,8 +36,10 @@ public function validate(string $name, array $filterDescription, array $queryPar
             ];
         }
 
+        $this->checkFilterDeprecations($filterDescription);
+
         // if query param is empty and the configuration does not allow it
-        if (!($filterDescription['swagger']['allowEmptyValue'] ?? false) && empty($this->requestGetQueryParameter($queryParameters, $name))) {
+        if (!($filterDescription['openapi']['allowEmptyValue'] ?? $filterDescription['swagger']['allowEmptyValue'] ?? false) && empty($this->requestGetQueryParameter($queryParameters, $name))) {
             return [
                 sprintf('Query parameter "%s" does not allow empty value', $name),
             ];