.code-samples.meilisearch.yaml

# This code-samples file is used by the Meilisearch documentation
# Every example written here will be automatically fetched by
# the documentation on build
---
get_one_index_1: |-
  curl \
    -X GET 'http://localhost:7700/indexes/movies'
list_all_indexes_1: |-
  curl \
    -X GET 'http://localhost:7700/indexes?limit=3'
create_an_index_1: |-
  curl \
    -X POST 'http://localhost:7700/indexes' \
    -H 'Content-Type: application/json' \
    --data-binary '{
      "uid": "movies",
      "primaryKey": "id"
    }'
update_an_index_1: |-
  curl \
    -X PATCH 'http://localhost:7700/indexes/movies' \
    -H 'Content-Type: application/json' \
    --data-binary '{ "primaryKey": "id" }'
delete_an_index_1: |-
  curl \
    -X DELETE 'http://localhost:7700/indexes/movies'
get_one_document_1: |-
  curl \
    -X GET 'http://localhost:7700/indexes/movies/documents/25684?fields=id,title,poster,release_date'
get_documents_1: |-
  curl \
    -X GET 'http://localhost:7700/indexes/movies/documents?limit=2&filter=genres=action'
add_or_replace_documents_1: |-
  curl \
    -X POST 'http://localhost:7700/indexes/movies/documents' \
    -H 'Content-Type: application/json' \
    --data-binary '[
      {
        "id": 287947,
        "title": "Shazam",
        "poster": "https://image.tmdb.org/t/p/w1280/xnopI5Xtky18MPhK40cZAGAOVeV.jpg",
        "overview": "A boy is given the ability to become an adult superhero in times of need with a single magic word.",
        "release_date": "2019-03-23"
      }
    ]'
add_or_update_documents_1: |-
  curl \
    -X PUT 'http://localhost:7700/indexes/movies/documents' \
    -H 'Content-Type: application/json' \
    --data-binary '[
      {
        "id": 287947,
        "title": "Shazam ⚡️",
        "genres": "comedy"
      }
    ]'
delete_all_documents_1: |-
  curl \
    -X DELETE 'http://localhost:7700/indexes/movies/documents'
delete_one_document_1: |-
  curl \
    -X DELETE 'http://localhost:7700/indexes/movies/documents/25684'
delete_documents_by_batch_1: |-
  curl \
    -X POST 'http://localhost:7700/indexes/movies/documents/delete-batch' \
    -H 'Content-Type: application/json' \
    --data-binary '[
      23488,
      153738,
      437035,
      363869
    ]'
search_post_1: |-
  curl \
    -X POST 'http://localhost:7700/indexes/movies/search' \
    -H 'Content-Type: application/json' \
    --data-binary '{ "q": "american ninja" }'
search_get_1: |-
  curl \
    -X GET 'http://localhost:7700/indexes/movies/search?q=american%20ninja'
get_all_tasks_1: |-
  curl \
    -X GET 'http://localhost:7700/tasks'
get_task_1: |-
  curl \
    -X GET 'http://localhost:7700/tasks/1'
get_all_tasks_paginating_1: |-
  curl \
    -X GET 'http://localhost:7700/tasks?limit=2&from=10
get_all_tasks_paginating_2: |-
  curl \
    -X GET 'http://localhost:7700/tasks?limit=2&from=8
get_one_key_1: |-
  curl \
    -X GET 'http://localhost:7700/keys/6062abda-a5aa-4414-ac91-ecd7944c0f8d' \
    -H 'Authorization: Bearer MASTER_KEY'
get_all_keys_1: |-
  curl \
    -X GET 'http://localhost:7700/keys?limit=3' \
    -H 'Authorization: Bearer MASTER_KEY'
create_a_key_1: |-
  curl \
    -X POST 'http://localhost:7700/keys' \
    -H 'Authorization: Bearer MASTER_KEY' \
    -H 'Content-Type: application/json' \
    --data-binary '{
      "description": "Add documents: Products API key",
      "actions": ["documents.add"],
      "indexes": ["products"],
      "expiresAt": "2042-04-02T00:42:42Z"
    }'
update_a_key_1: |-
  curl \
    -X PATCH 'http://localhost:7700/keys/6062abda-a5aa-4414-ac91-ecd7944c0f8d' \
    -H 'Authorization: Bearer MASTER_KEY' \
    -H 'Content-Type: application/json' \
    --data-binary '{
      "name": "Products/Reviews API key",
      "description": "Manage documents: Products/Reviews API key"
    }'
delete_a_key_1: |-
  curl \
    -X DELETE 'http://localhost:7700/keys/6062abda-a5aa-4414-ac91-ecd7944c0f8d' \
    -H 'Authorization: Bearer MASTER_KEY'
