Skip to content

Commit a49eba0

Browse files
refactor(specs): extract results field in a dedicated directory (generated)
algolia/api-clients-automation#5739 Co-authored-by: algolia-bot <[email protected]> Co-authored-by: Clara Muller <[email protected]>
1 parent 1864928 commit a49eba0

File tree

3 files changed

+6
-12
lines changed

3 files changed

+6
-12
lines changed

packages/client_composition/lib/src/model/search_hits.dart

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ final class SearchHits extends DelegatingMap<String, dynamic> {
2121
@JsonKey(name: r'hits')
2222
final List<Hit> hits;
2323

24-
/// Search query.
24+
/// The search query string.
2525
@JsonKey(name: r'query')
2626
final String query;
2727

packages/client_composition/lib/src/model/search_pagination.dart

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,7 @@ final class SearchPagination {
1515
required this.hitsPerPage,
1616
});
1717

18-
/// Page of search results to retrieve.
19-
// minimum: 0
18+
/// The current page of the results.
2019
@JsonKey(name: r'page')
2120
final int page;
2221

@@ -28,9 +27,7 @@ final class SearchPagination {
2827
@JsonKey(name: r'nbPages')
2928
final int nbPages;
3029

31-
/// Number of hits per page.
32-
// minimum: 1
33-
// maximum: 1000
30+
/// Number of hits returned per page.
3431
@JsonKey(name: r'hitsPerPage')
3532
final int hitsPerPage;
3633

packages/client_composition/lib/src/model/search_results_item.dart

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -156,8 +156,7 @@ final class SearchResultsItem {
156156
@JsonKey(name: r'_automaticInsights')
157157
final bool? automaticInsights;
158158

159-
/// Page of search results to retrieve.
160-
// minimum: 0
159+
/// The current page of the results.
161160
@JsonKey(name: r'page')
162161
final int page;
163162

@@ -169,17 +168,15 @@ final class SearchResultsItem {
169168
@JsonKey(name: r'nbPages')
170169
final int nbPages;
171170

172-
/// Number of hits per page.
173-
// minimum: 1
174-
// maximum: 1000
171+
/// Number of hits returned per page.
175172
@JsonKey(name: r'hitsPerPage')
176173
final int hitsPerPage;
177174

178175
/// Search results (hits). Hits are records from your index that match the search criteria, augmented with additional attributes, such as, for highlighting.
179176
@JsonKey(name: r'hits')
180177
final List<Hit> hits;
181178

182-
/// Search query.
179+
/// The search query string.
183180
@JsonKey(name: r'query')
184181
final String query;
185182

0 commit comments

Comments
 (0)