v0.28: API endpoint verbs update

Author: maryamsulemani97

.code-samples.meilisearch.yaml

@@ -136,7 +136,7 @@ get_settings_1: |-
     -X GET 'http://localhost:7700/indexes/movies/settings'
 update_settings_1: |-
   curl \
-    -X POST 'http://localhost:7700/indexes/movies/settings' \
+    -X PATCH 'http://localhost:7700/indexes/movies/settings' \
     -H 'Content-Type: application/json' \
     --data-binary '{
       "rankingRules": [
@@ -193,7 +193,7 @@ get_synonyms_1: |-
     -X GET 'http://localhost:7700/indexes/movies/settings/synonyms'
 update_synonyms_1: |-
   curl \
-    -X POST 'http://localhost:7700/indexes/movies/settings/synonyms' \
+    -X PUT 'http://localhost:7700/indexes/movies/settings/synonyms' \
     -H 'Content-Type: application/json' \
     --data-binary '{
       "wolverine": [
@@ -214,7 +214,7 @@ get_stop_words_1: |-
     -X GET 'http://localhost:7700/indexes/movies/settings/stop-words'
 update_stop_words_1: |-
   curl \
-    -X POST 'http://localhost:7700/indexes/movies/settings/stop-words' \
+    -X PUT 'http://localhost:7700/indexes/movies/settings/stop-words' \
     -H 'Content-Type: application/json' \
     --data-binary '[
       "the",
@@ -229,7 +229,7 @@ get_ranking_rules_1: |-
     -X GET 'http://localhost:7700/indexes/movies/settings/ranking-rules'
 update_ranking_rules_1: |-
   curl \
-    -X POST 'http://localhost:7700/indexes/movies/settings/ranking-rules' \
+    -X PUT 'http://localhost:7700/indexes/movies/settings/ranking-rules' \
     -H 'Content-Type: application/json' \
     --data-binary '[
       "words",
@@ -249,7 +249,7 @@ get_distinct_attribute_1: |-
     -X GET 'http://localhost:7700/indexes/shoes/settings/distinct-attribute'
 update_distinct_attribute_1: |-
   curl \
-    -X POST 'http://localhost:7700/indexes/shoes/settings/distinct-attribute' \
+    -X PUT 'http://localhost:7700/indexes/shoes/settings/distinct-attribute' \
     -H 'Content-Type: application/json' \
     --data-binary '"skuid"'
 reset_distinct_attribute_1: |-
@@ -260,7 +260,7 @@ get_filterable_attributes_1: |-
     -X GET 'http://localhost:7700/indexes/movies/settings/filterable-attributes'
 update_filterable_attributes_1: |-
   curl \
-    -X POST 'http://localhost:7700/indexes/movies/settings/filterable-attributes' \
+    -X PUT 'http://localhost:7700/indexes/movies/settings/filterable-attributes' \
     -H 'Content-Type: application/json' \
     --data-binary '[
       "genres",
@@ -274,7 +274,7 @@ get_searchable_attributes_1: |-
     -X GET 'http://localhost:7700/indexes/movies/settings/searchable-attributes'
 update_searchable_attributes_1: |-
   curl \
-    -X POST 'http://localhost:7700/indexes/movies/settings/searchable-attributes' \
+    -X PUT 'http://localhost:7700/indexes/movies/settings/searchable-attributes' \
     -H 'Content-Type: application/json' \
     --data-binary '[
       "title",
@@ -289,7 +289,7 @@ get_displayed_attributes_1: |-
     -X GET 'http://localhost:7700/indexes/movies/settings/displayed-attributes'
 update_displayed_attributes_1: |-
   curl \
-    -X POST 'http://localhost:7700/indexes/movies/settings/displayed-attributes' \
+    -X PUT 'http://localhost:7700/indexes/movies/settings/displayed-attributes' \
     -H 'Content-Type: application/json' \
     --data-binary '[
       "title",
@@ -314,12 +314,12 @@ get_version_1: |-
     -X GET 'http://localhost:7700/version'
 distinct_attribute_guide_1: |-
   curl \
-    -X POST 'http://localhost:7700/indexes/jackets/settings' \
+    -X PUT 'http://localhost:7700/indexes/jackets/settings' \
     -H 'Content-Type: application/json' \
     --data-binary '{ "distinctAttribute": "product_id" }'
 field_properties_guide_searchable_1: |-
   curl \
-    -X POST 'http://localhost:7700/indexes/movies/settings' \
+    -X PUT 'http://localhost:7700/indexes/movies/settings' \
     -H 'Content-Type: application/json' \
     --data-binary '{
       "searchableAttributes": [
@@ -330,7 +330,7 @@ field_properties_guide_searchable_1: |-
     }'
 field_properties_guide_displayed_1: |-
   curl \
-    -X POST 'http://localhost:7700/indexes/movies/settings' \
+    -X PUT 'http://localhost:7700/indexes/movies/settings' \
     -H 'Content-Type: application/json' \
     --data-binary '{
       "displayedAttributes": [
@@ -442,7 +442,7 @@ search_parameter_guide_matches_1: |-
     }'
 settings_guide_synonyms_1: |-
   curl \
-    -X POST 'http://localhost:7700/indexes/tops/settings' \
+    -X PUT 'http://localhost:7700/indexes/tops/settings' \
     -H 'Content-Type: application/json' \
     --data-binary '{
       "synonyms": {
@@ -452,7 +452,7 @@ settings_guide_synonyms_1: |-
     }'
 settings_guide_stop_words_1: |-
   curl \
-    -X POST 'http://localhost:7700/indexes/movies/settings' \
+    -X PUT 'http://localhost:7700/indexes/movies/settings' \
     -H 'Content-Type: application/json' \
     --data-binary '{
       "stopWords": [
@@ -463,7 +463,7 @@ settings_guide_stop_words_1: |-
     }'
 settings_guide_ranking_rules_1: |-
   curl \
-    -X POST 'http://localhost:7700/indexes/movies/settings' \
+    -X PUT 'http://localhost:7700/indexes/movies/settings' \
     -H 'Content-Type: application/json' \
     --data-binary '{
       "rankingRules": [
@@ -479,12 +479,12 @@ settings_guide_ranking_rules_1: |-
     }'
 settings_guide_distinct_1: |-
   curl \
-    -X POST 'http://localhost:7700/indexes/jackets/settings' \
+    -X PUT 'http://localhost:7700/indexes/jackets/settings' \
     -H 'Content-Type: application/json' \
     --data-binary '{ "distinctAttribute": "product_id" }
 settings_guide_searchable_1: |-
   curl \
-    -X POST 'http://localhost:7700/indexes/movies/settings' \
+    -X PUT 'http://localhost:7700/indexes/movies/settings' \
     -H 'Content-Type: application/json' \
     --data-binary '{
       "searchableAttributes": [
@@ -495,7 +495,7 @@ settings_guide_searchable_1: |-
     }'
 settings_guide_displayed_1: |-
   curl \
-    -X POST 'http://localhost:7700/indexes/movies/settings' \
+    -X PUT 'http://localhost:7700/indexes/movies/settings' \
     -H 'Content-Type: application/json' \
     --data-binary '{
       "displayedAttributes": [
@@ -507,7 +507,7 @@ settings_guide_displayed_1: |-
     }'
 settings_guide_sortable_1: |-
   curl \
-    -X POST 'http://localhost:7700/indexes/books/settings' \
+    -X PUT 'http://localhost:7700/indexes/books/settings' \
     -H 'Content-Type: application/json' \
     --data-binary '{
       "sortableAttributes": [
@@ -544,7 +544,7 @@ getting_started_add_meteorites: |-
     --data-binary @meteorites.json
 getting_started_update_ranking_rules: |-
   curl \
-    -X POST 'http://localhost:7700/indexes/movies/settings/ranking-rules' \
+    -X PUT 'http://localhost:7700/indexes/movies/settings/ranking-rules' \
     -H 'Content-Type: application/json' \
     --data-binary '[
       "exactness",
@@ -558,7 +558,7 @@ getting_started_update_ranking_rules: |-
     ]'
 getting_started_update_displayed_attributes: |-
   curl \
-    -X POST 'http://localhost:7700/indexes/movies/settings/displayed-attributes' \
+    -X PUT 'http://localhost:7700/indexes/movies/settings/displayed-attributes' \
     -H 'Content-Type: application/json' \
     --data-binary '[
       "title",
@@ -567,17 +567,17 @@ getting_started_update_displayed_attributes: |-
     ]'
 getting_started_update_searchable_attributes: |-
   curl \
-    -X POST 'http://localhost:7700/indexes/movies/settings/searchable-attributes' \
+    -X PUT 'http://localhost:7700/indexes/movies/settings/searchable-attributes' \
     -H 'Content-Type: application/json' \
     --data-binary '["title"]'
 getting_started_update_stop_words: |-
   curl \
-    -X POST 'http://localhost:7700/indexes/movies/settings/stop-words' \
+    -X PUT 'http://localhost:7700/indexes/movies/settings/stop-words' \
     -H 'Content-Type: application/json' \
     --data-binary '["the"]'
 getting_started_synonyms: |-
   curl \
-    -X POST 'http://localhost:7700/indexes/movies/settings/synonyms' \
+    -X PUT 'http://localhost:7700/indexes/movies/settings/synonyms' \
     -H 'Content-Type: application/json' \
     --data-binary '{
       "winnie": ["piglet"], 
@@ -608,7 +608,7 @@ getting_started_sorting: |-
     }'
 getting_started_configure_settings: |-
   curl \
