From a45b5511f633f17a32361e00607aeade9a962982 Mon Sep 17 00:00:00 2001 From: "opensearch-trigger-bot[bot]" <98922864+opensearch-trigger-bot[bot]@users.noreply.github.com> Date: Sat, 9 Mar 2024 13:44:46 -0500 Subject: [PATCH] Update OpenAPI specs (#198) Signed-off-by: GitHub Co-authored-by: Xtansia --- OpenSearch.openapi.json | 247 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 247 insertions(+) diff --git a/OpenSearch.openapi.json b/OpenSearch.openapi.json index b81b9276f..fc0588afa 100644 --- a/OpenSearch.openapi.json +++ b/OpenSearch.openapi.json @@ -13060,6 +13060,253 @@ "x-version-added": "1.0" } }, + "/_plugins/_knn/stats": { + "get": { + "description": "Provides information about the current status of the k-NN plugin.", + "externalDocs": { + "description": "API Reference", + "url": "https://opensearch.org/docs/latest/search-plugins/knn/api/#stats" + }, + "operationId": "KNNStats", + "parameters": [ + { + "name": "timeout", + "in": "query", + "description": "Operation timeout.", + "schema": { + "type": "string", + "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", + "description": "Operation timeout.", + "x-data-type": "time" + } + } + ], + "responses": { + "200": { + "description": "KNNStats 200 response" + } + }, + "x-operation-group": "knn.stats", + "x-version-added": "1.0" + } + }, + "/_plugins/_knn/stats/{stat}": { + "get": { + "description": "Provides information about the current status of the k-NN plugin.", + "operationId": "KNNStats_WithStat", + "parameters": [ + { + "name": "stat", + "in": "path", + "description": "Comma-separated list of stats to retrieve; use `_all` or empty string to retrieve all stats.", + "schema": { + "type": "string", + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", + "description": "Comma-separated list of stats to retrieve; use `_all` or empty string to retrieve all stats.", + "x-enum-options": [ + "circuit_breaker_triggered", + "total_load_time", + "eviction_count", + "hit_count", + "miss_count", + "graph_memory_usage", + "graph_memory_usage_percentage", + "graph_index_requests", + "graph_index_errors", + "graph_query_requests", + "graph_query_errors", + "knn_query_requests", + "cache_capacity_reached", + "load_success_count", + "load_exception_count", + "indices_in_cache", + "script_compilations", + "script_compilation_errors", + "script_query_requests", + "script_query_errors", + "nmslib_initialized", + "faiss_initialized", + "model_index_status", + "indexing_from_model_degraded", + "training_requests", + "training_errors", + "training_memory_usage", + "training_memory_usage_percentage" + ], + "x-data-type": "array" + }, + "required": true + }, + { + "name": "timeout", + "in": "query", + "description": "Operation timeout.", + "schema": { + "type": "string", + "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", + "description": "Operation timeout.", + "x-data-type": "time" + } + } + ], + "responses": { + "200": { + "description": "KNNStats_WithStat 200 response" + } + }, + "x-operation-group": "knn.stats", + "x-version-added": "1.0" + } + }, + "/_plugins/_knn/warmup/{index}": { + "get": { + "description": "Preloads native library files into memory, reducing initial search latency for specified indexes", + "externalDocs": { + "description": "API Reference", + "url": "https://opensearch.org/docs/latest/search-plugins/knn/api/#warmup-operation" + }, + "operationId": "KNNWarmup", + "parameters": [ + { + "name": "index", + "in": "path", + "description": "Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices.", + "schema": { + "type": "string", + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", + "description": "Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices.", + "x-data-type": "array" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "KNNWarmup 200 response" + } + }, + "x-operation-group": "knn.warmup", + "x-version-added": "1.0" + } + }, + "/_plugins/_knn/{nodeId}/stats": { + "get": { + "description": "Provides information about the current status of the k-NN plugin.", + "operationId": "KNNStats_WithNodeId", + "parameters": [ + { + "name": "nodeId", + "in": "path", + "description": "Comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes.", + "schema": { + "type": "string", + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", + "description": "Comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes.", + "x-data-type": "array" + }, + "required": true + }, + { + "name": "timeout", + "in": "query", + "description": "Operation timeout.", + "schema": { + "type": "string", + "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", + "description": "Operation timeout.", + "x-data-type": "time" + } + } + ], + "responses": { + "200": { + "description": "KNNStats_WithNodeId 200 response" + } + }, + "x-operation-group": "knn.stats", + "x-version-added": "1.0" + } + }, + "/_plugins/_knn/{nodeId}/stats/{stat}": { + "get": { + "description": "Provides information about the current status of the k-NN plugin.", + "operationId": "KNNStats_WithStatNodeId", + "parameters": [ + { + "name": "nodeId", + "in": "path", + "description": "Comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes.", + "schema": { + "type": "string", + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", + "description": "Comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes.", + "x-data-type": "array" + }, + "required": true + }, + { + "name": "stat", + "in": "path", + "description": "Comma-separated list of stats to retrieve; use `_all` or empty string to retrieve all stats.", + "schema": { + "type": "string", + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", + "description": "Comma-separated list of stats to retrieve; use `_all` or empty string to retrieve all stats.", + "x-enum-options": [ + "circuit_breaker_triggered", + "total_load_time", + "eviction_count", + "hit_count", + "miss_count", + "graph_memory_usage", + "graph_memory_usage_percentage", + "graph_index_requests", + "graph_index_errors", + "graph_query_requests", + "graph_query_errors", + "knn_query_requests", + "cache_capacity_reached", + "load_success_count", + "load_exception_count", + "indices_in_cache", + "script_compilations", + "script_compilation_errors", + "script_query_requests", + "script_query_errors", + "nmslib_initialized", + "faiss_initialized", + "model_index_status", + "indexing_from_model_degraded", + "training_requests", + "training_errors", + "training_memory_usage", + "training_memory_usage_percentage" + ], + "x-data-type": "array" + }, + "required": true + }, + { + "name": "timeout", + "in": "query", + "description": "Operation timeout.", + "schema": { + "type": "string", + "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", + "description": "Operation timeout.", + "x-data-type": "time" + } + } + ], + "responses": { + "200": { + "description": "KNNStats_WithStatNodeId 200 response" + } + }, + "x-operation-group": "knn.stats", + "x-version-added": "1.0" + } + }, "/_plugins/_security/api/account": { "get": { "description": "Returns account details for the current user.",