Merge #1288

1288: v0.25 r=guimachiavelli a=guimachiavelli This is a hub PR for all v0.25-related updates. Please, do not add any changes directly to it; instead, create a new branch based off this PR's branch. Co-authored-by: gui machiavelli <hey@guimachiavelli.com> Co-authored-by: Maryam Sulemani <maryam@meilisearch.com> Co-authored-by: maryamsulemani97 <90181761+maryamsulemani97@users.noreply.github.com>
meilisearch · Jan 11, 2022 · d734999 · d734999
2 parents 328c04c + f34d8da
commit d734999
Show file tree

Hide file tree

Showing 42 changed files with 1,531 additions and 515 deletions.
diff --git a/.code-samples.meilisearch.yaml b/.code-samples.meilisearch.yaml
@@ -76,16 +76,62 @@ search_post_1: |-
 search_get_1: |-
   curl \
     -X GET 'http://localhost:7700/indexes/movies/search?q=american%20ninja'
-get_update_1: |-
+get_task_by_index_1: |-
   curl \
-    -X GET 'http://localhost:7700/indexes/movies/updates/1'
-get_all_updates_1: |-
+    -X GET 'http://localhost:7700/indexes/movies/tasks/1'
+get_all_tasks_1: |-
   curl \
-    -X GET 'http://localhost:7700/indexes/movies/updates'
-get_keys_1: |-
+    -X GET 'http://localhost:7700/tasks'
+get_task_1: |-
   curl \
-    -H "X-Meili-API-Key: 123" \
-    -X GET 'http://localhost:7700/keys'
+    -X GET 'http://localhost:7700/tasks/1'
+get_all_tasks_by_index_1: |-
+  curl \
+    -X GET 'http://localhost:7700/indexes/movies/tasks'
+get_one_key_1: |-
+  curl \
+    -X GET 'http://localhost:7700/keys/d0552b41536279a0ad88bd595327b96f01176a60c2243e906c52ac02375f9bc4' \
+    -H 'Authorization: Bearer masterKey'
+get_all_keys_1: |-
+  curl \
+    -X GET 'http://localhost:7700/keys' \
+    -H 'Authorization: Bearer masterKey'
+create_a_key_1: |-
+  curl \
+    -X POST 'http://localhost:7700/keys' \
+    -H 'Authorization: Bearer masterKey' \
+    -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/d0552b41536279a0ad88bd595327b96f01176a60c2243e906c52ac02375f9bc4' \
+    -H 'Authorization: Bearer masterKey' \
+    -H 'Content-Type: application/json' \
+    --data-binary '{
+      "description": "Manage documents: Products/Reviews API key",
+      "actions": [
+        "documents.add",
+        "documents.delete"
+      ],
+      "indexes": [
+        "products",
+        "reviews"
+      ],
+      "expiresAt": "2042-04-02T00:42:42Z"
+    }'
+delete_a_key_1: |-
+  curl \
+    -X DELETE 'http://localhost:7700/keys/d0552b41536279a0ad88bd595327b96f01176a60c2243e906c52ac02375f9bc4' \
+    -H 'Authorization: Bearer masterKey'
 get_settings_1: |-
   curl \
     -X GET 'http://localhost:7700/indexes/movies/settings'
@@ -462,9 +508,9 @@ phrase_search_1: |-
   curl -X POST 'http://localhost:7700/indexes/movies/search' \
   -H 'Content-Type: application/json' \
   --data-binary '{ "q": "\"african american\" horror" }'
-authentication_header_1: |-
+authorization_header_1: |-
   curl -X GET 'http://127.0.0.1:7700/keys' \
-    -H 'X-Meili-API-Key: masterKey'
+    -H 'Authorization: Bearer masterKey'
 sorting_guide_update_sortable_attributes_1: |-
   curl \
   -X POST 'http://localhost:7700/indexes/books/settings/sortable-attributes' \