-    -X POST 'http://localhost:7700/indexes/meteorites/settings' \
+    -X PUT 'http://localhost:7700/indexes/meteorites/settings' \
     -H 'Content-Type: application/json' \
     --data-binary '{
       "filterableAttributes": [
@@ -626,7 +626,7 @@ getting_started_communicating_with_a_protected_instance: |-
     -H 'Authorization: Bearer API_KEY'    
 faceted_search_update_settings_1: |-
   curl \
-    -X POST 'http://localhost:7700/indexes/movies/settings' \
+    -X PUT 'http://localhost:7700/indexes/movies/settings' \
     -H 'Content-Type: application/json' \
     --data-binary '{
       "filterableAttributes": [
@@ -686,15 +686,15 @@ authorization_header_1: |-
     -H 'Authorization: Bearer MASTER_KEY'
 sorting_guide_update_sortable_attributes_1: |-
   curl \
-    -X POST 'http://localhost:7700/indexes/books/settings/sortable-attributes' \
+    -X PUT 'http://localhost:7700/indexes/books/settings/sortable-attributes' \
     -H 'Content-Type: application/json' \
     --data-binary '[
       "author",
       "price"
     ]'
 sorting_guide_update_ranking_rules_1: |-
   curl \
-    -X POST 'http://localhost:7700/indexes/books/settings/ranking-rules' \
+    -X PUT 'http://localhost:7700/indexes/books/settings/ranking-rules' \
     -H 'Content-Type: application/json' \
     --data-binary '[
       "words",
@@ -725,7 +725,7 @@ get_sortable_attributes_1: |-
     -X GET 'http://localhost:7700/indexes/books/settings/sortable-attributes'
 update_sortable_attributes_1: |-
   curl \
-    -X POST 'http://localhost:7700/indexes/books/settings/sortable-attributes' \
+    -X PUT 'http://localhost:7700/indexes/books/settings/sortable-attributes' \
     -H 'Content-Type: application/json' \
     --data-binary '[
       "price",
@@ -759,7 +759,7 @@ geosearch_guide_filter_usage_2: |-
     --data-binary '{ "filter": "_geoRadius(45.472735, 9.184019, 2000) AND type = pizza" }'
 geosearch_guide_sort_settings_1: |-
   curl \
-    -X POST 'http://localhost:7700/indexes/restaurants/settings/sortable-attributes' \
+    -X PUT 'http://localhost:7700/indexes/restaurants/settings/sortable-attributes' \
     -H 'Content-type:application/json' \
     --data-binary '["_geo"]'
 geosearch_guide_sort_usage_1: |-
@@ -844,7 +844,7 @@ get_typo_tolerance_1: |-
     -X GET 'http://localhost:7700/indexes/books/settings/typo-tolerance'
 update_typo_tolerance_1: |-
   curl \
-    -X POST 'http://localhost:7700/indexes/books/settings/typo-tolerance' \
+    -X PATCH 'http://localhost:7700/indexes/books/settings/typo-tolerance' \
     -H 'Content-Type: application/json' \
     --data-binary '{
       "minWordSizeForTypos": {
@@ -858,17 +858,17 @@ reset_typo_tolerance_1: |-
     -X DELETE 'http://localhost:7700/indexes/books/settings/typo-tolerance'
 typo_tolerance_guide_1: |-
   curl \
-    -X POST 'http://localhost:7700/indexes/movies/settings/typo-tolerance' \
+    -X PATCH 'http://localhost:7700/indexes/movies/settings/typo-tolerance' \
     -H 'Content-Type: application/json' \
     --data-binary '{ "enabled": false }'
 typo_tolerance_guide_2: |-
   curl \
-    -X POST 'http://localhost:7700/indexes/movies/settings/typo-tolerance' \
+    -X PATCH 'http://localhost:7700/indexes/movies/settings/typo-tolerance' \
     -H 'Content-Type: application/json' \
     --data-binary '{ "disableOnAttributes": ["title"] }'
 typo_tolerance_guide_3: |-
   curl \
-    -X POST 'http://localhost:7700/indexes/movies/settings/typo-tolerance' \
+    -X PATCH 'http://localhost:7700/indexes/movies/settings/typo-tolerance' \
     -H 'Content-Type: application/json' \
     --data-binary '{
       "disableOnWords": [
@@ -877,7 +877,7 @@ typo_tolerance_guide_3: |-
     }'
 typo_tolerance_guide_4: |-
   curl \
-    -X POST 'http://localhost:7700/indexes/movies/settings/typo-tolerance' \
+    -X PATCH 'http://localhost:7700/indexes/movies/settings/typo-tolerance' \
     -H 'Content-Type: application/json' \
     --data-binary '{
       "minWordSizeForTypos": {
@@ -887,7 +887,7 @@ typo_tolerance_guide_4: |-
     }'
 settings_guide_typo_tolerance_1: |-
   curl \
-    -X POST 'http://localhost:7700/indexes/movies/settings/typo-tolerance' \
+    -X PATCH 'http://localhost:7700/indexes/movies/settings/typo-tolerance' \
     -H 'Content-Type: application/json' \
     --data-binary '{
       "minWordSizeForTypos": {
@@ -953,7 +953,7 @@ updating_guide_add_documents_old: |-
     -H 'X-Meili-API-Key: API_KEY'
 getting_started_typo_tolerance: |-
   curl \
-    -X POST 'http://localhost:7700/indexes/movies/settings/typo-tolerance' \
+    -X PATCH 'http://localhost:7700/indexes/movies/settings/typo-tolerance' \
     -H 'Content-Type: application/json' \
     --data-binary '{
       "minWordSizeForTypos": { "oneTypo": 4 }

reference/api/displayed_attributes.md

@@ -38,7 +38,7 @@ List the settings.
 
 ## Update displayed attributes
 
-<RouteHighlighter method="POST" route="/indexes/{index_uid}/settings/displayed-attributes" />
+<RouteHighlighter method="PUT" route="/indexes/{index_uid}/settings/displayed-attributes" />
 
 Update the [displayed attributes](/learn/configuration/settings.md#displayed-attributes) of an index. The index [`uid`](/learn/core_concepts/indexes.md#index-uid) is required.
 

reference/api/distinct_attribute.md

@@ -30,7 +30,7 @@ Get the [distinct attribute](/learn/configuration/settings.md#distinct-attribute
 
 ## Update distinct attribute
 
-<RouteHighlighter method="POST" route="/indexes/{index_uid}/settings/distinct-attribute" />
+<RouteHighlighter method="PUT" route="/indexes/{index_uid}/settings/distinct-attribute" />
 
 Update the [distinct attribute](/learn/configuration/settings.md#distinct-attribute) field of an index. This will re-index all documents in the index. The index [`uid`](/learn/core_concepts/indexes.md#index-uid) is required.
 

reference/api/filterable_attributes.md

@@ -34,7 +34,7 @@ List the settings.
 
 ## Update filterable attributes
 
-<RouteHighlighter method="POST" route="/indexes/{index_uid}/settings/filterable-attributes" />
+<RouteHighlighter method="PUT" route="/indexes/{index_uid}/settings/filterable-attributes" />
 
 Update an index's [filterable attributes list](/learn/advanced/filtering_and_faceted_search.md). This will re-index all documents in the index. The index [`uid`](/learn/core_concepts/indexes.md#index-uid) is required.
 

reference/api/ranking_rules.md

@@ -44,7 +44,7 @@ List the settings.
 
 ## Update ranking rules
 
-<RouteHighlighter method="POST" route="/indexes/{index_uid}/settings/ranking-rules" />
+<RouteHighlighter method="PUT" route="/indexes/{index_uid}/settings/ranking-rules" />
 
 Update the [ranking rules](/learn/core_concepts/relevancy.md#ranking-rules) of an index. The index [`uid`](/learn/core_concepts/indexes.md#index-uid) is required.
 

reference/api/searchable_attributes.md

@@ -37,7 +37,7 @@ List the settings.
 
 ## Update searchable attributes
 
-<RouteHighlighter method="POST" route="/indexes/{index_uid}/settings/searchable-attributes" />
+<RouteHighlighter method="PUT" route="/indexes/{index_uid}/settings/searchable-attributes" />
 
 Update the [searchable attributes](/learn/configuration/displayed_searchable_attributes.md#searchable-fields) of an index. This will re-index all documents in the index. The index [`uid`](/learn/core_concepts/indexes.md#index-uid) is required.
 

reference/api/settings.md

@@ -103,7 +103,7 @@ List the settings.
 
 ## Update settings
 
-<RouteHighlighter method="POST" route="/indexes/{index_uid}/settings" />
+<RouteHighlighter method="PATCH" route="/indexes/{index_uid}/settings" />
 
 Update the settings of an index. The index [`uid`](/learn/core_concepts/indexes.md#index-uid) is required.
 

reference/api/sortable_attributes.md

@@ -33,7 +33,7 @@ List the settings.
 
 ## Update sortable attributes
 
-<RouteHighlighter method="POST" route="/indexes/{index_uid}/settings/sortable-attributes" />
+<RouteHighlighter method="PUT" route="/indexes/{index_uid}/settings/sortable-attributes" />
 
 Update an index's sortable attributes list. This will re-index all documents in the index. This will re-index all documents in the index. The index [`uid`](/learn/core_concepts/indexes.md#index-uid) is required.
 

reference/api/stop_words.md

@@ -38,7 +38,7 @@ Get the stop-words list of an index. The index [`uid`](/learn/core_concepts/inde
 
 ## Update stop-words
 
-<RouteHighlighter method="POST" route="/indexes/{index_uid}/settings/stop-words" />
+<RouteHighlighter method="PUT" route="/indexes/{index_uid}/settings/stop-words" />
 
 Update the list of stop-words of an index. This will re-index all documents in the index. The index [`uid`](/learn/core_concepts/indexes.md#index-uid) is required.
 

reference/api/synonyms.md

@@ -42,7 +42,7 @@ Get the list of [synonyms](/learn/configuration/synonyms.md) of an index. The in
 
 ## Update synonyms
 
-<RouteHighlighter method="POST" route="/indexes/{index_uid}/settings/synonyms"/>
+<RouteHighlighter method="PUT" route="/indexes/{index_uid}/settings/synonyms"/>
 
 Update the list of [synonyms](/learn/configuration/synonyms.md) of an index. Synonyms are [normalized](/learn/configuration/synonyms.md#normalization). The index [`uid`](/learn/core_concepts/indexes.md#index-uid) is required.
 

reference/api/typo_tolerance.md

@@ -61,7 +61,7 @@ An array of attributes for which the typo tolerance feature is disabled.
 
 ## Update typo tolerance
 
-<RouteHighlighter method="POST" route="/indexes/{index_uid}/settings/typo-tolerance"/>
+<RouteHighlighter method="PATCH" route="/indexes/{index_uid}/settings/typo-tolerance"/>
 
 Partially update the typo tolerance settings for an index. The index [`uid`](/learn/core_concepts/indexes.md#index-uid) is required.