Skip to content

Commit 95b551a

Browse files
committed
[AUTOMATION POST DEPLOYMENT] Update meilisearch-openapi.json from latest Meilisearch release
1 parent 5cd8bd9 commit 95b551a

1 file changed

Lines changed: 24 additions & 10 deletions

File tree

assets/open-api/meilisearch-openapi.json

Lines changed: 24 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
"name": "MIT",
1212
"identifier": "MIT"
1313
},
14-
"version": "1.35.0"
14+
"version": "1.36.0"
1515
},
1616
"servers": [
1717
{
@@ -511,7 +511,7 @@
511511
"Experimental features"
512512
],
513513
"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.",
515515
"operationId": "patch_features",
516516
"responses": {
517517
"200": {
@@ -1302,7 +1302,7 @@
13021302
"Documents"
13031303
],
13041304
"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.",
13061306
"operationId": "update_documents",
13071307
"parameters": [
13081308
{
@@ -1431,7 +1431,7 @@
14311431
"Documents"
14321432
],
14331433
"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.",
14351435
"operationId": "replace_documents",
14361436
"parameters": [
14371437
{
@@ -1827,7 +1827,7 @@
18271827
"Documents"
18281828
],
18291829
"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.",
18311831
"operationId": "edit_documents_by_function",
18321832
"parameters": [
18331833
{
@@ -2488,7 +2488,7 @@
24882488
"Search"
24892489
],
24902490
"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.",
24922492
"operationId": "search_with_url_query",
24932493
"parameters": [
24942494
{
@@ -2895,7 +2895,7 @@
28952895
"Search"
28962896
],
28972897
"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.",
28992899
"operationId": "search_with_post",
29002900
"parameters": [
29012901
{
@@ -11235,7 +11235,7 @@
1123511235
{
1123611236
"name": "uuid",
1123711237
"in": "path",
11238-
"description": "Unique identifier of the webhook.",
11238+
"description": "Universally unique identifier of the webhook.",
1123911239
"required": true,
1124011240
"schema": {
1124111241
"type": "string",
@@ -14689,7 +14689,7 @@
1468914689
"oneOf": [
1469014690
{
1469114691
"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.",
1469314693
"enum": [
1469414694
"Words"
1469514695
]
@@ -14710,11 +14710,25 @@
1471014710
},
1471114711
{
1471214712
"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.",
1471414714
"enum": [
1471514715
"Attribute"
1471614716
]
1471714717
},
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+
},
1471814732
{
1471914733
"type": "string",
1472014734
"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

Comments
 (0)