get_settings_1: |-
  curl \
    -X GET 'http://localhost:7700/indexes/movies/settings'
update_settings_1: |-
  curl \
    -X PATCH 'http://localhost:7700/indexes/movies/settings' \
    -H 'Content-Type: application/json' \
    --data-binary '{
      "rankingRules": [
        "words",
        "typo",
        "proximity",
        "attribute",
        "sort",
        "exactness",
        "release_date:desc",
        "rank:desc"
      ],
      "distinctAttribute": "movie_id",
      "searchableAttributes": [
        "title",
        "overview",
        "genres"
      ],
      "displayedAttributes": [
        "title",
        "overview",
        "genres",
        "release_date"
      ],
      "stopWords": [
        "the",
        "a",
        "an"
      ],
      "sortableAttributes": [
        "title",
        "release_date"
      ],
      "synonyms": {
        "wolverine": [
          "xmen",
          "logan"
      ],
        "logan": ["wolverine"]
      },
      "typoTolerance": {
        "minWordSizeForTypos": {
          "oneTypo": 8,
          "twoTypos": 10
        },
        "disableOnAttributes": ["title"]
      },
      "pagination": {
        "maxTotalHits": 5000
      },
      "faceting": {
        "maxValuesPerFacet": 200
      }
    }'
reset_settings_1: |-
  curl \
    -X DELETE 'http://localhost:7700/indexes/movies/settings'
get_synonyms_1: |-
  curl \
    -X GET 'http://localhost:7700/indexes/movies/settings/synonyms'
update_synonyms_1: |-
  curl \
    -X PUT 'http://localhost:7700/indexes/movies/settings/synonyms' \
    -H 'Content-Type: application/json' \
    --data-binary '{
      "wolverine": [
        "xmen",
        "logan"
      ],
      "logan": [
        "wolverine",
        "xmen"
      ],
      "wow": ["world of warcraft"]
    }'
reset_synonyms_1: |-
  curl \
    -X DELETE 'http://localhost:7700/indexes/movies/settings/synonyms'
get_stop_words_1: |-
  curl \
    -X GET 'http://localhost:7700/indexes/movies/settings/stop-words'
update_stop_words_1: |-
  curl \
    -X PUT 'http://localhost:7700/indexes/movies/settings/stop-words' \
    -H 'Content-Type: application/json' \
    --data-binary '[
      "the",
      "of",
      "to"
    ]'
reset_stop_words_1: |-
  curl \
    -X DELETE 'http://localhost:7700/indexes/movies/settings/stop-words'
get_ranking_rules_1: |-
  curl \
    -X GET 'http://localhost:7700/indexes/movies/settings/ranking-rules'
update_ranking_rules_1: |-
  curl \
    -X PUT 'http://localhost:7700/indexes/movies/settings/ranking-rules' \
    -H 'Content-Type: application/json' \
    --data-binary '[
      "words",
      "typo",
      "proximity",
      "attribute",
      "sort",
      "exactness",
      "release_date:asc",
      "rank:desc"
    ]'
reset_ranking_rules_1: |-
  curl \
    -X DELETE 'http://localhost:7700/indexes/movies/settings/ranking-rules'
get_distinct_attribute_1: |-
  curl \
    -X GET 'http://localhost:7700/indexes/shoes/settings/distinct-attribute'
update_distinct_attribute_1: |-
  curl \
    -X PUT 'http://localhost:7700/indexes/shoes/settings/distinct-attribute' \
    -H 'Content-Type: application/json' \
    --data-binary '"skuid"'
reset_distinct_attribute_1: |-
  curl \
    -X DELETE 'http://localhost:7700/indexes/shoes/settings/distinct-attribute'
get_filterable_attributes_1: |-
  curl \
    -X GET 'http://localhost:7700/indexes/movies/settings/filterable-attributes'
update_filterable_attributes_1: |-
  curl \
    -X PUT 'http://localhost:7700/indexes/movies/settings/filterable-attributes' \
    -H 'Content-Type: application/json' \
    --data-binary '[
      "genres",
      "director"
    ]'
reset_filterable_attributes_1: |-
  curl \
    -X DELETE 'http://localhost:7700/indexes/movies/settings/filterable-attributes'
get_searchable_attributes_1: |-
  curl \
    -X GET 'http://localhost:7700/indexes/movies/settings/searchable-attributes'
update_searchable_attributes_1: |-
  curl \
    -X PUT 'http://localhost:7700/indexes/movies/settings/searchable-attributes' \
    -H 'Content-Type: application/json' \
    --data-binary '[
      "title",
      "overview",
      "genres"
    ]'
reset_searchable_attributes_1: |-
  curl \
    -X DELETE 'http://localhost:7700/indexes/movies/settings/searchable-attributes'
