fix(specs): optional/required query and params (#1864)

algolia · Aug 3, 2023 · c6a7ab4 · c6a7ab4
1 parent ac4ce55
commit c6a7ab4
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 8 deletions.
diff --git a/specs/recommend/common/schemas/RecommendationsResponse.yml b/specs/recommend/common/schemas/RecommendationsResponse.yml
@@ -11,6 +11,12 @@ recommendHits:
       type: array
       items:
         $ref: '#/recommendHit'
+    query:
+      $ref: '../../../common/schemas/SearchParams.yml#/query'    
+    params:
+      type: string
+      description: URL-encoded string of all search parameters.
+      example: query=a&hitsPerPage=20     
   required:
     - hits
 

diff --git a/specs/search/common/schemas/SearchResponse.yml b/specs/search/common/schemas/SearchResponse.yml
@@ -11,8 +11,16 @@ searchHits:
       type: array
       items:
         $ref: 'Hit.yml#/hit'
+    query:
+      $ref: '../../../common/schemas/SearchParams.yml#/query'    
+    params:
+      type: string
+      description: URL-encoded string of all search parameters.
+      example: query=a&hitsPerPage=20  
   required:
     - hits
+    - query
+    - params
 
 baseSearchResponse:
   type: object
@@ -24,8 +32,6 @@ baseSearchResponse:
     - hitsPerPage
     - processingTimeMS
     - exhaustiveNbHits
-    - query
-    - params
   properties:
     abTestID:
       type: integer
@@ -110,10 +116,6 @@ baseSearchResponse:
       example: 20
     page:
       $ref: '../../../common/schemas/SearchParams.yml#/page'
-    params:
-      type: string
-      description: URL-encoded string of all search parameters.
-      example: query=a&hitsPerPage=20
     redirect:
       type: object
       description: >
@@ -131,8 +133,6 @@ baseSearchResponse:
       type: integer
       description: Time the server took to process the request, in milliseconds.
       example: 20
-    query:
-      $ref: '../../../common/schemas/SearchParams.yml#/query'
     queryAfterRemoval:
       type: string
       description: Markup text indicating which parts of the original query have been removed to retrieve a non-empty result set.