fix: broken CI

algolia · Dec 17, 2021 · 1368f9f · 1368f9f
1 parent 0c796ab
commit 1368f9f
Show file tree

Hide file tree

Showing 8 changed files with 13 additions and 9 deletions.
diff --git a/clients/algoliasearch-client-javascript/client-search/model/baseSearchParams.ts b/clients/algoliasearch-client-javascript/client-search/model/baseSearchParams.ts
@@ -1,6 +1,6 @@
 export type BaseSearchParams = {
   /**
-   * Full text query.
+   * The text to search in the index.
    */
   query: string;
   /**

diff --git a/clients/algoliasearch-client-javascript/client-search/model/baseSearchResponse.ts b/clients/algoliasearch-client-javascript/client-search/model/baseSearchResponse.ts
@@ -38,7 +38,7 @@ export type BaseSearchResponse = {
    */
   facets_stats?: { [key: string]: BaseSearchResponseFacetsStats };
   /**
-   * Maximum number of hits in a page. Minimum is 1, maximum is 1000.
+   * Set the number of hits per page.
    */
   hitsPerPage: number;
   /**
@@ -82,7 +82,7 @@ export type BaseSearchResponse = {
    */
   processingTimeMS: number;
   /**
-   * Full text query.
+   * The text to search in the index.
    */
   query: string;
   /**

diff --git a/clients/algoliasearch-client-javascript/client-search/model/indexSettingsAsSearchParams.ts b/clients/algoliasearch-client-javascript/client-search/model/indexSettingsAsSearchParams.ts
@@ -56,7 +56,7 @@ export type IndexSettingsAsSearchParams = {
    */
   restrictHighlightAndSnippetArrays?: boolean;
   /**
-   * Maximum number of hits in a page. Minimum is 1, maximum is 1000.
+   * Set the number of hits per page.
    */
   hitsPerPage?: number;
   /**

diff --git a/clients/algoliasearch-client-javascript/client-search/model/multipleQueries.ts b/clients/algoliasearch-client-javascript/client-search/model/multipleQueries.ts
@@ -4,7 +4,7 @@ export type MultipleQueries = {
    */
   indexName: string;
   /**
-   * Full text query.
+   * The text to search in the index.
    */
   query?: string;
   /**

diff --git a/clients/algoliasearch-client-javascript/client-search/model/searchUserIdsObject.ts b/clients/algoliasearch-client-javascript/client-search/model/searchUserIdsObject.ts
@@ -15,7 +15,7 @@ export type SearchUserIdsObject = {
    */
   page?: number;
   /**
-   * Maximum number of hits in a page. Minimum is 1, maximum is 1000.
+   * Set the number of hits per page.
    */
   hitsPerPage?: number;
 };
diff --git a/specs/search/common/schemas/IndexSettings.yml b/specs/search/common/schemas/IndexSettings.yml
@@ -158,7 +158,9 @@ indexSettingsAsSearchParams:
       description: Restrict highlighting and snippeting to items that matched the query.
       default: false
     hitsPerPage:
-      $ref: '../../../common/parameters.yml#/hitsPerPage'
+      type: integer
+      description: Set the number of hits per page.
+      default: 20
     minWordSizefor1Typo:
       type: integer
       description: Minimum number of characters a word in the query string must contain to accept matches with 1 typo.

diff --git a/specs/search/common/schemas/SearchParams.yml b/specs/search/common/schemas/SearchParams.yml
@@ -10,7 +10,9 @@ baseSearchParams:
     - query
   properties:
     query:
-      $ref: '../../../common/parameters.yml#/query'
+      type: string
+      description: The text to search in the index.
+      default: ''
     similarQuery:
       type: string
       description: Overrides the query parameter and performs a more generic search that can be used to find "similar" results.

diff --git a/specs/search/common/schemas/SearchResponse.yml b/specs/search/common/schemas/SearchResponse.yml
@@ -82,7 +82,7 @@ baseSearchResponse:
             type: integer
             description: The sum of all values in the result set.
     hitsPerPage:
-      $ref: '../../../common/parameters.yml#/hitsPerPage'
+      $ref: 'IndexSettings.yml#/indexSettingsAsSearchParams/properties/hitsPerPage'
     index:
       type: string
       example: indexName