get_displayed_attributes_1: |-
  curl \
    -X GET 'http://localhost:7700/indexes/movies/settings/displayed-attributes'
update_displayed_attributes_1: |-
  curl \
    -X PUT 'http://localhost:7700/indexes/movies/settings/displayed-attributes' \
    -H 'Content-Type: application/json' \
    --data-binary '[
      "title",
      "overview",
      "genres",
      "release_date"
    ]'
reset_displayed_attributes_1: |-
  curl \
    -X DELETE 'http://localhost:7700/indexes/movies/settings/displayed-attributes'
get_index_stats_1: |-
  curl \
    -X GET 'http://localhost:7700/indexes/movies/stats'
get_indexes_stats_1: |-
  curl \
    -X GET 'http://localhost:7700/stats'
get_health_1: |-
  curl \
    -X GET 'http://localhost:7700/health'
get_version_1: |-
  curl \
    -X GET 'http://localhost:7700/version'
distinct_attribute_guide_1: |-
  curl \
    -X PUT 'http://localhost:7700/indexes/jackets/settings/distinct-attribute' \
    -H 'Content-Type: application/json' \
    --data-binary '"product_id"'
field_properties_guide_searchable_1: |-
  curl \
    -X PUT 'http://localhost:7700/indexes/movies/settings/searchable-attributes' \
    -H 'Content-Type: application/json' \
    --data-binary '[
        "title",
        "overview",
        "genres"
      ]'
field_properties_guide_displayed_1: |-
  curl \
    -X PUT 'http://localhost:7700/indexes/movies/settings/displayed-attributes' \
    -H 'Content-Type: application/json' \
    --data-binary '[
        "title",
        "overview",
        "genres",
        "release_date"
      ]'
filtering_guide_1: |-
  curl \
    -X POST 'http://localhost:7700/indexes/movie_ratings/search' \
    -H 'Content-Type: application/json' \
    --data-binary '{
      "q": "Avengers",
      "filter": "release_date > 795484800"
    }'
filtering_guide_2: |-
  curl \
    -X POST 'http://localhost:7700/indexes/movie_ratings/search' \
    -H 'Content-Type: application/json' \
    --data-binary '{
      "q": "Batman",
      "filter": "release_date > 795484800 AND (director = \"Tim Burton\" OR director = \"Christopher Nolan\")"
    }'
filtering_guide_3: |-
  curl \
    -X POST 'http://localhost:7700/indexes/movie_ratings/search' \
    -H 'Content-Type: application/json' \
    --data-binary '{
      "q": "Planet of the Apes",
      "filter": "release_date > 1577884550 AND (NOT director = \"Tim Burton\")"
    }' \
filtering_guide_nested_1: |-
  curl \
    -X POST 'http://localhost:7700/indexes/movie_ratings/search' \
    -H 'Content-Type: application/json' \
    --data-binary '{
      "q": "thriller",
      "filter": "rating.users >= 90"
    }'
search_parameter_guide_query_1: |-
  curl \
    -X POST 'http://localhost:7700/indexes/movies/search' \
    -H 'Content-Type: application/json' \
    --data-binary '{ "q": "shifu" }'
search_parameter_guide_offset_1: |-
  curl \
    -X POST 'http://localhost:7700/indexes/movies/search' \
    -H 'Content-Type: application/json' \
    --data-binary '{
      "q": "shifu",
      "offset": 1
    }'
search_parameter_guide_limit_1: |-
  curl \
    -X POST 'http://localhost:7700/indexes/movies/search' \
    -H 'Content-Type: application/json' \
    --data-binary '{
      "q": "shifu",
      "limit": 2
    }'
search_parameter_guide_hitsperpage_1: |-
  curl \
    -X POST 'http://localhost:7700/indexes/movies/search' \
    -H 'Content-Type: application/json' \
    --data-binary '{
      "q": "",
      "hitsPerPage": 15
    }'
search_parameter_guide_page_1: |-
  curl \
    -X POST 'http://localhost:7700/indexes/movies/search' \
    -H 'Content-Type: application/json' \
    --data-binary '{
      "q": "",
      "page": 2
    }'
search_parameter_guide_retrieve_1: |-
  curl \
    -X POST 'http://localhost:7700/indexes/movies/search' \
    -H 'Content-Type: application/json' \
    --data-binary '{
      "q": "shifu",
      "attributesToRetrieve": [
        "overview",
        "title"
      ]
    }'
search_parameter_guide_crop_1: |-
  curl \
    -X POST 'http://localhost:7700/indexes/movies/search' \
    -H 'Content-Type: application/json' \
    --data-binary '{
      "q": "shifu",
      "attributesToCrop": ["overview"],
      "cropLength": 5
    }'