@@ -559,6 +605,38 @@ geosearch_guide_sort_usage_2: |-
   curl -X POST 'http://localhost:7700/indexes/restaurants/search' \
     -H 'Content-type:application/json' \
     --data-binary '{ "sort": ["_geoPoint(48.8583701,2.2922926):asc", "rating:desc"] }'
+security_guide_search_key_1: |-
+  curl -X POST 'http://127.0.0.1:7700/indexes/patient_medical_records/search' \
+    -H 'Authorization: Bearer apiKey'
+security_guide_update_key_1: |-
+  curl \
+    -X PATCH 'http://localhost:7700/keys/d0552b41536279a0ad88bd595327b96f01176a60c2243e906c52ac02375f9bc4' \
+    -H 'Authorization: Bearer masterKey' \
+    -H 'Content-Type: application/json' \
+    --data-binary '{
+      "indexes": ["doctors"]
+    }'
+security_guide_create_key_1: |-
+  curl \
+    -X POST 'http://localhost:7700/keys' \
+    -H 'Content-Type: application/json' \
+    -H 'Authorization: Bearer masterKey' \
+    --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 masterKey'
+security_guide_delete_key_1: |-
+  curl \
+    -X DELETE 'http://localhost:7700/keys/d0552b41536279a0ad88bd595327b96f01176a60c2243e906c52ac02375f9bc4' \
+    -H 'Authorization: Bearer masterKey'
 document_guide_create_index_primary_key: |-
   curl \
     -X POST 'http://localhost:7700/indexes' \

diff --git a/.vuepress/config.js b/.vuepress/config.js
@@ -1,6 +1,6 @@
 const ogprefix = 'og: http://ogp.me/ns#'
 module.exports = {
-  title: 'MeiliSearch Documentation v0.24',
+  title: 'MeiliSearch Documentation v0.25',
   description: 'Open source Instant Search Engine',
   themeConfig: {
     repo: 'meilisearch/MeiliSearch',
@@ -78,7 +78,7 @@ module.exports = {
           path: '/learn/advanced/',
           collapsable: false,
           children: [
-            '/learn/advanced/asynchronous_updates',
+            '/learn/advanced/asynchronous_operations',
             '/learn/advanced/snapshots_vs_dumps',
             {
               title: 'Updating MeiliSearch',
@@ -164,7 +164,6 @@ module.exports = {
           path: '/reference/features/',
           collapsable: false,
           children: [
-            '/reference/features/authentication',
             '/reference/features/configuration',
             '/reference/features/distinct',
             '/reference/features/dumps',
@@ -178,6 +177,7 @@ module.exports = {
             '/reference/features/known_limitations',
             '/reference/features/language',
             '/reference/features/search_parameters',
+            '/reference/features/security',
             '/reference/features/settings',
             '/reference/features/snapshots',
             '/reference/features/sorting',
@@ -194,7 +194,7 @@ module.exports = {
             '/reference/api/indexes',
             '/reference/api/documents',
             '/reference/api/search',
-            '/reference/api/updates',
+            '/reference/api/tasks',
             '/reference/api/keys',
             {
               title: 'Settings',

diff --git a/.vuepress/public/_redirects b/.vuepress/public/_redirects
@@ -77,8 +77,14 @@
 
 # Group filters and facets content
 /reference/api/attributes_for_faceting.html         /reference/api/filterable_attributes.html
-/reference/features/filtering.html                   /reference/features/filtering_and_faceted_search.html
-/reference/features/faceted_search.html              /reference/features/filtering_and_faceted_search.html
+/reference/features/filtering.html                  /reference/features/filtering_and_faceted_search.html
+/reference/features/faceted_search.html             /reference/features/filtering_and_faceted_search.html
+
+# Rename Asynchronous updates to Asynchronous operations
+/learn/advanced/asynchronous_updates.html           /learn/advanced/asynchronous_operations.html
+
+# Rename Updates to Tasks
+/reference/api/updates.html                         /reference/api/tasks.html
 
 # Move under the hood articles to /learn
 /reference/under_the_hood/concat.html                /learn/advanced/concat.html