Adds default schema type to OpenApiSearch query parameters (#474)

* Adds default schema type to OpenApiSearch query parameters
cnizzardini · Oct 2, 2022 · 45cbd74 · 45cbd74
1 parent 4166b9d
commit 45cbd74
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 1 deletion.
diff --git a/src/Lib/Extension/CakeSearch/Extension.php b/src/Lib/Extension/CakeSearch/Extension.php
@@ -138,7 +138,9 @@ private function createParameter(FilterDecorator $filter): Parameter
     {
         $parameter = new Parameter(in: 'query', name: $filter->getName());
         $parameter->setSchema(
-            (new Schema())->setDescription($filter->getComparison())
+            (new Schema())
+                ->setDescription($filter->getComparison())
+                ->setType('string')
         );
 
         return $parameter;

diff --git a/tests/TestCase/Lib/Extension/CakeSearch/ExtensionTest.php b/tests/TestCase/Lib/Extension/CakeSearch/ExtensionTest.php
@@ -92,6 +92,7 @@ public function test_search_parameters_exist_in_openapi_output(string $endpoint)
         $search = $arr['paths'][$endpoint]['get'];
 
         $this->assertEquals('first_name', $search['parameters'][0]['name']);
+        $this->assertEquals('string', $search['parameters'][0]['schema']['type']);
     }
 
     public function test_getOperation_throws_exception_when_event_subject_is_invalid(): void