search_parameter_guide_crop_marker_1: |-
  curl \
    -X POST 'http://localhost:7700/indexes/movies/search' \
    -H 'Content-Type: application/json' \
    --data-binary '{
      "q": "shifu",
      "cropMarker": "[…]",
      "attributesToCrop": ["overview"]
    }'
search_parameter_guide_highlight_1: |-
  curl \
    -X POST 'http://localhost:7700/indexes/movies/search' \
    -H 'Content-Type: application/json' \
    --data-binary '{
      "q": "winter feast",
      "attributesToHighlight": ["overview"]
    }'
search_parameter_guide_highlight_tag_1: |-
  curl \
    -X POST 'http://localhost:7700/indexes/movies/search' \
    -H 'Content-Type: application/json' \
    --data-binary '{
      "q": "winter feast",
      "attributesToHighlight": ["overview"],
      "highlightPreTag": "<span class=\"highlight\">",
      "highlightPostTag": "</span>"
    }'
search_parameter_guide_show_matches_position_1: |-
  curl \
    -X POST 'http://localhost:7700/indexes/movies/search' \
    -H 'Content-Type: application/json' \
    --data-binary '{
      "q": "winter feast",
      "showMatchesPosition": true
    }'
add_movies_json_1: |-
  curl \
    -X POST 'http://localhost:7700/indexes/movies/documents'\
    -H 'Content-Type: application/json' \
    --data-binary @movies.json
getting_started_add_documents_md: |-
  ```bash
  curl \
    -X POST 'http://localhost:7700/indexes/movies/documents?primaryKey=id' \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer aSampleMasterKey' \
    --data-binary @movies.json
  ```
getting_started_check_task_status: |-
  curl \
    -X GET 'http://localhost:7700/tasks/0' \
    -H 'Authorization: Bearer aSampleMasterKey'
getting_started_search_md: |-
  ```bash
  curl \
    -X POST 'http://localhost:7700/indexes/movies/search' \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer aSampleMasterKey' \
    --data-binary '{ "q": "botman" }'
  ```
getting_started_add_meteorites: |-
  curl \
    -X POST 'http://localhost:7700/indexes/meteorites/documents' \
    -H 'Content-Type: application/json' \
    --data-binary @meteorites.json
getting_started_update_ranking_rules: |-
  curl \
    -X PUT 'http://localhost:7700/indexes/movies/settings/ranking-rules' \
    -H 'Content-Type: application/json' \
    --data-binary '[
      "exactness",
      "words",
      "typo",
      "proximity",
      "attribute",
      "sort",
      "release_date:asc",
      "rank:desc"
    ]'
getting_started_update_displayed_attributes: |-
  curl \
    -X PUT 'http://localhost:7700/indexes/movies/settings/displayed-attributes' \
    -H 'Content-Type: application/json' \
    --data-binary '[
      "title",
      "overview",
      "poster"
    ]'
getting_started_update_searchable_attributes: |-
  curl \
    -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 PUT 'http://localhost:7700/indexes/movies/settings/stop-words' \
    -H 'Content-Type: application/json' \
    --data-binary '["the"]'
getting_started_synonyms: |-
  curl \
    -X PUT 'http://localhost:7700/indexes/movies/settings/synonyms' \
    -H 'Content-Type: application/json' \
    --data-binary '{
      "winnie": ["piglet"],
      "piglet": ["winnie"]
    }'
getting_started_filtering: |-
  curl \
    -X POST 'http://localhost:7700/indexes/meteorites/search' \
    -H 'Content-Type: application/json' \
    --data-binary '{ "filter": "mass < 200" }'
getting_started_geo_radius: |-
  curl \
    -X POST 'http://localhost:7700/indexes/meteorites/search' \
    -H 'Content-type:application/json' \
    --data-binary '{ "filter": "_geoRadius(46.9480, 7.4474, 210000)" }'
getting_started_geo_point: |-
  curl \
    -X POST 'http://localhost:7700/indexes/meteorites/search' \
    -H 'Content-type:application/json' \
    --data-binary '{ "sort": ["_geoPoint(48.8583701,2.2922926):asc"] }'
getting_started_sorting: |-
  curl \
    -X POST 'http://localhost:7700/indexes/meteorites/search' \
    -H 'Content-Type: application/json' \
    --data-binary '{
      "filter": "mass < 200",
      "sort": ["mass:asc"]
    }'
getting_started_configure_settings: |-
  curl \
    -X PATCH 'http://localhost:7700/indexes/meteorites/settings' \
    -H 'Content-Type: application/json' \
    --data-binary '{
      "filterableAttributes": [
        "mass",
        "_geo"
      ],
      "sortableAttributes": [
        "mass",
        "_geo"
      ]
    }'
