You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: assets/open-api/meilisearch-openapi.json
+24-10Lines changed: 24 additions & 10 deletions
Original file line number
Diff line number
Diff line change
@@ -11,7 +11,7 @@
11
11
"name": "MIT",
12
12
"identifier": "MIT"
13
13
},
14
-
"version": "1.35.0"
14
+
"version": "1.36.0"
15
15
},
16
16
"servers": [
17
17
{
@@ -511,7 +511,7 @@
511
511
"Experimental features"
512
512
],
513
513
"summary": "Configure experimental features",
514
-
"description": "Enable or disable experimental features at runtime. Only features that are marked as runtime-togglable can be changed.",
514
+
"description": "Enable or disable experimental features at runtime.",
515
515
"operationId": "patch_features",
516
516
"responses": {
517
517
"200": {
@@ -1302,7 +1302,7 @@
1302
1302
"Documents"
1303
1303
],
1304
1304
"summary": "Add or update documents",
1305
-
"description": "Add a list of documents or update them if they already exist.\n\nIf you send an already existing document (same id) the old document will\nbe only partially updated according to the fields of the new document.\nThus, any fields not present in the new document are kept and remained\nunchanged.\n\nIf the provided index does not exist, it will be created.\n\nTo completely overwrite a document, see [add or replace documents route](https://docs.meilisearch.com/docs/api-reference/documents/add-or-replace-documents).\n\n> Use the reserved `_geo` object to add geo coordinates to a document.\n> `_geo` is an object made of `lat` and `lng` field.",
1305
+
"description": "Add a list of documents or update them if they already exist.\n\nIf you send an already existing document (same id) the old document will\nbe only partially updated according to the fields of the new document.\nThus, any fields not present in the new document are kept and remained\nunchanged.\n\nIf the provided index does not exist, it will be created.\n\nTo completely overwrite a document, see [add or replace documents route](/reference/api/documents/add-or-replace-documents).\n\n> Use the reserved `_geo` object to add geo coordinates to a document.\n> `_geo` is an object made of `lat` and `lng` field.",
1306
1306
"operationId": "update_documents",
1307
1307
"parameters": [
1308
1308
{
@@ -1431,7 +1431,7 @@
1431
1431
"Documents"
1432
1432
],
1433
1433
"summary": "Add or replace documents",
1434
-
"description": "Add a list of documents or replace them if they already exist.\n\nIf you send an already existing document (same id) the whole existing\ndocument will be overwritten by the new document. Fields previously in the\ndocument not present in the new document are removed.\n\nIf the provided index does not exist, it will be created.\n\nFor a partial update of the document see [add or update documents route](https://docs.meilisearch.com/docs/api-reference/documents/add-or-update-documents).\n\n> Use the reserved `_geo` object to add geo coordinates to a document.\n> `_geo` is an object made of `lat` and `lng` field.",
1434
+
"description": "Add a list of documents or replace them if they already exist.\n\nIf you send an already existing document (same id) the whole existing\ndocument will be overwritten by the new document. Fields previously in the\ndocument not present in the new document are removed.\n\nIf the provided index does not exist, it will be created.\n\nFor a partial update of the document see [add or update documents route](/reference/api/documents/add-or-update-documents).\n\n> Use the reserved `_geo` object to add geo coordinates to a document.\n> `_geo` is an object made of `lat` and `lng` field.",
1435
1435
"operationId": "replace_documents",
1436
1436
"parameters": [
1437
1437
{
@@ -1827,7 +1827,7 @@
1827
1827
"Documents"
1828
1828
],
1829
1829
"summary": "Edit documents by function",
1830
-
"description": "Use a [RHAI function](https://rhai.rs/book/engine/hello-world.html) to edit one or more documents directly in Meilisearch. The function receives each document and returns the modified document.",
1830
+
"description": "Use a [RHAI function](https://rhai.rs/book/engine/hello-world.html) to edit one or more documents directly in Meilisearch. The function receives each document and returns the modified document.\n\nThis feature is experimental and must be enabled through the experimental route.",
1831
1831
"operationId": "edit_documents_by_function",
1832
1832
"parameters": [
1833
1833
{
@@ -2488,7 +2488,7 @@
2488
2488
"Search"
2489
2489
],
2490
2490
"summary": "Search with GET",
2491
-
"description": "Search for documents matching a query in the given index.\n\n> Equivalent to the [search with POST route](https://www.meilisearch.com/docs/api-reference/search/search-with-post) in the Meilisearch API.",
2491
+
"description": "Search for documents matching a query in the given index.\n\n> Equivalent to the [search with POST route](/reference/api/search/search-with-post) in the Meilisearch API.",
2492
2492
"operationId": "search_with_url_query",
2493
2493
"parameters": [
2494
2494
{
@@ -2895,7 +2895,7 @@
2895
2895
"Search"
2896
2896
],
2897
2897
"summary": "Search with POST",
2898
-
"description": "Search for documents matching a query in the given index.\n\n> Equivalent to the [search with GET route](https://www.meilisearch.com/docs/api-reference/search/search-with-get) in the Meilisearch API.",
2898
+
"description": "Search for documents matching a query in the given index.\n\n> Equivalent to the [search with GET route](/reference/api/search/search-with-get) in the Meilisearch API.",
2899
2899
"operationId": "search_with_post",
2900
2900
"parameters": [
2901
2901
{
@@ -11235,7 +11235,7 @@
11235
11235
{
11236
11236
"name": "uuid",
11237
11237
"in": "path",
11238
-
"description": "Unique identifier of the webhook.",
11238
+
"description": "Universally unique identifier of the webhook.",
11239
11239
"required": true,
11240
11240
"schema": {
11241
11241
"type": "string",
@@ -14689,7 +14689,7 @@
14689
14689
"oneOf": [
14690
14690
{
14691
14691
"type": "string",
14692
-
"description": "Sorted by decreasing number of matched query terms.\nQuery words at the front of an attribute is considered better than if\nit was at the back.",
14692
+
"description": "Sorted by decreasing number of matched query terms.",
14693
14693
"enum": [
14694
14694
"Words"
14695
14695
]
@@ -14710,11 +14710,25 @@
14710
14710
},
14711
14711
{
14712
14712
"type": "string",
14713
-
"description": "Documents with quey words contained in more important\nattributes are considered better.",
14713
+
"description": "Documents with query words contained in more important\nattributes and at a closer-to-the-front position in it\nare considered better.",
14714
14714
"enum": [
14715
14715
"Attribute"
14716
14716
]
14717
14717
},
14718
+
{
14719
+
"type": "string",
14720
+
"description": "Documents with query words contained in more important\nattributes are considered better. Position of the\nquery words in an attribute is not considered.",
14721
+
"enum": [
14722
+
"AttributeRank"
14723
+
]
14724
+
},
14725
+
{
14726
+
"type": "string",
14727
+
"description": "Documents with query words that are closer to the front\nof an attribute are considered better. Attribute rank\nis not considered.",
14728
+
"enum": [
14729
+
"WordPosition"
14730
+
]
14731
+
},
14718
14732
{
14719
14733
"type": "string",
14720
14734
"description": "Dynamically sort at query time the documents. None, one or multiple\nAsc/Desc sortable attributes can be used in place of this criterion at\nquery time.",
0 commit comments