Skip to content

Commit 1610258

Browse files
Code samples changes related to Meilisearch release (v0.28.0) (#347)
* Update .code-samples.meilisearch.yaml * Update code samples * Fix list_indexes code sample * Fix get_one_document_1 code sample * Update .code-samples.meilisearch.yaml Author: Clémentine Urquizar <[email protected]> Co-authored-by: Bruno Casali <[email protected]>
1 parent dc383ed commit 1610258

File tree

1 file changed

+39
-20
lines changed

1 file changed

+39
-20
lines changed

.code-samples.meilisearch.yaml

Lines changed: 39 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
get_one_index_1: |-
77
$client->index('movies')->fetchRawInfo();
88
list_all_indexes_1: |-
9-
$client->getAllIndexes();
9+
$client->getAllIndexes((new IndexesQuery())->setLimit(3));
1010
create_an_index_1: |-
1111
$client->createIndex('movies', ['primaryKey' => 'id']);
1212
update_an_index_1: |-
@@ -18,7 +18,7 @@ delete_an_index_1: |-
1818
// OR
1919
$client->index('movies')->delete();
2020
get_one_document_1: |-
21-
$client->index('movies')->getDocument(25684);
21+
$client->index('movies')->getDocument(25684, ['id', 'title', 'poster', 'release_date']);
2222
get_documents_1: |-
2323
$client->index('movies')->getDocuments(['limit' => 2]);
2424
add_or_replace_documents_1: |-
@@ -54,18 +54,14 @@ search_post_1: |-
5454
5555
// Get the decoded response of Meilisearch, see response below
5656
$response = $searchResults->getRaw();
57-
get_task_by_index_1: |-
58-
$client->index('movies')->getTask(1);
5957
get_all_tasks_1: |-
6058
$client->getTasks();
6159
get_task_1: |-
6260
$client->getTask(1);
63-
get_all_tasks_by_index_1: |-
64-
$client->index('movies')->getTasks();
6561
get_one_key_1: |-
66-
$client->getKey('d0552b41536279a0ad88bd595327b96f01176a60c2243e906c52ac02375f9bc4');
62+
$client->getKey('6062abda-a5aa-4414-ac91-ecd7944c0f8d');
6763
get_all_keys_1: |-
68-
$client->getKeys();
64+
$client->getKeys((new KeysQuery())->setLimit(3));
6965
create_a_key_1: |-
7066
$client->createKey([
7167
'description' => 'Add documents: Products API key',
@@ -74,15 +70,13 @@ create_a_key_1: |-
7470
'expiresAt' => '2042-04-02T00:42:42Z',
7571
]);
7672
update_a_key_1: |-
77-
$client->updateKey('d0552b41536279a0ad88bd595327b96f01176a60c2243e906c52ac02375f9bc4',
73+
$client->updateKey('6062abda-a5aa-4414-ac91-ecd7944c0f8d',
7874
[
79-
'description' => 'Manage documents: Products/Reviews API key',
80-
'actions' => ['documents.add', 'documents.delete'],
81-
'indexes' => ['products', 'reviews'],
82-
'expiresAt' => '2042-04-02T00:42:42Z',
75+
'name' => 'Products/Reviews API key',
76+
'description' => 'Manage documents: Products/Reviews API key'
8377
]);
8478
delete_a_key_1: |-
85-
$client->deleteKey('d0552b41536279a0ad88bd595327b96f01176a60c2243e906c52ac02375f9bc4')
79+
$client->deleteKey('6062abda-a5aa-4414-ac91-ecd7944c0f8d')
8680
get_settings_1: |-
8781
$client->index('movies')->getSettings();
8882
update_settings_1: |-
@@ -128,6 +122,12 @@ update_settings_1: |-
128122
'twoTypos' => 10
129123
],
130124
'disableOnAttributes' => ['title']
125+
],
126+
'pagination' => [
127+
'maxTotalHits' => 5000
128+
],
129+
'faceting' => [
130+
'maxValuesPerFacet' => 200
131131
]
132132
]);
133133
reset_settings_1: |-
@@ -271,7 +271,7 @@ search_parameter_guide_highlight_tag_1: |-
271271
'highlightPreTag' => '<span class="highlight">',
272272
'highlightPostTag' => '</span>'
273273
]);
274-
search_parameter_guide_matches_1: |-
274+
search_parameter_guide_show_matches_position_1: |-
275275
$client->index('movies')->search('winter feast', ['attributesToHighlight' => ['overview'], 'showMatchesPosition' => true]);
276276
settings_guide_synonyms_1: |-
277277
$client->index('tops')->updateSettings([
@@ -401,7 +401,7 @@ getting_started_add_documents_md: |-
401401
402402
[About this SDK](https://github.com/meilisearch/meilisearch-php/)
403403
getting_started_check_task_status: |-
404-
$client->index('movies')->getTask(0);
404+
$client->getTask(0);
405405
getting_started_search_md: |-
406406
```php
407407
$client->index('movies')->search('botman');
@@ -467,7 +467,7 @@ faceted_search_update_settings_1: |-
467467
$client->index('movies')->updateFilterableAttributes(['director', 'genres']);
468468
faceted_search_filter_1: |-
469469
$client->index('movies')->search('thriller', ['filter' => [['genres = Horror', 'genres = Mystery'], 'director = "Jordan Peele"']]);
470-
faceted_search_facets_distribution_1: |-
470+
faceted_search_facets_1: |-
471471
$client->index('movies')->search('Batman', ['facets' => ['genres']]);
472472
faceted_search_walkthrough_filter_1: |-
473473
$client->index('movies')->search('thriller', ['filter' => [['genres = Horror', 'genres = Mystery'], 'director = "Jordan Peele"']]);
@@ -530,8 +530,8 @@ security_guide_search_key_1: |-
530530
$client->index('patient_medical_records')->search();
531531
security_guide_update_key_1: |-
532532
$client = new Client('http://127.0.0.1:7700', 'masterKey');
533-
$client->updateKey('d0552b41536279a0ad88bd595327b96f01176a60c2243e906c52ac02375f9bc4',
534-
['indexes': ['doctors']]
533+
$client->updateKey('74c9c733-3368-4738-bbe5-1d18a5fecb37',
534+
['description' => 'Default Search API Key']
535535
);
536536
security_guide_create_key_1: |-
537537
$client = new Client('http://127.0.0.1:7700', 'masterKey');
@@ -546,7 +546,7 @@ security_guide_list_keys_1: |-
546546
$client->getKeys();
547547
security_guide_delete_key_1: |-
548548
$client = new Client('http://127.0.0.1:7700', 'masterKey');
549-
$client->deleteKey('d0552b41536279a0ad88bd595327b96f01176a60c2243e906c52ac02375f9bc4');
549+
$client->deleteKey('ac5cd97d-5a4b-4226-a868-2d0eb6d197ab');
550550
authorization_header_1: |-
551551
$client = new Client('http://127.0.0.1:7700', 'masterKey');
552552
$client->getKeys();
@@ -566,3 +566,22 @@ tenant_token_guide_generate_sdk_1: |-
566566
tenant_token_guide_search_sdk_1: |-
567567
$frontEndClient = new Client('http://127.0.0.1:7700', $token);
568568
$frontEndClient->index('patient_medical_records')->search('blood test');
569+
get_all_tasks_filtering_1: |-
570+
$client->index('movies')->getTasks();
571+
get_all_tasks_filtering_2: |-
572+
$taskQuery = (new TasksQuery())->setStatus(['succeeded', 'failed'])->setType(['documentAdditionOrUpdate']);
573+
$client->getTasks($taskQuery);
574+
get_all_tasks_paginating_1: |-
575+
$taskQuery = (new TasksQuery())->setLimit(2)->setFrom(10));
576+
$client->getTasks($taskQuery);
577+
get_all_tasks_paginating_2: |-
578+
$taskQuery = (new TasksQuery())->setLimit(2)->setFrom(8));
579+
$client->getTasks($taskQuery);
580+
get_pagination_settings_1: |-
581+
update_pagination_settings_1: |-
582+
reset_pagination_settings_1: |-
583+
get_faceting_settings_1: |-
584+
update_faceting_settings_1: |-
585+
reset_faceting_settings_1: |-
586+
settings_guide_faceting_1: |-
587+
settings_guide_pagination_1: |-

0 commit comments

Comments
 (0)