faceted_search_walkthrough_filter_1: |-
  curl \
    -X POST 'http://localhost:7700/indexes/movies/search' \
    -H 'Content-Type: application/json' \
    --data-binary '{
      "q": "thriller",
      "filter": [
        [
          "genres = Horror",
          "genres = Mystery"
        ],
        "director = \"Jordan Peele\""
      ]
    }'
post_dump_1: |-
  curl \
    -X POST 'http://localhost:7700/dumps'
phrase_search_1: |-
  curl \
    -X POST 'http://localhost:7700/indexes/movies/search' \
    -H 'Content-Type: application/json' \
  --data-binary '{ "q": "\"african american\" horror" }'
authorization_header_1: |-
  # replace the MASTER_KEY placeholder with your master key
  curl \
    -X GET 'http://localhost:7700/keys' \
    -H 'Authorization: Bearer MASTER_KEY'
sorting_guide_update_sortable_attributes_1: |-
  curl \
    -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 PUT 'http://localhost:7700/indexes/books/settings/ranking-rules' \
    -H 'Content-Type: application/json' \
    --data-binary '[
      "words",
      "sort",
      "typo",
      "proximity",
      "attribute",
      "exactness"
    ]'
sorting_guide_sort_nested_1: |-
  curl \
    -X POST 'http://localhost:7700/indexes/books/search' \
    -H 'Content-Type: application/json' \
    --data-binary '{
      "q": "science fiction",
      "sort": ["rating.users:asc"]
    }'
sorting_guide_sort_parameter_1: |-
  curl \
    -X POST 'http://localhost:7700/indexes/books/search' \
    -H 'Content-Type: application/json' \
    --data-binary '{
      "q": "science fiction",
      "sort": ["price:asc"]
    }'
sorting_guide_sort_parameter_2: |-
  curl \
    -X POST 'http://localhost:7700/indexes/books/search' \
    -H 'Content-Type: application/json' \
    --data-binary '{
      "q": "butler",
      "sort": ["author:desc"]
    }'
get_sortable_attributes_1: |-
  curl \
    -X GET 'http://localhost:7700/indexes/books/settings/sortable-attributes'
update_sortable_attributes_1: |-
  curl \
    -X PUT 'http://localhost:7700/indexes/books/settings/sortable-attributes' \
    -H 'Content-Type: application/json' \
    --data-binary '[
      "price",
      "author"
    ]'
reset_sortable_attributes_1: |-
  curl \
    -X DELETE 'http://localhost:7700/indexes/books/settings/sortable-attributes'
search_parameter_guide_sort_1: |-
  curl \
    -X POST 'http://localhost:7700/indexes/books/search' \
    -H 'Content-Type: application/json' \
    --data-binary '{
      "q": "science fiction",
      "sort": ["price:asc"]
    }'
geosearch_guide_filter_settings_1: |-
  curl \
    -X PUT 'http://localhost:7700/indexes/restaurants/settings/filterable-attributes' \
    -H 'Content-type:application/json' \
    --data-binary '["_geo"]'
geosearch_guide_filter_usage_1: |-
  curl \
    -X POST 'http://localhost:7700/indexes/restaurants/search' \
    -H 'Content-type:application/json' \
    --data-binary '{ "filter": "_geoRadius(45.472735, 9.184019, 2000)" }'
geosearch_guide_filter_usage_2: |-
  curl \
    -X POST 'http://localhost:7700/indexes/restaurants/search' \
    -H 'Content-type:application/json' \
    --data-binary '{ "filter": "_geoRadius(45.472735, 9.184019, 2000) AND type = pizza" }'
geosearch_guide_filter_usage_3: |-
  curl \
    -X POST 'http://localhost:7700/indexes/restaurants/search' \
    -H 'Content-type:application/json' \
    --data-binary '{ "filter": "_geoBoundingBox([45.494181, 9.214024], [45.449484, 9.179175])" }'
geosearch_guide_sort_settings_1: |-
  curl \
    -X PUT 'http://localhost:7700/indexes/restaurants/settings/sortable-attributes' \
    -H 'Content-type:application/json' \
    --data-binary '["_geo"]'
geosearch_guide_sort_usage_1: |-
  curl \
    -X POST 'http://localhost:7700/indexes/restaurants/search' \
    -H 'Content-type:application/json' \
    --data-binary '{ "sort": ["_geoPoint(48.8561446,2.2978204):asc"] }'
geosearch_guide_sort_usage_2: |-
  curl \
    -X POST 'http://localhost:7700/indexes/restaurants/search' \
    -H 'Content-type:application/json' \
    --data-binary '{
      "sort": [
        "_geoPoint(48.8561446,2.2978204):asc",
        "rating:desc"
      ]
    }'
security_guide_search_key_1: |-
  curl \
    -X POST 'http://localhost:7700/indexes/patient_medical_records/search' \
    -H 'Authorization: Bearer API_KEY'
