feat(specs): improve Composition Client searchResponse specs (matches SearchClient more closely for IS) (#4300) (generated) [skip ci]

Co-authored-by: Emmanuel Krebs <[email protected]>
Co-authored-by: Clément Vannicatte <[email protected]>

Author: 3 people

clients/algoliasearch-client-javascript/packages/client-composition/model/searchHits.ts

@@ -7,4 +7,14 @@ export type SearchHits<T = Record<string, unknown>> = Record<string, any> & {
    * Search results (hits).  Hits are records from your index that match the search criteria, augmented with additional attributes, such as, for highlighting.
    */
   hits: Hit<T>[];
+
+  /**
+   * Search query.
+   */
+  query: string;
+
+  /**
+   * URL-encoded string of all search parameters.
+   */
+  params: string;
 };

clients/algoliasearch-client-javascript/packages/client-composition/model/searchPagination.ts

@@ -4,20 +4,20 @@ export type SearchPagination = {
   /**
    * Page of search results to retrieve.
    */
-  page?: number;
+  page: number;
 
   /**
    * Number of results (hits).
    */
-  nbHits?: number;
+  nbHits: number;
 
   /**
    * Number of pages of results.
    */
-  nbPages?: number;
+  nbPages: number;
 
   /**
    * Number of hits per page.
    */
-  hitsPerPage?: number;
+  hitsPerPage: number;
 };

clients/algoliasearch-client-javascript/packages/client-composition/model/searchResults.ts

@@ -6,5 +6,5 @@ export type SearchResults<T = Record<string, unknown>> = {
   /**
    * Search results.
    */
-  results?: SearchResultsItem<T>[];
+  results: SearchResultsItem<T>[];
 };

docs/bundled/composition.yml

@@ -2041,6 +2041,11 @@ components:
           $ref: '#/components/schemas/nbPages'
         hitsPerPage:
           $ref: '#/components/schemas/hitsPerPage'
+      required:
+        - page
+        - nbHits
+        - nbPages
+        - hitsPerPage
     highlightedValue:
       type: string
       description: Highlighted attribute value, including HTML tags.
@@ -2280,8 +2285,16 @@ components:
             augmented with additional attributes, such as, for highlighting.
           items:
             $ref: '#/components/schemas/hit'
+        query:
+          $ref: '#/components/schemas/query'
+        params:
+          type: string
+          description: URL-encoded string of all search parameters.
+          example: query=a&hitsPerPage=20
       required:
         - hits
+        - query
+        - params
     resultsInjectedItemInfoResponse:
       type: object
       additionalProperties: true
@@ -2334,6 +2347,8 @@ components:
           description: Search results.
           items:
             $ref: '#/components/schemas/searchResultsItem'
+      required:
+        - results
     searchResponse:
       additionalProperties: true
       allOf:

specs/bundled/composition.yml

@@ -1763,6 +1763,11 @@ components:
           $ref: '#/components/schemas/nbPages'
         hitsPerPage:
           $ref: '#/components/schemas/hitsPerPage'
+      required:
+        - page
+        - nbHits
+        - nbPages
+        - hitsPerPage
     highlightedValue:
       type: string
       description: Highlighted attribute value, including HTML tags.
@@ -2002,8 +2007,16 @@ components:
             augmented with additional attributes, such as, for highlighting.
           items:
             $ref: '#/components/schemas/hit'
+        query:
+          $ref: '#/components/schemas/query'
+        params:
+          type: string
+          description: URL-encoded string of all search parameters.
+          example: query=a&hitsPerPage=20
       required:
         - hits
+        - query
+        - params
     resultsInjectedItemInfoResponse:
       type: object
       additionalProperties: true
@@ -2056,6 +2069,8 @@ components:
           description: Search results.
           items:
             $ref: '#/components/schemas/searchResultsItem'
+      required:
+        - results
     searchResponse:
       additionalProperties: true
       allOf: