Skip to content

Commit 1368f9f

Browse files
committed
fix: broken CI
1 parent 0c796ab commit 1368f9f

File tree

8 files changed

+13
-9
lines changed

8 files changed

+13
-9
lines changed

clients/algoliasearch-client-javascript/client-search/model/baseSearchParams.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
export type BaseSearchParams = {
22
/**
3-
* Full text query.
3+
* The text to search in the index.
44
*/
55
query: string;
66
/**

clients/algoliasearch-client-javascript/client-search/model/baseSearchResponse.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ export type BaseSearchResponse = {
3838
*/
3939
facets_stats?: { [key: string]: BaseSearchResponseFacetsStats };
4040
/**
41-
* Maximum number of hits in a page. Minimum is 1, maximum is 1000.
41+
* Set the number of hits per page.
4242
*/
4343
hitsPerPage: number;
4444
/**
@@ -82,7 +82,7 @@ export type BaseSearchResponse = {
8282
*/
8383
processingTimeMS: number;
8484
/**
85-
* Full text query.
85+
* The text to search in the index.
8686
*/
8787
query: string;
8888
/**

clients/algoliasearch-client-javascript/client-search/model/indexSettingsAsSearchParams.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ export type IndexSettingsAsSearchParams = {
5656
*/
5757
restrictHighlightAndSnippetArrays?: boolean;
5858
/**
59-
* Maximum number of hits in a page. Minimum is 1, maximum is 1000.
59+
* Set the number of hits per page.
6060
*/
6161
hitsPerPage?: number;
6262
/**

clients/algoliasearch-client-javascript/client-search/model/multipleQueries.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ export type MultipleQueries = {
44
*/
55
indexName: string;
66
/**
7-
* Full text query.
7+
* The text to search in the index.
88
*/
99
query?: string;
1010
/**

clients/algoliasearch-client-javascript/client-search/model/searchUserIdsObject.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ export type SearchUserIdsObject = {
1515
*/
1616
page?: number;
1717
/**
18-
* Maximum number of hits in a page. Minimum is 1, maximum is 1000.
18+
* Set the number of hits per page.
1919
*/
2020
hitsPerPage?: number;
2121
};

specs/search/common/schemas/IndexSettings.yml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -158,7 +158,9 @@ indexSettingsAsSearchParams:
158158
description: Restrict highlighting and snippeting to items that matched the query.
159159
default: false
160160
hitsPerPage:
161-
$ref: '../../../common/parameters.yml#/hitsPerPage'
161+
type: integer
162+
description: Set the number of hits per page.
163+
default: 20
162164
minWordSizefor1Typo:
163165
type: integer
164166
description: Minimum number of characters a word in the query string must contain to accept matches with 1 typo.

specs/search/common/schemas/SearchParams.yml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,9 @@ baseSearchParams:
1010
- query
1111
properties:
1212
query:
13-
$ref: '../../../common/parameters.yml#/query'
13+
type: string
14+
description: The text to search in the index.
15+
default: ''
1416
similarQuery:
1517
type: string
1618
description: Overrides the query parameter and performs a more generic search that can be used to find "similar" results.

specs/search/common/schemas/SearchResponse.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ baseSearchResponse:
8282
type: integer
8383
description: The sum of all values in the result set.
8484
hitsPerPage:
85-
$ref: '../../../common/parameters.yml#/hitsPerPage'
85+
$ref: 'IndexSettings.yml#/indexSettingsAsSearchParams/properties/hitsPerPage'
8686
index:
8787
type: string
8888
example: indexName

0 commit comments

Comments
 (0)