security_guide_update_key_1: |-
  curl \
    -X PATCH 'http://localhost:7700/keys/74c9c733-3368-4738-bbe5-1d18a5fecb37 \
    -H 'Authorization: Bearer MASTER_KEY' \
    -H 'Content-Type: application/json' \
    --data-binary '{ "description": "Default Search API Key" }'
security_guide_create_key_1: |-
  curl \
    -X POST 'http://localhost:7700/keys' \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer MASTER_KEY' \
    --data-binary '{
      "description": "Search patient records key",
      "actions": ["search"],
      "indexes": ["patient_medical_records"],
      "expiresAt": "2023-01-01T00:00:00Z"
    }'
security_guide_list_keys_1: |-
  curl \
    -X GET 'http://localhost:7700/keys' \
    -H 'Authorization: Bearer MASTER_KEY'
security_guide_delete_key_1: |-
  curl \
    -X DELETE 'http://localhost:7700/keys/ac5cd97d-5a4b-4226-a868-2d0eb6d197ab' \
    -H 'Authorization: Bearer MASTER_KEY'
primary_field_guide_create_index_primary_key: |-
  curl \
    -X POST 'http://localhost:7700/indexes' \
    -H 'Content-Type: application/json' \
    --data-binary '{
      "uid": "books",
      "primaryKey": "reference_number"
    }'
primary_field_guide_add_document_primary_key: |-
  curl \
    -X POST 'http://localhost:7700/indexes/books/documents?primaryKey=reference_number' \
    -H 'Content-Type: application/json' \
    --data-binary '[
      {
        "reference_number": 287947,
        "title": "Diary of a Wimpy Kid",
        "author": "Jeff Kinney",
        "genres": [
          "comedy",
          "humor"
        ],
        "price": 5.00
      }
    ]'
primary_field_guide_update_document_primary_key: |-
  curl \
    -X PATCH 'http://localhost:7700/indexes/books' \
    -H 'Content-Type: application/json' \
    --data-binary '{ "primaryKey": "title" }'
tenant_token_guide_search_no_sdk_1: |-
  curl \
    -X POST 'http://localhost:7700/indexes/patient_medical_records/search' \
    -H 'Authorization: Bearer TENANT_TOKEN'
get_typo_tolerance_1: |-
  curl \
    -X GET 'http://localhost:7700/indexes/books/settings/typo-tolerance'
update_typo_tolerance_1: |-
  curl \
    -X PATCH 'http://localhost:7700/indexes/books/settings/typo-tolerance' \
    -H 'Content-Type: application/json' \
    --data-binary '{
      "minWordSizeForTypos": {
        "oneTypo": 4,
        "twoTypos": 10
      },
      "disableOnAttributes": ["title"]
    }'
reset_typo_tolerance_1: |-
  curl \
    -X DELETE 'http://localhost:7700/indexes/books/settings/typo-tolerance'
typo_tolerance_guide_1: |-
  curl \
    -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 PATCH 'http://localhost:7700/indexes/movies/settings/typo-tolerance' \
    -H 'Content-Type: application/json' \
    --data-binary '{ "disableOnAttributes": ["title"] }'
typo_tolerance_guide_3: |-
  curl \
    -X PATCH 'http://localhost:7700/indexes/movies/settings/typo-tolerance' \
    -H 'Content-Type: application/json' \
    --data-binary '{
      "disableOnWords": [
        "shrek"
      ]
    }'
typo_tolerance_guide_4: |-
  curl \
    -X PATCH 'http://localhost:7700/indexes/movies/settings/typo-tolerance' \
    -H 'Content-Type: application/json' \
    --data-binary '{
      "minWordSizeForTypos": {
        "oneTypo": 4,
        "twoTypos": 10
      }
    }'
updating_guide_check_version_new_authorization_header: |-
  curl \
    -X GET 'http://<your-domain-name>/version' \
    -H 'Authorization: Bearer API_KEY'
updating_guide_check_version_old_authorization_header: |-
  curl \
    -X GET 'http://<your-domain-name>/version' \
    -H 'X-Meili-API-Key: API_KEY'
updating_guide_get_displayed_attributes_old_authorization_header: |-
  # whenever you see {index_uid}, replace it with your index's unique id
  curl \
    -X GET 'http://<your-domain-name>/indexes/{index_uid}/settings/displayed-attributes' \
    -H 'X-Meili-API-Key: API_KEY'
updating_guide_reset_displayed_attributes_old_authorization_header: |-
  curl \
    -X DELETE 'http://<your-domain-name>/indexes/{index_uid}/settings/displayed-attributes' \
    -H 'X-Meili-API-Key: API_KEY'
updating_guide_create_dump: |-
  curl \
    -X POST 'http://<your-domain-name>/dumps' \
    -H 'Authorization: Bearer API_KEY'
  # -H 'X-Meili-API-Key: API_KEY' for v0.24 or below
