From a2edf045ee6b00bb0f3b3f7b751efa62b7270045 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Mon, 2 Sep 2024 00:05:47 +0000 Subject: [PATCH] Re-generate client code using latest OpenSearch API specification (2024-09-02) Signed-off-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> --- java-codegen/opensearch-openapi.yaml | 885 ++++++++++++++++++++------- 1 file changed, 649 insertions(+), 236 deletions(-) diff --git a/java-codegen/opensearch-openapi.yaml b/java-codegen/opensearch-openapi.yaml index 889bedbbdf..0abbed25c2 100644 --- a/java-codegen/opensearch-openapi.yaml +++ b/java-codegen/opensearch-openapi.yaml @@ -1501,34 +1501,6 @@ paths: responses: '200': $ref: '#/components/responses/nodes.hot_threads@200' - /_cluster/nodes/{node_id}/hotthreads: - get: - operationId: nodes.hot_threads.3 - x-operation-group: nodes.hot_threads - x-ignorable: true - deprecated: true - x-deprecation-message: The hot threads API accepts `hotthreads` but only `hot_threads` is documented - x-version-added: '1.0' - x-version-deprecated: '1.0' - description: Returns information about hot threads on each node in the cluster. - externalDocs: - url: https://opensearch.org/docs/latest/api-reference/nodes-apis/nodes-hot-threads/ - parameters: - - $ref: '#/components/parameters/nodes.hot_threads::path.node_id' - - $ref: '#/components/parameters/nodes.hot_threads::query.ignore_idle_threads' - - $ref: '#/components/parameters/nodes.hot_threads::query.interval' - - $ref: '#/components/parameters/nodes.hot_threads::query.snapshots' - - $ref: '#/components/parameters/nodes.hot_threads::query.threads' - - $ref: '#/components/parameters/nodes.hot_threads::query.timeout' - - $ref: '#/components/parameters/nodes.hot_threads::query.type' - - $ref: '#/components/parameters/_global::query.pretty' - - $ref: '#/components/parameters/_global::query.human' - - $ref: '#/components/parameters/_global::query.error_trace' - - $ref: '#/components/parameters/_global::query.source' - - $ref: '#/components/parameters/_global::query.filter_path' - responses: - '200': - $ref: '#/components/responses/nodes.hot_threads@200' /_cluster/nodes/hot_threads: get: operationId: nodes.hot_threads.0 @@ -1556,33 +1528,6 @@ paths: responses: '200': $ref: '#/components/responses/nodes.hot_threads@200' - /_cluster/nodes/hotthreads: - get: - operationId: nodes.hot_threads.1 - x-operation-group: nodes.hot_threads - x-ignorable: true - deprecated: true - x-deprecation-message: The hot threads API accepts `hotthreads` but only `hot_threads` is documented - x-version-added: '1.0' - x-version-deprecated: '1.0' - description: Returns information about hot threads on each node in the cluster. - externalDocs: - url: https://opensearch.org/docs/latest/api-reference/nodes-apis/nodes-hot-threads/ - parameters: - - $ref: '#/components/parameters/nodes.hot_threads::query.ignore_idle_threads' - - $ref: '#/components/parameters/nodes.hot_threads::query.interval' - - $ref: '#/components/parameters/nodes.hot_threads::query.snapshots' - - $ref: '#/components/parameters/nodes.hot_threads::query.threads' - - $ref: '#/components/parameters/nodes.hot_threads::query.timeout' - - $ref: '#/components/parameters/nodes.hot_threads::query.type' - - $ref: '#/components/parameters/_global::query.pretty' - - $ref: '#/components/parameters/_global::query.human' - - $ref: '#/components/parameters/_global::query.error_trace' - - $ref: '#/components/parameters/_global::query.source' - - $ref: '#/components/parameters/_global::query.filter_path' - responses: - '200': - $ref: '#/components/responses/nodes.hot_threads@200' /_cluster/pending_tasks: get: operationId: cluster.pending_tasks.0 @@ -3101,34 +3046,6 @@ paths: responses: '200': $ref: '#/components/responses/nodes.hot_threads@200' - /_nodes/{node_id}/hotthreads: - get: - operationId: nodes.hot_threads.7 - x-operation-group: nodes.hot_threads - x-ignorable: true - deprecated: true - x-deprecation-message: The hot threads API accepts `hotthreads` but only `hot_threads` is documented - x-version-added: '1.0' - x-version-deprecated: '1.0' - description: Returns information about hot threads on each node in the cluster. - externalDocs: - url: https://opensearch.org/docs/latest/api-reference/nodes-apis/nodes-hot-threads/ - parameters: - - $ref: '#/components/parameters/nodes.hot_threads::path.node_id' - - $ref: '#/components/parameters/nodes.hot_threads::query.ignore_idle_threads' - - $ref: '#/components/parameters/nodes.hot_threads::query.interval' - - $ref: '#/components/parameters/nodes.hot_threads::query.snapshots' - - $ref: '#/components/parameters/nodes.hot_threads::query.threads' - - $ref: '#/components/parameters/nodes.hot_threads::query.timeout' - - $ref: '#/components/parameters/nodes.hot_threads::query.type' - - $ref: '#/components/parameters/_global::query.pretty' - - $ref: '#/components/parameters/_global::query.human' - - $ref: '#/components/parameters/_global::query.error_trace' - - $ref: '#/components/parameters/_global::query.source' - - $ref: '#/components/parameters/_global::query.filter_path' - responses: - '200': - $ref: '#/components/responses/nodes.hot_threads@200' /_nodes/{node_id}/reload_secure_settings: post: operationId: nodes.reload_secure_settings.1 @@ -3293,33 +3210,6 @@ paths: responses: '200': $ref: '#/components/responses/nodes.hot_threads@200' - /_nodes/hotthreads: - get: - operationId: nodes.hot_threads.5 - x-operation-group: nodes.hot_threads - x-ignorable: true - deprecated: true - x-deprecation-message: The hot threads API accepts `hotthreads` but only `hot_threads` is documented - x-version-added: '1.0' - x-version-deprecated: '1.0' - description: Returns information about hot threads on each node in the cluster. - externalDocs: - url: https://opensearch.org/docs/latest/api-reference/nodes-apis/nodes-hot-threads/ - parameters: - - $ref: '#/components/parameters/nodes.hot_threads::query.ignore_idle_threads' - - $ref: '#/components/parameters/nodes.hot_threads::query.interval' - - $ref: '#/components/parameters/nodes.hot_threads::query.snapshots' - - $ref: '#/components/parameters/nodes.hot_threads::query.threads' - - $ref: '#/components/parameters/nodes.hot_threads::query.timeout' - - $ref: '#/components/parameters/nodes.hot_threads::query.type' - - $ref: '#/components/parameters/_global::query.pretty' - - $ref: '#/components/parameters/_global::query.human' - - $ref: '#/components/parameters/_global::query.error_trace' - - $ref: '#/components/parameters/_global::query.source' - - $ref: '#/components/parameters/_global::query.filter_path' - responses: - '200': - $ref: '#/components/responses/nodes.hot_threads@200' /_nodes/reload_secure_settings: post: operationId: nodes.reload_secure_settings.0 @@ -3473,6 +3363,81 @@ paths: $ref: '#/components/responses/security.get_sslinfo@200' '500': $ref: '#/components/responses/security.get_sslinfo@500' + /_plugins/_asynchronous_search: + post: + operationId: asynchronous_search.search.0 + x-operation-group: asynchronous_search.search + x-version-added: '1.0' + description: Perform an asynchronous search. + externalDocs: + url: https://opensearch.org/docs/latest/search-plugins/async/index/#rest-api + parameters: + - $ref: '#/components/parameters/asynchronous_search.search::query.index' + - $ref: '#/components/parameters/asynchronous_search.search::query.keep_alive' + - $ref: '#/components/parameters/asynchronous_search.search::query.keep_on_completion' + - $ref: '#/components/parameters/asynchronous_search.search::query.wait_for_completion_timeout' + - $ref: '#/components/parameters/_global::query.pretty' + - $ref: '#/components/parameters/_global::query.human' + - $ref: '#/components/parameters/_global::query.error_trace' + - $ref: '#/components/parameters/_global::query.source' + - $ref: '#/components/parameters/_global::query.filter_path' + requestBody: + $ref: '#/components/requestBodies/asynchronous_search.search' + responses: + '200': + $ref: '#/components/responses/asynchronous_search.search@200' + /_plugins/_asynchronous_search/{id}: + delete: + operationId: asynchronous_search.delete.0 + x-operation-group: asynchronous_search.delete + x-version-added: '1.0' + description: Delete asynchronous search. + externalDocs: + url: https://opensearch.org/docs/latest/search-plugins/async/index/#delete-searches-and-results + parameters: + - $ref: '#/components/parameters/asynchronous_search.delete::path.id' + - $ref: '#/components/parameters/_global::query.pretty' + - $ref: '#/components/parameters/_global::query.human' + - $ref: '#/components/parameters/_global::query.error_trace' + - $ref: '#/components/parameters/_global::query.source' + - $ref: '#/components/parameters/_global::query.filter_path' + responses: + '200': + $ref: '#/components/responses/asynchronous_search.delete@200' + get: + operationId: asynchronous_search.get.0 + x-operation-group: asynchronous_search.get + x-version-added: '1.0' + description: Get partial responses from asynchronous search. + externalDocs: + url: https://opensearch.org/docs/latest/search-plugins/async/index/#get-partial-results + parameters: + - $ref: '#/components/parameters/asynchronous_search.get::path.id' + - $ref: '#/components/parameters/_global::query.pretty' + - $ref: '#/components/parameters/_global::query.human' + - $ref: '#/components/parameters/_global::query.error_trace' + - $ref: '#/components/parameters/_global::query.source' + - $ref: '#/components/parameters/_global::query.filter_path' + responses: + '200': + $ref: '#/components/responses/asynchronous_search.get@200' + /_plugins/_asynchronous_search/stats: + get: + operationId: asynchronous_search.stats.0 + x-operation-group: asynchronous_search.stats + x-version-added: '1.0' + description: Monitoring of asynchronous searches that are running, completed, and/or persisted. + externalDocs: + url: https://opensearch.org/docs/latest/search-plugins/async/index/#monitor-stats + responses: + '200': + $ref: '#/components/responses/asynchronous_search.stats@200' + parameters: + - $ref: '#/components/parameters/_global::query.pretty' + - $ref: '#/components/parameters/_global::query.human' + - $ref: '#/components/parameters/_global::query.error_trace' + - $ref: '#/components/parameters/_global::query.source' + - $ref: '#/components/parameters/_global::query.filter_path' /_plugins/_knn/{node_id}/stats: get: operationId: knn.stats.2 @@ -11006,6 +10971,89 @@ paths: responses: '200': $ref: '#/components/responses/indices.validate_query@200' + /_opendistro/_asynchronous_search: + post: + operationId: asynchronous_search.search.0_superseded + x-operation-group: asynchronous_search.search + x-version-added: '1.0' + description: Perform an asynchronous search. + externalDocs: + url: https://opensearch.org/docs/latest/search-plugins/async/index/#rest-api + parameters: + - $ref: '#/components/parameters/asynchronous_search.search::query.index' + - $ref: '#/components/parameters/asynchronous_search.search::query.keep_alive' + - $ref: '#/components/parameters/asynchronous_search.search::query.keep_on_completion' + - $ref: '#/components/parameters/asynchronous_search.search::query.wait_for_completion_timeout' + - $ref: '#/components/parameters/_global::query.pretty' + - $ref: '#/components/parameters/_global::query.human' + - $ref: '#/components/parameters/_global::query.error_trace' + - $ref: '#/components/parameters/_global::query.source' + - $ref: '#/components/parameters/_global::query.filter_path' + requestBody: + $ref: '#/components/requestBodies/asynchronous_search.search' + responses: + '200': + $ref: '#/components/responses/asynchronous_search.search@200' + deprecated: true + x-ignorable: true + /_opendistro/_asynchronous_search/stats: + get: + operationId: asynchronous_search.stats.0_superseded + x-operation-group: asynchronous_search.stats + x-version-added: '1.0' + description: Monitoring of asynchronous searches that are running, completed, and/or persisted. + externalDocs: + url: https://opensearch.org/docs/latest/search-plugins/async/index/#monitor-stats + responses: + '200': + $ref: '#/components/responses/asynchronous_search.stats@200' + parameters: + - $ref: '#/components/parameters/_global::query.pretty' + - $ref: '#/components/parameters/_global::query.human' + - $ref: '#/components/parameters/_global::query.error_trace' + - $ref: '#/components/parameters/_global::query.source' + - $ref: '#/components/parameters/_global::query.filter_path' + deprecated: true + x-ignorable: true + /_opendistro/_asynchronous_search/{id}: + get: + operationId: asynchronous_search.get.0_superseded + x-operation-group: asynchronous_search.get + x-version-added: '1.0' + description: Get partial responses from asynchronous search. + externalDocs: + url: https://opensearch.org/docs/latest/search-plugins/async/index/#get-partial-results + parameters: + - $ref: '#/components/parameters/asynchronous_search.get::path.id' + - $ref: '#/components/parameters/_global::query.pretty' + - $ref: '#/components/parameters/_global::query.human' + - $ref: '#/components/parameters/_global::query.error_trace' + - $ref: '#/components/parameters/_global::query.source' + - $ref: '#/components/parameters/_global::query.filter_path' + responses: + '200': + $ref: '#/components/responses/asynchronous_search.get@200' + deprecated: true + x-ignorable: true + delete: + operationId: asynchronous_search.delete.0_superseded + x-operation-group: asynchronous_search.delete + x-version-added: '1.0' + description: Delete asynchronous search. + externalDocs: + url: https://opensearch.org/docs/latest/search-plugins/async/index/#delete-searches-and-results + parameters: + - $ref: '#/components/parameters/asynchronous_search.delete::path.id' + - $ref: '#/components/parameters/_global::query.pretty' + - $ref: '#/components/parameters/_global::query.human' + - $ref: '#/components/parameters/_global::query.error_trace' + - $ref: '#/components/parameters/_global::query.source' + - $ref: '#/components/parameters/_global::query.filter_path' + responses: + '200': + $ref: '#/components/responses/asynchronous_search.delete@200' + deprecated: true + x-ignorable: true /_opendistro/_knn/stats/{stat}: get: operationId: knn.stats.1_superseded @@ -12876,6 +12924,112 @@ paths: $ref: '#/components/responses/sql.post_stats@200' deprecated: true x-ignorable: true + /_cluster/nodes/hotthreads: + get: + operationId: nodes.hot_threads.0_superseded + x-operation-group: nodes.hot_threads + x-ignorable: true + deprecated: true + x-deprecation-message: The hot accepts /_cluster/nodes as prefix for backwards compatibility reasons + x-version-added: '1.0' + x-version-deprecated: '1.0' + description: Returns information about hot threads on each node in the cluster. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/nodes-apis/nodes-hot-threads/ + parameters: + - $ref: '#/components/parameters/nodes.hot_threads::query.ignore_idle_threads' + - $ref: '#/components/parameters/nodes.hot_threads::query.interval' + - $ref: '#/components/parameters/nodes.hot_threads::query.snapshots' + - $ref: '#/components/parameters/nodes.hot_threads::query.threads' + - $ref: '#/components/parameters/nodes.hot_threads::query.timeout' + - $ref: '#/components/parameters/nodes.hot_threads::query.type' + - $ref: '#/components/parameters/_global::query.pretty' + - $ref: '#/components/parameters/_global::query.human' + - $ref: '#/components/parameters/_global::query.error_trace' + - $ref: '#/components/parameters/_global::query.source' + - $ref: '#/components/parameters/_global::query.filter_path' + responses: + '200': + $ref: '#/components/responses/nodes.hot_threads@200' + /_cluster/nodes/{node_id}/hotthreads: + get: + operationId: nodes.hot_threads.2_superseded + x-operation-group: nodes.hot_threads + x-ignorable: true + deprecated: true + x-deprecation-message: The hot accepts /_cluster/nodes as prefix for backwards compatibility reasons + x-version-added: '1.0' + x-version-deprecated: '1.0' + description: Returns information about hot threads on each node in the cluster. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/nodes-apis/nodes-hot-threads/ + parameters: + - $ref: '#/components/parameters/nodes.hot_threads::path.node_id' + - $ref: '#/components/parameters/nodes.hot_threads::query.ignore_idle_threads' + - $ref: '#/components/parameters/nodes.hot_threads::query.interval' + - $ref: '#/components/parameters/nodes.hot_threads::query.snapshots' + - $ref: '#/components/parameters/nodes.hot_threads::query.threads' + - $ref: '#/components/parameters/nodes.hot_threads::query.timeout' + - $ref: '#/components/parameters/nodes.hot_threads::query.type' + - $ref: '#/components/parameters/_global::query.pretty' + - $ref: '#/components/parameters/_global::query.human' + - $ref: '#/components/parameters/_global::query.error_trace' + - $ref: '#/components/parameters/_global::query.source' + - $ref: '#/components/parameters/_global::query.filter_path' + responses: + '200': + $ref: '#/components/responses/nodes.hot_threads@200' + /_nodes/{node_id}/hotthreads: + get: + operationId: nodes.hot_threads.6_superseded + x-operation-group: nodes.hot_threads + x-version-added: '1.0' + description: Returns information about hot threads on each node in the cluster. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/nodes-apis/nodes-hot-threads/ + parameters: + - $ref: '#/components/parameters/nodes.hot_threads::path.node_id' + - $ref: '#/components/parameters/nodes.hot_threads::query.ignore_idle_threads' + - $ref: '#/components/parameters/nodes.hot_threads::query.interval' + - $ref: '#/components/parameters/nodes.hot_threads::query.snapshots' + - $ref: '#/components/parameters/nodes.hot_threads::query.threads' + - $ref: '#/components/parameters/nodes.hot_threads::query.timeout' + - $ref: '#/components/parameters/nodes.hot_threads::query.type' + - $ref: '#/components/parameters/_global::query.pretty' + - $ref: '#/components/parameters/_global::query.human' + - $ref: '#/components/parameters/_global::query.error_trace' + - $ref: '#/components/parameters/_global::query.source' + - $ref: '#/components/parameters/_global::query.filter_path' + responses: + '200': + $ref: '#/components/responses/nodes.hot_threads@200' + deprecated: true + x-ignorable: true + /_nodes/hotthreads: + get: + operationId: nodes.hot_threads.4_superseded + x-operation-group: nodes.hot_threads + x-version-added: '1.0' + description: Returns information about hot threads on each node in the cluster. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/nodes-apis/nodes-hot-threads/ + parameters: + - $ref: '#/components/parameters/nodes.hot_threads::query.ignore_idle_threads' + - $ref: '#/components/parameters/nodes.hot_threads::query.interval' + - $ref: '#/components/parameters/nodes.hot_threads::query.snapshots' + - $ref: '#/components/parameters/nodes.hot_threads::query.threads' + - $ref: '#/components/parameters/nodes.hot_threads::query.timeout' + - $ref: '#/components/parameters/nodes.hot_threads::query.type' + - $ref: '#/components/parameters/_global::query.pretty' + - $ref: '#/components/parameters/_global::query.human' + - $ref: '#/components/parameters/_global::query.error_trace' + - $ref: '#/components/parameters/_global::query.source' + - $ref: '#/components/parameters/_global::query.filter_path' + responses: + '200': + $ref: '#/components/responses/nodes.hot_threads@200' + deprecated: true + x-ignorable: true components: parameters: _global::query.pretty: @@ -12920,6 +13074,40 @@ components: items: type: string x-global: true + asynchronous_search.delete::path.id: + name: id + in: path + schema: + type: string + asynchronous_search.get::path.id: + name: id + in: path + schema: + type: string + asynchronous_search.search::query.index: + name: index + in: query + description: The name of the index to be searched. + schema: + type: string + asynchronous_search.search::query.keep_alive: + name: keep_alive + in: query + description: The amount of time that the result is saved in the cluster. + schema: + type: string + asynchronous_search.search::query.keep_on_completion: + name: keep_on_completion + in: query + description: Whether you want to save the results in the cluster after the search is complete. + schema: + type: boolean + asynchronous_search.search::query.wait_for_completion_timeout: + name: wait_for_completion_timeout + in: query + description: The amount of time that you plan to wait for the results. + schema: + type: string bulk::path.index: in: path name: index @@ -13188,7 +13376,7 @@ components: description: Operation timeout for connection to master node. schema: $ref: '#/components/schemas/_common:Duration' - x-version-deprecated: 2.0.0 + x-version-deprecated: '2.0' x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. deprecated: true cat.allocation::query.s: @@ -13257,7 +13445,7 @@ components: description: Operation timeout for connection to master node. schema: $ref: '#/components/schemas/_common:Duration' - x-version-deprecated: 2.0.0 + x-version-deprecated: '2.0' x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. deprecated: true cat.cluster_manager::query.s: @@ -13549,7 +13737,7 @@ components: description: Operation timeout for connection to master node. schema: $ref: '#/components/schemas/_common:Duration' - x-version-deprecated: 2.0.0 + x-version-deprecated: '2.0' x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. deprecated: true cat.indices::query.pri: @@ -13633,7 +13821,7 @@ components: description: Operation timeout for connection to master node. schema: $ref: '#/components/schemas/_common:Duration' - x-version-deprecated: 2.0.0 + x-version-deprecated: '2.0' x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. deprecated: true cat.master::query.s: @@ -13702,7 +13890,7 @@ components: description: Operation timeout for connection to master node. schema: $ref: '#/components/schemas/_common:Duration' - x-version-deprecated: 2.0.0 + x-version-deprecated: '2.0' x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. deprecated: true cat.nodeattrs::query.s: @@ -13791,7 +13979,7 @@ components: description: Operation timeout for connection to master node. schema: $ref: '#/components/schemas/_common:Duration' - x-version-deprecated: 2.0.0 + x-version-deprecated: '2.0' x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. deprecated: true cat.nodes::query.s: @@ -13866,7 +14054,7 @@ components: description: Operation timeout for connection to master node. schema: $ref: '#/components/schemas/_common:Duration' - x-version-deprecated: 2.0.0 + x-version-deprecated: '2.0' x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. deprecated: true cat.pending_tasks::query.s: @@ -13992,7 +14180,7 @@ components: description: Operation timeout for connection to master node. schema: $ref: '#/components/schemas/_common:Duration' - x-version-deprecated: 2.0.0 + x-version-deprecated: '2.0' x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. deprecated: true cat.plugins::query.s: @@ -14156,7 +14344,7 @@ components: description: Operation timeout for connection to master node. schema: $ref: '#/components/schemas/_common:Duration' - x-version-deprecated: 2.0.0 + x-version-deprecated: '2.0' x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. deprecated: true cat.repositories::query.s: @@ -14381,7 +14569,7 @@ components: description: Operation timeout for connection to master node. schema: $ref: '#/components/schemas/_common:Duration' - x-version-deprecated: 2.0.0 + x-version-deprecated: '2.0' x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. deprecated: true cat.segments::query.s: @@ -14468,7 +14656,7 @@ components: description: Operation timeout for connection to master node. schema: $ref: '#/components/schemas/_common:Duration' - x-version-deprecated: 2.0.0 + x-version-deprecated: '2.0' x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. deprecated: true cat.shards::query.s: @@ -14555,7 +14743,7 @@ components: description: Operation timeout for connection to master node. schema: $ref: '#/components/schemas/_common:Duration' - x-version-deprecated: 2.0.0 + x-version-deprecated: '2.0' x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. deprecated: true cat.snapshots::query.s: @@ -14726,7 +14914,7 @@ components: description: Operation timeout for connection to master node. schema: $ref: '#/components/schemas/_common:Duration' - x-version-deprecated: 2.0.0 + x-version-deprecated: '2.0' x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. deprecated: true cat.templates::query.s: @@ -14805,7 +14993,7 @@ components: description: Operation timeout for connection to master node. schema: $ref: '#/components/schemas/_common:Duration' - x-version-deprecated: 2.0.0 + x-version-deprecated: '2.0' x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. deprecated: true cat.thread_pool::query.s: @@ -14889,7 +15077,7 @@ components: schema: $ref: '#/components/schemas/_common:Duration' style: form - x-version-deprecated: 2.0.0 + x-version-deprecated: '2.0' x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. cluster.delete_component_template::query.timeout: in: query @@ -14952,7 +15140,7 @@ components: schema: $ref: '#/components/schemas/_common:Duration' style: form - x-version-deprecated: 2.0.0 + x-version-deprecated: '2.0' x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. cluster.get_component_template::path.name: in: path @@ -14991,7 +15179,7 @@ components: schema: $ref: '#/components/schemas/_common:Duration' style: form - x-version-deprecated: 2.0.0 + x-version-deprecated: '2.0' x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. cluster.get_decommission_awareness::path.awareness_attribute_name: name: awareness_attribute_name @@ -15034,7 +15222,7 @@ components: schema: $ref: '#/components/schemas/_common:Duration' style: form - x-version-deprecated: 2.0.0 + x-version-deprecated: '2.0' x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. cluster.get_settings::query.timeout: in: query @@ -15105,7 +15293,7 @@ components: schema: $ref: '#/components/schemas/_common:Duration' style: form - x-version-deprecated: 2.0.0 + x-version-deprecated: '2.0' x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. cluster.health::query.timeout: in: query @@ -15185,7 +15373,7 @@ components: schema: $ref: '#/components/schemas/_common:Duration' style: form - x-version-deprecated: 2.0.0 + x-version-deprecated: '2.0' x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. cluster.post_voting_config_exclusions::query.node_ids: in: query @@ -15254,7 +15442,7 @@ components: schema: $ref: '#/components/schemas/_common:Duration' style: form - x-version-deprecated: 2.0.0 + x-version-deprecated: '2.0' x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. cluster.put_component_template::query.timeout: name: timeout @@ -15301,7 +15489,7 @@ components: schema: $ref: '#/components/schemas/_common:Duration' style: form - x-version-deprecated: 2.0.0 + x-version-deprecated: '2.0' x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. cluster.put_settings::query.timeout: in: query @@ -15347,7 +15535,7 @@ components: schema: $ref: '#/components/schemas/_common:Duration' style: form - x-version-deprecated: 2.0.0 + x-version-deprecated: '2.0' x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. cluster.reroute::query.metric: in: query @@ -15440,7 +15628,7 @@ components: schema: $ref: '#/components/schemas/_common:Duration' style: form - x-version-deprecated: 2.0.0 + x-version-deprecated: '2.0' x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. cluster.state::query.wait_for_metadata_version: in: query @@ -15768,7 +15956,7 @@ components: schema: $ref: '#/components/schemas/_common:Duration' style: form - x-version-deprecated: 2.0.0 + x-version-deprecated: '2.0' x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. dangling_indices.delete_dangling_index::query.timeout: in: query @@ -15808,7 +15996,7 @@ components: schema: $ref: '#/components/schemas/_common:Duration' style: form - x-version-deprecated: 2.0.0 + x-version-deprecated: '2.0' x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. dangling_indices.import_dangling_index::query.timeout: in: query @@ -16150,7 +16338,7 @@ components: schema: $ref: '#/components/schemas/_common:Duration' style: form - x-version-deprecated: 2.0.0 + x-version-deprecated: '2.0' x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. delete_script::query.timeout: in: query @@ -16601,7 +16789,7 @@ components: schema: $ref: '#/components/schemas/_common:Duration' style: form - x-version-deprecated: 2.0.0 + x-version-deprecated: '2.0' x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. get_source::path.id: in: path @@ -16935,7 +17123,7 @@ components: schema: $ref: '#/components/schemas/_common:Duration' style: form - x-version-deprecated: 2.0.0 + x-version-deprecated: '2.0' x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. indices.add_block::query.timeout: in: query @@ -17083,7 +17271,7 @@ components: schema: $ref: '#/components/schemas/_common:Duration' style: form - x-version-deprecated: 2.0.0 + x-version-deprecated: '2.0' x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. indices.clone::query.task_execution_timeout: name: task_execution_timeout @@ -17170,7 +17358,7 @@ components: schema: $ref: '#/components/schemas/_common:Duration' style: form - x-version-deprecated: 2.0.0 + x-version-deprecated: '2.0' x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. indices.close::query.timeout: in: query @@ -17229,7 +17417,7 @@ components: schema: $ref: '#/components/schemas/_common:Duration' style: form - x-version-deprecated: 2.0.0 + x-version-deprecated: '2.0' x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. indices.create::query.timeout: in: query @@ -17297,7 +17485,7 @@ components: schema: $ref: '#/components/schemas/_common:Duration' style: form - x-version-deprecated: 2.0.0 + x-version-deprecated: '2.0' x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. indices.delete_alias::query.timeout: in: query @@ -17339,7 +17527,7 @@ components: schema: $ref: '#/components/schemas/_common:Duration' style: form - x-version-deprecated: 2.0.0 + x-version-deprecated: '2.0' x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. indices.delete_index_template::query.timeout: in: query @@ -17375,7 +17563,7 @@ components: schema: $ref: '#/components/schemas/_common:Duration' style: form - x-version-deprecated: 2.0.0 + x-version-deprecated: '2.0' x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. indices.delete_template::query.timeout: in: query @@ -17444,7 +17632,7 @@ components: schema: $ref: '#/components/schemas/_common:Duration' style: form - x-version-deprecated: 2.0.0 + x-version-deprecated: '2.0' x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. indices.delete::query.timeout: in: query @@ -17547,7 +17735,7 @@ components: schema: $ref: '#/components/schemas/_common:Duration' style: form - x-version-deprecated: 2.0.0 + x-version-deprecated: '2.0' x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. indices.exists_template::path.name: in: path @@ -17588,7 +17776,7 @@ components: schema: $ref: '#/components/schemas/_common:Duration' style: form - x-version-deprecated: 2.0.0 + x-version-deprecated: '2.0' x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. indices.exists::path.index: in: path @@ -17952,7 +18140,7 @@ components: schema: $ref: '#/components/schemas/_common:Duration' style: form - x-version-deprecated: 2.0.0 + x-version-deprecated: '2.0' x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. indices.get_mapping::path.index: in: path @@ -18027,7 +18215,7 @@ components: schema: $ref: '#/components/schemas/_common:Duration' style: form - x-version-deprecated: 2.0.0 + x-version-deprecated: '2.0' x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. indices.get_settings::path.index: in: path @@ -18121,7 +18309,7 @@ components: schema: $ref: '#/components/schemas/_common:Duration' style: form - x-version-deprecated: 2.0.0 + x-version-deprecated: '2.0' x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. indices.get_template::path.name: in: path @@ -18167,7 +18355,7 @@ components: schema: $ref: '#/components/schemas/_common:Duration' style: form - x-version-deprecated: 2.0.0 + x-version-deprecated: '2.0' x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. indices.get_upgrade::path.index: name: index @@ -18277,7 +18465,7 @@ components: schema: $ref: '#/components/schemas/_common:Duration' style: form - x-version-deprecated: 2.0.0 + x-version-deprecated: '2.0' x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. indices.open::path.index: in: path @@ -18336,7 +18524,7 @@ components: schema: $ref: '#/components/schemas/_common:Duration' style: form - x-version-deprecated: 2.0.0 + x-version-deprecated: '2.0' x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. indices.open::query.task_execution_timeout: name: task_execution_timeout @@ -18410,7 +18598,7 @@ components: schema: $ref: '#/components/schemas/_common:Duration' style: form - x-version-deprecated: 2.0.0 + x-version-deprecated: '2.0' x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. indices.put_alias::query.timeout: in: query @@ -18458,7 +18646,7 @@ components: description: Operation timeout for connection to master node. schema: $ref: '#/components/schemas/_common:Duration' - x-version-deprecated: 2.0.0 + x-version-deprecated: '2.0' x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. deprecated: true indices.put_mapping::path.index: @@ -18513,7 +18701,7 @@ components: schema: $ref: '#/components/schemas/_common:Duration' style: form - x-version-deprecated: 2.0.0 + x-version-deprecated: '2.0' x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. indices.put_mapping::query.timeout: in: query @@ -18599,7 +18787,7 @@ components: schema: $ref: '#/components/schemas/_common:Duration' style: form - x-version-deprecated: 2.0.0 + x-version-deprecated: '2.0' x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. indices.put_settings::query.preserve_existing: in: query @@ -18651,7 +18839,7 @@ components: schema: $ref: '#/components/schemas/_common:Duration' style: form - x-version-deprecated: 2.0.0 + x-version-deprecated: '2.0' x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. indices.put_template::query.order: in: query @@ -18795,7 +18983,7 @@ components: schema: $ref: '#/components/schemas/_common:Duration' style: form - x-version-deprecated: 2.0.0 + x-version-deprecated: '2.0' x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. indices.rollover::query.timeout: in: query @@ -18947,7 +19135,7 @@ components: schema: $ref: '#/components/schemas/_common:Duration' style: form - x-version-deprecated: 2.0.0 + x-version-deprecated: '2.0' x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. indices.shrink::query.task_execution_timeout: name: task_execution_timeout @@ -19028,7 +19216,7 @@ components: schema: $ref: '#/components/schemas/_common:Duration' style: form - x-version-deprecated: 2.0.0 + x-version-deprecated: '2.0' x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. indices.simulate_template::path.name: in: path @@ -19071,7 +19259,7 @@ components: schema: $ref: '#/components/schemas/_common:Duration' style: form - x-version-deprecated: 2.0.0 + x-version-deprecated: '2.0' x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. indices.split::path.index: in: path @@ -19114,7 +19302,7 @@ components: schema: $ref: '#/components/schemas/_common:Duration' style: form - x-version-deprecated: 2.0.0 + x-version-deprecated: '2.0' x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. indices.split::query.task_execution_timeout: name: task_execution_timeout @@ -19255,7 +19443,7 @@ components: schema: $ref: '#/components/schemas/_common:Duration' style: form - x-version-deprecated: 2.0.0 + x-version-deprecated: '2.0' x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. indices.update_aliases::query.timeout: in: query @@ -19445,7 +19633,7 @@ components: schema: $ref: '#/components/schemas/_common:Duration' style: form - x-version-deprecated: 2.0.0 + x-version-deprecated: '2.0' x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. ingest.delete_pipeline::query.timeout: in: query @@ -19484,7 +19672,7 @@ components: schema: $ref: '#/components/schemas/_common:Duration' style: form - x-version-deprecated: 2.0.0 + x-version-deprecated: '2.0' x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. ingest.put_pipeline::path.id: in: path @@ -19509,7 +19697,7 @@ components: schema: $ref: '#/components/schemas/_common:Duration' style: form - x-version-deprecated: 2.0.0 + x-version-deprecated: '2.0' x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. ingest.put_pipeline::query.timeout: in: query @@ -20895,7 +21083,7 @@ components: schema: $ref: '#/components/schemas/_common:Duration' style: form - x-version-deprecated: 2.0.0 + x-version-deprecated: '2.0' x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. put_script::query.timeout: in: query @@ -22135,7 +22323,7 @@ components: schema: $ref: '#/components/schemas/_common:Duration' style: form - x-version-deprecated: 2.0.0 + x-version-deprecated: '2.0' x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. snapshot.cleanup_repository::query.timeout: in: query @@ -22183,7 +22371,7 @@ components: schema: $ref: '#/components/schemas/_common:Duration' style: form - x-version-deprecated: 2.0.0 + x-version-deprecated: '2.0' x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. snapshot.create_repository::path.repository: in: path @@ -22208,7 +22396,7 @@ components: schema: $ref: '#/components/schemas/_common:Duration' style: form - x-version-deprecated: 2.0.0 + x-version-deprecated: '2.0' x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. snapshot.create_repository::query.timeout: in: query @@ -22255,7 +22443,7 @@ components: schema: $ref: '#/components/schemas/_common:Duration' style: form - x-version-deprecated: 2.0.0 + x-version-deprecated: '2.0' x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. snapshot.create::query.wait_for_completion: in: query @@ -22288,7 +22476,7 @@ components: schema: $ref: '#/components/schemas/_common:Duration' style: form - x-version-deprecated: 2.0.0 + x-version-deprecated: '2.0' x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. snapshot.delete_repository::query.timeout: in: query @@ -22328,7 +22516,7 @@ components: schema: $ref: '#/components/schemas/_common:Duration' style: form - x-version-deprecated: 2.0.0 + x-version-deprecated: '2.0' x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. snapshot.get_repository::path.repository: in: path @@ -22361,7 +22549,7 @@ components: schema: $ref: '#/components/schemas/_common:Duration' style: form - x-version-deprecated: 2.0.0 + x-version-deprecated: '2.0' x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. snapshot.get::path.repository: in: path @@ -22405,7 +22593,7 @@ components: schema: $ref: '#/components/schemas/_common:Duration' style: form - x-version-deprecated: 2.0.0 + x-version-deprecated: '2.0' x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. snapshot.get::query.verbose: in: query @@ -22445,7 +22633,7 @@ components: schema: $ref: '#/components/schemas/_common:Duration' style: form - x-version-deprecated: 2.0.0 + x-version-deprecated: '2.0' x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. snapshot.restore::query.wait_for_completion: in: query @@ -22494,7 +22682,7 @@ components: schema: $ref: '#/components/schemas/_common:Duration' style: form - x-version-deprecated: 2.0.0 + x-version-deprecated: '2.0' x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. snapshot.verify_repository::path.repository: in: path @@ -22519,7 +22707,7 @@ components: schema: $ref: '#/components/schemas/_common:Duration' style: form - x-version-deprecated: 2.0.0 + x-version-deprecated: '2.0' x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. snapshot.verify_repository::query.timeout: in: query @@ -23363,6 +23551,11 @@ components: style: form x-default: '1' requestBodies: + asynchronous_search.search: + content: + application/json: + schema: + $ref: '#/components/schemas/asynchronous_search._common:Search' bulk: content: application/x-ndjson: @@ -24344,10 +24537,10 @@ components: knn: description: Defines the approximate kNN search to run. oneOf: - - $ref: '#/components/schemas/_common:KnnQuery' + - $ref: '#/components/schemas/_common.query_dsl:KnnQuery' - type: array items: - $ref: '#/components/schemas/_common:KnnQuery' + $ref: '#/components/schemas/_common.query_dsl:KnnQuery' rank: $ref: '#/components/schemas/_common:RankContainer' min_score: @@ -24864,6 +25057,29 @@ components: $ref: '#/components/schemas/_common:Conflicts' description: The search definition using the Query DSL responses: + asynchronous_search.delete@200: + content: + application/json: + schema: + type: object + properties: + acknowledged: + type: boolean + asynchronous_search.get@200: + content: + application/json: + schema: + $ref: '#/components/schemas/asynchronous_search._common:ResponseBody' + asynchronous_search.search@200: + content: + application/json: + schema: + $ref: '#/components/schemas/asynchronous_search._common:ResponseBody' + asynchronous_search.stats@200: + content: + application/json: + schema: + $ref: '#/components/schemas/asynchronous_search._common:StatsResponse' bulk@200: content: application/json: @@ -25244,16 +25460,13 @@ components: properties: persistent: type: object - additionalProperties: - type: object + additionalProperties: true transient: type: object - additionalProperties: - type: object + additionalProperties: true defaults: type: object - additionalProperties: - type: object + additionalProperties: true required: - persistent - transient @@ -26239,7 +26452,9 @@ components: $ref: '#/components/schemas/_core.mtermvectors:TermVectorsResult' required: - docs - nodes.hot_threads@200: {} + nodes.hot_threads@200: + content: + text/plain: {} nodes.info@200: content: application/json: @@ -28363,38 +28578,34 @@ components: - source _common:Ip: type: string - _common:KnnQuery: + _common:KnnField: type: object properties: - field: - $ref: '#/components/schemas/_common:Field' - query_vector: + vector: $ref: '#/components/schemas/_common:QueryVector' - query_vector_builder: - $ref: '#/components/schemas/_common:QueryVectorBuilder' k: - description: The final number of nearest neighbors to return as top hits + description: The final number of nearest neighbors to return as top hits. type: number - num_candidates: - description: The number of nearest neighbor candidates to consider per shard + min_score: + description: The minimum similarity score for a neighbor to be considered a hit. type: number - boost: - description: Boost value to apply to kNN scores + x-version-added: '2.14' + max_distance: + description: The maximum physical distance in vector space for a neighbor to be considered a hit. type: number + x-version-added: '2.14' filter: - description: Filters for the kNN search query + description: Filters for the kNN search query. oneOf: - $ref: '#/components/schemas/_common.query_dsl:QueryContainer' - type: array items: $ref: '#/components/schemas/_common.query_dsl:QueryContainer' - similarity: - description: The minimum similarity for a vector to be considered a match + boost: + description: Boost value to apply to kNN scores type: number required: - - field - - k - - num_candidates + - vector _common:LatLonGeoLocation: type: object properties: @@ -28772,13 +28983,6 @@ components: type: array items: type: number - _common:QueryVectorBuilder: - type: object - properties: - text_embedding: - $ref: '#/components/schemas/_common:TextEmbedding' - minProperties: 1 - maxProperties: 1 _common:RankBase: type: object _common:RankContainer: @@ -29533,16 +29737,6 @@ components: oneOf: - type: string - type: number - _common:TextEmbedding: - type: object - properties: - model_id: - type: string - model_text: - type: string - required: - - model_id - - model_text _common:TimeOfDay: description: Time of day, expressed as HH:MM:SS. type: string @@ -37025,6 +37219,12 @@ components: $ref: '#/components/schemas/_common:Field' required: - pattern + _common.query_dsl:KnnQuery: + type: object + additionalProperties: + $ref: '#/components/schemas/_common:KnnField' + minProperties: 1 + maxProperties: 1 _common.query_dsl:Like: description: Text that we want similar documents for or a lookup to a document's field for the text. oneOf: @@ -37566,6 +37766,8 @@ components: $ref: '#/components/schemas/_common.query_dsl:IntervalsQuery' minProperties: 1 maxProperties: 1 + knn: + $ref: '#/components/schemas/_common.query_dsl:KnnQuery' match: description: |- Returns documents that match a provided text, number, date or boolean value. @@ -38749,10 +38951,10 @@ components: knn: description: Defines the approximate kNN search to run. oneOf: - - $ref: '#/components/schemas/_common:KnnQuery' + - $ref: '#/components/schemas/_common.query_dsl:KnnQuery' - type: array items: - $ref: '#/components/schemas/_common:KnnQuery' + $ref: '#/components/schemas/_common.query_dsl:KnnQuery' from: description: |- Starting document offset. By default, you cannot page through more than 10,000 @@ -40294,6 +40496,186 @@ components: properties: get: $ref: '#/components/schemas/_common:InlineGet' + asynchronous_search._common:AsynchronousSearchStats: + type: object + properties: + submitted: + type: integer + initialized: + type: integer + search_failed: + type: integer + search_completed: + type: integer + rejected: + type: integer + persist_failed: + type: integer + cancelled: + type: integer + running_current: + type: integer + persisted: + type: integer + asynchronous_search._common:NodesStats: + type: object + properties: + asynchronous_search_stats: + $ref: '#/components/schemas/asynchronous_search._common:AsynchronousSearchStats' + asynchronous_search._common:ResponseBody: + type: object + properties: + id: + type: string + state: + type: string + start_time_in_millis: + type: number + expiration_time_in_millis: + type: number + took: + type: number + response: + $ref: '#/components/schemas/_core.search:ResponseBody' + asynchronous_search._common:Search: + type: object + properties: + aggregations: + description: Defines the aggregations that are run as part of the search request. + type: object + additionalProperties: + $ref: '#/components/schemas/_common.aggregations:AggregationContainer' + collapse: + $ref: '#/components/schemas/_core.search:FieldCollapse' + explain: + description: If true, returns detailed information about score computation as part of a hit. + type: boolean + ext: + description: Configuration of search extensions defined by OpenSearch plugins. + type: object + additionalProperties: + type: object + from: + description: |- + Starting document offset. + Needs to be non-negative. + By default, you cannot page through more than 10,000 hits using the `from` and `size` parameters. + To page through more hits, use the `search_after` parameter. + type: number + highlight: + $ref: '#/components/schemas/_core.search:Highlight' + track_total_hits: + $ref: '#/components/schemas/_core.search:TrackHits' + indices_boost: + description: Boosts the _score of documents from specified indices. + type: array + items: + type: object + additionalProperties: + type: number + docvalue_fields: + description: |- + Array of wildcard (`*`) patterns. + The request returns doc values for field names matching these patterns in the `hits.fields` property of the response. + type: array + items: + $ref: '#/components/schemas/_common.query_dsl:FieldAndFormat' + rank: + $ref: '#/components/schemas/_common:RankContainer' + min_score: + description: |- + Minimum `_score` for matching documents. + Documents with a lower `_score` are not included in the search results. + type: number + post_filter: + $ref: '#/components/schemas/_common.query_dsl:QueryContainer' + profile: + description: |- + Set to `true` to return detailed timing information about the execution of individual components in a search request. + NOTE: This is a debugging tool and adds significant overhead to search execution. + type: boolean + query: + $ref: '#/components/schemas/_common.query_dsl:QueryContainer' + script_fields: + description: Retrieve a script evaluation (based on different fields) for each hit. + type: object + additionalProperties: + $ref: '#/components/schemas/_common:ScriptField' + search_after: + $ref: '#/components/schemas/_common:SortResults' + size: + description: |- + The number of hits to return. + By default, you cannot page through more than 10,000 hits using the `from` and `size` parameters. + To page through more hits, use the `search_after` parameter. + type: number + slice: + $ref: '#/components/schemas/_common:SlicedScroll' + sort: + $ref: '#/components/schemas/_common:Sort' + _source: + $ref: '#/components/schemas/_core.search:SourceConfig' + fields: + description: |- + Array of wildcard (`*`) patterns. + The request returns values for field names matching these patterns in the `hits.fields` property of the response. + type: array + items: + $ref: '#/components/schemas/_common.query_dsl:FieldAndFormat' + suggest: + $ref: '#/components/schemas/_core.search:Suggester' + terminate_after: + description: |- + Maximum number of documents to collect for each shard. + If a query reaches this limit, OpenSearch terminates the query early. + OpenSearch collects documents before sorting. + Use with caution. + OpenSearch applies this parameter to each shard handling the request. + When possible, let OpenSearch perform early termination automatically. + Avoid specifying this parameter for requests that target data streams with backing indices across multiple data tiers. + If set to `0` (default), the query does not terminate early. + type: number + timeout: + description: |- + Specifies the period of time to wait for a response from each shard. + If no response is received before the timeout expires, the request fails and returns an error. + Defaults to no timeout. + type: string + track_scores: + description: If true, calculate and return document scores, even if the scores are not used for sorting. + type: boolean + version: + description: If true, returns document version as part of a hit. + type: boolean + seq_no_primary_term: + description: If `true`, returns sequence number and primary term of the last modification of each hit. + type: boolean + stored_fields: + $ref: '#/components/schemas/_common:Fields' + pit: + $ref: '#/components/schemas/_core.search:PointInTimeReference' + runtime_mappings: + $ref: '#/components/schemas/_common.mapping:RuntimeFields' + stats: + description: |- + Stats groups to associate with the search. + Each group maintains a statistics aggregation for its associated searches. + You can retrieve these stats using the indices stats API. + type: array + items: + type: string + description: The search definition using the Query DSL. + asynchronous_search._common:StatsResponse: + type: object + properties: + _nodes: + $ref: '#/components/schemas/_common:NodeStatistics' + cluster_name: + type: string + nodes: + type: object + additionalProperties: + $ref: '#/components/schemas/asynchronous_search._common:NodesStats' cat._common:CatPitSegmentsRecord: type: object properties: @@ -41121,7 +41503,7 @@ components: Indicates whether the node is the elected master node. Returned values include `*`(elected master) and `-`(not elected master). type: string - x-version-deprecated: 2.0.0 + x-version-deprecated: '2.0' x-deprecation-message: To promote inclusive language, use 'cluster_manager' instead. name: $ref: '#/components/schemas/_common:Name' @@ -42206,6 +42588,22 @@ components: - REINITIALIZED - REPLICA_ADDED - REROUTE_CANCELLED + cluster.health:AwarenessAttributeStats: + type: object + x-version-added: '2.5' + properties: + active_shards: + type: number + initializing_shards: + type: number + relocating_shards: + type: number + unassigned_shards: + type: number + data_nodes: + type: number + weight: + type: number cluster.health:HealthResponseBody: type: object properties: @@ -42217,11 +42615,25 @@ components: type: number active_shards_percent_as_number: $ref: '#/components/schemas/_common:Percentage' + awareness_attributes: + description: Cluster health information for each awareness attribute. + type: object + x-version-added: '2.5' + additionalProperties: + $ref: '#/components/schemas/cluster.health:AwarenessAttributeStats' cluster_name: $ref: '#/components/schemas/_common:Name' delayed_unassigned_shards: description: The number of shards whose allocation has been delayed by the timeout settings. type: number + discovered_master: + description: True if the master node has been discovered. + type: boolean + x-version-deprecated: '2.0' + discovered_cluster_manager: + description: True if the cluster manager node has been discovered. + type: boolean + x-version-added: '2.0' indices: type: object additionalProperties: @@ -42251,7 +42663,7 @@ components: task_max_waiting_in_queue_millis: $ref: '#/components/schemas/_common:DurationValueUnitMillis' timed_out: - description: If false the response returned within the period of time that is specified by the timeout parameter (30s by default) + description: If false the response returned within the period of time that is specified by the timeout parameter (30s by default). type: boolean unassigned_shards: description: The number of shards that are not allocated. @@ -42629,6 +43041,10 @@ components: total_in_bytes: description: Total size, in bytes, of all file stores across all selected nodes. type: number + cache_reserved_in_bytes: + description: Total size, in bytes, of all cache reserved across all selected nodes. + type: number + x-version-added: '2.7' required: - available_in_bytes - free_in_bytes @@ -42811,10 +43227,16 @@ components: type: number master: type: number + cluster_manager: + type: number + x-version-added: '2.0' ml: type: number remote_cluster_client: type: number + search: + type: number + x-version-added: '2.4' total: type: number transform: @@ -42824,17 +43246,10 @@ components: required: - coordinating_only - data - - data_cold - - data_content - - data_hot - - data_warm - ingest - master - - ml - remote_cluster_client - total - - transform - - voting_only cluster.stats:ClusterNodes: type: object properties: @@ -42880,7 +43295,6 @@ components: - count - discovery_types - fs - - indexing_pressure - ingest - jvm - network_types @@ -43162,7 +43576,6 @@ components: type: string required: - count - - flavor - type cluster.stats:OperatingSystemMemoryInfo: type: object