feat: add groups filter whitelist info to swagger (#5244)

Author: SpartakusMd

src/Api/FilterInterface.php

@@ -43,6 +43,11 @@ interface FilterInterface
      *          'type' => 'integer',
      *       ]
      *     ]
+     *   - schema (optional): schema definition,
+     *     e.g. 'schema' => [
+     *       'type' => 'string',
+     *       'enum' => ['value_1', 'value_2'],
+     *     ]
      * The description can contain additional data specific to a filter.
      *
      * @see \ApiPlatform\OpenApi\Factory\OpenApiFactory::getFiltersParameters

src/Serializer/Filter/GroupFilter.php

@@ -58,13 +58,23 @@ public function apply(Request $request, bool $normalization, array $attributes,
      */
     public function getDescription(string $resourceClass): array
     {
-        return [
-            "$this->parameterName[]" => [
-                'property' => null,
-                'type' => 'string',
-                'is_collection' => true,
-                'required' => false,
-            ],
+        $description = [
+            'property' => null,
+            'type' => 'string',
+            'is_collection' => true,
+            'required' => false,
         ];
+
+        if ($this->whitelist) {
+            $description['schema'] = [
+                'type' => 'array',
+                'items' => [
+                    'type' => 'string',
+                    'enum' => $this->whitelist,
+                ],
+            ];
+        }
+
+        return ["$this->parameterName[]" => $description];
     }
 }

tests/Serializer/Filter/GroupFilterTest.php

@@ -125,4 +125,26 @@ public function testGetDescription(): void
 
         $this->assertSame($expectedDescription, $groupFilter->getDescription(DummyGroup::class));
     }
+
+    public function testGetDescriptionWithWhitelist(): void
+    {
+        $groupFilter = new GroupFilter('custom_groups', false, ['default_group', 'another_default_group']);
+        $expectedDescription = [
+            'custom_groups[]' => [
+                'property' => null,
+                'type' => 'string',
+                'is_collection' => true,
+                'required' => false,
+                'schema' => [
+                    'type' => 'array',
+                    'items' => [
+                        'type' => 'string',
+                        'enum' => ['default_group', 'another_default_group'],
+                    ],
+                ],
+            ],
+        ];
+
+        $this->assertSame($expectedDescription, $groupFilter->getDescription(DummyGroup::class));
+    }
 }