getting_started_typo_tolerance: |-
  curl \
    -X PATCH 'http://localhost:7700/indexes/movies/settings/typo-tolerance' \
    -H 'Content-Type: application/json' \
    --data-binary '{
      "minWordSizeForTypos": { "oneTypo": 4 }
  }'
get_pagination_settings_1: |-
  curl \
    -X GET 'http://localhost:7700/indexes/books/settings/pagination'
update_pagination_settings_1: |-
  curl \
    -X PATCH 'http://localhost:7700/indexes/books/settings/pagination' \
    -H 'Content-Type: application/json' \
    --data-binary '{
      "maxTotalHits": 100
    }'
reset_pagination_settings_1: |-
  curl \
    -X DELETE 'http://localhost:7700/indexes/books/settings/pagination'
get_faceting_settings_1: |-
  curl \
    -X GET 'http://localhost:7700/indexes/books/settings/faceting'
update_faceting_settings_1: |-
  curl \
    -X PATCH 'http://localhost:7700/indexes/books/settings/faceting' \
    -H 'Content-Type: application/json' \
    --data-binary '{
      "maxValuesPerFacet": 2,
      "sortFacetValuesBy": {
        "*": "alpha",
        "genres": "count"
      }
    }'
reset_faceting_settings_1: |-
  curl \
    -X DELETE 'http://localhost:7700/indexes/books/settings/faceting'
synonyms_guide_1: |-
  curl \
    -X PUT 'http://localhost:7700/indexes/movies/settings/synonyms' \
    -H 'Content-Type: application/json' \
    --data-binary '{
      "great": ["fantastic"], "fantastic": ["great"]
    }'
getting_started_faceting: |-
  curl \
    -X PATCH 'http://localhost:7700/indexes/movies/settings/faceting' \
    -H 'Content-Type: application/json' \
    --data-binary '{
      "maxValuesPerFacet": 2,
       "sortFacetValuesBy": {
         "*": "count"
       }
    }'
getting_started_pagination: |-
  curl \
    -X PATCH 'http://localhost:7700/indexes/movies/settings/pagination' \
    -H 'Content-Type: application/json' \
    --data-binary '{
      "maxTotalHits": 500
    }'
search_parameter_guide_matching_strategy_1: |-
  curl \
    -X POST 'http://localhost:7700/indexes/movies/search' \
    -H 'Content-Type: application/json' \
    --data-binary '{
      "q": "big fat liar",
      "matchingStrategy": "last"
    }'
search_parameter_guide_matching_strategy_2: |-
  curl \
    -X POST 'http://localhost:7700/indexes/movies/search' \
    -H 'Content-Type: application/json' \
    --data-binary '{
      "q": "big fat liar",
      "matchingStrategy": "all"
    }'
date_guide_index_1: |-
  curl \
    -x POST 'http://localhost:7700/indexes/games/documents' \
    -h 'content-type: application/json' \
    --data-binary @games.json
date_guide_filterable_attributes_1: |-
  curl \
    -X PUT 'http://localhost:7700/indexes/games/settings/filterable-attributes' \
    -H 'Content-Type: application/json' \
    --data-binary '[
      "release_timestamp"
    ]'
date_guide_filter_1: |-
  curl \
    -X POST 'http://localhost:7700/indexes/games/search' \
    -H 'Content-Type: application/json' \
    --data-binary '{
      "q": "",
      "filter": "release_timestamp >= 1514761200 AND release_timestamp < 1672527600"
    }'
date_guide_sortable_attributes_1: |-
  curl \
    -X PUT 'http://localhost:7700/indexes/games/settings/sortable-attributes' \
    -H 'Content-Type: application/json' \
    --data-binary '[
      "release_timestamp"
    ]'
date_guide_sort_1: |-
  curl \
    -X POST 'http://localhost:7700/indexes/games/search' \
    -H 'Content-Type: application/json' \
    --data-binary '{
      "q": "",
      "sort": ["release_timestamp:desc"]
    }'
async_guide_filter_by_date_1: |-
  curl \
    -X GET 'http://localhost:7700/tasks?afterEnqueuedAt=2020-10-11T11:49:53.000Z'
async_guide_multiple_filters_1: |-
  curl \
    -X GET 'http://localhost:7700/tasks?indexUids=movies&types=documentAdditionOrUpdate,documentDeletion&statuses=processing'
async_guide_filter_by_ids_1: |-
  curl \
    -X GET 'http://localhost:7700/tasks?uids=5,10,13'
async_guide_filter_by_statuses_1: |-
  curl \
    -X GET 'http://localhost:7700/tasks?statuses=failed,canceled'
