Skip to content

Commit

Permalink
Update OpenAPI specs (#204)
Browse files Browse the repository at this point in the history 
Signed-off-by: GitHub <noreply@github.com>
Co-authored-by: dblock <dblock@users.noreply.github.com>
  • Loading branch information
@opensearch-trigger-bot @dblock
opensearch-trigger-bot[bot] and dblock committed Mar 21, 2024
1 parent d1b6535 commit 3763fdd
Showing 1 changed file with 64 additions and 4 deletions.
68 changes: 64 additions & 4 deletions OpenSearch.openapi.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8228,6 +8228,16 @@
"description": "Specify whether the index should be flushed after performing the operation."
}
},
{
"name": "primary_only",
"in": "query",
"description": "Specify whether the operation should only perform on primary shards. Defaults to false.",
"schema": {
"type": "boolean",
"default": false,
"description": "Specify whether the operation should only perform on primary shards. Defaults to false."
}
},
{
"name": "ignore_unavailable",
"in": "query",
Expand Down Expand Up @@ -13189,13 +13199,13 @@
"x-version-added": "1.0"
}
},
"/_plugins/_knn/{nodeId}/stats": {
"/_plugins/_knn/{node_id}/stats": {
"get": {
"description": "Provides information about the current status of the k-NN plugin.",
"operationId": "KNNStats_WithNodeId",
"parameters": [
{
"name": "nodeId",
"name": "node_id",
"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": {
Expand Down Expand Up @@ -13227,13 +13237,13 @@
"x-version-added": "1.0"
}
},
"/_plugins/_knn/{nodeId}/stats/{stat}": {
"/_plugins/_knn/{node_id}/stats/{stat}": {
"get": {
"description": "Provides information about the current status of the k-NN plugin.",
"operationId": "KNNStats_WithStatNodeId",
"parameters": [
{
"name": "nodeId",
"name": "node_id",
"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": {
Expand Down Expand Up @@ -16433,6 +16443,16 @@
"type": "string",
"description": "Customizable sequence of processing stages applied to search queries."
}
},
{
"name": "include_named_queries_score",
"in": "query",
"description": "Indicates whether hit.matched_queries should be rendered as a map that includes the name of the matched query associated with its score (true) or as an array containing the name of the matched queries (false)",
"schema": {
"type": "boolean",
"default": false,
"description": "Indicates whether hit.matched_queries should be rendered as a map that includes the name of the matched query associated with its score (true) or as an array containing the name of the matched queries (false)"
}
}
],
"responses": {
Expand Down Expand Up @@ -16926,6 +16946,16 @@
"type": "string",
"description": "Customizable sequence of processing stages applied to search queries."
}
},
{
"name": "include_named_queries_score",
"in": "query",
"description": "Indicates whether hit.matched_queries should be rendered as a map that includes the name of the matched query associated with its score (true) or as an array containing the name of the matched queries (false)",
"schema": {
"type": "boolean",
"default": false,
"description": "Indicates whether hit.matched_queries should be rendered as a map that includes the name of the matched query associated with its score (true) or as an array containing the name of the matched queries (false)"
}
}
],
"responses": {
Expand Down Expand Up @@ -25493,6 +25523,16 @@
"description": "Specify whether the index should be flushed after performing the operation."
}
},
{
"name": "primary_only",
"in": "query",
"description": "Specify whether the operation should only perform on primary shards. Defaults to false.",
"schema": {
"type": "boolean",
"default": false,
"description": "Specify whether the operation should only perform on primary shards. Defaults to false."
}
},
{
"name": "ignore_unavailable",
"in": "query",
Expand Down Expand Up @@ -27741,6 +27781,16 @@
"type": "string",
"description": "Customizable sequence of processing stages applied to search queries."
}
},
{
"name": "include_named_queries_score",
"in": "query",
"description": "Indicates whether hit.matched_queries should be rendered as a map that includes the name of the matched query associated with its score (true) or as an array containing the name of the matched queries (false)",
"schema": {
"type": "boolean",
"default": false,
"description": "Indicates whether hit.matched_queries should be rendered as a map that includes the name of the matched query associated with its score (true) or as an array containing the name of the matched queries (false)"
}
}
],
"responses": {
Expand Down Expand Up @@ -28253,6 +28303,16 @@
"type": "string",
"description": "Customizable sequence of processing stages applied to search queries."
}
},
{
"name": "include_named_queries_score",
"in": "query",
"description": "Indicates whether hit.matched_queries should be rendered as a map that includes the name of the matched query associated with its score (true) or as an array containing the name of the matched queries (false)",
"schema": {
"type": "boolean",
"default": false,
"description": "Indicates whether hit.matched_queries should be rendered as a map that includes the name of the matched query associated with its score (true) or as an array containing the name of the matched queries (false)"
}
}
],
"responses": {
Expand Down

0 comments on commit 3763fdd

Please sign in to comment.