fix(specs): allow searchParams in browse method (#911)

algolia · Aug 9, 2022 · c2a054f · c2a054f
1 parent d007211
commit c2a054f
Show file tree

Hide file tree

Showing 11 changed files with 60 additions and 43 deletions.
diff --git a/.github/.cache_version b/.github/.cache_version
@@ -1 +1 @@
-0.0.12
+0.0.13
diff --git a/specs/common/schemas/SearchParams.yml b/specs/common/schemas/SearchParams.yml
@@ -232,11 +232,6 @@ page:
   x-categories:
     - Pagination
 
-cursor:
-  type: string
-  description: Cursor indicating the location to resume browsing from. Must match the value returned by the previous call.
-  example: jMDY3M2MwM2QwMWUxMmQwYWI0ZTN
-
 aroundRadius:
   description: Define the maximum radius for a geo search (in meters).
   oneOf:

diff --git a/specs/search/common/schemas/BrowseParams.yml b/specs/search/common/schemas/BrowseParams.yml
@@ -0,0 +1,18 @@
+browseParams:
+  oneOf:
+    - $ref: '../../../common/schemas/SearchParams.yml#/searchParamsString'
+    - $ref: '#/browseParamsObject'
+
+browseParamsObject:
+  allOf:
+    - $ref: '../../../common/schemas/SearchParams.yml#/searchParamsObject'
+    - $ref: '#/cursor'
+
+cursor:
+  type: object
+  additionalProperties: false
+  properties:
+    cursor:
+      type: string
+      description: Cursor indicating the location to resume browsing from. Must match the value returned by the previous call.
+      example: jMDY3M2MwM2QwMWUxMmQwYWI0ZTN
diff --git a/specs/search/common/schemas/BrowseResponse.yml b/specs/search/common/schemas/BrowseResponse.yml
@@ -0,0 +1,5 @@
+browseResponse:
+  allOf:
+    - $ref: './SearchResponse.yml#/baseSearchResponse'
+    - $ref: './SearchResponse.yml#/searchHits'
+    - $ref: './BrowseParams.yml#/cursor'
diff --git a/specs/search/common/schemas/SearchResponse.yml b/specs/search/common/schemas/SearchResponse.yml
@@ -1,21 +1,8 @@
-SearchResponse:
+searchResponse:
   allOf:
     - $ref: '#/baseSearchResponse'
     - $ref: '#/searchHits'
 
-browseResponse:
-  allOf:
-    - $ref: '#/baseSearchResponse'
-    - $ref: '#/searchHits'
-    - $ref: '#/baseBrowseResponse'
-
-baseBrowseResponse:
-  type: object
-  additionalProperties: false
-  properties:
-    cursor:
-      $ref: '../../../common/schemas/SearchParams.yml#/cursor'
-
 searchHits:
   type: object
   additionalProperties: false

diff --git a/specs/search/paths/search/browse.yml b/specs/search/paths/search/browse.yml
@@ -15,21 +15,14 @@ post:
     content:
       application/json:
         schema:
-          title: browseRequest
-          type: object
-          additionalProperties: false
-          properties:
-            params:
-              $ref: '../../../common/schemas/SearchParams.yml#/paramsAsString'
-            cursor:
-              $ref: '../../../common/schemas/SearchParams.yml#/cursor'
+          $ref: '../../common/schemas/BrowseParams.yml#/browseParams'
   responses:
     '200':
       description: OK
       content:
         application/json:
           schema:
-            $ref: '../../common/schemas/SearchResponse.yml#/browseResponse'
+            $ref: '../../common/schemas/BrowseResponse.yml#/browseResponse'
     '400':
       $ref: '../../../common/responses/BadRequest.yml'
     '402':

diff --git a/specs/search/paths/search/search.yml b/specs/search/paths/search/search.yml
@@ -38,7 +38,7 @@ post:
               results:
                 type: array
                 items:
-                  $ref: '../../common/schemas/SearchResponse.yml#/SearchResponse'
+                  $ref: '../../common/schemas/SearchResponse.yml#/searchResponse'
             required:
               - results
     '400':

diff --git a/specs/search/paths/search/searchSingleIndex.yml b/specs/search/paths/search/searchSingleIndex.yml
@@ -19,7 +19,7 @@ post:
       content:
         application/json:
           schema:
-            $ref: '../../common/schemas/SearchResponse.yml#/SearchResponse'
+            $ref: '../../common/schemas/SearchResponse.yml#/searchResponse'
     '400':
       $ref: '../../../common/responses/BadRequest.yml'
     '402':

diff --git a/templates/javascript/clients/client/api/helpers.mustache b/templates/javascript/clients/client/api/helpers.mustache
@@ -113,15 +113,15 @@ waitForApiKey(
  * @summary Helper method that iterates on the `browse` method.
  * @param browseObjects - The browseObjects object.
  * @param browseObjects.indexName - The index in which to perform the request.
- * @param browseObjects.browseRequest - The `browse` method parameters.
+ * @param browseObjects.browseParams - The `browse` parameters.
  * @param browseObjects.validate - The validator function. It receive the resolved return of the API call. By default, stops when there is no `cursor` in the response.
  * @param browseObjects.aggregator - The function that runs right after the API call has been resolved, allows you to do anything with the response before `validate`.
  * @param requestOptions - The requestOptions to send along with the query, they will be forwarded to the `browse` method and merged with the transporter requestOptions.
  */
 browseObjects<T>(
   {
     indexName,
-    browseRequest,
+    browseParams,
     ...browseObjectsOptions
   }: BrowseOptions<BrowseResponse<T>> & BrowseProps,
   requestOptions?: RequestOptions
@@ -131,9 +131,9 @@ browseObjects<T>(
       return this.browse(
         {
           indexName,
-          browseRequest: {
+          browseParams: {
             cursor: previousResponse ? previousResponse.cursor : undefined,
-            ...browseRequest,
+            ...browseParams,
           },
         },
         requestOptions

diff --git a/tests/CTS/methods/requests/search/browse.json b/tests/CTS/methods/requests/search/browse.json
@@ -1,6 +1,6 @@
 [
   {
-    "testName": "get browse results with minimal parameters",
+    "testName": "browse with minimal parameters",
     "parameters": {
       "indexName": "indexName"
     },
@@ -10,20 +10,40 @@
     }
   },
   {
-    "testName": "get browse results with all parameters",
+    "testName": "browse with search parameters",
     "parameters": {
       "indexName": "indexName",
-      "browseRequest": {
-        "params": "query=foo&facetFilters=['bar']",
-        "cursor": "cts"
+      "browseParams": {
+        "query": "myQuery",
+        "facetFilters": [
+          "tags:algolia"
+        ]
       }
     },
     "request": {
       "path": "/1/indexes/indexName/browse",
       "method": "POST",
       "body": {
-        "params": "query=foo&facetFilters=['bar']",
-        "cursor": "cts"
+        "query": "myQuery",
+        "facetFilters": [
+          "tags:algolia"
+        ]
+      }
+    }
+  },
+  {
+    "testName": "browse allow a cursor in parameters",
+    "parameters": {
+      "indexName": "indexName",
+      "browseParams": {
+        "cursor": "test"
+      }
+    },
+    "request": {
+      "path": "/1/indexes/indexName/browse",
+      "method": "POST",
+      "body": {
+        "cursor": "test"
       }
     }
   }

diff --git a/tests/CTS/methods/requests/search/searchSingleIndex.json b/tests/CTS/methods/requests/search/searchSingleIndex.json
@@ -10,7 +10,6 @@
     }
   },
   {
-    "method": "search",
     "testName": "search with searchParams",
     "parameters": {
       "indexName": "indexName",