async_guide_filter_by_types_1: |-
  curl \
    -X GET 'http://localhost:7700/tasks?types=dumpCreation,indexSwap'
async_guide_filter_by_index_uids_1: |-
  curl \
    -X GET 'http://localhost:7700/tasks?indexUids=movies'
async_guide_canceled_by_1: |-
  curl \
    -X GET 'http://localhost:7700/tasks?canceledBy=9,15'
delete_tasks_1: |-
  curl \
    -X DELETE 'http://localhost:7700/tasks?uids=1,2'
cancel_tasks_1: |-
  curl \
    -X POST 'http://localhost:7700/tasks/cancel?uids=1,2'
swap_indexes_1: |-
  curl \
    -X POST 'http://localhost:7700/swap-indexes' \
    -H 'Content-Type: application/json' \
    --data-binary '[
      {
        "indexes": [
          "indexA",
          "indexB"
        ]
      },
      {
        "indexes": [
          "indexX",
          "indexY"
        ]
      }
    ]'
multi_search_1: |-
  curl \
    -X POST 'http://localhost:7700/multi-search' \
    -H 'Content-Type: application/json' \
    --data-binary '{
      "queries": [
        {
          "indexUid": "movies",
          "q": "pooh",
          "limit": 5
        },
        {
          "indexUid": "movies",
          "q": "nemo",
          "limit": 5
        },
        {
          "indexUid": "movie_ratings",
          "q": "us"
        }
      ]
    }'
faceted_search_update_settings_1: |-
  curl \
    -X PUT 'http://localhost:7700/indexes/books/settings/filterable-attributes' \
    -H 'Content-Type: application/json' \
    --data-binary '[
      "genres", "rating", "language"
    ]'
faceted_search_1: |-
  curl \
    -X POST 'http://localhost:7700/indexes/books/search' \
    -H 'Content-Type: application/json' \
    --data-binary '{
      "q": "classic",
      "facets": [
      "genres", "rating", "language"
    ]
  }'
search_parameter_guide_facet_stats_1: |-
  curl \
    -X POST 'http://localhost:7700/indexes/movie_ratings/search' \
    -H 'Content-Type: application/json' \
    --data-binary '{
      "q": "Batman",
      "facets": ["genres", "rating"]
    }'
filtering_update_settings_1: |-
  curl \
    -X PUT 'http://localhost:7700/indexes/movie_ratings/settings/filterable-attributes' \
    -H 'Content-Type: application/json' \
    --data-binary '[
      "genres",
      "director"
    ]'
get_documents_post_1: |-
  curl \
    -X POST http://localhost:7700/indexes/books/documents/fetch \
    -H 'Content-Type: application/json' \
    --data-binary '{
      "filter": "(rating > 3 AND (genres = Adventure OR genres = Fiction)) AND language = English",
      "fields": ["title", "genres", "rating", "language"],
      "limit": 3
    }'
delete_documents_by_filter_1: |-
  curl \
    -X POST http://localhost:7700/indexes/movies/documents/delete \
    -H 'Content-Type: application/json' \
    --data-binary '{
      "filter": "genres = action OR genres = adventure"
    }'
get_experimental_features_1: |-
  curl \
    -X GET 'http://localhost:7700/experimental-features/'
update_experimental_features_1: |-
  curl \
    -X PATCH 'http://localhost:7700/experimental-features/' \
    -H 'Content-Type: application/json'  \
    --data-binary '{
      "scoreDetails": true
    }'
facet_search_1: |-
  curl \
    -X POST 'http://localhost:7700/indexes/books/facet-search' \
    -H 'Content-Type: application/json' \
    --data-binary '{
      "facetQuery": "fiction",
      "facetName": "genres",
      "filter": "rating > 3"
    }'
facet_search_2: |-
  curl \
    -X PATCH 'http://localhost:7700/indexes/books/settings/faceting' \
    -H 'Content-Type: application/json' \
    --data-binary '{
      "sortFacetValuesBy": {
        "genres": "count"
    }
  }'
facet_search_3: |-
  curl \
    -X POST 'http://localhost:7700/indexes/books/facet-search' \
    -H 'Content-Type: application/json' \
    --data-binary '{
      "facetQuery": "c",
      "facetName": "genres"
  }'
search_parameter_guide_show_ranking_score_1: |-
  curl \
    -X POST 'http://localhost:7700/indexes/movies/search' \
    -H 'Content-Type: application/json' \
    --data-binary '{
      "q": "dragon",
      "showRankingScore": true
    }'
search_parameter_guide_attributes_to_search_on_1: |-
  curl \
    -X POST 'http://localhost:7700/indexes/movies/search' \
    -H 'Content-Type: application/json' \
    --data-binary '{
      "q": "adventure",
      "attributesToSearchOn": ["overview"]
    }'