Skip to content

Commit 4a53358

Browse files
bors[bot]maryamsulemani97guimachiavelli
authored
1732: v0.28: API endpoint verbs update r=guimachiavelli a=maryamsulemani97 closes #1702 1734: v0.28: /search name changes r=guimachiavelli a=maryamsulemani97 closes #1692 1736: v0.28: Changes to `/documents` r=guimachiavelli a=guimachiavelli Closes #1700 Co-authored-by: Maryam Sulemani <[email protected]> Co-authored-by: gui machiavelli <[email protected]> Co-authored-by: gui machiavelli <[email protected]>
4 parents 3c52b44 + 7e70b5c + dde9a7c + ae3eff9 commit 4a53358

20 files changed

+155
-172
lines changed

‎.code-samples.meilisearch.yaml

Lines changed: 44 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -19,15 +19,15 @@ create_an_index_1: |-
1919
}'
2020
update_an_index_1: |-
2121
curl \
22-
-X PUT 'http://localhost:7700/indexes/movies' \
22+
-X PATCH 'http://localhost:7700/indexes/movies' \
2323
-H 'Content-Type: application/json' \
2424
--data-binary '{ "primaryKey": "id" }'
2525
delete_an_index_1: |-
2626
curl \
2727
-X DELETE 'http://localhost:7700/indexes/movies'
2828
get_one_document_1: |-
2929
curl \
30-
-X GET 'http://localhost:7700/indexes/movies/documents/25684'
30+
-X GET 'http://localhost:7700/indexes/movies/documents/25684?fields=id,title,poster,release_date'
3131
get_documents_1: |-
3232
curl \
3333
-X GET 'http://localhost:7700/indexes/movies/documents?limit=2'
@@ -142,7 +142,7 @@ get_settings_1: |-
142142
-X GET 'http://localhost:7700/indexes/movies/settings'
143143
update_settings_1: |-
144144
curl \
145-
-X POST 'http://localhost:7700/indexes/movies/settings' \
145+
-X PATCH 'http://localhost:7700/indexes/movies/settings' \
146146
-H 'Content-Type: application/json' \
147147
--data-binary '{
148148
"rankingRules": [
@@ -199,7 +199,7 @@ get_synonyms_1: |-
199199
-X GET 'http://localhost:7700/indexes/movies/settings/synonyms'
200200
update_synonyms_1: |-
201201
curl \
202-
-X POST 'http://localhost:7700/indexes/movies/settings/synonyms' \
202+
-X PUT 'http://localhost:7700/indexes/movies/settings/synonyms' \
203203
-H 'Content-Type: application/json' \
204204
--data-binary '{
205205
"wolverine": [
@@ -220,7 +220,7 @@ get_stop_words_1: |-
220220
-X GET 'http://localhost:7700/indexes/movies/settings/stop-words'
221221
update_stop_words_1: |-
222222
curl \
223-
-X POST 'http://localhost:7700/indexes/movies/settings/stop-words' \
223+
-X PUT 'http://localhost:7700/indexes/movies/settings/stop-words' \
224224
-H 'Content-Type: application/json' \
225225
--data-binary '[
226226
"the",
@@ -235,7 +235,7 @@ get_ranking_rules_1: |-
235235
-X GET 'http://localhost:7700/indexes/movies/settings/ranking-rules'
236236
update_ranking_rules_1: |-
237237
curl \
238-
-X POST 'http://localhost:7700/indexes/movies/settings/ranking-rules' \
238+
-X PUT 'http://localhost:7700/indexes/movies/settings/ranking-rules' \
239239
-H 'Content-Type: application/json' \
240240
--data-binary '[
241241
"words",
@@ -255,7 +255,7 @@ get_distinct_attribute_1: |-
255255
-X GET 'http://localhost:7700/indexes/shoes/settings/distinct-attribute'
256256
update_distinct_attribute_1: |-
257257
curl \
258-
-X POST 'http://localhost:7700/indexes/shoes/settings/distinct-attribute' \
258+
-X PUT 'http://localhost:7700/indexes/shoes/settings/distinct-attribute' \
259259
-H 'Content-Type: application/json' \
260260
--data-binary '"skuid"'
261261
reset_distinct_attribute_1: |-
@@ -266,7 +266,7 @@ get_filterable_attributes_1: |-
266266
-X GET 'http://localhost:7700/indexes/movies/settings/filterable-attributes'
267267
update_filterable_attributes_1: |-
268268
curl \
269-
-X POST 'http://localhost:7700/indexes/movies/settings/filterable-attributes' \
269+
-X PUT 'http://localhost:7700/indexes/movies/settings/filterable-attributes' \
270270
-H 'Content-Type: application/json' \
271271
--data-binary '[
272272
"genres",
@@ -280,7 +280,7 @@ get_searchable_attributes_1: |-
280280
-X GET 'http://localhost:7700/indexes/movies/settings/searchable-attributes'
281281
update_searchable_attributes_1: |-
282282
curl \
283-
-X POST 'http://localhost:7700/indexes/movies/settings/searchable-attributes' \
283+
-X PUT 'http://localhost:7700/indexes/movies/settings/searchable-attributes' \
284284
-H 'Content-Type: application/json' \
285285
--data-binary '[
286286
"title",
@@ -295,7 +295,7 @@ get_displayed_attributes_1: |-
295295
-X GET 'http://localhost:7700/indexes/movies/settings/displayed-attributes'
296296
update_displayed_attributes_1: |-
297297
curl \
298-
-X POST 'http://localhost:7700/indexes/movies/settings/displayed-attributes' \
298+
-X PUT 'http://localhost:7700/indexes/movies/settings/displayed-attributes' \
299299
-H 'Content-Type: application/json' \
300300
--data-binary '[
301301
"title",
@@ -320,12 +320,12 @@ get_version_1: |-
320320
-X GET 'http://localhost:7700/version'
321321
distinct_attribute_guide_1: |-
322322
curl \
323-
-X POST 'http://localhost:7700/indexes/jackets/settings' \
323+
-X PUT 'http://localhost:7700/indexes/jackets/settings' \
324324
-H 'Content-Type: application/json' \
325325
--data-binary '{ "distinctAttribute": "product_id" }'
326326
field_properties_guide_searchable_1: |-
327327
curl \
328-
-X POST 'http://localhost:7700/indexes/movies/settings' \
328+
-X PUT 'http://localhost:7700/indexes/movies/settings' \
329329
-H 'Content-Type: application/json' \
330330
--data-binary '{
331331
"searchableAttributes": [
@@ -336,7 +336,7 @@ field_properties_guide_searchable_1: |-
336336
}'
337337
field_properties_guide_displayed_1: |-
338338
curl \
339-
-X POST 'http://localhost:7700/indexes/movies/settings' \
339+
-X PUT 'http://localhost:7700/indexes/movies/settings' \
340340
-H 'Content-Type: application/json' \
341341
--data-binary '{
342342
"displayedAttributes": [
@@ -438,17 +438,17 @@ search_parameter_guide_highlight_tag_1: |-
438438
"highlightPreTag": "<span class=\"highlight\">",
439439
"highlightPostTag": "</span>"
440440
}'
441-
search_parameter_guide_matches_1: |-
441+
search_parameter_guide_show_matches_position_1: |-
442442
curl \
443443
-X POST 'http://localhost:7700/indexes/movies/search' \
444444
-H 'Content-Type: application/json' \
445445
--data-binary '{
446446
"q": "winter feast",
447-
"matches": true
447+
"showMatchesPosition": true
448448
}'
449449
settings_guide_synonyms_1: |-
450450
curl \
451-
-X POST 'http://localhost:7700/indexes/tops/settings' \
451+
-X PUT 'http://localhost:7700/indexes/tops/settings' \
452452
-H 'Content-Type: application/json' \
453453
--data-binary '{
454454
"synonyms": {
@@ -458,7 +458,7 @@ settings_guide_synonyms_1: |-
458458
}'
459459
settings_guide_stop_words_1: |-
460460
curl \
461-
-X POST 'http://localhost:7700/indexes/movies/settings' \
461+
-X PUT 'http://localhost:7700/indexes/movies/settings' \
462462
-H 'Content-Type: application/json' \
463463
--data-binary '{
464464
"stopWords": [
@@ -469,7 +469,7 @@ settings_guide_stop_words_1: |-
469469
}'
470470
settings_guide_ranking_rules_1: |-
471471
curl \
472-
-X POST 'http://localhost:7700/indexes/movies/settings' \
472+
-X PUT 'http://localhost:7700/indexes/movies/settings' \
473473
-H 'Content-Type: application/json' \
474474
--data-binary '{
475475
"rankingRules": [
@@ -485,12 +485,12 @@ settings_guide_ranking_rules_1: |-
485485
}'
486486
settings_guide_distinct_1: |-
487487
curl \
488-
-X POST 'http://localhost:7700/indexes/jackets/settings' \
488+
-X PUT 'http://localhost:7700/indexes/jackets/settings' \
489489
-H 'Content-Type: application/json' \
490490
--data-binary '{ "distinctAttribute": "product_id" }
491491
settings_guide_searchable_1: |-
492492
curl \
493-
-X POST 'http://localhost:7700/indexes/movies/settings' \
493+
-X PUT 'http://localhost:7700/indexes/movies/settings' \
494494
-H 'Content-Type: application/json' \
495495
--data-binary '{
496496
"searchableAttributes": [
@@ -501,7 +501,7 @@ settings_guide_searchable_1: |-
501501
}'
502502
settings_guide_displayed_1: |-
503503
curl \
504-
-X POST 'http://localhost:7700/indexes/movies/settings' \
504+
-X PUT 'http://localhost:7700/indexes/movies/settings' \
505505
-H 'Content-Type: application/json' \
506506
--data-binary '{
507507
"displayedAttributes": [
@@ -513,7 +513,7 @@ settings_guide_displayed_1: |-
513513
}'
514514
settings_guide_sortable_1: |-
515515
curl \
516-
-X POST 'http://localhost:7700/indexes/books/settings' \
516+
-X PUT 'http://localhost:7700/indexes/books/settings' \
517517
-H 'Content-Type: application/json' \
518518
--data-binary '{
519519
"sortableAttributes": [
@@ -550,7 +550,7 @@ getting_started_add_meteorites: |-
550550
--data-binary @meteorites.json
551551
getting_started_update_ranking_rules: |-
552552
curl \
553-
-X POST 'http://localhost:7700/indexes/movies/settings/ranking-rules' \
553+
-X PUT 'http://localhost:7700/indexes/movies/settings/ranking-rules' \
554554
-H 'Content-Type: application/json' \
555555
--data-binary '[
556556
"exactness",
@@ -564,7 +564,7 @@ getting_started_update_ranking_rules: |-
564564
]'
565565
getting_started_update_displayed_attributes: |-
566566
curl \
567-
-X POST 'http://localhost:7700/indexes/movies/settings/displayed-attributes' \
567+
-X PUT 'http://localhost:7700/indexes/movies/settings/displayed-attributes' \
568568
-H 'Content-Type: application/json' \
569569
--data-binary '[
570570
"title",
@@ -573,17 +573,17 @@ getting_started_update_displayed_attributes: |-
573573
]'
574574
getting_started_update_searchable_attributes: |-
575575
curl \
576-
-X POST 'http://localhost:7700/indexes/movies/settings/searchable-attributes' \
576+
-X PUT 'http://localhost:7700/indexes/movies/settings/searchable-attributes' \
577577
-H 'Content-Type: application/json' \
578578
--data-binary '["title"]'
579579
getting_started_update_stop_words: |-
580580
curl \
581-
-X POST 'http://localhost:7700/indexes/movies/settings/stop-words' \
581+
-X PUT 'http://localhost:7700/indexes/movies/settings/stop-words' \
582582
-H 'Content-Type: application/json' \
583583
--data-binary '["the"]'
584584
getting_started_synonyms: |-
585585
curl \
586-
-X POST 'http://localhost:7700/indexes/movies/settings/synonyms' \
586+
-X PUT 'http://localhost:7700/indexes/movies/settings/synonyms' \
587587
-H 'Content-Type: application/json' \
588588
--data-binary '{
589589
"winnie": ["piglet"],
@@ -614,7 +614,7 @@ getting_started_sorting: |-
614614
}'
615615
getting_started_configure_settings: |-
616616
curl \
617-
-X POST 'http://localhost:7700/indexes/meteorites/settings' \
617+
-X PUT 'http://localhost:7700/indexes/meteorites/settings' \
618618
-H 'Content-Type: application/json' \
619619
--data-binary '{
620620
"filterableAttributes": [
@@ -632,7 +632,7 @@ getting_started_communicating_with_a_protected_instance: |-
632632
-H 'Authorization: Bearer API_KEY'
633633
faceted_search_update_settings_1: |-
634634
curl \
635-
-X POST 'http://localhost:7700/indexes/movies/settings' \
635+
-X PUT 'http://localhost:7700/indexes/movies/settings' \
636636
-H 'Content-Type: application/json' \
637637
--data-binary '{
638638
"filterableAttributes": [
@@ -654,13 +654,13 @@ faceted_search_filter_1: |-
654654
"director = \"Jordan Peele\""
655655
]
656656
}'
657-
faceted_search_facets_distribution_1: |-
657+
faceted_search_facets_1: |-
658658
curl \
659659
-X POST 'http://localhost:7700/indexes/movies/search' \
660660
-H 'Content-Type: application/json' \
661661
--data-binary '{
662662
"q": "Batman",
663-
"facetsDistribution": ["genres"]
663+
"facets": ["genres"]
664664
}'
665665
faceted_search_walkthrough_filter_1: |-
666666
curl \
@@ -689,15 +689,15 @@ authorization_header_1: |-
689689
-H 'Authorization: Bearer MASTER_KEY'
690690
sorting_guide_update_sortable_attributes_1: |-
691691
curl \
692-
-X POST 'http://localhost:7700/indexes/books/settings/sortable-attributes' \
692+
-X PUT 'http://localhost:7700/indexes/books/settings/sortable-attributes' \
693693
-H 'Content-Type: application/json' \
694694
--data-binary '[
695695
"author",
696696
"price"
697697
]'
698698
sorting_guide_update_ranking_rules_1: |-
699699
curl \
700-
-X POST 'http://localhost:7700/indexes/books/settings/ranking-rules' \
700+
-X PUT 'http://localhost:7700/indexes/books/settings/ranking-rules' \
701701
-H 'Content-Type: application/json' \
702702
--data-binary '[
703703
"words",
@@ -728,7 +728,7 @@ get_sortable_attributes_1: |-
728728
-X GET 'http://localhost:7700/indexes/books/settings/sortable-attributes'
729729
update_sortable_attributes_1: |-
730730
curl \
731-
-X POST 'http://localhost:7700/indexes/books/settings/sortable-attributes' \
731+
-X PUT 'http://localhost:7700/indexes/books/settings/sortable-attributes' \
732732
-H 'Content-Type: application/json' \
733733
--data-binary '[
734734
"price",
@@ -747,7 +747,7 @@ search_parameter_guide_sort_1: |-
747747
}'
748748
geosearch_guide_filter_settings_1: |-
749749
curl \
750-
-X POST 'http://localhost:7700/indexes/restaurants/settings/filterable-attributes' \
750+
-X PUT 'http://localhost:7700/indexes/restaurants/settings/filterable-attributes' \
751751
-H 'Content-type:application/json' \
752752
--data-binary '["_geo"]'
753753
geosearch_guide_filter_usage_1: |-
@@ -762,7 +762,7 @@ geosearch_guide_filter_usage_2: |-
762762
--data-binary '{ "filter": "_geoRadius(45.472735, 9.184019, 2000) AND type = pizza" }'
763763
geosearch_guide_sort_settings_1: |-
764764
curl \
765-
-X POST 'http://localhost:7700/indexes/restaurants/settings/sortable-attributes' \
765+
-X PUT 'http://localhost:7700/indexes/restaurants/settings/sortable-attributes' \
766766
-H 'Content-type:application/json' \
767767
--data-binary '["_geo"]'
768768
geosearch_guide_sort_usage_1: |-
@@ -835,7 +835,7 @@ primary_field_guide_add_document_primary_key: |-
835835
]'
836836
primary_field_guide_update_document_primary_key: |-
837837
curl \
838-
-X PUT 'http://localhost:7700/indexes/books' \
838+
-X PATCH 'http://localhost:7700/indexes/books' \
839839
-H 'Content-Type: application/json' \
840840
--data-binary '{ "primaryKey": "title" }'
841841
tenant_token_guide_search_no_sdk_1: |-
@@ -847,7 +847,7 @@ get_typo_tolerance_1: |-
847847
-X GET 'http://localhost:7700/indexes/books/settings/typo-tolerance'
848848
update_typo_tolerance_1: |-
849849
curl \
850-
-X POST 'http://localhost:7700/indexes/books/settings/typo-tolerance' \
850+
-X PATCH 'http://localhost:7700/indexes/books/settings/typo-tolerance' \
851851
-H 'Content-Type: application/json' \
852852
--data-binary '{
853853
"minWordSizeForTypos": {
@@ -861,17 +861,17 @@ reset_typo_tolerance_1: |-
861861
-X DELETE 'http://localhost:7700/indexes/books/settings/typo-tolerance'
862862
typo_tolerance_guide_1: |-
863863
curl \
864-
-X POST 'http://localhost:7700/indexes/movies/settings/typo-tolerance' \
864+
-X PATCH 'http://localhost:7700/indexes/movies/settings/typo-tolerance' \
865865
-H 'Content-Type: application/json' \
866866
--data-binary '{ "enabled": false }'
867867
typo_tolerance_guide_2: |-
868868
curl \
869-
-X POST 'http://localhost:7700/indexes/movies/settings/typo-tolerance' \
869+
-X PATCH 'http://localhost:7700/indexes/movies/settings/typo-tolerance' \
870870
-H 'Content-Type: application/json' \
871871
--data-binary '{ "disableOnAttributes": ["title"] }'
872872
typo_tolerance_guide_3: |-
873873
curl \
874-
-X POST 'http://localhost:7700/indexes/movies/settings/typo-tolerance' \
874+
-X PATCH 'http://localhost:7700/indexes/movies/settings/typo-tolerance' \
875875
-H 'Content-Type: application/json' \
876876
--data-binary '{
877877
"disableOnWords": [
@@ -880,7 +880,7 @@ typo_tolerance_guide_3: |-
880880
}'
881881
typo_tolerance_guide_4: |-
882882
curl \
883-
-X POST 'http://localhost:7700/indexes/movies/settings/typo-tolerance' \
883+
-X PATCH 'http://localhost:7700/indexes/movies/settings/typo-tolerance' \
884884
-H 'Content-Type: application/json' \
885885
--data-binary '{
886886
"minWordSizeForTypos": {
@@ -890,7 +890,7 @@ typo_tolerance_guide_4: |-
890890
}'
891891
settings_guide_typo_tolerance_1: |-
892892
curl \
893-
-X POST 'http://localhost:7700/indexes/movies/settings/typo-tolerance' \
893+
-X PATCH 'http://localhost:7700/indexes/movies/settings/typo-tolerance' \
894894
-H 'Content-Type: application/json' \
895895
--data-binary '{
896896
"minWordSizeForTypos": {
@@ -951,7 +951,7 @@ updating_guide_add_documents_old: |-
951951
-H 'X-Meili-API-Key: API_KEY'
952952
getting_started_typo_tolerance: |-
953953
curl \
954-
-X POST 'http://localhost:7700/indexes/movies/settings/typo-tolerance' \
954+
-X PATCH 'http://localhost:7700/indexes/movies/settings/typo-tolerance' \
955955
-H 'Content-Type: application/json' \
956956
--data-binary '{
957957
"minWordSizeForTypos": { "oneTypo": 4 }

‎.vuepress/public/sample-template.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ search_parameter_guide_limit_1: |-
6767
search_parameter_guide_retrieve_1: |-
6868
search_parameter_guide_crop_1: |-
6969
search_parameter_guide_highlight_1: |-
70-
search_parameter_guide_matches_1: |-
70+
search_parameter_guide_show_matches_position_1: |-
7171
settings_guide_synonyms_1: |-
7272
settings_guide_stop_words_1: |-
7373
settings_guide_ranking_rules_1: |-
@@ -92,7 +92,7 @@ getting_started_sorting: |-
9292
getting_started_filtering: |-
9393
faceted_search_update_settings_1: |-
9494
faceted_search_filter_1: |-
95-
faceted_search_facets_distribution_1: |-
95+
faceted_search_facets_1: |-
9696
faceted_search_walkthrough_filter_1: |-
9797
add_movies_json_1: |-
9898
post_dump_1: |-

0 commit comments

Comments
 (0)