fix(specs): make hits required, facets count as an integer, `sear…

…chParams` as optional (#868)
algolia · Jul 27, 2022 · 6bdc94f · 6bdc94f
1 parent bdef794
commit 6bdc94f
Show file tree

Hide file tree

Showing 4 changed files with 9 additions and 13 deletions.
diff --git a/specs/recommend/common/schemas/RecommendationsResponse.yml b/specs/recommend/common/schemas/RecommendationsResponse.yml
@@ -11,6 +11,8 @@ recommendHits:
       type: array
       items:
         $ref: '#/recommendHit'
+  required:
+    - hits
 
 recommendHit:
   type: object

diff --git a/specs/search/common/schemas/SearchResponse.yml b/specs/search/common/schemas/SearchResponse.yml
@@ -26,12 +26,13 @@ searchHits:
       type: array
       items:
         $ref: 'Hit.yml#/hit'
+  required:
+    - hits
 
 baseSearchResponse:
   type: object
   additionalProperties: false
   required:
-    - hits
     - nbHits
     - page
     - nbPages
@@ -47,7 +48,7 @@ baseSearchResponse:
       description: If a search encounters an index that is being A/B tested, abTestID reports the ongoing A/B test ID.
     abTestVariantID:
       type: integer
-      description: If a search encounters an index that is being A/B tested, abTestVariantID reports the variant ID of the index used.
+      description: If a search encounters an index that is being A/B tested, abTestVariantID reports the variant ID of the index used (starting at 1).
     aroundLatLng:
       type: string
       description: The computed geo location.
@@ -70,7 +71,7 @@ baseSearchResponse:
       additionalProperties:
         type: object
         additionalProperties:
-          type: string
+          type: integer
       description: A mapping of each facet name to the corresponding facet counts.
       example:
         category:

diff --git a/specs/search/paths/search/searchSingleIndex.yml b/specs/search/paths/search/searchSingleIndex.yml
@@ -9,7 +9,6 @@ post:
   parameters:
     - $ref: '../../../common/parameters.yml#/IndexName'
   requestBody:
-    required: true
     content:
       application/json:
         schema:

diff --git a/tests/CTS/methods/requests/search/searchSingleIndex.json b/tests/CTS/methods/requests/search/searchSingleIndex.json
@@ -2,22 +2,16 @@
   {
     "testName": "search with minimal parameters",
     "parameters": {
-      "indexName": "indexName",
-      "searchParams": {
-        "query": "myQuery"
-      }
+      "indexName": "indexName"
     },
     "request": {
       "path": "/1/indexes/indexName/query",
-      "method": "POST",
-      "body": {
-        "query": "myQuery"
-      }
+      "method": "POST"
     }
   },
   {
     "method": "search",
-    "testName": "search with facetFilters",
+    "testName": "search with searchParams",
     "parameters": {
       "indexName": "indexName",
       "searchParams": {