Skip to content

Commit

Permalink
Update OpenAPI specs (#198)
Browse files Browse the repository at this point in the history
Signed-off-by: GitHub <[email protected]>
Co-authored-by: Xtansia <[email protected]>
  • Loading branch information
opensearch-trigger-bot[bot] and Xtansia authored Mar 9, 2024
1 parent 6bd8f3b commit a45b551
Showing 1 changed file with 247 additions and 0 deletions.
247 changes: 247 additions & 0 deletions OpenSearch.openapi.json
Original file line number Diff line number Diff line change
Expand Up @@ -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.",
Expand Down

0 comments on commit a45b551

Please sign in to comment.