diff --git a/OpenSearch.sln.DotSettings b/OpenSearch.sln.DotSettings index d831b30a7f..5905a6acf8 100644 --- a/OpenSearch.sln.DotSettings +++ b/OpenSearch.sln.DotSettings @@ -101,7 +101,7 @@ </Entry.Match> <Entry.SortBy> <Kind Is="Member" /> - <Name Is="Enter Pattern Here" /> + <Name /> </Entry.SortBy> </Entry> <Entry DisplayName="Fields"> @@ -116,7 +116,7 @@ <Entry.SortBy> <Access /> <Readonly /> - <Name Is="Enter Pattern Here" /> + <Name /> </Entry.SortBy> </Entry> <Entry DisplayName="Constructors"> @@ -136,7 +136,7 @@ </Entry.Match> <Entry.SortBy> <Access /> - <Name Is="Enter Pattern Here" /> + <Name /> </Entry.SortBy> </Entry> <Entry DisplayName="Setup/Teardown Methods" Priority="100"> @@ -200,7 +200,7 @@ </Entry.Match> <Entry.SortBy> <Kind Is="Member" /> - <Name Is="Enter Pattern Here" /> + <Name /> </Entry.SortBy> </Entry> <Entry DisplayName="Fields"> @@ -215,7 +215,7 @@ <Entry.SortBy> <Access /> <Readonly /> - <Name Is="Enter Pattern Here" /> + <Name /> </Entry.SortBy> </Entry> <Entry DisplayName="Constructors"> @@ -235,7 +235,7 @@ </Entry.Match> <Entry.SortBy> <Access /> - <Name Is="Enter Pattern Here" /> + <Name /> </Entry.SortBy> </Entry> <Entry DisplayName="Interface Implementations"> @@ -248,7 +248,7 @@ <Entry.SortBy> <ImplementsInterface Name="IDisposable" /> <Access /> - <Name Is="Enter Pattern Here" /> + <Name /> </Entry.SortBy> </Entry> <Entry DisplayName="All other members" /> @@ -501,6 +501,7 @@ True True True + True True True False diff --git a/src/ApiGenerator/Domain/Specification/Deprecation.cs b/src/ApiGenerator/Domain/Specification/Deprecation.cs index 96ac03c7d7..96d06b7b8f 100644 --- a/src/ApiGenerator/Domain/Specification/Deprecation.cs +++ b/src/ApiGenerator/Domain/Specification/Deprecation.cs @@ -26,16 +26,18 @@ * under the License. */ +using SemanticVersioning; + namespace ApiGenerator.Domain.Specification; public class Deprecation { - public string Version { get; set; } + public Version Version { get; set; } public string Description { get; set; } public override string ToString() => - (!string.IsNullOrEmpty(Version), !string.IsNullOrEmpty(Description)) switch + (Version != null, !string.IsNullOrEmpty(Description)) switch { (true, true) => $"Deprecated as of: {Version}, reason: {Description}", (true, false) => $"Deprecated as of: {Version}", diff --git a/src/ApiGenerator/Generator/ApiEndpointFactory.cs b/src/ApiGenerator/Generator/ApiEndpointFactory.cs index 5d3f748e6c..65302b43d2 100644 --- a/src/ApiGenerator/Generator/ApiEndpointFactory.cs +++ b/src/ApiGenerator/Generator/ApiEndpointFactory.cs @@ -263,7 +263,7 @@ private static string GetOpenSearchType(JsonSchema schema, Action { JsonObjectType.Integer => "number", JsonObjectType.Array => "list", - JsonObjectType.String when schema.Pattern == "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$" => "time", + JsonObjectType.String when schema.Pattern == @"^([0-9\.]+)(?:d|h|m|s|ms|micros|nanos)$" => "time", var t => t.ToString().ToLowerInvariant() }; } @@ -308,19 +308,24 @@ private static bool XGlobal(this OpenApiParameter parameter) => private static string XDeprecationMessage(this IJsonExtensionObject schema) => schema.GetExtension("x-deprecation-message") as string; - private static string XVersionDeprecated(this IJsonExtensionObject schema) => - schema.GetExtension("x-version-deprecated") as string; + private static Version XVersionDeprecated(this IJsonExtensionObject schema) => + schema.GetExtension("x-version-deprecated") is string s + ? CoerceVersion(s) + : null; private static Version XVersionAdded(this IJsonExtensionObject schema) => schema.GetExtension("x-version-added") is string s - ? s.Split('.').Length switch - { - 1 => new Version($"{s}.0.0"), - 2 => new Version($"{s}.0"), - _ => new Version(s), - } + ? CoerceVersion(s) : null; + private static Version CoerceVersion(string s) => + s.Split('.').Length switch + { + 1 => new Version($"{s}.0.0"), + 2 => new Version($"{s}.0"), + _ => new Version(s), + }; + private static object GetExtension(this IJsonExtensionObject schema, string key) => schema.ExtensionData?.TryGetValue(key, out var value) ?? false ? value : null; } diff --git a/src/ApiGenerator/opensearch-openapi.yaml b/src/ApiGenerator/opensearch-openapi.yaml index 8d9df0fb17..a3bd080cfd 100644 --- a/src/ApiGenerator/opensearch-openapi.yaml +++ b/src/ApiGenerator/opensearch-openapi.yaml @@ -2,13 +2,15 @@ openapi: 3.1.0 info: title: OpenSearch API Specification version: 1.0.0 - x-api-version: 2.15.0 + x-api-version: 2.16.0 paths: /: get: operationId: info.0 x-operation-group: info x-version-added: '1.0' + x-distributions-excluded: + - amazon-serverless description: Returns basic information about the cluster. externalDocs: url: https://opensearch.org/docs/latest @@ -58,13 +60,15 @@ paths: responses: '200': $ref: '#/components/responses/indices.get_alias@200' + '404': + $ref: '#/components/responses/indices.get_alias@404' put: operationId: indices.put_alias.0 x-operation-group: indices.put_alias x-version-added: '1.0' description: Creates or updates an alias. externalDocs: - url: https://opensearch.org/docs/latest/im-plugin/index-alias/#create-aliases + url: https://opensearch.org/docs/latest/api-reference/index-apis/update-alias/ parameters: - $ref: '#/components/parameters/indices.put_alias::query.cluster_manager_timeout' - $ref: '#/components/parameters/indices.put_alias::query.master_timeout' @@ -101,6 +105,8 @@ paths: responses: '200': $ref: '#/components/responses/indices.get_alias@200' + '404': + $ref: '#/components/responses/indices.get_alias@404' head: operationId: indices.exists_alias.0 x-operation-group: indices.exists_alias @@ -122,13 +128,15 @@ paths: responses: '200': $ref: '#/components/responses/indices.exists_alias@200' + '404': + $ref: '#/components/responses/indices.exists_alias@404' post: operationId: indices.put_alias.1 x-operation-group: indices.put_alias x-version-added: '1.0' description: Creates or updates an alias. externalDocs: - url: https://opensearch.org/docs/latest/im-plugin/index-alias/#create-aliases + url: https://opensearch.org/docs/latest/api-reference/index-apis/update-alias/ parameters: - $ref: '#/components/parameters/indices.put_alias::path.name' - $ref: '#/components/parameters/indices.put_alias::query.cluster_manager_timeout' @@ -150,7 +158,7 @@ paths: x-version-added: '1.0' description: Creates or updates an alias. externalDocs: - url: https://opensearch.org/docs/latest/im-plugin/index-alias/#create-aliases + url: https://opensearch.org/docs/latest/api-reference/index-apis/update-alias/ parameters: - $ref: '#/components/parameters/indices.put_alias::path.name' - $ref: '#/components/parameters/indices.put_alias::query.cluster_manager_timeout' @@ -173,7 +181,7 @@ paths: x-version-added: '1.0' description: Updates index aliases. externalDocs: - url: https://opensearch.org/docs/latest/api-reference/alias/ + url: https://opensearch.org/docs/latest/api-reference/index-apis/alias/ parameters: - $ref: '#/components/parameters/indices.update_aliases::query.cluster_manager_timeout' - $ref: '#/components/parameters/indices.update_aliases::query.master_timeout' @@ -195,7 +203,7 @@ paths: x-version-added: '1.0' description: Creates or updates an alias. externalDocs: - url: https://opensearch.org/docs/latest/im-plugin/index-alias/#create-aliases + url: https://opensearch.org/docs/latest/api-reference/index-apis/update-alias/ parameters: - $ref: '#/components/parameters/indices.put_alias::path.name' - $ref: '#/components/parameters/indices.put_alias::query.cluster_manager_timeout' @@ -217,7 +225,7 @@ paths: x-version-added: '1.0' description: Creates or updates an alias. externalDocs: - url: https://opensearch.org/docs/latest/im-plugin/index-alias/#create-aliases + url: https://opensearch.org/docs/latest/api-reference/index-apis/update-alias/ parameters: - $ref: '#/components/parameters/indices.put_alias::path.name' - $ref: '#/components/parameters/indices.put_alias::query.cluster_manager_timeout' @@ -334,6 +342,9 @@ paths: operationId: indices.clear_cache.0 x-operation-group: indices.clear_cache x-version-added: '1.0' + x-distributions-excluded: + - amazon-managed + - amazon-serverless description: Clears all or specific caches for one or more indices. externalDocs: url: https://opensearch.org/docs/latest/api-reference/index-apis/clear-index-cache/ @@ -713,6 +724,9 @@ paths: operationId: cat.nodeattrs.0 x-operation-group: cat.nodeattrs x-version-added: '1.0' + x-distributions-excluded: + - amazon-managed + - amazon-serverless description: Returns information about custom node attributes. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-nodeattrs/ @@ -1487,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 @@ -1542,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 @@ -2342,6 +2301,9 @@ paths: operationId: indices.forcemerge.0 x-operation-group: indices.forcemerge x-version-added: '1.0' + x-distributions-excluded: + - amazon-managed + - amazon-serverless description: Performs the force merge operation on one or more indices. externalDocs: url: https://opensearch.org/docs/latest @@ -3084,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 @@ -3276,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 @@ -3456,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 @@ -3839,7 +3821,51 @@ paths: responses: '200': $ref: '#/components/responses/ml.delete_model@200' + /_plugins/_ml/models/{model_id}/_deploy: + post: + operationId: ml.deploy_model.0 + x-operation-group: ml.deploy_model + description: Deploys a model. + parameters: + - $ref: '#/components/parameters/ml.deploy_model::path.model_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/ml.deploy_model@200' + /_plugins/_ml/models/{model_id}/_undeploy: + post: + operationId: ml.undeploy_model.0 + x-operation-group: ml.undeploy_model + description: Undeploys a model. + parameters: + - $ref: '#/components/parameters/ml.undeploy_model::path.model_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/ml.undeploy_model@200' /_plugins/_ml/tasks/{task_id}: + delete: + operationId: ml.delete_task.0 + x-operation-group: ml.delete_task + description: Deletes a task. + parameters: + - $ref: '#/components/parameters/ml.delete_task::path.task_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/ml.delete_task@200' get: operationId: ml.get_task.0 x-operation-group: ml.get_task @@ -4071,6 +4097,309 @@ paths: - $ref: '#/components/parameters/_global::query.error_trace' - $ref: '#/components/parameters/_global::query.source' - $ref: '#/components/parameters/_global::query.filter_path' + /_plugins/_observability/_local/stats: + get: + operationId: observability.get_localstats.0 + x-operation-group: observability.get_localstats + x-version-added: '1.1' + description: Retrieves Local Stats of all observability objects. + responses: + '200': + $ref: '#/components/responses/observability.get_localstats@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/_observability/object: + delete: + operationId: observability.delete_objects.0 + x-operation-group: observability.delete_objects + x-version-added: '1.1' + description: Deletes specific observability objects specified by ID or a list of IDs. + parameters: + - $ref: '#/components/parameters/observability.delete_objects::query.objectId' + - $ref: '#/components/parameters/observability.delete_objects::query.objectIdList' + - $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/observability.delete_objects@200' + '404': + $ref: '#/components/responses/observability.delete_objects@404' + get: + operationId: observability.list_objects.0 + x-operation-group: observability.list_objects + x-version-added: '1.1' + description: Retrieves list of all observability objects. + responses: + '200': + $ref: '#/components/responses/observability.list_objects@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' + post: + operationId: observability.create_object.0 + x-operation-group: observability.create_object + x-version-added: '1.1' + description: Creates a new observability object. + requestBody: + $ref: '#/components/requestBodies/observability.create_object' + responses: + '200': + $ref: '#/components/responses/observability.create_object@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/_observability/object/{object_id}: + delete: + operationId: observability.delete_object.0 + x-operation-group: observability.delete_object + x-version-added: '1.1' + description: Deletes specific observability object specified by ID. + parameters: + - $ref: '#/components/parameters/observability.delete_object::path.object_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/observability.delete_object@200' + '404': + $ref: '#/components/responses/observability.delete_object@404' + get: + operationId: observability.get_object.0 + x-operation-group: observability.get_object + x-version-added: '1.1' + description: Retrieves specific observability object specified by ID. + parameters: + - $ref: '#/components/parameters/observability.get_object::path.object_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/observability.get_object@200' + '404': + $ref: '#/components/responses/observability.get_object@404' + put: + operationId: observability.update_object.0 + x-operation-group: observability.update_object + x-version-added: '1.1' + description: Updates an existing observability object. + parameters: + - $ref: '#/components/parameters/observability.update_object::path.object_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' + requestBody: + $ref: '#/components/requestBodies/observability.update_object' + responses: + '200': + $ref: '#/components/responses/observability.update_object@200' + '404': + $ref: '#/components/responses/observability.update_object@404' + /_plugins/_ppl: + post: + operationId: ppl.query.0 + x-operation-group: ppl.query + x-version-added: '1.0' + description: Send a PPL query to the PPL plugin. + externalDocs: + url: https://opensearch.org/docs/latest/search-plugins/sql/sql-ppl-api/ + parameters: + - $ref: '#/components/parameters/ppl.query::query.format' + - $ref: '#/components/parameters/ppl.query::query.sanitize' + - $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/ppl.query' + responses: + '200': + $ref: '#/components/responses/ppl.query@200' + /_plugins/_ppl/_explain: + post: + operationId: ppl.explain.0 + x-operation-group: ppl.explain + x-version-added: '1.0' + description: Shows how a query is executed against OpenSearch. + externalDocs: + url: https://opensearch.org/docs/latest/search-plugins/sql/sql-ppl-api/ + parameters: + - $ref: '#/components/parameters/ppl.explain::query.format' + - $ref: '#/components/parameters/ppl.explain::query.sanitize' + - $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/ppl.explain' + responses: + '200': + $ref: '#/components/responses/ppl.explain@200' + /_plugins/_ppl/stats: + get: + operationId: ppl.get_stats.0 + x-operation-group: ppl.get_stats + x-version-added: '1.0' + description: Collect metrics for the plugin within the interval. + externalDocs: + url: https://opensearch.org/docs/latest/search-plugins/sql/monitoring/ + parameters: + - $ref: '#/components/parameters/ppl.get_stats::query.format' + - $ref: '#/components/parameters/ppl.get_stats::query.sanitize' + - $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/ppl.get_stats@200' + post: + operationId: ppl.post_stats.1 + x-operation-group: ppl.post_stats + x-version-added: '1.0' + description: By a stats endpoint, you are able to collect metrics for the plugin within the interval. + externalDocs: + url: https://opensearch.org/docs/latest/search-plugins/sql/monitoring/ + parameters: + - $ref: '#/components/parameters/ppl.post_stats::query.format' + - $ref: '#/components/parameters/ppl.post_stats::query.sanitize' + - $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/ppl.post_stats' + responses: + '200': + $ref: '#/components/responses/ppl.post_stats@200' + /_plugins/_query/_datasources: + get: + operationId: query.datasources_list.0 + x-operation-group: query.datasources_list + x-version-added: '2.7' + description: Retrieves list of all datasources. + responses: + '200': + $ref: '#/components/responses/query.datasources_list@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' + post: + operationId: query.datasources_create.0 + x-operation-group: query.datasources_create + x-version-added: '2.7' + description: Creates a new query datasource. + requestBody: + $ref: '#/components/requestBodies/query.datasources_create' + responses: + '201': + $ref: '#/components/responses/query.datasources_create@201' + 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' + put: + operationId: query.datasources_update.0 + x-operation-group: query.datasources_update + x-version-added: '2.7' + description: Updates an existing query datasource. + requestBody: + $ref: '#/components/requestBodies/query.datasources_update' + responses: + '200': + $ref: '#/components/responses/query.datasources_update@200' + '404': + $ref: '#/components/responses/query.datasources_update@404' + 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/_query/_datasources/{datasource_name}: + delete: + operationId: query.datasource_delete.0 + x-operation-group: query.datasource_delete + x-version-added: '2.7' + description: Deletes specific datasource specified by name. + parameters: + - $ref: '#/components/parameters/query.datasource_delete::path.datasource_name' + - $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: + '204': + $ref: '#/components/responses/query.datasource_delete@204' + '404': + $ref: '#/components/responses/query.datasource_delete@404' + get: + operationId: query.datasource_retrieve.0 + x-operation-group: query.datasource_retrieve + x-version-added: '2.7' + description: Retrieves specific datasource specified by name. + parameters: + - $ref: '#/components/parameters/query.datasource_retrieve::path.datasource_name' + - $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/query.datasource_retrieve@200' + '404': + $ref: '#/components/responses/query.datasource_retrieve@404' + /_plugins/_query/settings: + put: + operationId: sql.settings.0 + x-operation-group: sql.settings + x-version-added: '1.0' + description: Adds SQL settings to the standard OpenSearch cluster settings. + externalDocs: + url: https://opensearch.org/docs/latest/search-plugins/sql/settings/ + parameters: + - $ref: '#/components/parameters/sql.settings::query.format' + - $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/sql.settings' + responses: + '200': + $ref: '#/components/responses/sql.settings@200' /_plugins/_rollup/jobs/{id}: delete: operationId: rollups.delete.0 @@ -4181,11 +4510,14 @@ paths: responses: '200': $ref: '#/components/responses/rollups.stop@200' - /_plugins/_security/_upgrade_check: + /_plugins/_security/api/_upgrade_check: get: operationId: security.config_upgrade_check.0 x-operation-group: security.config_upgrade_check x-version-added: '2.14' + x-distributions-excluded: + - amazon-managed + - amazon-serverless description: Check whether or not an upgrade can be performed and what resources can be updated. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#configuration-upgrade-check @@ -4198,11 +4530,14 @@ paths: - $ref: '#/components/parameters/_global::query.error_trace' - $ref: '#/components/parameters/_global::query.source' - $ref: '#/components/parameters/_global::query.filter_path' - /_plugins/_security/_upgrade_perform: + /_plugins/_security/api/_upgrade_perform: post: operationId: security.config_upgrade_perform.0 x-operation-group: security.config_upgrade_perform x-version-added: '2.14' + x-distributions-excluded: + - amazon-managed + - amazon-serverless description: Helps cluster operator upgrade missing defaults and stale default definitions. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#configuration-upgrade @@ -4211,6 +4546,8 @@ paths: responses: '200': $ref: '#/components/responses/security.config_upgrade_perform@200' + '400': + $ref: '#/components/responses/security.config_upgrade_perform@400' parameters: - $ref: '#/components/parameters/_global::query.pretty' - $ref: '#/components/parameters/_global::query.human' @@ -4222,6 +4559,9 @@ paths: operationId: security.get_account_details.0 x-operation-group: security.get_account_details x-version-added: '1.0' + x-distributions-excluded: + - amazon-managed + - amazon-serverless description: Returns account details for the current user. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#get-account-details @@ -4238,6 +4578,9 @@ paths: operationId: security.change_password.0 x-operation-group: security.change_password x-version-added: '1.0' + x-distributions-excluded: + - amazon-managed + - amazon-serverless description: Changes the password for the current user. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#change-password @@ -4246,6 +4589,8 @@ paths: responses: '200': $ref: '#/components/responses/security.change_password@200' + '403': + $ref: '#/components/responses/security.change_password@403' parameters: - $ref: '#/components/parameters/_global::query.pretty' - $ref: '#/components/parameters/_global::query.human' @@ -4257,6 +4602,9 @@ paths: operationId: security.get_action_groups.0 x-operation-group: security.get_action_groups x-version-added: '1.0' + x-distributions-excluded: + - amazon-managed + - amazon-serverless description: Retrieves all action groups. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#get-action-groups @@ -4273,6 +4621,9 @@ paths: operationId: security.patch_action_groups.1 x-operation-group: security.patch_action_groups x-version-added: '1.0' + x-distributions-excluded: + - amazon-managed + - amazon-serverless description: Creates, updates, or deletes multiple action groups in a single call. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#patch-action-groups @@ -4292,6 +4643,9 @@ paths: operationId: security.delete_action_group.0 x-operation-group: security.delete_action_group x-version-added: '1.0' + x-distributions-excluded: + - amazon-managed + - amazon-serverless description: Delete a specified action group. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#delete-action-group @@ -4309,6 +4663,9 @@ paths: operationId: security.get_action_group.0 x-operation-group: security.get_action_group x-version-added: '1.0' + x-distributions-excluded: + - amazon-managed + - amazon-serverless description: Retrieves one action group. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#get-action-group @@ -4326,6 +4683,9 @@ paths: operationId: security.patch_action_group.0 x-operation-group: security.patch_action_group x-version-added: '1.0' + x-distributions-excluded: + - amazon-managed + - amazon-serverless description: Updates individual attributes of an action group. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#patch-action-group @@ -4345,6 +4705,9 @@ paths: operationId: security.create_action_group.0 x-operation-group: security.create_action_group x-version-added: '1.0' + x-distributions-excluded: + - amazon-managed + - amazon-serverless description: Creates or replaces the specified action group. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#create-action-group @@ -4360,17 +4723,24 @@ paths: responses: '200': $ref: '#/components/responses/security.create_action_group@200' + '201': + $ref: '#/components/responses/security.create_action_group@201' /_plugins/_security/api/allowlist: get: operationId: security.get_allowlist.0 x-operation-group: security.get_allowlist - x-version-added: '1.0' + x-version-added: '2.1' + x-distributions-excluded: + - amazon-managed + - amazon-serverless description: Retrieves the current list of allowed API accessible to normal user. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#access-control-for-the-api responses: '200': $ref: '#/components/responses/security.get_allowlist@200' + '403': + $ref: '#/components/responses/security.get_allowlist@403' parameters: - $ref: '#/components/parameters/_global::query.pretty' - $ref: '#/components/parameters/_global::query.human' @@ -4380,7 +4750,10 @@ paths: patch: operationId: security.patch_allowlist.0 x-operation-group: security.patch_allowlist - x-version-added: '1.0' + x-version-added: '2.1' + x-distributions-excluded: + - amazon-managed + - amazon-serverless description: Updates the current list of allowed API accessible to normal user. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#access-control-for-the-api @@ -4389,6 +4762,8 @@ paths: responses: '200': $ref: '#/components/responses/security.patch_allowlist@200' + '403': + $ref: '#/components/responses/security.patch_allowlist@403' parameters: - $ref: '#/components/parameters/_global::query.pretty' - $ref: '#/components/parameters/_global::query.human' @@ -4398,7 +4773,10 @@ paths: put: operationId: security.create_allowlist.0 x-operation-group: security.create_allowlist - x-version-added: '1.0' + x-version-added: '2.1' + x-distributions-excluded: + - amazon-managed + - amazon-serverless description: Creates or replaces the allowlisted APIs. Accessible via Super Admin certificate or REST API permission. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#access-control-for-the-api @@ -4407,6 +4785,8 @@ paths: responses: '200': $ref: '#/components/responses/security.create_allowlist@200' + '403': + $ref: '#/components/responses/security.create_allowlist@403' parameters: - $ref: '#/components/parameters/_global::query.pretty' - $ref: '#/components/parameters/_global::query.human' @@ -4418,6 +4798,9 @@ paths: operationId: security.get_audit_configuration.0 x-operation-group: security.get_audit_configuration x-version-added: '1.0' + x-distributions-excluded: + - amazon-managed + - amazon-serverless description: Retrieves the audit configuration. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#audit-logs @@ -4434,6 +4817,9 @@ paths: operationId: security.patch_audit_configuration.0 x-operation-group: security.patch_audit_configuration x-version-added: '1.0' + x-distributions-excluded: + - amazon-managed + - amazon-serverless description: A PATCH call is used to update specified fields in the audit configuration. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#audit-logs @@ -4453,6 +4839,9 @@ paths: operationId: security.update_audit_configuration.0 x-operation-group: security.update_audit_configuration x-version-added: '1.0' + x-distributions-excluded: + - amazon-managed + - amazon-serverless description: Updates the audit configuration. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#audit-logs @@ -4472,6 +4861,9 @@ paths: operationId: security.authtoken.0 x-operation-group: security.authtoken x-version-added: '1.0' + x-distributions-excluded: + - amazon-managed + - amazon-serverless description: Returns the authorization token. responses: '200': @@ -4487,6 +4879,9 @@ paths: operationId: security.flush_cache.0 x-operation-group: security.flush_cache x-version-added: '1.0' + x-distributions-excluded: + - amazon-managed + - amazon-serverless description: Flushes the Security plugin user, authentication, and authorization cache. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#flush-cache @@ -4504,6 +4899,9 @@ paths: x-operation-group: security.cache x-ignorable: true x-version-added: '1.0' + x-distributions-excluded: + - amazon-managed + - amazon-serverless description: Not supported for cache API. responses: '501': @@ -4518,6 +4916,9 @@ paths: operationId: security.cache.2 x-operation-group: security.cache x-version-added: '1.0' + x-distributions-excluded: + - amazon-managed + - amazon-serverless x-ignorable: true description: Not supported for cache API. responses: @@ -4533,6 +4934,9 @@ paths: operationId: security.cache.3 x-operation-group: security.cache x-version-added: '1.0' + x-distributions-excluded: + - amazon-managed + - amazon-serverless x-ignorable: true description: Not supported for cache API. responses: @@ -4544,11 +4948,63 @@ paths: - $ref: '#/components/parameters/_global::query.error_trace' - $ref: '#/components/parameters/_global::query.source' - $ref: '#/components/parameters/_global::query.filter_path' + /_plugins/_security/api/certificates: + get: + operationId: security.get_all_certificates.0 + x-operation-group: security.get_all_certificates + x-version-added: '2.15' + x-distributions-excluded: + - amazon-managed + - amazon-serverless + description: Retrieves the cluster security certificates. + parameters: + - $ref: '#/components/parameters/security.get_all_certificates::query.cert_type' + - $ref: '#/components/parameters/security.get_all_certificates::query.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' + responses: + '200': + $ref: '#/components/responses/security.get_all_certificates@200' + '403': + $ref: '#/components/responses/security.get_all_certificates@403' + '500': + $ref: '#/components/responses/security.get_all_certificates@500' + /_plugins/_security/api/certificates/{node_id}: + get: + operationId: security.get_node_certificates.0 + x-operation-group: security.get_node_certificates + x-version-added: '2.15' + x-distributions-excluded: + - amazon-managed + - amazon-serverless + description: Retrieves the given node's security certificates. + parameters: + - $ref: '#/components/parameters/security.get_node_certificates::path.node_id' + - $ref: '#/components/parameters/security.get_node_certificates::query.cert_type' + - $ref: '#/components/parameters/security.get_node_certificates::query.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' + responses: + '200': + $ref: '#/components/responses/security.get_node_certificates@200' + '403': + $ref: '#/components/responses/security.get_node_certificates@403' + '500': + $ref: '#/components/responses/security.get_node_certificates@500' /_plugins/_security/api/generateonbehalfoftoken: post: operationId: security.generate_obo_token.0 x-operation-group: security.generate_obo_token x-version-added: '2.12' + x-distributions-excluded: + - amazon-managed + - amazon-serverless description: Generates On-Behalf-Of token for the current user. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/authentication-tokens/#api-endpoint @@ -4570,6 +5026,9 @@ paths: operationId: security.get_users.0 x-operation-group: security.get_users x-version-added: '1.0' + x-distributions-excluded: + - amazon-managed + - amazon-serverless description: Retrieve all internal users. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#get-users @@ -4586,6 +5045,9 @@ paths: operationId: security.patch_users.0 x-operation-group: security.patch_users x-version-added: '1.0' + x-distributions-excluded: + - amazon-managed + - amazon-serverless description: Creates, updates, or deletes multiple internal users in a single call. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#patch-users @@ -4605,6 +5067,9 @@ paths: operationId: security.delete_user.0 x-operation-group: security.delete_user x-version-added: '1.0' + x-distributions-excluded: + - amazon-managed + - amazon-serverless description: Delete the specified user. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#delete-user @@ -4622,6 +5087,9 @@ paths: operationId: security.get_user.0 x-operation-group: security.get_user x-version-added: '1.0' + x-distributions-excluded: + - amazon-managed + - amazon-serverless description: Retrieve one internal user. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#get-user @@ -4639,6 +5107,9 @@ paths: operationId: security.patch_user.0 x-operation-group: security.patch_user x-version-added: '1.0' + x-distributions-excluded: + - amazon-managed + - amazon-serverless description: Updates individual attributes of an internal user. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#patch-user @@ -4658,6 +5129,9 @@ paths: operationId: security.create_user.0 x-operation-group: security.create_user x-version-added: '1.0' + x-distributions-excluded: + - amazon-managed + - amazon-serverless description: Creates or replaces the specified user. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#create-user @@ -4677,7 +5151,10 @@ paths: post: operationId: security.generate_user_token.0 x-operation-group: security.generate_user_token - x-version-added: '1.0' + x-version-added: '2.7' + x-distributions-excluded: + - amazon-managed + - amazon-serverless description: Generates authorization token for the given user. parameters: - $ref: '#/components/parameters/security.generate_user_token::path.username' @@ -4696,6 +5173,9 @@ paths: operationId: security.migrate.0 x-operation-group: security.migrate x-version-added: '1.0' + x-distributions-excluded: + - amazon-managed + - amazon-serverless description: Migrates security configuration from v6 to v7. responses: '200': @@ -4713,6 +5193,9 @@ paths: operationId: security.get_distinguished_names.0 x-operation-group: security.get_distinguished_names x-version-added: '1.0' + x-distributions-excluded: + - amazon-managed + - amazon-serverless description: Retrieves distinguished names. Only accessible to super-admins and with rest-api permissions when enabled. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#get-distinguished-names @@ -4726,12 +5209,17 @@ paths: responses: '200': $ref: '#/components/responses/security.get_distinguished_names@200' + '400': + $ref: '#/components/responses/security.get_distinguished_names@400' '403': $ref: '#/components/responses/security.get_distinguished_names@403' patch: operationId: security.patch_distinguished_names.0 x-operation-group: security.patch_distinguished_names x-version-added: '1.0' + x-distributions-excluded: + - amazon-managed + - amazon-serverless description: Bulk update of distinguished names. Only accessible to super-admins and with rest-api permissions when enabled. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#update-all-distinguished-names @@ -4740,6 +5228,8 @@ paths: responses: '200': $ref: '#/components/responses/security.patch_distinguished_names@200' + '400': + $ref: '#/components/responses/security.patch_distinguished_names@400' '403': $ref: '#/components/responses/security.patch_distinguished_names@403' parameters: @@ -4753,6 +5243,9 @@ paths: operationId: security.delete_distinguished_name.0 x-operation-group: security.delete_distinguished_name x-version-added: '1.0' + x-distributions-excluded: + - amazon-managed + - amazon-serverless description: Deletes all distinguished names in the specified cluster or node allow list. Only accessible to super-admins and with rest-api permissions when enabled. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#delete-distinguished-names @@ -4766,12 +5259,17 @@ paths: responses: '200': $ref: '#/components/responses/security.delete_distinguished_name@200' + '400': + $ref: '#/components/responses/security.delete_distinguished_name@400' '403': $ref: '#/components/responses/security.delete_distinguished_name@403' get: operationId: security.get_distinguished_name.0 x-operation-group: security.get_distinguished_name x-version-added: '1.0' + x-distributions-excluded: + - amazon-managed + - amazon-serverless description: Retrieves distinguished names. Only accessible to super-admins and with rest-api permissions when enabled. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#get-distinguished-names @@ -4786,12 +5284,17 @@ paths: responses: '200': $ref: '#/components/responses/security.get_distinguished_name@200' + '400': + $ref: '#/components/responses/security.get_distinguished_name@400' '403': $ref: '#/components/responses/security.get_distinguished_name@403' patch: operationId: security.patch_distinguished_name.0 x-operation-group: security.patch_distinguished_name x-version-added: '1.0' + x-distributions-excluded: + - amazon-managed + - amazon-serverless description: Updates a distinguished cluster name for a specific cluster. Only accessible to super-admins and with rest-api permissions when enabled. parameters: - $ref: '#/components/parameters/security.patch_distinguished_name::path.cluster_name' @@ -4805,12 +5308,17 @@ paths: responses: '200': $ref: '#/components/responses/security.patch_distinguished_name@200' + '400': + $ref: '#/components/responses/security.patch_distinguished_name@400' '403': $ref: '#/components/responses/security.patch_distinguished_name@403' put: operationId: security.update_distinguished_name.0 x-operation-group: security.update_distinguished_name x-version-added: '1.0' + x-distributions-excluded: + - amazon-managed + - amazon-serverless description: Adds or updates the specified distinguished names in the cluster or node allow list. Only accessible to super-admins and with rest-api permissions when enabled. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#update-distinguished-names @@ -4826,6 +5334,8 @@ paths: responses: '200': $ref: '#/components/responses/security.update_distinguished_name@200' + '400': + $ref: '#/components/responses/security.update_distinguished_name@400' '403': $ref: '#/components/responses/security.update_distinguished_name@403' /_plugins/_security/api/permissionsinfo: @@ -4833,6 +5343,9 @@ paths: operationId: security.get_permissions_info.0 x-operation-group: security.get_permissions_info x-version-added: '1.0' + x-distributions-excluded: + - amazon-managed + - amazon-serverless description: Gets the evaluated REST API permissions for the currently logged in user. responses: '200': @@ -4850,6 +5363,9 @@ paths: operationId: security.get_roles.0 x-operation-group: security.get_roles x-version-added: '1.0' + x-distributions-excluded: + - amazon-managed + - amazon-serverless description: Retrieves all roles. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#get-roles @@ -4866,6 +5382,9 @@ paths: operationId: security.patch_roles.0 x-operation-group: security.patch_roles x-version-added: '1.0' + x-distributions-excluded: + - amazon-managed + - amazon-serverless description: Creates, updates, or deletes multiple roles in a single call. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#patch-roles @@ -4887,6 +5406,9 @@ paths: operationId: security.delete_role.0 x-operation-group: security.delete_role x-version-added: '1.0' + x-distributions-excluded: + - amazon-managed + - amazon-serverless description: Delete the specified role. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#delete-role @@ -4904,6 +5426,9 @@ paths: operationId: security.get_role.0 x-operation-group: security.get_role x-version-added: '1.0' + x-distributions-excluded: + - amazon-managed + - amazon-serverless description: Retrieves one role. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#get-role @@ -4921,6 +5446,9 @@ paths: operationId: security.patch_role.0 x-operation-group: security.patch_role x-version-added: '1.0' + x-distributions-excluded: + - amazon-managed + - amazon-serverless description: Updates individual attributes of a role. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#patch-role @@ -4942,6 +5470,9 @@ paths: operationId: security.create_role.0 x-operation-group: security.create_role x-version-added: '1.0' + x-distributions-excluded: + - amazon-managed + - amazon-serverless description: Creates or replaces the specified role. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#create-role @@ -4957,11 +5488,16 @@ paths: responses: '200': $ref: '#/components/responses/security.create_role@200' + '201': + $ref: '#/components/responses/security.create_role@201' /_plugins/_security/api/rolesmapping: get: operationId: security.get_role_mappings.0 x-operation-group: security.get_role_mappings x-version-added: '1.0' + x-distributions-excluded: + - amazon-managed + - amazon-serverless description: Retrieves all role mappings. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#get-role-mappings @@ -4978,6 +5514,9 @@ paths: operationId: security.patch_role_mappings.0 x-operation-group: security.patch_role_mappings x-version-added: '1.0' + x-distributions-excluded: + - amazon-managed + - amazon-serverless description: Creates or updates multiple role mappings in a single call. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#patch-role-mappings @@ -4999,6 +5538,9 @@ paths: operationId: security.delete_role_mapping.0 x-operation-group: security.delete_role_mapping x-version-added: '1.0' + x-distributions-excluded: + - amazon-managed + - amazon-serverless description: Deletes the specified role mapping. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#delete-role-mapping @@ -5016,6 +5558,9 @@ paths: operationId: security.get_role_mapping.0 x-operation-group: security.get_role_mapping x-version-added: '1.0' + x-distributions-excluded: + - amazon-managed + - amazon-serverless description: Retrieves one role mapping. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#get-role-mapping @@ -5033,6 +5578,9 @@ paths: operationId: security.patch_role_mapping.0 x-operation-group: security.patch_role_mapping x-version-added: '1.0' + x-distributions-excluded: + - amazon-managed + - amazon-serverless description: Updates individual attributes of a role mapping. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#patch-role-mapping @@ -5054,6 +5602,9 @@ paths: operationId: security.create_role_mapping.0 x-operation-group: security.create_role_mapping x-version-added: '1.0' + x-distributions-excluded: + - amazon-managed + - amazon-serverless description: Creates or replaces the specified role mapping. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#create-role-mapping @@ -5069,11 +5620,16 @@ paths: responses: '200': $ref: '#/components/responses/security.create_role_mapping@200' + '201': + $ref: '#/components/responses/security.create_role_mapping@201' /_plugins/_security/api/securityconfig: get: operationId: security.get_configuration.0 x-operation-group: security.get_configuration - x-version-added: '1.0' + x-version-added: '2.10' + x-distributions-excluded: + - amazon-managed + - amazon-serverless description: Returns the current Security plugin configuration in JSON format. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#get-configuration @@ -5089,7 +5645,10 @@ paths: patch: operationId: security.patch_configuration.0 x-operation-group: security.patch_configuration - x-version-added: '1.0' + x-version-added: '2.10' + x-distributions-excluded: + - amazon-managed + - amazon-serverless description: A PATCH call is used to update the existing configuration using the REST API. Only accessible by admins and users with rest api access and only when put or patch is enabled. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#patch-configuration @@ -5098,6 +5657,8 @@ paths: responses: '200': $ref: '#/components/responses/security.patch_configuration@200' + '403': + $ref: '#/components/responses/security.patch_configuration@403' parameters: - $ref: '#/components/parameters/_global::query.pretty' - $ref: '#/components/parameters/_global::query.human' @@ -5108,7 +5669,10 @@ paths: put: operationId: security.update_configuration.0 x-operation-group: security.update_configuration - x-version-added: '1.0' + x-version-added: '2.10' + x-distributions-excluded: + - amazon-managed + - amazon-serverless description: Adds or updates the existing configuration using the REST API. Only accessible by admins and users with rest api access and only when put or patch is enabled. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#update-configuration @@ -5117,6 +5681,8 @@ paths: responses: '200': $ref: '#/components/responses/security.update_configuration@200' + '403': + $ref: '#/components/responses/security.update_configuration@403' parameters: - $ref: '#/components/parameters/_global::query.pretty' - $ref: '#/components/parameters/_global::query.human' @@ -5127,7 +5693,10 @@ paths: get: operationId: security.get_certificates.0 x-operation-group: security.get_certificates - x-version-added: '1.0' + x-version-added: '2.0' + x-distributions-excluded: + - amazon-managed + - amazon-serverless description: Retrieves the cluster security certificates. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#get-certificates @@ -5136,6 +5705,8 @@ paths: $ref: '#/components/responses/security.get_certificates@200' '400': $ref: '#/components/responses/security.get_certificates@400' + '403': + $ref: '#/components/responses/security.get_certificates@403' parameters: - $ref: '#/components/parameters/_global::query.pretty' - $ref: '#/components/parameters/_global::query.human' @@ -5146,7 +5717,10 @@ paths: put: operationId: security.reload_http_certificates.0 x-operation-group: security.reload_http_certificates - x-version-added: '1.0' + x-version-added: '2.8' + x-distributions-excluded: + - amazon-managed + - amazon-serverless description: Reload HTTP layer communication certificates. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#reload-http-certificates @@ -5155,6 +5729,8 @@ paths: $ref: '#/components/responses/security.reload_http_certificates@200' '400': $ref: '#/components/responses/security.reload_http_certificates@400' + '403': + $ref: '#/components/responses/security.reload_http_certificates@403' parameters: - $ref: '#/components/parameters/_global::query.pretty' - $ref: '#/components/parameters/_global::query.human' @@ -5165,7 +5741,10 @@ paths: put: operationId: security.reload_transport_certificates.0 x-operation-group: security.reload_transport_certificates - x-version-added: '1.0' + x-version-added: '2.8' + x-distributions-excluded: + - amazon-managed + - amazon-serverless description: Reload Transport layer communication certificates. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#reload-transport-certificates @@ -5174,6 +5753,8 @@ paths: $ref: '#/components/responses/security.reload_transport_certificates@200' '400': $ref: '#/components/responses/security.reload_transport_certificates@400' + '403': + $ref: '#/components/responses/security.reload_transport_certificates@403' parameters: - $ref: '#/components/parameters/_global::query.pretty' - $ref: '#/components/parameters/_global::query.human' @@ -5185,6 +5766,9 @@ paths: operationId: security.get_tenancy_config.0 x-operation-group: security.get_tenancy_config x-version-added: '2.7' + x-distributions-excluded: + - amazon-managed + - amazon-serverless description: Retrieves multi-tenancy configuration. Only accessible to admins and users with REST API permissions. externalDocs: url: https://opensearch.org/docs/latest/security/multi-tenancy/dynamic-config/#configuring-multi-tenancy-with-the-rest-api @@ -5203,6 +5787,9 @@ paths: operationId: security.create_update_tenancy_config.0 x-operation-group: security.create_update_tenancy_config x-version-added: '2.7' + x-distributions-excluded: + - amazon-managed + - amazon-serverless description: Creates or replaces the multi-tenancy configuration. Only accessible to admins and users with REST API permissions. externalDocs: url: https://opensearch.org/docs/latest/security/multi-tenancy/dynamic-config/#configuring-multi-tenancy-with-the-rest-api @@ -5224,6 +5811,9 @@ paths: operationId: security.get_tenants.0 x-operation-group: security.get_tenants x-version-added: '1.0' + x-distributions-excluded: + - amazon-managed + - amazon-serverless description: Retrieves all tenants. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#get-tenants @@ -5242,6 +5832,9 @@ paths: operationId: security.patch_tenants.0 x-operation-group: security.patch_tenants x-version-added: '1.0' + x-distributions-excluded: + - amazon-managed + - amazon-serverless description: Add, delete, or modify multiple tenants in a single call. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#patch-tenants @@ -5263,6 +5856,9 @@ paths: operationId: security.delete_tenant.0 x-operation-group: security.delete_tenant x-version-added: '1.0' + x-distributions-excluded: + - amazon-managed + - amazon-serverless description: Delete the specified tenant. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#delete-action-group @@ -5282,6 +5878,9 @@ paths: operationId: security.get_tenant.0 x-operation-group: security.get_tenant x-version-added: '1.0' + x-distributions-excluded: + - amazon-managed + - amazon-serverless description: Retrieves one tenant. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#get-tenant @@ -5299,6 +5898,9 @@ paths: operationId: security.patch_tenant.0 x-operation-group: security.patch_tenant x-version-added: '1.0' + x-distributions-excluded: + - amazon-managed + - amazon-serverless description: Add, delete, or modify a single tenant. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#patch-tenant @@ -5320,6 +5922,9 @@ paths: operationId: security.create_tenant.0 x-operation-group: security.create_tenant x-version-added: '1.0' + x-distributions-excluded: + - amazon-managed + - amazon-serverless description: Creates or replaces the specified tenant. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#create-tenant @@ -5335,6 +5940,8 @@ paths: responses: '200': $ref: '#/components/responses/security.create_tenant@200' + '201': + $ref: '#/components/responses/security.create_tenant@201' '400': $ref: '#/components/responses/security.create_tenant@400' /_plugins/_security/api/user: @@ -5342,6 +5949,9 @@ paths: operationId: security.get_users_legacy.0 x-operation-group: security.get_users_legacy x-version-added: '1.0' + x-distributions-excluded: + - amazon-managed + - amazon-serverless description: Retrieve all internal users. Legacy API. responses: '200': @@ -5357,6 +5967,9 @@ paths: operationId: security.delete_user_legacy.0 x-operation-group: security.delete_user_legacy x-version-added: '1.0' + x-distributions-excluded: + - amazon-managed + - amazon-serverless description: Delete the specified user. Legacy API. parameters: - $ref: '#/components/parameters/security.delete_user_legacy::path.username' @@ -5372,6 +5985,9 @@ paths: operationId: security.get_user_legacy.0 x-operation-group: security.get_user_legacy x-version-added: '1.0' + x-distributions-excluded: + - amazon-managed + - amazon-serverless description: Retrieve one user. Legacy API. parameters: - $ref: '#/components/parameters/security.get_user_legacy::path.username' @@ -5387,6 +6003,9 @@ paths: operationId: security.create_user_legacy.0 x-operation-group: security.create_user_legacy x-version-added: '1.0' + x-distributions-excluded: + - amazon-managed + - amazon-serverless description: Creates or replaces the specified user. Legacy API. parameters: - $ref: '#/components/parameters/security.create_user_legacy::path.username' @@ -5400,12 +6019,17 @@ paths: responses: '200': $ref: '#/components/responses/security.create_user_legacy@200' + '201': + $ref: '#/components/responses/security.create_user_legacy@201' /_plugins/_security/api/user/{username}/authtoken: post: operationId: security.generate_user_token_legacy.0 x-operation-group: security.generate_user_token_legacy - x-version-added: '1.0' - description: Generates authorization token for the given user. Legacy API. + x-version-added: '2.7' + x-distributions-excluded: + - amazon-managed + - amazon-serverless + description: Generates authorization token for the given user. Legacy API. Not Implemented. parameters: - $ref: '#/components/parameters/security.generate_user_token_legacy::path.username' - $ref: '#/components/parameters/_global::query.pretty' @@ -5414,15 +6038,16 @@ paths: - $ref: '#/components/parameters/_global::query.source' - $ref: '#/components/parameters/_global::query.filter_path' responses: - '200': - $ref: '#/components/responses/security.generate_user_token_legacy@200' - '400': - $ref: '#/components/responses/security.generate_user_token_legacy@400' + '501': + $ref: '#/components/responses/security.generate_user_token_legacy@501' /_plugins/_security/api/validate: get: operationId: security.validate.0 x-operation-group: security.validate x-version-added: '1.0' + x-distributions-excluded: + - amazon-managed + - amazon-serverless description: Checks whether the v6 security configuration is valid and ready to be migrated to v7. parameters: - $ref: '#/components/parameters/security.validate::query.accept_invalid' @@ -5441,6 +6066,9 @@ paths: operationId: security.authinfo.0 x-operation-group: security.authinfo x-version-added: '1.0' + x-distributions-excluded: + - amazon-managed + - amazon-serverless description: Returns the authentication information. parameters: - $ref: '#/components/parameters/security.authinfo::query.auth_type' @@ -5459,6 +6087,9 @@ paths: operationId: security.authinfo.1 x-operation-group: security.authinfo x-version-added: '1.0' + x-distributions-excluded: + - amazon-managed + - amazon-serverless description: Returns the authentication information. parameters: - $ref: '#/components/parameters/security.authinfo::query.auth_type' @@ -5478,6 +6109,9 @@ paths: operationId: security.get_dashboards_info.0 x-operation-group: security.get_dashboards_info x-version-added: '1.0' + x-distributions-excluded: + - amazon-managed + - amazon-serverless description: Retrieves the current security-dashboards plugin configuration. responses: '200': @@ -5494,9 +6128,10 @@ paths: operationId: security.post_dashboards_info.1 x-operation-group: security.post_dashboards_info x-version-added: '1.0' + x-distributions-excluded: + - amazon-managed + - amazon-serverless description: Updates the current security-dashboards plugin configuration. - requestBody: - $ref: '#/components/requestBodies/security.post_dashboards_info' responses: '200': $ref: '#/components/responses/security.post_dashboards_info@200' @@ -5513,6 +6148,9 @@ paths: operationId: security.health.0 x-operation-group: security.health x-version-added: '1.0' + x-distributions-excluded: + - amazon-managed + - amazon-serverless description: Checks to see if the Security plugin is up and running. parameters: - $ref: '#/components/parameters/security.health::query.mode' @@ -5530,6 +6168,9 @@ paths: operationId: security.health.1 x-operation-group: security.health x-version-added: '1.0' + x-distributions-excluded: + - amazon-managed + - amazon-serverless description: Checks to see if the Security plugin is up and running. parameters: - $ref: '#/components/parameters/security.health::query.mode' @@ -5548,10 +6189,15 @@ paths: operationId: security.tenant_info.0 x-operation-group: security.tenant_info x-version-added: '1.0' + x-distributions-excluded: + - amazon-managed + - amazon-serverless description: Retrieves the tenant names if any exist. Only accessible to super admins or kibanaserver user. responses: '200': $ref: '#/components/responses/security.tenant_info@200' + '403': + $ref: '#/components/responses/security.tenant_info@403' '500': $ref: '#/components/responses/security.tenant_info@500' parameters: @@ -5564,10 +6210,15 @@ paths: operationId: security.tenant_info.1 x-operation-group: security.tenant_info x-version-added: '1.0' + x-distributions-excluded: + - amazon-managed + - amazon-serverless description: Retrieves the tenant names if any exist. Only accessible to super admins or kibanaserver user. responses: '200': $ref: '#/components/responses/security.tenant_info@200' + '403': + $ref: '#/components/responses/security.tenant_info@403' '500': $ref: '#/components/responses/security.tenant_info@500' parameters: @@ -5580,7 +6231,10 @@ paths: get: operationId: security.who_am_i.0 x-operation-group: security.who_am_i - x-version-added: '1.0' + x-version-added: '2.0' + x-distributions-excluded: + - amazon-managed + - amazon-serverless description: Gets the user identity related information for currently logged in user. responses: '200': @@ -5596,7 +6250,10 @@ paths: post: operationId: security.who_am_i.1 x-operation-group: security.who_am_i - x-version-added: '1.0' + x-version-added: '2.0' + x-distributions-excluded: + - amazon-managed + - amazon-serverless description: Gets the user identity related information for currently logged in user. responses: '200': @@ -5614,6 +6271,9 @@ paths: operationId: security.who_am_i_protected.0 x-operation-group: security.who_am_i_protected x-version-added: '2.11' + x-distributions-excluded: + - amazon-managed + - amazon-serverless description: Gets the user identity related information for currently logged in user. User needs to have access to this endpoint when authorization at REST layer is enabled. responses: '200': @@ -5626,6 +6286,108 @@ paths: - $ref: '#/components/parameters/_global::query.error_trace' - $ref: '#/components/parameters/_global::query.source' - $ref: '#/components/parameters/_global::query.filter_path' + /_plugins/_sql: + post: + operationId: sql.query.0 + x-operation-group: sql.query + x-version-added: '1.0' + description: Send a SQL/PPL query to the SQL plugin. + externalDocs: + url: https://opensearch.org/docs/latest/search-plugins/sql/sql-ppl-api/ + parameters: + - $ref: '#/components/parameters/sql.query::query.format' + - $ref: '#/components/parameters/sql.query::query.sanitize' + - $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/sql.query' + responses: + '200': + $ref: '#/components/responses/sql.query@200' + /_plugins/_sql/_explain: + post: + operationId: sql.explain.0 + x-operation-group: sql.explain + x-version-added: '1.0' + description: Shows how a query is executed against OpenSearch. + externalDocs: + url: https://opensearch.org/docs/latest/search-plugins/sql/sql-ppl-api/ + parameters: + - $ref: '#/components/parameters/sql.explain::query.format' + - $ref: '#/components/parameters/sql.explain::query.sanitize' + - $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/sql.explain' + responses: + '200': + $ref: '#/components/responses/sql.explain@200' + /_plugins/_sql/close: + post: + operationId: sql.close.0 + x-operation-group: sql.close + x-version-added: '1.0' + description: Clear the cursor context. + externalDocs: + url: https://opensearch.org/docs/latest/search-plugins/sql/sql-ppl-api/ + parameters: + - $ref: '#/components/parameters/sql.close::query.format' + - $ref: '#/components/parameters/sql.close::query.sanitize' + - $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/sql.close' + responses: + '200': + $ref: '#/components/responses/sql.close@200' + /_plugins/_sql/stats: + get: + operationId: sql.get_stats.0 + x-operation-group: sql.get_stats + x-version-added: '1.0' + description: Collect metrics for the plugin within the interval. + externalDocs: + url: https://opensearch.org/docs/latest/search-plugins/sql/monitoring/ + parameters: + - $ref: '#/components/parameters/sql.get_stats::query.format' + - $ref: '#/components/parameters/sql.get_stats::query.sanitize' + - $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/sql.get_stats@200' + post: + operationId: sql.post_stats.1 + x-operation-group: sql.post_stats + x-version-added: '1.0' + description: By a stats endpoint, you are able to collect metrics for the plugin within the interval. + externalDocs: + url: https://opensearch.org/docs/latest/search-plugins/sql/monitoring/ + parameters: + - $ref: '#/components/parameters/sql.post_stats::query.format' + - $ref: '#/components/parameters/sql.post_stats::query.sanitize' + - $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/sql.post_stats' + responses: + '200': + $ref: '#/components/responses/sql.post_stats@200' /_plugins/_transform: get: operationId: transforms.search.0 @@ -5762,7 +6524,7 @@ paths: operationId: transforms.stop.0 x-operation-group: transforms.stop x-version-added: '1.0' - description: stop transform. + description: Stop transform. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/index-transforms/transforms-apis/#stop-a-transform-job parameters: @@ -6327,6 +7089,10 @@ paths: responses: '200': $ref: '#/components/responses/search@200' + '400': + $ref: '#/components/responses/search@400' + '404': + $ref: '#/components/responses/search@404' post: operationId: search.1 x-operation-group: search @@ -6391,6 +7157,10 @@ paths: responses: '200': $ref: '#/components/responses/search@200' + '400': + $ref: '#/components/responses/search@400' + '404': + $ref: '#/components/responses/search@404' /_search_shards: get: operationId: search_shards.0 @@ -6761,6 +7531,9 @@ paths: operationId: indices.segments.0 x-operation-group: indices.segments x-version-added: '1.0' + x-distributions-excluded: + - amazon-managed + - amazon-serverless description: Provides low-level information about segments in a Lucene index. externalDocs: url: https://opensearch.org/docs/latest @@ -6782,6 +7555,9 @@ paths: operationId: indices.get_settings.0 x-operation-group: indices.get_settings x-version-added: '1.0' + x-distributions-excluded: + - amazon-managed + - amazon-serverless description: Returns settings for one or more indices. externalDocs: url: https://opensearch.org/docs/latest/api-reference/index-apis/get-settings/ @@ -7790,13 +8566,15 @@ paths: responses: '200': $ref: '#/components/responses/indices.get_alias@200' + '404': + $ref: '#/components/responses/indices.get_alias@404' put: operationId: indices.put_alias.5 x-operation-group: indices.put_alias x-version-added: '1.0' description: Creates or updates an alias. externalDocs: - url: https://opensearch.org/docs/latest/im-plugin/index-alias/#create-aliases + url: https://opensearch.org/docs/latest/api-reference/index-apis/update-alias/ parameters: - $ref: '#/components/parameters/indices.put_alias::path.index' - $ref: '#/components/parameters/indices.put_alias::query.cluster_manager_timeout' @@ -7856,6 +8634,8 @@ paths: responses: '200': $ref: '#/components/responses/indices.get_alias@200' + '404': + $ref: '#/components/responses/indices.get_alias@404' head: operationId: indices.exists_alias.1 x-operation-group: indices.exists_alias @@ -7878,13 +8658,15 @@ paths: responses: '200': $ref: '#/components/responses/indices.exists_alias@200' + '404': + $ref: '#/components/responses/indices.exists_alias@404' post: operationId: indices.put_alias.6 x-operation-group: indices.put_alias x-version-added: '1.0' description: Creates or updates an alias. externalDocs: - url: https://opensearch.org/docs/latest/im-plugin/index-alias/#create-aliases + url: https://opensearch.org/docs/latest/api-reference/index-apis/update-alias/ parameters: - $ref: '#/components/parameters/indices.put_alias::path.index' - $ref: '#/components/parameters/indices.put_alias::path.name' @@ -7907,7 +8689,7 @@ paths: x-version-added: '1.0' description: Creates or updates an alias. externalDocs: - url: https://opensearch.org/docs/latest/im-plugin/index-alias/#create-aliases + url: https://opensearch.org/docs/latest/api-reference/index-apis/update-alias/ parameters: - $ref: '#/components/parameters/indices.put_alias::path.index' - $ref: '#/components/parameters/indices.put_alias::path.name' @@ -7931,7 +8713,7 @@ paths: x-version-added: '1.0' description: Creates or updates an alias. externalDocs: - url: https://opensearch.org/docs/latest/im-plugin/index-alias/#create-aliases + url: https://opensearch.org/docs/latest/api-reference/index-apis/update-alias/ parameters: - $ref: '#/components/parameters/indices.put_alias::path.index' - $ref: '#/components/parameters/indices.put_alias::query.cluster_manager_timeout' @@ -7975,7 +8757,7 @@ paths: x-version-added: '1.0' description: Creates or updates an alias. externalDocs: - url: https://opensearch.org/docs/latest/im-plugin/index-alias/#create-aliases + url: https://opensearch.org/docs/latest/api-reference/index-apis/update-alias/ parameters: - $ref: '#/components/parameters/indices.put_alias::path.index' - $ref: '#/components/parameters/indices.put_alias::path.name' @@ -7998,7 +8780,7 @@ paths: x-version-added: '1.0' description: Creates or updates an alias. externalDocs: - url: https://opensearch.org/docs/latest/im-plugin/index-alias/#create-aliases + url: https://opensearch.org/docs/latest/api-reference/index-apis/update-alias/ parameters: - $ref: '#/components/parameters/indices.put_alias::path.index' - $ref: '#/components/parameters/indices.put_alias::path.name' @@ -9315,6 +10097,10 @@ paths: responses: '200': $ref: '#/components/responses/search@200' + '400': + $ref: '#/components/responses/search@400' + '404': + $ref: '#/components/responses/search@404' post: operationId: search.3 x-operation-group: search @@ -9380,6 +10166,10 @@ paths: responses: '200': $ref: '#/components/responses/search@200' + '400': + $ref: '#/components/responses/search@400' + '404': + $ref: '#/components/responses/search@404' /{index}/_search_shards: get: operationId: search_shards.2 @@ -9520,6 +10310,9 @@ paths: operationId: indices.segments.1 x-operation-group: indices.segments x-version-added: '1.0' + x-distributions-excluded: + - amazon-managed + - amazon-serverless description: Provides low-level information about segments in a Lucene index. externalDocs: url: https://opensearch.org/docs/latest @@ -10178,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 @@ -10241,6 +11117,95 @@ paths: $ref: '#/components/responses/knn.stats@200' deprecated: true x-ignorable: true + /_opendistro/_ppl: + post: + operationId: ppl.query.0_superseded + x-operation-group: ppl.query + x-version-added: '1.0' + description: Send a PPL query to the PPL plugin. + externalDocs: + url: https://opensearch.org/docs/latest/search-plugins/sql/sql-ppl-api/ + parameters: + - $ref: '#/components/parameters/ppl.query::query.format' + - $ref: '#/components/parameters/ppl.query::query.sanitize' + - $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/ppl.query' + responses: + '200': + $ref: '#/components/responses/ppl.query@200' + deprecated: true + x-ignorable: true + /_opendistro/_ppl/_explain: + post: + operationId: ppl.explain.0_superseded + x-operation-group: ppl.explain + x-version-added: '1.0' + description: Shows how a query is executed against OpenSearch. + externalDocs: + url: https://opensearch.org/docs/latest/search-plugins/sql/sql-ppl-api/ + parameters: + - $ref: '#/components/parameters/ppl.explain::query.format' + - $ref: '#/components/parameters/ppl.explain::query.sanitize' + - $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/ppl.explain' + responses: + '200': + $ref: '#/components/responses/ppl.explain@200' + deprecated: true + x-ignorable: true + /_opendistro/_ppl/stats: + get: + operationId: ppl.get_stats.0_superseded + x-operation-group: ppl.get_stats + x-version-added: '1.0' + description: Collect metrics for the plugin within the interval. + externalDocs: + url: https://opensearch.org/docs/latest/search-plugins/sql/monitoring/ + parameters: + - $ref: '#/components/parameters/ppl.get_stats::query.format' + - $ref: '#/components/parameters/ppl.get_stats::query.sanitize' + - $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/ppl.get_stats@200' + deprecated: true + x-ignorable: true + post: + operationId: ppl.post_stats.1_superseded + x-operation-group: ppl.post_stats + x-version-added: '1.0' + description: By a stats endpoint, you are able to collect metrics for the plugin within the interval. + externalDocs: + url: https://opensearch.org/docs/latest/search-plugins/sql/monitoring/ + parameters: + - $ref: '#/components/parameters/ppl.post_stats::query.format' + - $ref: '#/components/parameters/ppl.post_stats::query.sanitize' + - $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/ppl.post_stats' + responses: + '200': + $ref: '#/components/responses/ppl.post_stats@200' + deprecated: true + x-ignorable: true /_opendistro/_rollup/jobs/{rollupID}: get: operationId: rollups.get.0_superseded @@ -10368,6 +11333,9 @@ paths: operationId: security.get_account_details.0_superseded x-operation-group: security.get_account_details x-version-added: '1.0' + x-distributions-excluded: + - amazon-managed + - amazon-serverless description: Returns account details for the current user. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#get-account-details @@ -10386,6 +11354,9 @@ paths: operationId: security.change_password.0_superseded x-operation-group: security.change_password x-version-added: '1.0' + x-distributions-excluded: + - amazon-managed + - amazon-serverless description: Changes the password for the current user. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#change-password @@ -10394,6 +11365,8 @@ paths: responses: '200': $ref: '#/components/responses/security.change_password@200' + '403': + $ref: '#/components/responses/security.change_password@403' parameters: - $ref: '#/components/parameters/_global::query.pretty' - $ref: '#/components/parameters/_global::query.human' @@ -10407,6 +11380,9 @@ paths: operationId: security.get_action_group.0_superseded x-operation-group: security.get_action_group x-version-added: '1.0' + x-distributions-excluded: + - amazon-managed + - amazon-serverless description: Retrieves one action group. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#get-action-group @@ -10426,6 +11402,9 @@ paths: operationId: security.create_action_group.0_superseded x-operation-group: security.create_action_group x-version-added: '1.0' + x-distributions-excluded: + - amazon-managed + - amazon-serverless description: Creates or replaces the specified action group. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#create-action-group @@ -10441,12 +11420,17 @@ paths: responses: '200': $ref: '#/components/responses/security.create_action_group@200' + '201': + $ref: '#/components/responses/security.create_action_group@201' deprecated: true x-ignorable: true patch: operationId: security.patch_action_group.0_superseded x-operation-group: security.patch_action_group x-version-added: '1.0' + x-distributions-excluded: + - amazon-managed + - amazon-serverless description: Updates individual attributes of an action group. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#patch-action-group @@ -10468,6 +11452,9 @@ paths: operationId: security.delete_action_group.0_superseded x-operation-group: security.delete_action_group x-version-added: '1.0' + x-distributions-excluded: + - amazon-managed + - amazon-serverless description: Delete a specified action group. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#delete-action-group @@ -10488,6 +11475,9 @@ paths: operationId: security.update_audit_configuration.0_superseded x-operation-group: security.update_audit_configuration x-version-added: '1.0' + x-distributions-excluded: + - amazon-managed + - amazon-serverless description: Updates the audit configuration. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#audit-logs @@ -10509,6 +11499,9 @@ paths: operationId: security.authtoken.0_superseded x-operation-group: security.authtoken x-version-added: '1.0' + x-distributions-excluded: + - amazon-managed + - amazon-serverless description: Returns the authorization token. responses: '200': @@ -10527,6 +11520,9 @@ paths: x-operation-group: security.cache x-ignorable: true x-version-added: '1.0' + x-distributions-excluded: + - amazon-managed + - amazon-serverless description: Not supported for cache API. responses: '501': @@ -10542,6 +11538,9 @@ paths: operationId: security.cache.2_superseded x-operation-group: security.cache x-version-added: '1.0' + x-distributions-excluded: + - amazon-managed + - amazon-serverless x-ignorable: true description: Not supported for cache API. responses: @@ -10558,6 +11557,9 @@ paths: operationId: security.cache.3_superseded x-operation-group: security.cache x-version-added: '1.0' + x-distributions-excluded: + - amazon-managed + - amazon-serverless x-ignorable: true description: Not supported for cache API. responses: @@ -10574,6 +11576,9 @@ paths: operationId: security.flush_cache.0_superseded x-operation-group: security.flush_cache x-version-added: '1.0' + x-distributions-excluded: + - amazon-managed + - amazon-serverless description: Flushes the Security plugin user, authentication, and authorization cache. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#flush-cache @@ -10593,6 +11598,9 @@ paths: operationId: security.get_user.0_superseded x-operation-group: security.get_user x-version-added: '1.0' + x-distributions-excluded: + - amazon-managed + - amazon-serverless description: Retrieve one internal user. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#get-user @@ -10612,6 +11620,9 @@ paths: operationId: security.create_user.0_superseded x-operation-group: security.create_user x-version-added: '1.0' + x-distributions-excluded: + - amazon-managed + - amazon-serverless description: Creates or replaces the specified user. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#create-user @@ -10633,6 +11644,9 @@ paths: operationId: security.patch_user.0_superseded x-operation-group: security.patch_user x-version-added: '1.0' + x-distributions-excluded: + - amazon-managed + - amazon-serverless description: Updates individual attributes of an internal user. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#patch-user @@ -10654,6 +11668,9 @@ paths: operationId: security.delete_user.0_superseded x-operation-group: security.delete_user x-version-added: '1.0' + x-distributions-excluded: + - amazon-managed + - amazon-serverless description: Delete the specified user. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#delete-user @@ -10673,7 +11690,10 @@ paths: post: operationId: security.generate_user_token.0_superseded x-operation-group: security.generate_user_token - x-version-added: '1.0' + x-version-added: '2.7' + x-distributions-excluded: + - amazon-managed + - amazon-serverless description: Generates authorization token for the given user. parameters: - $ref: '#/components/parameters/security.generate_user_token::path.username' @@ -10694,6 +11714,9 @@ paths: operationId: security.migrate.0_superseded x-operation-group: security.migrate x-version-added: '1.0' + x-distributions-excluded: + - amazon-managed + - amazon-serverless description: Migrates security configuration from v6 to v7. responses: '200': @@ -10713,6 +11736,9 @@ paths: operationId: security.get_permissions_info.0_superseded x-operation-group: security.get_permissions_info x-version-added: '1.0' + x-distributions-excluded: + - amazon-managed + - amazon-serverless description: Gets the evaluated REST API permissions for the currently logged in user. responses: '200': @@ -10732,6 +11758,9 @@ paths: operationId: security.get_role.0_superseded x-operation-group: security.get_role x-version-added: '1.0' + x-distributions-excluded: + - amazon-managed + - amazon-serverless description: Retrieves one role. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#get-role @@ -10751,6 +11780,9 @@ paths: operationId: security.create_role.0_superseded x-operation-group: security.create_role x-version-added: '1.0' + x-distributions-excluded: + - amazon-managed + - amazon-serverless description: Creates or replaces the specified role. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#create-role @@ -10766,12 +11798,17 @@ paths: responses: '200': $ref: '#/components/responses/security.create_role@200' + '201': + $ref: '#/components/responses/security.create_role@201' deprecated: true x-ignorable: true patch: operationId: security.patch_role.0_superseded x-operation-group: security.patch_role x-version-added: '1.0' + x-distributions-excluded: + - amazon-managed + - amazon-serverless description: Updates individual attributes of a role. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#patch-role @@ -10795,6 +11832,9 @@ paths: operationId: security.delete_role.0_superseded x-operation-group: security.delete_role x-version-added: '1.0' + x-distributions-excluded: + - amazon-managed + - amazon-serverless description: Delete the specified role. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#delete-role @@ -10815,6 +11855,9 @@ paths: operationId: security.get_role_mapping.0_superseded x-operation-group: security.get_role_mapping x-version-added: '1.0' + x-distributions-excluded: + - amazon-managed + - amazon-serverless description: Retrieves one role mapping. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#get-role-mapping @@ -10834,6 +11877,9 @@ paths: operationId: security.create_role_mapping.0_superseded x-operation-group: security.create_role_mapping x-version-added: '1.0' + x-distributions-excluded: + - amazon-managed + - amazon-serverless description: Creates or replaces the specified role mapping. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#create-role-mapping @@ -10849,12 +11895,17 @@ paths: responses: '200': $ref: '#/components/responses/security.create_role_mapping@200' + '201': + $ref: '#/components/responses/security.create_role_mapping@201' deprecated: true x-ignorable: true patch: operationId: security.patch_role_mapping.0_superseded x-operation-group: security.patch_role_mapping x-version-added: '1.0' + x-distributions-excluded: + - amazon-managed + - amazon-serverless description: Updates individual attributes of a role mapping. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#patch-role-mapping @@ -10878,6 +11929,9 @@ paths: operationId: security.delete_role_mapping.0_superseded x-operation-group: security.delete_role_mapping x-version-added: '1.0' + x-distributions-excluded: + - amazon-managed + - amazon-serverless description: Deletes the specified role mapping. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#delete-role-mapping @@ -10897,7 +11951,10 @@ paths: get: operationId: security.get_configuration.0_superseded x-operation-group: security.get_configuration - x-version-added: '1.0' + x-version-added: '2.10' + x-distributions-excluded: + - amazon-managed + - amazon-serverless description: Returns the current Security plugin configuration in JSON format. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#get-configuration @@ -10915,7 +11972,10 @@ paths: patch: operationId: security.patch_configuration.0_superseded x-operation-group: security.patch_configuration - x-version-added: '1.0' + x-version-added: '2.10' + x-distributions-excluded: + - amazon-managed + - amazon-serverless description: A PATCH call is used to update the existing configuration using the REST API. Only accessible by admins and users with rest api access and only when put or patch is enabled. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#patch-configuration @@ -10924,6 +11984,8 @@ paths: responses: '200': $ref: '#/components/responses/security.patch_configuration@200' + '403': + $ref: '#/components/responses/security.patch_configuration@403' parameters: - $ref: '#/components/parameters/_global::query.pretty' - $ref: '#/components/parameters/_global::query.human' @@ -10936,7 +11998,10 @@ paths: put: operationId: security.update_configuration.0_superseded x-operation-group: security.update_configuration - x-version-added: '1.0' + x-version-added: '2.10' + x-distributions-excluded: + - amazon-managed + - amazon-serverless description: Adds or updates the existing configuration using the REST API. Only accessible by admins and users with rest api access and only when put or patch is enabled. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#update-configuration @@ -10945,6 +12010,8 @@ paths: responses: '200': $ref: '#/components/responses/security.update_configuration@200' + '403': + $ref: '#/components/responses/security.update_configuration@403' parameters: - $ref: '#/components/parameters/_global::query.pretty' - $ref: '#/components/parameters/_global::query.human' @@ -10957,7 +12024,10 @@ paths: get: operationId: security.get_certificates.0_superseded x-operation-group: security.get_certificates - x-version-added: '1.0' + x-version-added: '2.0' + x-distributions-excluded: + - amazon-managed + - amazon-serverless description: Retrieves the cluster security certificates. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#get-certificates @@ -10966,6 +12036,8 @@ paths: $ref: '#/components/responses/security.get_certificates@200' '400': $ref: '#/components/responses/security.get_certificates@400' + '403': + $ref: '#/components/responses/security.get_certificates@403' parameters: - $ref: '#/components/parameters/_global::query.pretty' - $ref: '#/components/parameters/_global::query.human' @@ -10978,7 +12050,10 @@ paths: put: operationId: security.reload_transport_certificates.0_superseded x-operation-group: security.reload_transport_certificates - x-version-added: '1.0' + x-version-added: '2.8' + x-distributions-excluded: + - amazon-managed + - amazon-serverless description: Reload Transport layer communication certificates. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#reload-transport-certificates @@ -10987,6 +12062,8 @@ paths: $ref: '#/components/responses/security.reload_transport_certificates@200' '400': $ref: '#/components/responses/security.reload_transport_certificates@400' + '403': + $ref: '#/components/responses/security.reload_transport_certificates@403' parameters: - $ref: '#/components/parameters/_global::query.pretty' - $ref: '#/components/parameters/_global::query.human' @@ -10999,7 +12076,10 @@ paths: put: operationId: security.reload_http_certificates.0_superseded x-operation-group: security.reload_http_certificates - x-version-added: '1.0' + x-version-added: '2.8' + x-distributions-excluded: + - amazon-managed + - amazon-serverless description: Reload HTTP layer communication certificates. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#reload-http-certificates @@ -11008,6 +12088,8 @@ paths: $ref: '#/components/responses/security.reload_http_certificates@200' '400': $ref: '#/components/responses/security.reload_http_certificates@400' + '403': + $ref: '#/components/responses/security.reload_http_certificates@403' parameters: - $ref: '#/components/parameters/_global::query.pretty' - $ref: '#/components/parameters/_global::query.human' @@ -11021,6 +12103,9 @@ paths: operationId: security.get_distinguished_name.0_superseded x-operation-group: security.get_distinguished_name x-version-added: '1.0' + x-distributions-excluded: + - amazon-managed + - amazon-serverless description: Retrieves distinguished names. Only accessible to super-admins and with rest-api permissions when enabled. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#get-distinguished-names @@ -11035,6 +12120,8 @@ paths: responses: '200': $ref: '#/components/responses/security.get_distinguished_name@200' + '400': + $ref: '#/components/responses/security.get_distinguished_name@400' '403': $ref: '#/components/responses/security.get_distinguished_name@403' deprecated: true @@ -11043,6 +12130,9 @@ paths: operationId: security.update_distinguished_name.0_superseded x-operation-group: security.update_distinguished_name x-version-added: '1.0' + x-distributions-excluded: + - amazon-managed + - amazon-serverless description: Adds or updates the specified distinguished names in the cluster or node allow list. Only accessible to super-admins and with rest-api permissions when enabled. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#update-distinguished-names @@ -11058,6 +12148,8 @@ paths: responses: '200': $ref: '#/components/responses/security.update_distinguished_name@200' + '400': + $ref: '#/components/responses/security.update_distinguished_name@400' '403': $ref: '#/components/responses/security.update_distinguished_name@403' deprecated: true @@ -11066,6 +12158,9 @@ paths: operationId: security.patch_distinguished_name.0_superseded x-operation-group: security.patch_distinguished_name x-version-added: '1.0' + x-distributions-excluded: + - amazon-managed + - amazon-serverless description: Updates a distinguished cluster name for a specific cluster. Only accessible to super-admins and with rest-api permissions when enabled. parameters: - $ref: '#/components/parameters/security.patch_distinguished_name::path.cluster_name' @@ -11079,6 +12174,8 @@ paths: responses: '200': $ref: '#/components/responses/security.patch_distinguished_name@200' + '400': + $ref: '#/components/responses/security.patch_distinguished_name@400' '403': $ref: '#/components/responses/security.patch_distinguished_name@403' deprecated: true @@ -11087,6 +12184,9 @@ paths: operationId: security.delete_distinguished_name.0_superseded x-operation-group: security.delete_distinguished_name x-version-added: '1.0' + x-distributions-excluded: + - amazon-managed + - amazon-serverless description: Deletes all distinguished names in the specified cluster or node allow list. Only accessible to super-admins and with rest-api permissions when enabled. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#delete-distinguished-names @@ -11100,6 +12200,8 @@ paths: responses: '200': $ref: '#/components/responses/security.delete_distinguished_name@200' + '400': + $ref: '#/components/responses/security.delete_distinguished_name@400' '403': $ref: '#/components/responses/security.delete_distinguished_name@403' deprecated: true @@ -11109,6 +12211,9 @@ paths: operationId: security.get_tenancy_config.0_superseded x-operation-group: security.get_tenancy_config x-version-added: '2.7' + x-distributions-excluded: + - amazon-managed + - amazon-serverless description: Retrieves multi-tenancy configuration. Only accessible to admins and users with REST API permissions. externalDocs: url: https://opensearch.org/docs/latest/security/multi-tenancy/dynamic-config/#configuring-multi-tenancy-with-the-rest-api @@ -11129,6 +12234,9 @@ paths: operationId: security.create_update_tenancy_config.0_superseded x-operation-group: security.create_update_tenancy_config x-version-added: '2.7' + x-distributions-excluded: + - amazon-managed + - amazon-serverless description: Creates or replaces the multi-tenancy configuration. Only accessible to admins and users with REST API permissions. externalDocs: url: https://opensearch.org/docs/latest/security/multi-tenancy/dynamic-config/#configuring-multi-tenancy-with-the-rest-api @@ -11152,6 +12260,9 @@ paths: operationId: security.get_tenants.0_superseded x-operation-group: security.get_tenants x-version-added: '1.0' + x-distributions-excluded: + - amazon-managed + - amazon-serverless description: Retrieves all tenants. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#get-tenants @@ -11172,6 +12283,9 @@ paths: operationId: security.patch_tenants.0_superseded x-operation-group: security.patch_tenants x-version-added: '1.0' + x-distributions-excluded: + - amazon-managed + - amazon-serverless description: Add, delete, or modify multiple tenants in a single call. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#patch-tenants @@ -11195,6 +12309,9 @@ paths: operationId: security.get_tenant.0_superseded x-operation-group: security.get_tenant x-version-added: '1.0' + x-distributions-excluded: + - amazon-managed + - amazon-serverless description: Retrieves one tenant. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#get-tenant @@ -11214,6 +12331,9 @@ paths: operationId: security.create_tenant.0_superseded x-operation-group: security.create_tenant x-version-added: '1.0' + x-distributions-excluded: + - amazon-managed + - amazon-serverless description: Creates or replaces the specified tenant. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#create-tenant @@ -11229,6 +12349,8 @@ paths: responses: '200': $ref: '#/components/responses/security.create_tenant@200' + '201': + $ref: '#/components/responses/security.create_tenant@201' '400': $ref: '#/components/responses/security.create_tenant@400' deprecated: true @@ -11237,6 +12359,9 @@ paths: operationId: security.patch_tenant.0_superseded x-operation-group: security.patch_tenant x-version-added: '1.0' + x-distributions-excluded: + - amazon-managed + - amazon-serverless description: Add, delete, or modify a single tenant. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#patch-tenant @@ -11260,6 +12385,9 @@ paths: operationId: security.delete_tenant.0_superseded x-operation-group: security.delete_tenant x-version-added: '1.0' + x-distributions-excluded: + - amazon-managed + - amazon-serverless description: Delete the specified tenant. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#delete-action-group @@ -11282,6 +12410,9 @@ paths: operationId: security.get_users_legacy.0_superseded x-operation-group: security.get_users_legacy x-version-added: '1.0' + x-distributions-excluded: + - amazon-managed + - amazon-serverless description: Retrieve all internal users. Legacy API. responses: '200': @@ -11299,6 +12430,9 @@ paths: operationId: security.get_user_legacy.0_superseded x-operation-group: security.get_user_legacy x-version-added: '1.0' + x-distributions-excluded: + - amazon-managed + - amazon-serverless description: Retrieve one user. Legacy API. parameters: - $ref: '#/components/parameters/security.get_user_legacy::path.username' @@ -11316,6 +12450,9 @@ paths: operationId: security.create_user_legacy.0_superseded x-operation-group: security.create_user_legacy x-version-added: '1.0' + x-distributions-excluded: + - amazon-managed + - amazon-serverless description: Creates or replaces the specified user. Legacy API. parameters: - $ref: '#/components/parameters/security.create_user_legacy::path.username' @@ -11329,12 +12466,17 @@ paths: responses: '200': $ref: '#/components/responses/security.create_user_legacy@200' + '201': + $ref: '#/components/responses/security.create_user_legacy@201' deprecated: true x-ignorable: true delete: operationId: security.delete_user_legacy.0_superseded x-operation-group: security.delete_user_legacy x-version-added: '1.0' + x-distributions-excluded: + - amazon-managed + - amazon-serverless description: Delete the specified user. Legacy API. parameters: - $ref: '#/components/parameters/security.delete_user_legacy::path.username' @@ -11352,8 +12494,11 @@ paths: post: operationId: security.generate_user_token_legacy.0_superseded x-operation-group: security.generate_user_token_legacy - x-version-added: '1.0' - description: Generates authorization token for the given user. Legacy API. + x-version-added: '2.7' + x-distributions-excluded: + - amazon-managed + - amazon-serverless + description: Generates authorization token for the given user. Legacy API. Not Implemented. parameters: - $ref: '#/components/parameters/security.generate_user_token_legacy::path.username' - $ref: '#/components/parameters/_global::query.pretty' @@ -11362,10 +12507,8 @@ paths: - $ref: '#/components/parameters/_global::query.source' - $ref: '#/components/parameters/_global::query.filter_path' responses: - '200': - $ref: '#/components/responses/security.generate_user_token_legacy@200' - '400': - $ref: '#/components/responses/security.generate_user_token_legacy@400' + '501': + $ref: '#/components/responses/security.generate_user_token_legacy@501' deprecated: true x-ignorable: true /_opendistro/_security/api/validate: @@ -11373,6 +12516,9 @@ paths: operationId: security.validate.0_superseded x-operation-group: security.validate x-version-added: '1.0' + x-distributions-excluded: + - amazon-managed + - amazon-serverless description: Checks whether the v6 security configuration is valid and ready to be migrated to v7. parameters: - $ref: '#/components/parameters/security.validate::query.accept_invalid' @@ -11392,13 +12538,18 @@ paths: get: operationId: security.get_allowlist.0_superseded x-operation-group: security.get_allowlist - x-version-added: '1.0' + x-version-added: '2.1' + x-distributions-excluded: + - amazon-managed + - amazon-serverless description: Retrieves the current list of allowed API accessible to normal user. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#access-control-for-the-api responses: '200': $ref: '#/components/responses/security.get_allowlist@200' + '403': + $ref: '#/components/responses/security.get_allowlist@403' parameters: - $ref: '#/components/parameters/_global::query.pretty' - $ref: '#/components/parameters/_global::query.human' @@ -11410,7 +12561,10 @@ paths: put: operationId: security.create_allowlist.0_superseded x-operation-group: security.create_allowlist - x-version-added: '1.0' + x-version-added: '2.1' + x-distributions-excluded: + - amazon-managed + - amazon-serverless description: Creates or replaces the allowlisted APIs. Accessible via Super Admin certificate or REST API permission. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#access-control-for-the-api @@ -11419,6 +12573,8 @@ paths: responses: '200': $ref: '#/components/responses/security.create_allowlist@200' + '403': + $ref: '#/components/responses/security.create_allowlist@403' parameters: - $ref: '#/components/parameters/_global::query.pretty' - $ref: '#/components/parameters/_global::query.human' @@ -11430,7 +12586,10 @@ paths: patch: operationId: security.patch_allowlist.0_superseded x-operation-group: security.patch_allowlist - x-version-added: '1.0' + x-version-added: '2.1' + x-distributions-excluded: + - amazon-managed + - amazon-serverless description: Updates the current list of allowed API accessible to normal user. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#access-control-for-the-api @@ -11439,6 +12598,8 @@ paths: responses: '200': $ref: '#/components/responses/security.patch_allowlist@200' + '403': + $ref: '#/components/responses/security.patch_allowlist@403' parameters: - $ref: '#/components/parameters/_global::query.pretty' - $ref: '#/components/parameters/_global::query.human' @@ -11452,6 +12613,9 @@ paths: operationId: security.authinfo.0_superseded x-operation-group: security.authinfo x-version-added: '1.0' + x-distributions-excluded: + - amazon-managed + - amazon-serverless description: Returns the authentication information. parameters: - $ref: '#/components/parameters/security.authinfo::query.auth_type' @@ -11472,6 +12636,9 @@ paths: operationId: security.authinfo.1_superseded x-operation-group: security.authinfo x-version-added: '1.0' + x-distributions-excluded: + - amazon-managed + - amazon-serverless description: Returns the authentication information. parameters: - $ref: '#/components/parameters/security.authinfo::query.auth_type' @@ -11493,6 +12660,9 @@ paths: operationId: security.health.0_superseded x-operation-group: security.health x-version-added: '1.0' + x-distributions-excluded: + - amazon-managed + - amazon-serverless description: Checks to see if the Security plugin is up and running. parameters: - $ref: '#/components/parameters/security.health::query.mode' @@ -11512,6 +12682,9 @@ paths: operationId: security.health.1_superseded x-operation-group: security.health x-version-added: '1.0' + x-distributions-excluded: + - amazon-managed + - amazon-serverless description: Checks to see if the Security plugin is up and running. parameters: - $ref: '#/components/parameters/security.health::query.mode' @@ -11532,6 +12705,9 @@ paths: operationId: security.get_dashboards_info.0_superseded x-operation-group: security.get_dashboards_info x-version-added: '1.0' + x-distributions-excluded: + - amazon-managed + - amazon-serverless description: Retrieves the current security-dashboards plugin configuration. responses: '200': @@ -11550,9 +12726,10 @@ paths: operationId: security.post_dashboards_info.1_superseded x-operation-group: security.post_dashboards_info x-version-added: '1.0' + x-distributions-excluded: + - amazon-managed + - amazon-serverless description: Updates the current security-dashboards plugin configuration. - requestBody: - $ref: '#/components/requestBodies/security.post_dashboards_info' responses: '200': $ref: '#/components/responses/security.post_dashboards_info@200' @@ -11571,10 +12748,15 @@ paths: operationId: security.tenant_info.0_superseded x-operation-group: security.tenant_info x-version-added: '1.0' + x-distributions-excluded: + - amazon-managed + - amazon-serverless description: Retrieves the tenant names if any exist. Only accessible to super admins or kibanaserver user. responses: '200': $ref: '#/components/responses/security.tenant_info@200' + '403': + $ref: '#/components/responses/security.tenant_info@403' '500': $ref: '#/components/responses/security.tenant_info@500' parameters: @@ -11589,10 +12771,15 @@ paths: operationId: security.tenant_info.1_superseded x-operation-group: security.tenant_info x-version-added: '1.0' + x-distributions-excluded: + - amazon-managed + - amazon-serverless description: Retrieves the tenant names if any exist. Only accessible to super admins or kibanaserver user. responses: '200': $ref: '#/components/responses/security.tenant_info@200' + '403': + $ref: '#/components/responses/security.tenant_info@403' '500': $ref: '#/components/responses/security.tenant_info@500' parameters: @@ -11603,6 +12790,246 @@ paths: - $ref: '#/components/parameters/_global::query.filter_path' deprecated: true x-ignorable: true + /_opendistro/_sql: + post: + operationId: sql.query.0_superseded + x-operation-group: sql.query + x-version-added: '1.0' + description: Send a SQL/PPL query to the SQL plugin. + externalDocs: + url: https://opensearch.org/docs/latest/search-plugins/sql/sql-ppl-api/ + parameters: + - $ref: '#/components/parameters/sql.query::query.format' + - $ref: '#/components/parameters/sql.query::query.sanitize' + - $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/sql.query' + responses: + '200': + $ref: '#/components/responses/sql.query@200' + deprecated: true + x-ignorable: true + /_opendistro/_sql/_explain: + post: + operationId: sql.explain.0_superseded + x-operation-group: sql.explain + x-version-added: '1.0' + description: Shows how a query is executed against OpenSearch. + externalDocs: + url: https://opensearch.org/docs/latest/search-plugins/sql/sql-ppl-api/ + parameters: + - $ref: '#/components/parameters/sql.explain::query.format' + - $ref: '#/components/parameters/sql.explain::query.sanitize' + - $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/sql.explain' + responses: + '200': + $ref: '#/components/responses/sql.explain@200' + deprecated: true + x-ignorable: true + /_opendistro/_sql/close: + post: + operationId: sql.close.0_superseded + x-operation-group: sql.close + x-version-added: '1.0' + description: Clear the cursor context. + externalDocs: + url: https://opensearch.org/docs/latest/search-plugins/sql/sql-ppl-api/ + parameters: + - $ref: '#/components/parameters/sql.close::query.format' + - $ref: '#/components/parameters/sql.close::query.sanitize' + - $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/sql.close' + responses: + '200': + $ref: '#/components/responses/sql.close@200' + deprecated: true + x-ignorable: true + /_opendistro/_sql/settings: + put: + operationId: sql.settings.0_superseded + x-operation-group: sql.settings + x-version-added: '1.0' + description: Adds SQL settings to the standard OpenSearch cluster settings. + externalDocs: + url: https://opensearch.org/docs/latest/search-plugins/sql/settings/ + parameters: + - $ref: '#/components/parameters/sql.settings::query.format' + - $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/sql.settings' + responses: + '200': + $ref: '#/components/responses/sql.settings@200' + deprecated: true + x-ignorable: true + /_opendistro/_sql/stats: + get: + operationId: sql.get_stats.0_superseded + x-operation-group: sql.get_stats + x-version-added: '1.0' + description: Collect metrics for the plugin within the interval. + externalDocs: + url: https://opensearch.org/docs/latest/search-plugins/sql/monitoring/ + parameters: + - $ref: '#/components/parameters/sql.get_stats::query.format' + - $ref: '#/components/parameters/sql.get_stats::query.sanitize' + - $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/sql.get_stats@200' + deprecated: true + x-ignorable: true + post: + operationId: sql.post_stats.1_superseded + x-operation-group: sql.post_stats + x-version-added: '1.0' + description: By a stats endpoint, you are able to collect metrics for the plugin within the interval. + externalDocs: + url: https://opensearch.org/docs/latest/search-plugins/sql/monitoring/ + parameters: + - $ref: '#/components/parameters/sql.post_stats::query.format' + - $ref: '#/components/parameters/sql.post_stats::query.sanitize' + - $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/sql.post_stats' + responses: + '200': + $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: @@ -11647,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 @@ -11915,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: @@ -11984,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: @@ -12276,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: @@ -12360,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: @@ -12429,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: @@ -12518,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: @@ -12593,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: @@ -12719,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: @@ -12883,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: @@ -13108,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: @@ -13195,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: @@ -13282,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: @@ -13453,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: @@ -13532,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: @@ -13616,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 @@ -13679,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 @@ -13718,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 @@ -13761,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 @@ -13832,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 @@ -13912,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 @@ -13981,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 @@ -14028,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 @@ -14074,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 @@ -14167,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 @@ -14495,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 @@ -14535,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 @@ -14877,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 @@ -15328,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 @@ -15662,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 @@ -15810,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 @@ -15897,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 @@ -15956,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 @@ -16024,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 @@ -16066,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 @@ -16102,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 @@ -16171,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 @@ -16274,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 @@ -16315,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 @@ -16679,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 @@ -16754,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 @@ -16848,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 @@ -16894,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 @@ -17004,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 @@ -17063,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 @@ -17137,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 @@ -17185,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: @@ -17240,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 @@ -17326,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 @@ -17378,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 @@ -17522,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 @@ -17674,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 @@ -17755,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 @@ -17798,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 @@ -17841,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 @@ -17982,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 @@ -18172,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 @@ -18211,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 @@ -18236,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 @@ -18777,6 +20238,18 @@ components: required: true schema: type: string + ml.delete_task::path.task_id: + name: task_id + in: path + required: true + schema: + type: string + ml.deploy_model::path.model_id: + name: model_id + in: path + required: true + schema: + type: string ml.get_model_group::path.model_group_id: name: model_group_id in: path @@ -18789,6 +20262,12 @@ components: required: true schema: type: string + ml.undeploy_model::path.model_id: + name: model_id + in: path + required: true + schema: + type: string msearch_template::path.index: in: path name: index @@ -19475,6 +20954,98 @@ components: schema: type: string required: true + observability.delete_object::path.object_id: + in: path + name: object_id + description: The ID of the Observability Object. + required: true + schema: + type: string + style: simple + observability.delete_objects::query.objectId: + in: query + name: objectId + description: The ID of a single Observability Object to delete. + required: false + schema: + type: string + style: form + observability.delete_objects::query.objectIdList: + in: query + name: objectIdList + description: A comma-separated list of Observability Object IDs to delete. + required: false + schema: + type: string + style: form + observability.get_object::path.object_id: + in: path + name: object_id + description: The ID of the Observability Object. + required: true + schema: + type: string + style: simple + observability.update_object::path.object_id: + in: path + name: object_id + description: The ID of the Observability Object. + required: true + schema: + type: string + style: simple + ppl.explain::query.format: + name: format + in: query + description: A short version of the Accept header, e.g. json, yaml. + schema: + type: string + ppl.explain::query.sanitize: + name: sanitize + in: query + description: Specifies whether to escape special characters in the results. + schema: + type: boolean + default: true + ppl.get_stats::query.format: + name: format + in: query + description: A short version of the Accept header, e.g. json, yaml. + schema: + type: string + ppl.get_stats::query.sanitize: + name: sanitize + in: query + description: Specifies whether to escape special characters in the results. + schema: + type: boolean + default: true + ppl.post_stats::query.format: + name: format + in: query + description: A short version of the Accept header, e.g. json, yaml. + schema: + type: string + ppl.post_stats::query.sanitize: + name: sanitize + in: query + description: Specifies whether to escape special characters in the results. + schema: + type: boolean + default: true + ppl.query::query.format: + name: format + in: query + description: A short version of the Accept header, e.g. json, yaml. + schema: + type: string + ppl.query::query.sanitize: + name: sanitize + in: query + description: Specifies whether to escape special characters in the results. + schema: + type: boolean + default: true put_script::path.context: in: path name: context @@ -19512,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 @@ -19523,6 +21094,20 @@ components: schema: $ref: '#/components/schemas/_common:Duration' style: form + query.datasource_delete::path.datasource_name: + name: datasource_name + in: path + description: The Name of the DataSource to delete. + schema: + type: string + required: true + query.datasource_retrieve::path.datasource_name: + name: datasource_name + in: path + description: The Name of the DataSource to retrieve. + schema: + type: string + required: true rank_eval::path.index: in: path name: index @@ -20448,120 +22033,168 @@ components: description: The name of the action group to create or replace. schema: type: string - description: The name of the action group to create or replace. required: true security.create_role_mapping::path.role: name: role in: path + description: The name of the role to create a role mapping for. schema: type: string required: true security.create_role::path.role: name: role in: path + description: The name of the role to be created. schema: type: string required: true security.create_tenant::path.tenant: name: tenant in: path + description: The name of the tenant to be created. schema: type: string required: true security.create_user_legacy::path.username: name: username in: path + description: The name of the user to be created. schema: type: string required: true security.create_user::path.username: name: username in: path + description: The name of the user to be created. schema: type: string required: true security.delete_action_group::path.action_group: name: action_group in: path - description: Action group to delete. + description: The name of the action group to delete. schema: type: string - description: Action group to delete. required: true security.delete_distinguished_name::path.cluster_name: name: cluster_name in: path + description: The cluster-name to delete from list of distinguished names. schema: type: string required: true security.delete_role_mapping::path.role: name: role in: path + description: The name of the role whose mapping needs to delete. schema: type: string required: true security.delete_role::path.role: name: role in: path + description: The name of the role to delete. schema: type: string required: true security.delete_tenant::path.tenant: name: tenant in: path + description: The name of the tenant to delete. schema: type: string required: true security.delete_user_legacy::path.username: name: username in: path + description: The name of the user to delete. schema: type: string required: true security.delete_user::path.username: name: username in: path + description: The name of the user to delete. schema: type: string required: true security.generate_user_token_legacy::path.username: name: username in: path + description: The name of the user for whom an auth token is to be vended. schema: type: string required: true security.generate_user_token::path.username: name: username in: path + description: The name of the user for whom an auth token is to be vended. schema: type: string required: true security.get_action_group::path.action_group: name: action_group in: path - description: Action group to retrieve. + description: The name of the action group to retrieve. schema: type: string - description: Action group to retrieve. required: true + security.get_all_certificates::query.cert_type: + name: cert_type + in: query + description: The type of certificates (HTTP, TRANSPORT, ALL) to retrieve from all nodes. + schema: + type: string + required: false + security.get_all_certificates::query.timeout: + name: timeout + in: query + description: The maximum duration, in seconds, to be spent to retrieve certificates from all nodes. + schema: + $ref: '#/components/schemas/_common:Duration' + required: false security.get_distinguished_name::path.cluster_name: name: cluster_name in: path + description: The cluster-name to retrieve nodes DN setting for. schema: type: string required: true security.get_distinguished_name::query.show_all: name: show_all in: query + description: A boolean flag to include/exclude static nodes DN from final result. schema: type: boolean required: false security.get_distinguished_names::query.show_all: name: show_all in: query + description: A boolean flag to include/exclude static nodes DN from final result. schema: type: boolean required: false + security.get_node_certificates::path.node_id: + name: node_id + in: path + description: The full-id of the node to retrieve certificates. + schema: + type: string + required: true + security.get_node_certificates::query.cert_type: + name: cert_type + in: query + description: The type of certificates (HTTP, TRANSPORT, ALL) to retrieve for a node. + schema: + type: string + required: false + security.get_node_certificates::query.timeout: + name: timeout + in: query + description: The maximum duration, in seconds, to be spent to retrieve a node's certificates. + schema: + $ref: '#/components/schemas/_common:Duration' + required: false security.get_role_mapping::path.role: name: role in: path @@ -20577,80 +22210,93 @@ components: security.get_sslinfo::query.show_dn: name: show_dn in: query - description: The domain names from all certificates. + description: A boolean flag to indicate whether all domain names should be returned. schema: - type: string - description: A boolean flag to indicate whether all domain names should be returned. + type: + - boolean + - string required: false security.get_tenant::path.tenant: name: tenant in: path + description: The name of the tenant to retrieve. schema: type: string required: true security.get_user_legacy::path.username: name: username in: path + description: The name of the user to retrieve. schema: type: string required: true security.get_user::path.username: name: username in: path + description: The name of the user to retrieve. schema: type: string required: true security.health::query.mode: name: mode in: query + description: A flag to indicate whether service should consider security-plugin's status before returning health response. `strict` mode indicates service should check security plugin status. schema: type: string required: false security.patch_action_group::path.action_group: name: action_group in: path + description: The name of the action group to update. schema: type: string required: true security.patch_distinguished_name::path.cluster_name: name: cluster_name in: path + description: The cluster-name to update nodesDn value. schema: type: string required: true security.patch_role_mapping::path.role: name: role in: path + description: The name of the role to update role-mapping for. schema: type: string required: true security.patch_role::path.role: name: role in: path + description: The name of the role to update. schema: type: string required: true security.patch_tenant::path.tenant: name: tenant in: path + description: The name of the tenant to update. schema: type: string required: true security.patch_user::path.username: name: username in: path + description: The name of the user to update. schema: type: string required: true security.update_distinguished_name::path.cluster_name: name: cluster_name in: path + description: The cluster-name to create/update nodesDn value for. schema: type: string required: true security.validate::query.accept_invalid: name: accept_invalid in: query + description: A boolean flag to indicate whether invalid v6 configuration should be allowed. schema: type: boolean required: false @@ -20677,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 @@ -20725,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 @@ -20750,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 @@ -20797,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 @@ -20830,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 @@ -20870,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 @@ -20903,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 @@ -20947,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 @@ -20987,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 @@ -21036,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 @@ -21061,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 @@ -21070,6 +22716,77 @@ components: schema: $ref: '#/components/schemas/_common:Duration' style: form + sql.close::query.format: + name: format + in: query + description: A short version of the Accept header, e.g. json, yaml. + schema: + type: string + sql.close::query.sanitize: + name: sanitize + in: query + description: Specifies whether to escape special characters in the results + schema: + type: boolean + default: true + sql.explain::query.format: + name: format + in: query + description: A short version of the Accept header, e.g. json, yaml. + schema: + type: string + sql.explain::query.sanitize: + name: sanitize + in: query + description: Specifies whether to escape special characters in the results + schema: + type: boolean + default: true + sql.get_stats::query.format: + name: format + in: query + description: A short version of the Accept header, e.g. json, yaml. + schema: + type: string + sql.get_stats::query.sanitize: + name: sanitize + in: query + description: Specifies whether to escape special characters in the results + schema: + type: boolean + default: true + sql.post_stats::query.format: + name: format + in: query + description: A short version of the Accept header, e.g. json, yaml. + schema: + type: string + sql.post_stats::query.sanitize: + name: sanitize + in: query + description: Specifies whether to escape special characters in the results + schema: + type: boolean + default: true + sql.query::query.format: + name: format + in: query + description: A short version of the Accept header, e.g. json, yaml. + schema: + type: string + sql.query::query.sanitize: + name: sanitize + in: query + description: Specifies whether to escape special characters in the results + schema: + type: boolean + default: true + sql.settings::query.format: + name: format + in: query + description: A short version of the Accept header, e.g. json, yaml. + schema: + type: string tasks.cancel::path.task_id: in: path name: task_id @@ -21834,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: @@ -22522,17 +24244,7 @@ components: content: application/json: schema: - type: object - properties: - query: - type: object - description: The query. - size: - type: integer - description: The number of models to return. - required: - - query - - size + $ref: '#/components/schemas/ml._common:SearchModelsQuery' msearch: content: application/x-ndjson: @@ -22609,6 +24321,34 @@ components: schema: $ref: '#/components/schemas/notifications._common:NotificationsConfig' required: true + observability.create_object: + content: + application/json: + schema: + $ref: '#/components/schemas/observability._common:ObservabilityObject' + observability.update_object: + content: + application/json: + schema: + $ref: '#/components/schemas/observability._common:ObservabilityObject' + ppl.explain: + content: + application/json: + schema: + $ref: '#/components/schemas/sql._common:Explain' + required: true + ppl.post_stats: + content: + application/json: + schema: + $ref: '#/components/schemas/sql._common:Stats' + required: true + ppl.query: + content: + application/json: + schema: + $ref: '#/components/schemas/sql._common:Query' + required: true put_script: content: application/json: @@ -22621,6 +24361,16 @@ components: - script description: The document required: true + query.datasources_create: + content: + application/json: + schema: + $ref: '#/components/schemas/query._common:DataSource' + query.datasources_update: + content: + application/json: + schema: + $ref: '#/components/schemas/query._common:DataSource' rank_eval: content: application/json: @@ -22678,7 +24428,6 @@ components: examples: RemoteStoreRestore_example1: summary: Examples for Post Remote Storage Restore Operation. - description: '' value: indices: - books @@ -22788,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: @@ -22965,9 +24714,7 @@ components: content: application/json: schema: - type: array - items: - $ref: '#/components/schemas/security._common:MultiTenancyConfig' + $ref: '#/components/schemas/security._common:MultiTenancyConfig' required: true security.create_user: content: @@ -23104,12 +24851,6 @@ components: items: $ref: '#/components/schemas/security._common:PatchOperation' required: true - security.post_dashboards_info: - content: - application/json: - schema: - $ref: '#/components/schemas/security._common:DashboardsInfo' - required: false security.update_audit_configuration: content: application/json: @@ -23126,7 +24867,7 @@ components: content: application/json: schema: - $ref: '#/components/schemas/security._common:PatchOperation' + $ref: '#/components/schemas/security._common:DistinguishedNames' snapshot.clone: content: application/json: @@ -23212,6 +24953,38 @@ components: rename_replacement: type: string description: Details of what to restore + sql.close: + content: + application/json: + schema: + $ref: '#/components/schemas/sql._common:SqlClose' + required: true + sql.explain: + content: + application/json: + schema: + $ref: '#/components/schemas/sql._common:Explain' + required: true + sql.post_stats: + content: + application/json: + schema: + $ref: '#/components/schemas/sql._common:Stats' + required: true + sql.query: + content: + application/json: + schema: + $ref: '#/components/schemas/sql._common:Query' + required: true + sql.settings: + content: + application/json: + schema: + anyOf: + - $ref: '#/components/schemas/sql._common:SqlSettingsPlain' + - $ref: '#/components/schemas/sql._common:SqlSettings' + required: true termvectors: content: application/json: @@ -23284,8 +25057,30 @@ 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: - description: '' content: application/json: schema: @@ -23310,7 +25105,6 @@ components: - items - took cat.aliases@200: - description: '' content: text/plain: type: string @@ -23320,7 +25114,6 @@ components: items: $ref: '#/components/schemas/cat.aliases:AliasesRecord' cat.all_pit_segments@200: - description: '' content: text/plain: type: string @@ -23330,7 +25123,6 @@ components: items: $ref: '#/components/schemas/cat._common:CatPitSegmentsRecord' cat.allocation@200: - description: '' content: text/plain: type: string @@ -23340,7 +25132,6 @@ components: items: $ref: '#/components/schemas/cat.allocation:AllocationRecord' cat.cluster_manager@200: - description: '' content: text/plain: type: string @@ -23350,7 +25141,6 @@ components: items: $ref: '#/components/schemas/cat.cluster_manager:ClusterManagerRecord' cat.count@200: - description: '' content: text/plain: type: string @@ -23360,7 +25150,6 @@ components: items: $ref: '#/components/schemas/cat.count:CountRecord' cat.fielddata@200: - description: '' content: text/plain: type: string @@ -23370,7 +25159,6 @@ components: items: $ref: '#/components/schemas/cat.fielddata:FielddataRecord' cat.health@200: - description: '' content: text/plain: type: string @@ -23395,13 +25183,11 @@ components: items: $ref: '#/components/schemas/cat.health:HealthRecord' cat.help@200: - description: '' content: text/plain: schema: type: string cat.indices@200: - description: '' content: text/plain: type: string @@ -23426,7 +25212,6 @@ components: items: $ref: '#/components/schemas/cat.indices:IndicesRecord' cat.master@200: - description: '' content: text/plain: type: string @@ -23436,7 +25221,6 @@ components: items: $ref: '#/components/schemas/cat.master:MasterRecord' cat.nodeattrs@200: - description: '' content: text/plain: type: string @@ -23446,7 +25230,6 @@ components: items: $ref: '#/components/schemas/cat.nodeattrs:NodeAttributesRecord' cat.nodes@200: - description: '' content: text/plain: type: string @@ -23456,7 +25239,6 @@ components: items: $ref: '#/components/schemas/cat.nodes:NodesRecord' cat.pending_tasks@200: - description: '' content: text/plain: type: string @@ -23466,7 +25248,6 @@ components: items: $ref: '#/components/schemas/cat.pending_tasks:PendingTasksRecord' cat.pit_segments@200: - description: '' content: text/plain: type: string @@ -23476,7 +25257,6 @@ components: items: $ref: '#/components/schemas/cat._common:CatPitSegmentsRecord' cat.plugins@200: - description: '' content: text/plain: type: string @@ -23486,7 +25266,6 @@ components: items: $ref: '#/components/schemas/cat.plugins:PluginsRecord' cat.recovery@200: - description: '' content: text/plain: type: string @@ -23496,7 +25275,6 @@ components: items: $ref: '#/components/schemas/cat.recovery:RecoveryRecord' cat.repositories@200: - description: '' content: text/plain: type: string @@ -23506,7 +25284,6 @@ components: items: $ref: '#/components/schemas/cat.repositories:RepositoriesRecord' cat.segment_replication@200: - description: '' content: text/plain: type: string @@ -23516,7 +25293,6 @@ components: items: $ref: '#/components/schemas/cat._common:CatSegmentReplicationRecord' cat.segments@200: - description: '' content: text/plain: type: string @@ -23526,7 +25302,6 @@ components: items: $ref: '#/components/schemas/cat.segments:SegmentsRecord' cat.shards@200: - description: '' content: text/plain: type: string @@ -23536,7 +25311,6 @@ components: items: $ref: '#/components/schemas/cat.shards:ShardsRecord' cat.snapshots@200: - description: '' content: text/plain: type: string @@ -23546,7 +25320,6 @@ components: items: $ref: '#/components/schemas/cat.snapshots:SnapshotsRecord' cat.tasks@200: - description: '' content: text/plain: type: string @@ -23556,7 +25329,6 @@ components: items: $ref: '#/components/schemas/cat.tasks:TasksRecord' cat.templates@200: - description: '' content: text/plain: type: string @@ -23566,7 +25338,6 @@ components: items: $ref: '#/components/schemas/cat.templates:TemplatesRecord' cat.thread_pool@200: - description: '' content: text/plain: type: string @@ -23576,7 +25347,6 @@ components: items: $ref: '#/components/schemas/cat.thread_pool:ThreadPoolRecord' clear_scroll@200: - description: '' content: application/json: schema: @@ -23590,7 +25360,6 @@ components: - num_freed - succeeded cluster.allocation_explain@200: - description: '' content: application/json: schema: @@ -23658,25 +25427,19 @@ components: - primary - shard cluster.delete_component_template@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/_common:AcknowledgedResponseBase' - cluster.delete_decommission_awareness@200: - description: '' + cluster.delete_decommission_awareness@200: {} cluster.delete_voting_config_exclusions@200: - description: '' content: application/json: {} - cluster.delete_weighted_routing@200: - description: '' + cluster.delete_weighted_routing@200: {} cluster.exists_component_template@200: - description: '' content: application/json: {} cluster.get_component_template@200: - description: '' content: application/json: schema: @@ -23688,10 +25451,8 @@ components: $ref: '#/components/schemas/cluster._common:ComponentTemplate' required: - component_templates - cluster.get_decommission_awareness@200: - description: '' + cluster.get_decommission_awareness@200: {} cluster.get_settings@200: - description: '' content: application/json: schema: @@ -23699,29 +25460,23 @@ 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 - cluster.get_weighted_routing@200: - description: '' + cluster.get_weighted_routing@200: {} cluster.health@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/cluster.health:HealthResponseBody' cluster.pending_tasks@200: - description: '' content: application/json: schema: @@ -23734,19 +25489,15 @@ components: required: - tasks cluster.post_voting_config_exclusions@200: - description: '' content: application/json: {} cluster.put_component_template@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/_common:AcknowledgedResponseBase' - cluster.put_decommission_awareness@200: - description: '' + cluster.put_decommission_awareness@200: {} cluster.put_settings@200: - description: '' content: application/json: schema: @@ -23764,10 +25515,8 @@ components: - acknowledged - persistent - transient - cluster.put_weighted_routing@200: - description: '' + cluster.put_weighted_routing@200: {} cluster.remote_info@200: - description: '' content: application/json: schema: @@ -23775,7 +25524,6 @@ components: additionalProperties: $ref: '#/components/schemas/cluster.remote_info:ClusterRemoteInfo' cluster.reroute@200: - description: '' content: application/json: schema: @@ -23796,19 +25544,16 @@ components: required: - acknowledged cluster.state@200: - description: '' content: application/json: schema: type: object cluster.stats@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/cluster.stats:StatsResponseBase' count@200: - description: '' content: application/json: schema: @@ -23822,7 +25567,6 @@ components: - _shards - count create_pit@200: - description: '' content: application/json: schema: @@ -23836,25 +25580,21 @@ components: type: integer format: int64 create@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/_common:WriteResponseBase' dangling_indices.delete_dangling_index@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/_common:AcknowledgedResponseBase' dangling_indices.import_dangling_index@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/_common:AcknowledgedResponseBase' dangling_indices.list_dangling_indices@200: - description: '' content: application/json: schema: @@ -23871,7 +25611,6 @@ components: required: - dangling_indices delete_all_pits@200: - description: '' content: application/json: schema: @@ -23882,13 +25621,11 @@ components: items: $ref: '#/components/schemas/_core._common:PitsDetailsDeleteAll' delete_by_query_rethrottle@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/tasks._common:TaskListResponseBase' delete_by_query@200: - description: '' content: application/json: schema: @@ -23929,7 +25666,6 @@ components: version_conflicts: type: number delete_pit@200: - description: '' content: application/json: schema: @@ -23940,27 +25676,22 @@ components: items: $ref: '#/components/schemas/_core._common:DeletedPit' delete_script@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/_common:AcknowledgedResponseBase' delete@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/_common:WriteResponseBase' exists_source@200: - description: '' content: application/json: {} exists@200: - description: '' content: application/json: {} explain@200: - description: '' content: application/json: schema: @@ -23981,7 +25712,6 @@ components: - _index - matched field_caps@200: - description: '' content: application/json: schema: @@ -23999,7 +25729,6 @@ components: - fields - indices get_all_pits@200: - description: '' content: application/json: schema: @@ -24010,7 +25739,6 @@ components: items: $ref: '#/components/schemas/_core._common:PitDetail' get_script_context@200: - description: '' content: application/json: schema: @@ -24023,7 +25751,6 @@ components: required: - contexts get_script_languages@200: - description: '' content: application/json: schema: @@ -24041,7 +25768,6 @@ components: - language_contexts - types_allowed get_script@200: - description: '' content: application/json: schema: @@ -24057,31 +25783,26 @@ components: - _id - found get_source@200: - description: '' content: application/json: schema: type: object get@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/_core.get:GetResult' index@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/_common:WriteResponseBase' index@201: - description: '' content: application/json: schema: $ref: '#/components/schemas/_common:WriteResponseBase' indices.add_block@200: - description: '' content: application/json: schema: @@ -24100,7 +25821,6 @@ components: - indices - shards_acknowledged indices.analyze@200: - description: '' content: application/json: schema: @@ -24113,13 +25833,11 @@ components: items: $ref: '#/components/schemas/indices.analyze:AnalyzeToken' indices.clear_cache@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/_common:ShardsOperationResponseBase' indices.clone@200: - description: '' content: application/json: schema: @@ -24136,7 +25854,6 @@ components: - index - shards_acknowledged indices.close@200: - description: '' content: application/json: schema: @@ -24155,13 +25872,11 @@ components: - indices - shards_acknowledged indices.create_data_stream@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/_common:AcknowledgedResponseBase' indices.create@200: - description: '' content: application/json: schema: @@ -24178,7 +25893,6 @@ components: - index - shards_acknowledged indices.data_streams_stats@200: - description: '' content: application/json: schema: @@ -24209,63 +25923,54 @@ components: - data_streams - total_store_size_bytes indices.delete_alias@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/_common:AcknowledgedResponseBase' indices.delete_data_stream@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/_common:AcknowledgedResponseBase' indices.delete_index_template@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/_common:AcknowledgedResponseBase' indices.delete_template@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/_common:AcknowledgedResponseBase' indices.delete@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/_common:IndicesResponseBase' indices.exists_alias@200: - description: '' + content: + application/json: {} + indices.exists_alias@404: content: application/json: {} indices.exists_index_template@200: - description: '' content: application/json: {} indices.exists_template@200: - description: '' content: application/json: {} indices.exists@200: - description: '' content: application/json: {} indices.exists@404: - description: '' content: application/json: {} indices.flush@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/_common:ShardsOperationResponseBase' indices.forcemerge@200: - description: '' content: application/json: schema: @@ -24279,15 +25984,16 @@ components: you can use the task_id to get the status of the task at _tasks/ type: string indices.get_alias@200: - description: '' content: application/json: schema: type: object additionalProperties: $ref: '#/components/schemas/indices.get_alias:IndexAliases' + indices.get_alias@404: + content: + application/json: {} indices.get_data_stream@200: - description: '' content: application/json: schema: @@ -24300,7 +26006,6 @@ components: required: - data_streams indices.get_field_mapping@200: - description: '' content: application/json: schema: @@ -24308,7 +26013,6 @@ components: additionalProperties: $ref: '#/components/schemas/indices.get_field_mapping:TypeFieldMappings' indices.get_index_template@200: - description: '' content: application/json: schema: @@ -24321,7 +26025,6 @@ components: required: - index_templates indices.get_mapping@200: - description: '' content: application/json: schema: @@ -24329,7 +26032,6 @@ components: additionalProperties: $ref: '#/components/schemas/indices.get_mapping:IndexMappingRecord' indices.get_settings@200: - description: '' content: application/json: schema: @@ -24337,17 +26039,14 @@ components: additionalProperties: $ref: '#/components/schemas/indices._common:IndexState' indices.get_template@200: - description: '' content: application/json: schema: type: object additionalProperties: $ref: '#/components/schemas/indices._common:TemplateMapping' - indices.get_upgrade@200: - description: '' + indices.get_upgrade@200: {} indices.get@200: - description: '' content: application/json: schema: @@ -24355,7 +26054,6 @@ components: additionalProperties: $ref: '#/components/schemas/indices._common:IndexState' indices.open@200: - description: '' content: application/json: schema: @@ -24376,37 +26074,31 @@ components: - shards_acknowledged additionalProperties: false indices.put_alias@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/_common:AcknowledgedResponseBase' indices.put_index_template@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/_common:AcknowledgedResponseBase' indices.put_mapping@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/_common:IndicesResponseBase' indices.put_settings@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/_common:AcknowledgedResponseBase' indices.put_template@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/_common:AcknowledgedResponseBase' indices.recovery@200: - description: '' content: application/json: schema: @@ -24414,13 +26106,11 @@ components: additionalProperties: $ref: '#/components/schemas/indices.recovery:RecoveryStatus' indices.refresh@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/_common:ShardsOperationResponseBase' indices.resolve_index@200: - description: '' content: application/json: schema: @@ -24443,7 +26133,6 @@ components: - data_streams - indices indices.rollover@200: - description: '' content: application/json: schema: @@ -24474,7 +26163,6 @@ components: - rolled_over - shards_acknowledged indices.segments@200: - description: '' content: application/json: schema: @@ -24490,7 +26178,6 @@ components: - _shards - indices indices.shard_stores@200: - description: '' content: application/json: schema: @@ -24503,7 +26190,6 @@ components: required: - indices indices.shrink@200: - description: '' content: application/json: schema: @@ -24520,13 +26206,11 @@ components: - index - shards_acknowledged indices.simulate_index_template@200: - description: '' content: application/json: schema: type: object indices.simulate_template@200: - description: '' content: application/json: schema: @@ -24541,7 +26225,6 @@ components: required: - template indices.split@200: - description: '' content: application/json: schema: @@ -24558,33 +26241,29 @@ components: - index - shards_acknowledged indices.stats@200: - description: '' content: application/json: schema: type: object properties: + _shards: + $ref: '#/components/schemas/_common:ShardStatistics' + _all: + $ref: '#/components/schemas/indices.stats:AllIndicesStats' indices: type: object additionalProperties: $ref: '#/components/schemas/indices.stats:IndicesStats' - _shards: - $ref: '#/components/schemas/_common:ShardStatistics' - _all: - $ref: '#/components/schemas/indices.stats:IndicesStats' required: - _all - _shards indices.update_aliases@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/_common:AcknowledgedResponseBase' - indices.upgrade@200: - description: '' + indices.upgrade@200: {} indices.validate_query@200: - description: '' content: application/json: schema: @@ -24603,7 +26282,6 @@ components: required: - valid info@200: - description: '' content: application/json: schema: @@ -24626,13 +26304,11 @@ components: - tagline - version ingest.delete_pipeline@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/_common:AcknowledgedResponseBase' ingest.get_pipeline@200: - description: '' content: application/json: schema: @@ -24640,7 +26316,6 @@ components: additionalProperties: $ref: '#/components/schemas/ingest._common:Pipeline' ingest.processor_grok@200: - description: '' content: application/json: schema: @@ -24653,13 +26328,11 @@ components: required: - patterns ingest.put_pipeline@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/_common:AcknowledgedResponseBase' ingest.simulate@200: - description: '' content: application/json: schema: @@ -24671,20 +26344,13 @@ components: $ref: '#/components/schemas/ingest.simulate:PipelineSimulation' required: - docs - knn.delete_model@200: - description: '' - knn.get_model@200: - description: '' - knn.search_models@200: - description: '' - knn.stats@200: - description: '' - knn.train_model@200: - description: '' - knn.warmup@200: - description: '' + knn.delete_model@200: {} + knn.get_model@200: {} + knn.search_models@200: {} + knn.stats@200: {} + knn.train_model@200: {} + knn.warmup@200: {} mget@200: - description: '' content: application/json: schema: @@ -24700,92 +26366,57 @@ components: content: application/json: schema: - type: object + $ref: '#/components/schemas/_common:WriteResponseBase' ml.delete_model@200: content: application/json: schema: - type: object - ml.get_model_group@200: + $ref: '#/components/schemas/_common:WriteResponseBase' + ml.delete_task@200: + content: + application/json: + schema: + $ref: '#/components/schemas/_common:WriteResponseBase' + ml.deploy_model@200: content: application/json: schema: type: object properties: - name: + status: type: string - description: The model group name. - latest_version: - type: number - description: The latest version. - description: + task_id: type: string - description: The model group description. - access: + task_type: type: string - description: The model group access. - created_time: - type: integer - format: int64 - last_updated_time: - type: integer - format: int64 required: - - access - - description - - latest_version - - name + - status + - task_id + ml.get_model_group@200: + content: + application/json: + schema: + $ref: '#/components/schemas/ml._common:ModelGroup' ml.get_task@200: content: application/json: schema: - type: object - properties: - model_id: - type: string - description: The model ID. - state: - type: string - description: The state. - enum: - - CANCELLED - - COMPLETED - - COMPLETED_WITH_ERROR - - CREATED - - FAILED - - RUNNING - required: - - state + $ref: '#/components/schemas/ml._common:Task' ml.register_model_group@200: content: application/json: schema: - type: object - properties: - model_group_id: - type: string - description: The model group ID. - status: - type: string - description: The status. - required: - - model_group_id - - status + $ref: '#/components/schemas/ml._common:ModelGroupRegistration' ml.register_model@200: content: application/json: schema: type: object properties: - task_id: - type: string - description: The task ID. - model_id: - type: string - description: The model ID. status: type: string - description: The status. + task_id: + type: string required: - status - task_id @@ -24793,26 +26424,23 @@ components: content: application/json: schema: - type: object - properties: - hits: - $ref: '#/components/schemas/ml._common:SearchModelHits' - required: - - hits + $ref: '#/components/schemas/ml._common:SearchModelsResponse' + ml.undeploy_model@200: + content: + application/json: + schema: + $ref: '#/components/schemas/ml._common:UndeployModelResponse' msearch_template@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/_core.msearch:MultiSearchResult' msearch@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/_core.msearch:MultiSearchResult' mtermvectors@200: - description: '' content: application/json: schema: @@ -24825,33 +26453,29 @@ components: required: - docs nodes.hot_threads@200: - description: '' + content: + text/plain: {} nodes.info@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/nodes.info:ResponseBase' nodes.reload_secure_settings@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/nodes.reload_secure_settings:ResponseBase' nodes.stats@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/nodes.stats:ResponseBase' nodes.usage@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/nodes.usage:ResponseBase' notifications.create_config@200: - description: '' content: application/json: schema: @@ -24860,31 +26484,26 @@ components: config_id: type: string notifications.delete_config@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/notifications._common:DeleteConfigsResponse' notifications.delete_configs@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/notifications._common:DeleteConfigsResponse' notifications.get_config@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/notifications._common:GetConfigsResponse' notifications.get_configs@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/notifications._common:GetConfigsResponse' notifications.list_channels@200: - description: '' content: application/json: schema: @@ -24903,7 +26522,6 @@ components: items: $ref: '#/components/schemas/notifications._common:NotificationChannel' notifications.list_features@200: - description: '' content: application/json: schema: @@ -24916,7 +26534,6 @@ components: plugin_features: $ref: '#/components/schemas/notifications._common:NotificationsPluginFeaturesMap' notifications.send_test@200: - description: '' content: application/json: schema: @@ -24929,7 +26546,6 @@ components: items: $ref: '#/components/schemas/notifications._common:EventStatus' notifications.update_config@200: - description: '' content: application/json: schema: @@ -24937,18 +26553,172 @@ components: properties: config_id: type: string + observability.create_object@200: + description: Created + content: + application/json: + schema: + type: object + properties: + objectId: + type: string + observability.delete_object@200: + description: Deleted + content: + application/json: + schema: + type: object + properties: + deleteResponseList: + type: object + additionalProperties: + type: string + example: OK + observability.delete_object@404: + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/observability._common:NotFoundResponse' + observability.delete_objects@200: + description: Deleted + content: + application/json: + schema: + type: object + properties: + deleteResponseList: + type: object + additionalProperties: + type: string + example: OK + observability.delete_objects@404: + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/observability._common:NotFoundResponse' + observability.get_localstats@200: + description: Retrieves + content: + application/json: + schema: + type: string + observability.get_object@200: + description: Successful response of retrieving specific Observability Object. + content: + application/json: + schema: + $ref: '#/components/schemas/observability._common:ObservabilityObjectList' + observability.get_object@404: + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/observability._common:NotFoundResponse' + observability.list_objects@200: + description: Successful response of retrieving all Observability Objects. + content: + application/json: + schema: + $ref: '#/components/schemas/observability._common:ObservabilityObjectList' + observability.update_object@200: + description: Updated + content: + application/json: + schema: + type: object + properties: + objectId: + type: string + observability.update_object@404: + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/observability._common:NotFoundResponse' ping@200: - description: '' content: application/json: {} - put_script@200: + ppl.explain@200: + content: + application/json: + schema: + $ref: '#/components/schemas/sql._common:ExplainResponse' + required: true + ppl.get_stats@200: + content: + text/plain: + schema: + type: string + required: true + ppl.post_stats@200: + content: + text/plain: + schema: + type: string + required: true + ppl.query@200: description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/sql._common:QueryResponse' + put_script@200: content: application/json: schema: $ref: '#/components/schemas/_common:AcknowledgedResponseBase' + query.datasource_delete@204: + description: No Content + content: + application/json: + schema: + type: object + properties: {} + query.datasource_delete@404: + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/query._common:DataSourceNotFound' + query.datasource_retrieve@200: + description: Successful response of retrieving Data Source. + content: + application/json: + schema: + $ref: '#/components/schemas/query._common:DataSourceRetrieve' + query.datasource_retrieve@404: + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/query._common:DataSourceNotFound' + query.datasources_create@201: + description: Created + content: + application/json: + schema: + type: string + query.datasources_list@200: + description: Successful response of retrieving all Data Sources. + content: + application/json: + schema: + $ref: '#/components/schemas/query._common:DataSourceList' + query.datasources_update@200: + description: Updated + content: + application/json: + schema: + type: string + query.datasources_update@404: + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/query._common:DataSourceNotFound' rank_eval@200: - description: '' content: application/json: schema: @@ -24971,7 +26741,6 @@ components: - failures - metric_score reindex_rethrottle@200: - description: '' content: application/json: schema: @@ -24984,7 +26753,6 @@ components: required: - nodes reindex@200: - description: '' content: application/json: schema: @@ -25025,7 +26793,6 @@ components: version_conflicts: type: number remote_store.restore@200: - description: '' content: application/json: schema: @@ -25038,7 +26805,6 @@ components: examples: RemoteStoreRestore_example1: summary: Examples for Post Remote Storage Restore Operation. - description: '' value: remote_store: indices: @@ -25048,7 +26814,6 @@ components: failed: 0 successful: 1 render_search_template@200: - description: '' content: application/json: schema: @@ -25060,8 +26825,7 @@ components: type: object required: - template_output - rollups.delete@200: - description: '' + rollups.delete@200: {} rollups.explain@200: content: application/json: @@ -25077,12 +26841,9 @@ components: application/json: schema: $ref: '#/components/schemas/rollups._common:RollupEntity' - rollups.start@200: - description: '' - rollups.stop@200: - description: '' + rollups.start@200: {} + rollups.stop@200: {} scripts_painless_execute@200: - description: '' content: application/json: schema: @@ -25093,13 +26854,11 @@ components: required: - result scroll@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/_core.search:ResponseBody' search_pipeline.delete@200: - description: '' content: application/json: schema: @@ -25108,13 +26867,11 @@ components: acknowledged: type: boolean search_pipeline.get@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/search_pipeline._common:SearchPipelineMap' search_pipeline.put@200: - description: '' content: application/json: schema: @@ -25123,7 +26880,6 @@ components: acknowledged: type: boolean search_shards@200: - description: '' content: application/json: schema: @@ -25148,7 +26904,6 @@ components: - nodes - shards search_template@200: - description: '' content: application/json: schema: @@ -25196,265 +26951,282 @@ components: - timed_out - took search@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/_core.search:ResponseBody' + search@400: + content: + application/json: + schema: + $ref: '#/components/schemas/query._common:ErrorResponse' + search@404: + content: + application/json: + schema: + $ref: '#/components/schemas/query._common:ErrorResponse' security.authinfo@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:AuthInfo' security.authinfo@500: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:InternalServerError' security.authtoken@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:Ok' security.cache@501: - description: '' content: application/json: - schema: - $ref: '#/components/schemas/security._common:MethodNotImplemented' + schema: null security.change_password@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:Ok' + security.change_password@403: + content: + application/json: + schema: null security.config_upgrade_check@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:UpgradeCheck' security.config_upgrade_perform@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:UpgradePerform' + security.config_upgrade_perform@400: + content: + application/json: + schema: null security.create_action_group@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:Ok' + security.create_action_group@201: + content: + application/json: + schema: + $ref: '#/components/schemas/security._common:Created' security.create_allowlist@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:AllowListConfig' + security.create_allowlist@403: + content: + application/json: + schema: null security.create_role_mapping@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:Ok' + security.create_role_mapping@201: + content: + application/json: + schema: + $ref: '#/components/schemas/security._common:Created' security.create_role@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:Ok' + security.create_role@201: + content: + application/json: + schema: + $ref: '#/components/schemas/security._common:Created' security.create_tenant@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:Ok' - security.create_tenant@400: - description: '' + security.create_tenant@201: content: application/json: schema: - $ref: '#/components/schemas/security._common:BadRequest' + $ref: '#/components/schemas/security._common:Created' + security.create_tenant@400: + content: + application/json: + schema: null security.create_update_tenancy_config@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:MultiTenancyConfig' security.create_update_tenancy_config@400: - description: '' content: application/json: - schema: - $ref: '#/components/schemas/security._common:BadRequest' + schema: null security.create_user_legacy@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:Ok' + security.create_user_legacy@201: + content: + application/json: + schema: + $ref: '#/components/schemas/security._common:Created' security.create_user@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:Ok' security.delete_action_group@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:Ok' security.delete_distinguished_name@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:Ok' + security.delete_distinguished_name@400: + content: + application/json: + schema: null security.delete_distinguished_name@403: - description: '' content: application/json: - schema: - $ref: '#/components/schemas/security._common:Unauthorized' + schema: null security.delete_role_mapping@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:Ok' security.delete_role@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:Ok' security.delete_tenant@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:Ok' security.delete_tenant@400: - description: '' content: application/json: - schema: - $ref: '#/components/schemas/security._common:BadRequest' + schema: null security.delete_user_legacy@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:Ok' security.delete_user@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:Ok' security.flush_cache@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:Ok' security.generate_obo_token@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:GenerateOBOToken' security.generate_obo_token@400: - description: '' - content: - application/json: - schema: - $ref: '#/components/schemas/security._common:BadRequest' - security.generate_user_token_legacy@200: - description: '' content: + text/plain: + type: string application/json: - schema: - $ref: '#/components/schemas/security._common:Ok' - security.generate_user_token_legacy@400: - description: '' + schema: null + security.generate_user_token_legacy@501: content: application/json: - schema: - $ref: '#/components/schemas/security._common:BadRequest' + schema: null security.generate_user_token@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:Ok' security.generate_user_token@400: - description: '' content: application/json: - schema: - $ref: '#/components/schemas/security._common:BadRequest' + schema: null security.get_account_details@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:AccountDetails' security.get_action_group@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:ActionGroupsMap' security.get_action_groups@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:ActionGroupsMap' + security.get_all_certificates@200: + content: + application/json: + schema: + $ref: '#/components/schemas/security._common:GetCertificatesNew' + security.get_all_certificates@403: + content: + application/json: + schema: null + security.get_all_certificates@500: + content: + application/json: + schema: + $ref: '#/components/schemas/security._common:InternalServerError' security.get_allowlist@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:AllowListConfig' + security.get_allowlist@403: + content: + application/json: + schema: null security.get_audit_configuration@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:AuditConfigWithReadOnly' security.get_certificates@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:GetCertificates' security.get_certificates@400: - description: '' content: application/json: - schema: - $ref: '#/components/schemas/security._common:BadRequest' + schema: null + security.get_certificates@403: + content: + application/json: + schema: null security.get_configuration@200: - description: '' content: application/json: schema: - $ref: '#/components/schemas/security._common:DynamicConfig' + $ref: '#/components/schemas/security._common:SecurityConfig' security.get_dashboards_info@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:DashboardsInfo' security.get_dashboards_info@500: - description: '' content: application/json: schema: @@ -25465,392 +27237,371 @@ components: application/json: schema: $ref: '#/components/schemas/security._common:DistinguishedNames' + security.get_distinguished_name@400: + content: + application/json: + schema: null security.get_distinguished_name@403: - description: '' content: application/json: - schema: - $ref: '#/components/schemas/security._common:Unauthorized' + schema: null security.get_distinguished_names@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:DistinguishedNamesMap' + security.get_distinguished_names@400: + description: Show nodesDn setting for given cluster. + content: + application/json: + schema: null security.get_distinguished_names@403: - description: '' + content: + application/json: + schema: null + security.get_node_certificates@200: + content: + application/json: + schema: + $ref: '#/components/schemas/security._common:GetCertificatesNew' + security.get_node_certificates@403: + content: + application/json: + schema: null + security.get_node_certificates@500: content: application/json: schema: - $ref: '#/components/schemas/security._common:Unauthorized' + $ref: '#/components/schemas/security._common:InternalServerError' security.get_permissions_info@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:PermissionsInfo' security.get_permissions_info@500: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:InternalServerError' security.get_role_mapping@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:RoleMappings' security.get_role_mappings@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:RoleMappings' security.get_role@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:RolesMap' security.get_roles@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:RolesMap' security.get_sslinfo@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:SSLInfo' security.get_sslinfo@500: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:InternalServerError' security.get_tenancy_config@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:MultiTenancyConfig' security.get_tenancy_config@400: - description: '' content: application/json: - schema: - $ref: '#/components/schemas/security._common:BadRequest' + schema: null security.get_tenant@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:TenantsMap' security.get_tenants@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:TenantsMap' security.get_tenants@400: - description: '' content: application/json: - schema: - $ref: '#/components/schemas/security._common:BadRequest' + schema: null security.get_user_legacy@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:UsersMap' security.get_user@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:UsersMap' security.get_users_legacy@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:UsersMap' security.get_users@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:UsersMap' security.health@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:HealthInfo' security.migrate@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:Ok' security.migrate@400: - description: '' content: application/json: - schema: - $ref: '#/components/schemas/security._common:BadRequest' + schema: null security.patch_action_group@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:Ok' security.patch_action_groups@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:Ok' security.patch_allowlist@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:AllowListConfig' + security.patch_allowlist@403: + content: + application/json: + schema: null security.patch_audit_configuration@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:Ok' security.patch_configuration@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:Ok' + security.patch_configuration@403: + content: + application/json: + schema: null security.patch_distinguished_name@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:Ok' + security.patch_distinguished_name@400: + content: + application/json: + schema: null security.patch_distinguished_name@403: - description: '' content: application/json: - schema: - $ref: '#/components/schemas/security._common:Unauthorized' + schema: null security.patch_distinguished_names@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:Ok' + security.patch_distinguished_names@400: + content: + application/json: + schema: null security.patch_distinguished_names@403: - description: '' content: application/json: - schema: - $ref: '#/components/schemas/security._common:Unauthorized' + schema: null security.patch_role_mapping@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:Ok' security.patch_role_mapping@400: - description: '' content: application/json: - schema: - $ref: '#/components/schemas/security._common:BadRequest' + schema: null security.patch_role_mappings@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:Ok' security.patch_role_mappings@400: - description: '' content: application/json: - schema: - $ref: '#/components/schemas/security._common:BadRequest' + schema: null security.patch_role@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:Ok' security.patch_role@400: - description: '' content: application/json: - schema: - $ref: '#/components/schemas/security._common:BadRequest' + schema: null security.patch_roles@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:Ok' security.patch_roles@400: - description: '' content: application/json: - schema: - $ref: '#/components/schemas/security._common:BadRequest' + schema: null security.patch_tenant@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:Ok' security.patch_tenant@400: - description: '' content: application/json: - schema: - $ref: '#/components/schemas/security._common:BadRequest' + schema: null security.patch_tenants@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:Ok' security.patch_tenants@400: - description: '' content: application/json: - schema: - $ref: '#/components/schemas/security._common:BadRequest' + schema: null security.patch_user@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:Ok' security.patch_users@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:Ok' security.post_dashboards_info@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:DashboardsInfo' security.post_dashboards_info@500: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:InternalServerError' security.reload_http_certificates@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:Ok' security.reload_http_certificates@400: - description: '' content: application/json: - schema: - $ref: '#/components/schemas/security._common:BadRequest' + schema: null + security.reload_http_certificates@403: + content: + application/json: + schema: null security.reload_transport_certificates@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:Ok' security.reload_transport_certificates@400: - description: '' content: application/json: - schema: - $ref: '#/components/schemas/security._common:BadRequest' + schema: null + security.reload_transport_certificates@403: + content: + application/json: + schema: null security.tenant_info@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:TenantInfo' + security.tenant_info@403: + content: + text/plain: + type: string + application/json: + schema: null security.tenant_info@500: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:InternalServerError' security.update_audit_configuration@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:Ok' security.update_configuration@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:Ok' + security.update_configuration@403: + content: + application/json: + schema: null security.update_distinguished_name@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:Ok' + security.update_distinguished_name@400: + content: + application/json: + schema: null security.update_distinguished_name@403: - description: '' content: application/json: - schema: - $ref: '#/components/schemas/security._common:Unauthorized' + schema: null security.validate@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:Ok' security.validate@400: - description: '' content: application/json: - schema: - $ref: '#/components/schemas/security._common:BadRequest' + schema: null security.who_am_i_protected@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:WhoAmI' security.who_am_i_protected@500: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:InternalServerError' security.who_am_i@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:WhoAmI' security.who_am_i@500: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:InternalServerError' snapshot.cleanup_repository@200: - description: '' content: application/json: schema: @@ -25861,19 +27612,16 @@ components: required: - results snapshot.clone@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/_common:AcknowledgedResponseBase' snapshot.create_repository@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/_common:AcknowledgedResponseBase' snapshot.create@200: - description: '' content: application/json: schema: @@ -25885,19 +27633,16 @@ components: snapshot: $ref: '#/components/schemas/snapshot._common:SnapshotInfo' snapshot.delete_repository@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/_common:AcknowledgedResponseBase' snapshot.delete@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/_common:AcknowledgedResponseBase' snapshot.get_repository@200: - description: '' content: application/json: schema: @@ -25905,7 +27650,6 @@ components: additionalProperties: $ref: '#/components/schemas/snapshot._common:Repository' snapshot.get@200: - description: '' content: application/json: schema: @@ -25929,7 +27673,6 @@ components: - remaining - total snapshot.restore@200: - description: '' content: application/json: schema: @@ -25940,7 +27683,6 @@ components: required: - snapshot snapshot.status@200: - description: '' content: application/json: schema: @@ -25953,7 +27695,6 @@ components: required: - snapshots snapshot.verify_repository@200: - description: '' content: application/json: schema: @@ -25965,14 +27706,46 @@ components: $ref: '#/components/schemas/snapshot.verify_repository:CompactNodeInfo' required: - nodes + sql.close@200: + content: + application/json: + schema: + $ref: '#/components/schemas/sql._common:SqlCloseResponse' + required: true + sql.explain@200: + content: + application/json: + schema: + $ref: '#/components/schemas/sql._common:ExplainResponse' + required: true + sql.get_stats@200: + content: + text/plain: + schema: + type: string + required: true + sql.post_stats@200: + content: + text/plain: + schema: + type: string + required: true + sql.query@200: + content: + application/json: + schema: + $ref: '#/components/schemas/sql._common:QueryResponse' + sql.settings@200: + content: + application/json: + schema: + $ref: '#/components/schemas/sql._common:SqlSettingsResponse' tasks.cancel@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/tasks._common:TaskListResponseBase' tasks.get@200: - description: '' content: application/json: schema: @@ -25990,13 +27763,11 @@ components: - completed - task tasks.list@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/tasks._common:TaskListResponseBase' termvectors@200: - description: '' content: application/json: schema: @@ -26022,8 +27793,7 @@ components: - _version - found - took - transforms.delete@200: - description: '' + transforms.delete@200: {} transforms.explain@200: content: application/json: @@ -26060,7 +27830,6 @@ components: schema: $ref: '#/components/schemas/_common:AcknowledgedResponseBase' update_by_query_rethrottle@200: - description: '' content: application/json: schema: @@ -26073,7 +27842,6 @@ components: required: - nodes update_by_query@200: - description: '' content: application/json: schema: @@ -26114,7 +27882,6 @@ components: throttled_until_millis: $ref: '#/components/schemas/_common:DurationValueUnitMillis' update@200: - description: '' content: application/json: schema: @@ -26177,33 +27944,6 @@ components: - index - status - type - _common:BulkStats: - type: object - properties: - total_operations: - type: number - total_time: - $ref: '#/components/schemas/_common:Duration' - total_time_in_millis: - $ref: '#/components/schemas/_common:DurationValueUnitMillis' - total_size: - $ref: '#/components/schemas/_common:ByteSize' - total_size_in_bytes: - type: number - avg_time: - $ref: '#/components/schemas/_common:Duration' - avg_time_in_millis: - $ref: '#/components/schemas/_common:DurationValueUnitMillis' - avg_size: - $ref: '#/components/schemas/_common:ByteSize' - avg_size_in_bytes: - type: number - required: - - avg_size_in_bytes - - avg_time_in_millis - - total_operations - - total_size_in_bytes - - total_time_in_millis _common:byte: type: number _common:Bytes: @@ -26404,12 +28144,10 @@ components: description: |- A duration. Units can be `nanos`, `micros`, `ms` (milliseconds), `s` (seconds), `m` (minutes), `h` (hours) and `d` (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value. - pattern: ^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$ + pattern: ^([0-9\.]+)(?:d|h|m|s|ms|micros|nanos)$ type: string _common:DurationLarge: - description: |- - A date histogram interval. Similar to `Duration` with additional units: `w` (week), `M` (month), `q` (quarter) and - `y` (year) + description: 'A date histogram interval. Similar to `Duration` with additional units: `w` (week), `M` (month), `q` (quarter) and `y` (year).' type: string _common:DurationValueUnitMillis: allOf: @@ -26449,6 +28187,9 @@ components: $ref: '#/components/schemas/_common:ErrorCause' required: - type + additionalProperties: + title: metadata + description: Additional details about the error. _common:ErrorResponseBase: type: object properties: @@ -26548,7 +28289,7 @@ components: - as 4 top/bottom/left/right coordinates - as 2 top_left / bottom_right points - as 2 top_right / bottom_left points - - as a WKT bounding box + - as a WKT bounding box. oneOf: - $ref: '#/components/schemas/_common:CoordsGeoBounds' - $ref: '#/components/schemas/_common:TopLeftBottomRightGeoBounds' @@ -26587,7 +28328,7 @@ components: - type: number - type: string _common:GeoHexCell: - description: A map hex cell (H3) reference + description: A map hex cell (H3) reference. type: string _common:GeoLine: type: object @@ -26611,7 +28352,7 @@ components: - as a `{lat, long}` object - as a geo hash value - as a `[lon, lat]` array - - as a string in `", "` or WKT point formats + - as a string in `", "` or WKT point formats. oneOf: - $ref: '#/components/schemas/_common:LatLonGeoLocation' - $ref: '#/components/schemas/_common:GeoHashLocation' @@ -26627,32 +28368,32 @@ components: - intersects - within _common:GeoTile: - description: A map tile reference, represented as `{zoom}/{x}/{y}` + description: A map tile reference, represented as `{zoom}/{x}/{y}`. type: string _common:GeoTilePrecision: type: number _common:GetStats: type: object properties: - current: + total: type: number - exists_time: + time: $ref: '#/components/schemas/_common:Duration' - exists_time_in_millis: + time_in_millis: $ref: '#/components/schemas/_common:DurationValueUnitMillis' exists_total: type: number - missing_time: + exists_time: $ref: '#/components/schemas/_common:Duration' - missing_time_in_millis: + exists_time_in_millis: $ref: '#/components/schemas/_common:DurationValueUnitMillis' missing_total: type: number - time: + missing_time: $ref: '#/components/schemas/_common:Duration' - time_in_millis: + missing_time_in_millis: $ref: '#/components/schemas/_common:DurationValueUnitMillis' - total: + current: type: number required: - current @@ -26721,40 +28462,39 @@ components: _common:IndexingStats: type: object properties: + index_total: + type: number + index_time: + $ref: '#/components/schemas/_common:Duration' + index_time_in_millis: + $ref: '#/components/schemas/_common:DurationValueUnitMillis' index_current: type: number - delete_current: + index_failed: + type: number + delete_total: type: number delete_time: $ref: '#/components/schemas/_common:Duration' delete_time_in_millis: $ref: '#/components/schemas/_common:DurationValueUnitMillis' - delete_total: + delete_current: type: number - doc_status: - $ref: '#/components/schemas/_common:DocStatus' - is_throttled: - type: boolean noop_update_total: type: number + is_throttled: + type: boolean throttle_time: $ref: '#/components/schemas/_common:Duration' throttle_time_in_millis: $ref: '#/components/schemas/_common:DurationValueUnitMillis' - index_time: - $ref: '#/components/schemas/_common:Duration' - index_time_in_millis: - $ref: '#/components/schemas/_common:DurationValueUnitMillis' - index_total: - type: number - index_failed: - type: number + doc_status: + $ref: '#/components/schemas/_common:DocStatus' types: + x-version-removed: '2.0' type: object additionalProperties: $ref: '#/components/schemas/_common:IndexingStats' - write_load: - type: number required: - delete_current - delete_time_in_millis @@ -26838,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: @@ -26946,7 +28682,7 @@ components: items: type: string _common:MinimumShouldMatch: - description: The minimum number of terms that should match as integer, percentage or range + description: The minimum number of terms that should match as integer, percentage or range. oneOf: - type: number - type: string @@ -27027,7 +28763,7 @@ components: - transform - voting_only _common:NodeRoles: - description: '* @doc_id node-roles' + description: Node roles. type: array items: $ref: '#/components/schemas/_common:NodeRole' @@ -27247,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: @@ -27531,8 +29260,7 @@ components: Specifies any named parameters that are passed into the script as variables. Use parameters instead of hard-coded values to decrease compile time. type: object - additionalProperties: - type: object + additionalProperties: true _common:ScriptField: type: object properties: @@ -27581,6 +29309,21 @@ components: _common:SearchStats: type: object properties: + open_contexts: + description: The number of open search contexts. + type: number + query_current: + description: The number of shard query operations that are currently running. + type: number + query_time: + description: The total amount of time for all shard query operations. + $ref: '#/components/schemas/_common:Duration' + query_time_in_millis: + description: The total amount of time for all shard query operations, in milliseconds. + $ref: '#/components/schemas/_common:DurationValueUnitMillis' + query_total: + description: The total number of shard query operations. + type: number concurrent_query_total: description: The total number of query operations that use concurrent segment search. type: number @@ -27607,39 +29350,6 @@ components: fetch_total: description: The total number of shard fetch operations. type: number - open_contexts: - description: The number of open search contexts. - type: number - point_in_time_total: - description: The total number of shard Point in Time (PIT) contexts that have been created (completed and active) since the node last restarted. - type: number - point_in_time_time: - $ref: '#/components/schemas/_common:Duration' - point_in_time_time_in_millis: - description: The amount of time that shard PIT contexts have been held open since the node last restarted, in milliseconds. - $ref: '#/components/schemas/_common:DurationValueUnitMillis' - point_in_time_current: - description: The number of shard PIT contexts currently open. - type: number - query_current: - description: The number of shard query operations that are currently running. - type: number - query_time: - description: The total amount of time for all shard query operations. - $ref: '#/components/schemas/_common:Duration' - query_time_in_millis: - description: The total amount of time for all shard query operations, in milliseconds. - $ref: '#/components/schemas/_common:DurationValueUnitMillis' - query_total: - description: The total number of shard query operations. - type: number - request: - type: object - description: Statistics about coordinator search operations for the node. - additionalProperties: - $ref: '#/components/schemas/_common:RequestStats' - search_idle_reactivate_count_total: - type: number scroll_current: description: The number of shard scroll operations that are currently running. type: number @@ -27652,6 +29362,17 @@ components: scroll_total: description: The total number of shard scroll operations. type: number + point_in_time_total: + description: The total number of shard Point in Time (PIT) contexts that have been created (completed and active) since the node last restarted. + type: number + point_in_time_time: + $ref: '#/components/schemas/_common:Duration' + point_in_time_time_in_millis: + description: The amount of time that shard PIT contexts have been held open since the node last restarted, in milliseconds. + $ref: '#/components/schemas/_common:DurationValueUnitMillis' + point_in_time_current: + description: The number of shard PIT contexts currently open. + type: number suggest_current: description: The number of shard suggest operations that are currently running. type: number @@ -27664,6 +29385,13 @@ components: suggest_total: description: The total number of shard suggest operations. type: number + search_idle_reactivate_count_total: + type: number + request: + type: object + description: Statistics about coordinator search operations for the node. + additionalProperties: + $ref: '#/components/schemas/_common:RequestStats' groups: type: object additionalProperties: @@ -27787,6 +29515,7 @@ components: - version_map_memory_in_bytes _common:SequenceNumber: type: number + format: int64 _common:ShardFailure: type: object properties: @@ -27929,13 +29658,6 @@ components: reserved_in_bytes: description: A prediction, in bytes, of how much larger the shard stores will eventually grow due to ongoing peer recoveries, restoring snapshots, and similar activities. type: number - total_data_set_size: - $ref: '#/components/schemas/_common:ByteSize' - total_data_set_size_in_bytes: - description: |- - Total data set size, in bytes, of all shards assigned to selected nodes. - This includes the size of shards not stored fully on the nodes, such as the cache for partially mounted indices. - type: number required: - reserved_in_bytes - size_in_bytes @@ -28015,18 +29737,8 @@ 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 + description: Time of day, expressed as HH:MM:SS. type: string _common:TimeUnit: type: string @@ -28095,13 +29807,14 @@ components: _common:ulong: type: number _common:UnitMillis: - description: Time unit for milliseconds + description: Time unit for milliseconds. type: number + format: int64 _common:UnitNanos: - description: Time unit for nanoseconds + description: Time unit for nanoseconds. type: number _common:UnitSeconds: - description: Time unit for seconds + description: Time unit for seconds. type: number _common:Username: type: string @@ -28109,6 +29822,7 @@ components: type: string _common:VersionNumber: type: number + format: int64 _common:VersionString: type: string _common:VersionType: @@ -28125,7 +29839,7 @@ components: Although "void" is generally used for the unit type that has only one value, this is to be interpreted as the bottom type that has no value at all. Most languages have a unit type, but few have a bottom type. - See https://en.m.wikipedia.org/wiki/Unit_type and https://en.m.wikipedia.org/wiki/Bottom_type + See https://en.m.wikipedia.org/wiki/Unit_type and https://en.m.wikipedia.org/wiki/Bottom_type. type: object _common:WaitForActiveShardOptions: type: string @@ -28178,6 +29892,7 @@ components: $ref: '#/components/schemas/_common:IndexName' _primary_term: type: number + format: int64 result: $ref: '#/components/schemas/_common:Result' _seq_no: @@ -33841,8 +35556,8 @@ components: type: string enum: - 'false' - - runtime - strict + - strict_allow_templates - 'true' _common.mapping:DynamicProperty: allOf: @@ -34203,6 +35918,41 @@ components: - keyword required: - type + _common.mapping:KnnVectorMethod: + type: object + properties: + name: + type: string + space_type: + type: string + engine: + type: string + parameters: + type: object + additionalProperties: + type: object + required: + - name + _common.mapping:KnnVectorProperty: + allOf: + - $ref: '#/components/schemas/_common.mapping:KnnVectorPropertyBase' + - type: object + properties: + type: + type: string + enum: + - knn_vector + required: + - type + _common.mapping:KnnVectorPropertyBase: + type: object + properties: + dimension: + type: number + method: + $ref: '#/components/schemas/_common.mapping:KnnVectorMethod' + required: + - dimension _common.mapping:LongNumberProperty: allOf: - $ref: '#/components/schemas/_common.mapping:NumberPropertyBase' @@ -34401,6 +36151,7 @@ components: - $ref: '#/components/schemas/_common.mapping:IntegerRangeProperty' - $ref: '#/components/schemas/_common.mapping:IpRangeProperty' - $ref: '#/components/schemas/_common.mapping:LongRangeProperty' + - $ref: '#/components/schemas/_common.mapping:KnnVectorProperty' _common.mapping:PropertyBase: type: object properties: @@ -35187,10 +36938,7 @@ components: validation_method: $ref: '#/components/schemas/_common.query_dsl:GeoValidationMethod' ignore_unmapped: - description: |- - Set to `true` to ignore an unmapped field and not match any documents for this query. - Set to `false` to throw an exception if the field is not mapped. - type: boolean + $ref: '#/components/schemas/_common.query_dsl:IgnoreUnmapped' _common.query_dsl:GeoDecayFunction: allOf: - $ref: '#/components/schemas/_common.query_dsl:DecayFunctionBase' @@ -35211,11 +36959,7 @@ components: validation_method: $ref: '#/components/schemas/_common.query_dsl:GeoValidationMethod' ignore_unmapped: - description: |- - Set to `true` to ignore an unmapped field and not match any documents for this query. - Set to `false` to throw an exception if the field is not mapped. - type: boolean - default: false + $ref: '#/components/schemas/_common.query_dsl:IgnoreUnmapped' field: type: object required: @@ -35234,17 +36978,14 @@ components: validation_method: $ref: '#/components/schemas/_common.query_dsl:GeoValidationMethod' ignore_unmapped: - type: boolean + $ref: '#/components/schemas/_common.query_dsl:IgnoreUnmapped' _common.query_dsl:GeoShapeQuery: allOf: - $ref: '#/components/schemas/_common.query_dsl:QueryBase' - type: object properties: ignore_unmapped: - description: |- - Set to `true` to ignore an unmapped field and not match any documents for this query. - Set to `false` to throw an exception if the field is not mapped. - type: boolean + $ref: '#/components/schemas/_common.query_dsl:IgnoreUnmapped' _common.query_dsl:GeoValidationMethod: type: string enum: @@ -35257,8 +36998,8 @@ components: - type: object properties: ignore_unmapped: + $ref: '#/components/schemas/_common.query_dsl:IgnoreUnmapped' description: Indicates whether to ignore an unmapped `type` and not return any documents instead of an error. - type: boolean inner_hits: $ref: '#/components/schemas/_core.search:InnerHits' max_children: @@ -35286,10 +37027,10 @@ components: - type: object properties: ignore_unmapped: + $ref: '#/components/schemas/_common.query_dsl:IgnoreUnmapped' description: |- Indicates whether to ignore an unmapped `parent_type` and not return any documents instead of an error. You can use this parameter to query multiple indices that may not contain the `parent_type`. - type: boolean inner_hits: $ref: '#/components/schemas/_core.search:InnerHits' parent_type: @@ -35309,6 +37050,12 @@ components: properties: values: $ref: '#/components/schemas/_common:Ids' + _common.query_dsl:IgnoreUnmapped: + type: boolean + default: false + description: |- + Set to `true` to ignore an unmapped field and not match any documents for this query. + Set to `false` to throw an exception if the field is not mapped. _common.query_dsl:IntervalsAllOf: type: object properties: @@ -35472,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: @@ -35776,8 +37529,8 @@ components: - type: object properties: ignore_unmapped: + $ref: '#/components/schemas/_common.query_dsl:IgnoreUnmapped' description: Indicates whether to ignore an unmapped path and not return any documents instead of an error. - type: boolean inner_hits: $ref: '#/components/schemas/_core.search:InnerHits' path: @@ -35789,6 +37542,30 @@ components: required: - path - query + _common.query_dsl:NeuralQuery: + allOf: + - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - type: object + additionalProperties: + $ref: '#/components/schemas/_common.query_dsl:NeuralQueryVectorField' + _common.query_dsl:NeuralQueryVectorField: + type: object + properties: + query_text: + type: string + query_image: + type: string + contentEncoding: base64 + model_id: + type: string + k: + type: integer + min_score: + type: number + max_distance: + type: number + filter: + $ref: '#/components/schemas/_common.query_dsl:QueryContainer' _common.query_dsl:NumberRangeQuery: allOf: - $ref: '#/components/schemas/_common.query_dsl:RangeQueryBase' @@ -35833,8 +37610,8 @@ components: id: $ref: '#/components/schemas/_common:Id' ignore_unmapped: + $ref: '#/components/schemas/_common.query_dsl:IgnoreUnmapped' description: Indicates whether to ignore an unmapped `type` and not return any documents instead of an error. - type: boolean type: $ref: '#/components/schemas/_common:RelationName' _common.query_dsl:PercolateQuery: @@ -35989,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. @@ -36036,6 +37815,8 @@ components: $ref: '#/components/schemas/_common.query_dsl:MultiMatchQuery' nested: $ref: '#/components/schemas/_common.query_dsl:NestedQuery' + neural: + $ref: '#/components/schemas/_common.query_dsl:NeuralQuery' parent_id: $ref: '#/components/schemas/_common.query_dsl:ParentIdQuery' percolate: @@ -36106,7 +37887,9 @@ components: To return a document, the query term must exactly match the queried field's value, including whitespace and capitalization. type: object additionalProperties: - $ref: '#/components/schemas/_common.query_dsl:TermQuery' + anyOf: + - $ref: '#/components/schemas/_common.query_dsl:TermQuery' + - $ref: '#/components/schemas/_common:FieldValue' minProperties: 1 maxProperties: 1 terms: @@ -36382,8 +38165,7 @@ components: - type: object properties: ignore_unmapped: - description: When set to `true` the query ignores an unmapped field and will not match any documents. - type: boolean + $ref: '#/components/schemas/_common.query_dsl:IgnoreUnmapped' _common.query_dsl:SimpleQueryStringFlag: type: string enum: @@ -36401,7 +38183,7 @@ components: - SLOP - WHITESPACE _common.query_dsl:SimpleQueryStringFlags: - description: Query flags can be either a single flag or a combination of flags, e.g. `OR|AND|PREFIX` + description: Query flags can be either a single flag or a combination of flags, e.g. `OR|AND|PREFIX`. allOf: - $ref: '#/components/schemas/_common:PipeSeparatedFlagsSimpleQueryStringFlag' _common.query_dsl:SimpleQueryStringQuery: @@ -37169,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 @@ -38714,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: @@ -39541,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' @@ -40626,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: @@ -40637,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: @@ -40671,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. @@ -41049,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 @@ -41231,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: @@ -41244,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: @@ -41300,7 +43295,6 @@ components: - count - discovery_types - fs - - indexing_pressure - ingest - jvm - network_types @@ -41582,7 +43576,6 @@ components: type: string required: - count - - flavor - type cluster.stats:OperatingSystemMemoryInfo: type: object @@ -41704,6 +43697,8 @@ components: type: string index_uuid: type: string + creation_date: + $ref: '#/components/schemas/_common:DateTime' creation_date_millis: $ref: '#/components/schemas/_common:EpochTimeUnitMillis' node_ids: @@ -42053,6 +44048,7 @@ components: $ref: '#/components/schemas/_common:Stringifiedboolean' indices._common:IndexSettings: type: object + description: The index settings to be updated. properties: index: $ref: '#/components/schemas/indices._common:IndexSettings' @@ -42183,7 +44179,6 @@ components: store: $ref: '#/components/schemas/indices._common:Storage' additionalProperties: {} - description: The index settings to be updated indices._common:IndexSettingsAnalysis: type: object properties: @@ -42297,7 +44292,7 @@ components: $ref: '#/components/schemas/indices._common:IndexTemplateDataStreamConfiguration' required: - index_patterns - description: New index template definition to be simulated, if no index template name is specified + description: New index template definition to be simulated, if no index template name is specified. indices._common:IndexTemplateDataStreamConfiguration: type: object properties: @@ -43389,83 +45384,89 @@ components: - aliases - mappings - settings - indices.stats:IndexMetadataState: - type: string - enum: - - close - - open + indices.stats:AllIndicesStats: + type: object + properties: + primaries: + $ref: '#/components/schemas/indices.stats:IndexStats' + total: + $ref: '#/components/schemas/indices.stats:IndexStats' + required: + - primaries + - total + indices.stats:IndexShardStats: + allOf: + - $ref: '#/components/schemas/indices.stats:IndexStatsBase' + - type: object + properties: + routing: + $ref: '#/components/schemas/indices.stats:ShardRouting' + commit: + $ref: '#/components/schemas/indices.stats:ShardCommit' + seq_no: + $ref: '#/components/schemas/indices.stats:ShardSequenceNumber' + retention_leases: + $ref: '#/components/schemas/indices.stats:ShardRetentionLeases' + shard_path: + $ref: '#/components/schemas/indices.stats:ShardPath' indices.stats:IndexStats: + allOf: + - $ref: '#/components/schemas/indices.stats:IndexStatsBase' + - type: object + indices.stats:IndexStatsBase: type: object properties: - completion: - $ref: '#/components/schemas/_common:CompletionStats' docs: $ref: '#/components/schemas/_common:DocStats' - fielddata: - $ref: '#/components/schemas/_common:FielddataStats' - flush: - $ref: '#/components/schemas/_common:FlushStats' - get: - $ref: '#/components/schemas/_common:GetStats' + store: + $ref: '#/components/schemas/_common:StoreStats' indexing: $ref: '#/components/schemas/_common:IndexingStats' - indices: - $ref: '#/components/schemas/indices.stats:IndicesStats' + get: + $ref: '#/components/schemas/_common:GetStats' + search: + $ref: '#/components/schemas/_common:SearchStats' merges: $ref: '#/components/schemas/_common:MergesStats' - query_cache: - $ref: '#/components/schemas/_common:QueryCacheStats' - recovery: - $ref: '#/components/schemas/_common:RecoveryStats' refresh: $ref: '#/components/schemas/_common:RefreshStats' - request_cache: - $ref: '#/components/schemas/_common:RequestCacheStats' - search: - $ref: '#/components/schemas/_common:SearchStats' + flush: + $ref: '#/components/schemas/_common:FlushStats' + warmer: + $ref: '#/components/schemas/_common:WarmerStats' + query_cache: + $ref: '#/components/schemas/_common:QueryCacheStats' + fielddata: + $ref: '#/components/schemas/_common:FielddataStats' + completion: + $ref: '#/components/schemas/_common:CompletionStats' segments: $ref: '#/components/schemas/_common:SegmentsStats' - store: - $ref: '#/components/schemas/_common:StoreStats' translog: $ref: '#/components/schemas/_common:TranslogStats' - warmer: - $ref: '#/components/schemas/_common:WarmerStats' - bulk: - $ref: '#/components/schemas/_common:BulkStats' - shard_stats: - $ref: '#/components/schemas/indices.stats:ShardsTotalStats' + request_cache: + $ref: '#/components/schemas/_common:RequestCacheStats' + recovery: + $ref: '#/components/schemas/_common:RecoveryStats' indices.stats:IndicesStats: type: object properties: + uuid: + $ref: '#/components/schemas/_common:Uuid' primaries: $ref: '#/components/schemas/indices.stats:IndexStats' + total: + $ref: '#/components/schemas/indices.stats:IndexStats' shards: type: object additionalProperties: type: array items: - $ref: '#/components/schemas/indices.stats:ShardStats' - total: - $ref: '#/components/schemas/indices.stats:IndexStats' - uuid: - $ref: '#/components/schemas/_common:Uuid' - health: - $ref: '#/components/schemas/_common:HealthStatus' - status: - $ref: '#/components/schemas/indices.stats:IndexMetadataState' - indices.stats:MappingStats: - type: object - properties: - total_count: - type: number - total_estimated_overhead: - $ref: '#/components/schemas/_common:ByteSize' - total_estimated_overhead_in_bytes: - type: number + $ref: '#/components/schemas/indices.stats:IndexShardStats' required: - - total_count - - total_estimated_overhead_in_bytes + - primaries + - total + - uuid indices.stats:ShardCommit: type: object properties: @@ -43531,31 +45532,6 @@ components: - data_path - is_custom_data_path - state_path - indices.stats:ShardQueryCache: - type: object - properties: - cache_count: - type: number - cache_size: - type: number - evictions: - type: number - hit_count: - type: number - memory_size_in_bytes: - type: number - miss_count: - type: number - total_count: - type: number - required: - - cache_count - - cache_size - - evictions - - hit_count - - memory_size_in_bytes - - miss_count - - total_count indices.stats:ShardRetentionLeases: type: object properties: @@ -43608,70 +45584,6 @@ components: - global_checkpoint - local_checkpoint - max_seq_no - indices.stats:ShardStats: - type: object - properties: - commit: - $ref: '#/components/schemas/indices.stats:ShardCommit' - completion: - $ref: '#/components/schemas/_common:CompletionStats' - docs: - $ref: '#/components/schemas/_common:DocStats' - fielddata: - $ref: '#/components/schemas/_common:FielddataStats' - flush: - $ref: '#/components/schemas/_common:FlushStats' - get: - $ref: '#/components/schemas/_common:GetStats' - indexing: - $ref: '#/components/schemas/_common:IndexingStats' - mappings: - $ref: '#/components/schemas/indices.stats:MappingStats' - merges: - $ref: '#/components/schemas/_common:MergesStats' - shard_path: - $ref: '#/components/schemas/indices.stats:ShardPath' - query_cache: - $ref: '#/components/schemas/indices.stats:ShardQueryCache' - recovery: - $ref: '#/components/schemas/_common:RecoveryStats' - refresh: - $ref: '#/components/schemas/_common:RefreshStats' - request_cache: - $ref: '#/components/schemas/_common:RequestCacheStats' - retention_leases: - $ref: '#/components/schemas/indices.stats:ShardRetentionLeases' - routing: - $ref: '#/components/schemas/indices.stats:ShardRouting' - search: - $ref: '#/components/schemas/_common:SearchStats' - segments: - $ref: '#/components/schemas/_common:SegmentsStats' - seq_no: - $ref: '#/components/schemas/indices.stats:ShardSequenceNumber' - store: - $ref: '#/components/schemas/_common:StoreStats' - translog: - $ref: '#/components/schemas/_common:TranslogStats' - warmer: - $ref: '#/components/schemas/_common:WarmerStats' - bulk: - $ref: '#/components/schemas/_common:BulkStats' - shards: - type: object - additionalProperties: - type: object - shard_stats: - $ref: '#/components/schemas/indices.stats:ShardsTotalStats' - indices: - $ref: '#/components/schemas/indices.stats:IndicesStats' - indices.stats:ShardsTotalStats: - type: object - properties: - total_count: - type: number - required: - - total_count indices.update_aliases:Action: type: object properties: @@ -44738,7 +46650,45 @@ components: required: - relation - value - ml._common:SearchModelHits: + ml._common:ModelGroup: + type: object + properties: + name: + type: string + description: The model group name. + latest_version: + type: number + description: The latest version. + description: + type: string + description: The model group description. + access: + type: string + description: The model group access. + created_time: + type: integer + format: int64 + last_updated_time: + type: integer + format: int64 + required: + - access + - description + - latest_version + - name + ml._common:ModelGroupRegistration: + type: object + properties: + model_group_id: + type: string + description: The model group ID. + status: + type: string + description: The status. + required: + - model_group_id + - status + ml._common:SearchModelsHits: type: object properties: total: @@ -44746,11 +46696,11 @@ components: hits: type: array items: - $ref: '#/components/schemas/ml._common:SearchModelHitsHit' + $ref: '#/components/schemas/ml._common:SearchModelsHitsHit' required: - hits - total - ml._common:SearchModelHitsHit: + ml._common:SearchModelsHitsHit: type: object properties: _index: @@ -44765,6 +46715,78 @@ components: required: - _id - model_id + ml._common:SearchModelsQuery: + type: object + properties: + query: + type: object + description: The query. + size: + type: integer + description: The number of models to return. + required: + - query + - size + ml._common:SearchModelsResponse: + type: object + properties: + hits: + $ref: '#/components/schemas/ml._common:SearchModelsHits' + required: + - hits + ml._common:Task: + type: object + properties: + model_id: + type: string + task_id: + type: string + state: + type: string + enum: + - CANCELLED + - COMPLETED + - COMPLETED_WITH_ERROR + - CREATED + - FAILED + - RUNNING + task_type: + type: string + description: Task type. + enum: + - DEPLOY_MODEL + - REGISTER_MODEL + function_name: + type: string + worker_node: + type: array + items: + $ref: '#/components/schemas/_common:NodeIds' + create_time: + type: integer + format: int64 + last_update_time: + type: integer + format: int64 + is_async: + type: boolean + error: + type: string + required: + - state + ml._common:UndeployModelNode: + type: object + properties: + stats: + $ref: '#/components/schemas/ml._common:UndeployModelNodeStats' + ml._common:UndeployModelNodeStats: + type: object + additionalProperties: true + ml._common:UndeployModelResponse: + type: object + additionalProperties: + title: nodes + $ref: '#/components/schemas/ml._common:UndeployModelNode' nodes._common:AdaptiveSelection: type: object properties: @@ -45244,6 +47266,14 @@ components: write_operations: description: The total number of write operations for the device completed since starting OpenSearch. type: number + read_time: + type: number + write_time: + type: number + queue_size: + type: number + io_time_in_millis: + $ref: '#/components/schemas/_common:DurationValueUnitMillis' nodes._common:IoStats: type: object properties: @@ -45645,8 +47675,10 @@ components: type: boolean enforced: type: boolean + total_rejections_breakup: + $ref: '#/components/schemas/nodes._common:TotalRejectionsBreakup' total_rejections_breakup_shadow_mode: - $ref: '#/components/schemas/nodes._common:TotalRejectionsBreakupShadowMode' + $ref: '#/components/schemas/nodes._common:TotalRejectionsBreakup' nodes._common:ShardRepositoriesStats: type: array nodes._common:ShardResourceUsageStats: @@ -45691,6 +47723,10 @@ components: type: number cancellation_limit_reached_count: type: number + cancelled_task_percentage: + type: number + current_cancellation_eligible_tasks_count: + type: number nodes._common:ShardSearchBackpressureTaskResourceTrackerCpuUsageTrackerStats: type: object properties: @@ -45736,6 +47772,9 @@ components: $ref: '#/components/schemas/nodes._common:ShardSearchBackpressureTaskResourceTrackerStats' cancellation_stats: $ref: '#/components/schemas/nodes._common:ShardSearchBackpressureTaskCancellationStats' + completion_count: + x-version-added: '3.0' + type: number nodes._common:ShardSearchPipelineStats: type: object properties: @@ -45852,7 +47891,7 @@ components: indexing_pressure: $ref: '#/components/schemas/nodes._common:IndexingPressure' indices: - $ref: '#/components/schemas/indices.stats:ShardStats' + $ref: '#/components/schemas/indices.stats:IndexShardStats' shard_indexing_pressure: $ref: '#/components/schemas/nodes._common:ShardIndexingPressureStats' search_backpressure: @@ -45901,7 +47940,7 @@ components: The total amount of time that tasks spend waiting in the thread pool queue. Currently, only `search`, `search_throttled`, and `index_searcher` thread pools support this metric. type: number - nodes._common:TotalRejectionsBreakupShadowMode: + nodes._common:TotalRejectionsBreakup: type: object properties: node_limits: @@ -46065,14 +48104,10 @@ components: search_pipelines: $ref: '#/components/schemas/nodes.info:NodeInfoSearchPipelines' required: - - attributes - build_hash - build_type - - host - - ip - name - roles - - transport_address - version nodes.info:NodeInfoAction: type: object @@ -46351,6 +48386,8 @@ components: $ref: '#/components/schemas/nodes.info:NodeInfoSettingsIngest' index: $ref: '#/components/schemas/nodes.info:NodeInfoSettingsIndex' + plugins: + $ref: '#/components/schemas/nodes.info:NodeInfoSettingsPlugins' required: - client - cluster @@ -46511,6 +48548,10 @@ components: required: - attr - name + nodes.info:NodeInfoSettingsPlugins: + type: object + additionalProperties: + $ref: '#/components/schemas/_common:FieldValue' nodes.info:NodeInfoSettingsTransport: type: object properties: @@ -46572,7 +48613,9 @@ components: bundled_jdk: type: boolean using_bundled_jdk: - type: boolean + type: + - boolean + - 'null' using_compressed_ordinary_object_pointers: oneOf: - type: boolean @@ -46583,16 +48626,9 @@ components: type: string required: - bundled_jdk - - gc_collectors - - input_arguments - mem - - memory_pools - pid - start_time_in_millis - - version - - vm_name - - vm_vendor - - vm_version nodes.info:NodeOperatingSystemInfo: type: object properties: @@ -46620,12 +48656,8 @@ components: swap: $ref: '#/components/schemas/nodes.info:NodeInfoMemory' required: - - arch - available_processors - - name - - pretty_name - refresh_interval_in_millis - - version nodes.info:NodeProcessInfo: type: object properties: @@ -47089,6 +49121,351 @@ components: $ref: '#/components/schemas/notifications._common:HeaderParamsMap' required: - url + observability._common:ErrorResponse: + type: object + properties: + root_cause: + type: array + items: + $ref: '#/components/schemas/observability._common:RootCause' + type: + type: string + example: status_exception + reason: + type: string + example: ObservabilityObject {objectId} not found + required: + - reason + - root_cause + - type + observability._common:NotFoundResponse: + type: object + properties: + error: + $ref: '#/components/schemas/observability._common:ErrorResponse' + status: + type: integer + example: 404 + required: + - error + - status + observability._common:ObservabilityObject: + type: object + properties: + objectId: + type: string + lastUpdatedTimeMs: + type: integer + createdTimeMs: + type: integer + tenant: + type: string + operationalPanel: + $ref: '#/components/schemas/observability._common:OperationalPanel' + savedVisualization: + $ref: '#/components/schemas/observability._common:SavedVisualization' + savedQuery: + $ref: '#/components/schemas/observability._common:SavedQuery' + required: + - objectId + - tenant + observability._common:ObservabilityObjectList: + type: object + properties: + startIndex: + type: integer + totalHits: + type: integer + totalHitRelation: + type: string + observabilityObjectList: + type: array + items: + $ref: '#/components/schemas/observability._common:ObservabilityObject' + required: + - observabilityObjectList + - startIndex + - totalHitRelation + - totalHits + observability._common:OperationalPanel: + type: object + properties: + name: + type: string + visualizations: + type: array + items: + $ref: '#/components/schemas/observability._common:Visualization' + timeRange: + $ref: '#/components/schemas/observability._common:TimeRange' + queryFilter: + $ref: '#/components/schemas/observability._common:QueryFilter' + applicationId: + type: string + required: + - applicationId + - name + - queryFilter + - timeRange + - visualizations + observability._common:QueryFilter: + type: object + properties: + query: + type: string + language: + type: string + required: + - language + - query + observability._common:RootCause: + type: object + properties: + type: + type: string + example: status_exception + reason: + type: string + example: ObservabilityObject {objectId} not found + required: + - reason + - type + observability._common:SavedQuery: + type: object + properties: + name: + type: string + description: + type: string + query: + type: string + selected_date_range: + $ref: '#/components/schemas/observability._common:SelectedDateRange' + selected_timestamp: + $ref: '#/components/schemas/observability._common:SelectedTimestamp' + selected_fields: + $ref: '#/components/schemas/observability._common:SelectedFields' + required: + - description + - name + - query + - selected_date_range + - selected_fields + - selected_timestamp + observability._common:SavedVisualization: + type: object + properties: + name: + type: string + description: + type: string + query: + type: string + type: + type: string + selected_date_range: + $ref: '#/components/schemas/observability._common:SelectedDateRange' + selected_timestamp: + $ref: '#/components/schemas/observability._common:SelectedTimestamp' + selected_fields: + $ref: '#/components/schemas/observability._common:SelectedFields' + required: + - description + - name + - query + - selected_date_range + - selected_fields + - selected_timestamp + - type + observability._common:SelectedDateRange: + type: object + properties: + start: + type: string + end: + type: string + text: + type: string + required: + - end + - start + - text + observability._common:SelectedFields: + type: object + properties: + text: + type: string + tokens: + type: array + items: + $ref: '#/components/schemas/observability._common:Token' + required: + - text + - tokens + observability._common:SelectedTimestamp: + type: object + properties: + name: + type: string + type: + type: string + required: + - name + - type + observability._common:TimeRange: + type: object + properties: + to: + type: string + from: + type: string + required: + - from + - to + observability._common:Token: + type: object + properties: + name: + type: string + type: + type: string + required: + - name + - type + observability._common:Visualization: + type: object + properties: + id: + type: string + savedVisualizationId: + type: string + x: + type: integer + y: + type: integer + w: + type: integer + h: + type: integer + required: + - h + - id + - savedVisualizationId + - w + - x + - y + query._common:Credentials: + type: object + properties: + username: + type: string + password: + type: string + required: + - password + - username + query._common:DataSource: + type: object + properties: + name: + type: string + description: + type: string + connector: + type: string + allowedRoles: + type: array + items: + type: string + properties: + type: object + additionalProperties: true + resultIndex: + type: string + status: + type: string + configuration: + $ref: '#/components/schemas/query._common:DataSourceConfiguration' + required: + - connector + - name + - properties + - resultIndex + - status + query._common:DataSourceConfiguration: + type: object + properties: + endpoint: + type: string + credentials: + $ref: '#/components/schemas/query._common:Credentials' + required: + - credentials + - endpoint + query._common:DataSourceList: + type: array + items: + $ref: '#/components/schemas/query._common:DataSource' + query._common:DataSourceNotFound: + type: object + properties: + error: + $ref: '#/components/schemas/query._common:ErrorResponse' + required: + - error + query._common:DataSourceRetrieve: + type: object + properties: + name: + type: string + description: + type: string + connector: + type: string + allowedRoles: + type: array + items: + type: string + properties: + type: object + additionalProperties: true + resultIndex: + type: string + status: + type: string + configuration: + $ref: '#/components/schemas/query._common:DataSourceConfiguration' + required: + - connector + - name + - properties + - resultIndex + - status + query._common:ErrorResponse: + type: object + properties: + root_cause: + type: array + items: + $ref: '#/components/schemas/query._common:RootCause' + type: + type: string + reason: + type: string + required: + - reason + - root_cause + - type + query._common:RootCause: + type: object + properties: + type: + type: string + reason: + type: string + required: + - reason + - type remote_store._common:RemoteStoreRestoreInfo: type: object properties: @@ -47298,6 +49675,21 @@ components: type: string target_field: type: string + search_pipeline._common:CollapseResponseProcessor: + type: object + properties: + tag: + type: string + description: + type: string + ignore_failure: + type: boolean + field: + type: string + context_prefix: + type: string + required: + - field search_pipeline._common:FilterQueryRequestProcessor: type: object properties: @@ -47309,6 +49701,13 @@ components: type: boolean query: $ref: '#/components/schemas/search_pipeline._common:UserDefinedObjectStructure' + search_pipeline._common:MLOpenSearchReranker: + type: object + properties: + model_id: + type: string + required: + - model_id search_pipeline._common:NeuralFieldMap: type: object additionalProperties: @@ -47353,6 +49752,30 @@ components: type: string required: - sample_factor + search_pipeline._common:PersonalizeSearchRankingResponseProcessor: + type: object + properties: + tag: + type: string + description: + type: string + ignore_failure: + type: boolean + campaign_arn: + type: string + recipe: + type: string + weight: + type: number + format: float + item_id_field: + type: string + iam_role_arn: + type: string + required: + - campaign_arn + - recipe + - weight search_pipeline._common:PhaseResultsProcessor: oneOf: - type: object @@ -47362,6 +49785,22 @@ components: $ref: '#/components/schemas/search_pipeline._common:NormalizationPhaseResultsProcessor' required: - normalization-processor + search_pipeline._common:RenameFieldResponseProcessor: + type: object + properties: + tag: + type: string + description: + type: string + ignore_failure: + type: boolean + field: + type: string + target_field: + type: string + required: + - field + - target_field search_pipeline._common:RequestProcessor: oneOf: - type: object @@ -47392,6 +49831,106 @@ components: $ref: '#/components/schemas/search_pipeline._common:OversampleRequestProcessor' required: - oversample + search_pipeline._common:RerankContext: + type: object + properties: + document_fields: + type: array + items: + type: string + required: + - document_fields + search_pipeline._common:RerankResponseProcessor: + type: object + properties: + tag: + type: string + description: + type: string + ignore_failure: + type: boolean + ml_opensearch: + $ref: '#/components/schemas/search_pipeline._common:MLOpenSearchReranker' + context: + $ref: '#/components/schemas/search_pipeline._common:RerankContext' + search_pipeline._common:ResponseProcessor: + oneOf: + - type: object + title: personalize_search_ranking + properties: + personalize_search_ranking: + $ref: '#/components/schemas/search_pipeline._common:PersonalizeSearchRankingResponseProcessor' + required: + - personalize_search_ranking + - type: object + title: retrieval_augmented_generation + properties: + retrieval_augmented_generation: + $ref: '#/components/schemas/search_pipeline._common:RetrievalAugmentedGenerationResponseProcessor' + required: + - retrieval_augmented_generation + - type: object + title: rename_field + properties: + rename_field: + $ref: '#/components/schemas/search_pipeline._common:RenameFieldResponseProcessor' + required: + - rename_field + - type: object + title: rerank + properties: + rerank: + $ref: '#/components/schemas/search_pipeline._common:RerankResponseProcessor' + required: + - rerank + - type: object + title: collapse + properties: + collapse: + $ref: '#/components/schemas/search_pipeline._common:CollapseResponseProcessor' + required: + - collapse + - type: object + title: truncate_hits + properties: + truncate_hits: + $ref: '#/components/schemas/search_pipeline._common:TruncateHitsResponseProcessor' + required: + - truncate_hits + - type: object + title: sort + properties: + sort: + $ref: '#/components/schemas/search_pipeline._common:SortResponseProcessor' + required: + - sort + - type: object + title: split + properties: + split: + $ref: '#/components/schemas/search_pipeline._common:SplitResponseProcessor' + required: + - split + search_pipeline._common:RetrievalAugmentedGenerationResponseProcessor: + type: object + properties: + tag: + type: string + description: + type: string + model_id: + type: string + context_field_list: + type: array + items: + type: string + system_prompt: + type: string + user_instructions: + type: string + required: + - context_field_list + - model_id search_pipeline._common:ScoreCombination: type: object properties: @@ -47435,7 +49974,7 @@ components: response_processors: type: array items: - $ref: '#/components/schemas/search_pipeline._common:RequestProcessor' + $ref: '#/components/schemas/search_pipeline._common:ResponseProcessor' phase_results_processors: type: array items: @@ -47455,6 +49994,57 @@ components: type: string required: - source + search_pipeline._common:SortResponseProcessor: + type: object + properties: + tag: + type: string + description: + type: string + ignore_failure: + type: boolean + field: + type: string + order: + type: string + target_field: + type: string + required: + - field + search_pipeline._common:SplitResponseProcessor: + type: object + properties: + tag: + type: string + description: + type: string + ignore_failure: + type: boolean + field: + type: string + separator: + type: string + preserve_trailing: + type: boolean + target_field: + type: string + required: + - field + - separator + search_pipeline._common:TruncateHitsResponseProcessor: + type: object + properties: + tag: + type: string + description: + type: string + ignore_failure: + type: boolean + target_size: + type: integer + format: int32 + context_prefix: + type: string search_pipeline._common:UserDefinedObjectStructure: type: object properties: @@ -47539,7 +50129,9 @@ components: is_internal_user: type: boolean user_requested_tenant: - type: string + type: + - 'null' + - string backend_roles: type: array items: @@ -47575,7 +50167,7 @@ components: type: object additionalProperties: $ref: '#/components/schemas/security._common:ActionGroup' - security._common:AllowConfig: + security._common:AllowListConfig: type: object properties: enabled: @@ -47583,11 +50175,6 @@ components: requests: type: object description: An object with APIs as key and array of http methods as values. - security._common:AllowListConfig: - type: object - properties: - config: - $ref: '#/components/schemas/security._common:AllowConfig' security._common:AuditConfig: type: object properties: @@ -47617,6 +50204,14 @@ components: type: array items: type: string + ignore_headers: + type: array + items: + type: string + ignore_url_params: + type: array + items: + type: string disabled_rest_categories: type: array items: @@ -47647,31 +50242,47 @@ components: type: string description: User's name. user_requested_tenant: - type: string + type: + - 'null' + - string description: Name of the tenant the user wants to switch to. remote_address: - type: string + type: + - 'null' + - string description: The IP address of remote user. backend_roles: type: array description: Backend roles associated with the user. + items: + type: string custom_attribute_names: type: array description: Name of the attributes associated with the user. + items: + type: string roles: type: array description: Roles associated with the user. + items: + type: string tenants: type: object description: Tenants the user has access to with read-write or read-only access indicator. principal: - type: string + type: + - 'null' + - string description: User principal. peer_certificates: - type: number + type: + - number + - string description: Number of peer certificates. sso_logout_url: - type: string + type: + - 'null' + - string description: Logout url. size_of_user: type: string @@ -47682,16 +50293,18 @@ components: size_of_backendroles: type: string description: Size of backend roles in bytes. - security._common:BadRequest: + security._common:CertificateCountPerNode: type: object properties: - status: - type: string - enum: - - 400 - message: - type: string - description: Message returned as part of BAD_REQUEST response. + total: + type: number + description: Total number of nodes. + successful: + type: number + description: Number of nodes for which certificates could be fetched. + failed: + type: number + description: Number of nodes for which certificates could not be fetched. security._common:CertificatesDetail: type: object properties: @@ -47705,6 +50318,31 @@ components: type: string not_after: type: string + security._common:CertificatesPerNode: + type: object + properties: + name: + type: string + description: Name of the node. + certificates: + type: object + additionalProperties: + $ref: '#/components/schemas/security._common:CertificateTypes' + security._common:CertificateTypes: + type: object + properties: + http: + type: array + items: + type: object + additionalProperties: + $ref: '#/components/schemas/security._common:CertificatesDetail' + transport: + type: array + items: + type: object + additionalProperties: + $ref: '#/components/schemas/security._common:CertificatesDetail' security._common:ChangePasswordRequestContent: type: object properties: @@ -47751,6 +50389,18 @@ components: config: type: array description: List of configs to be upgraded. + items: + type: string + security._common:Created: + type: object + properties: + status: + type: + - number + - string + message: + type: string + description: Message returned as part of CREATED response. security._common:CreateTenantParams: type: object properties: @@ -47786,6 +50436,8 @@ components: sign_in_options: type: array description: List of available sign-in options available. + items: + type: string password_validation_error_message: type: string description: Error message when password validation fails. @@ -47811,27 +50463,36 @@ components: security._common:DynamicOptions: type: object properties: - filteredAliasMode: + filtered_alias_mode: type: string - disableRestAuth: + disable_rest_auth: type: boolean - disableIntertransportAuth: + disable_intertransport_auth: type: boolean - respectRequestIndicesOptions: + respect_request_indices_options: type: boolean - kibana: {} - http: {} - authc: {} - authz: {} - authFailureListeners: {} - doNotFailOnForbidden: + opensearch-dashboards: + type: object + kibana: + type: object + http: + type: object + authc: + type: object + authz: + type: object + auth_failure_listeners: + type: object + do_not_fail_on_forbidden: type: boolean - multiRolespanEnabled: + multi_rolespan_enabled: type: boolean - hostsResolverMode: + hosts_resolver_mode: type: string - doNotFailOnForbiddenEmpty: + do_not_fail_on_forbidden_empty: type: boolean + on_behalf_of: + type: object security._common:GenerateOBOToken: type: object properties: @@ -47855,11 +50516,27 @@ components: type: array items: $ref: '#/components/schemas/security._common:CertificatesDetail' + security._common:GetCertificatesNew: + type: object + properties: + _nodes: + type: object + additionalProperties: + $ref: '#/components/schemas/security._common:CertificateCountPerNode' + cluster_name: + type: string + description: Name of this cluster. + nodes: + type: object + additionalProperties: + $ref: '#/components/schemas/security._common:CertificatesPerNode' security._common:HealthInfo: type: object properties: message: - type: string + type: + - 'null' + - string mode: type: string status: @@ -47891,16 +50568,6 @@ components: error: type: string description: Error message during request execution. - security._common:MethodNotImplemented: - type: object - properties: - status: - type: string - enum: - - 501 - message: - type: string - description: Message returned as part of NOT_IMPLEMENTED response. security._common:MultiTenancyConfig: type: object properties: @@ -47914,7 +50581,6 @@ components: type: array items: type: string - description: Value in seconds. security._common:OBOToken: type: object properties: @@ -47933,9 +50599,9 @@ components: type: object properties: status: - type: string - enum: - - 200 + type: + - number + - string message: type: string description: Message returned as part of OK response. @@ -48021,38 +50687,63 @@ components: type: object additionalProperties: $ref: '#/components/schemas/security._common:Role' + security._common:SecurityConfig: + type: object + properties: + config: + $ref: '#/components/schemas/security._common:DynamicConfig' security._common:SSLInfo: type: object properties: principal: - type: string + type: + - 'null' + - string description: User principal. peer_certificates: - type: number + type: + - number + - string description: Number of certificates. peer_certificates_list: - type: array + type: + - array + - 'null' description: List of domain names from peer certificates. + items: + type: string local_certificates_list: type: array description: List of domain names from local certificates. + items: + type: string ssl_protocol: - type: string + type: + - 'null' + - string description: Protocol for this ssl setup. ssl_cipher: - type: string + type: + - 'null' + - string description: Cipher for this ssl setup. ssl_openssl_available: type: boolean description: A boolean to indicate if OpenSSL is available. ssl_openssl_version: - type: string + type: + - number + - string description: Version of openssl. ssl_openssl_version_string: - type: string + type: + - 'null' + - string description: Full version string for openssl version. ssl_openssl_non_available_cause: - type: string + type: + - 'null' + - string description: Reason for openssl unavailability. ssl_openssl_supports_key_manager_factory: type: boolean @@ -48061,7 +50752,9 @@ components: type: boolean description: Indicates whether hostname validation is supported. ssl_provider_http: - type: string + type: + - 'null' + - string description: Returns http provider's name. ssl_provider_transport_server: type: string @@ -48069,6 +50762,20 @@ components: ssl_provider_transport_client: type: string description: Returns transport client's name. + required: + - peer_certificates + - principal + - ssl_cipher + - ssl_openssl_available + - ssl_openssl_non_available_cause + - ssl_openssl_supports_hostname_validation + - ssl_openssl_supports_key_manager_factory + - ssl_openssl_version + - ssl_openssl_version_string + - ssl_protocol + - ssl_provider_http + - ssl_provider_transport_client + - ssl_provider_transport_server security._common:Tenant: type: object properties: @@ -48099,16 +50806,6 @@ components: type: object additionalProperties: $ref: '#/components/schemas/security._common:Tenant' - security._common:Unauthorized: - type: object - properties: - status: - type: string - enum: - - 403 - message: - type: string - description: Message returned as part of FORBIDDEN response. security._common:UpgradeCheck: type: object properties: @@ -48128,6 +50825,8 @@ components: security._common:User: type: object properties: + password: + type: string hash: type: string reserved: @@ -48169,11 +50868,13 @@ components: type: object properties: dn: - type: string + type: + - 'null' + - string is_admin: - type: string + type: boolean is_node_certificate_request: - type: string + type: boolean snapshot._common:FileCountSnapshotStats: type: object properties: @@ -48497,6 +51198,168 @@ components: $ref: '#/components/schemas/_common:Name' required: - name + sql._common:Cursor: + type: object + properties: + keep_alive: + type: string + sql._common:Explain: + type: object + properties: + query: + type: string + filter: + type: object + fetch_size: + type: integer + sql._common:ExplainBody: + type: object + properties: + name: + type: string + description: + type: object + children: + type: array + items: + $ref: '#/components/schemas/sql._common:ExplainBody' + sql._common:ExplainResponse: + type: object + properties: + root: + $ref: '#/components/schemas/sql._common:ExplainBody' + sql._common:Plugins: + type: object + properties: + ppl: + $ref: '#/components/schemas/sql._common:Ppl' + query: + $ref: '#/components/schemas/sql._common:PluginsQuery' + sql: + $ref: '#/components/schemas/sql._common:Sql' + sql._common:PluginsQuery: + type: object + properties: + memory_limit: + type: string + size_limit: + anyOf: + - type: string + - type: integer + sql._common:Ppl: + type: object + properties: + enabled: + anyOf: + - type: boolean + - type: string + sql._common:Query: + type: object + properties: + query: + type: string + filter: + type: object + fetch_size: + type: integer + sql._common:QueryResponse: + type: object + properties: + schema: + type: array + items: + type: object + datarows: + type: array + items: + type: array + cursor: + type: string + total: + type: integer + size: + type: integer + status: + type: integer + sql._common:Sql: + type: object + properties: + enabled: + anyOf: + - type: boolean + - type: string + slowlog: + anyOf: + - type: integer + - type: string + cursor: + $ref: '#/components/schemas/sql._common:Cursor' + sql._common:SqlClose: + type: object + properties: + cursor: + type: string + sql._common:SqlCloseResponse: + type: object + properties: + succeeded: + type: boolean + sql._common:SqlSettings: + type: object + properties: + transient: + $ref: '#/components/schemas/sql._common:Transient' + sql._common:SqlSettingsPlain: + type: object + properties: + transient: + $ref: '#/components/schemas/sql._common:TransientPlain' + sql._common:SqlSettingsResponse: + type: object + properties: + acknowledged: + type: boolean + persistent: + type: object + transient: + $ref: '#/components/schemas/sql._common:Transient' + sql._common:Stats: + type: object + properties: + start_time: + type: string + end_time: + type: object + cluster_name: + type: object + index: + type: object + query: + type: object + user: + type: object + execution_time: + type: object + sql._common:Transient: + type: object + properties: + plugins: + $ref: '#/components/schemas/sql._common:Plugins' + sql._common:TransientPlain: + type: object + properties: + plugins.sql.enabled: + type: boolean + plugins.ppl.enabled: + type: boolean + plugins.sql.slowlog: + type: integer + plugins.sql.cursor.keep_alive: + type: string + plugins.query.memory_limit: + type: string + plugins.query.size_limit: + type: integer tasks._common:GroupBy: type: string enum: