Skip to content

Commit 3592870

Browse files
authored
Fix code-samples after #310 release (#322)
* Fix code-samples after #310 release * Update .code-samples.meilisearch.yaml
1 parent f98de26 commit 3592870

File tree

1 file changed

+64
-69
lines changed

1 file changed

+64
-69
lines changed

.code-samples.meilisearch.yaml

+64-69
Original file line numberDiff line numberDiff line change
@@ -19,34 +19,34 @@ get_documents_1: |-
1919
.getDocuments(params: DocumentsQuery(limit: 2, filter: 'genres = action'));
2020
multi_search_1: |-
2121
await client.multiSearch(MultiSearchQuery(queries: [
22-
SearchQuery(
22+
IndexSearchQuery(
2323
query: "pooh",
2424
indexUid: "movies",
2525
limit: 5
2626
),
27-
SearchQuery(
27+
IndexSearchQuery(
2828
query: "nemo",
2929
indexUid: "movies",
3030
limit: 5
3131
),
32-
SearchQuery(
32+
IndexSearchQuery(
3333
query: "us",
3434
indexUid: "movies_ratings"
3535
),
3636
]));
3737
faceted_search_2: |-
3838
await client.multiSearch(MultiSearchQuery(queries: [
39-
SearchQuery(
39+
IndexSearchQuery(
4040
indexUid: 'books',
4141
facets: ['language', 'genres', 'author', 'format'],
4242
filter: [['language = English', 'language = French'], ['genres = Fiction']]
4343
),
44-
SearchQuery(
44+
IndexSearchQuery(
4545
indexUid: 'books',
4646
facets: ['language'],
4747
filter: [['genres = Fiction']]
4848
),
49-
SearchQuery(
49+
IndexSearchQuery(
5050
indexUid: "books",
5151
facets: ['genres'],
5252
filter: [['language = English', 'language = French']]
@@ -55,17 +55,13 @@ faceted_search_2: |-
5555
faceted_search_update_settings_1: |-
5656
await client.index('books').updateFilterableAttributes(['genres', 'rating', 'language']);
5757
search_parameter_guide_facet_stats_1: |-
58-
await client.index('movie_ratings').search('Batman', facets: ['genres', 'rating']);
58+
await client.index('movie_ratings').search('Batman', SearchQuery(facets: ['genres', 'rating']));
5959
faceted_search_1: |-
60-
await client.index('books').search('', facets: ['genres', 'rating', 'language']);
60+
await client.index('books').search('', SearchQuery(facets: ['genres', 'rating', 'language']));
6161
filtering_guide_nested_1: |-
62-
await client.index('movie_ratings').search('thriller', {
63-
filter: 'rating.users >= 90'
64-
})
62+
await client.index('movie_ratings').search('thriller', SearchQuery(filter: 'rating.users >= 90'));
6563
sorting_guide_sort_nested_1: |-
66-
await client.index('books').search('science fiction', {
67-
sort: ["rating.users:asc"],
68-
})
64+
await client.index('movie_ratings').search('thriller', SearchQuery(sort: ["rating.users:asc"]));
6965
async_guide_filter_by_date_1: |-
7066
await client.getTasks(params: TasksQuery(afterEnqueuedAt: DateTime(2020, 10, 11, 11, 49, 53)));
7167
async_guide_multiple_filters_1: |-
@@ -87,9 +83,9 @@ async_guide_canceled_by: |-
8783
swap_indexes_1: |-
8884
await client.swapIndexes([SwapIndex(['indexA', 'indexB']), SwapIndex(['indexX', 'indexY'])]);
8985
search_parameter_guide_hitsperpage_1: |-
90-
await client.index('movies').search('', hitsPerPage: 15) as PaginatedSearchResult;
86+
await client.index('movies').search('', SearchQuery(hitsPerPage: 15)) as PaginatedSearchResult;
9187
search_parameter_guide_page_1: |-
92-
await client.index('movies').search('', page: 2) as PaginatedSearchResult;
88+
await client.index('movies').search('', SearchQuery(page: 2)) as PaginatedSearchResult;
9389
getting_started_faceting: |-
9490
getting_started_pagination: |-
9591
synonyms_guide_1: |-
@@ -102,25 +98,24 @@ date_guide_index_1: |-
10298
import 'dart:convert';
10399
104100
final json = await File('games.json').readAsString();
105-
final games = jsonDecode(json);
106101
107-
await client.index('games').addDocuments(games);
102+
await client.index('games').addDocumentsJson(json);
108103
date_guide_filterable_attributes_1: |-
109104
await client.index('games').updateFilterableAttributes(['release_timestamp']);
110105
date_guide_filter_1: |-
111106
await client.index('games').search('',
112-
filter:
113-
'release_timestamp >= 1514761200 AND release_timestamp < 1672527600');
107+
SearchQuery(filter:
108+
'release_timestamp >= 1514761200 AND release_timestamp < 1672527600'));
114109
date_guide_sortable_attributes_1: |-
115110
await client.index('games').updateSortableAttributes(['release_timestamp']);
116111
date_guide_sort_1: |-
117-
await client.index('games').search('', sort: ['release_timestamp:desc']);
112+
await client.index('games').search('', SearchQuery(sort: ['release_timestamp:desc']));
118113
getting_started_typo_tolerance: |-
119114
120115
get_all_tasks_paginating_1: |-
121-
await client.getTasks(params: TasksQuery(limit: 2, from: 10);
116+
await client.getTasks(params: TasksQuery(limit: 2, from: 10));
122117
get_all_tasks_paginating_2: |-
123-
await client.getTasks(params: TasksQuery(limit: 2, from: 8);
118+
await client.getTasks(params: TasksQuery(limit: 2, from: 8));
124119
get_pagination_settings_1: |-
125120
update_pagination_settings_1: |-
126121
reset_pagination_settings_1: |-
@@ -288,45 +283,47 @@ field_properties_guide_displayed_1: |-
288283
filtering_guide_1: |-
289284
await await client
290285
.index('movies')
291-
.search('Avengers', filter: 'release_date > 795484800');
286+
.search('Avengers', SearchQuery(filter: 'release_date > 795484800'));
292287
filtering_guide_2: |-
293-
await client.index('movies').search('Batman',
294-
filter:
295-
'release_date > 795484800 AND (director = "Tim Burton" OR director = "Christopher Nolan")');
288+
await client.index('movies')
289+
.search('Batman',
290+
SearchQuery(filter: 'release_date > 795484800 AND (director = "Tim Burton" OR director = "Christopher Nolan")'
291+
)
292+
);
296293
filtering_guide_3: |-
297294
await client.index('movies').search('Planet of the Apes',
298-
filter: 'rating >= 3 AND (NOT director = "Tim Burton")');
295+
SearchQuery(filter: 'rating >= 3 AND (NOT director = "Tim Burton")'));
299296
search_parameter_guide_query_1: |-
300297
await client.index('movies').search('shifu');
301298
search_parameter_guide_offset_1: |-
302-
await client.index('movies').search('shifu', offset: 1);
299+
await client.index('movies').search('shifu', SearchQuery(offset: 1));
303300
search_parameter_guide_limit_1: |-
304-
await client.index('movies').search('shifu', limit: 2);
301+
await client.index('movies').search('shifu', SearchQuery(limit: 2));
305302
search_parameter_guide_matching_strategy_1: |-
306-
await client.index('movies').search('big fat liar', matchingStrategy: MatchingStrategy.last);
303+
await client.index('movies').search('big fat liar', SearchQuery(matchingStrategy: MatchingStrategy.last));
307304
search_parameter_guide_matching_strategy_2: |-
308-
await client.index('movies').search('big fat liar', matchingStrategy: MatchingStrategy.all);
305+
await client.index('movies').search('big fat liar', SearchQuery(matchingStrategy: MatchingStrategy.all));
309306
search_parameter_guide_retrieve_1: |-
310307
await client
311308
.index('movies')
312-
.search('shifu', attributesToRetrieve: ['overview', 'title']);
309+
.search('shifu', SearchQuery(attributesToRetrieve: ['overview', 'title']));
313310
search_parameter_guide_crop_1: |-
314311
await client
315312
.index('movies')
316-
.search('shifu', attributesToCrop: ['overview'], cropLength: 5);
313+
.search('shifu', SearchQuery(attributesToCrop: ['overview'], cropLength: 5));
317314
search_parameter_guide_highlight_1: |-
318315
await client
319316
.index('movies')
320-
.search('winter feast', attributesToHighlight: ['overview']);
317+
.search('winter feast', SearchQuery(attributesToHighlight: ['overview']));
321318
search_parameter_guide_show_matches_position_1: |-
322-
await client.index('movies').search('winter feast', showMatchesPosition: true);
319+
await client.index('movies').search('winter feast', SearchQuery(showMatchesPosition: true));
323320
add_movies_json_1: |-
324321
import 'dart:io';
325322
import 'dart:convert';
326323
327-
final jsonFile = await File('movies.json').readAsString();
328-
final movies = jsonDecode(jsonFile);
329-
await client.index('movies').addDocuments(movies);
324+
final json = await File('movies.json').readAsString();
325+
326+
await client.index('movies').addDocumentsJson(json);
330327
documents_guide_add_movie_1: |-
331328
await client.index('movies').addDocuments([
332329
{ 'movie_id': '123sq178', 'title': 'Amélie Poulain' }
@@ -358,9 +355,9 @@ getting_started_add_documents_md: |-
358355
359356
var client = MeiliSearchClient('http://localhost:7700', 'masterKey');
360357
361-
final jsonFile = await File('movies.json').readAsString();
362-
final movies = jsonDecode(jsonFile);
363-
await client.index('movies').addDocuments(movies);
358+
final json = await File('movies.json').readAsString();
359+
360+
await client.index('movies').addDocumentsJson(json);
364361
```
365362
366363
[About this SDK](https://github.com/meilisearch/meilisearch-dart/)
@@ -404,40 +401,39 @@ getting_started_communicating_with_a_protected_instance: |-
404401
var client = MeiliSearchClient('http://localhost:7700', 'apiKey');
405402
await client.index('movies').search('');
406403
getting_started_add_meteorites: |-
407-
final jsonFile = await File('meteorites.json').readAsString();
408-
final meteorites = jsonDecode(jsonFile);
404+
final json = await File('meteorites.json').readAsString();
409405
410-
await client.index('meteorites').addDocuments(meteorites);
406+
await client.index('meteorites').addDocumentsJson(json);
411407
getting_started_configure_settings: |-
412408
await client.index('meteorites').updateSettings(IndexSettings(
413409
filterableAttributes: ['mass', '_geo'],
414410
sortableAttributes: ['mass', '_geo']
415411
));
416412
getting_started_geo_radius: |-
417-
await client.index('meteorites').search('', filter: '_geoRadius(46.9480, 7.4474, 210000)');
413+
await client.index('meteorites').search('', SearchQuery(filter: '_geoRadius(46.9480, 7.4474, 210000)'));
418414
getting_started_geo_point: |-
419-
await client.index('meteorites').search('', sort: ['_geoPoint(48.8583701, 2.2922926):asc']);
415+
await client.index('meteorites').search('', SearchQuery(sort: ['_geoPoint(48.8583701, 2.2922926):asc']));
420416
getting_started_sorting: |-
421-
await client.index('meteorites').search('', sort: ['mass:asc'], filter: 'mass < 200');
417+
await client.index('meteorites').search('', SearchQuery(sort: ['mass:asc'], filter: 'mass < 200'));
422418
getting_started_filtering: |-
423-
await client.index('meteorites').search('', filter: 'mass < 200');
419+
await client.index('meteorites').search('', SearchQuery(filter: 'mass < 200'));
424420
filtering_update_settings_1: |-
425421
await client.index('movies').updateFilterableAttributes([
426422
'director',
427423
'genres',
428424
]);
429425
faceted_search_filter_1: |-
430-
await client.index('movies').search('thriller', filter: [
426+
await client.index('movies').search('thriller', SearchQuery(filter: [
431427
['genres = Horror', 'genres = Mystery'],
432428
'director = "Jordan Peele"'
433-
]);
429+
]));
434430
faceted_search_facets_1: |-
435-
await client.index('movies').search('Batman', facets: ['genres']);
431+
await client.index('movies').search('Batman', SearchQuery(facets: ['genres']));
436432
faceted_search_walkthrough_filter_1: |-
437-
await client.index('movies').search('thriller', filter: [
433+
await client.index('movies').search('thriller', SearchQuery(filter: [
438434
['genres = Horror', 'genres = Mystery'],
439435
'director = "Jordan Peele"'
440-
]);
436+
]));
441437
post_dump_1: |-
442438
await client.createDump();
443439
phrase_search_1: |-
@@ -454,9 +450,9 @@ sorting_guide_update_ranking_rules_1: |-
454450
'exactness'
455451
]);
456452
sorting_guide_sort_parameter_1: |-
457-
await client.index('books').search('science fiction', sort: ['price:asc']);
453+
await client.index('books').search('science fiction', SearchQuery(sort: ['price:asc']));
458454
sorting_guide_sort_parameter_2: |-
459-
await client.index('books').search('butler', sort: ['author:desc']);
455+
await client.index('books').search('butler', SearchQuery(sort: ['author:desc']));
460456
get_sortable_attributes_1: |-
461457
await client.index('books').getSortableAttributes();
462458
update_sortable_attributes_1: |-
@@ -467,23 +463,23 @@ update_sortable_attributes_1: |-
467463
reset_sortable_attributes_1: |-
468464
await client.index('books').resetSortableAttributes();
469465
search_parameter_guide_sort_1: |-
470-
await client.index('books').search('science fiction', sort: ['price:asc']);
466+
await client.index('books').search('science fiction', SearchQuery(sort: ['price:asc']));
471467
geosearch_guide_filter_settings_1: |-
472468
await client.index('restaurants').updateFilterableAttributes(['_geo']);
473469
geosearch_guide_filter_usage_1: |-
474470
await await client
475471
.index('restaurants')
476-
.search('', filter: '_geoRadius(45.472735, 9.184019, 2000)');
472+
.search('', SearchQuery(filter: '_geoRadius(45.472735, 9.184019, 2000)'));
477473
geosearch_guide_filter_usage_2: |-
478474
await await client
479475
.index('restaurants')
480-
.search('', filter: '_geoRadius(45.472735, 9.184019, 2000) AND type = pizza');
476+
.search('', SearchQuery(filter: '_geoRadius(45.472735, 9.184019, 2000) AND type = pizza'));
481477
geosearch_guide_sort_settings_1: |-
482478
await client.index('restaurants').updateSortableAttributes(['_geo']);
483479
geosearch_guide_sort_usage_1: |-
484-
await client.index('restaurants').search('', sort: ['_geoPoint(48.8561446, 2.2978204):asc']);
480+
await client.index('restaurants').search('', SearchQuery(sort: ['_geoPoint(48.8561446, 2.2978204):asc']));
485481
geosearch_guide_sort_usage_2: |-
486-
await client.index('restaurants').search('', sort: ['_geoPoint(48.8561446, 2.2978204):asc', 'rating:desc']);
482+
await client.index('restaurants').search('', SearchQuery(sort: ['_geoPoint(48.8561446, 2.2978204):asc', 'rating:desc']));
487483
authorization_header_1: |-
488484
var client = MeiliSearchClient('http://localhost:7700', 'masterKey');
489485
await client.getKeys();
@@ -559,12 +555,11 @@ landing_getting_started_1: |-
559555
search_parameter_guide_crop_marker_1: |-
560556
await client
561557
.index('movies')
562-
.search('shifu', attributesToCrop: ['overview'], cropMarker: "[…]");
558+
.search('shifu', SearchQuery(attributesToCrop: ['overview'], cropMarker: "[…]"));
563559
search_parameter_guide_highlight_tag_1: |-
564-
await client
565-
.index('movies')
566-
.search('winter feast',
567-
attributesToHighlight: ['overview'],
568-
highlightPreTag: '<span class="highlight">',
569-
highlightPostTag: '</span>',
570-
);
560+
await client.index('movies').search(
561+
'winter feast',
562+
SearchQuery(
563+
attributesToHighlight: ['overview'],
564+
highlightPreTag: '<span class="highlight">',
565+
highlightPostTag: '</span>'));

0 commit comments

Comments
 (0)