fix(elasticsearch): add is_collection to documentation (#5497)

api-platform · Apr 4, 2023 · 2586134 · 2586134
1 parent 43394b4
commit 2586134
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 0 deletions.
diff --git a/src/Elasticsearch/Filter/AbstractSearchFilter.php b/src/Elasticsearch/Filter/AbstractSearchFilter.php
@@ -96,6 +96,7 @@ public function getDescription(string $resourceClass): array
                     'property' => $property,
                     'type' => $hasAssociation ? 'string' : $this->getPhpType($type),
                     'required' => false,
+                    'is_collection' => str_ends_with((string) $filterParameterName, '[]'),
                 ];
             }
         }

diff --git a/tests/Elasticsearch/Filter/MatchFilterTest.php b/tests/Elasticsearch/Filter/MatchFilterTest.php
@@ -176,41 +176,49 @@ public function testGetDescription(): void
                     'property' => 'id',
                     'type' => 'int',
                     'required' => false,
+                    'is_collection' => false,
                 ],
                 'id[]' => [
                     'property' => 'id',
                     'type' => 'int',
                     'required' => false,
+                    'is_collection' => true,
                 ],
                 'name' => [
                     'property' => 'name',
                     'type' => 'string',
                     'required' => false,
+                    'is_collection' => false,
                 ],
                 'name[]' => [
                     'property' => 'name',
                     'type' => 'string',
                     'required' => false,
+                    'is_collection' => true,
                 ],
                 'date' => [
                     'property' => 'date',
                     'type' => \DateTimeInterface::class,
                     'required' => false,
+                    'is_collection' => false,
                 ],
                 'date[]' => [
                     'property' => 'date',
                     'type' => \DateTimeInterface::class,
                     'required' => false,
+                    'is_collection' => true,
                 ],
                 'weird' => [
                     'property' => 'weird',
                     'type' => 'string',
                     'required' => false,
+                    'is_collection' => false,
                 ],
                 'weird[]' => [
                     'property' => 'weird',
                     'type' => 'string',
                     'required' => false,
+                    'is_collection' => true,
                 ],
             ],
             $matchFilter->getDescription(Foo::class)

diff --git a/tests/Elasticsearch/Filter/TermFilterTest.php b/tests/Elasticsearch/Filter/TermFilterTest.php
@@ -176,41 +176,49 @@ public function testGetDescription(): void
                     'property' => 'id',
                     'type' => 'int',
                     'required' => false,
+                    'is_collection' => false,
                 ],
                 'id[]' => [
                     'property' => 'id',
                     'type' => 'int',
                     'required' => false,
+                    'is_collection' => true,
                 ],
                 'name' => [
                     'property' => 'name',
                     'type' => 'string',
                     'required' => false,
+                    'is_collection' => false,
                 ],
                 'name[]' => [
                     'property' => 'name',
                     'type' => 'string',
                     'required' => false,
+                    'is_collection' => true,
                 ],
                 'date' => [
                     'property' => 'date',
                     'type' => \DateTimeInterface::class,
                     'required' => false,
+                    'is_collection' => false,
                 ],
                 'date[]' => [
                     'property' => 'date',
                     'type' => \DateTimeInterface::class,
                     'required' => false,
+                    'is_collection' => true,
                 ],
                 'weird' => [
                     'property' => 'weird',
                     'type' => 'string',
                     'required' => false,
+                    'is_collection' => false,
                 ],
                 'weird[]' => [
                     'property' => 'weird',
                     'type' => 'string',
                     'required' => false,
+                    'is_collection' => true,
                 ],
             ],
             $termFilter->getDescription(Foo::class)