Skip to content

Commit 06a26c1

Browse files
meili-botmeili-bot
committed
[AUTOMATION POST DEPLOYMENT] Update meilisearch-openapi.json from latest Meilisearch release
1 parent 9088ac8 commit 06a26c1

1 file changed

Lines changed: 125 additions & 6 deletions

File tree

‎assets/open-api/meilisearch-openapi.json‎

Lines changed: 125 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
"name": "MIT",
1212
"identifier": "MIT"
1313
},
14-
"version": "1.39.0"
14+
"version": "1.40.0"
1515
},
1616
"servers": [
1717
{
@@ -1031,6 +1031,7 @@
10311031
"containsFilter": false,
10321032
"network": false,
10331033
"getTaskDocumentsRoute": false,
1034+
"taskQueueCompactionRoute": false,
10341035
"compositeEmbedders": false,
10351036
"chatCompletions": false,
10361037
"multimodal": false,
@@ -1088,6 +1089,7 @@
10881089
"containsFilter": false,
10891090
"network": false,
10901091
"getTaskDocumentsRoute": false,
1092+
"taskQueueCompactionRoute": false,
10911093
"compositeEmbedders": false,
10921094
"chatCompletions": false,
10931095
"multimodal": false,
@@ -11651,6 +11653,73 @@
1165111653
]
1165211654
}
1165311655
},
11656+
"/tasks/compact": {
11657+
"post": {
11658+
"tags": [
11659+
"Async task management"
11660+
],
11661+
"summary": "Compact task queue.",
11662+
"description": "Trigger a compaction process on the task queue database and return its size before and\nafter compaction. A successful compaction requires restarting the instance before it can\nsafely resume normal writes.",
11663+
"operationId": "compact_task_queue",
11664+
"responses": {
11665+
"200": {
11666+
"description": "Task queue compaction successfully completed.",
11667+
"content": {
11668+
"application/json": {
11669+
"schema": {
11670+
"$ref": "#/components/schemas/TaskCompactionSummary"
11671+
},
11672+
"example": {
11673+
"preSize": "456 kiB",
11674+
"postSize": "123 kiB",
11675+
"status": "succeeded",
11676+
"actionRequired": "you must restart your instance"
11677+
}
11678+
}
11679+
}
11680+
},
11681+
"401": {
11682+
"description": "The authorization header is missing.",
11683+
"content": {
11684+
"application/json": {
11685+
"schema": {
11686+
"$ref": "#/components/schemas/ResponseError"
11687+
},
11688+
"example": {
11689+
"message": "The Authorization header is missing. It must use the bearer authorization method.",
11690+
"code": "missing_authorization_header",
11691+
"type": "auth",
11692+
"link": "https://docs.meilisearch.com/errors#missing_authorization_header"
11693+
}
11694+
}
11695+
}
11696+
},
11697+
"500": {
11698+
"description": "Task queue compaction failed",
11699+
"content": {
11700+
"application/json": {
11701+
"schema": {
11702+
"$ref": "#/components/schemas/TaskCompactionSummary"
11703+
},
11704+
"example": {
11705+
"status": "failed",
11706+
"errorMessage": "unexpected internal error"
11707+
}
11708+
}
11709+
}
11710+
}
11711+
},
11712+
"security": [
11713+
{
11714+
"Bearer": [
11715+
"tasks.compact",
11716+
"tasks.*",
11717+
"*"
11718+
]
11719+
}
11720+
]
11721+
}
11722+
},
1165411723
"/tasks/{task_id}": {
1165511724
"get": {
1165611725
"tags": [
@@ -12325,7 +12394,8 @@
1232512394
"webhooks.create",
1232612395
"webhooks.*",
1232712396
"indexes.compact",
12328-
"fields.post"
12397+
"fields.post",
12398+
"tasks.compact"
1232912399
]
1233012400
},
1233112401
"AllBatches": {
@@ -13039,6 +13109,7 @@
1303913109
"invalid_multi_search_max_values_per_facet",
1304013110
"invalid_multi_search_merge_facets",
1304113111
"invalid_multi_search_query_facets",
13112+
"invalid_multi_search_distinct",
1304213113
"invalid_multi_search_query_pagination",
1304313114
"invalid_multi_search_query_ranking_rules",
1304413115
"invalid_multi_search_query_position",
@@ -13812,7 +13883,7 @@
1381213883
"string",
1381313884
"null"
1381413885
],
13815-
"description": "URL of the embedder API.\n\n- Mandatory for `rest`. Optional for `openAi` and `ollama`.\n- 🌱 When modified for `openAi``, embeddings are never regenerated\n- 🏗️ When modified for `ollama` and `rest`, embeddings are always regenerated\n- If targetting URL resolving to a non-global IP (such as `localhost`), make sure that\n `--experimental-allowed-ip-networks` allows it.",
13886+
"description": "URL of the embedder API.\n\n- Mandatory for `rest`. Optional for `openAi` and `ollama`.\n- 🌱 When modified for `openAi``, embeddings are never regenerated\n- 🏗️ When modified for `ollama` and `rest`, embeddings are always regenerated\n- If targetting URL resolving to a non-global IP (such as `localhost`), make sure that\n `--experimental-allowed-ip-networks` allows it. For details on how use this parameter,\n refer to [this documentation](https://www.meilisearch.com/docs/learn/self_hosted/configure_meilisearch_at_launch#allow-requests-to-private-networks).",
1381613887
"example": "http://localhost:11434/api/embeddings"
1381713888
},
1381813889
"indexingFragments": {
@@ -14348,6 +14419,13 @@
1434814419
}
1434914420
]
1435014421
},
14422+
"distinct": {
14423+
"type": [
14424+
"string",
14425+
"null"
14426+
],
14427+
"description": "Restrict search to documents with unique values of the specified attribute across all queries.\n\n1. This applies across all queries in the request, regardless of index or remote of origin.\n2. This overrides the index-level distinct attribute.\n3. This requires that the passed field can be set as distinct in all the participating indexes."
14428+
},
1435114429
"showPerformanceDetails": {
1435214430
"type": "boolean",
1435314431
"description": "Whether to include performance details in the response"
@@ -16025,7 +16103,7 @@
1602516103
"string",
1602616104
"null"
1602716105
],
16028-
"description": "URL of the remote instance",
16106+
"description": "URL of the remote instance\n\n- If the URL of the remote instance is resolving to a non-global IP, make sure that\n `--experimental-allowed-ip-networks` allows it. For details on how use this parameter,\n refer to [this documentation](https://www.meilisearch.com/docs/learn/self_hosted/configure_meilisearch_at_launch#allow-requests-to-private-networks).",
1602916107
"example": "http://localhost:7700"
1603016108
},
1603116109
"searchApiKey": {
@@ -16145,6 +16223,13 @@
1614516223
],
1614616224
"description": "Enable the route to get documents from tasks"
1614716225
},
16226+
"taskQueueCompactionRoute": {
16227+
"type": [
16228+
"boolean",
16229+
"null"
16230+
],
16231+
"description": "Enable the route to compact the task queue database"
16232+
},
1614816233
"compositeEmbedders": {
1614916234
"type": [
1615016235
"boolean",
@@ -16962,7 +17047,7 @@
1696217047
"string",
1696317048
"null"
1696417049
],
16965-
"description": "URL of the embedder API.\n\n- Mandatory for `rest`. Optional for `openAi` and `ollama`.\n- 🌱 When modified for `openAi``, embeddings are never regenerated\n- 🏗️ When modified for `ollama` and `rest`, embeddings are always regenerated\n- If targetting URL resolving to a non-global IP (such as `localhost`), make sure that\n `--experimental-allowed-ip-networks` allows it.",
17050+
"description": "URL of the embedder API.\n\n- Mandatory for `rest`. Optional for `openAi` and `ollama`.\n- 🌱 When modified for `openAi``, embeddings are never regenerated\n- 🏗️ When modified for `ollama` and `rest`, embeddings are always regenerated\n- If targetting URL resolving to a non-global IP (such as `localhost`), make sure that\n `--experimental-allowed-ip-networks` allows it. For details on how use this parameter,\n refer to [this documentation](https://www.meilisearch.com/docs/learn/self_hosted/configure_meilisearch_at_launch#allow-requests-to-private-networks).",
1696617051
"example": "http://localhost:11434/api/embeddings"
1696717052
},
1696817053
"indexingFragments": {
@@ -18023,7 +18108,7 @@
1802318108
"string",
1802418109
"null"
1802518110
],
18026-
"description": "URL of the embedder API.\n\n- Mandatory for `rest`. Optional for `openAi` and `ollama`.\n- 🌱 When modified for `openAi``, embeddings are never regenerated\n- 🏗️ When modified for `ollama` and `rest`, embeddings are always regenerated\n- If targetting URL resolving to a non-global IP (such as `localhost`), make sure that\n `--experimental-allowed-ip-networks` allows it.",
18111+
"description": "URL of the embedder API.\n\n- Mandatory for `rest`. Optional for `openAi` and `ollama`.\n- 🌱 When modified for `openAi``, embeddings are never regenerated\n- 🏗️ When modified for `ollama` and `rest`, embeddings are always regenerated\n- If targetting URL resolving to a non-global IP (such as `localhost`), make sure that\n `--experimental-allowed-ip-networks` allows it. For details on how use this parameter,\n refer to [this documentation](https://www.meilisearch.com/docs/learn/self_hosted/configure_meilisearch_at_launch#allow-requests-to-private-networks).",
1802718112
"example": "http://localhost:11434/api/embeddings"
1802818113
},
1802918114
"indexingFragments": {
@@ -18137,6 +18222,40 @@
1813718222
}
1813818223
}
1813918224
},
18225+
"TaskCompactionSummary": {
18226+
"type": "object",
18227+
"required": [
18228+
"status"
18229+
],
18230+
"properties": {
18231+
"preSize": {
18232+
"type": "string",
18233+
"description": "Size of the task queue database before compaction."
18234+
},
18235+
"postSize": {
18236+
"type": "string",
18237+
"description": "Size of the task queue database after compaction."
18238+
},
18239+
"status": {
18240+
"$ref": "#/components/schemas/Status",
18241+
"description": "Outcome of the compaction operation."
18242+
},
18243+
"actionRequired": {
18244+
"type": [
18245+
"string",
18246+
"null"
18247+
],
18248+
"description": "Follow-up action required after a successful compaction."
18249+
},
18250+
"errorMessage": {
18251+
"type": [
18252+
"string",
18253+
"null"
18254+
],
18255+
"description": "Error message if compaction failed."
18256+
}
18257+
}
18258+
},
1814018259
"TaskView": {
1814118260
"type": "object",
1814218261
"description": "Represents the current state and details of an asynchronous task.\n\nTasks are created when you perform operations like adding documents,\nupdating settings, or creating indexes. Use this view to monitor task\nprogress and check for errors.",

0 commit comments

Comments
 (0)