From cb4eaa7b9339140a39c22ae1108f5ddbfabc3006 Mon Sep 17 00:00:00 2001 From: Thomas Farr Date: Tue, 26 Nov 2024 10:27:01 +1300 Subject: [PATCH] Fix codegen (#860) Signed-off-by: Thomas Farr --- src/ApiGenerator/Domain/Code/CsharpNames.cs | 2 +- .../Generator/ApiEndpointFactory.cs | 10 +- src/ApiGenerator/opensearch-openapi.yaml | 34529 +++++++++------- .../_Generated/ApiUrlsLookup.cs | 9 +- .../_Generated/Descriptors.Cat.cs | 130 +- .../_Generated/Descriptors.Cluster.cs | 112 +- .../_Generated/Descriptors.DanglingIndices.cs | 8 +- .../_Generated/Descriptors.Indices.cs | 230 +- .../_Generated/Descriptors.Ingest.cs | 16 +- .../_Generated/Descriptors.NoNamespace.cs | 138 +- .../_Generated/Descriptors.Nodes.cs | 18 +- .../_Generated/Descriptors.Snapshot.cs | 50 +- .../_Generated/OpenSearchClient.Cat.cs | 16 +- .../_Generated/Requests.Cat.cs | 120 +- .../_Generated/Requests.Cluster.cs | 132 +- .../_Generated/Requests.DanglingIndices.cs | 8 +- .../_Generated/Requests.Indices.cs | 268 +- .../_Generated/Requests.Ingest.cs | 25 +- .../_Generated/Requests.NoNamespace.cs | 146 +- .../_Generated/Requests.Nodes.cs | 10 +- .../_Generated/Requests.Snapshot.cs | 54 +- src/OpenSearch.Net/_Generated/Api/Enums.cs | 127 + .../RequestParameters.Cat.cs | 120 +- .../RequestParameters.Cluster.cs | 102 +- .../RequestParameters.DanglingIndices.cs | 8 +- .../RequestParameters.FlowFramework.cs | 4 +- .../RequestParameters.Indices.cs | 312 +- .../RequestParameters.Ingest.cs | 25 +- .../RequestParameters.Insights.cs | 69 + .../RequestParameters.Ism.cs | 8 +- .../RequestParameters.Knn.cs | 18 +- .../RequestParameters.List.cs | 285 + .../RequestParameters.NoNamespace.cs | 168 +- .../RequestParameters.Nodes.cs | 10 +- .../RequestParameters.Ppl.cs | 8 +- .../RequestParameters.Replication.cs | 137 + .../RequestParameters.Security.cs | 10 +- .../RequestParameters.Snapshot.cs | 54 +- .../RequestParameters.Sql.cs | 12 +- .../RequestParameters.Wlm.cs | 86 + .../_Generated/IOpenSearchLowLevelClient.cs | 92 +- .../OpenSearchLowLevelClient.Cat.cs | 24 +- .../OpenSearchLowLevelClient.Cluster.cs | 98 +- .../OpenSearchLowLevelClient.Indices.cs | 124 +- .../OpenSearchLowLevelClient.Insights.cs | 99 + .../OpenSearchLowLevelClient.Ism.cs | 24 +- .../OpenSearchLowLevelClient.Knn.cs | 4 +- .../OpenSearchLowLevelClient.List.cs | 208 + .../OpenSearchLowLevelClient.Nodes.cs | 24 +- .../OpenSearchLowLevelClient.Replication.cs | 465 + .../OpenSearchLowLevelClient.Security.cs | 8 +- .../OpenSearchLowLevelClient.Snapshot.cs | 4 +- .../OpenSearchLowLevelClient.Wlm.cs | 237 + .../_Generated/OpenSearchLowLevelClient.cs | 88 +- .../TaskManagement/GetTask/GetTaskApiTests.cs | 4 +- .../TasksList/TasksListApiTests.cs | 2 +- .../DeleteByQueryRethrottleApiTests.cs | 2 +- .../Multiple/MultiGet/GetManyApiTests.cs | 4 +- .../ReindexOnServerApiTests.cs | 8 +- .../ReindexOnServerPipelineApiTests.cs | 10 +- .../ReindexOnServerSliceApiTests.cs | 4 +- .../ReindexOnServerSourceApiTests.cs | 4 +- .../ReindexRethrottleApiTests.cs | 4 +- .../UpdateByQuery/UpdateByQueryApiTests.cs | 4 +- .../UpdateByQueryRethrottleApiTests.cs | 2 +- 65 files changed, 21717 insertions(+), 17424 deletions(-) create mode 100644 src/OpenSearch.Net/_Generated/Api/RequestParameters/RequestParameters.Insights.cs create mode 100644 src/OpenSearch.Net/_Generated/Api/RequestParameters/RequestParameters.List.cs create mode 100644 src/OpenSearch.Net/_Generated/Api/RequestParameters/RequestParameters.Replication.cs create mode 100644 src/OpenSearch.Net/_Generated/Api/RequestParameters/RequestParameters.Wlm.cs create mode 100644 src/OpenSearch.Net/_Generated/OpenSearchLowLevelClient.Insights.cs create mode 100644 src/OpenSearch.Net/_Generated/OpenSearchLowLevelClient.List.cs create mode 100644 src/OpenSearch.Net/_Generated/OpenSearchLowLevelClient.Replication.cs create mode 100644 src/OpenSearch.Net/_Generated/OpenSearchLowLevelClient.Wlm.cs diff --git a/src/ApiGenerator/Domain/Code/CsharpNames.cs b/src/ApiGenerator/Domain/Code/CsharpNames.cs index a100d0e54e..da5e9e9bb6 100644 --- a/src/ApiGenerator/Domain/Code/CsharpNames.cs +++ b/src/ApiGenerator/Domain/Code/CsharpNames.cs @@ -211,7 +211,7 @@ public string GenericOrNonGenericResponseName public static string GetEnumName(string schemaKey) { - var enumName = schemaKey.Replace("_common", "").SplitPascalCase().ToPascalCase(); + var enumName = schemaKey.Replace("_common", "").Replace("___", " ").SplitPascalCase().ToPascalCase(); if (GlobalOverrides.Instance.RenameEnums.TryGetValue(enumName, out var renamed)) enumName = renamed; return enumName; } diff --git a/src/ApiGenerator/Generator/ApiEndpointFactory.cs b/src/ApiGenerator/Generator/ApiEndpointFactory.cs index caa9066ccd..30a30f936a 100644 --- a/src/ApiGenerator/Generator/ApiEndpointFactory.cs +++ b/src/ApiGenerator/Generator/ApiEndpointFactory.cs @@ -237,6 +237,12 @@ private static string GetOpenSearchType(JsonSchema schema, Action if (oneOf.Length != 2) throw new Exception("Unable to determine type of oneOf"); + if (oneOf[0].Type == JsonObjectType.Boolean && oneOf[1].IsEnum()) + { + trackEnumToGenerate(schemaKey, isListContext); + return CsharpNames.GetEnumName(schemaKey) + "?"; + } + var first = GetOpenSearchType(oneOf[0], trackEnumToGenerate); var second = GetOpenSearchType(oneOf[1], trackEnumToGenerate); if (first.EndsWith("?")) return first; @@ -256,7 +262,7 @@ private static string GetOpenSearchType(JsonSchema schema, Action _ = GetOpenSearchType(schema.Item, trackEnumToGenerate, true); var types = Enum.GetValues() - .Where(t => t != JsonObjectType.None && schema.Type.HasFlag(t)) + .Where(t => t != JsonObjectType.None && t != JsonObjectType.Null && schema.Type.HasFlag(t)) .ToHashSet(); var type = types.Count switch @@ -271,7 +277,7 @@ 2 when types.Contains(JsonObjectType.Boolean) && types.Contains(JsonObjectType.S { 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 == @"^(?:(-1)|([0-9\.]+)(?:d|h|m|s|ms|micros|nanos))$" => "time", var t => t.ToString().ToLowerInvariant() }; } diff --git a/src/ApiGenerator/opensearch-openapi.yaml b/src/ApiGenerator/opensearch-openapi.yaml index 0b9dbb76d5..e7a7660fbc 100644 --- a/src/ApiGenerator/opensearch-openapi.yaml +++ b/src/ApiGenerator/opensearch-openapi.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: title: OpenSearch API Specification - version: 1.0.0 + version: 0.2.0 x-api-version: 2.16.0 paths: /: @@ -15,14 +15,14 @@ paths: externalDocs: url: https://opensearch.org/docs/latest 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' + - $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/info@200' + $ref: '#/components/responses/info___200' head: operationId: ping.0 x-operation-group: ping @@ -31,14 +31,14 @@ paths: externalDocs: url: https://opensearch.org/docs/latest 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' + - $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/ping@200' + $ref: '#/components/responses/ping___200' /_alias: get: operationId: indices.get_alias.0 @@ -48,20 +48,20 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/im-plugin/index-alias/ parameters: - - $ref: '#/components/parameters/indices.get_alias::query.allow_no_indices' - - $ref: '#/components/parameters/indices.get_alias::query.expand_wildcards' - - $ref: '#/components/parameters/indices.get_alias::query.ignore_unavailable' - - $ref: '#/components/parameters/indices.get_alias::query.local' - - $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' + - $ref: '#/components/parameters/indices.get_alias___query.allow_no_indices' + - $ref: '#/components/parameters/indices.get_alias___query.expand_wildcards' + - $ref: '#/components/parameters/indices.get_alias___query.ignore_unavailable' + - $ref: '#/components/parameters/indices.get_alias___query.local' + - $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/indices.get_alias@200' + $ref: '#/components/responses/indices.get_alias___200' '404': - $ref: '#/components/responses/indices.get_alias@404' + $ref: '#/components/responses/indices.get_alias___404' put: operationId: indices.put_alias.0 x-operation-group: indices.put_alias @@ -70,19 +70,19 @@ paths: externalDocs: 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' - - $ref: '#/components/parameters/indices.put_alias::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' + - $ref: '#/components/parameters/indices.put_alias___query.cluster_manager_timeout' + - $ref: '#/components/parameters/indices.put_alias___query.master_timeout' + - $ref: '#/components/parameters/indices.put_alias___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' requestBody: $ref: '#/components/requestBodies/indices.put_alias' responses: '200': - $ref: '#/components/responses/indices.put_alias@200' + $ref: '#/components/responses/indices.put_alias___200' /_alias/{name}: get: operationId: indices.get_alias.1 @@ -92,21 +92,21 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/im-plugin/index-alias/ parameters: - - $ref: '#/components/parameters/indices.get_alias::path.name' - - $ref: '#/components/parameters/indices.get_alias::query.allow_no_indices' - - $ref: '#/components/parameters/indices.get_alias::query.expand_wildcards' - - $ref: '#/components/parameters/indices.get_alias::query.ignore_unavailable' - - $ref: '#/components/parameters/indices.get_alias::query.local' - - $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' + - $ref: '#/components/parameters/indices.get_alias___path.name' + - $ref: '#/components/parameters/indices.get_alias___query.allow_no_indices' + - $ref: '#/components/parameters/indices.get_alias___query.expand_wildcards' + - $ref: '#/components/parameters/indices.get_alias___query.ignore_unavailable' + - $ref: '#/components/parameters/indices.get_alias___query.local' + - $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/indices.get_alias@200' + $ref: '#/components/responses/indices.get_alias___200' '404': - $ref: '#/components/responses/indices.get_alias@404' + $ref: '#/components/responses/indices.get_alias___404' head: operationId: indices.exists_alias.0 x-operation-group: indices.exists_alias @@ -115,21 +115,21 @@ paths: externalDocs: url: https://opensearch.org/docs/latest parameters: - - $ref: '#/components/parameters/indices.exists_alias::path.name' - - $ref: '#/components/parameters/indices.exists_alias::query.allow_no_indices' - - $ref: '#/components/parameters/indices.exists_alias::query.expand_wildcards' - - $ref: '#/components/parameters/indices.exists_alias::query.ignore_unavailable' - - $ref: '#/components/parameters/indices.exists_alias::query.local' - - $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' + - $ref: '#/components/parameters/indices.exists_alias___path.name' + - $ref: '#/components/parameters/indices.exists_alias___query.allow_no_indices' + - $ref: '#/components/parameters/indices.exists_alias___query.expand_wildcards' + - $ref: '#/components/parameters/indices.exists_alias___query.ignore_unavailable' + - $ref: '#/components/parameters/indices.exists_alias___query.local' + - $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/indices.exists_alias@200' + $ref: '#/components/responses/indices.exists_alias___200' '404': - $ref: '#/components/responses/indices.exists_alias@404' + $ref: '#/components/responses/indices.exists_alias___404' post: operationId: indices.put_alias.1 x-operation-group: indices.put_alias @@ -138,20 +138,20 @@ paths: externalDocs: 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' - - $ref: '#/components/parameters/indices.put_alias::query.master_timeout' - - $ref: '#/components/parameters/indices.put_alias::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' + - $ref: '#/components/parameters/indices.put_alias___path.name' + - $ref: '#/components/parameters/indices.put_alias___query.cluster_manager_timeout' + - $ref: '#/components/parameters/indices.put_alias___query.master_timeout' + - $ref: '#/components/parameters/indices.put_alias___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' requestBody: $ref: '#/components/requestBodies/indices.put_alias' responses: '200': - $ref: '#/components/responses/indices.put_alias@200' + $ref: '#/components/responses/indices.put_alias___200' put: operationId: indices.put_alias.2 x-operation-group: indices.put_alias @@ -160,20 +160,20 @@ paths: externalDocs: 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' - - $ref: '#/components/parameters/indices.put_alias::query.master_timeout' - - $ref: '#/components/parameters/indices.put_alias::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' + - $ref: '#/components/parameters/indices.put_alias___path.name' + - $ref: '#/components/parameters/indices.put_alias___query.cluster_manager_timeout' + - $ref: '#/components/parameters/indices.put_alias___query.master_timeout' + - $ref: '#/components/parameters/indices.put_alias___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' requestBody: $ref: '#/components/requestBodies/indices.put_alias' responses: '200': - $ref: '#/components/responses/indices.put_alias@200' + $ref: '#/components/responses/indices.put_alias___200' /_aliases: post: operationId: indices.update_aliases.0 @@ -183,19 +183,19 @@ paths: externalDocs: 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' - - $ref: '#/components/parameters/indices.update_aliases::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' + - $ref: '#/components/parameters/indices.update_aliases___query.cluster_manager_timeout' + - $ref: '#/components/parameters/indices.update_aliases___query.master_timeout' + - $ref: '#/components/parameters/indices.update_aliases___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' requestBody: $ref: '#/components/requestBodies/indices.update_aliases' responses: '200': - $ref: '#/components/responses/indices.update_aliases@200' + $ref: '#/components/responses/indices.update_aliases___200' /_aliases/{name}: post: operationId: indices.put_alias.3 @@ -205,20 +205,20 @@ paths: externalDocs: 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' - - $ref: '#/components/parameters/indices.put_alias::query.master_timeout' - - $ref: '#/components/parameters/indices.put_alias::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' + - $ref: '#/components/parameters/indices.put_alias___path.name' + - $ref: '#/components/parameters/indices.put_alias___query.cluster_manager_timeout' + - $ref: '#/components/parameters/indices.put_alias___query.master_timeout' + - $ref: '#/components/parameters/indices.put_alias___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' requestBody: $ref: '#/components/requestBodies/indices.put_alias' responses: '200': - $ref: '#/components/responses/indices.put_alias@200' + $ref: '#/components/responses/indices.put_alias___200' put: operationId: indices.put_alias.4 x-operation-group: indices.put_alias @@ -227,20 +227,20 @@ paths: externalDocs: 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' - - $ref: '#/components/parameters/indices.put_alias::query.master_timeout' - - $ref: '#/components/parameters/indices.put_alias::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' + - $ref: '#/components/parameters/indices.put_alias___path.name' + - $ref: '#/components/parameters/indices.put_alias___query.cluster_manager_timeout' + - $ref: '#/components/parameters/indices.put_alias___query.master_timeout' + - $ref: '#/components/parameters/indices.put_alias___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' requestBody: $ref: '#/components/requestBodies/indices.put_alias' responses: '200': - $ref: '#/components/responses/indices.put_alias@200' + $ref: '#/components/responses/indices.put_alias___200' /_analyze: get: operationId: indices.analyze.0 @@ -250,17 +250,17 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/analyze-apis/perform-text-analysis/ parameters: - - $ref: '#/components/parameters/indices.analyze::query.index' - - $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' + - $ref: '#/components/parameters/indices.analyze___query.index' + - $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/indices.analyze' responses: '200': - $ref: '#/components/responses/indices.analyze@200' + $ref: '#/components/responses/indices.analyze___200' post: operationId: indices.analyze.1 x-operation-group: indices.analyze @@ -269,17 +269,17 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/analyze-apis/perform-text-analysis/ parameters: - - $ref: '#/components/parameters/indices.analyze::query.index' - - $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' + - $ref: '#/components/parameters/indices.analyze___query.index' + - $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/indices.analyze' responses: '200': - $ref: '#/components/responses/indices.analyze@200' + $ref: '#/components/responses/indices.analyze___200' /_bulk: post: operationId: bulk.0 @@ -289,26 +289,26 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/document-apis/bulk/ parameters: - - $ref: '#/components/parameters/bulk::query._source' - - $ref: '#/components/parameters/bulk::query._source_excludes' - - $ref: '#/components/parameters/bulk::query._source_includes' - - $ref: '#/components/parameters/bulk::query.pipeline' - - $ref: '#/components/parameters/bulk::query.refresh' - - $ref: '#/components/parameters/bulk::query.require_alias' - - $ref: '#/components/parameters/bulk::query.routing' - - $ref: '#/components/parameters/bulk::query.timeout' - - $ref: '#/components/parameters/bulk::query.type' - - $ref: '#/components/parameters/bulk::query.wait_for_active_shards' - - $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' + - $ref: '#/components/parameters/bulk___query._source' + - $ref: '#/components/parameters/bulk___query._source_excludes' + - $ref: '#/components/parameters/bulk___query._source_includes' + - $ref: '#/components/parameters/bulk___query.pipeline' + - $ref: '#/components/parameters/bulk___query.refresh' + - $ref: '#/components/parameters/bulk___query.require_alias' + - $ref: '#/components/parameters/bulk___query.routing' + - $ref: '#/components/parameters/bulk___query.timeout' + - $ref: '#/components/parameters/bulk___query.type' + - $ref: '#/components/parameters/bulk___query.wait_for_active_shards' + - $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/bulk' responses: '200': - $ref: '#/components/responses/bulk@200' + $ref: '#/components/responses/bulk___200' put: operationId: bulk.1 x-operation-group: bulk @@ -317,26 +317,26 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/document-apis/bulk/ parameters: - - $ref: '#/components/parameters/bulk::query._source' - - $ref: '#/components/parameters/bulk::query._source_excludes' - - $ref: '#/components/parameters/bulk::query._source_includes' - - $ref: '#/components/parameters/bulk::query.pipeline' - - $ref: '#/components/parameters/bulk::query.refresh' - - $ref: '#/components/parameters/bulk::query.require_alias' - - $ref: '#/components/parameters/bulk::query.routing' - - $ref: '#/components/parameters/bulk::query.timeout' - - $ref: '#/components/parameters/bulk::query.type' - - $ref: '#/components/parameters/bulk::query.wait_for_active_shards' - - $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' + - $ref: '#/components/parameters/bulk___query._source' + - $ref: '#/components/parameters/bulk___query._source_excludes' + - $ref: '#/components/parameters/bulk___query._source_includes' + - $ref: '#/components/parameters/bulk___query.pipeline' + - $ref: '#/components/parameters/bulk___query.refresh' + - $ref: '#/components/parameters/bulk___query.require_alias' + - $ref: '#/components/parameters/bulk___query.routing' + - $ref: '#/components/parameters/bulk___query.timeout' + - $ref: '#/components/parameters/bulk___query.type' + - $ref: '#/components/parameters/bulk___query.wait_for_active_shards' + - $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/bulk' responses: '200': - $ref: '#/components/responses/bulk@200' + $ref: '#/components/responses/bulk___200' /_bulk/stream: post: operationId: bulk_stream.0 @@ -346,28 +346,28 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/document-apis/bulk-streaming/ parameters: - - $ref: '#/components/parameters/bulk_stream::query._source' - - $ref: '#/components/parameters/bulk_stream::query._source_excludes' - - $ref: '#/components/parameters/bulk_stream::query._source_includes' - - $ref: '#/components/parameters/bulk_stream::query.batch_interval' - - $ref: '#/components/parameters/bulk_stream::query.batch_size' - - $ref: '#/components/parameters/bulk_stream::query.pipeline' - - $ref: '#/components/parameters/bulk_stream::query.refresh' - - $ref: '#/components/parameters/bulk_stream::query.require_alias' - - $ref: '#/components/parameters/bulk_stream::query.routing' - - $ref: '#/components/parameters/bulk_stream::query.timeout' - - $ref: '#/components/parameters/bulk_stream::query.type' - - $ref: '#/components/parameters/bulk_stream::query.wait_for_active_shards' - - $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' + - $ref: '#/components/parameters/bulk_stream___query._source' + - $ref: '#/components/parameters/bulk_stream___query._source_excludes' + - $ref: '#/components/parameters/bulk_stream___query._source_includes' + - $ref: '#/components/parameters/bulk_stream___query.batch_interval' + - $ref: '#/components/parameters/bulk_stream___query.batch_size' + - $ref: '#/components/parameters/bulk_stream___query.pipeline' + - $ref: '#/components/parameters/bulk_stream___query.refresh' + - $ref: '#/components/parameters/bulk_stream___query.require_alias' + - $ref: '#/components/parameters/bulk_stream___query.routing' + - $ref: '#/components/parameters/bulk_stream___query.timeout' + - $ref: '#/components/parameters/bulk_stream___query.type' + - $ref: '#/components/parameters/bulk_stream___query.wait_for_active_shards' + - $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/bulk_stream' responses: '200': - $ref: '#/components/responses/bulk_stream@200' + $ref: '#/components/responses/bulk_stream___200' put: operationId: bulk_stream.1 x-operation-group: bulk_stream @@ -376,28 +376,28 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/document-apis/bulk-streaming/ parameters: - - $ref: '#/components/parameters/bulk_stream::query._source' - - $ref: '#/components/parameters/bulk_stream::query._source_excludes' - - $ref: '#/components/parameters/bulk_stream::query._source_includes' - - $ref: '#/components/parameters/bulk_stream::query.batch_interval' - - $ref: '#/components/parameters/bulk_stream::query.batch_size' - - $ref: '#/components/parameters/bulk_stream::query.pipeline' - - $ref: '#/components/parameters/bulk_stream::query.refresh' - - $ref: '#/components/parameters/bulk_stream::query.require_alias' - - $ref: '#/components/parameters/bulk_stream::query.routing' - - $ref: '#/components/parameters/bulk_stream::query.timeout' - - $ref: '#/components/parameters/bulk_stream::query.type' - - $ref: '#/components/parameters/bulk_stream::query.wait_for_active_shards' - - $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' + - $ref: '#/components/parameters/bulk_stream___query._source' + - $ref: '#/components/parameters/bulk_stream___query._source_excludes' + - $ref: '#/components/parameters/bulk_stream___query._source_includes' + - $ref: '#/components/parameters/bulk_stream___query.batch_interval' + - $ref: '#/components/parameters/bulk_stream___query.batch_size' + - $ref: '#/components/parameters/bulk_stream___query.pipeline' + - $ref: '#/components/parameters/bulk_stream___query.refresh' + - $ref: '#/components/parameters/bulk_stream___query.require_alias' + - $ref: '#/components/parameters/bulk_stream___query.routing' + - $ref: '#/components/parameters/bulk_stream___query.timeout' + - $ref: '#/components/parameters/bulk_stream___query.type' + - $ref: '#/components/parameters/bulk_stream___query.wait_for_active_shards' + - $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/bulk_stream' responses: '200': - $ref: '#/components/responses/bulk_stream@200' + $ref: '#/components/responses/bulk_stream___200' /_cache/clear: post: operationId: indices.clear_cache.0 @@ -406,27 +406,27 @@ paths: x-distributions-excluded: - amazon-managed - amazon-serverless - description: Clears all or specific caches for one or more indices. + description: Clears all or specific caches for one or more indexes. externalDocs: url: https://opensearch.org/docs/latest/api-reference/index-apis/clear-index-cache/ parameters: - - $ref: '#/components/parameters/indices.clear_cache::query.allow_no_indices' - - $ref: '#/components/parameters/indices.clear_cache::query.expand_wildcards' - - $ref: '#/components/parameters/indices.clear_cache::query.fielddata' - - $ref: '#/components/parameters/indices.clear_cache::query.fields' - - $ref: '#/components/parameters/indices.clear_cache::query.file' - - $ref: '#/components/parameters/indices.clear_cache::query.ignore_unavailable' - - $ref: '#/components/parameters/indices.clear_cache::query.index' - - $ref: '#/components/parameters/indices.clear_cache::query.query' - - $ref: '#/components/parameters/indices.clear_cache::query.request' - - $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/indices.clear_cache@200' + - $ref: '#/components/parameters/indices.clear_cache___query.allow_no_indices' + - $ref: '#/components/parameters/indices.clear_cache___query.expand_wildcards' + - $ref: '#/components/parameters/indices.clear_cache___query.fielddata' + - $ref: '#/components/parameters/indices.clear_cache___query.fields' + - $ref: '#/components/parameters/indices.clear_cache___query.file' + - $ref: '#/components/parameters/indices.clear_cache___query.ignore_unavailable' + - $ref: '#/components/parameters/indices.clear_cache___query.index' + - $ref: '#/components/parameters/indices.clear_cache___query.query' + - $ref: '#/components/parameters/indices.clear_cache___query.request' + - $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/indices.clear_cache___200' /_cat: get: operationId: cat.help.0 @@ -437,62 +437,62 @@ paths: url: https://opensearch.org/docs/latest/api-reference/cat/index/ responses: '200': - $ref: '#/components/responses/cat.help@200' + $ref: '#/components/responses/cat.help___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' + - $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' /_cat/aliases: get: operationId: cat.aliases.0 x-operation-group: cat.aliases x-version-added: '1.0' - description: Shows information about currently configured aliases to indices including filter and routing infos. + description: Shows information about currently configured aliases to indexes including filter and routing info. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-aliases/ parameters: - - $ref: '#/components/parameters/cat.aliases::query.expand_wildcards' - - $ref: '#/components/parameters/cat.aliases::query.format' - - $ref: '#/components/parameters/cat.aliases::query.h' - - $ref: '#/components/parameters/cat.aliases::query.help' - - $ref: '#/components/parameters/cat.aliases::query.local' - - $ref: '#/components/parameters/cat.aliases::query.s' - - $ref: '#/components/parameters/cat.aliases::query.v' - - $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/cat.aliases@200' + - $ref: '#/components/parameters/cat.aliases___query.expand_wildcards' + - $ref: '#/components/parameters/cat.aliases___query.format' + - $ref: '#/components/parameters/cat.aliases___query.h' + - $ref: '#/components/parameters/cat.aliases___query.help' + - $ref: '#/components/parameters/cat.aliases___query.local' + - $ref: '#/components/parameters/cat.aliases___query.s' + - $ref: '#/components/parameters/cat.aliases___query.v' + - $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/cat.aliases___200' /_cat/aliases/{name}: get: operationId: cat.aliases.1 x-operation-group: cat.aliases x-version-added: '1.0' - description: Shows information about currently configured aliases to indices including filter and routing infos. + description: Shows information about currently configured aliases to indexes including filter and routing info. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-aliases/ parameters: - - $ref: '#/components/parameters/cat.aliases::path.name' - - $ref: '#/components/parameters/cat.aliases::query.expand_wildcards' - - $ref: '#/components/parameters/cat.aliases::query.format' - - $ref: '#/components/parameters/cat.aliases::query.h' - - $ref: '#/components/parameters/cat.aliases::query.help' - - $ref: '#/components/parameters/cat.aliases::query.local' - - $ref: '#/components/parameters/cat.aliases::query.s' - - $ref: '#/components/parameters/cat.aliases::query.v' - - $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/cat.aliases@200' + - $ref: '#/components/parameters/cat.aliases___path.name' + - $ref: '#/components/parameters/cat.aliases___query.expand_wildcards' + - $ref: '#/components/parameters/cat.aliases___query.format' + - $ref: '#/components/parameters/cat.aliases___query.h' + - $ref: '#/components/parameters/cat.aliases___query.help' + - $ref: '#/components/parameters/cat.aliases___query.local' + - $ref: '#/components/parameters/cat.aliases___query.s' + - $ref: '#/components/parameters/cat.aliases___query.v' + - $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/cat.aliases___200' /_cat/allocation: get: operationId: cat.allocation.0 @@ -502,23 +502,23 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-allocation/ parameters: - - $ref: '#/components/parameters/cat.allocation::query.bytes' - - $ref: '#/components/parameters/cat.allocation::query.cluster_manager_timeout' - - $ref: '#/components/parameters/cat.allocation::query.format' - - $ref: '#/components/parameters/cat.allocation::query.h' - - $ref: '#/components/parameters/cat.allocation::query.help' - - $ref: '#/components/parameters/cat.allocation::query.local' - - $ref: '#/components/parameters/cat.allocation::query.master_timeout' - - $ref: '#/components/parameters/cat.allocation::query.s' - - $ref: '#/components/parameters/cat.allocation::query.v' - - $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/cat.allocation@200' + - $ref: '#/components/parameters/cat.allocation___query.bytes' + - $ref: '#/components/parameters/cat.allocation___query.cluster_manager_timeout' + - $ref: '#/components/parameters/cat.allocation___query.format' + - $ref: '#/components/parameters/cat.allocation___query.h' + - $ref: '#/components/parameters/cat.allocation___query.help' + - $ref: '#/components/parameters/cat.allocation___query.local' + - $ref: '#/components/parameters/cat.allocation___query.master_timeout' + - $ref: '#/components/parameters/cat.allocation___query.s' + - $ref: '#/components/parameters/cat.allocation___query.v' + - $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/cat.allocation___200' /_cat/allocation/{node_id}: get: operationId: cat.allocation.1 @@ -528,24 +528,24 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-allocation/ parameters: - - $ref: '#/components/parameters/cat.allocation::path.node_id' - - $ref: '#/components/parameters/cat.allocation::query.bytes' - - $ref: '#/components/parameters/cat.allocation::query.cluster_manager_timeout' - - $ref: '#/components/parameters/cat.allocation::query.format' - - $ref: '#/components/parameters/cat.allocation::query.h' - - $ref: '#/components/parameters/cat.allocation::query.help' - - $ref: '#/components/parameters/cat.allocation::query.local' - - $ref: '#/components/parameters/cat.allocation::query.master_timeout' - - $ref: '#/components/parameters/cat.allocation::query.s' - - $ref: '#/components/parameters/cat.allocation::query.v' - - $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/cat.allocation@200' + - $ref: '#/components/parameters/cat.allocation___path.node_id' + - $ref: '#/components/parameters/cat.allocation___query.bytes' + - $ref: '#/components/parameters/cat.allocation___query.cluster_manager_timeout' + - $ref: '#/components/parameters/cat.allocation___query.format' + - $ref: '#/components/parameters/cat.allocation___query.h' + - $ref: '#/components/parameters/cat.allocation___query.help' + - $ref: '#/components/parameters/cat.allocation___query.local' + - $ref: '#/components/parameters/cat.allocation___query.master_timeout' + - $ref: '#/components/parameters/cat.allocation___query.s' + - $ref: '#/components/parameters/cat.allocation___query.v' + - $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/cat.allocation___200' /_cat/cluster_manager: get: operationId: cat.cluster_manager.0 @@ -555,116 +555,116 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-cluster_manager/ parameters: - - $ref: '#/components/parameters/cat.cluster_manager::query.cluster_manager_timeout' - - $ref: '#/components/parameters/cat.cluster_manager::query.format' - - $ref: '#/components/parameters/cat.cluster_manager::query.h' - - $ref: '#/components/parameters/cat.cluster_manager::query.help' - - $ref: '#/components/parameters/cat.cluster_manager::query.local' - - $ref: '#/components/parameters/cat.cluster_manager::query.master_timeout' - - $ref: '#/components/parameters/cat.cluster_manager::query.s' - - $ref: '#/components/parameters/cat.cluster_manager::query.v' - - $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/cat.cluster_manager@200' + - $ref: '#/components/parameters/cat.cluster_manager___query.cluster_manager_timeout' + - $ref: '#/components/parameters/cat.cluster_manager___query.format' + - $ref: '#/components/parameters/cat.cluster_manager___query.h' + - $ref: '#/components/parameters/cat.cluster_manager___query.help' + - $ref: '#/components/parameters/cat.cluster_manager___query.local' + - $ref: '#/components/parameters/cat.cluster_manager___query.master_timeout' + - $ref: '#/components/parameters/cat.cluster_manager___query.s' + - $ref: '#/components/parameters/cat.cluster_manager___query.v' + - $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/cat.cluster_manager___200' /_cat/count: get: operationId: cat.count.0 x-operation-group: cat.count x-version-added: '1.0' - description: Provides quick access to the document count of the entire cluster, or individual indices. + description: Provides quick access to the document count of the entire cluster, or individual indexes. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-count/ parameters: - - $ref: '#/components/parameters/cat.count::query.format' - - $ref: '#/components/parameters/cat.count::query.h' - - $ref: '#/components/parameters/cat.count::query.help' - - $ref: '#/components/parameters/cat.count::query.s' - - $ref: '#/components/parameters/cat.count::query.v' - - $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' + - $ref: '#/components/parameters/cat.count___query.format' + - $ref: '#/components/parameters/cat.count___query.h' + - $ref: '#/components/parameters/cat.count___query.help' + - $ref: '#/components/parameters/cat.count___query.s' + - $ref: '#/components/parameters/cat.count___query.v' + - $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/cat.count@200' + $ref: '#/components/responses/cat.count___200' /_cat/count/{index}: get: operationId: cat.count.1 x-operation-group: cat.count x-version-added: '1.0' - description: Provides quick access to the document count of the entire cluster, or individual indices. + description: Provides quick access to the document count of the entire cluster, or individual indexes. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-count/ parameters: - - $ref: '#/components/parameters/cat.count::path.index' - - $ref: '#/components/parameters/cat.count::query.format' - - $ref: '#/components/parameters/cat.count::query.h' - - $ref: '#/components/parameters/cat.count::query.help' - - $ref: '#/components/parameters/cat.count::query.s' - - $ref: '#/components/parameters/cat.count::query.v' - - $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' + - $ref: '#/components/parameters/cat.count___path.index' + - $ref: '#/components/parameters/cat.count___query.format' + - $ref: '#/components/parameters/cat.count___query.h' + - $ref: '#/components/parameters/cat.count___query.help' + - $ref: '#/components/parameters/cat.count___query.s' + - $ref: '#/components/parameters/cat.count___query.v' + - $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/cat.count@200' + $ref: '#/components/responses/cat.count___200' /_cat/fielddata: get: operationId: cat.fielddata.0 x-operation-group: cat.fielddata x-version-added: '1.0' - description: Shows how much heap memory is currently being used by fielddata on every data node in the cluster. + description: Shows how much heap memory is currently being used by field data on every data node in the cluster. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-field-data/ parameters: - - $ref: '#/components/parameters/cat.fielddata::query.bytes' - - $ref: '#/components/parameters/cat.fielddata::query.fields' - - $ref: '#/components/parameters/cat.fielddata::query.format' - - $ref: '#/components/parameters/cat.fielddata::query.h' - - $ref: '#/components/parameters/cat.fielddata::query.help' - - $ref: '#/components/parameters/cat.fielddata::query.s' - - $ref: '#/components/parameters/cat.fielddata::query.v' - - $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/cat.fielddata@200' + - $ref: '#/components/parameters/cat.fielddata___query.bytes' + - $ref: '#/components/parameters/cat.fielddata___query.fields' + - $ref: '#/components/parameters/cat.fielddata___query.format' + - $ref: '#/components/parameters/cat.fielddata___query.h' + - $ref: '#/components/parameters/cat.fielddata___query.help' + - $ref: '#/components/parameters/cat.fielddata___query.s' + - $ref: '#/components/parameters/cat.fielddata___query.v' + - $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/cat.fielddata___200' /_cat/fielddata/{fields}: get: operationId: cat.fielddata.1 x-operation-group: cat.fielddata x-version-added: '1.0' - description: Shows how much heap memory is currently being used by fielddata on every data node in the cluster. + description: Shows how much heap memory is currently being used by field data on every data node in the cluster. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-field-data/ parameters: - - $ref: '#/components/parameters/cat.fielddata::path.fields' - - $ref: '#/components/parameters/cat.fielddata::query.bytes' - - $ref: '#/components/parameters/cat.fielddata::query.fields' - - $ref: '#/components/parameters/cat.fielddata::query.format' - - $ref: '#/components/parameters/cat.fielddata::query.h' - - $ref: '#/components/parameters/cat.fielddata::query.help' - - $ref: '#/components/parameters/cat.fielddata::query.s' - - $ref: '#/components/parameters/cat.fielddata::query.v' - - $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/cat.fielddata@200' + - $ref: '#/components/parameters/cat.fielddata___path.fields' + - $ref: '#/components/parameters/cat.fielddata___query.bytes' + - $ref: '#/components/parameters/cat.fielddata___query.fields' + - $ref: '#/components/parameters/cat.fielddata___query.format' + - $ref: '#/components/parameters/cat.fielddata___query.h' + - $ref: '#/components/parameters/cat.fielddata___query.help' + - $ref: '#/components/parameters/cat.fielddata___query.s' + - $ref: '#/components/parameters/cat.fielddata___query.v' + - $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/cat.fielddata___200' /_cat/health: get: operationId: cat.health.0 @@ -674,112 +674,112 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-health/ parameters: - - $ref: '#/components/parameters/cat.health::query.format' - - $ref: '#/components/parameters/cat.health::query.h' - - $ref: '#/components/parameters/cat.health::query.help' - - $ref: '#/components/parameters/cat.health::query.s' - - $ref: '#/components/parameters/cat.health::query.time' - - $ref: '#/components/parameters/cat.health::query.ts' - - $ref: '#/components/parameters/cat.health::query.v' - - $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/cat.health@200' + - $ref: '#/components/parameters/cat.health___query.format' + - $ref: '#/components/parameters/cat.health___query.h' + - $ref: '#/components/parameters/cat.health___query.help' + - $ref: '#/components/parameters/cat.health___query.s' + - $ref: '#/components/parameters/cat.health___query.time' + - $ref: '#/components/parameters/cat.health___query.ts' + - $ref: '#/components/parameters/cat.health___query.v' + - $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/cat.health___200' /_cat/indices: get: operationId: cat.indices.0 x-operation-group: cat.indices x-version-added: '1.0' - description: 'Returns information about indices: number of primaries and replicas, document counts, disk size, ...' + description: 'Returns information about indexes: number of primaries and replicas, document counts, disk size, ...' externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-indices/ parameters: - - $ref: '#/components/parameters/cat.indices::query.bytes' - - $ref: '#/components/parameters/cat.indices::query.cluster_manager_timeout' - - $ref: '#/components/parameters/cat.indices::query.expand_wildcards' - - $ref: '#/components/parameters/cat.indices::query.format' - - $ref: '#/components/parameters/cat.indices::query.h' - - $ref: '#/components/parameters/cat.indices::query.health' - - $ref: '#/components/parameters/cat.indices::query.help' - - $ref: '#/components/parameters/cat.indices::query.include_unloaded_segments' - - $ref: '#/components/parameters/cat.indices::query.local' - - $ref: '#/components/parameters/cat.indices::query.master_timeout' - - $ref: '#/components/parameters/cat.indices::query.pri' - - $ref: '#/components/parameters/cat.indices::query.s' - - $ref: '#/components/parameters/cat.indices::query.time' - - $ref: '#/components/parameters/cat.indices::query.v' - - $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/cat.indices@200' + - $ref: '#/components/parameters/cat.indices___query.bytes' + - $ref: '#/components/parameters/cat.indices___query.cluster_manager_timeout' + - $ref: '#/components/parameters/cat.indices___query.expand_wildcards' + - $ref: '#/components/parameters/cat.indices___query.format' + - $ref: '#/components/parameters/cat.indices___query.h' + - $ref: '#/components/parameters/cat.indices___query.health' + - $ref: '#/components/parameters/cat.indices___query.help' + - $ref: '#/components/parameters/cat.indices___query.include_unloaded_segments' + - $ref: '#/components/parameters/cat.indices___query.local' + - $ref: '#/components/parameters/cat.indices___query.master_timeout' + - $ref: '#/components/parameters/cat.indices___query.pri' + - $ref: '#/components/parameters/cat.indices___query.s' + - $ref: '#/components/parameters/cat.indices___query.time' + - $ref: '#/components/parameters/cat.indices___query.v' + - $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/cat.indices___200' /_cat/indices/{index}: get: operationId: cat.indices.1 x-operation-group: cat.indices x-version-added: '1.0' - description: 'Returns information about indices: number of primaries and replicas, document counts, disk size, ...' + description: 'Returns information about indexes: number of primaries and replicas, document counts, disk size, ...' externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-indices/ parameters: - - $ref: '#/components/parameters/cat.indices::path.index' - - $ref: '#/components/parameters/cat.indices::query.bytes' - - $ref: '#/components/parameters/cat.indices::query.cluster_manager_timeout' - - $ref: '#/components/parameters/cat.indices::query.expand_wildcards' - - $ref: '#/components/parameters/cat.indices::query.format' - - $ref: '#/components/parameters/cat.indices::query.h' - - $ref: '#/components/parameters/cat.indices::query.health' - - $ref: '#/components/parameters/cat.indices::query.help' - - $ref: '#/components/parameters/cat.indices::query.include_unloaded_segments' - - $ref: '#/components/parameters/cat.indices::query.local' - - $ref: '#/components/parameters/cat.indices::query.master_timeout' - - $ref: '#/components/parameters/cat.indices::query.pri' - - $ref: '#/components/parameters/cat.indices::query.s' - - $ref: '#/components/parameters/cat.indices::query.time' - - $ref: '#/components/parameters/cat.indices::query.v' - - $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/cat.indices@200' + - $ref: '#/components/parameters/cat.indices___path.index' + - $ref: '#/components/parameters/cat.indices___query.bytes' + - $ref: '#/components/parameters/cat.indices___query.cluster_manager_timeout' + - $ref: '#/components/parameters/cat.indices___query.expand_wildcards' + - $ref: '#/components/parameters/cat.indices___query.format' + - $ref: '#/components/parameters/cat.indices___query.h' + - $ref: '#/components/parameters/cat.indices___query.health' + - $ref: '#/components/parameters/cat.indices___query.help' + - $ref: '#/components/parameters/cat.indices___query.include_unloaded_segments' + - $ref: '#/components/parameters/cat.indices___query.local' + - $ref: '#/components/parameters/cat.indices___query.master_timeout' + - $ref: '#/components/parameters/cat.indices___query.pri' + - $ref: '#/components/parameters/cat.indices___query.s' + - $ref: '#/components/parameters/cat.indices___query.time' + - $ref: '#/components/parameters/cat.indices___query.v' + - $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/cat.indices___200' /_cat/master: get: operationId: cat.master.0 x-operation-group: cat.master deprecated: true - x-deprecation-message: To promote inclusive language, please use '/_cat/cluster_manager' instead. + x-deprecation-message: To promote inclusive language, use '/_cat/cluster_manager' instead. x-version-added: '1.0' x-version-deprecated: '2.0' description: Returns information about the cluster-manager node. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-cluster_manager/ parameters: - - $ref: '#/components/parameters/cat.master::query.cluster_manager_timeout' - - $ref: '#/components/parameters/cat.master::query.format' - - $ref: '#/components/parameters/cat.master::query.h' - - $ref: '#/components/parameters/cat.master::query.help' - - $ref: '#/components/parameters/cat.master::query.local' - - $ref: '#/components/parameters/cat.master::query.master_timeout' - - $ref: '#/components/parameters/cat.master::query.s' - - $ref: '#/components/parameters/cat.master::query.v' - - $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/cat.master@200' + - $ref: '#/components/parameters/cat.master___query.cluster_manager_timeout' + - $ref: '#/components/parameters/cat.master___query.format' + - $ref: '#/components/parameters/cat.master___query.h' + - $ref: '#/components/parameters/cat.master___query.help' + - $ref: '#/components/parameters/cat.master___query.local' + - $ref: '#/components/parameters/cat.master___query.master_timeout' + - $ref: '#/components/parameters/cat.master___query.s' + - $ref: '#/components/parameters/cat.master___query.v' + - $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/cat.master___200' /_cat/nodeattrs: get: operationId: cat.nodeattrs.0 @@ -792,22 +792,22 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-nodeattrs/ parameters: - - $ref: '#/components/parameters/cat.nodeattrs::query.cluster_manager_timeout' - - $ref: '#/components/parameters/cat.nodeattrs::query.format' - - $ref: '#/components/parameters/cat.nodeattrs::query.h' - - $ref: '#/components/parameters/cat.nodeattrs::query.help' - - $ref: '#/components/parameters/cat.nodeattrs::query.local' - - $ref: '#/components/parameters/cat.nodeattrs::query.master_timeout' - - $ref: '#/components/parameters/cat.nodeattrs::query.s' - - $ref: '#/components/parameters/cat.nodeattrs::query.v' - - $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/cat.nodeattrs@200' + - $ref: '#/components/parameters/cat.nodeattrs___query.cluster_manager_timeout' + - $ref: '#/components/parameters/cat.nodeattrs___query.format' + - $ref: '#/components/parameters/cat.nodeattrs___query.h' + - $ref: '#/components/parameters/cat.nodeattrs___query.help' + - $ref: '#/components/parameters/cat.nodeattrs___query.local' + - $ref: '#/components/parameters/cat.nodeattrs___query.master_timeout' + - $ref: '#/components/parameters/cat.nodeattrs___query.s' + - $ref: '#/components/parameters/cat.nodeattrs___query.v' + - $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/cat.nodeattrs___200' /_cat/nodes: get: operationId: cat.nodes.0 @@ -817,25 +817,25 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-nodes/ parameters: - - $ref: '#/components/parameters/cat.nodes::query.bytes' - - $ref: '#/components/parameters/cat.nodes::query.cluster_manager_timeout' - - $ref: '#/components/parameters/cat.nodes::query.format' - - $ref: '#/components/parameters/cat.nodes::query.full_id' - - $ref: '#/components/parameters/cat.nodes::query.h' - - $ref: '#/components/parameters/cat.nodes::query.help' - - $ref: '#/components/parameters/cat.nodes::query.local' - - $ref: '#/components/parameters/cat.nodes::query.master_timeout' - - $ref: '#/components/parameters/cat.nodes::query.s' - - $ref: '#/components/parameters/cat.nodes::query.time' - - $ref: '#/components/parameters/cat.nodes::query.v' - - $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/cat.nodes@200' + - $ref: '#/components/parameters/cat.nodes___query.bytes' + - $ref: '#/components/parameters/cat.nodes___query.cluster_manager_timeout' + - $ref: '#/components/parameters/cat.nodes___query.format' + - $ref: '#/components/parameters/cat.nodes___query.full_id' + - $ref: '#/components/parameters/cat.nodes___query.h' + - $ref: '#/components/parameters/cat.nodes___query.help' + - $ref: '#/components/parameters/cat.nodes___query.local' + - $ref: '#/components/parameters/cat.nodes___query.master_timeout' + - $ref: '#/components/parameters/cat.nodes___query.s' + - $ref: '#/components/parameters/cat.nodes___query.time' + - $ref: '#/components/parameters/cat.nodes___query.v' + - $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/cat.nodes___200' /_cat/pending_tasks: get: operationId: cat.pending_tasks.0 @@ -845,23 +845,23 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-pending-tasks/ parameters: - - $ref: '#/components/parameters/cat.pending_tasks::query.cluster_manager_timeout' - - $ref: '#/components/parameters/cat.pending_tasks::query.format' - - $ref: '#/components/parameters/cat.pending_tasks::query.h' - - $ref: '#/components/parameters/cat.pending_tasks::query.help' - - $ref: '#/components/parameters/cat.pending_tasks::query.local' - - $ref: '#/components/parameters/cat.pending_tasks::query.master_timeout' - - $ref: '#/components/parameters/cat.pending_tasks::query.s' - - $ref: '#/components/parameters/cat.pending_tasks::query.time' - - $ref: '#/components/parameters/cat.pending_tasks::query.v' - - $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/cat.pending_tasks@200' + - $ref: '#/components/parameters/cat.pending_tasks___query.cluster_manager_timeout' + - $ref: '#/components/parameters/cat.pending_tasks___query.format' + - $ref: '#/components/parameters/cat.pending_tasks___query.h' + - $ref: '#/components/parameters/cat.pending_tasks___query.help' + - $ref: '#/components/parameters/cat.pending_tasks___query.local' + - $ref: '#/components/parameters/cat.pending_tasks___query.master_timeout' + - $ref: '#/components/parameters/cat.pending_tasks___query.s' + - $ref: '#/components/parameters/cat.pending_tasks___query.time' + - $ref: '#/components/parameters/cat.pending_tasks___query.v' + - $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/cat.pending_tasks___200' /_cat/pit_segments: get: operationId: cat.pit_segments.0 @@ -871,22 +871,22 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/search-plugins/point-in-time-api/ parameters: - - $ref: '#/components/parameters/cat.pit_segments::query.bytes' - - $ref: '#/components/parameters/cat.pit_segments::query.format' - - $ref: '#/components/parameters/cat.pit_segments::query.h' - - $ref: '#/components/parameters/cat.pit_segments::query.help' - - $ref: '#/components/parameters/cat.pit_segments::query.s' - - $ref: '#/components/parameters/cat.pit_segments::query.v' - - $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' + - $ref: '#/components/parameters/cat.pit_segments___query.bytes' + - $ref: '#/components/parameters/cat.pit_segments___query.format' + - $ref: '#/components/parameters/cat.pit_segments___query.h' + - $ref: '#/components/parameters/cat.pit_segments___query.help' + - $ref: '#/components/parameters/cat.pit_segments___query.s' + - $ref: '#/components/parameters/cat.pit_segments___query.v' + - $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/cat.pit_segments' responses: '200': - $ref: '#/components/responses/cat.pit_segments@200' + $ref: '#/components/responses/cat.pit_segments___200' /_cat/pit_segments/_all: get: operationId: cat.all_pit_segments.0 @@ -896,20 +896,20 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/search-plugins/point-in-time-api/ parameters: - - $ref: '#/components/parameters/cat.all_pit_segments::query.bytes' - - $ref: '#/components/parameters/cat.all_pit_segments::query.format' - - $ref: '#/components/parameters/cat.all_pit_segments::query.h' - - $ref: '#/components/parameters/cat.all_pit_segments::query.help' - - $ref: '#/components/parameters/cat.all_pit_segments::query.s' - - $ref: '#/components/parameters/cat.all_pit_segments::query.v' - - $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' + - $ref: '#/components/parameters/cat.all_pit_segments___query.bytes' + - $ref: '#/components/parameters/cat.all_pit_segments___query.format' + - $ref: '#/components/parameters/cat.all_pit_segments___query.h' + - $ref: '#/components/parameters/cat.all_pit_segments___query.help' + - $ref: '#/components/parameters/cat.all_pit_segments___query.s' + - $ref: '#/components/parameters/cat.all_pit_segments___query.v' + - $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/cat.all_pit_segments@200' + $ref: '#/components/responses/cat.all_pit_segments___200' /_cat/plugins: get: operationId: cat.plugins.0 @@ -919,22 +919,22 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-plugins/ parameters: - - $ref: '#/components/parameters/cat.plugins::query.cluster_manager_timeout' - - $ref: '#/components/parameters/cat.plugins::query.format' - - $ref: '#/components/parameters/cat.plugins::query.h' - - $ref: '#/components/parameters/cat.plugins::query.help' - - $ref: '#/components/parameters/cat.plugins::query.local' - - $ref: '#/components/parameters/cat.plugins::query.master_timeout' - - $ref: '#/components/parameters/cat.plugins::query.s' - - $ref: '#/components/parameters/cat.plugins::query.v' - - $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/cat.plugins@200' + - $ref: '#/components/parameters/cat.plugins___query.cluster_manager_timeout' + - $ref: '#/components/parameters/cat.plugins___query.format' + - $ref: '#/components/parameters/cat.plugins___query.h' + - $ref: '#/components/parameters/cat.plugins___query.help' + - $ref: '#/components/parameters/cat.plugins___query.local' + - $ref: '#/components/parameters/cat.plugins___query.master_timeout' + - $ref: '#/components/parameters/cat.plugins___query.s' + - $ref: '#/components/parameters/cat.plugins___query.v' + - $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/cat.plugins___200' /_cat/recovery: get: operationId: cat.recovery.0 @@ -944,24 +944,24 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-plugins/ parameters: - - $ref: '#/components/parameters/cat.recovery::query.active_only' - - $ref: '#/components/parameters/cat.recovery::query.bytes' - - $ref: '#/components/parameters/cat.recovery::query.detailed' - - $ref: '#/components/parameters/cat.recovery::query.format' - - $ref: '#/components/parameters/cat.recovery::query.h' - - $ref: '#/components/parameters/cat.recovery::query.help' - - $ref: '#/components/parameters/cat.recovery::query.index' - - $ref: '#/components/parameters/cat.recovery::query.s' - - $ref: '#/components/parameters/cat.recovery::query.time' - - $ref: '#/components/parameters/cat.recovery::query.v' - - $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/cat.recovery@200' + - $ref: '#/components/parameters/cat.recovery___query.active_only' + - $ref: '#/components/parameters/cat.recovery___query.bytes' + - $ref: '#/components/parameters/cat.recovery___query.detailed' + - $ref: '#/components/parameters/cat.recovery___query.format' + - $ref: '#/components/parameters/cat.recovery___query.h' + - $ref: '#/components/parameters/cat.recovery___query.help' + - $ref: '#/components/parameters/cat.recovery___query.index' + - $ref: '#/components/parameters/cat.recovery___query.s' + - $ref: '#/components/parameters/cat.recovery___query.time' + - $ref: '#/components/parameters/cat.recovery___query.v' + - $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/cat.recovery___200' /_cat/recovery/{index}: get: operationId: cat.recovery.1 @@ -971,25 +971,25 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-plugins/ parameters: - - $ref: '#/components/parameters/cat.recovery::path.index' - - $ref: '#/components/parameters/cat.recovery::query.active_only' - - $ref: '#/components/parameters/cat.recovery::query.bytes' - - $ref: '#/components/parameters/cat.recovery::query.detailed' - - $ref: '#/components/parameters/cat.recovery::query.format' - - $ref: '#/components/parameters/cat.recovery::query.h' - - $ref: '#/components/parameters/cat.recovery::query.help' - - $ref: '#/components/parameters/cat.recovery::query.index' - - $ref: '#/components/parameters/cat.recovery::query.s' - - $ref: '#/components/parameters/cat.recovery::query.time' - - $ref: '#/components/parameters/cat.recovery::query.v' - - $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/cat.recovery@200' + - $ref: '#/components/parameters/cat.recovery___path.index' + - $ref: '#/components/parameters/cat.recovery___query.active_only' + - $ref: '#/components/parameters/cat.recovery___query.bytes' + - $ref: '#/components/parameters/cat.recovery___query.detailed' + - $ref: '#/components/parameters/cat.recovery___query.format' + - $ref: '#/components/parameters/cat.recovery___query.h' + - $ref: '#/components/parameters/cat.recovery___query.help' + - $ref: '#/components/parameters/cat.recovery___query.index' + - $ref: '#/components/parameters/cat.recovery___query.s' + - $ref: '#/components/parameters/cat.recovery___query.time' + - $ref: '#/components/parameters/cat.recovery___query.v' + - $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/cat.recovery___200' /_cat/repositories: get: operationId: cat.repositories.0 @@ -999,22 +999,22 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-repositories/ parameters: - - $ref: '#/components/parameters/cat.repositories::query.cluster_manager_timeout' - - $ref: '#/components/parameters/cat.repositories::query.format' - - $ref: '#/components/parameters/cat.repositories::query.h' - - $ref: '#/components/parameters/cat.repositories::query.help' - - $ref: '#/components/parameters/cat.repositories::query.local' - - $ref: '#/components/parameters/cat.repositories::query.master_timeout' - - $ref: '#/components/parameters/cat.repositories::query.s' - - $ref: '#/components/parameters/cat.repositories::query.v' - - $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/cat.repositories@200' + - $ref: '#/components/parameters/cat.repositories___query.cluster_manager_timeout' + - $ref: '#/components/parameters/cat.repositories___query.format' + - $ref: '#/components/parameters/cat.repositories___query.h' + - $ref: '#/components/parameters/cat.repositories___query.help' + - $ref: '#/components/parameters/cat.repositories___query.local' + - $ref: '#/components/parameters/cat.repositories___query.master_timeout' + - $ref: '#/components/parameters/cat.repositories___query.s' + - $ref: '#/components/parameters/cat.repositories___query.v' + - $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/cat.repositories___200' /_cat/segment_replication: get: operationId: cat.segment_replication.0 @@ -1024,31 +1024,31 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-segment-replication/ parameters: - - $ref: '#/components/parameters/cat.segment_replication::query.active_only' - - $ref: '#/components/parameters/cat.segment_replication::query.allow_no_indices' - - $ref: '#/components/parameters/cat.segment_replication::query.bytes' - - $ref: '#/components/parameters/cat.segment_replication::query.completed_only' - - $ref: '#/components/parameters/cat.segment_replication::query.detailed' - - $ref: '#/components/parameters/cat.segment_replication::query.expand_wildcards' - - $ref: '#/components/parameters/cat.segment_replication::query.format' - - $ref: '#/components/parameters/cat.segment_replication::query.h' - - $ref: '#/components/parameters/cat.segment_replication::query.help' - - $ref: '#/components/parameters/cat.segment_replication::query.ignore_throttled' - - $ref: '#/components/parameters/cat.segment_replication::query.ignore_unavailable' - - $ref: '#/components/parameters/cat.segment_replication::query.index' - - $ref: '#/components/parameters/cat.segment_replication::query.s' - - $ref: '#/components/parameters/cat.segment_replication::query.shards' - - $ref: '#/components/parameters/cat.segment_replication::query.time' - - $ref: '#/components/parameters/cat.segment_replication::query.timeout' - - $ref: '#/components/parameters/cat.segment_replication::query.v' - - $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/cat.segment_replication@200' + - $ref: '#/components/parameters/cat.segment_replication___query.active_only' + - $ref: '#/components/parameters/cat.segment_replication___query.allow_no_indices' + - $ref: '#/components/parameters/cat.segment_replication___query.bytes' + - $ref: '#/components/parameters/cat.segment_replication___query.completed_only' + - $ref: '#/components/parameters/cat.segment_replication___query.detailed' + - $ref: '#/components/parameters/cat.segment_replication___query.expand_wildcards' + - $ref: '#/components/parameters/cat.segment_replication___query.format' + - $ref: '#/components/parameters/cat.segment_replication___query.h' + - $ref: '#/components/parameters/cat.segment_replication___query.help' + - $ref: '#/components/parameters/cat.segment_replication___query.ignore_throttled' + - $ref: '#/components/parameters/cat.segment_replication___query.ignore_unavailable' + - $ref: '#/components/parameters/cat.segment_replication___query.index' + - $ref: '#/components/parameters/cat.segment_replication___query.s' + - $ref: '#/components/parameters/cat.segment_replication___query.shards' + - $ref: '#/components/parameters/cat.segment_replication___query.time' + - $ref: '#/components/parameters/cat.segment_replication___query.timeout' + - $ref: '#/components/parameters/cat.segment_replication___query.v' + - $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/cat.segment_replication___200' /_cat/segment_replication/{index}: get: operationId: cat.segment_replication.1 @@ -1058,32 +1058,32 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-segment-replication/ parameters: - - $ref: '#/components/parameters/cat.segment_replication::path.index' - - $ref: '#/components/parameters/cat.segment_replication::query.active_only' - - $ref: '#/components/parameters/cat.segment_replication::query.allow_no_indices' - - $ref: '#/components/parameters/cat.segment_replication::query.bytes' - - $ref: '#/components/parameters/cat.segment_replication::query.completed_only' - - $ref: '#/components/parameters/cat.segment_replication::query.detailed' - - $ref: '#/components/parameters/cat.segment_replication::query.expand_wildcards' - - $ref: '#/components/parameters/cat.segment_replication::query.format' - - $ref: '#/components/parameters/cat.segment_replication::query.h' - - $ref: '#/components/parameters/cat.segment_replication::query.help' - - $ref: '#/components/parameters/cat.segment_replication::query.ignore_throttled' - - $ref: '#/components/parameters/cat.segment_replication::query.ignore_unavailable' - - $ref: '#/components/parameters/cat.segment_replication::query.index' - - $ref: '#/components/parameters/cat.segment_replication::query.s' - - $ref: '#/components/parameters/cat.segment_replication::query.shards' - - $ref: '#/components/parameters/cat.segment_replication::query.time' - - $ref: '#/components/parameters/cat.segment_replication::query.timeout' - - $ref: '#/components/parameters/cat.segment_replication::query.v' - - $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/cat.segment_replication@200' + - $ref: '#/components/parameters/cat.segment_replication___path.index' + - $ref: '#/components/parameters/cat.segment_replication___query.active_only' + - $ref: '#/components/parameters/cat.segment_replication___query.allow_no_indices' + - $ref: '#/components/parameters/cat.segment_replication___query.bytes' + - $ref: '#/components/parameters/cat.segment_replication___query.completed_only' + - $ref: '#/components/parameters/cat.segment_replication___query.detailed' + - $ref: '#/components/parameters/cat.segment_replication___query.expand_wildcards' + - $ref: '#/components/parameters/cat.segment_replication___query.format' + - $ref: '#/components/parameters/cat.segment_replication___query.h' + - $ref: '#/components/parameters/cat.segment_replication___query.help' + - $ref: '#/components/parameters/cat.segment_replication___query.ignore_throttled' + - $ref: '#/components/parameters/cat.segment_replication___query.ignore_unavailable' + - $ref: '#/components/parameters/cat.segment_replication___query.index' + - $ref: '#/components/parameters/cat.segment_replication___query.s' + - $ref: '#/components/parameters/cat.segment_replication___query.shards' + - $ref: '#/components/parameters/cat.segment_replication___query.time' + - $ref: '#/components/parameters/cat.segment_replication___query.timeout' + - $ref: '#/components/parameters/cat.segment_replication___query.v' + - $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/cat.segment_replication___200' /_cat/segments: get: operationId: cat.segments.0 @@ -1093,22 +1093,22 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-segments/ parameters: - - $ref: '#/components/parameters/cat.segments::query.bytes' - - $ref: '#/components/parameters/cat.segments::query.cluster_manager_timeout' - - $ref: '#/components/parameters/cat.segments::query.format' - - $ref: '#/components/parameters/cat.segments::query.h' - - $ref: '#/components/parameters/cat.segments::query.help' - - $ref: '#/components/parameters/cat.segments::query.master_timeout' - - $ref: '#/components/parameters/cat.segments::query.s' - - $ref: '#/components/parameters/cat.segments::query.v' - - $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/cat.segments@200' + - $ref: '#/components/parameters/cat.segments___query.bytes' + - $ref: '#/components/parameters/cat.segments___query.cluster_manager_timeout' + - $ref: '#/components/parameters/cat.segments___query.format' + - $ref: '#/components/parameters/cat.segments___query.h' + - $ref: '#/components/parameters/cat.segments___query.help' + - $ref: '#/components/parameters/cat.segments___query.master_timeout' + - $ref: '#/components/parameters/cat.segments___query.s' + - $ref: '#/components/parameters/cat.segments___query.v' + - $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/cat.segments___200' /_cat/segments/{index}: get: operationId: cat.segments.1 @@ -1118,23 +1118,23 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-segments/ parameters: - - $ref: '#/components/parameters/cat.segments::path.index' - - $ref: '#/components/parameters/cat.segments::query.bytes' - - $ref: '#/components/parameters/cat.segments::query.cluster_manager_timeout' - - $ref: '#/components/parameters/cat.segments::query.format' - - $ref: '#/components/parameters/cat.segments::query.h' - - $ref: '#/components/parameters/cat.segments::query.help' - - $ref: '#/components/parameters/cat.segments::query.master_timeout' - - $ref: '#/components/parameters/cat.segments::query.s' - - $ref: '#/components/parameters/cat.segments::query.v' - - $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/cat.segments@200' + - $ref: '#/components/parameters/cat.segments___path.index' + - $ref: '#/components/parameters/cat.segments___query.bytes' + - $ref: '#/components/parameters/cat.segments___query.cluster_manager_timeout' + - $ref: '#/components/parameters/cat.segments___query.format' + - $ref: '#/components/parameters/cat.segments___query.h' + - $ref: '#/components/parameters/cat.segments___query.help' + - $ref: '#/components/parameters/cat.segments___query.master_timeout' + - $ref: '#/components/parameters/cat.segments___query.s' + - $ref: '#/components/parameters/cat.segments___query.v' + - $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/cat.segments___200' /_cat/shards: get: operationId: cat.shards.0 @@ -1144,24 +1144,24 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-shards/ parameters: - - $ref: '#/components/parameters/cat.shards::query.bytes' - - $ref: '#/components/parameters/cat.shards::query.cluster_manager_timeout' - - $ref: '#/components/parameters/cat.shards::query.format' - - $ref: '#/components/parameters/cat.shards::query.h' - - $ref: '#/components/parameters/cat.shards::query.help' - - $ref: '#/components/parameters/cat.shards::query.local' - - $ref: '#/components/parameters/cat.shards::query.master_timeout' - - $ref: '#/components/parameters/cat.shards::query.s' - - $ref: '#/components/parameters/cat.shards::query.time' - - $ref: '#/components/parameters/cat.shards::query.v' - - $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/cat.shards@200' + - $ref: '#/components/parameters/cat.shards___query.bytes' + - $ref: '#/components/parameters/cat.shards___query.cluster_manager_timeout' + - $ref: '#/components/parameters/cat.shards___query.format' + - $ref: '#/components/parameters/cat.shards___query.h' + - $ref: '#/components/parameters/cat.shards___query.help' + - $ref: '#/components/parameters/cat.shards___query.local' + - $ref: '#/components/parameters/cat.shards___query.master_timeout' + - $ref: '#/components/parameters/cat.shards___query.s' + - $ref: '#/components/parameters/cat.shards___query.time' + - $ref: '#/components/parameters/cat.shards___query.v' + - $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/cat.shards___200' /_cat/shards/{index}: get: operationId: cat.shards.1 @@ -1171,25 +1171,25 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-shards/ parameters: - - $ref: '#/components/parameters/cat.shards::path.index' - - $ref: '#/components/parameters/cat.shards::query.bytes' - - $ref: '#/components/parameters/cat.shards::query.cluster_manager_timeout' - - $ref: '#/components/parameters/cat.shards::query.format' - - $ref: '#/components/parameters/cat.shards::query.h' - - $ref: '#/components/parameters/cat.shards::query.help' - - $ref: '#/components/parameters/cat.shards::query.local' - - $ref: '#/components/parameters/cat.shards::query.master_timeout' - - $ref: '#/components/parameters/cat.shards::query.s' - - $ref: '#/components/parameters/cat.shards::query.time' - - $ref: '#/components/parameters/cat.shards::query.v' - - $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/cat.shards@200' + - $ref: '#/components/parameters/cat.shards___path.index' + - $ref: '#/components/parameters/cat.shards___query.bytes' + - $ref: '#/components/parameters/cat.shards___query.cluster_manager_timeout' + - $ref: '#/components/parameters/cat.shards___query.format' + - $ref: '#/components/parameters/cat.shards___query.h' + - $ref: '#/components/parameters/cat.shards___query.help' + - $ref: '#/components/parameters/cat.shards___query.local' + - $ref: '#/components/parameters/cat.shards___query.master_timeout' + - $ref: '#/components/parameters/cat.shards___query.s' + - $ref: '#/components/parameters/cat.shards___query.time' + - $ref: '#/components/parameters/cat.shards___query.v' + - $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/cat.shards___200' /_cat/snapshots: get: operationId: cat.snapshots.0 @@ -1199,23 +1199,23 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-snapshots/ parameters: - - $ref: '#/components/parameters/cat.snapshots::query.cluster_manager_timeout' - - $ref: '#/components/parameters/cat.snapshots::query.format' - - $ref: '#/components/parameters/cat.snapshots::query.h' - - $ref: '#/components/parameters/cat.snapshots::query.help' - - $ref: '#/components/parameters/cat.snapshots::query.ignore_unavailable' - - $ref: '#/components/parameters/cat.snapshots::query.master_timeout' - - $ref: '#/components/parameters/cat.snapshots::query.s' - - $ref: '#/components/parameters/cat.snapshots::query.time' - - $ref: '#/components/parameters/cat.snapshots::query.v' - - $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/cat.snapshots@200' + - $ref: '#/components/parameters/cat.snapshots___query.cluster_manager_timeout' + - $ref: '#/components/parameters/cat.snapshots___query.format' + - $ref: '#/components/parameters/cat.snapshots___query.h' + - $ref: '#/components/parameters/cat.snapshots___query.help' + - $ref: '#/components/parameters/cat.snapshots___query.ignore_unavailable' + - $ref: '#/components/parameters/cat.snapshots___query.master_timeout' + - $ref: '#/components/parameters/cat.snapshots___query.s' + - $ref: '#/components/parameters/cat.snapshots___query.time' + - $ref: '#/components/parameters/cat.snapshots___query.v' + - $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/cat.snapshots___200' /_cat/snapshots/{repository}: get: operationId: cat.snapshots.1 @@ -1225,24 +1225,24 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-snapshots/ parameters: - - $ref: '#/components/parameters/cat.snapshots::path.repository' - - $ref: '#/components/parameters/cat.snapshots::query.cluster_manager_timeout' - - $ref: '#/components/parameters/cat.snapshots::query.format' - - $ref: '#/components/parameters/cat.snapshots::query.h' - - $ref: '#/components/parameters/cat.snapshots::query.help' - - $ref: '#/components/parameters/cat.snapshots::query.ignore_unavailable' - - $ref: '#/components/parameters/cat.snapshots::query.master_timeout' - - $ref: '#/components/parameters/cat.snapshots::query.s' - - $ref: '#/components/parameters/cat.snapshots::query.time' - - $ref: '#/components/parameters/cat.snapshots::query.v' - - $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/cat.snapshots@200' + - $ref: '#/components/parameters/cat.snapshots___path.repository' + - $ref: '#/components/parameters/cat.snapshots___query.cluster_manager_timeout' + - $ref: '#/components/parameters/cat.snapshots___query.format' + - $ref: '#/components/parameters/cat.snapshots___query.h' + - $ref: '#/components/parameters/cat.snapshots___query.help' + - $ref: '#/components/parameters/cat.snapshots___query.ignore_unavailable' + - $ref: '#/components/parameters/cat.snapshots___query.master_timeout' + - $ref: '#/components/parameters/cat.snapshots___query.s' + - $ref: '#/components/parameters/cat.snapshots___query.time' + - $ref: '#/components/parameters/cat.snapshots___query.v' + - $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/cat.snapshots___200' /_cat/tasks: get: operationId: cat.tasks.0 @@ -1252,24 +1252,24 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-tasks/ parameters: - - $ref: '#/components/parameters/cat.tasks::query.actions' - - $ref: '#/components/parameters/cat.tasks::query.detailed' - - $ref: '#/components/parameters/cat.tasks::query.format' - - $ref: '#/components/parameters/cat.tasks::query.h' - - $ref: '#/components/parameters/cat.tasks::query.help' - - $ref: '#/components/parameters/cat.tasks::query.nodes' - - $ref: '#/components/parameters/cat.tasks::query.parent_task_id' - - $ref: '#/components/parameters/cat.tasks::query.s' - - $ref: '#/components/parameters/cat.tasks::query.time' - - $ref: '#/components/parameters/cat.tasks::query.v' - - $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/cat.tasks@200' + - $ref: '#/components/parameters/cat.tasks___query.actions' + - $ref: '#/components/parameters/cat.tasks___query.detailed' + - $ref: '#/components/parameters/cat.tasks___query.format' + - $ref: '#/components/parameters/cat.tasks___query.h' + - $ref: '#/components/parameters/cat.tasks___query.help' + - $ref: '#/components/parameters/cat.tasks___query.nodes' + - $ref: '#/components/parameters/cat.tasks___query.parent_task_id' + - $ref: '#/components/parameters/cat.tasks___query.s' + - $ref: '#/components/parameters/cat.tasks___query.time' + - $ref: '#/components/parameters/cat.tasks___query.v' + - $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/cat.tasks___200' /_cat/templates: get: operationId: cat.templates.0 @@ -1279,22 +1279,22 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-templates/ parameters: - - $ref: '#/components/parameters/cat.templates::query.cluster_manager_timeout' - - $ref: '#/components/parameters/cat.templates::query.format' - - $ref: '#/components/parameters/cat.templates::query.h' - - $ref: '#/components/parameters/cat.templates::query.help' - - $ref: '#/components/parameters/cat.templates::query.local' - - $ref: '#/components/parameters/cat.templates::query.master_timeout' - - $ref: '#/components/parameters/cat.templates::query.s' - - $ref: '#/components/parameters/cat.templates::query.v' - - $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/cat.templates@200' + - $ref: '#/components/parameters/cat.templates___query.cluster_manager_timeout' + - $ref: '#/components/parameters/cat.templates___query.format' + - $ref: '#/components/parameters/cat.templates___query.h' + - $ref: '#/components/parameters/cat.templates___query.help' + - $ref: '#/components/parameters/cat.templates___query.local' + - $ref: '#/components/parameters/cat.templates___query.master_timeout' + - $ref: '#/components/parameters/cat.templates___query.s' + - $ref: '#/components/parameters/cat.templates___query.v' + - $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/cat.templates___200' /_cat/templates/{name}: get: operationId: cat.templates.1 @@ -1304,23 +1304,23 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-templates/ parameters: - - $ref: '#/components/parameters/cat.templates::path.name' - - $ref: '#/components/parameters/cat.templates::query.cluster_manager_timeout' - - $ref: '#/components/parameters/cat.templates::query.format' - - $ref: '#/components/parameters/cat.templates::query.h' - - $ref: '#/components/parameters/cat.templates::query.help' - - $ref: '#/components/parameters/cat.templates::query.local' - - $ref: '#/components/parameters/cat.templates::query.master_timeout' - - $ref: '#/components/parameters/cat.templates::query.s' - - $ref: '#/components/parameters/cat.templates::query.v' - - $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/cat.templates@200' + - $ref: '#/components/parameters/cat.templates___path.name' + - $ref: '#/components/parameters/cat.templates___query.cluster_manager_timeout' + - $ref: '#/components/parameters/cat.templates___query.format' + - $ref: '#/components/parameters/cat.templates___query.h' + - $ref: '#/components/parameters/cat.templates___query.help' + - $ref: '#/components/parameters/cat.templates___query.local' + - $ref: '#/components/parameters/cat.templates___query.master_timeout' + - $ref: '#/components/parameters/cat.templates___query.s' + - $ref: '#/components/parameters/cat.templates___query.v' + - $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/cat.templates___200' /_cat/thread_pool: get: operationId: cat.thread_pool.0 @@ -1332,23 +1332,23 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-thread-pool/ parameters: - - $ref: '#/components/parameters/cat.thread_pool::query.cluster_manager_timeout' - - $ref: '#/components/parameters/cat.thread_pool::query.format' - - $ref: '#/components/parameters/cat.thread_pool::query.h' - - $ref: '#/components/parameters/cat.thread_pool::query.help' - - $ref: '#/components/parameters/cat.thread_pool::query.local' - - $ref: '#/components/parameters/cat.thread_pool::query.master_timeout' - - $ref: '#/components/parameters/cat.thread_pool::query.s' - - $ref: '#/components/parameters/cat.thread_pool::query.size' - - $ref: '#/components/parameters/cat.thread_pool::query.v' - - $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/cat.thread_pool@200' + - $ref: '#/components/parameters/cat.thread_pool___query.cluster_manager_timeout' + - $ref: '#/components/parameters/cat.thread_pool___query.format' + - $ref: '#/components/parameters/cat.thread_pool___query.h' + - $ref: '#/components/parameters/cat.thread_pool___query.help' + - $ref: '#/components/parameters/cat.thread_pool___query.local' + - $ref: '#/components/parameters/cat.thread_pool___query.master_timeout' + - $ref: '#/components/parameters/cat.thread_pool___query.s' + - $ref: '#/components/parameters/cat.thread_pool___query.size' + - $ref: '#/components/parameters/cat.thread_pool___query.v' + - $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/cat.thread_pool___200' /_cat/thread_pool/{thread_pool_patterns}: get: operationId: cat.thread_pool.1 @@ -1360,24 +1360,24 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-thread-pool/ parameters: - - $ref: '#/components/parameters/cat.thread_pool::path.thread_pool_patterns' - - $ref: '#/components/parameters/cat.thread_pool::query.cluster_manager_timeout' - - $ref: '#/components/parameters/cat.thread_pool::query.format' - - $ref: '#/components/parameters/cat.thread_pool::query.h' - - $ref: '#/components/parameters/cat.thread_pool::query.help' - - $ref: '#/components/parameters/cat.thread_pool::query.local' - - $ref: '#/components/parameters/cat.thread_pool::query.master_timeout' - - $ref: '#/components/parameters/cat.thread_pool::query.s' - - $ref: '#/components/parameters/cat.thread_pool::query.size' - - $ref: '#/components/parameters/cat.thread_pool::query.v' - - $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/cat.thread_pool@200' + - $ref: '#/components/parameters/cat.thread_pool___path.thread_pool_patterns' + - $ref: '#/components/parameters/cat.thread_pool___query.cluster_manager_timeout' + - $ref: '#/components/parameters/cat.thread_pool___query.format' + - $ref: '#/components/parameters/cat.thread_pool___query.h' + - $ref: '#/components/parameters/cat.thread_pool___query.help' + - $ref: '#/components/parameters/cat.thread_pool___query.local' + - $ref: '#/components/parameters/cat.thread_pool___query.master_timeout' + - $ref: '#/components/parameters/cat.thread_pool___query.s' + - $ref: '#/components/parameters/cat.thread_pool___query.size' + - $ref: '#/components/parameters/cat.thread_pool___query.v' + - $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/cat.thread_pool___200' /_cluster/allocation/explain: get: operationId: cluster.allocation_explain.0 @@ -1387,18 +1387,18 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-allocation/ parameters: - - $ref: '#/components/parameters/cluster.allocation_explain::query.include_disk_info' - - $ref: '#/components/parameters/cluster.allocation_explain::query.include_yes_decisions' - - $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' + - $ref: '#/components/parameters/cluster.allocation_explain___query.include_disk_info' + - $ref: '#/components/parameters/cluster.allocation_explain___query.include_yes_decisions' + - $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/cluster.allocation_explain' responses: '200': - $ref: '#/components/responses/cluster.allocation_explain@200' + $ref: '#/components/responses/cluster.allocation_explain___200' post: operationId: cluster.allocation_explain.1 x-operation-group: cluster.allocation_explain @@ -1407,18 +1407,18 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-allocation/ parameters: - - $ref: '#/components/parameters/cluster.allocation_explain::query.include_disk_info' - - $ref: '#/components/parameters/cluster.allocation_explain::query.include_yes_decisions' - - $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' + - $ref: '#/components/parameters/cluster.allocation_explain___query.include_disk_info' + - $ref: '#/components/parameters/cluster.allocation_explain___query.include_yes_decisions' + - $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/cluster.allocation_explain' responses: '200': - $ref: '#/components/responses/cluster.allocation_explain@200' + $ref: '#/components/responses/cluster.allocation_explain___200' /_cluster/decommission/awareness: delete: operationId: cluster.delete_decommission_awareness.0 @@ -1429,13 +1429,13 @@ paths: url: https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-decommission/#example-decommissioning-and-recommissioning-a-zone responses: '200': - $ref: '#/components/responses/cluster.delete_decommission_awareness@200' + $ref: '#/components/responses/cluster.delete_decommission_awareness___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' + - $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' /_cluster/decommission/awareness/{awareness_attribute_name}/_status: get: operationId: cluster.get_decommission_awareness.0 @@ -1445,15 +1445,15 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-decommission/#example-getting-zone-decommission-status parameters: - - $ref: '#/components/parameters/cluster.get_decommission_awareness::path.awareness_attribute_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' + - $ref: '#/components/parameters/cluster.get_decommission_awareness___path.awareness_attribute_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/cluster.get_decommission_awareness@200' + $ref: '#/components/responses/cluster.get_decommission_awareness___200' /_cluster/decommission/awareness/{awareness_attribute_name}/{awareness_attribute_value}: put: operationId: cluster.put_decommission_awareness.0 @@ -1463,16 +1463,16 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-decommission/#example-decommissioning-and-recommissioning-a-zone parameters: - - $ref: '#/components/parameters/cluster.put_decommission_awareness::path.awareness_attribute_name' - - $ref: '#/components/parameters/cluster.put_decommission_awareness::path.awareness_attribute_value' - - $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' + - $ref: '#/components/parameters/cluster.put_decommission_awareness___path.awareness_attribute_name' + - $ref: '#/components/parameters/cluster.put_decommission_awareness___path.awareness_attribute_value' + - $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/cluster.put_decommission_awareness@200' + $ref: '#/components/responses/cluster.put_decommission_awareness___200' /_cluster/health: get: operationId: cluster.health.0 @@ -1482,27 +1482,27 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-health/ parameters: - - $ref: '#/components/parameters/cluster.health::query.awareness_attribute' - - $ref: '#/components/parameters/cluster.health::query.cluster_manager_timeout' - - $ref: '#/components/parameters/cluster.health::query.expand_wildcards' - - $ref: '#/components/parameters/cluster.health::query.level' - - $ref: '#/components/parameters/cluster.health::query.local' - - $ref: '#/components/parameters/cluster.health::query.master_timeout' - - $ref: '#/components/parameters/cluster.health::query.timeout' - - $ref: '#/components/parameters/cluster.health::query.wait_for_active_shards' - - $ref: '#/components/parameters/cluster.health::query.wait_for_events' - - $ref: '#/components/parameters/cluster.health::query.wait_for_no_initializing_shards' - - $ref: '#/components/parameters/cluster.health::query.wait_for_no_relocating_shards' - - $ref: '#/components/parameters/cluster.health::query.wait_for_nodes' - - $ref: '#/components/parameters/cluster.health::query.wait_for_status' - - $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/cluster.health@200' + - $ref: '#/components/parameters/cluster.health___query.awareness_attribute' + - $ref: '#/components/parameters/cluster.health___query.cluster_manager_timeout' + - $ref: '#/components/parameters/cluster.health___query.expand_wildcards' + - $ref: '#/components/parameters/cluster.health___query.level' + - $ref: '#/components/parameters/cluster.health___query.local' + - $ref: '#/components/parameters/cluster.health___query.master_timeout' + - $ref: '#/components/parameters/cluster.health___query.timeout' + - $ref: '#/components/parameters/cluster.health___query.wait_for_active_shards' + - $ref: '#/components/parameters/cluster.health___query.wait_for_events' + - $ref: '#/components/parameters/cluster.health___query.wait_for_no_initializing_shards' + - $ref: '#/components/parameters/cluster.health___query.wait_for_no_relocating_shards' + - $ref: '#/components/parameters/cluster.health___query.wait_for_nodes' + - $ref: '#/components/parameters/cluster.health___query.wait_for_status' + - $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/cluster.health___200' /_cluster/health/{index}: get: operationId: cluster.health.1 @@ -1512,28 +1512,28 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-health/ parameters: - - $ref: '#/components/parameters/cluster.health::path.index' - - $ref: '#/components/parameters/cluster.health::query.awareness_attribute' - - $ref: '#/components/parameters/cluster.health::query.cluster_manager_timeout' - - $ref: '#/components/parameters/cluster.health::query.expand_wildcards' - - $ref: '#/components/parameters/cluster.health::query.level' - - $ref: '#/components/parameters/cluster.health::query.local' - - $ref: '#/components/parameters/cluster.health::query.master_timeout' - - $ref: '#/components/parameters/cluster.health::query.timeout' - - $ref: '#/components/parameters/cluster.health::query.wait_for_active_shards' - - $ref: '#/components/parameters/cluster.health::query.wait_for_events' - - $ref: '#/components/parameters/cluster.health::query.wait_for_no_initializing_shards' - - $ref: '#/components/parameters/cluster.health::query.wait_for_no_relocating_shards' - - $ref: '#/components/parameters/cluster.health::query.wait_for_nodes' - - $ref: '#/components/parameters/cluster.health::query.wait_for_status' - - $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/cluster.health@200' + - $ref: '#/components/parameters/cluster.health___path.index' + - $ref: '#/components/parameters/cluster.health___query.awareness_attribute' + - $ref: '#/components/parameters/cluster.health___query.cluster_manager_timeout' + - $ref: '#/components/parameters/cluster.health___query.expand_wildcards' + - $ref: '#/components/parameters/cluster.health___query.level' + - $ref: '#/components/parameters/cluster.health___query.local' + - $ref: '#/components/parameters/cluster.health___query.master_timeout' + - $ref: '#/components/parameters/cluster.health___query.timeout' + - $ref: '#/components/parameters/cluster.health___query.wait_for_active_shards' + - $ref: '#/components/parameters/cluster.health___query.wait_for_events' + - $ref: '#/components/parameters/cluster.health___query.wait_for_no_initializing_shards' + - $ref: '#/components/parameters/cluster.health___query.wait_for_no_relocating_shards' + - $ref: '#/components/parameters/cluster.health___query.wait_for_nodes' + - $ref: '#/components/parameters/cluster.health___query.wait_for_status' + - $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/cluster.health___200' /_cluster/nodes/{node_id}/hot_threads: get: operationId: nodes.hot_threads.2 @@ -1547,21 +1547,21 @@ paths: 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' + - $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 @@ -1575,20 +1575,20 @@ paths: 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' + - $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' + $ref: '#/components/responses/nodes.hot_threads___200' /_cluster/pending_tasks: get: operationId: cluster.pending_tasks.0 @@ -1600,17 +1600,17 @@ paths: externalDocs: url: https://opensearch.org/docs/latest parameters: - - $ref: '#/components/parameters/cluster.pending_tasks::query.cluster_manager_timeout' - - $ref: '#/components/parameters/cluster.pending_tasks::query.local' - - $ref: '#/components/parameters/cluster.pending_tasks::query.master_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' + - $ref: '#/components/parameters/cluster.pending_tasks___query.cluster_manager_timeout' + - $ref: '#/components/parameters/cluster.pending_tasks___query.local' + - $ref: '#/components/parameters/cluster.pending_tasks___query.master_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/cluster.pending_tasks@200' + $ref: '#/components/responses/cluster.pending_tasks___200' /_cluster/reroute: post: operationId: cluster.reroute.0 @@ -1620,23 +1620,23 @@ paths: externalDocs: url: https://opensearch.org/docs/latest parameters: - - $ref: '#/components/parameters/cluster.reroute::query.cluster_manager_timeout' - - $ref: '#/components/parameters/cluster.reroute::query.dry_run' - - $ref: '#/components/parameters/cluster.reroute::query.explain' - - $ref: '#/components/parameters/cluster.reroute::query.master_timeout' - - $ref: '#/components/parameters/cluster.reroute::query.metric' - - $ref: '#/components/parameters/cluster.reroute::query.retry_failed' - - $ref: '#/components/parameters/cluster.reroute::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' + - $ref: '#/components/parameters/cluster.reroute___query.cluster_manager_timeout' + - $ref: '#/components/parameters/cluster.reroute___query.dry_run' + - $ref: '#/components/parameters/cluster.reroute___query.explain' + - $ref: '#/components/parameters/cluster.reroute___query.master_timeout' + - $ref: '#/components/parameters/cluster.reroute___query.metric' + - $ref: '#/components/parameters/cluster.reroute___query.retry_failed' + - $ref: '#/components/parameters/cluster.reroute___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' requestBody: $ref: '#/components/requestBodies/cluster.reroute' responses: '200': - $ref: '#/components/responses/cluster.reroute@200' + $ref: '#/components/responses/cluster.reroute___200' /_cluster/routing/awareness/{attribute}/weights: get: operationId: cluster.get_weighted_routing.0 @@ -1646,15 +1646,15 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-awareness/#example-getting-weights-for-all-zones parameters: - - $ref: '#/components/parameters/cluster.get_weighted_routing::path.attribute' - - $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' + - $ref: '#/components/parameters/cluster.get_weighted_routing___path.attribute' + - $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/cluster.get_weighted_routing@200' + $ref: '#/components/responses/cluster.get_weighted_routing___200' put: operationId: cluster.put_weighted_routing.0 x-operation-group: cluster.put_weighted_routing @@ -1663,17 +1663,17 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-awareness/#example-weighted-round-robin-search parameters: - - $ref: '#/components/parameters/cluster.put_weighted_routing::path.attribute' - - $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' + - $ref: '#/components/parameters/cluster.put_weighted_routing___path.attribute' + - $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/cluster.put_weighted_routing' responses: '200': - $ref: '#/components/responses/cluster.put_weighted_routing@200' + $ref: '#/components/responses/cluster.put_weighted_routing___200' /_cluster/routing/awareness/weights: delete: operationId: cluster.delete_weighted_routing.0 @@ -1686,13 +1686,13 @@ paths: $ref: '#/components/requestBodies/cluster.delete_weighted_routing' responses: '200': - $ref: '#/components/responses/cluster.delete_weighted_routing@200' + $ref: '#/components/responses/cluster.delete_weighted_routing___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' + - $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' /_cluster/settings: get: operationId: cluster.get_settings.0 @@ -1702,19 +1702,19 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-settings/ parameters: - - $ref: '#/components/parameters/cluster.get_settings::query.cluster_manager_timeout' - - $ref: '#/components/parameters/cluster.get_settings::query.flat_settings' - - $ref: '#/components/parameters/cluster.get_settings::query.include_defaults' - - $ref: '#/components/parameters/cluster.get_settings::query.master_timeout' - - $ref: '#/components/parameters/cluster.get_settings::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' + - $ref: '#/components/parameters/cluster.get_settings___query.cluster_manager_timeout' + - $ref: '#/components/parameters/cluster.get_settings___query.flat_settings' + - $ref: '#/components/parameters/cluster.get_settings___query.include_defaults' + - $ref: '#/components/parameters/cluster.get_settings___query.master_timeout' + - $ref: '#/components/parameters/cluster.get_settings___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/cluster.get_settings@200' + $ref: '#/components/responses/cluster.get_settings___200' put: operationId: cluster.put_settings.0 x-operation-group: cluster.put_settings @@ -1723,20 +1723,20 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/cluster-settings/ parameters: - - $ref: '#/components/parameters/cluster.put_settings::query.cluster_manager_timeout' - - $ref: '#/components/parameters/cluster.put_settings::query.flat_settings' - - $ref: '#/components/parameters/cluster.put_settings::query.master_timeout' - - $ref: '#/components/parameters/cluster.put_settings::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' + - $ref: '#/components/parameters/cluster.put_settings___query.cluster_manager_timeout' + - $ref: '#/components/parameters/cluster.put_settings___query.flat_settings' + - $ref: '#/components/parameters/cluster.put_settings___query.master_timeout' + - $ref: '#/components/parameters/cluster.put_settings___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' requestBody: $ref: '#/components/requestBodies/cluster.put_settings' responses: '200': - $ref: '#/components/responses/cluster.put_settings@200' + $ref: '#/components/responses/cluster.put_settings___200' /_cluster/state: get: operationId: cluster.state.0 @@ -1746,23 +1746,23 @@ paths: externalDocs: url: https://opensearch.org/docs/latest parameters: - - $ref: '#/components/parameters/cluster.state::query.allow_no_indices' - - $ref: '#/components/parameters/cluster.state::query.cluster_manager_timeout' - - $ref: '#/components/parameters/cluster.state::query.expand_wildcards' - - $ref: '#/components/parameters/cluster.state::query.flat_settings' - - $ref: '#/components/parameters/cluster.state::query.ignore_unavailable' - - $ref: '#/components/parameters/cluster.state::query.local' - - $ref: '#/components/parameters/cluster.state::query.master_timeout' - - $ref: '#/components/parameters/cluster.state::query.wait_for_metadata_version' - - $ref: '#/components/parameters/cluster.state::query.wait_for_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/cluster.state@200' + - $ref: '#/components/parameters/cluster.state___query.allow_no_indices' + - $ref: '#/components/parameters/cluster.state___query.cluster_manager_timeout' + - $ref: '#/components/parameters/cluster.state___query.expand_wildcards' + - $ref: '#/components/parameters/cluster.state___query.flat_settings' + - $ref: '#/components/parameters/cluster.state___query.ignore_unavailable' + - $ref: '#/components/parameters/cluster.state___query.local' + - $ref: '#/components/parameters/cluster.state___query.master_timeout' + - $ref: '#/components/parameters/cluster.state___query.wait_for_metadata_version' + - $ref: '#/components/parameters/cluster.state___query.wait_for_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/cluster.state___200' /_cluster/state/{metric}: get: operationId: cluster.state.1 @@ -1772,24 +1772,24 @@ paths: externalDocs: url: https://opensearch.org/docs/latest parameters: - - $ref: '#/components/parameters/cluster.state::path.metric' - - $ref: '#/components/parameters/cluster.state::query.allow_no_indices' - - $ref: '#/components/parameters/cluster.state::query.cluster_manager_timeout' - - $ref: '#/components/parameters/cluster.state::query.expand_wildcards' - - $ref: '#/components/parameters/cluster.state::query.flat_settings' - - $ref: '#/components/parameters/cluster.state::query.ignore_unavailable' - - $ref: '#/components/parameters/cluster.state::query.local' - - $ref: '#/components/parameters/cluster.state::query.master_timeout' - - $ref: '#/components/parameters/cluster.state::query.wait_for_metadata_version' - - $ref: '#/components/parameters/cluster.state::query.wait_for_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/cluster.state@200' + - $ref: '#/components/parameters/cluster.state___path.metric' + - $ref: '#/components/parameters/cluster.state___query.allow_no_indices' + - $ref: '#/components/parameters/cluster.state___query.cluster_manager_timeout' + - $ref: '#/components/parameters/cluster.state___query.expand_wildcards' + - $ref: '#/components/parameters/cluster.state___query.flat_settings' + - $ref: '#/components/parameters/cluster.state___query.ignore_unavailable' + - $ref: '#/components/parameters/cluster.state___query.local' + - $ref: '#/components/parameters/cluster.state___query.master_timeout' + - $ref: '#/components/parameters/cluster.state___query.wait_for_metadata_version' + - $ref: '#/components/parameters/cluster.state___query.wait_for_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/cluster.state___200' /_cluster/state/{metric}/{index}: get: operationId: cluster.state.2 @@ -1799,25 +1799,25 @@ paths: externalDocs: url: https://opensearch.org/docs/latest parameters: - - $ref: '#/components/parameters/cluster.state::path.index' - - $ref: '#/components/parameters/cluster.state::path.metric' - - $ref: '#/components/parameters/cluster.state::query.allow_no_indices' - - $ref: '#/components/parameters/cluster.state::query.cluster_manager_timeout' - - $ref: '#/components/parameters/cluster.state::query.expand_wildcards' - - $ref: '#/components/parameters/cluster.state::query.flat_settings' - - $ref: '#/components/parameters/cluster.state::query.ignore_unavailable' - - $ref: '#/components/parameters/cluster.state::query.local' - - $ref: '#/components/parameters/cluster.state::query.master_timeout' - - $ref: '#/components/parameters/cluster.state::query.wait_for_metadata_version' - - $ref: '#/components/parameters/cluster.state::query.wait_for_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/cluster.state@200' + - $ref: '#/components/parameters/cluster.state___path.index' + - $ref: '#/components/parameters/cluster.state___path.metric' + - $ref: '#/components/parameters/cluster.state___query.allow_no_indices' + - $ref: '#/components/parameters/cluster.state___query.cluster_manager_timeout' + - $ref: '#/components/parameters/cluster.state___query.expand_wildcards' + - $ref: '#/components/parameters/cluster.state___query.flat_settings' + - $ref: '#/components/parameters/cluster.state___query.ignore_unavailable' + - $ref: '#/components/parameters/cluster.state___query.local' + - $ref: '#/components/parameters/cluster.state___query.master_timeout' + - $ref: '#/components/parameters/cluster.state___query.wait_for_metadata_version' + - $ref: '#/components/parameters/cluster.state___query.wait_for_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/cluster.state___200' /_cluster/stats: get: operationId: cluster.stats.0 @@ -1827,16 +1827,59 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-stats/ parameters: - - $ref: '#/components/parameters/cluster.stats::query.flat_settings' - - $ref: '#/components/parameters/cluster.stats::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' + - $ref: '#/components/parameters/cluster.stats___query.flat_settings' + - $ref: '#/components/parameters/cluster.stats___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/cluster.stats@200' + $ref: '#/components/responses/cluster.stats___200' + /_cluster/stats/{metric}/{index_metric}/nodes/{node_id}: + get: + operationId: cluster.stats.3 + x-operation-group: cluster.stats + x-version-added: '2.18' + description: Returns high-level overview of cluster statistics. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-stats/ + parameters: + - $ref: '#/components/parameters/cluster.stats___path.index_metric' + - $ref: '#/components/parameters/cluster.stats___path.metric' + - $ref: '#/components/parameters/cluster.stats___path.node_id' + - $ref: '#/components/parameters/cluster.stats___query.flat_settings' + - $ref: '#/components/parameters/cluster.stats___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/cluster.stats___200' + /_cluster/stats/{metric}/nodes/{node_id}: + get: + operationId: cluster.stats.2 + x-operation-group: cluster.stats + x-version-added: '2.18' + description: Returns high-level overview of cluster statistics. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-stats/ + parameters: + - $ref: '#/components/parameters/cluster.stats___path.metric' + - $ref: '#/components/parameters/cluster.stats___path.node_id' + - $ref: '#/components/parameters/cluster.stats___query.flat_settings' + - $ref: '#/components/parameters/cluster.stats___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/cluster.stats___200' /_cluster/stats/nodes/{node_id}: get: operationId: cluster.stats.1 @@ -1846,17 +1889,17 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-stats/ parameters: - - $ref: '#/components/parameters/cluster.stats::path.node_id' - - $ref: '#/components/parameters/cluster.stats::query.flat_settings' - - $ref: '#/components/parameters/cluster.stats::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' + - $ref: '#/components/parameters/cluster.stats___path.node_id' + - $ref: '#/components/parameters/cluster.stats___query.flat_settings' + - $ref: '#/components/parameters/cluster.stats___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/cluster.stats@200' + $ref: '#/components/responses/cluster.stats___200' /_cluster/voting_config_exclusions: delete: operationId: cluster.delete_voting_config_exclusions.0 @@ -1866,15 +1909,15 @@ paths: externalDocs: url: https://opensearch.org/docs/latest parameters: - - $ref: '#/components/parameters/cluster.delete_voting_config_exclusions::query.wait_for_removal' - - $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' + - $ref: '#/components/parameters/cluster.delete_voting_config_exclusions___query.wait_for_removal' + - $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/cluster.delete_voting_config_exclusions@200' + $ref: '#/components/responses/cluster.delete_voting_config_exclusions___200' post: operationId: cluster.post_voting_config_exclusions.0 x-operation-group: cluster.post_voting_config_exclusions @@ -1883,17 +1926,17 @@ paths: externalDocs: url: https://opensearch.org/docs/latest parameters: - - $ref: '#/components/parameters/cluster.post_voting_config_exclusions::query.node_ids' - - $ref: '#/components/parameters/cluster.post_voting_config_exclusions::query.node_names' - - $ref: '#/components/parameters/cluster.post_voting_config_exclusions::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' + - $ref: '#/components/parameters/cluster.post_voting_config_exclusions___query.node_ids' + - $ref: '#/components/parameters/cluster.post_voting_config_exclusions___query.node_names' + - $ref: '#/components/parameters/cluster.post_voting_config_exclusions___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/cluster.post_voting_config_exclusions@200' + $ref: '#/components/responses/cluster.post_voting_config_exclusions___200' /_component_template: get: operationId: cluster.get_component_template.0 @@ -1903,17 +1946,17 @@ paths: externalDocs: url: https://opensearch.org/docs/latest parameters: - - $ref: '#/components/parameters/cluster.get_component_template::query.cluster_manager_timeout' - - $ref: '#/components/parameters/cluster.get_component_template::query.local' - - $ref: '#/components/parameters/cluster.get_component_template::query.master_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' + - $ref: '#/components/parameters/cluster.get_component_template___query.cluster_manager_timeout' + - $ref: '#/components/parameters/cluster.get_component_template___query.local' + - $ref: '#/components/parameters/cluster.get_component_template___query.master_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/cluster.get_component_template@200' + $ref: '#/components/responses/cluster.get_component_template___200' /_component_template/{name}: delete: operationId: cluster.delete_component_template.0 @@ -1923,18 +1966,18 @@ paths: externalDocs: url: https://opensearch.org/docs/latest parameters: - - $ref: '#/components/parameters/cluster.delete_component_template::path.name' - - $ref: '#/components/parameters/cluster.delete_component_template::query.cluster_manager_timeout' - - $ref: '#/components/parameters/cluster.delete_component_template::query.master_timeout' - - $ref: '#/components/parameters/cluster.delete_component_template::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' + - $ref: '#/components/parameters/cluster.delete_component_template___path.name' + - $ref: '#/components/parameters/cluster.delete_component_template___query.cluster_manager_timeout' + - $ref: '#/components/parameters/cluster.delete_component_template___query.master_timeout' + - $ref: '#/components/parameters/cluster.delete_component_template___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/cluster.delete_component_template@200' + $ref: '#/components/responses/cluster.delete_component_template___200' get: operationId: cluster.get_component_template.1 x-operation-group: cluster.get_component_template @@ -1943,18 +1986,18 @@ paths: externalDocs: url: https://opensearch.org/docs/latest parameters: - - $ref: '#/components/parameters/cluster.get_component_template::path.name' - - $ref: '#/components/parameters/cluster.get_component_template::query.cluster_manager_timeout' - - $ref: '#/components/parameters/cluster.get_component_template::query.local' - - $ref: '#/components/parameters/cluster.get_component_template::query.master_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' + - $ref: '#/components/parameters/cluster.get_component_template___path.name' + - $ref: '#/components/parameters/cluster.get_component_template___query.cluster_manager_timeout' + - $ref: '#/components/parameters/cluster.get_component_template___query.local' + - $ref: '#/components/parameters/cluster.get_component_template___query.master_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/cluster.get_component_template@200' + $ref: '#/components/responses/cluster.get_component_template___200' head: operationId: cluster.exists_component_template.0 x-operation-group: cluster.exists_component_template @@ -1963,18 +2006,18 @@ paths: externalDocs: url: https://opensearch.org/docs/latest parameters: - - $ref: '#/components/parameters/cluster.exists_component_template::path.name' - - $ref: '#/components/parameters/cluster.exists_component_template::query.cluster_manager_timeout' - - $ref: '#/components/parameters/cluster.exists_component_template::query.local' - - $ref: '#/components/parameters/cluster.exists_component_template::query.master_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' + - $ref: '#/components/parameters/cluster.exists_component_template___path.name' + - $ref: '#/components/parameters/cluster.exists_component_template___query.cluster_manager_timeout' + - $ref: '#/components/parameters/cluster.exists_component_template___query.local' + - $ref: '#/components/parameters/cluster.exists_component_template___query.master_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/cluster.exists_component_template@200' + $ref: '#/components/responses/cluster.exists_component_template___200' post: operationId: cluster.put_component_template.0 x-operation-group: cluster.put_component_template @@ -1983,21 +2026,21 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/im-plugin/index-templates/#use-component-templates-to-create-an-index-template parameters: - - $ref: '#/components/parameters/cluster.put_component_template::path.name' - - $ref: '#/components/parameters/cluster.put_component_template::query.cluster_manager_timeout' - - $ref: '#/components/parameters/cluster.put_component_template::query.create' - - $ref: '#/components/parameters/cluster.put_component_template::query.master_timeout' - - $ref: '#/components/parameters/cluster.put_component_template::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' + - $ref: '#/components/parameters/cluster.put_component_template___path.name' + - $ref: '#/components/parameters/cluster.put_component_template___query.cluster_manager_timeout' + - $ref: '#/components/parameters/cluster.put_component_template___query.create' + - $ref: '#/components/parameters/cluster.put_component_template___query.master_timeout' + - $ref: '#/components/parameters/cluster.put_component_template___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' requestBody: $ref: '#/components/requestBodies/cluster.put_component_template' responses: '200': - $ref: '#/components/responses/cluster.put_component_template@200' + $ref: '#/components/responses/cluster.put_component_template___200' put: operationId: cluster.put_component_template.1 x-operation-group: cluster.put_component_template @@ -2006,21 +2049,21 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/im-plugin/index-templates/#use-component-templates-to-create-an-index-template parameters: - - $ref: '#/components/parameters/cluster.put_component_template::path.name' - - $ref: '#/components/parameters/cluster.put_component_template::query.cluster_manager_timeout' - - $ref: '#/components/parameters/cluster.put_component_template::query.create' - - $ref: '#/components/parameters/cluster.put_component_template::query.master_timeout' - - $ref: '#/components/parameters/cluster.put_component_template::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' + - $ref: '#/components/parameters/cluster.put_component_template___path.name' + - $ref: '#/components/parameters/cluster.put_component_template___query.cluster_manager_timeout' + - $ref: '#/components/parameters/cluster.put_component_template___query.create' + - $ref: '#/components/parameters/cluster.put_component_template___query.master_timeout' + - $ref: '#/components/parameters/cluster.put_component_template___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' requestBody: $ref: '#/components/requestBodies/cluster.put_component_template' responses: '200': - $ref: '#/components/responses/cluster.put_component_template@200' + $ref: '#/components/responses/cluster.put_component_template___200' /_count: get: operationId: count.0 @@ -2030,30 +2073,30 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/count/ parameters: - - $ref: '#/components/parameters/count::query.allow_no_indices' - - $ref: '#/components/parameters/count::query.analyze_wildcard' - - $ref: '#/components/parameters/count::query.analyzer' - - $ref: '#/components/parameters/count::query.default_operator' - - $ref: '#/components/parameters/count::query.df' - - $ref: '#/components/parameters/count::query.expand_wildcards' - - $ref: '#/components/parameters/count::query.ignore_throttled' - - $ref: '#/components/parameters/count::query.ignore_unavailable' - - $ref: '#/components/parameters/count::query.lenient' - - $ref: '#/components/parameters/count::query.min_score' - - $ref: '#/components/parameters/count::query.preference' - - $ref: '#/components/parameters/count::query.q' - - $ref: '#/components/parameters/count::query.routing' - - $ref: '#/components/parameters/count::query.terminate_after' - - $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' + - $ref: '#/components/parameters/count___query.allow_no_indices' + - $ref: '#/components/parameters/count___query.analyze_wildcard' + - $ref: '#/components/parameters/count___query.analyzer' + - $ref: '#/components/parameters/count___query.default_operator' + - $ref: '#/components/parameters/count___query.df' + - $ref: '#/components/parameters/count___query.expand_wildcards' + - $ref: '#/components/parameters/count___query.ignore_throttled' + - $ref: '#/components/parameters/count___query.ignore_unavailable' + - $ref: '#/components/parameters/count___query.lenient' + - $ref: '#/components/parameters/count___query.min_score' + - $ref: '#/components/parameters/count___query.preference' + - $ref: '#/components/parameters/count___query.q' + - $ref: '#/components/parameters/count___query.routing' + - $ref: '#/components/parameters/count___query.terminate_after' + - $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/count' responses: '200': - $ref: '#/components/responses/count@200' + $ref: '#/components/responses/count___200' post: operationId: count.1 x-operation-group: count @@ -2062,47 +2105,47 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/count/ parameters: - - $ref: '#/components/parameters/count::query.allow_no_indices' - - $ref: '#/components/parameters/count::query.analyze_wildcard' - - $ref: '#/components/parameters/count::query.analyzer' - - $ref: '#/components/parameters/count::query.default_operator' - - $ref: '#/components/parameters/count::query.df' - - $ref: '#/components/parameters/count::query.expand_wildcards' - - $ref: '#/components/parameters/count::query.ignore_throttled' - - $ref: '#/components/parameters/count::query.ignore_unavailable' - - $ref: '#/components/parameters/count::query.lenient' - - $ref: '#/components/parameters/count::query.min_score' - - $ref: '#/components/parameters/count::query.preference' - - $ref: '#/components/parameters/count::query.q' - - $ref: '#/components/parameters/count::query.routing' - - $ref: '#/components/parameters/count::query.terminate_after' - - $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' + - $ref: '#/components/parameters/count___query.allow_no_indices' + - $ref: '#/components/parameters/count___query.analyze_wildcard' + - $ref: '#/components/parameters/count___query.analyzer' + - $ref: '#/components/parameters/count___query.default_operator' + - $ref: '#/components/parameters/count___query.df' + - $ref: '#/components/parameters/count___query.expand_wildcards' + - $ref: '#/components/parameters/count___query.ignore_throttled' + - $ref: '#/components/parameters/count___query.ignore_unavailable' + - $ref: '#/components/parameters/count___query.lenient' + - $ref: '#/components/parameters/count___query.min_score' + - $ref: '#/components/parameters/count___query.preference' + - $ref: '#/components/parameters/count___query.q' + - $ref: '#/components/parameters/count___query.routing' + - $ref: '#/components/parameters/count___query.terminate_after' + - $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/count' responses: '200': - $ref: '#/components/responses/count@200' + $ref: '#/components/responses/count___200' /_dangling: get: operationId: dangling_indices.list_dangling_indices.0 x-operation-group: dangling_indices.list_dangling_indices x-version-added: '1.0' - description: Returns all dangling indices. + description: Returns all dangling indexes. externalDocs: url: https://opensearch.org/docs/latest/api-reference/index-apis/dangling-index/ 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' + - $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/dangling_indices.list_dangling_indices@200' + $ref: '#/components/responses/dangling_indices.list_dangling_indices___200' /_dangling/{index_uuid}: delete: operationId: dangling_indices.delete_dangling_index.0 @@ -2112,19 +2155,19 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/index-apis/dangling-index/ parameters: - - $ref: '#/components/parameters/dangling_indices.delete_dangling_index::path.index_uuid' - - $ref: '#/components/parameters/dangling_indices.delete_dangling_index::query.accept_data_loss' - - $ref: '#/components/parameters/dangling_indices.delete_dangling_index::query.cluster_manager_timeout' - - $ref: '#/components/parameters/dangling_indices.delete_dangling_index::query.master_timeout' - - $ref: '#/components/parameters/dangling_indices.delete_dangling_index::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' + - $ref: '#/components/parameters/dangling_indices.delete_dangling_index___path.index_uuid' + - $ref: '#/components/parameters/dangling_indices.delete_dangling_index___query.accept_data_loss' + - $ref: '#/components/parameters/dangling_indices.delete_dangling_index___query.cluster_manager_timeout' + - $ref: '#/components/parameters/dangling_indices.delete_dangling_index___query.master_timeout' + - $ref: '#/components/parameters/dangling_indices.delete_dangling_index___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/dangling_indices.delete_dangling_index@200' + '202': + $ref: '#/components/responses/dangling_indices.delete_dangling_index___202' post: operationId: dangling_indices.import_dangling_index.0 x-operation-group: dangling_indices.import_dangling_index @@ -2133,19 +2176,19 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/index-apis/dangling-index/ parameters: - - $ref: '#/components/parameters/dangling_indices.import_dangling_index::path.index_uuid' - - $ref: '#/components/parameters/dangling_indices.import_dangling_index::query.accept_data_loss' - - $ref: '#/components/parameters/dangling_indices.import_dangling_index::query.cluster_manager_timeout' - - $ref: '#/components/parameters/dangling_indices.import_dangling_index::query.master_timeout' - - $ref: '#/components/parameters/dangling_indices.import_dangling_index::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' + - $ref: '#/components/parameters/dangling_indices.import_dangling_index___path.index_uuid' + - $ref: '#/components/parameters/dangling_indices.import_dangling_index___query.accept_data_loss' + - $ref: '#/components/parameters/dangling_indices.import_dangling_index___query.cluster_manager_timeout' + - $ref: '#/components/parameters/dangling_indices.import_dangling_index___query.master_timeout' + - $ref: '#/components/parameters/dangling_indices.import_dangling_index___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/dangling_indices.import_dangling_index@200' + '202': + $ref: '#/components/responses/dangling_indices.import_dangling_index___202' /_data_stream: get: operationId: indices.get_data_stream.0 @@ -2155,14 +2198,14 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/im-plugin/data-streams/ 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' + - $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/indices.get_data_stream@200' + $ref: '#/components/responses/indices.get_data_stream___200' /_data_stream/_stats: get: operationId: indices.data_streams_stats.0 @@ -2172,14 +2215,14 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/im-plugin/data-streams/ 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' + - $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/indices.data_streams_stats@200' + $ref: '#/components/responses/indices.data_streams_stats___200' /_data_stream/{name}: delete: operationId: indices.delete_data_stream.0 @@ -2189,15 +2232,15 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/im-plugin/data-streams/ parameters: - - $ref: '#/components/parameters/indices.delete_data_stream::path.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' + - $ref: '#/components/parameters/indices.delete_data_stream___path.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/indices.delete_data_stream@200' + $ref: '#/components/responses/indices.delete_data_stream___200' get: operationId: indices.get_data_stream.1 x-operation-group: indices.get_data_stream @@ -2206,15 +2249,15 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/im-plugin/data-streams/ parameters: - - $ref: '#/components/parameters/indices.get_data_stream::path.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' + - $ref: '#/components/parameters/indices.get_data_stream___path.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/indices.get_data_stream@200' + $ref: '#/components/responses/indices.get_data_stream___200' put: operationId: indices.create_data_stream.0 x-operation-group: indices.create_data_stream @@ -2223,17 +2266,17 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/im-plugin/data-streams/ parameters: - - $ref: '#/components/parameters/indices.create_data_stream::path.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' + - $ref: '#/components/parameters/indices.create_data_stream___path.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' requestBody: $ref: '#/components/requestBodies/indices.create_data_stream' responses: '200': - $ref: '#/components/responses/indices.create_data_stream@200' + $ref: '#/components/responses/indices.create_data_stream___200' /_data_stream/{name}/_stats: get: operationId: indices.data_streams_stats.1 @@ -2243,15 +2286,15 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/im-plugin/data-streams/ parameters: - - $ref: '#/components/parameters/indices.data_streams_stats::path.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' + - $ref: '#/components/parameters/indices.data_streams_stats___path.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/indices.data_streams_stats@200' + $ref: '#/components/responses/indices.data_streams_stats___200' /_delete_by_query/{task_id}/_rethrottle: post: operationId: delete_by_query_rethrottle.0 @@ -2261,106 +2304,106 @@ paths: externalDocs: url: https://opensearch.org/docs/latest parameters: - - $ref: '#/components/parameters/delete_by_query_rethrottle::path.task_id' - - $ref: '#/components/parameters/delete_by_query_rethrottle::query.requests_per_second' - - $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' + - $ref: '#/components/parameters/delete_by_query_rethrottle___path.task_id' + - $ref: '#/components/parameters/delete_by_query_rethrottle___query.requests_per_second' + - $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/delete_by_query_rethrottle@200' + $ref: '#/components/responses/delete_by_query_rethrottle___200' /_field_caps: get: operationId: field_caps.0 x-operation-group: field_caps x-version-added: '1.0' - description: Returns the information about the capabilities of fields among multiple indices. + description: Returns the information about the capabilities of fields among multiple indexes. externalDocs: url: https://opensearch.org/docs/latest/field-types/supported-field-types/alias/#using-aliases-in-field-capabilities-api-operations parameters: - - $ref: '#/components/parameters/field_caps::query.allow_no_indices' - - $ref: '#/components/parameters/field_caps::query.expand_wildcards' - - $ref: '#/components/parameters/field_caps::query.fields' - - $ref: '#/components/parameters/field_caps::query.ignore_unavailable' - - $ref: '#/components/parameters/field_caps::query.include_unmapped' - - $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' + - $ref: '#/components/parameters/field_caps___query.allow_no_indices' + - $ref: '#/components/parameters/field_caps___query.expand_wildcards' + - $ref: '#/components/parameters/field_caps___query.fields' + - $ref: '#/components/parameters/field_caps___query.ignore_unavailable' + - $ref: '#/components/parameters/field_caps___query.include_unmapped' + - $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/field_caps' responses: '200': - $ref: '#/components/responses/field_caps@200' + $ref: '#/components/responses/field_caps___200' post: operationId: field_caps.1 x-operation-group: field_caps x-version-added: '1.0' - description: Returns the information about the capabilities of fields among multiple indices. + description: Returns the information about the capabilities of fields among multiple indexes. externalDocs: url: https://opensearch.org/docs/latest/field-types/supported-field-types/alias/#using-aliases-in-field-capabilities-api-operations parameters: - - $ref: '#/components/parameters/field_caps::query.allow_no_indices' - - $ref: '#/components/parameters/field_caps::query.expand_wildcards' - - $ref: '#/components/parameters/field_caps::query.fields' - - $ref: '#/components/parameters/field_caps::query.ignore_unavailable' - - $ref: '#/components/parameters/field_caps::query.include_unmapped' - - $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' + - $ref: '#/components/parameters/field_caps___query.allow_no_indices' + - $ref: '#/components/parameters/field_caps___query.expand_wildcards' + - $ref: '#/components/parameters/field_caps___query.fields' + - $ref: '#/components/parameters/field_caps___query.ignore_unavailable' + - $ref: '#/components/parameters/field_caps___query.include_unmapped' + - $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/field_caps' responses: '200': - $ref: '#/components/responses/field_caps@200' + $ref: '#/components/responses/field_caps___200' /_flush: get: operationId: indices.flush.0 x-operation-group: indices.flush x-version-added: '1.0' - description: Performs the flush operation on one or more indices. + description: Performs the flush operation on one or more indexes. externalDocs: url: https://opensearch.org/docs/latest parameters: - - $ref: '#/components/parameters/indices.flush::query.allow_no_indices' - - $ref: '#/components/parameters/indices.flush::query.expand_wildcards' - - $ref: '#/components/parameters/indices.flush::query.force' - - $ref: '#/components/parameters/indices.flush::query.ignore_unavailable' - - $ref: '#/components/parameters/indices.flush::query.wait_if_ongoing' - - $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' + - $ref: '#/components/parameters/indices.flush___query.allow_no_indices' + - $ref: '#/components/parameters/indices.flush___query.expand_wildcards' + - $ref: '#/components/parameters/indices.flush___query.force' + - $ref: '#/components/parameters/indices.flush___query.ignore_unavailable' + - $ref: '#/components/parameters/indices.flush___query.wait_if_ongoing' + - $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/indices.flush@200' + $ref: '#/components/responses/indices.flush___200' post: operationId: indices.flush.1 x-operation-group: indices.flush x-version-added: '1.0' - description: Performs the flush operation on one or more indices. + description: Performs the flush operation on one or more indexes. externalDocs: url: https://opensearch.org/docs/latest parameters: - - $ref: '#/components/parameters/indices.flush::query.allow_no_indices' - - $ref: '#/components/parameters/indices.flush::query.expand_wildcards' - - $ref: '#/components/parameters/indices.flush::query.force' - - $ref: '#/components/parameters/indices.flush::query.ignore_unavailable' - - $ref: '#/components/parameters/indices.flush::query.wait_if_ongoing' - - $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' + - $ref: '#/components/parameters/indices.flush___query.allow_no_indices' + - $ref: '#/components/parameters/indices.flush___query.expand_wildcards' + - $ref: '#/components/parameters/indices.flush___query.force' + - $ref: '#/components/parameters/indices.flush___query.ignore_unavailable' + - $ref: '#/components/parameters/indices.flush___query.wait_if_ongoing' + - $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/indices.flush@200' + $ref: '#/components/responses/indices.flush___200' /_forcemerge: post: operationId: indices.forcemerge.0 @@ -2369,26 +2412,26 @@ paths: x-distributions-excluded: - amazon-managed - amazon-serverless - description: Performs the force merge operation on one or more indices. + description: Performs the force merge operation on one or more indexes. externalDocs: url: https://opensearch.org/docs/latest parameters: - - $ref: '#/components/parameters/indices.forcemerge::query.allow_no_indices' - - $ref: '#/components/parameters/indices.forcemerge::query.expand_wildcards' - - $ref: '#/components/parameters/indices.forcemerge::query.flush' - - $ref: '#/components/parameters/indices.forcemerge::query.ignore_unavailable' - - $ref: '#/components/parameters/indices.forcemerge::query.max_num_segments' - - $ref: '#/components/parameters/indices.forcemerge::query.only_expunge_deletes' - - $ref: '#/components/parameters/indices.forcemerge::query.primary_only' - - $ref: '#/components/parameters/indices.forcemerge::query.wait_for_completion' - - $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/indices.forcemerge@200' + - $ref: '#/components/parameters/indices.forcemerge___query.allow_no_indices' + - $ref: '#/components/parameters/indices.forcemerge___query.expand_wildcards' + - $ref: '#/components/parameters/indices.forcemerge___query.flush' + - $ref: '#/components/parameters/indices.forcemerge___query.ignore_unavailable' + - $ref: '#/components/parameters/indices.forcemerge___query.max_num_segments' + - $ref: '#/components/parameters/indices.forcemerge___query.only_expunge_deletes' + - $ref: '#/components/parameters/indices.forcemerge___query.primary_only' + - $ref: '#/components/parameters/indices.forcemerge___query.wait_for_completion' + - $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/indices.forcemerge___200' /_index_template: get: operationId: indices.get_index_template.0 @@ -2398,18 +2441,18 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/im-plugin/index-templates/ parameters: - - $ref: '#/components/parameters/indices.get_index_template::query.cluster_manager_timeout' - - $ref: '#/components/parameters/indices.get_index_template::query.flat_settings' - - $ref: '#/components/parameters/indices.get_index_template::query.local' - - $ref: '#/components/parameters/indices.get_index_template::query.master_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' + - $ref: '#/components/parameters/indices.get_index_template___query.cluster_manager_timeout' + - $ref: '#/components/parameters/indices.get_index_template___query.flat_settings' + - $ref: '#/components/parameters/indices.get_index_template___query.local' + - $ref: '#/components/parameters/indices.get_index_template___query.master_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/indices.get_index_template@200' + $ref: '#/components/responses/indices.get_index_template___200' /_index_template/_simulate: post: operationId: indices.simulate_template.0 @@ -2419,20 +2462,20 @@ paths: externalDocs: url: https://opensearch.org/docs/latest parameters: - - $ref: '#/components/parameters/indices.simulate_template::query.cause' - - $ref: '#/components/parameters/indices.simulate_template::query.cluster_manager_timeout' - - $ref: '#/components/parameters/indices.simulate_template::query.create' - - $ref: '#/components/parameters/indices.simulate_template::query.master_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' + - $ref: '#/components/parameters/indices.simulate_template___query.cause' + - $ref: '#/components/parameters/indices.simulate_template___query.cluster_manager_timeout' + - $ref: '#/components/parameters/indices.simulate_template___query.create' + - $ref: '#/components/parameters/indices.simulate_template___query.master_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/indices.simulate_template' responses: '200': - $ref: '#/components/responses/indices.simulate_template@200' + $ref: '#/components/responses/indices.simulate_template___200' /_index_template/_simulate_index/{name}: post: operationId: indices.simulate_index_template.0 @@ -2442,21 +2485,21 @@ paths: externalDocs: url: https://opensearch.org/docs/latest parameters: - - $ref: '#/components/parameters/indices.simulate_index_template::path.name' - - $ref: '#/components/parameters/indices.simulate_index_template::query.cause' - - $ref: '#/components/parameters/indices.simulate_index_template::query.cluster_manager_timeout' - - $ref: '#/components/parameters/indices.simulate_index_template::query.create' - - $ref: '#/components/parameters/indices.simulate_index_template::query.master_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' + - $ref: '#/components/parameters/indices.simulate_index_template___path.name' + - $ref: '#/components/parameters/indices.simulate_index_template___query.cause' + - $ref: '#/components/parameters/indices.simulate_index_template___query.cluster_manager_timeout' + - $ref: '#/components/parameters/indices.simulate_index_template___query.create' + - $ref: '#/components/parameters/indices.simulate_index_template___query.master_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/indices.simulate_index_template' responses: '200': - $ref: '#/components/responses/indices.simulate_index_template@200' + $ref: '#/components/responses/indices.simulate_index_template___200' /_index_template/_simulate/{name}: post: operationId: indices.simulate_template.1 @@ -2466,21 +2509,21 @@ paths: externalDocs: url: https://opensearch.org/docs/latest parameters: - - $ref: '#/components/parameters/indices.simulate_template::path.name' - - $ref: '#/components/parameters/indices.simulate_template::query.cause' - - $ref: '#/components/parameters/indices.simulate_template::query.cluster_manager_timeout' - - $ref: '#/components/parameters/indices.simulate_template::query.create' - - $ref: '#/components/parameters/indices.simulate_template::query.master_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' + - $ref: '#/components/parameters/indices.simulate_template___path.name' + - $ref: '#/components/parameters/indices.simulate_template___query.cause' + - $ref: '#/components/parameters/indices.simulate_template___query.cluster_manager_timeout' + - $ref: '#/components/parameters/indices.simulate_template___query.create' + - $ref: '#/components/parameters/indices.simulate_template___query.master_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/indices.simulate_template' responses: '200': - $ref: '#/components/responses/indices.simulate_template@200' + $ref: '#/components/responses/indices.simulate_template___200' /_index_template/{name}: delete: operationId: indices.delete_index_template.0 @@ -2490,18 +2533,18 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/im-plugin/index-templates/#delete-a-template parameters: - - $ref: '#/components/parameters/indices.delete_index_template::path.name' - - $ref: '#/components/parameters/indices.delete_index_template::query.cluster_manager_timeout' - - $ref: '#/components/parameters/indices.delete_index_template::query.master_timeout' - - $ref: '#/components/parameters/indices.delete_index_template::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' + - $ref: '#/components/parameters/indices.delete_index_template___path.name' + - $ref: '#/components/parameters/indices.delete_index_template___query.cluster_manager_timeout' + - $ref: '#/components/parameters/indices.delete_index_template___query.master_timeout' + - $ref: '#/components/parameters/indices.delete_index_template___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/indices.delete_index_template@200' + $ref: '#/components/responses/indices.delete_index_template___200' get: operationId: indices.get_index_template.1 x-operation-group: indices.get_index_template @@ -2510,19 +2553,19 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/im-plugin/index-templates/ parameters: - - $ref: '#/components/parameters/indices.get_index_template::path.name' - - $ref: '#/components/parameters/indices.get_index_template::query.cluster_manager_timeout' - - $ref: '#/components/parameters/indices.get_index_template::query.flat_settings' - - $ref: '#/components/parameters/indices.get_index_template::query.local' - - $ref: '#/components/parameters/indices.get_index_template::query.master_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' + - $ref: '#/components/parameters/indices.get_index_template___path.name' + - $ref: '#/components/parameters/indices.get_index_template___query.cluster_manager_timeout' + - $ref: '#/components/parameters/indices.get_index_template___query.flat_settings' + - $ref: '#/components/parameters/indices.get_index_template___query.local' + - $ref: '#/components/parameters/indices.get_index_template___query.master_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/indices.get_index_template@200' + $ref: '#/components/responses/indices.get_index_template___200' head: operationId: indices.exists_index_template.0 x-operation-group: indices.exists_index_template @@ -2531,19 +2574,19 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/im-plugin/index-templates/ parameters: - - $ref: '#/components/parameters/indices.exists_index_template::path.name' - - $ref: '#/components/parameters/indices.exists_index_template::query.cluster_manager_timeout' - - $ref: '#/components/parameters/indices.exists_index_template::query.flat_settings' - - $ref: '#/components/parameters/indices.exists_index_template::query.local' - - $ref: '#/components/parameters/indices.exists_index_template::query.master_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' + - $ref: '#/components/parameters/indices.exists_index_template___path.name' + - $ref: '#/components/parameters/indices.exists_index_template___query.cluster_manager_timeout' + - $ref: '#/components/parameters/indices.exists_index_template___query.flat_settings' + - $ref: '#/components/parameters/indices.exists_index_template___query.local' + - $ref: '#/components/parameters/indices.exists_index_template___query.master_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/indices.exists_index_template@200' + $ref: '#/components/responses/indices.exists_index_template___200' post: operationId: indices.put_index_template.0 x-operation-group: indices.put_index_template @@ -2552,21 +2595,21 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/im-plugin/index-templates/ parameters: - - $ref: '#/components/parameters/indices.put_index_template::path.name' - - $ref: '#/components/parameters/indices.put_index_template::query.cause' - - $ref: '#/components/parameters/indices.put_index_template::query.cluster_manager_timeout' - - $ref: '#/components/parameters/indices.put_index_template::query.create' - - $ref: '#/components/parameters/indices.put_index_template::query.master_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' + - $ref: '#/components/parameters/indices.put_index_template___path.name' + - $ref: '#/components/parameters/indices.put_index_template___query.cause' + - $ref: '#/components/parameters/indices.put_index_template___query.cluster_manager_timeout' + - $ref: '#/components/parameters/indices.put_index_template___query.create' + - $ref: '#/components/parameters/indices.put_index_template___query.master_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/indices.put_index_template' responses: '200': - $ref: '#/components/responses/indices.put_index_template@200' + $ref: '#/components/responses/indices.put_index_template___200' put: operationId: indices.put_index_template.1 x-operation-group: indices.put_index_template @@ -2575,21 +2618,21 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/im-plugin/index-templates/ parameters: - - $ref: '#/components/parameters/indices.put_index_template::path.name' - - $ref: '#/components/parameters/indices.put_index_template::query.cause' - - $ref: '#/components/parameters/indices.put_index_template::query.cluster_manager_timeout' - - $ref: '#/components/parameters/indices.put_index_template::query.create' - - $ref: '#/components/parameters/indices.put_index_template::query.master_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' + - $ref: '#/components/parameters/indices.put_index_template___path.name' + - $ref: '#/components/parameters/indices.put_index_template___query.cause' + - $ref: '#/components/parameters/indices.put_index_template___query.cluster_manager_timeout' + - $ref: '#/components/parameters/indices.put_index_template___query.create' + - $ref: '#/components/parameters/indices.put_index_template___query.master_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/indices.put_index_template' responses: '200': - $ref: '#/components/responses/indices.put_index_template@200' + $ref: '#/components/responses/indices.put_index_template___200' /_ingest/pipeline: get: operationId: ingest.get_pipeline.0 @@ -2599,16 +2642,16 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/ingest-apis/get-ingest/ parameters: - - $ref: '#/components/parameters/ingest.get_pipeline::query.cluster_manager_timeout' - - $ref: '#/components/parameters/ingest.get_pipeline::query.master_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' + - $ref: '#/components/parameters/ingest.get_pipeline___query.cluster_manager_timeout' + - $ref: '#/components/parameters/ingest.get_pipeline___query.master_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/ingest.get_pipeline@200' + $ref: '#/components/responses/ingest.get_pipeline___200' /_ingest/pipeline/_simulate: get: operationId: ingest.simulate.0 @@ -2618,17 +2661,17 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/ingest-apis/simulate-ingest/ parameters: - - $ref: '#/components/parameters/ingest.simulate::query.verbose' - - $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' + - $ref: '#/components/parameters/ingest.simulate___query.verbose' + - $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/ingest.simulate' responses: '200': - $ref: '#/components/responses/ingest.simulate@200' + $ref: '#/components/responses/ingest.simulate___200' post: operationId: ingest.simulate.1 x-operation-group: ingest.simulate @@ -2637,17 +2680,17 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/ingest-apis/simulate-ingest/ parameters: - - $ref: '#/components/parameters/ingest.simulate::query.verbose' - - $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' + - $ref: '#/components/parameters/ingest.simulate___query.verbose' + - $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/ingest.simulate' responses: '200': - $ref: '#/components/responses/ingest.simulate@200' + $ref: '#/components/responses/ingest.simulate___200' /_ingest/pipeline/{id}: delete: operationId: ingest.delete_pipeline.0 @@ -2657,18 +2700,18 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/ingest-apis/delete-ingest/ parameters: - - $ref: '#/components/parameters/ingest.delete_pipeline::path.id' - - $ref: '#/components/parameters/ingest.delete_pipeline::query.cluster_manager_timeout' - - $ref: '#/components/parameters/ingest.delete_pipeline::query.master_timeout' - - $ref: '#/components/parameters/ingest.delete_pipeline::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' + - $ref: '#/components/parameters/ingest.delete_pipeline___path.id' + - $ref: '#/components/parameters/ingest.delete_pipeline___query.cluster_manager_timeout' + - $ref: '#/components/parameters/ingest.delete_pipeline___query.master_timeout' + - $ref: '#/components/parameters/ingest.delete_pipeline___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/ingest.delete_pipeline@200' + $ref: '#/components/responses/ingest.delete_pipeline___200' get: operationId: ingest.get_pipeline.1 x-operation-group: ingest.get_pipeline @@ -2677,17 +2720,17 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/ingest-apis/get-ingest/ parameters: - - $ref: '#/components/parameters/ingest.get_pipeline::path.id' - - $ref: '#/components/parameters/ingest.get_pipeline::query.cluster_manager_timeout' - - $ref: '#/components/parameters/ingest.get_pipeline::query.master_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' + - $ref: '#/components/parameters/ingest.get_pipeline___path.id' + - $ref: '#/components/parameters/ingest.get_pipeline___query.cluster_manager_timeout' + - $ref: '#/components/parameters/ingest.get_pipeline___query.master_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/ingest.get_pipeline@200' + $ref: '#/components/responses/ingest.get_pipeline___200' put: operationId: ingest.put_pipeline.0 x-operation-group: ingest.put_pipeline @@ -2696,20 +2739,20 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/ingest-apis/create-update-ingest/ parameters: - - $ref: '#/components/parameters/ingest.put_pipeline::path.id' - - $ref: '#/components/parameters/ingest.put_pipeline::query.cluster_manager_timeout' - - $ref: '#/components/parameters/ingest.put_pipeline::query.master_timeout' - - $ref: '#/components/parameters/ingest.put_pipeline::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' + - $ref: '#/components/parameters/ingest.put_pipeline___path.id' + - $ref: '#/components/parameters/ingest.put_pipeline___query.cluster_manager_timeout' + - $ref: '#/components/parameters/ingest.put_pipeline___query.master_timeout' + - $ref: '#/components/parameters/ingest.put_pipeline___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' requestBody: $ref: '#/components/requestBodies/ingest.put_pipeline' responses: '200': - $ref: '#/components/responses/ingest.put_pipeline@200' + $ref: '#/components/responses/ingest.put_pipeline___200' /_ingest/pipeline/{id}/_simulate: get: operationId: ingest.simulate.2 @@ -2719,18 +2762,18 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/ingest-apis/simulate-ingest/ parameters: - - $ref: '#/components/parameters/ingest.simulate::path.id' - - $ref: '#/components/parameters/ingest.simulate::query.verbose' - - $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' + - $ref: '#/components/parameters/ingest.simulate___path.id' + - $ref: '#/components/parameters/ingest.simulate___query.verbose' + - $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/ingest.simulate' responses: '200': - $ref: '#/components/responses/ingest.simulate@200' + $ref: '#/components/responses/ingest.simulate___200' post: operationId: ingest.simulate.3 x-operation-group: ingest.simulate @@ -2739,18 +2782,18 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/ingest-apis/simulate-ingest/ parameters: - - $ref: '#/components/parameters/ingest.simulate::path.id' - - $ref: '#/components/parameters/ingest.simulate::query.verbose' - - $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' + - $ref: '#/components/parameters/ingest.simulate___path.id' + - $ref: '#/components/parameters/ingest.simulate___query.verbose' + - $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/ingest.simulate' responses: '200': - $ref: '#/components/responses/ingest.simulate@200' + $ref: '#/components/responses/ingest.simulate___200' /_ingest/processor/grok: get: operationId: ingest.processor_grok.0 @@ -2760,38 +2803,202 @@ paths: externalDocs: url: https://opensearch.org/docs/latest 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' - responses: - '200': - $ref: '#/components/responses/ingest.processor_grok@200' + - $ref: '#/components/parameters/ingest.processor_grok___query.s' + - $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/ingest.processor_grok___200' + /_insights/top_queries: + get: + operationId: insights.top_queries.0 + x-operation-group: insights.top_queries + x-version-added: '1.0' + description: Retrieves the top queries based on the given metric type (latency, CPU, or memory). + parameters: + - $ref: '#/components/parameters/insights.top_queries___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/insights.top_queries___200' + /_list: + get: + operationId: list.help.0 + x-operation-group: list.help + x-version-added: '2.18' + description: Returns help for the List APIs. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/list/index/ + responses: + '200': + $ref: '#/components/responses/list.help___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' + /_list/indices: + get: + operationId: list.indices.0 + x-operation-group: list.indices + x-version-added: '2.18' + description: Returns paginated information about indexes including number of primaries and replicas, document counts, disk size. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/list/list-indices/ + parameters: + - $ref: '#/components/parameters/list.indices___query.bytes' + - $ref: '#/components/parameters/list.indices___query.cluster_manager_timeout' + - $ref: '#/components/parameters/list.indices___query.expand_wildcards' + - $ref: '#/components/parameters/list.indices___query.format' + - $ref: '#/components/parameters/list.indices___query.h' + - $ref: '#/components/parameters/list.indices___query.health' + - $ref: '#/components/parameters/list.indices___query.help' + - $ref: '#/components/parameters/list.indices___query.include_unloaded_segments' + - $ref: '#/components/parameters/list.indices___query.local' + - $ref: '#/components/parameters/list.indices___query.master_timeout' + - $ref: '#/components/parameters/list.indices___query.next_token' + - $ref: '#/components/parameters/list.indices___query.pri' + - $ref: '#/components/parameters/list.indices___query.s' + - $ref: '#/components/parameters/list.indices___query.size' + - $ref: '#/components/parameters/list.indices___query.sort' + - $ref: '#/components/parameters/list.indices___query.time' + - $ref: '#/components/parameters/list.indices___query.v' + - $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/list.indices___200' + /_list/indices/{index}: + get: + operationId: list.indices.1 + x-operation-group: list.indices + x-version-added: '2.18' + description: Returns paginated information about indexes including number of primaries and replicas, document counts, disk size. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/list/list-indices/ + parameters: + - $ref: '#/components/parameters/list.indices___path.index' + - $ref: '#/components/parameters/list.indices___query.bytes' + - $ref: '#/components/parameters/list.indices___query.cluster_manager_timeout' + - $ref: '#/components/parameters/list.indices___query.expand_wildcards' + - $ref: '#/components/parameters/list.indices___query.format' + - $ref: '#/components/parameters/list.indices___query.h' + - $ref: '#/components/parameters/list.indices___query.health' + - $ref: '#/components/parameters/list.indices___query.help' + - $ref: '#/components/parameters/list.indices___query.include_unloaded_segments' + - $ref: '#/components/parameters/list.indices___query.local' + - $ref: '#/components/parameters/list.indices___query.master_timeout' + - $ref: '#/components/parameters/list.indices___query.next_token' + - $ref: '#/components/parameters/list.indices___query.pri' + - $ref: '#/components/parameters/list.indices___query.s' + - $ref: '#/components/parameters/list.indices___query.size' + - $ref: '#/components/parameters/list.indices___query.sort' + - $ref: '#/components/parameters/list.indices___query.time' + - $ref: '#/components/parameters/list.indices___query.v' + - $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/list.indices___200' + /_list/shards: + get: + operationId: list.shards.0 + x-operation-group: list.shards + x-version-added: '2.18' + description: Returns paginated details of shard allocation on nodes. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/list/list-shards/ + parameters: + - $ref: '#/components/parameters/list.shards___query.bytes' + - $ref: '#/components/parameters/list.shards___query.cluster_manager_timeout' + - $ref: '#/components/parameters/list.shards___query.format' + - $ref: '#/components/parameters/list.shards___query.h' + - $ref: '#/components/parameters/list.shards___query.help' + - $ref: '#/components/parameters/list.shards___query.local' + - $ref: '#/components/parameters/list.shards___query.master_timeout' + - $ref: '#/components/parameters/list.shards___query.next_token' + - $ref: '#/components/parameters/list.shards___query.s' + - $ref: '#/components/parameters/list.shards___query.size' + - $ref: '#/components/parameters/list.shards___query.sort' + - $ref: '#/components/parameters/list.shards___query.time' + - $ref: '#/components/parameters/list.shards___query.v' + - $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/list.shards___200' + /_list/shards/{index}: + get: + operationId: list.shards.1 + x-operation-group: list.shards + x-version-added: '2.18' + description: Returns paginated details of shard allocation on nodes. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/list/list-shards/ + parameters: + - $ref: '#/components/parameters/list.shards___path.index' + - $ref: '#/components/parameters/list.shards___query.bytes' + - $ref: '#/components/parameters/list.shards___query.cluster_manager_timeout' + - $ref: '#/components/parameters/list.shards___query.format' + - $ref: '#/components/parameters/list.shards___query.h' + - $ref: '#/components/parameters/list.shards___query.help' + - $ref: '#/components/parameters/list.shards___query.local' + - $ref: '#/components/parameters/list.shards___query.master_timeout' + - $ref: '#/components/parameters/list.shards___query.next_token' + - $ref: '#/components/parameters/list.shards___query.s' + - $ref: '#/components/parameters/list.shards___query.size' + - $ref: '#/components/parameters/list.shards___query.sort' + - $ref: '#/components/parameters/list.shards___query.time' + - $ref: '#/components/parameters/list.shards___query.v' + - $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/list.shards___200' /_mapping: get: operationId: indices.get_mapping.0 x-operation-group: indices.get_mapping x-version-added: '1.0' - description: Returns mappings for one or more indices. + description: Returns mappings for one or more indexes. externalDocs: url: https://opensearch.org/docs/latest/field-types/index/#get-a-mapping parameters: - - $ref: '#/components/parameters/indices.get_mapping::query.allow_no_indices' - - $ref: '#/components/parameters/indices.get_mapping::query.cluster_manager_timeout' - - $ref: '#/components/parameters/indices.get_mapping::query.expand_wildcards' - - $ref: '#/components/parameters/indices.get_mapping::query.ignore_unavailable' - - $ref: '#/components/parameters/indices.get_mapping::query.index' - - $ref: '#/components/parameters/indices.get_mapping::query.local' - - $ref: '#/components/parameters/indices.get_mapping::query.master_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/indices.get_mapping@200' + - $ref: '#/components/parameters/indices.get_mapping___query.allow_no_indices' + - $ref: '#/components/parameters/indices.get_mapping___query.cluster_manager_timeout' + - $ref: '#/components/parameters/indices.get_mapping___query.expand_wildcards' + - $ref: '#/components/parameters/indices.get_mapping___query.ignore_unavailable' + - $ref: '#/components/parameters/indices.get_mapping___query.index' + - $ref: '#/components/parameters/indices.get_mapping___query.local' + - $ref: '#/components/parameters/indices.get_mapping___query.master_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/indices.get_mapping___200' /_mapping/field/{fields}: get: operationId: indices.get_field_mapping.0 @@ -2801,20 +3008,20 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/field-types/index/ parameters: - - $ref: '#/components/parameters/indices.get_field_mapping::path.fields' - - $ref: '#/components/parameters/indices.get_field_mapping::query.allow_no_indices' - - $ref: '#/components/parameters/indices.get_field_mapping::query.expand_wildcards' - - $ref: '#/components/parameters/indices.get_field_mapping::query.ignore_unavailable' - - $ref: '#/components/parameters/indices.get_field_mapping::query.include_defaults' - - $ref: '#/components/parameters/indices.get_field_mapping::query.local' - - $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' + - $ref: '#/components/parameters/indices.get_field_mapping___path.fields' + - $ref: '#/components/parameters/indices.get_field_mapping___query.allow_no_indices' + - $ref: '#/components/parameters/indices.get_field_mapping___query.expand_wildcards' + - $ref: '#/components/parameters/indices.get_field_mapping___query.ignore_unavailable' + - $ref: '#/components/parameters/indices.get_field_mapping___query.include_defaults' + - $ref: '#/components/parameters/indices.get_field_mapping___query.local' + - $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/indices.get_field_mapping@200' + $ref: '#/components/responses/indices.get_field_mapping___200' /_mget: get: operationId: mget.0 @@ -2824,24 +3031,24 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/document-apis/multi-get/ parameters: - - $ref: '#/components/parameters/mget::query._source' - - $ref: '#/components/parameters/mget::query._source_excludes' - - $ref: '#/components/parameters/mget::query._source_includes' - - $ref: '#/components/parameters/mget::query.preference' - - $ref: '#/components/parameters/mget::query.realtime' - - $ref: '#/components/parameters/mget::query.refresh' - - $ref: '#/components/parameters/mget::query.routing' - - $ref: '#/components/parameters/mget::query.stored_fields' - - $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' + - $ref: '#/components/parameters/mget___query._source' + - $ref: '#/components/parameters/mget___query._source_excludes' + - $ref: '#/components/parameters/mget___query._source_includes' + - $ref: '#/components/parameters/mget___query.preference' + - $ref: '#/components/parameters/mget___query.realtime' + - $ref: '#/components/parameters/mget___query.refresh' + - $ref: '#/components/parameters/mget___query.routing' + - $ref: '#/components/parameters/mget___query.stored_fields' + - $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/mget' responses: '200': - $ref: '#/components/responses/mget@200' + $ref: '#/components/responses/mget___200' post: operationId: mget.1 x-operation-group: mget @@ -2850,24 +3057,24 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/document-apis/multi-get/ parameters: - - $ref: '#/components/parameters/mget::query._source' - - $ref: '#/components/parameters/mget::query._source_excludes' - - $ref: '#/components/parameters/mget::query._source_includes' - - $ref: '#/components/parameters/mget::query.preference' - - $ref: '#/components/parameters/mget::query.realtime' - - $ref: '#/components/parameters/mget::query.refresh' - - $ref: '#/components/parameters/mget::query.routing' - - $ref: '#/components/parameters/mget::query.stored_fields' - - $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' + - $ref: '#/components/parameters/mget___query._source' + - $ref: '#/components/parameters/mget___query._source_excludes' + - $ref: '#/components/parameters/mget___query._source_includes' + - $ref: '#/components/parameters/mget___query.preference' + - $ref: '#/components/parameters/mget___query.realtime' + - $ref: '#/components/parameters/mget___query.refresh' + - $ref: '#/components/parameters/mget___query.routing' + - $ref: '#/components/parameters/mget___query.stored_fields' + - $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/mget' responses: '200': - $ref: '#/components/responses/mget@200' + $ref: '#/components/responses/mget___200' /_msearch: get: operationId: msearch.0 @@ -2877,23 +3084,23 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/multi-search/ parameters: - - $ref: '#/components/parameters/msearch::query.ccs_minimize_roundtrips' - - $ref: '#/components/parameters/msearch::query.max_concurrent_searches' - - $ref: '#/components/parameters/msearch::query.max_concurrent_shard_requests' - - $ref: '#/components/parameters/msearch::query.pre_filter_shard_size' - - $ref: '#/components/parameters/msearch::query.rest_total_hits_as_int' - - $ref: '#/components/parameters/msearch::query.search_type' - - $ref: '#/components/parameters/msearch::query.typed_keys' - - $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' + - $ref: '#/components/parameters/msearch___query.ccs_minimize_roundtrips' + - $ref: '#/components/parameters/msearch___query.max_concurrent_searches' + - $ref: '#/components/parameters/msearch___query.max_concurrent_shard_requests' + - $ref: '#/components/parameters/msearch___query.pre_filter_shard_size' + - $ref: '#/components/parameters/msearch___query.rest_total_hits_as_int' + - $ref: '#/components/parameters/msearch___query.search_type' + - $ref: '#/components/parameters/msearch___query.typed_keys' + - $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/msearch' responses: '200': - $ref: '#/components/responses/msearch@200' + $ref: '#/components/responses/msearch___200' post: operationId: msearch.1 x-operation-group: msearch @@ -2902,23 +3109,23 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/multi-search/ parameters: - - $ref: '#/components/parameters/msearch::query.ccs_minimize_roundtrips' - - $ref: '#/components/parameters/msearch::query.max_concurrent_searches' - - $ref: '#/components/parameters/msearch::query.max_concurrent_shard_requests' - - $ref: '#/components/parameters/msearch::query.pre_filter_shard_size' - - $ref: '#/components/parameters/msearch::query.rest_total_hits_as_int' - - $ref: '#/components/parameters/msearch::query.search_type' - - $ref: '#/components/parameters/msearch::query.typed_keys' - - $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' + - $ref: '#/components/parameters/msearch___query.ccs_minimize_roundtrips' + - $ref: '#/components/parameters/msearch___query.max_concurrent_searches' + - $ref: '#/components/parameters/msearch___query.max_concurrent_shard_requests' + - $ref: '#/components/parameters/msearch___query.pre_filter_shard_size' + - $ref: '#/components/parameters/msearch___query.rest_total_hits_as_int' + - $ref: '#/components/parameters/msearch___query.search_type' + - $ref: '#/components/parameters/msearch___query.typed_keys' + - $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/msearch' responses: '200': - $ref: '#/components/responses/msearch@200' + $ref: '#/components/responses/msearch___200' /_msearch/template: get: operationId: msearch_template.0 @@ -2928,21 +3135,21 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/search-plugins/search-template/ parameters: - - $ref: '#/components/parameters/msearch_template::query.ccs_minimize_roundtrips' - - $ref: '#/components/parameters/msearch_template::query.max_concurrent_searches' - - $ref: '#/components/parameters/msearch_template::query.rest_total_hits_as_int' - - $ref: '#/components/parameters/msearch_template::query.search_type' - - $ref: '#/components/parameters/msearch_template::query.typed_keys' - - $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' + - $ref: '#/components/parameters/msearch_template___query.ccs_minimize_roundtrips' + - $ref: '#/components/parameters/msearch_template___query.max_concurrent_searches' + - $ref: '#/components/parameters/msearch_template___query.rest_total_hits_as_int' + - $ref: '#/components/parameters/msearch_template___query.search_type' + - $ref: '#/components/parameters/msearch_template___query.typed_keys' + - $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/msearch_template' responses: '200': - $ref: '#/components/responses/msearch_template@200' + $ref: '#/components/responses/msearch_template___200' post: operationId: msearch_template.1 x-operation-group: msearch_template @@ -2951,21 +3158,21 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/search-plugins/search-template/ parameters: - - $ref: '#/components/parameters/msearch_template::query.ccs_minimize_roundtrips' - - $ref: '#/components/parameters/msearch_template::query.max_concurrent_searches' - - $ref: '#/components/parameters/msearch_template::query.rest_total_hits_as_int' - - $ref: '#/components/parameters/msearch_template::query.search_type' - - $ref: '#/components/parameters/msearch_template::query.typed_keys' - - $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' + - $ref: '#/components/parameters/msearch_template___query.ccs_minimize_roundtrips' + - $ref: '#/components/parameters/msearch_template___query.max_concurrent_searches' + - $ref: '#/components/parameters/msearch_template___query.rest_total_hits_as_int' + - $ref: '#/components/parameters/msearch_template___query.search_type' + - $ref: '#/components/parameters/msearch_template___query.typed_keys' + - $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/msearch_template' responses: '200': - $ref: '#/components/responses/msearch_template@200' + $ref: '#/components/responses/msearch_template___200' /_mtermvectors: get: operationId: mtermvectors.0 @@ -2975,28 +3182,28 @@ paths: externalDocs: url: https://opensearch.org/docs/latest parameters: - - $ref: '#/components/parameters/mtermvectors::query.field_statistics' - - $ref: '#/components/parameters/mtermvectors::query.fields' - - $ref: '#/components/parameters/mtermvectors::query.ids' - - $ref: '#/components/parameters/mtermvectors::query.offsets' - - $ref: '#/components/parameters/mtermvectors::query.payloads' - - $ref: '#/components/parameters/mtermvectors::query.positions' - - $ref: '#/components/parameters/mtermvectors::query.preference' - - $ref: '#/components/parameters/mtermvectors::query.realtime' - - $ref: '#/components/parameters/mtermvectors::query.routing' - - $ref: '#/components/parameters/mtermvectors::query.term_statistics' - - $ref: '#/components/parameters/mtermvectors::query.version' - - $ref: '#/components/parameters/mtermvectors::query.version_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' + - $ref: '#/components/parameters/mtermvectors___query.field_statistics' + - $ref: '#/components/parameters/mtermvectors___query.fields' + - $ref: '#/components/parameters/mtermvectors___query.ids' + - $ref: '#/components/parameters/mtermvectors___query.offsets' + - $ref: '#/components/parameters/mtermvectors___query.payloads' + - $ref: '#/components/parameters/mtermvectors___query.positions' + - $ref: '#/components/parameters/mtermvectors___query.preference' + - $ref: '#/components/parameters/mtermvectors___query.realtime' + - $ref: '#/components/parameters/mtermvectors___query.routing' + - $ref: '#/components/parameters/mtermvectors___query.term_statistics' + - $ref: '#/components/parameters/mtermvectors___query.version' + - $ref: '#/components/parameters/mtermvectors___query.version_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' requestBody: $ref: '#/components/requestBodies/mtermvectors' responses: '200': - $ref: '#/components/responses/mtermvectors@200' + $ref: '#/components/responses/mtermvectors___200' post: operationId: mtermvectors.1 x-operation-group: mtermvectors @@ -3005,28 +3212,28 @@ paths: externalDocs: url: https://opensearch.org/docs/latest parameters: - - $ref: '#/components/parameters/mtermvectors::query.field_statistics' - - $ref: '#/components/parameters/mtermvectors::query.fields' - - $ref: '#/components/parameters/mtermvectors::query.ids' - - $ref: '#/components/parameters/mtermvectors::query.offsets' - - $ref: '#/components/parameters/mtermvectors::query.payloads' - - $ref: '#/components/parameters/mtermvectors::query.positions' - - $ref: '#/components/parameters/mtermvectors::query.preference' - - $ref: '#/components/parameters/mtermvectors::query.realtime' - - $ref: '#/components/parameters/mtermvectors::query.routing' - - $ref: '#/components/parameters/mtermvectors::query.term_statistics' - - $ref: '#/components/parameters/mtermvectors::query.version' - - $ref: '#/components/parameters/mtermvectors::query.version_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' + - $ref: '#/components/parameters/mtermvectors___query.field_statistics' + - $ref: '#/components/parameters/mtermvectors___query.fields' + - $ref: '#/components/parameters/mtermvectors___query.ids' + - $ref: '#/components/parameters/mtermvectors___query.offsets' + - $ref: '#/components/parameters/mtermvectors___query.payloads' + - $ref: '#/components/parameters/mtermvectors___query.positions' + - $ref: '#/components/parameters/mtermvectors___query.preference' + - $ref: '#/components/parameters/mtermvectors___query.realtime' + - $ref: '#/components/parameters/mtermvectors___query.routing' + - $ref: '#/components/parameters/mtermvectors___query.term_statistics' + - $ref: '#/components/parameters/mtermvectors___query.version' + - $ref: '#/components/parameters/mtermvectors___query.version_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' requestBody: $ref: '#/components/requestBodies/mtermvectors' responses: '200': - $ref: '#/components/responses/mtermvectors@200' + $ref: '#/components/responses/mtermvectors___200' /_nodes: get: operationId: nodes.info.0 @@ -3036,16 +3243,16 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/nodes-apis/nodes-info/ parameters: - - $ref: '#/components/parameters/nodes.info::query.flat_settings' - - $ref: '#/components/parameters/nodes.info::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' + - $ref: '#/components/parameters/nodes.info___query.flat_settings' + - $ref: '#/components/parameters/nodes.info___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/nodes.info@200' + $ref: '#/components/responses/nodes.info___200' /_nodes/{node_id_or_metric}: get: operationId: nodes.info.1 @@ -3055,17 +3262,17 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/nodes-apis/nodes-info/ parameters: - - $ref: '#/components/parameters/nodes.info::path.node_id_or_metric' - - $ref: '#/components/parameters/nodes.info::query.flat_settings' - - $ref: '#/components/parameters/nodes.info::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' + - $ref: '#/components/parameters/nodes.info___path.node_id_or_metric' + - $ref: '#/components/parameters/nodes.info___query.flat_settings' + - $ref: '#/components/parameters/nodes.info___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/nodes.info@200' + $ref: '#/components/responses/nodes.info___200' /_nodes/{node_id}/{metric}: get: operationId: nodes.info.3 @@ -3075,18 +3282,18 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/nodes-apis/nodes-info/ parameters: - - $ref: '#/components/parameters/nodes.info::path.metric' - - $ref: '#/components/parameters/nodes.info::path.node_id' - - $ref: '#/components/parameters/nodes.info::query.flat_settings' - - $ref: '#/components/parameters/nodes.info::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' + - $ref: '#/components/parameters/nodes.info___path.metric' + - $ref: '#/components/parameters/nodes.info___path.node_id' + - $ref: '#/components/parameters/nodes.info___query.flat_settings' + - $ref: '#/components/parameters/nodes.info___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/nodes.info@200' + $ref: '#/components/responses/nodes.info___200' /_nodes/{node_id}/hot_threads: get: operationId: nodes.hot_threads.6 @@ -3096,21 +3303,21 @@ paths: 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' + - $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 @@ -3120,18 +3327,18 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/nodes-apis/nodes-reload-secure/ parameters: - - $ref: '#/components/parameters/nodes.reload_secure_settings::path.node_id' - - $ref: '#/components/parameters/nodes.reload_secure_settings::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' + - $ref: '#/components/parameters/nodes.reload_secure_settings___path.node_id' + - $ref: '#/components/parameters/nodes.reload_secure_settings___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' requestBody: $ref: '#/components/requestBodies/nodes.reload_secure_settings' responses: '200': - $ref: '#/components/responses/nodes.reload_secure_settings@200' + $ref: '#/components/responses/nodes.reload_secure_settings___200' /_nodes/{node_id}/stats: get: operationId: nodes.stats.3 @@ -3141,23 +3348,23 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/nodes-apis/nodes-usage/ parameters: - - $ref: '#/components/parameters/nodes.stats::path.node_id' - - $ref: '#/components/parameters/nodes.stats::query.completion_fields' - - $ref: '#/components/parameters/nodes.stats::query.fielddata_fields' - - $ref: '#/components/parameters/nodes.stats::query.fields' - - $ref: '#/components/parameters/nodes.stats::query.groups' - - $ref: '#/components/parameters/nodes.stats::query.include_segment_file_sizes' - - $ref: '#/components/parameters/nodes.stats::query.level' - - $ref: '#/components/parameters/nodes.stats::query.timeout' - - $ref: '#/components/parameters/nodes.stats::query.types' - - $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.stats@200' + - $ref: '#/components/parameters/nodes.stats___path.node_id' + - $ref: '#/components/parameters/nodes.stats___query.completion_fields' + - $ref: '#/components/parameters/nodes.stats___query.fielddata_fields' + - $ref: '#/components/parameters/nodes.stats___query.fields' + - $ref: '#/components/parameters/nodes.stats___query.groups' + - $ref: '#/components/parameters/nodes.stats___query.include_segment_file_sizes' + - $ref: '#/components/parameters/nodes.stats___query.level' + - $ref: '#/components/parameters/nodes.stats___query.timeout' + - $ref: '#/components/parameters/nodes.stats___query.types' + - $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.stats___200' /_nodes/{node_id}/stats/{metric}: get: operationId: nodes.stats.4 @@ -3167,24 +3374,24 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/nodes-apis/nodes-usage/ parameters: - - $ref: '#/components/parameters/nodes.stats::path.metric' - - $ref: '#/components/parameters/nodes.stats::path.node_id' - - $ref: '#/components/parameters/nodes.stats::query.completion_fields' - - $ref: '#/components/parameters/nodes.stats::query.fielddata_fields' - - $ref: '#/components/parameters/nodes.stats::query.fields' - - $ref: '#/components/parameters/nodes.stats::query.groups' - - $ref: '#/components/parameters/nodes.stats::query.include_segment_file_sizes' - - $ref: '#/components/parameters/nodes.stats::query.level' - - $ref: '#/components/parameters/nodes.stats::query.timeout' - - $ref: '#/components/parameters/nodes.stats::query.types' - - $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.stats@200' + - $ref: '#/components/parameters/nodes.stats___path.metric' + - $ref: '#/components/parameters/nodes.stats___path.node_id' + - $ref: '#/components/parameters/nodes.stats___query.completion_fields' + - $ref: '#/components/parameters/nodes.stats___query.fielddata_fields' + - $ref: '#/components/parameters/nodes.stats___query.fields' + - $ref: '#/components/parameters/nodes.stats___query.groups' + - $ref: '#/components/parameters/nodes.stats___query.include_segment_file_sizes' + - $ref: '#/components/parameters/nodes.stats___query.level' + - $ref: '#/components/parameters/nodes.stats___query.timeout' + - $ref: '#/components/parameters/nodes.stats___query.types' + - $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.stats___200' /_nodes/{node_id}/stats/{metric}/{index_metric}: get: operationId: nodes.stats.5 @@ -3194,25 +3401,25 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/nodes-apis/nodes-usage/ parameters: - - $ref: '#/components/parameters/nodes.stats::path.index_metric' - - $ref: '#/components/parameters/nodes.stats::path.metric' - - $ref: '#/components/parameters/nodes.stats::path.node_id' - - $ref: '#/components/parameters/nodes.stats::query.completion_fields' - - $ref: '#/components/parameters/nodes.stats::query.fielddata_fields' - - $ref: '#/components/parameters/nodes.stats::query.fields' - - $ref: '#/components/parameters/nodes.stats::query.groups' - - $ref: '#/components/parameters/nodes.stats::query.include_segment_file_sizes' - - $ref: '#/components/parameters/nodes.stats::query.level' - - $ref: '#/components/parameters/nodes.stats::query.timeout' - - $ref: '#/components/parameters/nodes.stats::query.types' - - $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.stats@200' + - $ref: '#/components/parameters/nodes.stats___path.index_metric' + - $ref: '#/components/parameters/nodes.stats___path.metric' + - $ref: '#/components/parameters/nodes.stats___path.node_id' + - $ref: '#/components/parameters/nodes.stats___query.completion_fields' + - $ref: '#/components/parameters/nodes.stats___query.fielddata_fields' + - $ref: '#/components/parameters/nodes.stats___query.fields' + - $ref: '#/components/parameters/nodes.stats___query.groups' + - $ref: '#/components/parameters/nodes.stats___query.include_segment_file_sizes' + - $ref: '#/components/parameters/nodes.stats___query.level' + - $ref: '#/components/parameters/nodes.stats___query.timeout' + - $ref: '#/components/parameters/nodes.stats___query.types' + - $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.stats___200' /_nodes/{node_id}/usage: get: operationId: nodes.usage.2 @@ -3222,16 +3429,16 @@ paths: externalDocs: url: https://opensearch.org/docs/latest parameters: - - $ref: '#/components/parameters/nodes.usage::path.node_id' - - $ref: '#/components/parameters/nodes.usage::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' + - $ref: '#/components/parameters/nodes.usage___path.node_id' + - $ref: '#/components/parameters/nodes.usage___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/nodes.usage@200' + $ref: '#/components/responses/nodes.usage___200' /_nodes/{node_id}/usage/{metric}: get: operationId: nodes.usage.3 @@ -3241,17 +3448,17 @@ paths: externalDocs: url: https://opensearch.org/docs/latest parameters: - - $ref: '#/components/parameters/nodes.usage::path.metric' - - $ref: '#/components/parameters/nodes.usage::path.node_id' - - $ref: '#/components/parameters/nodes.usage::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' + - $ref: '#/components/parameters/nodes.usage___path.metric' + - $ref: '#/components/parameters/nodes.usage___path.node_id' + - $ref: '#/components/parameters/nodes.usage___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/nodes.usage@200' + $ref: '#/components/responses/nodes.usage___200' /_nodes/hot_threads: get: operationId: nodes.hot_threads.4 @@ -3261,20 +3468,20 @@ paths: 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' + - $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' + $ref: '#/components/responses/nodes.hot_threads___200' /_nodes/reload_secure_settings: post: operationId: nodes.reload_secure_settings.0 @@ -3284,17 +3491,17 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/nodes-apis/nodes-reload-secure/ parameters: - - $ref: '#/components/parameters/nodes.reload_secure_settings::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' + - $ref: '#/components/parameters/nodes.reload_secure_settings___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' requestBody: $ref: '#/components/requestBodies/nodes.reload_secure_settings' responses: '200': - $ref: '#/components/responses/nodes.reload_secure_settings@200' + $ref: '#/components/responses/nodes.reload_secure_settings___200' /_nodes/stats: get: operationId: nodes.stats.0 @@ -3304,22 +3511,22 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/nodes-apis/nodes-usage/ parameters: - - $ref: '#/components/parameters/nodes.stats::query.completion_fields' - - $ref: '#/components/parameters/nodes.stats::query.fielddata_fields' - - $ref: '#/components/parameters/nodes.stats::query.fields' - - $ref: '#/components/parameters/nodes.stats::query.groups' - - $ref: '#/components/parameters/nodes.stats::query.include_segment_file_sizes' - - $ref: '#/components/parameters/nodes.stats::query.level' - - $ref: '#/components/parameters/nodes.stats::query.timeout' - - $ref: '#/components/parameters/nodes.stats::query.types' - - $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.stats@200' + - $ref: '#/components/parameters/nodes.stats___query.completion_fields' + - $ref: '#/components/parameters/nodes.stats___query.fielddata_fields' + - $ref: '#/components/parameters/nodes.stats___query.fields' + - $ref: '#/components/parameters/nodes.stats___query.groups' + - $ref: '#/components/parameters/nodes.stats___query.include_segment_file_sizes' + - $ref: '#/components/parameters/nodes.stats___query.level' + - $ref: '#/components/parameters/nodes.stats___query.timeout' + - $ref: '#/components/parameters/nodes.stats___query.types' + - $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.stats___200' /_nodes/stats/{metric}: get: operationId: nodes.stats.1 @@ -3329,23 +3536,23 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/nodes-apis/nodes-usage/ parameters: - - $ref: '#/components/parameters/nodes.stats::path.metric' - - $ref: '#/components/parameters/nodes.stats::query.completion_fields' - - $ref: '#/components/parameters/nodes.stats::query.fielddata_fields' - - $ref: '#/components/parameters/nodes.stats::query.fields' - - $ref: '#/components/parameters/nodes.stats::query.groups' - - $ref: '#/components/parameters/nodes.stats::query.include_segment_file_sizes' - - $ref: '#/components/parameters/nodes.stats::query.level' - - $ref: '#/components/parameters/nodes.stats::query.timeout' - - $ref: '#/components/parameters/nodes.stats::query.types' - - $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.stats@200' + - $ref: '#/components/parameters/nodes.stats___path.metric' + - $ref: '#/components/parameters/nodes.stats___query.completion_fields' + - $ref: '#/components/parameters/nodes.stats___query.fielddata_fields' + - $ref: '#/components/parameters/nodes.stats___query.fields' + - $ref: '#/components/parameters/nodes.stats___query.groups' + - $ref: '#/components/parameters/nodes.stats___query.include_segment_file_sizes' + - $ref: '#/components/parameters/nodes.stats___query.level' + - $ref: '#/components/parameters/nodes.stats___query.timeout' + - $ref: '#/components/parameters/nodes.stats___query.types' + - $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.stats___200' /_nodes/stats/{metric}/{index_metric}: get: operationId: nodes.stats.2 @@ -3355,24 +3562,24 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/nodes-apis/nodes-usage/ parameters: - - $ref: '#/components/parameters/nodes.stats::path.index_metric' - - $ref: '#/components/parameters/nodes.stats::path.metric' - - $ref: '#/components/parameters/nodes.stats::query.completion_fields' - - $ref: '#/components/parameters/nodes.stats::query.fielddata_fields' - - $ref: '#/components/parameters/nodes.stats::query.fields' - - $ref: '#/components/parameters/nodes.stats::query.groups' - - $ref: '#/components/parameters/nodes.stats::query.include_segment_file_sizes' - - $ref: '#/components/parameters/nodes.stats::query.level' - - $ref: '#/components/parameters/nodes.stats::query.timeout' - - $ref: '#/components/parameters/nodes.stats::query.types' - - $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.stats@200' + - $ref: '#/components/parameters/nodes.stats___path.index_metric' + - $ref: '#/components/parameters/nodes.stats___path.metric' + - $ref: '#/components/parameters/nodes.stats___query.completion_fields' + - $ref: '#/components/parameters/nodes.stats___query.fielddata_fields' + - $ref: '#/components/parameters/nodes.stats___query.fields' + - $ref: '#/components/parameters/nodes.stats___query.groups' + - $ref: '#/components/parameters/nodes.stats___query.include_segment_file_sizes' + - $ref: '#/components/parameters/nodes.stats___query.level' + - $ref: '#/components/parameters/nodes.stats___query.timeout' + - $ref: '#/components/parameters/nodes.stats___query.types' + - $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.stats___200' /_nodes/usage: get: operationId: nodes.usage.0 @@ -3382,15 +3589,15 @@ paths: externalDocs: url: https://opensearch.org/docs/latest parameters: - - $ref: '#/components/parameters/nodes.usage::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' + - $ref: '#/components/parameters/nodes.usage___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/nodes.usage@200' + $ref: '#/components/responses/nodes.usage___200' /_nodes/usage/{metric}: get: operationId: nodes.usage.1 @@ -3400,16 +3607,16 @@ paths: externalDocs: url: https://opensearch.org/docs/latest parameters: - - $ref: '#/components/parameters/nodes.usage::path.metric' - - $ref: '#/components/parameters/nodes.usage::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' + - $ref: '#/components/parameters/nodes.usage___path.metric' + - $ref: '#/components/parameters/nodes.usage___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/nodes.usage@200' + $ref: '#/components/responses/nodes.usage___200' /_opendistro/_security/sslinfo: get: operationId: security.get_sslinfo.0 @@ -3417,17 +3624,17 @@ paths: x-version-added: '1.0' description: Retrieves the SSL configuration information. parameters: - - $ref: '#/components/parameters/security.get_sslinfo::query.show_dn' - - $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' + - $ref: '#/components/parameters/security.get_sslinfo___query.show_dn' + - $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_sslinfo@200' + $ref: '#/components/responses/security.get_sslinfo___200' '500': - $ref: '#/components/responses/security.get_sslinfo@500' + $ref: '#/components/responses/security.get_sslinfo___500' /_plugins/_asynchronous_search: post: operationId: asynchronous_search.search.0 @@ -3437,20 +3644,20 @@ paths: 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' + - $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' + $ref: '#/components/responses/asynchronous_search.search___200' /_plugins/_asynchronous_search/{id}: delete: operationId: asynchronous_search.delete.0 @@ -3460,15 +3667,15 @@ paths: 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' + - $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' + $ref: '#/components/responses/asynchronous_search.delete___200' get: operationId: asynchronous_search.get.0 x-operation-group: asynchronous_search.get @@ -3477,15 +3684,15 @@ paths: 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' + - $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' + $ref: '#/components/responses/asynchronous_search.get___200' /_plugins/_asynchronous_search/stats: get: operationId: asynchronous_search.stats.0 @@ -3496,13 +3703,13 @@ paths: url: https://opensearch.org/docs/latest/search-plugins/async/index/#monitor-stats responses: '200': - $ref: '#/components/responses/asynchronous_search.stats@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' + - $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/_flow_framework/workflow: post: operationId: flow_framework.create.0 @@ -3512,25 +3719,25 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/automating-configurations/api/create-workflow/ parameters: - - $ref: '#/components/parameters/flow_framework.create::query.provision' - - $ref: '#/components/parameters/flow_framework.create::query.reprovision' - - $ref: '#/components/parameters/flow_framework.create::query.update_fields' - - $ref: '#/components/parameters/flow_framework.create::query.use_case' - - $ref: '#/components/parameters/flow_framework.create::query.validation' - - $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' + - $ref: '#/components/parameters/flow_framework.create___query.provision' + - $ref: '#/components/parameters/flow_framework.create___query.reprovision' + - $ref: '#/components/parameters/flow_framework.create___query.update_fields' + - $ref: '#/components/parameters/flow_framework.create___query.use_case' + - $ref: '#/components/parameters/flow_framework.create___query.validation' + - $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/flow_framework.create' responses: '201': - $ref: '#/components/responses/flow_framework.create@201' + $ref: '#/components/responses/flow_framework.create___201' '400': - $ref: '#/components/responses/flow_framework.create@400' + $ref: '#/components/responses/flow_framework.create___400' '403': - $ref: '#/components/responses/flow_framework.create@403' + $ref: '#/components/responses/flow_framework.create___403' /_plugins/_flow_framework/workflow/_search: get: operationId: flow_framework.search.1 @@ -3543,19 +3750,19 @@ paths: $ref: '#/components/requestBodies/flow_framework.search' responses: '200': - $ref: '#/components/responses/flow_framework.search@200' + $ref: '#/components/responses/flow_framework.search___200' '400': - $ref: '#/components/responses/flow_framework.search@400' + $ref: '#/components/responses/flow_framework.search___400' '403': - $ref: '#/components/responses/flow_framework.search@403' + $ref: '#/components/responses/flow_framework.search___403' '408': - $ref: '#/components/responses/flow_framework.search@408' + $ref: '#/components/responses/flow_framework.search___408' 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' + - $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: flow_framework.search.0 x-operation-group: flow_framework.search @@ -3567,19 +3774,19 @@ paths: $ref: '#/components/requestBodies/flow_framework.search' responses: '200': - $ref: '#/components/responses/flow_framework.search@200' + $ref: '#/components/responses/flow_framework.search___200' '400': - $ref: '#/components/responses/flow_framework.search@400' + $ref: '#/components/responses/flow_framework.search___400' '403': - $ref: '#/components/responses/flow_framework.search@403' + $ref: '#/components/responses/flow_framework.search___403' '408': - $ref: '#/components/responses/flow_framework.search@408' + $ref: '#/components/responses/flow_framework.search___408' 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' + - $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/_flow_framework/workflow/_steps: get: operationId: flow_framework.get_steps.0 @@ -3589,19 +3796,19 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/automating-configurations/api/get-workflow-steps/ parameters: - - $ref: '#/components/parameters/flow_framework.get_steps::query.workflow_step' - - $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' + - $ref: '#/components/parameters/flow_framework.get_steps___query.workflow_step' + - $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/flow_framework.get_steps@200' + $ref: '#/components/responses/flow_framework.get_steps___200' '400': - $ref: '#/components/responses/flow_framework.get_steps@400' + $ref: '#/components/responses/flow_framework.get_steps___400' '403': - $ref: '#/components/responses/flow_framework.get_steps@403' + $ref: '#/components/responses/flow_framework.get_steps___403' /_plugins/_flow_framework/workflow/{workflow_id}: delete: operationId: flow_framework.delete.0 @@ -3611,20 +3818,20 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/automating-configurations/api/delete-workflow/ parameters: - - $ref: '#/components/parameters/flow_framework.delete::path.workflow_id' - - $ref: '#/components/parameters/flow_framework.delete::query.clear_status' - - $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' + - $ref: '#/components/parameters/flow_framework.delete___path.workflow_id' + - $ref: '#/components/parameters/flow_framework.delete___query.clear_status' + - $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/flow_framework.delete@200' + $ref: '#/components/responses/flow_framework.delete___200' '400': - $ref: '#/components/responses/flow_framework.delete@400' + $ref: '#/components/responses/flow_framework.delete___400' '403': - $ref: '#/components/responses/flow_framework.delete@403' + $ref: '#/components/responses/flow_framework.delete___403' get: operationId: flow_framework.get.0 x-operation-group: flow_framework.get @@ -3633,17 +3840,17 @@ paths: url: https://opensearch.org/docs/latest/automating-configurations/api/get-workflow/ description: Get a workflow. parameters: - - $ref: '#/components/parameters/flow_framework.get::path.workflow_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' + - $ref: '#/components/parameters/flow_framework.get___path.workflow_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/flow_framework.get@200' + $ref: '#/components/responses/flow_framework.get___200' '404': - $ref: '#/components/responses/flow_framework.get@404' + $ref: '#/components/responses/flow_framework.get___404' put: operationId: flow_framework.update.0 x-operation-group: flow_framework.update @@ -3652,27 +3859,27 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/automating-configurations/api/create-workflow/ parameters: - - $ref: '#/components/parameters/flow_framework.update::path.workflow_id' - - $ref: '#/components/parameters/flow_framework.update::query.provision' - - $ref: '#/components/parameters/flow_framework.update::query.reprovision' - - $ref: '#/components/parameters/flow_framework.update::query.update_fields' - - $ref: '#/components/parameters/flow_framework.update::query.use_case' - - $ref: '#/components/parameters/flow_framework.update::query.validation' - - $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' + - $ref: '#/components/parameters/flow_framework.update___path.workflow_id' + - $ref: '#/components/parameters/flow_framework.update___query.provision' + - $ref: '#/components/parameters/flow_framework.update___query.reprovision' + - $ref: '#/components/parameters/flow_framework.update___query.update_fields' + - $ref: '#/components/parameters/flow_framework.update___query.use_case' + - $ref: '#/components/parameters/flow_framework.update___query.validation' + - $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/flow_framework.update' responses: '201': - $ref: '#/components/responses/flow_framework.update@201' - description: It returns the workflow_id + $ref: '#/components/responses/flow_framework.update___201' + description: It returns the `workflow_id`. '400': - $ref: '#/components/responses/flow_framework.update@400' + $ref: '#/components/responses/flow_framework.update___400' '404': - $ref: '#/components/responses/flow_framework.update@404' + $ref: '#/components/responses/flow_framework.update___404' /_plugins/_flow_framework/workflow/{workflow_id}/_deprovision: post: operationId: flow_framework.deprovision.0 @@ -3682,22 +3889,22 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/automating-configurations/api/deprovision-workflow/ parameters: - - $ref: '#/components/parameters/flow_framework.deprovision::path.workflow_id' - - $ref: '#/components/parameters/flow_framework.deprovision::query.allow_delete' - - $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' + - $ref: '#/components/parameters/flow_framework.deprovision___path.workflow_id' + - $ref: '#/components/parameters/flow_framework.deprovision___query.allow_delete' + - $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/flow_framework.deprovision@200' + $ref: '#/components/responses/flow_framework.deprovision___200' '202': - $ref: '#/components/responses/flow_framework.deprovision@202' + $ref: '#/components/responses/flow_framework.deprovision___202' '403': - $ref: '#/components/responses/flow_framework.deprovision@403' + $ref: '#/components/responses/flow_framework.deprovision___403' '404': - $ref: '#/components/responses/flow_framework.deprovision@404' + $ref: '#/components/responses/flow_framework.deprovision___404' /_plugins/_flow_framework/workflow/{workflow_id}/_provision: post: operationId: flow_framework.provision.0 @@ -3707,12 +3914,12 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/automating-configurations/api/provision-workflow/ parameters: - - $ref: '#/components/parameters/flow_framework.provision::path.workflow_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' + - $ref: '#/components/parameters/flow_framework.provision___path.workflow_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: description: |- Pass dynamic substitution expressions as key-value pairs, either as query parameters or in the request body. @@ -3721,11 +3928,11 @@ paths: $ref: '#/components/requestBodies/flow_framework.provision' responses: '200': - $ref: '#/components/responses/flow_framework.provision@200' + $ref: '#/components/responses/flow_framework.provision___200' '400': - $ref: '#/components/responses/flow_framework.provision@400' + $ref: '#/components/responses/flow_framework.provision___400' '403': - $ref: '#/components/responses/flow_framework.provision@403' + $ref: '#/components/responses/flow_framework.provision___403' /_plugins/_flow_framework/workflow/{workflow_id}/_status: get: operationId: flow_framework.get_status.0 @@ -3735,20 +3942,20 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/automating-configurations/api/get-workflow-status/ parameters: - - $ref: '#/components/parameters/flow_framework.get_status::path.workflow_id' - - $ref: '#/components/parameters/flow_framework.get_status::query.all' - - $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' + - $ref: '#/components/parameters/flow_framework.get_status___path.workflow_id' + - $ref: '#/components/parameters/flow_framework.get_status___query.all' + - $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/flow_framework.get_status@200' + $ref: '#/components/responses/flow_framework.get_status___200' '403': - $ref: '#/components/responses/flow_framework.get_status@403' + $ref: '#/components/responses/flow_framework.get_status___403' '404': - $ref: '#/components/responses/flow_framework.get_status@404' + $ref: '#/components/responses/flow_framework.get_status___404' /_plugins/_flow_framework/workflow/state/_search: get: operationId: flow_framework.search_state.1 @@ -3761,19 +3968,19 @@ paths: $ref: '#/components/requestBodies/flow_framework.search_state' responses: '200': - $ref: '#/components/responses/flow_framework.search_state@200' + $ref: '#/components/responses/flow_framework.search_state___200' '400': - $ref: '#/components/responses/flow_framework.search_state@400' + $ref: '#/components/responses/flow_framework.search_state___400' '403': - $ref: '#/components/responses/flow_framework.search_state@403' + $ref: '#/components/responses/flow_framework.search_state___403' '408': - $ref: '#/components/responses/flow_framework.search_state@408' + $ref: '#/components/responses/flow_framework.search_state___408' 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' + - $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: flow_framework.search_state.0 x-operation-group: flow_framework.search_state @@ -3785,19 +3992,19 @@ paths: $ref: '#/components/requestBodies/flow_framework.search_state' responses: '200': - $ref: '#/components/responses/flow_framework.search_state@200' + $ref: '#/components/responses/flow_framework.search_state___200' '400': - $ref: '#/components/responses/flow_framework.search_state@400' + $ref: '#/components/responses/flow_framework.search_state___400' '403': - $ref: '#/components/responses/flow_framework.search_state@403' + $ref: '#/components/responses/flow_framework.search_state___403' '408': - $ref: '#/components/responses/flow_framework.search_state@408' + $ref: '#/components/responses/flow_framework.search_state___408' 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' + - $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/_ism/add: post: operationId: ism.add_policy.0 @@ -3806,17 +4013,17 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/im-plugin/ism/api/#add-policy parameters: - - $ref: '#/components/parameters/ism.add_policy::query.index' - - $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' + - $ref: '#/components/parameters/ism.add_policy___query.index' + - $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/ism.add_policy' responses: '200': - $ref: '#/components/responses/ism.add_policy@200' + $ref: '#/components/responses/ism.add_policy___200' /_plugins/_ism/add/{index}: post: operationId: ism.add_policy.1 @@ -3825,18 +4032,18 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/im-plugin/ism/api/#add-policy parameters: - - $ref: '#/components/parameters/ism.add_policy::path.index' - - $ref: '#/components/parameters/ism.add_policy::query.index' - - $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' + - $ref: '#/components/parameters/ism.add_policy___path.index' + - $ref: '#/components/parameters/ism.add_policy___query.index' + - $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/ism.add_policy' responses: '200': - $ref: '#/components/responses/ism.add_policy@200' + $ref: '#/components/responses/ism.add_policy___200' /_plugins/_ism/change_policy: post: operationId: ism.change_policy.0 @@ -3845,17 +4052,17 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/im-plugin/ism/api/#update-managed-index-policy parameters: - - $ref: '#/components/parameters/ism.change_policy::query.index' - - $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' + - $ref: '#/components/parameters/ism.change_policy___query.index' + - $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/ism.change_policy' responses: '200': - $ref: '#/components/responses/ism.change_policy@200' + $ref: '#/components/responses/ism.change_policy___200' /_plugins/_ism/change_policy/{index}: post: operationId: ism.change_policy.1 @@ -3864,90 +4071,90 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/im-plugin/ism/api/#update-managed-index-policy parameters: - - $ref: '#/components/parameters/ism.change_policy::path.index' - - $ref: '#/components/parameters/ism.change_policy::query.index' - - $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' + - $ref: '#/components/parameters/ism.change_policy___path.index' + - $ref: '#/components/parameters/ism.change_policy___query.index' + - $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/ism.change_policy' responses: '200': - $ref: '#/components/responses/ism.change_policy@200' + $ref: '#/components/responses/ism.change_policy___200' /_plugins/_ism/explain: get: operationId: ism.explain_policy.0 x-operation-group: ism.explain_policy - description: Gets the currently applied policy on indices. + description: Gets the currently applied policy on indexes. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/ism/api/#explain-index requestBody: $ref: '#/components/requestBodies/ism.explain_policy' responses: '200': - $ref: '#/components/responses/ism.explain_policy@200' + $ref: '#/components/responses/ism.explain_policy___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' + - $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: ism.explain_policy.0 + operationId: ism.explain_policy.1 x-operation-group: ism.explain_policy - description: Gets the currently applied policy on indices. + description: Gets the currently applied policy on indexes. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/ism/api/#explain-index requestBody: $ref: '#/components/requestBodies/ism.explain_policy' responses: '200': - $ref: '#/components/responses/ism.explain_policy@200' + $ref: '#/components/responses/ism.explain_policy___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' + - $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/_ism/explain/{index}: get: - operationId: ism.explain_policy.1 + operationId: ism.explain_policy.3 x-operation-group: ism.explain_policy - description: Gets the currently applied policy on indices. + description: Gets the currently applied policy on indexes. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/ism/api/#explain-index parameters: - - $ref: '#/components/parameters/ism.explain_policy::path.index' - - $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' + - $ref: '#/components/parameters/ism.explain_policy___path.index' + - $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/ism.explain_policy' responses: '200': - $ref: '#/components/responses/ism.explain_policy@200' + $ref: '#/components/responses/ism.explain_policy___200' post: - operationId: ism.explain_policy.1 + operationId: ism.explain_policy.4 x-operation-group: ism.explain_policy - description: Gets the currently applied policy on indices. + description: Gets the currently applied policy on indexes. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/ism/api/#explain-index parameters: - - $ref: '#/components/parameters/ism.explain_policy::path.index' - - $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' + - $ref: '#/components/parameters/ism.explain_policy___path.index' + - $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/ism.explain_policy' responses: '200': - $ref: '#/components/responses/ism.explain_policy@200' + $ref: '#/components/responses/ism.explain_policy___200' /_plugins/_ism/policies: get: operationId: ism.get_policies.0 @@ -3957,13 +4164,13 @@ paths: url: https://opensearch.org/docs/latest/im-plugin/ism/api/#get-policy responses: '200': - $ref: '#/components/responses/ism.get_policies@200' + $ref: '#/components/responses/ism.get_policies___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' + - $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: ism.put_policies.0 x-operation-group: ism.put_policies @@ -3973,17 +4180,17 @@ paths: requestBody: $ref: '#/components/requestBodies/ism.put_policies' parameters: - - $ref: '#/components/parameters/ism.put_policies::query.if_primary_term' - - $ref: '#/components/parameters/ism.put_policies::query.if_seq_no' - - $ref: '#/components/parameters/ism.put_policies::query.policyID' - - $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' + - $ref: '#/components/parameters/ism.put_policies___query.if_primary_term' + - $ref: '#/components/parameters/ism.put_policies___query.if_seq_no' + - $ref: '#/components/parameters/ism.put_policies___query.policyID' + - $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/ism.put_policies@200' + $ref: '#/components/responses/ism.put_policies___200' /_plugins/_ism/policies/{policy_id}: delete: operationId: ism.delete_policy.0 @@ -3992,15 +4199,15 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/im-plugin/ism/api/#delete-policy parameters: - - $ref: '#/components/parameters/ism.delete_policy::path.policy_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' + - $ref: '#/components/parameters/ism.delete_policy___path.policy_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/ism.delete_policy@200' + $ref: '#/components/responses/ism.delete_policy___200' get: operationId: ism.get_policy.0 x-operation-group: ism.get_policy @@ -4008,15 +4215,15 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/im-plugin/ism/api/#put-policy parameters: - - $ref: '#/components/parameters/ism.get_policy::path.policy_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' + - $ref: '#/components/parameters/ism.get_policy___path.policy_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/ism.get_policy@200' + $ref: '#/components/responses/ism.get_policy___200' head: operationId: ism.exists_policy.0 x-operation-group: ism.exists_policy @@ -4024,17 +4231,17 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/im-plugin/ism/api/#get-policy parameters: - - $ref: '#/components/parameters/ism.exists_policy::path.policy_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' + - $ref: '#/components/parameters/ism.exists_policy___path.policy_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/ism.exists_policy@200' + $ref: '#/components/responses/ism.exists_policy___200' '404': - $ref: '#/components/responses/ism.exists_policy@404' + $ref: '#/components/responses/ism.exists_policy___404' put: operationId: ism.put_policy.0 x-operation-group: ism.put_policy @@ -4042,21 +4249,21 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/im-plugin/ism/api/#create-policy parameters: - - $ref: '#/components/parameters/ism.put_policy::path.policy_id' - - $ref: '#/components/parameters/ism.put_policy::query.if_primary_term' - - $ref: '#/components/parameters/ism.put_policy::query.if_seq_no' - - $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' + - $ref: '#/components/parameters/ism.put_policy___path.policy_id' + - $ref: '#/components/parameters/ism.put_policy___query.if_primary_term' + - $ref: '#/components/parameters/ism.put_policy___query.if_seq_no' + - $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/ism.put_policy' responses: '200': - $ref: '#/components/responses/ism.put_policy@200' + $ref: '#/components/responses/ism.put_policy___200' '201': - $ref: '#/components/responses/ism.put_policy@201' + $ref: '#/components/responses/ism.put_policy___201' /_plugins/_ism/remove: post: operationId: ism.remove_policy.0 @@ -4065,15 +4272,15 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/im-plugin/ism/api/#remove-policy parameters: - - $ref: '#/components/parameters/ism.remove_policy::query.index' - - $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' + - $ref: '#/components/parameters/ism.remove_policy___query.index' + - $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/ism.remove_policy@200' + $ref: '#/components/responses/ism.remove_policy___200' /_plugins/_ism/remove/{index}: post: operationId: ism.remove_policy.1 @@ -4082,16 +4289,16 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/im-plugin/ism/api/#remove-policy parameters: - - $ref: '#/components/parameters/ism.remove_policy::path.index' - - $ref: '#/components/parameters/ism.remove_policy::query.index' - - $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' + - $ref: '#/components/parameters/ism.remove_policy___path.index' + - $ref: '#/components/parameters/ism.remove_policy___query.index' + - $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/ism.remove_policy@200' + $ref: '#/components/responses/ism.remove_policy___200' /_plugins/_ism/retry: post: operationId: ism.retry_index.0 @@ -4100,17 +4307,17 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/im-plugin/ism/api/#retry-failed-index parameters: - - $ref: '#/components/parameters/ism.retry_index::query.index' - - $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' + - $ref: '#/components/parameters/ism.retry_index___query.index' + - $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/ism.retry_index' responses: '200': - $ref: '#/components/responses/ism.retry_index@200' + $ref: '#/components/responses/ism.retry_index___200' /_plugins/_ism/retry/{index}: post: operationId: ism.retry_index.1 @@ -4119,18 +4326,18 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/im-plugin/ism/api/#retry-failed-index parameters: - - $ref: '#/components/parameters/ism.retry_index::path.index' - - $ref: '#/components/parameters/ism.retry_index::query.index' - - $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' + - $ref: '#/components/parameters/ism.retry_index___path.index' + - $ref: '#/components/parameters/ism.retry_index___query.index' + - $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/ism.retry_index' responses: '200': - $ref: '#/components/responses/ism.retry_index@200' + $ref: '#/components/responses/ism.retry_index___200' /_plugins/_knn/{node_id}/stats: get: operationId: knn.stats.2 @@ -4140,16 +4347,16 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/search-plugins/knn/api/#stats parameters: - - $ref: '#/components/parameters/knn.stats::path.node_id' - - $ref: '#/components/parameters/knn.stats::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' + - $ref: '#/components/parameters/knn.stats___path.node_id' + - $ref: '#/components/parameters/knn.stats___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/knn.stats@200' + $ref: '#/components/responses/knn.stats___200' /_plugins/_knn/{node_id}/stats/{stat}: get: operationId: knn.stats.3 @@ -4159,17 +4366,17 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/search-plugins/knn/api/#stats parameters: - - $ref: '#/components/parameters/knn.stats::path.node_id' - - $ref: '#/components/parameters/knn.stats::path.stat' - - $ref: '#/components/parameters/knn.stats::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' + - $ref: '#/components/parameters/knn.stats___path.node_id' + - $ref: '#/components/parameters/knn.stats___path.stat' + - $ref: '#/components/parameters/knn.stats___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/knn.stats@200' + $ref: '#/components/responses/knn.stats___200' /_plugins/_knn/models/_search: get: operationId: knn.search_models.0 @@ -4179,58 +4386,58 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/search-plugins/knn/api/#search-model parameters: - - $ref: '#/components/parameters/knn.search_models::query._source' - - $ref: '#/components/parameters/knn.search_models::query._source_excludes' - - $ref: '#/components/parameters/knn.search_models::query._source_includes' - - $ref: '#/components/parameters/knn.search_models::query.allow_no_indices' - - $ref: '#/components/parameters/knn.search_models::query.allow_partial_search_results' - - $ref: '#/components/parameters/knn.search_models::query.analyze_wildcard' - - $ref: '#/components/parameters/knn.search_models::query.analyzer' - - $ref: '#/components/parameters/knn.search_models::query.batched_reduce_size' - - $ref: '#/components/parameters/knn.search_models::query.ccs_minimize_roundtrips' - - $ref: '#/components/parameters/knn.search_models::query.default_operator' - - $ref: '#/components/parameters/knn.search_models::query.df' - - $ref: '#/components/parameters/knn.search_models::query.docvalue_fields' - - $ref: '#/components/parameters/knn.search_models::query.expand_wildcards' - - $ref: '#/components/parameters/knn.search_models::query.explain' - - $ref: '#/components/parameters/knn.search_models::query.from' - - $ref: '#/components/parameters/knn.search_models::query.ignore_throttled' - - $ref: '#/components/parameters/knn.search_models::query.ignore_unavailable' - - $ref: '#/components/parameters/knn.search_models::query.lenient' - - $ref: '#/components/parameters/knn.search_models::query.max_concurrent_shard_requests' - - $ref: '#/components/parameters/knn.search_models::query.pre_filter_shard_size' - - $ref: '#/components/parameters/knn.search_models::query.preference' - - $ref: '#/components/parameters/knn.search_models::query.q' - - $ref: '#/components/parameters/knn.search_models::query.request_cache' - - $ref: '#/components/parameters/knn.search_models::query.rest_total_hits_as_int' - - $ref: '#/components/parameters/knn.search_models::query.routing' - - $ref: '#/components/parameters/knn.search_models::query.scroll' - - $ref: '#/components/parameters/knn.search_models::query.search_type' - - $ref: '#/components/parameters/knn.search_models::query.seq_no_primary_term' - - $ref: '#/components/parameters/knn.search_models::query.size' - - $ref: '#/components/parameters/knn.search_models::query.sort' - - $ref: '#/components/parameters/knn.search_models::query.stats' - - $ref: '#/components/parameters/knn.search_models::query.stored_fields' - - $ref: '#/components/parameters/knn.search_models::query.suggest_field' - - $ref: '#/components/parameters/knn.search_models::query.suggest_mode' - - $ref: '#/components/parameters/knn.search_models::query.suggest_size' - - $ref: '#/components/parameters/knn.search_models::query.suggest_text' - - $ref: '#/components/parameters/knn.search_models::query.terminate_after' - - $ref: '#/components/parameters/knn.search_models::query.timeout' - - $ref: '#/components/parameters/knn.search_models::query.track_scores' - - $ref: '#/components/parameters/knn.search_models::query.track_total_hits' - - $ref: '#/components/parameters/knn.search_models::query.typed_keys' - - $ref: '#/components/parameters/knn.search_models::query.version' - - $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' + - $ref: '#/components/parameters/knn.search_models___query._source' + - $ref: '#/components/parameters/knn.search_models___query._source_excludes' + - $ref: '#/components/parameters/knn.search_models___query._source_includes' + - $ref: '#/components/parameters/knn.search_models___query.allow_no_indices' + - $ref: '#/components/parameters/knn.search_models___query.allow_partial_search_results' + - $ref: '#/components/parameters/knn.search_models___query.analyze_wildcard' + - $ref: '#/components/parameters/knn.search_models___query.analyzer' + - $ref: '#/components/parameters/knn.search_models___query.batched_reduce_size' + - $ref: '#/components/parameters/knn.search_models___query.ccs_minimize_roundtrips' + - $ref: '#/components/parameters/knn.search_models___query.default_operator' + - $ref: '#/components/parameters/knn.search_models___query.df' + - $ref: '#/components/parameters/knn.search_models___query.docvalue_fields' + - $ref: '#/components/parameters/knn.search_models___query.expand_wildcards' + - $ref: '#/components/parameters/knn.search_models___query.explain' + - $ref: '#/components/parameters/knn.search_models___query.from' + - $ref: '#/components/parameters/knn.search_models___query.ignore_throttled' + - $ref: '#/components/parameters/knn.search_models___query.ignore_unavailable' + - $ref: '#/components/parameters/knn.search_models___query.lenient' + - $ref: '#/components/parameters/knn.search_models___query.max_concurrent_shard_requests' + - $ref: '#/components/parameters/knn.search_models___query.pre_filter_shard_size' + - $ref: '#/components/parameters/knn.search_models___query.preference' + - $ref: '#/components/parameters/knn.search_models___query.q' + - $ref: '#/components/parameters/knn.search_models___query.request_cache' + - $ref: '#/components/parameters/knn.search_models___query.rest_total_hits_as_int' + - $ref: '#/components/parameters/knn.search_models___query.routing' + - $ref: '#/components/parameters/knn.search_models___query.scroll' + - $ref: '#/components/parameters/knn.search_models___query.search_type' + - $ref: '#/components/parameters/knn.search_models___query.seq_no_primary_term' + - $ref: '#/components/parameters/knn.search_models___query.size' + - $ref: '#/components/parameters/knn.search_models___query.sort' + - $ref: '#/components/parameters/knn.search_models___query.stats' + - $ref: '#/components/parameters/knn.search_models___query.stored_fields' + - $ref: '#/components/parameters/knn.search_models___query.suggest_field' + - $ref: '#/components/parameters/knn.search_models___query.suggest_mode' + - $ref: '#/components/parameters/knn.search_models___query.suggest_size' + - $ref: '#/components/parameters/knn.search_models___query.suggest_text' + - $ref: '#/components/parameters/knn.search_models___query.terminate_after' + - $ref: '#/components/parameters/knn.search_models___query.timeout' + - $ref: '#/components/parameters/knn.search_models___query.track_scores' + - $ref: '#/components/parameters/knn.search_models___query.track_total_hits' + - $ref: '#/components/parameters/knn.search_models___query.typed_keys' + - $ref: '#/components/parameters/knn.search_models___query.version' + - $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/knn.search_models' responses: '200': - $ref: '#/components/responses/knn.search_models@200' + $ref: '#/components/responses/knn.search_models___200' post: operationId: knn.search_models.1 x-operation-group: knn.search_models @@ -4239,58 +4446,58 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/search-plugins/knn/api/#search-model parameters: - - $ref: '#/components/parameters/knn.search_models::query._source' - - $ref: '#/components/parameters/knn.search_models::query._source_excludes' - - $ref: '#/components/parameters/knn.search_models::query._source_includes' - - $ref: '#/components/parameters/knn.search_models::query.allow_no_indices' - - $ref: '#/components/parameters/knn.search_models::query.allow_partial_search_results' - - $ref: '#/components/parameters/knn.search_models::query.analyze_wildcard' - - $ref: '#/components/parameters/knn.search_models::query.analyzer' - - $ref: '#/components/parameters/knn.search_models::query.batched_reduce_size' - - $ref: '#/components/parameters/knn.search_models::query.ccs_minimize_roundtrips' - - $ref: '#/components/parameters/knn.search_models::query.default_operator' - - $ref: '#/components/parameters/knn.search_models::query.df' - - $ref: '#/components/parameters/knn.search_models::query.docvalue_fields' - - $ref: '#/components/parameters/knn.search_models::query.expand_wildcards' - - $ref: '#/components/parameters/knn.search_models::query.explain' - - $ref: '#/components/parameters/knn.search_models::query.from' - - $ref: '#/components/parameters/knn.search_models::query.ignore_throttled' - - $ref: '#/components/parameters/knn.search_models::query.ignore_unavailable' - - $ref: '#/components/parameters/knn.search_models::query.lenient' - - $ref: '#/components/parameters/knn.search_models::query.max_concurrent_shard_requests' - - $ref: '#/components/parameters/knn.search_models::query.pre_filter_shard_size' - - $ref: '#/components/parameters/knn.search_models::query.preference' - - $ref: '#/components/parameters/knn.search_models::query.q' - - $ref: '#/components/parameters/knn.search_models::query.request_cache' - - $ref: '#/components/parameters/knn.search_models::query.rest_total_hits_as_int' - - $ref: '#/components/parameters/knn.search_models::query.routing' - - $ref: '#/components/parameters/knn.search_models::query.scroll' - - $ref: '#/components/parameters/knn.search_models::query.search_type' - - $ref: '#/components/parameters/knn.search_models::query.seq_no_primary_term' - - $ref: '#/components/parameters/knn.search_models::query.size' - - $ref: '#/components/parameters/knn.search_models::query.sort' - - $ref: '#/components/parameters/knn.search_models::query.stats' - - $ref: '#/components/parameters/knn.search_models::query.stored_fields' - - $ref: '#/components/parameters/knn.search_models::query.suggest_field' - - $ref: '#/components/parameters/knn.search_models::query.suggest_mode' - - $ref: '#/components/parameters/knn.search_models::query.suggest_size' - - $ref: '#/components/parameters/knn.search_models::query.suggest_text' - - $ref: '#/components/parameters/knn.search_models::query.terminate_after' - - $ref: '#/components/parameters/knn.search_models::query.timeout' - - $ref: '#/components/parameters/knn.search_models::query.track_scores' - - $ref: '#/components/parameters/knn.search_models::query.track_total_hits' - - $ref: '#/components/parameters/knn.search_models::query.typed_keys' - - $ref: '#/components/parameters/knn.search_models::query.version' - - $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' + - $ref: '#/components/parameters/knn.search_models___query._source' + - $ref: '#/components/parameters/knn.search_models___query._source_excludes' + - $ref: '#/components/parameters/knn.search_models___query._source_includes' + - $ref: '#/components/parameters/knn.search_models___query.allow_no_indices' + - $ref: '#/components/parameters/knn.search_models___query.allow_partial_search_results' + - $ref: '#/components/parameters/knn.search_models___query.analyze_wildcard' + - $ref: '#/components/parameters/knn.search_models___query.analyzer' + - $ref: '#/components/parameters/knn.search_models___query.batched_reduce_size' + - $ref: '#/components/parameters/knn.search_models___query.ccs_minimize_roundtrips' + - $ref: '#/components/parameters/knn.search_models___query.default_operator' + - $ref: '#/components/parameters/knn.search_models___query.df' + - $ref: '#/components/parameters/knn.search_models___query.docvalue_fields' + - $ref: '#/components/parameters/knn.search_models___query.expand_wildcards' + - $ref: '#/components/parameters/knn.search_models___query.explain' + - $ref: '#/components/parameters/knn.search_models___query.from' + - $ref: '#/components/parameters/knn.search_models___query.ignore_throttled' + - $ref: '#/components/parameters/knn.search_models___query.ignore_unavailable' + - $ref: '#/components/parameters/knn.search_models___query.lenient' + - $ref: '#/components/parameters/knn.search_models___query.max_concurrent_shard_requests' + - $ref: '#/components/parameters/knn.search_models___query.pre_filter_shard_size' + - $ref: '#/components/parameters/knn.search_models___query.preference' + - $ref: '#/components/parameters/knn.search_models___query.q' + - $ref: '#/components/parameters/knn.search_models___query.request_cache' + - $ref: '#/components/parameters/knn.search_models___query.rest_total_hits_as_int' + - $ref: '#/components/parameters/knn.search_models___query.routing' + - $ref: '#/components/parameters/knn.search_models___query.scroll' + - $ref: '#/components/parameters/knn.search_models___query.search_type' + - $ref: '#/components/parameters/knn.search_models___query.seq_no_primary_term' + - $ref: '#/components/parameters/knn.search_models___query.size' + - $ref: '#/components/parameters/knn.search_models___query.sort' + - $ref: '#/components/parameters/knn.search_models___query.stats' + - $ref: '#/components/parameters/knn.search_models___query.stored_fields' + - $ref: '#/components/parameters/knn.search_models___query.suggest_field' + - $ref: '#/components/parameters/knn.search_models___query.suggest_mode' + - $ref: '#/components/parameters/knn.search_models___query.suggest_size' + - $ref: '#/components/parameters/knn.search_models___query.suggest_text' + - $ref: '#/components/parameters/knn.search_models___query.terminate_after' + - $ref: '#/components/parameters/knn.search_models___query.timeout' + - $ref: '#/components/parameters/knn.search_models___query.track_scores' + - $ref: '#/components/parameters/knn.search_models___query.track_total_hits' + - $ref: '#/components/parameters/knn.search_models___query.typed_keys' + - $ref: '#/components/parameters/knn.search_models___query.version' + - $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/knn.search_models' responses: '200': - $ref: '#/components/responses/knn.search_models@200' + $ref: '#/components/responses/knn.search_models___200' /_plugins/_knn/models/_train: post: operationId: knn.train_model.0 @@ -4300,17 +4507,17 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/search-plugins/knn/api/#train-model parameters: - - $ref: '#/components/parameters/knn.train_model::query.preference' - - $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' + - $ref: '#/components/parameters/knn.train_model___query.preference' + - $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/knn.train_model' responses: '200': - $ref: '#/components/responses/knn.train_model@200' + $ref: '#/components/responses/knn.train_model___200' /_plugins/_knn/models/{model_id}: delete: operationId: knn.delete_model.0 @@ -4320,15 +4527,15 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/search-plugins/knn/api/#delete-model parameters: - - $ref: '#/components/parameters/knn.delete_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' + - $ref: '#/components/parameters/knn.delete_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/knn.delete_model@200' + $ref: '#/components/responses/knn.delete_model___200' get: operationId: knn.get_model.0 x-operation-group: knn.get_model @@ -4337,15 +4544,15 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/search-plugins/knn/api/#get-model parameters: - - $ref: '#/components/parameters/knn.get_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' + - $ref: '#/components/parameters/knn.get_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/knn.get_model@200' + $ref: '#/components/responses/knn.get_model___200' /_plugins/_knn/models/{model_id}/_train: post: operationId: knn.train_model.1 @@ -4355,18 +4562,18 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/search-plugins/knn/api/#train-model parameters: - - $ref: '#/components/parameters/knn.train_model::path.model_id' - - $ref: '#/components/parameters/knn.train_model::query.preference' - - $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' + - $ref: '#/components/parameters/knn.train_model___path.model_id' + - $ref: '#/components/parameters/knn.train_model___query.preference' + - $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/knn.train_model' responses: '200': - $ref: '#/components/responses/knn.train_model@200' + $ref: '#/components/responses/knn.train_model___200' /_plugins/_knn/stats: get: operationId: knn.stats.0 @@ -4376,15 +4583,15 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/search-plugins/knn/api/#stats parameters: - - $ref: '#/components/parameters/knn.stats::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' + - $ref: '#/components/parameters/knn.stats___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/knn.stats@200' + $ref: '#/components/responses/knn.stats___200' /_plugins/_knn/stats/{stat}: get: operationId: knn.stats.1 @@ -4394,16 +4601,16 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/search-plugins/knn/api/#stats parameters: - - $ref: '#/components/parameters/knn.stats::path.stat' - - $ref: '#/components/parameters/knn.stats::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' + - $ref: '#/components/parameters/knn.stats___path.stat' + - $ref: '#/components/parameters/knn.stats___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/knn.stats@200' + $ref: '#/components/responses/knn.stats___200' /_plugins/_knn/warmup/{index}: get: operationId: knn.warmup.0 @@ -4413,15 +4620,15 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/search-plugins/knn/api/#warmup-operation parameters: - - $ref: '#/components/parameters/knn.warmup::path.index' - - $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' + - $ref: '#/components/parameters/knn.warmup___path.index' + - $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/knn.warmup@200' + $ref: '#/components/responses/knn.warmup___200' /_plugins/_ml/agents/_register: post: operationId: ml.register_agents.0 @@ -4431,28 +4638,28 @@ paths: $ref: '#/components/requestBodies/ml.register_agents' responses: '200': - $ref: '#/components/responses/ml.register_agents@200' + $ref: '#/components/responses/ml.register_agents___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' + - $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/_ml/agents/{agent_id}: delete: operationId: ml.delete_agent.0 x-operation-group: ml.delete_agent description: Delete an agent. parameters: - - $ref: '#/components/parameters/ml.delete_agent::path.agent_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' + - $ref: '#/components/parameters/ml.delete_agent___path.agent_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_agent@200' + $ref: '#/components/responses/ml.delete_agent___200' /_plugins/_ml/connectors/_create: post: operationId: ml.create_connector.0 @@ -4462,28 +4669,28 @@ paths: $ref: '#/components/requestBodies/ml.create_connector' responses: '200': - $ref: '#/components/responses/ml.create_connector@200' + $ref: '#/components/responses/ml.create_connector___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' + - $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/_ml/connectors/{connector_id}: delete: operationId: ml.delete_connector.0 x-operation-group: ml.delete_connector description: Deletes a standalone connector. parameters: - - $ref: '#/components/parameters/ml.delete_connector::path.connector_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' + - $ref: '#/components/parameters/ml.delete_connector___path.connector_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_connector@200' + $ref: '#/components/responses/ml.delete_connector___200' /_plugins/_ml/model_groups/_register: post: operationId: ml.register_model_group.0 @@ -4493,42 +4700,42 @@ paths: $ref: '#/components/requestBodies/ml.register_model_group' responses: '200': - $ref: '#/components/responses/ml.register_model_group@200' + $ref: '#/components/responses/ml.register_model_group___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' + - $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/_ml/model_groups/{model_group_id}: delete: operationId: ml.delete_model_group.0 x-operation-group: ml.delete_model_group description: Deletes a model group. parameters: - - $ref: '#/components/parameters/ml.delete_model_group::path.model_group_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' + - $ref: '#/components/parameters/ml.delete_model_group___path.model_group_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_model_group@200' + $ref: '#/components/responses/ml.delete_model_group___200' get: operationId: ml.get_model_group.0 x-operation-group: ml.get_model_group description: Retrieves a model group. parameters: - - $ref: '#/components/parameters/ml.get_model_group::path.model_group_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' + - $ref: '#/components/parameters/ml.get_model_group___path.model_group_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.get_model_group@200' + $ref: '#/components/responses/ml.get_model_group___200' /_plugins/_ml/models/_register: post: operationId: ml.register_model.0 @@ -4538,13 +4745,13 @@ paths: $ref: '#/components/requestBodies/ml.register_model' responses: '200': - $ref: '#/components/responses/ml.register_model@200' + $ref: '#/components/responses/ml.register_model___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' + - $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/_ml/models/_search: get: operationId: ml.search_models.0 @@ -4554,87 +4761,87 @@ paths: $ref: '#/components/requestBodies/ml.search_models' responses: '200': - $ref: '#/components/responses/ml.search_models@200' + $ref: '#/components/responses/ml.search_models___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' + - $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/_ml/models/{model_id}: delete: operationId: ml.delete_model.0 x-operation-group: ml.delete_model description: Deletes a model. parameters: - - $ref: '#/components/parameters/ml.delete_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' + - $ref: '#/components/parameters/ml.delete_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.delete_model@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' + - $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' + $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' + - $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' + $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' + - $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' + $ref: '#/components/responses/ml.delete_task___200' get: operationId: ml.get_task.0 x-operation-group: ml.get_task description: Retrieves a task. parameters: - - $ref: '#/components/parameters/ml.get_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' + - $ref: '#/components/parameters/ml.get_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.get_task@200' + $ref: '#/components/responses/ml.get_task___200' /_plugins/_notifications/channels: get: operationId: notifications.list_channels.0 @@ -4645,13 +4852,13 @@ paths: url: https://opensearch.org/docs/latest/observing-your-data/notifications/api/#list-all-notification-channels responses: '200': - $ref: '#/components/responses/notifications.list_channels@200' + $ref: '#/components/responses/notifications.list_channels___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' + - $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/_notifications/configs: delete: operationId: notifications.delete_configs.0 @@ -4661,16 +4868,16 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/observing-your-data/notifications/api/#delete-channel-configuration parameters: - - $ref: '#/components/parameters/notifications.delete_configs::query.config_id' - - $ref: '#/components/parameters/notifications.delete_configs::query.config_id_list' - - $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' + - $ref: '#/components/parameters/notifications.delete_configs___query.config_id' + - $ref: '#/components/parameters/notifications.delete_configs___query.config_id_list' + - $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/notifications.delete_configs@200' + $ref: '#/components/responses/notifications.delete_configs___200' get: operationId: notifications.get_configs.0 x-operation-group: notifications.get_configs @@ -4679,56 +4886,56 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/observing-your-data/notifications/api/#list-all-notification-configurations parameters: - - $ref: '#/components/parameters/notifications.get_configs::query.chime.url' - - $ref: '#/components/parameters/notifications.get_configs::query.chime.url.keyword' - - $ref: '#/components/parameters/notifications.get_configs::query.config_id' - - $ref: '#/components/parameters/notifications.get_configs::query.config_id_list' - - $ref: '#/components/parameters/notifications.get_configs::query.config_type' - - $ref: '#/components/parameters/notifications.get_configs::query.created_time_ms' - - $ref: '#/components/parameters/notifications.get_configs::query.description' - - $ref: '#/components/parameters/notifications.get_configs::query.description.keyword' - - $ref: '#/components/parameters/notifications.get_configs::query.email.email_account_id' - - $ref: '#/components/parameters/notifications.get_configs::query.email.email_group_id_list' - - $ref: '#/components/parameters/notifications.get_configs::query.email.recipient_list.recipient' - - $ref: '#/components/parameters/notifications.get_configs::query.email.recipient_list.recipient.keyword' - - $ref: '#/components/parameters/notifications.get_configs::query.email_group.recipient_list.recipient' - - $ref: '#/components/parameters/notifications.get_configs::query.email_group.recipient_list.recipient.keyword' - - $ref: '#/components/parameters/notifications.get_configs::query.is_enabled' - - $ref: '#/components/parameters/notifications.get_configs::query.last_updated_time_ms' - - $ref: '#/components/parameters/notifications.get_configs::query.microsoft_teams.url' - - $ref: '#/components/parameters/notifications.get_configs::query.microsoft_teams.url.keyword' - - $ref: '#/components/parameters/notifications.get_configs::query.name' - - $ref: '#/components/parameters/notifications.get_configs::query.name.keyword' - - $ref: '#/components/parameters/notifications.get_configs::query.query' - - $ref: '#/components/parameters/notifications.get_configs::query.ses_account.from_address' - - $ref: '#/components/parameters/notifications.get_configs::query.ses_account.from_address.keyword' - - $ref: '#/components/parameters/notifications.get_configs::query.ses_account.region' - - $ref: '#/components/parameters/notifications.get_configs::query.ses_account.role_arn' - - $ref: '#/components/parameters/notifications.get_configs::query.ses_account.role_arn.keyword' - - $ref: '#/components/parameters/notifications.get_configs::query.slack.url' - - $ref: '#/components/parameters/notifications.get_configs::query.slack.url.keyword' - - $ref: '#/components/parameters/notifications.get_configs::query.smtp_account.from_address' - - $ref: '#/components/parameters/notifications.get_configs::query.smtp_account.from_address.keyword' - - $ref: '#/components/parameters/notifications.get_configs::query.smtp_account.host' - - $ref: '#/components/parameters/notifications.get_configs::query.smtp_account.host.keyword' - - $ref: '#/components/parameters/notifications.get_configs::query.smtp_account.method' - - $ref: '#/components/parameters/notifications.get_configs::query.sns.role_arn' - - $ref: '#/components/parameters/notifications.get_configs::query.sns.role_arn.keyword' - - $ref: '#/components/parameters/notifications.get_configs::query.sns.topic_arn' - - $ref: '#/components/parameters/notifications.get_configs::query.sns.topic_arn.keyword' - - $ref: '#/components/parameters/notifications.get_configs::query.text_query' - - $ref: '#/components/parameters/notifications.get_configs::query.webhook.url' - - $ref: '#/components/parameters/notifications.get_configs::query.webhook.url.keyword' - - $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' + - $ref: '#/components/parameters/notifications.get_configs___query.chime.url' + - $ref: '#/components/parameters/notifications.get_configs___query.chime.url.keyword' + - $ref: '#/components/parameters/notifications.get_configs___query.config_id' + - $ref: '#/components/parameters/notifications.get_configs___query.config_id_list' + - $ref: '#/components/parameters/notifications.get_configs___query.config_type' + - $ref: '#/components/parameters/notifications.get_configs___query.created_time_ms' + - $ref: '#/components/parameters/notifications.get_configs___query.description' + - $ref: '#/components/parameters/notifications.get_configs___query.description.keyword' + - $ref: '#/components/parameters/notifications.get_configs___query.email.email_account_id' + - $ref: '#/components/parameters/notifications.get_configs___query.email.email_group_id_list' + - $ref: '#/components/parameters/notifications.get_configs___query.email.recipient_list.recipient' + - $ref: '#/components/parameters/notifications.get_configs___query.email.recipient_list.recipient.keyword' + - $ref: '#/components/parameters/notifications.get_configs___query.email_group.recipient_list.recipient' + - $ref: '#/components/parameters/notifications.get_configs___query.email_group.recipient_list.recipient.keyword' + - $ref: '#/components/parameters/notifications.get_configs___query.is_enabled' + - $ref: '#/components/parameters/notifications.get_configs___query.last_updated_time_ms' + - $ref: '#/components/parameters/notifications.get_configs___query.microsoft_teams.url' + - $ref: '#/components/parameters/notifications.get_configs___query.microsoft_teams.url.keyword' + - $ref: '#/components/parameters/notifications.get_configs___query.name' + - $ref: '#/components/parameters/notifications.get_configs___query.name.keyword' + - $ref: '#/components/parameters/notifications.get_configs___query.query' + - $ref: '#/components/parameters/notifications.get_configs___query.ses_account.from_address' + - $ref: '#/components/parameters/notifications.get_configs___query.ses_account.from_address.keyword' + - $ref: '#/components/parameters/notifications.get_configs___query.ses_account.region' + - $ref: '#/components/parameters/notifications.get_configs___query.ses_account.role_arn' + - $ref: '#/components/parameters/notifications.get_configs___query.ses_account.role_arn.keyword' + - $ref: '#/components/parameters/notifications.get_configs___query.slack.url' + - $ref: '#/components/parameters/notifications.get_configs___query.slack.url.keyword' + - $ref: '#/components/parameters/notifications.get_configs___query.smtp_account.from_address' + - $ref: '#/components/parameters/notifications.get_configs___query.smtp_account.from_address.keyword' + - $ref: '#/components/parameters/notifications.get_configs___query.smtp_account.host' + - $ref: '#/components/parameters/notifications.get_configs___query.smtp_account.host.keyword' + - $ref: '#/components/parameters/notifications.get_configs___query.smtp_account.method' + - $ref: '#/components/parameters/notifications.get_configs___query.sns.role_arn' + - $ref: '#/components/parameters/notifications.get_configs___query.sns.role_arn.keyword' + - $ref: '#/components/parameters/notifications.get_configs___query.sns.topic_arn' + - $ref: '#/components/parameters/notifications.get_configs___query.sns.topic_arn.keyword' + - $ref: '#/components/parameters/notifications.get_configs___query.text_query' + - $ref: '#/components/parameters/notifications.get_configs___query.webhook.url' + - $ref: '#/components/parameters/notifications.get_configs___query.webhook.url.keyword' + - $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/notifications.get_configs' responses: '200': - $ref: '#/components/responses/notifications.get_configs@200' + $ref: '#/components/responses/notifications.get_configs___200' post: operationId: notifications.create_config.0 x-operation-group: notifications.create_config @@ -4740,13 +4947,13 @@ paths: $ref: '#/components/requestBodies/notifications.create_config' responses: '200': - $ref: '#/components/responses/notifications.create_config@200' + $ref: '#/components/responses/notifications.create_config___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' + - $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/_notifications/configs/{config_id}: delete: operationId: notifications.delete_config.0 @@ -4756,30 +4963,30 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/observing-your-data/notifications/api/#delete-channel-configuration parameters: - - $ref: '#/components/parameters/notifications.delete_config::path.config_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' + - $ref: '#/components/parameters/notifications.delete_config___path.config_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/notifications.delete_config@200' + $ref: '#/components/responses/notifications.delete_config___200' get: operationId: notifications.get_config.0 x-operation-group: notifications.get_config x-version-added: '2.0' description: Get a specific channel configuration. parameters: - - $ref: '#/components/parameters/notifications.get_config::path.config_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' + - $ref: '#/components/parameters/notifications.get_config___path.config_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/notifications.get_config@200' + $ref: '#/components/responses/notifications.get_config___200' put: operationId: notifications.update_config.0 x-operation-group: notifications.update_config @@ -4788,17 +4995,17 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/observing-your-data/notifications/api/#update-channel-configuration parameters: - - $ref: '#/components/parameters/notifications.update_config::path.config_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' + - $ref: '#/components/parameters/notifications.update_config___path.config_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/notifications.update_config' responses: '200': - $ref: '#/components/responses/notifications.update_config@200' + $ref: '#/components/responses/notifications.update_config___200' /_plugins/_notifications/feature/test/{config_id}: get: operationId: notifications.send_test.0 @@ -4811,15 +5018,15 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/observing-your-data/notifications/api/#send-test-notification parameters: - - $ref: '#/components/parameters/notifications.send_test::path.config_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' + - $ref: '#/components/parameters/notifications.send_test___path.config_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/notifications.send_test@200' + $ref: '#/components/responses/notifications.send_test___200' post: operationId: notifications.send_test.1 x-operation-group: notifications.send_test @@ -4828,15 +5035,15 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/observing-your-data/notifications/api/#send-test-notification parameters: - - $ref: '#/components/parameters/notifications.send_test::path.config_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' + - $ref: '#/components/parameters/notifications.send_test___path.config_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/notifications.send_test@200' + $ref: '#/components/responses/notifications.send_test___200' /_plugins/_notifications/features: get: operationId: notifications.list_features.0 @@ -4847,13 +5054,13 @@ paths: url: https://opensearch.org/docs/latest/observing-your-data/notifications/api/#list-supported-channel-configurations responses: '200': - $ref: '#/components/responses/notifications.list_features@200' + $ref: '#/components/responses/notifications.list_features___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' + - $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/_local/stats: get: operationId: observability.get_localstats.0 @@ -4862,13 +5069,13 @@ paths: description: Retrieves Local Stats of all observability objects. responses: '200': - $ref: '#/components/responses/observability.get_localstats@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' + - $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 @@ -4876,18 +5083,18 @@ paths: 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' + - $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' + $ref: '#/components/responses/observability.delete_objects___200' '404': - $ref: '#/components/responses/observability.delete_objects@404' + $ref: '#/components/responses/observability.delete_objects___404' get: operationId: observability.list_objects.0 x-operation-group: observability.list_objects @@ -4895,13 +5102,13 @@ paths: description: Retrieves list of all observability objects. responses: '200': - $ref: '#/components/responses/observability.list_objects@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' + - $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 @@ -4911,13 +5118,13 @@ paths: $ref: '#/components/requestBodies/observability.create_object' responses: '200': - $ref: '#/components/responses/observability.create_object@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' + - $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 @@ -4925,53 +5132,53 @@ paths: 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' + - $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' + $ref: '#/components/responses/observability.delete_object___200' '404': - $ref: '#/components/responses/observability.delete_object@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' + - $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' + $ref: '#/components/responses/observability.get_object___200' '404': - $ref: '#/components/responses/observability.get_object@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' + - $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' + $ref: '#/components/responses/observability.update_object___200' '404': - $ref: '#/components/responses/observability.update_object@404' + $ref: '#/components/responses/observability.update_object___404' /_plugins/_ppl: post: operationId: ppl.query.0 @@ -4981,18 +5188,18 @@ paths: 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' + - $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' + $ref: '#/components/responses/ppl.query___200' /_plugins/_ppl/_explain: post: operationId: ppl.explain.0 @@ -5002,18 +5209,18 @@ paths: 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' + - $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' + $ref: '#/components/responses/ppl.explain___200' /_plugins/_ppl/stats: get: operationId: ppl.get_stats.0 @@ -5023,16 +5230,16 @@ paths: 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' + - $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' + $ref: '#/components/responses/ppl.get_stats___200' post: operationId: ppl.post_stats.1 x-operation-group: ppl.post_stats @@ -5041,18 +5248,18 @@ paths: 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' + - $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' + $ref: '#/components/responses/ppl.post_stats___200' /_plugins/_query/_datasources: get: operationId: query.datasources_list.0 @@ -5061,13 +5268,13 @@ paths: description: Retrieves list of all datasources. responses: '200': - $ref: '#/components/responses/query.datasources_list@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' + - $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 @@ -5077,13 +5284,13 @@ paths: $ref: '#/components/requestBodies/query.datasources_create' responses: '201': - $ref: '#/components/responses/query.datasources_create@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' + - $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 @@ -5093,15 +5300,15 @@ paths: $ref: '#/components/requestBodies/query.datasources_update' responses: '200': - $ref: '#/components/responses/query.datasources_update@200' + $ref: '#/components/responses/query.datasources_update___200' '404': - $ref: '#/components/responses/query.datasources_update@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' + - $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 @@ -5109,34 +5316,34 @@ paths: 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' + - $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' + $ref: '#/components/responses/query.datasource_delete___204' '404': - $ref: '#/components/responses/query.datasource_delete@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' + - $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' + $ref: '#/components/responses/query.datasource_retrieve___200' '404': - $ref: '#/components/responses/query.datasource_retrieve@404' + $ref: '#/components/responses/query.datasource_retrieve___404' /_plugins/_query/settings: put: operationId: sql.settings.0 @@ -5146,17 +5353,17 @@ paths: 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' + - $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' + $ref: '#/components/responses/sql.settings___200' /_plugins/_refresh_search_analyzers/{index}: post: operationId: ism.refresh_search_analyzers.0 @@ -5165,15 +5372,221 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/im-plugin/refresh-analyzer/ parameters: - - $ref: '#/components/parameters/ism.refresh_search_analyzers::path.index' - - $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' + - $ref: '#/components/parameters/ism.refresh_search_analyzers___path.index' + - $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/ism.refresh_search_analyzers@200' + $ref: '#/components/responses/ism.refresh_search_analyzers___200' + /_plugins/_replication/_autofollow: + delete: + operationId: replication.delete_replication_rule.0 + x-operation-group: replication.delete_replication_rule + x-version-added: '1.1' + description: Deletes the specified replication rule. + externalDocs: + url: https://opensearch.org/docs/latest/tuning-your-cluster/replication-plugin/api/#delete-replication-rule + requestBody: + $ref: '#/components/requestBodies/replication.delete_replication_rule' + responses: + '200': + $ref: '#/components/responses/replication.delete_replication_rule___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: replication.create_replication_rule.0 + x-operation-group: replication.create_replication_rule + x-version-added: '1.1' + description: Automatically starts replication on indexes matching a specified pattern. + externalDocs: + url: https://opensearch.org/docs/latest/tuning-your-cluster/replication-plugin/api/#create-replication-rule + requestBody: + $ref: '#/components/requestBodies/replication.create_replication_rule' + responses: + '200': + $ref: '#/components/responses/replication.create_replication_rule___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/_replication/{index}/_pause: + post: + operationId: replication.pause.0 + x-operation-group: replication.pause + x-version-added: '1.1' + description: Pauses replication of the leader index. + externalDocs: + url: https://opensearch.org/docs/latest/tuning-your-cluster/replication-plugin/api/#pause-replication + parameters: + - $ref: '#/components/parameters/replication.pause___path.index' + - $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/replication.pause' + responses: + '200': + $ref: '#/components/responses/replication.pause___200' + /_plugins/_replication/{index}/_resume: + post: + operationId: replication.resume.0 + x-operation-group: replication.resume + x-version-added: '1.1' + description: Resumes replication of the leader index. + externalDocs: + url: https://opensearch.org/docs/latest/tuning-your-cluster/replication-plugin/api/#resume-replication + parameters: + - $ref: '#/components/parameters/replication.resume___path.index' + - $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/replication.resume' + responses: + '200': + $ref: '#/components/responses/replication.resume___200' + /_plugins/_replication/{index}/_start: + put: + operationId: replication.start.0 + x-operation-group: replication.start + x-version-added: '1.1' + description: Initiate replication of an index from the leader cluster to the follower cluster. + externalDocs: + url: https://opensearch.org/docs/latest/tuning-your-cluster/replication-plugin/api/#start-replication + parameters: + - $ref: '#/components/parameters/replication.start___path.index' + - $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/replication.start' + responses: + '200': + $ref: '#/components/responses/replication.start___200' + /_plugins/_replication/{index}/_status: + get: + operationId: replication.status.0 + x-operation-group: replication.status + x-version-added: '1.1' + description: Gets the status of index replication. + externalDocs: + url: https://opensearch.org/docs/latest/tuning-your-cluster/replication-plugin/api/#get-replication-status + parameters: + - $ref: '#/components/parameters/replication.status___path.index' + - $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/replication.status___200' + /_plugins/_replication/{index}/_stop: + post: + operationId: replication.stop.0 + x-operation-group: replication.stop + x-version-added: '1.1' + description: Terminates replication and converts the follower index to a standard index. + externalDocs: + url: https://opensearch.org/docs/latest/tuning-your-cluster/replication-plugin/api/#stop-replication + parameters: + - $ref: '#/components/parameters/replication.stop___path.index' + - $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/replication.stop' + responses: + '200': + $ref: '#/components/responses/replication.stop___200' + /_plugins/_replication/{index}/_update: + put: + operationId: replication.update_settings.0 + x-operation-group: replication.update_settings + x-version-added: '1.1' + description: Updates settings on the follower index. + externalDocs: + url: https://opensearch.org/docs/latest/tuning-your-cluster/replication-plugin/api/#update-settings + parameters: + - $ref: '#/components/parameters/replication.update_settings___path.index' + - $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/replication.update_settings' + responses: + '200': + $ref: '#/components/responses/replication.update_settings___200' + /_plugins/_replication/autofollow_stats: + get: + operationId: replication.autofollow_stats.0 + x-operation-group: replication.autofollow_stats + x-version-added: '1.1' + description: Gets information about auto-follow activity and any replication rules configured on the specified cluster. + externalDocs: + url: https://opensearch.org/docs/latest/tuning-your-cluster/replication-plugin/api/#get-auto-follow-stats + responses: + '200': + $ref: '#/components/responses/replication.autofollow_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/_replication/follower_stats: + get: + operationId: replication.follower_stats.0 + x-operation-group: replication.follower_stats + x-version-added: '1.1' + description: Gets information about follower (syncing) indexes on a specified cluster. + externalDocs: + url: https://opensearch.org/docs/latest/tuning-your-cluster/replication-plugin/api/#get-follower-cluster-stats + responses: + '200': + $ref: '#/components/responses/replication.follower_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/_replication/leader_stats: + get: + operationId: replication.leader_stats.0 + x-operation-group: replication.leader_stats + x-version-added: '1.1' + description: Gets information about replicated leader indexes on a specified cluster. + externalDocs: + url: https://opensearch.org/docs/latest/tuning-your-cluster/replication-plugin/api/#get-leader-cluster-stats + responses: + '200': + $ref: '#/components/responses/replication.leader_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/_rollup/jobs/{id}: delete: operationId: rollups.delete.0 @@ -5184,14 +5597,14 @@ paths: url: https://opensearch.org/docs/latest/im-plugin/index-rollups/rollup-api/#delete-an-index-rollup-job responses: '200': - $ref: '#/components/responses/rollups.delete@200' + $ref: '#/components/responses/rollups.delete___200' parameters: - - $ref: '#/components/parameters/rollups.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' + - $ref: '#/components/parameters/rollups.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' get: operationId: rollups.get.0 x-operation-group: rollups.get @@ -5200,15 +5613,15 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/im-plugin/index-rollups/rollup-api/#get-an-index-rollup-job parameters: - - $ref: '#/components/parameters/rollups.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' + - $ref: '#/components/parameters/rollups.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/rollups.get@200' + $ref: '#/components/responses/rollups.get___200' put: operationId: rollups.put.0 x-operation-group: rollups.put @@ -5218,16 +5631,16 @@ paths: url: https://opensearch.org/docs/latest/im-plugin/index-rollups/rollup-api/#create-or-update-an-index-rollup-job responses: '200': - $ref: '#/components/responses/rollups.put@200' + $ref: '#/components/responses/rollups.put___200' parameters: - - $ref: '#/components/parameters/rollups.put::path.id' - - $ref: '#/components/parameters/rollups.put::query.if_primary_term' - - $ref: '#/components/parameters/rollups.put::query.if_seq_no' - - $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' + - $ref: '#/components/parameters/rollups.put___path.id' + - $ref: '#/components/parameters/rollups.put___query.if_primary_term' + - $ref: '#/components/parameters/rollups.put___query.if_seq_no' + - $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/rollups.put' /_plugins/_rollup/jobs/{id}/_explain: @@ -5239,15 +5652,15 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/im-plugin/index-rollups/rollup-api/#explain-an-index-rollup-job parameters: - - $ref: '#/components/parameters/rollups.explain::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' + - $ref: '#/components/parameters/rollups.explain___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/rollups.explain@200' + $ref: '#/components/responses/rollups.explain___200' /_plugins/_rollup/jobs/{id}/_start: post: operationId: rollups.start.0 @@ -5257,15 +5670,15 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/im-plugin/index-rollups/rollup-api/#start-or-stop-an-index-rollup-job parameters: - - $ref: '#/components/parameters/rollups.start::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' + - $ref: '#/components/parameters/rollups.start___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/rollups.start@200' + $ref: '#/components/responses/rollups.start___200' /_plugins/_rollup/jobs/{id}/_stop: post: operationId: rollups.stop.0 @@ -5275,15 +5688,15 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/im-plugin/index-rollups/rollup-api/#start-or-stop-an-index-rollup-job parameters: - - $ref: '#/components/parameters/rollups.stop::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' + - $ref: '#/components/parameters/rollups.stop___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/rollups.stop@200' + $ref: '#/components/responses/rollups.stop___200' /_plugins/_security/api/_upgrade_check: get: operationId: security.config_upgrade_check.0 @@ -5297,13 +5710,13 @@ paths: url: https://opensearch.org/docs/latest/security/access-control/api/#configuration-upgrade-check responses: '200': - $ref: '#/components/responses/security.config_upgrade_check@200' + $ref: '#/components/responses/security.config_upgrade_check___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' + - $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/_security/api/_upgrade_perform: post: operationId: security.config_upgrade_perform.0 @@ -5319,15 +5732,15 @@ paths: $ref: '#/components/requestBodies/security.config_upgrade_perform' responses: '200': - $ref: '#/components/responses/security.config_upgrade_perform@200' + $ref: '#/components/responses/security.config_upgrade_perform___200' '400': - $ref: '#/components/responses/security.config_upgrade_perform@400' + $ref: '#/components/responses/security.config_upgrade_perform___400' 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' + - $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/_security/api/account: get: operationId: security.get_account_details.0 @@ -5341,13 +5754,13 @@ paths: url: https://opensearch.org/docs/latest/security/access-control/api/#get-account-details responses: '200': - $ref: '#/components/responses/security.get_account_details@200' + $ref: '#/components/responses/security.get_account_details___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' + - $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: security.change_password.0 x-operation-group: security.change_password @@ -5362,15 +5775,15 @@ paths: $ref: '#/components/requestBodies/security.change_password' responses: '200': - $ref: '#/components/responses/security.change_password@200' + $ref: '#/components/responses/security.change_password___200' '403': - $ref: '#/components/responses/security.change_password@403' + $ref: '#/components/responses/security.change_password___403' 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' + - $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/_security/api/actiongroups: get: operationId: security.get_action_groups.0 @@ -5384,13 +5797,13 @@ paths: url: https://opensearch.org/docs/latest/security/access-control/api/#get-action-groups responses: '200': - $ref: '#/components/responses/security.get_action_groups@200' + $ref: '#/components/responses/security.get_action_groups___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' + - $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' patch: operationId: security.patch_action_groups.1 x-operation-group: security.patch_action_groups @@ -5405,13 +5818,13 @@ paths: $ref: '#/components/requestBodies/security.patch_action_groups' responses: '200': - $ref: '#/components/responses/security.patch_action_groups@200' + $ref: '#/components/responses/security.patch_action_groups___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' + - $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/_security/api/actiongroups/{action_group}: delete: operationId: security.delete_action_group.0 @@ -5424,15 +5837,15 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#delete-action-group parameters: - - $ref: '#/components/parameters/security.delete_action_group::path.action_group' - - $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' + - $ref: '#/components/parameters/security.delete_action_group___path.action_group' + - $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.delete_action_group@200' + $ref: '#/components/responses/security.delete_action_group___200' get: operationId: security.get_action_group.0 x-operation-group: security.get_action_group @@ -5444,15 +5857,15 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#get-action-group parameters: - - $ref: '#/components/parameters/security.get_action_group::path.action_group' - - $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' + - $ref: '#/components/parameters/security.get_action_group___path.action_group' + - $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_action_group@200' + $ref: '#/components/responses/security.get_action_group___200' patch: operationId: security.patch_action_group.0 x-operation-group: security.patch_action_group @@ -5464,17 +5877,17 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#patch-action-group parameters: - - $ref: '#/components/parameters/security.patch_action_group::path.action_group' - - $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' + - $ref: '#/components/parameters/security.patch_action_group___path.action_group' + - $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/security.patch_action_group' responses: '200': - $ref: '#/components/responses/security.patch_action_group@200' + $ref: '#/components/responses/security.patch_action_group___200' put: operationId: security.create_action_group.0 x-operation-group: security.create_action_group @@ -5486,19 +5899,19 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#create-action-group parameters: - - $ref: '#/components/parameters/security.create_action_group::path.action_group' - - $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' + - $ref: '#/components/parameters/security.create_action_group___path.action_group' + - $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/security.create_action_group' responses: '200': - $ref: '#/components/responses/security.create_action_group@200' + $ref: '#/components/responses/security.create_action_group___200' '201': - $ref: '#/components/responses/security.create_action_group@201' + $ref: '#/components/responses/security.create_action_group___201' /_plugins/_security/api/allowlist: get: operationId: security.get_allowlist.0 @@ -5512,15 +5925,15 @@ paths: url: https://opensearch.org/docs/latest/security/access-control/api/#access-control-for-the-api responses: '200': - $ref: '#/components/responses/security.get_allowlist@200' + $ref: '#/components/responses/security.get_allowlist___200' '403': - $ref: '#/components/responses/security.get_allowlist@403' + $ref: '#/components/responses/security.get_allowlist___403' 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' + - $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' patch: operationId: security.patch_allowlist.0 x-operation-group: security.patch_allowlist @@ -5535,15 +5948,15 @@ paths: $ref: '#/components/requestBodies/security.patch_allowlist' responses: '200': - $ref: '#/components/responses/security.patch_allowlist@200' + $ref: '#/components/responses/security.patch_allowlist___200' '403': - $ref: '#/components/responses/security.patch_allowlist@403' + $ref: '#/components/responses/security.patch_allowlist___403' 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' + - $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: security.create_allowlist.0 x-operation-group: security.create_allowlist @@ -5551,22 +5964,22 @@ paths: x-distributions-excluded: - amazon-managed - amazon-serverless - description: Creates or replaces the allowlisted APIs. Accessible via Super Admin certificate or REST API permission. + description: Creates or replaces the permitted APIs. Accessible using Super Admin certificate or REST API permission. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#access-control-for-the-api requestBody: $ref: '#/components/requestBodies/security.create_allowlist' responses: '200': - $ref: '#/components/responses/security.create_allowlist@200' + $ref: '#/components/responses/security.create_allowlist___200' '403': - $ref: '#/components/responses/security.create_allowlist@403' + $ref: '#/components/responses/security.create_allowlist___403' 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' + - $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/_security/api/audit: get: operationId: security.get_audit_configuration.0 @@ -5580,13 +5993,13 @@ paths: url: https://opensearch.org/docs/latest/security/access-control/api/#audit-logs responses: '200': - $ref: '#/components/responses/security.get_audit_configuration@200' + $ref: '#/components/responses/security.get_audit_configuration___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' + - $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' patch: operationId: security.patch_audit_configuration.0 x-operation-group: security.patch_audit_configuration @@ -5601,13 +6014,13 @@ paths: $ref: '#/components/requestBodies/security.patch_audit_configuration' responses: '200': - $ref: '#/components/responses/security.patch_audit_configuration@200' + $ref: '#/components/responses/security.patch_audit_configuration___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' + - $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/_security/api/audit/config: put: operationId: security.update_audit_configuration.0 @@ -5623,13 +6036,13 @@ paths: $ref: '#/components/requestBodies/security.update_audit_configuration' responses: '200': - $ref: '#/components/responses/security.update_audit_configuration@200' + $ref: '#/components/responses/security.update_audit_configuration___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' + - $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/_security/api/authtoken: post: operationId: security.authtoken.0 @@ -5641,13 +6054,13 @@ paths: description: Returns the authorization token. responses: '200': - $ref: '#/components/responses/security.authtoken@200' + $ref: '#/components/responses/security.authtoken___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' + - $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/_security/api/cache: delete: operationId: security.flush_cache.0 @@ -5661,13 +6074,13 @@ paths: url: https://opensearch.org/docs/latest/security/access-control/api/#flush-cache responses: '200': - $ref: '#/components/responses/security.flush_cache@200' + $ref: '#/components/responses/security.flush_cache___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' + - $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' get: operationId: security.cache.1 x-operation-group: security.cache @@ -5679,13 +6092,13 @@ paths: description: Not supported for cache API. responses: '501': - $ref: '#/components/responses/security.cache@501' + $ref: '#/components/responses/security.cache___501' 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' + - $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: security.cache.2 x-operation-group: security.cache @@ -5697,13 +6110,13 @@ paths: description: Not supported for cache API. responses: '501': - $ref: '#/components/responses/security.cache@501' + $ref: '#/components/responses/security.cache___501' 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' + - $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: security.cache.3 x-operation-group: security.cache @@ -5715,13 +6128,13 @@ paths: description: Not supported for cache API. responses: '501': - $ref: '#/components/responses/security.cache@501' + $ref: '#/components/responses/security.cache___501' 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' + - $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/_security/api/certificates: get: operationId: security.get_all_certificates.0 @@ -5732,20 +6145,20 @@ paths: - 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' + - $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' + $ref: '#/components/responses/security.get_all_certificates___200' '403': - $ref: '#/components/responses/security.get_all_certificates@403' + $ref: '#/components/responses/security.get_all_certificates___403' '500': - $ref: '#/components/responses/security.get_all_certificates@500' + $ref: '#/components/responses/security.get_all_certificates___500' /_plugins/_security/api/certificates/{node_id}: get: operationId: security.get_node_certificates.0 @@ -5756,21 +6169,21 @@ paths: - 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' + - $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' + $ref: '#/components/responses/security.get_node_certificates___200' '403': - $ref: '#/components/responses/security.get_node_certificates@403' + $ref: '#/components/responses/security.get_node_certificates___403' '500': - $ref: '#/components/responses/security.get_node_certificates@500' + $ref: '#/components/responses/security.get_node_certificates___500' /_plugins/_security/api/generateonbehalfoftoken: post: operationId: security.generate_obo_token.0 @@ -5786,15 +6199,15 @@ paths: $ref: '#/components/requestBodies/security.generate_obo_token' responses: '200': - $ref: '#/components/responses/security.generate_obo_token@200' + $ref: '#/components/responses/security.generate_obo_token___200' '400': - $ref: '#/components/responses/security.generate_obo_token@400' + $ref: '#/components/responses/security.generate_obo_token___400' 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' + - $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/_security/api/internalusers: get: operationId: security.get_users.0 @@ -5808,13 +6221,13 @@ paths: url: https://opensearch.org/docs/latest/security/access-control/api/#get-users responses: '200': - $ref: '#/components/responses/security.get_users@200' + $ref: '#/components/responses/security.get_users___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' + - $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' patch: operationId: security.patch_users.0 x-operation-group: security.patch_users @@ -5829,13 +6242,13 @@ paths: $ref: '#/components/requestBodies/security.patch_users' responses: '200': - $ref: '#/components/responses/security.patch_users@200' + $ref: '#/components/responses/security.patch_users___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' + - $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/_security/api/internalusers/{username}: delete: operationId: security.delete_user.0 @@ -5848,15 +6261,15 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#delete-user parameters: - - $ref: '#/components/parameters/security.delete_user::path.username' - - $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' + - $ref: '#/components/parameters/security.delete_user___path.username' + - $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.delete_user@200' + $ref: '#/components/responses/security.delete_user___200' get: operationId: security.get_user.0 x-operation-group: security.get_user @@ -5868,15 +6281,15 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#get-user parameters: - - $ref: '#/components/parameters/security.get_user::path.username' - - $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' + - $ref: '#/components/parameters/security.get_user___path.username' + - $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_user@200' + $ref: '#/components/responses/security.get_user___200' patch: operationId: security.patch_user.0 x-operation-group: security.patch_user @@ -5888,17 +6301,17 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#patch-user parameters: - - $ref: '#/components/parameters/security.patch_user::path.username' - - $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' + - $ref: '#/components/parameters/security.patch_user___path.username' + - $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/security.patch_user' responses: '200': - $ref: '#/components/responses/security.patch_user@200' + $ref: '#/components/responses/security.patch_user___200' put: operationId: security.create_user.0 x-operation-group: security.create_user @@ -5910,17 +6323,17 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#create-user parameters: - - $ref: '#/components/parameters/security.create_user::path.username' - - $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' + - $ref: '#/components/parameters/security.create_user___path.username' + - $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/security.create_user' responses: '200': - $ref: '#/components/responses/security.create_user@200' + $ref: '#/components/responses/security.create_user___200' /_plugins/_security/api/internalusers/{username}/authtoken: post: operationId: security.generate_user_token.0 @@ -5931,17 +6344,17 @@ paths: - amazon-serverless description: Generates authorization token for the given user. parameters: - - $ref: '#/components/parameters/security.generate_user_token::path.username' - - $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' + - $ref: '#/components/parameters/security.generate_user_token___path.username' + - $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.generate_user_token@200' + $ref: '#/components/responses/security.generate_user_token___200' '400': - $ref: '#/components/responses/security.generate_user_token@400' + $ref: '#/components/responses/security.generate_user_token___400' /_plugins/_security/api/migrate: post: operationId: security.migrate.0 @@ -5953,15 +6366,15 @@ paths: description: Migrates security configuration from v6 to v7. responses: '200': - $ref: '#/components/responses/security.migrate@200' + $ref: '#/components/responses/security.migrate___200' '400': - $ref: '#/components/responses/security.migrate@400' + $ref: '#/components/responses/security.migrate___400' 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' + - $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/_security/api/nodesdn: get: operationId: security.get_distinguished_names.0 @@ -5974,19 +6387,19 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#get-distinguished-names parameters: - - $ref: '#/components/parameters/security.get_distinguished_names::query.show_all' - - $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' + - $ref: '#/components/parameters/security.get_distinguished_names___query.show_all' + - $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_distinguished_names@200' + $ref: '#/components/responses/security.get_distinguished_names___200' '400': - $ref: '#/components/responses/security.get_distinguished_names@400' + $ref: '#/components/responses/security.get_distinguished_names___400' '403': - $ref: '#/components/responses/security.get_distinguished_names@403' + $ref: '#/components/responses/security.get_distinguished_names___403' patch: operationId: security.patch_distinguished_names.0 x-operation-group: security.patch_distinguished_names @@ -6001,17 +6414,17 @@ paths: $ref: '#/components/requestBodies/security.patch_distinguished_names' responses: '200': - $ref: '#/components/responses/security.patch_distinguished_names@200' + $ref: '#/components/responses/security.patch_distinguished_names___200' '400': - $ref: '#/components/responses/security.patch_distinguished_names@400' + $ref: '#/components/responses/security.patch_distinguished_names___400' '403': - $ref: '#/components/responses/security.patch_distinguished_names@403' + $ref: '#/components/responses/security.patch_distinguished_names___403' 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' + - $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/_security/api/nodesdn/{cluster_name}: delete: operationId: security.delete_distinguished_name.0 @@ -6024,19 +6437,19 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#delete-distinguished-names parameters: - - $ref: '#/components/parameters/security.delete_distinguished_name::path.cluster_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' + - $ref: '#/components/parameters/security.delete_distinguished_name___path.cluster_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/security.delete_distinguished_name@200' + $ref: '#/components/responses/security.delete_distinguished_name___200' '400': - $ref: '#/components/responses/security.delete_distinguished_name@400' + $ref: '#/components/responses/security.delete_distinguished_name___400' '403': - $ref: '#/components/responses/security.delete_distinguished_name@403' + $ref: '#/components/responses/security.delete_distinguished_name___403' get: operationId: security.get_distinguished_name.0 x-operation-group: security.get_distinguished_name @@ -6048,20 +6461,20 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#get-distinguished-names parameters: - - $ref: '#/components/parameters/security.get_distinguished_name::path.cluster_name' - - $ref: '#/components/parameters/security.get_distinguished_name::query.show_all' - - $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' + - $ref: '#/components/parameters/security.get_distinguished_name___path.cluster_name' + - $ref: '#/components/parameters/security.get_distinguished_name___query.show_all' + - $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_distinguished_name@200' + $ref: '#/components/responses/security.get_distinguished_name___200' '400': - $ref: '#/components/responses/security.get_distinguished_name@400' + $ref: '#/components/responses/security.get_distinguished_name___400' '403': - $ref: '#/components/responses/security.get_distinguished_name@403' + $ref: '#/components/responses/security.get_distinguished_name___403' patch: operationId: security.patch_distinguished_name.0 x-operation-group: security.patch_distinguished_name @@ -6071,21 +6484,21 @@ paths: - 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' - - $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' + - $ref: '#/components/parameters/security.patch_distinguished_name___path.cluster_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' requestBody: $ref: '#/components/requestBodies/security.patch_distinguished_name' responses: '200': - $ref: '#/components/responses/security.patch_distinguished_name@200' + $ref: '#/components/responses/security.patch_distinguished_name___200' '400': - $ref: '#/components/responses/security.patch_distinguished_name@400' + $ref: '#/components/responses/security.patch_distinguished_name___400' '403': - $ref: '#/components/responses/security.patch_distinguished_name@403' + $ref: '#/components/responses/security.patch_distinguished_name___403' put: operationId: security.update_distinguished_name.0 x-operation-group: security.update_distinguished_name @@ -6097,21 +6510,21 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#update-distinguished-names parameters: - - $ref: '#/components/parameters/security.update_distinguished_name::path.cluster_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' + - $ref: '#/components/parameters/security.update_distinguished_name___path.cluster_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' requestBody: $ref: '#/components/requestBodies/security.update_distinguished_name' responses: '200': - $ref: '#/components/responses/security.update_distinguished_name@200' + $ref: '#/components/responses/security.update_distinguished_name___200' '400': - $ref: '#/components/responses/security.update_distinguished_name@400' + $ref: '#/components/responses/security.update_distinguished_name___400' '403': - $ref: '#/components/responses/security.update_distinguished_name@403' + $ref: '#/components/responses/security.update_distinguished_name___403' /_plugins/_security/api/permissionsinfo: get: operationId: security.get_permissions_info.0 @@ -6123,15 +6536,15 @@ paths: description: Gets the evaluated REST API permissions for the currently logged in user. responses: '200': - $ref: '#/components/responses/security.get_permissions_info@200' + $ref: '#/components/responses/security.get_permissions_info___200' '500': - $ref: '#/components/responses/security.get_permissions_info@500' + $ref: '#/components/responses/security.get_permissions_info___500' 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' + - $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/_security/api/roles: get: operationId: security.get_roles.0 @@ -6145,13 +6558,13 @@ paths: url: https://opensearch.org/docs/latest/security/access-control/api/#get-roles responses: '200': - $ref: '#/components/responses/security.get_roles@200' + $ref: '#/components/responses/security.get_roles___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' + - $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' patch: operationId: security.patch_roles.0 x-operation-group: security.patch_roles @@ -6166,15 +6579,15 @@ paths: $ref: '#/components/requestBodies/security.patch_roles' responses: '200': - $ref: '#/components/responses/security.patch_roles@200' + $ref: '#/components/responses/security.patch_roles___200' '400': - $ref: '#/components/responses/security.patch_roles@400' + $ref: '#/components/responses/security.patch_roles___400' 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' + - $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/_security/api/roles/{role}: delete: operationId: security.delete_role.0 @@ -6187,15 +6600,15 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#delete-role parameters: - - $ref: '#/components/parameters/security.delete_role::path.role' - - $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' + - $ref: '#/components/parameters/security.delete_role___path.role' + - $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.delete_role@200' + $ref: '#/components/responses/security.delete_role___200' get: operationId: security.get_role.0 x-operation-group: security.get_role @@ -6207,15 +6620,15 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#get-role parameters: - - $ref: '#/components/parameters/security.get_role::path.role' - - $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' + - $ref: '#/components/parameters/security.get_role___path.role' + - $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_role@200' + $ref: '#/components/responses/security.get_role___200' patch: operationId: security.patch_role.0 x-operation-group: security.patch_role @@ -6227,19 +6640,19 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#patch-role parameters: - - $ref: '#/components/parameters/security.patch_role::path.role' - - $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' + - $ref: '#/components/parameters/security.patch_role___path.role' + - $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/security.patch_role' responses: '200': - $ref: '#/components/responses/security.patch_role@200' + $ref: '#/components/responses/security.patch_role___200' '400': - $ref: '#/components/responses/security.patch_role@400' + $ref: '#/components/responses/security.patch_role___400' put: operationId: security.create_role.0 x-operation-group: security.create_role @@ -6251,19 +6664,19 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#create-role parameters: - - $ref: '#/components/parameters/security.create_role::path.role' - - $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' + - $ref: '#/components/parameters/security.create_role___path.role' + - $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/security.create_role' responses: '200': - $ref: '#/components/responses/security.create_role@200' + $ref: '#/components/responses/security.create_role___200' '201': - $ref: '#/components/responses/security.create_role@201' + $ref: '#/components/responses/security.create_role___201' /_plugins/_security/api/rolesmapping: get: operationId: security.get_role_mappings.0 @@ -6277,13 +6690,13 @@ paths: url: https://opensearch.org/docs/latest/security/access-control/api/#get-role-mappings responses: '200': - $ref: '#/components/responses/security.get_role_mappings@200' + $ref: '#/components/responses/security.get_role_mappings___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' + - $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' patch: operationId: security.patch_role_mappings.0 x-operation-group: security.patch_role_mappings @@ -6298,15 +6711,15 @@ paths: $ref: '#/components/requestBodies/security.patch_role_mappings' responses: '200': - $ref: '#/components/responses/security.patch_role_mappings@200' + $ref: '#/components/responses/security.patch_role_mappings___200' '400': - $ref: '#/components/responses/security.patch_role_mappings@400' + $ref: '#/components/responses/security.patch_role_mappings___400' 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' + - $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/_security/api/rolesmapping/{role}: delete: operationId: security.delete_role_mapping.0 @@ -6319,15 +6732,15 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#delete-role-mapping parameters: - - $ref: '#/components/parameters/security.delete_role_mapping::path.role' - - $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' + - $ref: '#/components/parameters/security.delete_role_mapping___path.role' + - $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.delete_role_mapping@200' + $ref: '#/components/responses/security.delete_role_mapping___200' get: operationId: security.get_role_mapping.0 x-operation-group: security.get_role_mapping @@ -6339,15 +6752,15 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#get-role-mapping parameters: - - $ref: '#/components/parameters/security.get_role_mapping::path.role' - - $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' + - $ref: '#/components/parameters/security.get_role_mapping___path.role' + - $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_role_mapping@200' + $ref: '#/components/responses/security.get_role_mapping___200' patch: operationId: security.patch_role_mapping.0 x-operation-group: security.patch_role_mapping @@ -6359,19 +6772,19 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#patch-role-mapping parameters: - - $ref: '#/components/parameters/security.patch_role_mapping::path.role' - - $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' + - $ref: '#/components/parameters/security.patch_role_mapping___path.role' + - $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/security.patch_role_mapping' responses: '200': - $ref: '#/components/responses/security.patch_role_mapping@200' + $ref: '#/components/responses/security.patch_role_mapping___200' '400': - $ref: '#/components/responses/security.patch_role_mapping@400' + $ref: '#/components/responses/security.patch_role_mapping___400' put: operationId: security.create_role_mapping.0 x-operation-group: security.create_role_mapping @@ -6383,19 +6796,19 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#create-role-mapping parameters: - - $ref: '#/components/parameters/security.create_role_mapping::path.role' - - $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' + - $ref: '#/components/parameters/security.create_role_mapping___path.role' + - $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/security.create_role_mapping' responses: '200': - $ref: '#/components/responses/security.create_role_mapping@200' + $ref: '#/components/responses/security.create_role_mapping___200' '201': - $ref: '#/components/responses/security.create_role_mapping@201' + $ref: '#/components/responses/security.create_role_mapping___201' /_plugins/_security/api/securityconfig: get: operationId: security.get_configuration.0 @@ -6409,13 +6822,13 @@ paths: url: https://opensearch.org/docs/latest/security/access-control/api/#get-configuration responses: '200': - $ref: '#/components/responses/security.get_configuration@200' + $ref: '#/components/responses/security.get_configuration___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' + - $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' patch: operationId: security.patch_configuration.0 x-operation-group: security.patch_configuration @@ -6423,22 +6836,22 @@ paths: 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. + 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 requestBody: $ref: '#/components/requestBodies/security.patch_configuration' responses: '200': - $ref: '#/components/responses/security.patch_configuration@200' + $ref: '#/components/responses/security.patch_configuration___200' '403': - $ref: '#/components/responses/security.patch_configuration@403' + $ref: '#/components/responses/security.patch_configuration___403' 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' + - $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/_security/api/securityconfig/config: put: operationId: security.update_configuration.0 @@ -6447,22 +6860,22 @@ paths: 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. + 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 requestBody: $ref: '#/components/requestBodies/security.update_configuration' responses: '200': - $ref: '#/components/responses/security.update_configuration@200' + $ref: '#/components/responses/security.update_configuration___200' '403': - $ref: '#/components/responses/security.update_configuration@403' + $ref: '#/components/responses/security.update_configuration___403' 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' + - $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/_security/api/ssl/certs: get: operationId: security.get_certificates.0 @@ -6476,17 +6889,17 @@ paths: url: https://opensearch.org/docs/latest/security/access-control/api/#get-certificates responses: '200': - $ref: '#/components/responses/security.get_certificates@200' + $ref: '#/components/responses/security.get_certificates___200' '400': - $ref: '#/components/responses/security.get_certificates@400' + $ref: '#/components/responses/security.get_certificates___400' '403': - $ref: '#/components/responses/security.get_certificates@403' + $ref: '#/components/responses/security.get_certificates___403' 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' + - $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/_security/api/ssl/http/reloadcerts: put: operationId: security.reload_http_certificates.0 @@ -6500,17 +6913,17 @@ paths: url: https://opensearch.org/docs/latest/security/access-control/api/#reload-http-certificates responses: '200': - $ref: '#/components/responses/security.reload_http_certificates@200' + $ref: '#/components/responses/security.reload_http_certificates___200' '400': - $ref: '#/components/responses/security.reload_http_certificates@400' + $ref: '#/components/responses/security.reload_http_certificates___400' '403': - $ref: '#/components/responses/security.reload_http_certificates@403' + $ref: '#/components/responses/security.reload_http_certificates___403' 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' + - $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/_security/api/ssl/transport/reloadcerts: put: operationId: security.reload_transport_certificates.0 @@ -6524,17 +6937,17 @@ paths: url: https://opensearch.org/docs/latest/security/access-control/api/#reload-transport-certificates responses: '200': - $ref: '#/components/responses/security.reload_transport_certificates@200' + $ref: '#/components/responses/security.reload_transport_certificates___200' '400': - $ref: '#/components/responses/security.reload_transport_certificates@400' + $ref: '#/components/responses/security.reload_transport_certificates___400' '403': - $ref: '#/components/responses/security.reload_transport_certificates@403' + $ref: '#/components/responses/security.reload_transport_certificates___403' 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' + - $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/_security/api/tenancy/config: get: operationId: security.get_tenancy_config.0 @@ -6548,15 +6961,15 @@ paths: url: https://opensearch.org/docs/latest/security/multi-tenancy/dynamic-config/#configuring-multi-tenancy-with-the-rest-api responses: '200': - $ref: '#/components/responses/security.get_tenancy_config@200' + $ref: '#/components/responses/security.get_tenancy_config___200' '400': - $ref: '#/components/responses/security.get_tenancy_config@400' + $ref: '#/components/responses/security.get_tenancy_config___400' 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' + - $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: security.create_update_tenancy_config.0 x-operation-group: security.create_update_tenancy_config @@ -6571,15 +6984,15 @@ paths: $ref: '#/components/requestBodies/security.create_update_tenancy_config' responses: '200': - $ref: '#/components/responses/security.create_update_tenancy_config@200' + $ref: '#/components/responses/security.create_update_tenancy_config___200' '400': - $ref: '#/components/responses/security.create_update_tenancy_config@400' + $ref: '#/components/responses/security.create_update_tenancy_config___400' 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' + - $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/_security/api/tenants: get: operationId: security.get_tenants.0 @@ -6593,15 +7006,15 @@ paths: url: https://opensearch.org/docs/latest/security/access-control/api/#get-tenants responses: '200': - $ref: '#/components/responses/security.get_tenants@200' + $ref: '#/components/responses/security.get_tenants___200' '400': - $ref: '#/components/responses/security.get_tenants@400' + $ref: '#/components/responses/security.get_tenants___400' 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' + - $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' patch: operationId: security.patch_tenants.0 x-operation-group: security.patch_tenants @@ -6616,15 +7029,15 @@ paths: $ref: '#/components/requestBodies/security.patch_tenants' responses: '200': - $ref: '#/components/responses/security.patch_tenants@200' + $ref: '#/components/responses/security.patch_tenants___200' '400': - $ref: '#/components/responses/security.patch_tenants@400' + $ref: '#/components/responses/security.patch_tenants___400' 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' + - $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/_security/api/tenants/{tenant}: delete: operationId: security.delete_tenant.0 @@ -6637,17 +7050,17 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#delete-action-group parameters: - - $ref: '#/components/parameters/security.delete_tenant::path.tenant' - - $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' + - $ref: '#/components/parameters/security.delete_tenant___path.tenant' + - $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.delete_tenant@200' + $ref: '#/components/responses/security.delete_tenant___200' '400': - $ref: '#/components/responses/security.delete_tenant@400' + $ref: '#/components/responses/security.delete_tenant___400' get: operationId: security.get_tenant.0 x-operation-group: security.get_tenant @@ -6659,15 +7072,15 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#get-tenant parameters: - - $ref: '#/components/parameters/security.get_tenant::path.tenant' - - $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' + - $ref: '#/components/parameters/security.get_tenant___path.tenant' + - $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_tenant@200' + $ref: '#/components/responses/security.get_tenant___200' patch: operationId: security.patch_tenant.0 x-operation-group: security.patch_tenant @@ -6679,19 +7092,19 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#patch-tenant parameters: - - $ref: '#/components/parameters/security.patch_tenant::path.tenant' - - $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' + - $ref: '#/components/parameters/security.patch_tenant___path.tenant' + - $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/security.patch_tenant' responses: '200': - $ref: '#/components/responses/security.patch_tenant@200' + $ref: '#/components/responses/security.patch_tenant___200' '400': - $ref: '#/components/responses/security.patch_tenant@400' + $ref: '#/components/responses/security.patch_tenant___400' put: operationId: security.create_tenant.0 x-operation-group: security.create_tenant @@ -6703,21 +7116,21 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#create-tenant parameters: - - $ref: '#/components/parameters/security.create_tenant::path.tenant' - - $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' + - $ref: '#/components/parameters/security.create_tenant___path.tenant' + - $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/security.create_tenant' responses: '200': - $ref: '#/components/responses/security.create_tenant@200' + $ref: '#/components/responses/security.create_tenant___200' '201': - $ref: '#/components/responses/security.create_tenant@201' + $ref: '#/components/responses/security.create_tenant___201' '400': - $ref: '#/components/responses/security.create_tenant@400' + $ref: '#/components/responses/security.create_tenant___400' /_plugins/_security/api/user: get: operationId: security.get_users_legacy.0 @@ -6729,13 +7142,13 @@ paths: description: Retrieve all internal users. Legacy API. responses: '200': - $ref: '#/components/responses/security.get_users_legacy@200' + $ref: '#/components/responses/security.get_users_legacy___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' + - $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/_security/api/user/{username}: delete: operationId: security.delete_user_legacy.0 @@ -6746,15 +7159,15 @@ paths: - amazon-serverless description: Delete the specified user. Legacy API. parameters: - - $ref: '#/components/parameters/security.delete_user_legacy::path.username' - - $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' + - $ref: '#/components/parameters/security.delete_user_legacy___path.username' + - $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.delete_user_legacy@200' + $ref: '#/components/responses/security.delete_user_legacy___200' get: operationId: security.get_user_legacy.0 x-operation-group: security.get_user_legacy @@ -6764,15 +7177,15 @@ paths: - amazon-serverless description: Retrieve one user. Legacy API. parameters: - - $ref: '#/components/parameters/security.get_user_legacy::path.username' - - $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' + - $ref: '#/components/parameters/security.get_user_legacy___path.username' + - $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_user_legacy@200' + $ref: '#/components/responses/security.get_user_legacy___200' put: operationId: security.create_user_legacy.0 x-operation-group: security.create_user_legacy @@ -6782,19 +7195,19 @@ paths: - amazon-serverless description: Creates or replaces the specified user. Legacy API. parameters: - - $ref: '#/components/parameters/security.create_user_legacy::path.username' - - $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' + - $ref: '#/components/parameters/security.create_user_legacy___path.username' + - $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/security.create_user_legacy' responses: '200': - $ref: '#/components/responses/security.create_user_legacy@200' + $ref: '#/components/responses/security.create_user_legacy___200' '201': - $ref: '#/components/responses/security.create_user_legacy@201' + $ref: '#/components/responses/security.create_user_legacy___201' /_plugins/_security/api/user/{username}/authtoken: post: operationId: security.generate_user_token_legacy.0 @@ -6803,17 +7216,17 @@ paths: x-distributions-excluded: - amazon-managed - amazon-serverless - description: Generates authorization token for the given user. Legacy API. Not Implemented. + 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' - - $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' + - $ref: '#/components/parameters/security.generate_user_token_legacy___path.username' + - $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: '501': - $ref: '#/components/responses/security.generate_user_token_legacy@501' + $ref: '#/components/responses/security.generate_user_token_legacy___501' /_plugins/_security/api/validate: get: operationId: security.validate.0 @@ -6824,17 +7237,17 @@ paths: - 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' - - $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' + - $ref: '#/components/parameters/security.validate___query.accept_invalid' + - $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.validate@200' + $ref: '#/components/responses/security.validate___200' '400': - $ref: '#/components/responses/security.validate@400' + $ref: '#/components/responses/security.validate___400' /_plugins/_security/authinfo: get: operationId: security.authinfo.0 @@ -6845,18 +7258,18 @@ paths: - amazon-serverless description: Returns the authentication information. parameters: - - $ref: '#/components/parameters/security.authinfo::query.auth_type' - - $ref: '#/components/parameters/security.authinfo::query.verbose' - - $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' + - $ref: '#/components/parameters/security.authinfo___query.auth_type' + - $ref: '#/components/parameters/security.authinfo___query.verbose' + - $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.authinfo@200' + $ref: '#/components/responses/security.authinfo___200' '500': - $ref: '#/components/responses/security.authinfo@500' + $ref: '#/components/responses/security.authinfo___500' post: operationId: security.authinfo.1 x-operation-group: security.authinfo @@ -6866,18 +7279,18 @@ paths: - amazon-serverless description: Returns the authentication information. parameters: - - $ref: '#/components/parameters/security.authinfo::query.auth_type' - - $ref: '#/components/parameters/security.authinfo::query.verbose' - - $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' + - $ref: '#/components/parameters/security.authinfo___query.auth_type' + - $ref: '#/components/parameters/security.authinfo___query.verbose' + - $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.authinfo@200' + $ref: '#/components/responses/security.authinfo___200' '500': - $ref: '#/components/responses/security.authinfo@500' + $ref: '#/components/responses/security.authinfo___500' /_plugins/_security/dashboardsinfo: get: operationId: security.get_dashboards_info.0 @@ -6889,15 +7302,15 @@ paths: description: Retrieves the current security-dashboards plugin configuration. responses: '200': - $ref: '#/components/responses/security.get_dashboards_info@200' + $ref: '#/components/responses/security.get_dashboards_info___200' '500': - $ref: '#/components/responses/security.get_dashboards_info@500' + $ref: '#/components/responses/security.get_dashboards_info___500' 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' + - $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: security.post_dashboards_info.1 x-operation-group: security.post_dashboards_info @@ -6908,15 +7321,15 @@ paths: description: Updates the current security-dashboards plugin configuration. responses: '200': - $ref: '#/components/responses/security.post_dashboards_info@200' + $ref: '#/components/responses/security.post_dashboards_info___200' '500': - $ref: '#/components/responses/security.post_dashboards_info@500' + $ref: '#/components/responses/security.post_dashboards_info___500' 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' + - $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/_security/health: get: operationId: security.health.0 @@ -6927,17 +7340,17 @@ paths: - amazon-serverless description: Checks to see if the Security plugin is up and running. parameters: - - $ref: '#/components/parameters/security.health::query.mode' - - $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' + - $ref: '#/components/parameters/security.health___query.mode' + - $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' externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#health-check responses: '200': - $ref: '#/components/responses/security.health@200' + $ref: '#/components/responses/security.health___200' post: operationId: security.health.1 x-operation-group: security.health @@ -6947,17 +7360,17 @@ paths: - amazon-serverless description: Checks to see if the Security plugin is up and running. parameters: - - $ref: '#/components/parameters/security.health::query.mode' - - $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' + - $ref: '#/components/parameters/security.health___query.mode' + - $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' externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#health-check responses: '200': - $ref: '#/components/responses/security.health@200' + $ref: '#/components/responses/security.health___200' /_plugins/_security/tenantinfo: get: operationId: security.tenant_info.0 @@ -6969,17 +7382,17 @@ paths: 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' + $ref: '#/components/responses/security.tenant_info___200' '403': - $ref: '#/components/responses/security.tenant_info@403' + $ref: '#/components/responses/security.tenant_info___403' '500': - $ref: '#/components/responses/security.tenant_info@500' + $ref: '#/components/responses/security.tenant_info___500' 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' + - $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: security.tenant_info.1 x-operation-group: security.tenant_info @@ -6990,17 +7403,17 @@ paths: 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' + $ref: '#/components/responses/security.tenant_info___200' '403': - $ref: '#/components/responses/security.tenant_info@403' + $ref: '#/components/responses/security.tenant_info___403' '500': - $ref: '#/components/responses/security.tenant_info@500' + $ref: '#/components/responses/security.tenant_info___500' 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' + - $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/_security/whoami: get: operationId: security.who_am_i.0 @@ -7012,15 +7425,15 @@ paths: description: Gets the user identity related information for currently logged in user. responses: '200': - $ref: '#/components/responses/security.who_am_i@200' + $ref: '#/components/responses/security.who_am_i___200' '500': - $ref: '#/components/responses/security.who_am_i@500' + $ref: '#/components/responses/security.who_am_i___500' 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' + - $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: security.who_am_i.1 x-operation-group: security.who_am_i @@ -7031,15 +7444,15 @@ paths: description: Gets the user identity related information for currently logged in user. responses: '200': - $ref: '#/components/responses/security.who_am_i@200' + $ref: '#/components/responses/security.who_am_i___200' '500': - $ref: '#/components/responses/security.who_am_i@500' + $ref: '#/components/responses/security.who_am_i___500' 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' + - $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/_security/whoamiprotected: get: operationId: security.who_am_i_protected.0 @@ -7051,15 +7464,15 @@ paths: 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': - $ref: '#/components/responses/security.who_am_i_protected@200' + $ref: '#/components/responses/security.who_am_i_protected___200' '500': - $ref: '#/components/responses/security.who_am_i_protected@500' + $ref: '#/components/responses/security.who_am_i_protected___500' 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' + - $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/_sql: post: operationId: sql.query.0 @@ -7069,18 +7482,18 @@ paths: 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' + - $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' + $ref: '#/components/responses/sql.query___200' /_plugins/_sql/_explain: post: operationId: sql.explain.0 @@ -7090,18 +7503,18 @@ paths: 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' + - $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' + $ref: '#/components/responses/sql.explain___200' /_plugins/_sql/close: post: operationId: sql.close.0 @@ -7111,18 +7524,18 @@ paths: 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' + - $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' + $ref: '#/components/responses/sql.close___200' /_plugins/_sql/stats: get: operationId: sql.get_stats.0 @@ -7132,16 +7545,16 @@ paths: 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' + - $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' + $ref: '#/components/responses/sql.get_stats___200' post: operationId: sql.post_stats.1 x-operation-group: sql.post_stats @@ -7150,18 +7563,18 @@ paths: 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' + - $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' + $ref: '#/components/responses/sql.post_stats___200' /_plugins/_transform: get: operationId: transforms.search.0 @@ -7171,19 +7584,19 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/im-plugin/index-transforms/transforms-apis/#get-a-transform-jobs-details parameters: - - $ref: '#/components/parameters/transforms.search::query.from' - - $ref: '#/components/parameters/transforms.search::query.search' - - $ref: '#/components/parameters/transforms.search::query.size' - - $ref: '#/components/parameters/transforms.search::query.sortDirection' - - $ref: '#/components/parameters/transforms.search::query.sortField' - - $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' + - $ref: '#/components/parameters/transforms.search___query.from' + - $ref: '#/components/parameters/transforms.search___query.search' + - $ref: '#/components/parameters/transforms.search___query.size' + - $ref: '#/components/parameters/transforms.search___query.sortDirection' + - $ref: '#/components/parameters/transforms.search___query.sortField' + - $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/transforms.search@200' + $ref: '#/components/responses/transforms.search___200' /_plugins/_transform/_preview: post: operationId: transforms.preview.0 @@ -7196,13 +7609,13 @@ paths: $ref: '#/components/requestBodies/transforms.preview' responses: '200': - $ref: '#/components/responses/transforms.preview@200' + $ref: '#/components/responses/transforms.preview___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' + - $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/_transform/{id}: delete: operationId: transforms.delete.0 @@ -7212,15 +7625,15 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/im-plugin/index-transforms/transforms-apis/#delete-a-transform-job parameters: - - $ref: '#/components/parameters/transforms.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' + - $ref: '#/components/parameters/transforms.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/transforms.delete@200' + $ref: '#/components/responses/transforms.delete___200' get: operationId: transforms.get.0 x-operation-group: transforms.get @@ -7229,36 +7642,36 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/im-plugin/index-transforms/transforms-apis/#get-a-transform-jobs-details parameters: - - $ref: '#/components/parameters/transforms.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' + - $ref: '#/components/parameters/transforms.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/transforms.get@200' + $ref: '#/components/responses/transforms.get___200' put: operationId: transforms.put.0 x-operation-group: transforms.put x-version-added: '1.0' - description: Create an index transform, or update a transform if if_seq_no and if_primary_term are provided. + description: Create an index transform, or update a transform if `if_seq_no` and `if_primary_term` are provided. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/index-transforms/transforms-apis/#create-a-transform-job parameters: - - $ref: '#/components/parameters/transforms.put::path.id' - - $ref: '#/components/parameters/transforms.put::query.if_primary_term' - - $ref: '#/components/parameters/transforms.put::query.if_seq_no' - - $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' + - $ref: '#/components/parameters/transforms.put___path.id' + - $ref: '#/components/parameters/transforms.put___query.if_primary_term' + - $ref: '#/components/parameters/transforms.put___query.if_seq_no' + - $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/transforms.put' responses: '200': - $ref: '#/components/responses/transforms.put@200' + $ref: '#/components/responses/transforms.put___200' /_plugins/_transform/{id}/_explain: get: operationId: transforms.explain.0 @@ -7268,15 +7681,15 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/im-plugin/index-transforms/transforms-apis/#get-the-status-of-a-transform-job parameters: - - $ref: '#/components/parameters/transforms.explain::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' + - $ref: '#/components/parameters/transforms.explain___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/transforms.explain@200' + $ref: '#/components/responses/transforms.explain___200' /_plugins/_transform/{id}/_start: post: operationId: transforms.start.0 @@ -7286,15 +7699,15 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/im-plugin/index-transforms/transforms-apis/#start-a-transform-job parameters: - - $ref: '#/components/parameters/transforms.start::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' + - $ref: '#/components/parameters/transforms.start___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/transforms.start@200' + $ref: '#/components/responses/transforms.start___200' /_plugins/_transform/{id}/_stop: post: operationId: transforms.stop.0 @@ -7304,15 +7717,15 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/im-plugin/index-transforms/transforms-apis/#stop-a-transform-job parameters: - - $ref: '#/components/parameters/transforms.stop::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' + - $ref: '#/components/parameters/transforms.stop___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/transforms.stop@200' + $ref: '#/components/responses/transforms.stop___200' /_rank_eval: get: operationId: rank_eval.0 @@ -7322,20 +7735,20 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/rank-eval/ parameters: - - $ref: '#/components/parameters/rank_eval::query.allow_no_indices' - - $ref: '#/components/parameters/rank_eval::query.expand_wildcards' - - $ref: '#/components/parameters/rank_eval::query.ignore_unavailable' - - $ref: '#/components/parameters/rank_eval::query.search_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' + - $ref: '#/components/parameters/rank_eval___query.allow_no_indices' + - $ref: '#/components/parameters/rank_eval___query.expand_wildcards' + - $ref: '#/components/parameters/rank_eval___query.ignore_unavailable' + - $ref: '#/components/parameters/rank_eval___query.search_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' requestBody: $ref: '#/components/requestBodies/rank_eval' responses: '200': - $ref: '#/components/responses/rank_eval@200' + $ref: '#/components/responses/rank_eval___200' post: operationId: rank_eval.1 x-operation-group: rank_eval @@ -7344,20 +7757,20 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/rank-eval/ parameters: - - $ref: '#/components/parameters/rank_eval::query.allow_no_indices' - - $ref: '#/components/parameters/rank_eval::query.expand_wildcards' - - $ref: '#/components/parameters/rank_eval::query.ignore_unavailable' - - $ref: '#/components/parameters/rank_eval::query.search_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' + - $ref: '#/components/parameters/rank_eval___query.allow_no_indices' + - $ref: '#/components/parameters/rank_eval___query.expand_wildcards' + - $ref: '#/components/parameters/rank_eval___query.ignore_unavailable' + - $ref: '#/components/parameters/rank_eval___query.search_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' requestBody: $ref: '#/components/requestBodies/rank_eval' responses: '200': - $ref: '#/components/responses/rank_eval@200' + $ref: '#/components/responses/rank_eval___200' /_recovery: get: operationId: indices.recovery.0 @@ -7367,55 +7780,55 @@ paths: externalDocs: url: https://opensearch.org/docs/latest parameters: - - $ref: '#/components/parameters/indices.recovery::query.active_only' - - $ref: '#/components/parameters/indices.recovery::query.detailed' - - $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' + - $ref: '#/components/parameters/indices.recovery___query.active_only' + - $ref: '#/components/parameters/indices.recovery___query.detailed' + - $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/indices.recovery@200' + $ref: '#/components/responses/indices.recovery___200' /_refresh: get: operationId: indices.refresh.0 x-operation-group: indices.refresh x-version-added: '1.0' - description: Performs the refresh operation in one or more indices. + description: Performs the refresh operation in one or more indexes. externalDocs: url: https://opensearch.org/docs/latest/tuning-your-cluster/availability-and-recovery/remote-store/index/#refresh-level-and-request-level-durability parameters: - - $ref: '#/components/parameters/indices.refresh::query.allow_no_indices' - - $ref: '#/components/parameters/indices.refresh::query.expand_wildcards' - - $ref: '#/components/parameters/indices.refresh::query.ignore_unavailable' - - $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' + - $ref: '#/components/parameters/indices.refresh___query.allow_no_indices' + - $ref: '#/components/parameters/indices.refresh___query.expand_wildcards' + - $ref: '#/components/parameters/indices.refresh___query.ignore_unavailable' + - $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/indices.refresh@200' + $ref: '#/components/responses/indices.refresh___200' post: operationId: indices.refresh.1 x-operation-group: indices.refresh x-version-added: '1.0' - description: Performs the refresh operation in one or more indices. + description: Performs the refresh operation in one or more indexes. externalDocs: url: https://opensearch.org/docs/latest/tuning-your-cluster/availability-and-recovery/remote-store/index/#refresh-level-and-request-level-durability parameters: - - $ref: '#/components/parameters/indices.refresh::query.allow_no_indices' - - $ref: '#/components/parameters/indices.refresh::query.expand_wildcards' - - $ref: '#/components/parameters/indices.refresh::query.ignore_unavailable' - - $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' + - $ref: '#/components/parameters/indices.refresh___query.allow_no_indices' + - $ref: '#/components/parameters/indices.refresh___query.expand_wildcards' + - $ref: '#/components/parameters/indices.refresh___query.ignore_unavailable' + - $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/indices.refresh@200' + $ref: '#/components/responses/indices.refresh___200' /_reindex: post: operationId: reindex.0 @@ -7428,24 +7841,24 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/im-plugin/reindex-data/ parameters: - - $ref: '#/components/parameters/reindex::query.max_docs' - - $ref: '#/components/parameters/reindex::query.refresh' - - $ref: '#/components/parameters/reindex::query.requests_per_second' - - $ref: '#/components/parameters/reindex::query.scroll' - - $ref: '#/components/parameters/reindex::query.slices' - - $ref: '#/components/parameters/reindex::query.timeout' - - $ref: '#/components/parameters/reindex::query.wait_for_active_shards' - - $ref: '#/components/parameters/reindex::query.wait_for_completion' - - $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' + - $ref: '#/components/parameters/reindex___query.max_docs' + - $ref: '#/components/parameters/reindex___query.refresh' + - $ref: '#/components/parameters/reindex___query.requests_per_second' + - $ref: '#/components/parameters/reindex___query.scroll' + - $ref: '#/components/parameters/reindex___query.slices' + - $ref: '#/components/parameters/reindex___query.timeout' + - $ref: '#/components/parameters/reindex___query.wait_for_active_shards' + - $ref: '#/components/parameters/reindex___query.wait_for_completion' + - $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/reindex' responses: '200': - $ref: '#/components/responses/reindex@200' + $ref: '#/components/responses/reindex___200' /_reindex/{task_id}/_rethrottle: post: operationId: reindex_rethrottle.0 @@ -7455,16 +7868,16 @@ paths: externalDocs: url: https://opensearch.org/docs/latest parameters: - - $ref: '#/components/parameters/reindex_rethrottle::path.task_id' - - $ref: '#/components/parameters/reindex_rethrottle::query.requests_per_second' - - $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' + - $ref: '#/components/parameters/reindex_rethrottle___path.task_id' + - $ref: '#/components/parameters/reindex_rethrottle___query.requests_per_second' + - $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/reindex_rethrottle@200' + $ref: '#/components/responses/reindex_rethrottle___200' /_remote/info: get: operationId: cluster.remote_info.0 @@ -7474,14 +7887,14 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/remote-info/ 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' + - $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/cluster.remote_info@200' + $ref: '#/components/responses/cluster.remote_info___200' /_remotestore/_restore: post: operationId: remote_store.restore.0 @@ -7491,18 +7904,18 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/opensearch/remote/#restoring-from-a-backup parameters: - - $ref: '#/components/parameters/remote_store.restore::query.cluster_manager_timeout' - - $ref: '#/components/parameters/remote_store.restore::query.wait_for_completion' - - $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' + - $ref: '#/components/parameters/remote_store.restore___query.cluster_manager_timeout' + - $ref: '#/components/parameters/remote_store.restore___query.wait_for_completion' + - $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/remote_store.restore' responses: '200': - $ref: '#/components/responses/remote_store.restore@200' + $ref: '#/components/responses/remote_store.restore___200' /_render/template: get: operationId: render_search_template.0 @@ -7512,16 +7925,16 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/search-plugins/search-template/ 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' + - $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/render_search_template' responses: '200': - $ref: '#/components/responses/render_search_template@200' + $ref: '#/components/responses/render_search_template___200' post: operationId: render_search_template.1 x-operation-group: render_search_template @@ -7530,16 +7943,16 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/search-plugins/search-template/ 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' + - $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/render_search_template' responses: '200': - $ref: '#/components/responses/render_search_template@200' + $ref: '#/components/responses/render_search_template___200' /_render/template/{id}: get: operationId: render_search_template.2 @@ -7549,17 +7962,17 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/search-plugins/search-template/ parameters: - - $ref: '#/components/parameters/render_search_template::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' + - $ref: '#/components/parameters/render_search_template___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' requestBody: $ref: '#/components/requestBodies/render_search_template' responses: '200': - $ref: '#/components/responses/render_search_template@200' + $ref: '#/components/responses/render_search_template___200' post: operationId: render_search_template.3 x-operation-group: render_search_template @@ -7568,36 +7981,36 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/search-plugins/search-template/ parameters: - - $ref: '#/components/parameters/render_search_template::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' + - $ref: '#/components/parameters/render_search_template___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' requestBody: $ref: '#/components/requestBodies/render_search_template' responses: '200': - $ref: '#/components/responses/render_search_template@200' + $ref: '#/components/responses/render_search_template___200' /_resolve/index/{name}: get: operationId: indices.resolve_index.0 x-operation-group: indices.resolve_index x-version-added: '1.0' - description: Returns information about any matching indices, aliases, and data streams. + description: Returns information about any matching indexes, aliases, and data streams. externalDocs: url: https://opensearch.org/docs/latest parameters: - - $ref: '#/components/parameters/indices.resolve_index::path.name' - - $ref: '#/components/parameters/indices.resolve_index::query.expand_wildcards' - - $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' + - $ref: '#/components/parameters/indices.resolve_index___path.name' + - $ref: '#/components/parameters/indices.resolve_index___query.expand_wildcards' + - $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/indices.resolve_index@200' + $ref: '#/components/responses/indices.resolve_index___200' /_script_context: get: operationId: get_script_context.0 @@ -7607,14 +8020,14 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/script-apis/get-script-contexts/ 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' + - $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/get_script_context@200' + $ref: '#/components/responses/get_script_context___200' /_script_language: get: operationId: get_script_languages.0 @@ -7624,14 +8037,14 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/script-apis/get-script-language/ 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' + - $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/get_script_languages@200' + $ref: '#/components/responses/get_script_languages___200' /_scripts/{id}: delete: operationId: delete_script.0 @@ -7641,18 +8054,18 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/script-apis/delete-script/ parameters: - - $ref: '#/components/parameters/delete_script::path.id' - - $ref: '#/components/parameters/delete_script::query.cluster_manager_timeout' - - $ref: '#/components/parameters/delete_script::query.master_timeout' - - $ref: '#/components/parameters/delete_script::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' + - $ref: '#/components/parameters/delete_script___path.id' + - $ref: '#/components/parameters/delete_script___query.cluster_manager_timeout' + - $ref: '#/components/parameters/delete_script___query.master_timeout' + - $ref: '#/components/parameters/delete_script___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/delete_script@200' + $ref: '#/components/responses/delete_script___200' get: operationId: get_script.0 x-operation-group: get_script @@ -7661,17 +8074,17 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/script-apis/get-stored-script/ parameters: - - $ref: '#/components/parameters/get_script::path.id' - - $ref: '#/components/parameters/get_script::query.cluster_manager_timeout' - - $ref: '#/components/parameters/get_script::query.master_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' + - $ref: '#/components/parameters/get_script___path.id' + - $ref: '#/components/parameters/get_script___query.cluster_manager_timeout' + - $ref: '#/components/parameters/get_script___query.master_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/get_script@200' + $ref: '#/components/responses/get_script___200' post: operationId: put_script.0 x-operation-group: put_script @@ -7680,21 +8093,21 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/script-apis/create-stored-script/ parameters: - - $ref: '#/components/parameters/put_script::path.id' - - $ref: '#/components/parameters/put_script::query.cluster_manager_timeout' - - $ref: '#/components/parameters/put_script::query.context' - - $ref: '#/components/parameters/put_script::query.master_timeout' - - $ref: '#/components/parameters/put_script::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' + - $ref: '#/components/parameters/put_script___path.id' + - $ref: '#/components/parameters/put_script___query.cluster_manager_timeout' + - $ref: '#/components/parameters/put_script___query.context' + - $ref: '#/components/parameters/put_script___query.master_timeout' + - $ref: '#/components/parameters/put_script___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' requestBody: $ref: '#/components/requestBodies/put_script' responses: '200': - $ref: '#/components/responses/put_script@200' + $ref: '#/components/responses/put_script___200' put: operationId: put_script.1 x-operation-group: put_script @@ -7703,21 +8116,21 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/script-apis/create-stored-script/ parameters: - - $ref: '#/components/parameters/put_script::path.id' - - $ref: '#/components/parameters/put_script::query.cluster_manager_timeout' - - $ref: '#/components/parameters/put_script::query.context' - - $ref: '#/components/parameters/put_script::query.master_timeout' - - $ref: '#/components/parameters/put_script::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' + - $ref: '#/components/parameters/put_script___path.id' + - $ref: '#/components/parameters/put_script___query.cluster_manager_timeout' + - $ref: '#/components/parameters/put_script___query.context' + - $ref: '#/components/parameters/put_script___query.master_timeout' + - $ref: '#/components/parameters/put_script___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' requestBody: $ref: '#/components/requestBodies/put_script' responses: '200': - $ref: '#/components/responses/put_script@200' + $ref: '#/components/responses/put_script___200' /_scripts/{id}/{context}: post: operationId: put_script.2 @@ -7727,22 +8140,22 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/script-apis/create-stored-script/ parameters: - - $ref: '#/components/parameters/put_script::path.context' - - $ref: '#/components/parameters/put_script::path.id' - - $ref: '#/components/parameters/put_script::query.cluster_manager_timeout' - - $ref: '#/components/parameters/put_script::query.context' - - $ref: '#/components/parameters/put_script::query.master_timeout' - - $ref: '#/components/parameters/put_script::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' + - $ref: '#/components/parameters/put_script___path.context' + - $ref: '#/components/parameters/put_script___path.id' + - $ref: '#/components/parameters/put_script___query.cluster_manager_timeout' + - $ref: '#/components/parameters/put_script___query.context' + - $ref: '#/components/parameters/put_script___query.master_timeout' + - $ref: '#/components/parameters/put_script___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' requestBody: $ref: '#/components/requestBodies/put_script' responses: '200': - $ref: '#/components/responses/put_script@200' + $ref: '#/components/responses/put_script___200' put: operationId: put_script.3 x-operation-group: put_script @@ -7751,22 +8164,22 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/script-apis/create-stored-script/ parameters: - - $ref: '#/components/parameters/put_script::path.context' - - $ref: '#/components/parameters/put_script::path.id' - - $ref: '#/components/parameters/put_script::query.cluster_manager_timeout' - - $ref: '#/components/parameters/put_script::query.context' - - $ref: '#/components/parameters/put_script::query.master_timeout' - - $ref: '#/components/parameters/put_script::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' + - $ref: '#/components/parameters/put_script___path.context' + - $ref: '#/components/parameters/put_script___path.id' + - $ref: '#/components/parameters/put_script___query.cluster_manager_timeout' + - $ref: '#/components/parameters/put_script___query.context' + - $ref: '#/components/parameters/put_script___query.master_timeout' + - $ref: '#/components/parameters/put_script___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' requestBody: $ref: '#/components/requestBodies/put_script' responses: '200': - $ref: '#/components/responses/put_script@200' + $ref: '#/components/responses/put_script___200' /_scripts/painless/_execute: get: operationId: scripts_painless_execute.0 @@ -7776,16 +8189,16 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/script-apis/exec-script/ 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' + - $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/scripts_painless_execute' responses: '200': - $ref: '#/components/responses/scripts_painless_execute@200' + $ref: '#/components/responses/scripts_painless_execute___200' post: operationId: scripts_painless_execute.1 x-operation-group: scripts_painless_execute @@ -7794,16 +8207,16 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/script-apis/exec-script/ 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' + - $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/scripts_painless_execute' responses: '200': - $ref: '#/components/responses/scripts_painless_execute@200' + $ref: '#/components/responses/scripts_painless_execute___200' /_search: get: operationId: search.0 @@ -7813,66 +8226,66 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/search/ parameters: - - $ref: '#/components/parameters/search::query._source' - - $ref: '#/components/parameters/search::query._source_excludes' - - $ref: '#/components/parameters/search::query._source_includes' - - $ref: '#/components/parameters/search::query.allow_no_indices' - - $ref: '#/components/parameters/search::query.allow_partial_search_results' - - $ref: '#/components/parameters/search::query.analyze_wildcard' - - $ref: '#/components/parameters/search::query.analyzer' - - $ref: '#/components/parameters/search::query.batched_reduce_size' - - $ref: '#/components/parameters/search::query.cancel_after_time_interval' - - $ref: '#/components/parameters/search::query.ccs_minimize_roundtrips' - - $ref: '#/components/parameters/search::query.default_operator' - - $ref: '#/components/parameters/search::query.df' - - $ref: '#/components/parameters/search::query.docvalue_fields' - - $ref: '#/components/parameters/search::query.expand_wildcards' - - $ref: '#/components/parameters/search::query.explain' - - $ref: '#/components/parameters/search::query.from' - - $ref: '#/components/parameters/search::query.ignore_throttled' - - $ref: '#/components/parameters/search::query.ignore_unavailable' - - $ref: '#/components/parameters/search::query.include_named_queries_score' - - $ref: '#/components/parameters/search::query.lenient' - - $ref: '#/components/parameters/search::query.max_concurrent_shard_requests' - - $ref: '#/components/parameters/search::query.phase_took' - - $ref: '#/components/parameters/search::query.pre_filter_shard_size' - - $ref: '#/components/parameters/search::query.preference' - - $ref: '#/components/parameters/search::query.q' - - $ref: '#/components/parameters/search::query.request_cache' - - $ref: '#/components/parameters/search::query.rest_total_hits_as_int' - - $ref: '#/components/parameters/search::query.routing' - - $ref: '#/components/parameters/search::query.scroll' - - $ref: '#/components/parameters/search::query.search_pipeline' - - $ref: '#/components/parameters/search::query.search_type' - - $ref: '#/components/parameters/search::query.seq_no_primary_term' - - $ref: '#/components/parameters/search::query.size' - - $ref: '#/components/parameters/search::query.sort' - - $ref: '#/components/parameters/search::query.stats' - - $ref: '#/components/parameters/search::query.stored_fields' - - $ref: '#/components/parameters/search::query.suggest_field' - - $ref: '#/components/parameters/search::query.suggest_mode' - - $ref: '#/components/parameters/search::query.suggest_size' - - $ref: '#/components/parameters/search::query.suggest_text' - - $ref: '#/components/parameters/search::query.terminate_after' - - $ref: '#/components/parameters/search::query.timeout' - - $ref: '#/components/parameters/search::query.track_scores' - - $ref: '#/components/parameters/search::query.track_total_hits' - - $ref: '#/components/parameters/search::query.typed_keys' - - $ref: '#/components/parameters/search::query.version' - - $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' + - $ref: '#/components/parameters/search___query._source' + - $ref: '#/components/parameters/search___query._source_excludes' + - $ref: '#/components/parameters/search___query._source_includes' + - $ref: '#/components/parameters/search___query.allow_no_indices' + - $ref: '#/components/parameters/search___query.allow_partial_search_results' + - $ref: '#/components/parameters/search___query.analyze_wildcard' + - $ref: '#/components/parameters/search___query.analyzer' + - $ref: '#/components/parameters/search___query.batched_reduce_size' + - $ref: '#/components/parameters/search___query.cancel_after_time_interval' + - $ref: '#/components/parameters/search___query.ccs_minimize_roundtrips' + - $ref: '#/components/parameters/search___query.default_operator' + - $ref: '#/components/parameters/search___query.df' + - $ref: '#/components/parameters/search___query.docvalue_fields' + - $ref: '#/components/parameters/search___query.expand_wildcards' + - $ref: '#/components/parameters/search___query.explain' + - $ref: '#/components/parameters/search___query.from' + - $ref: '#/components/parameters/search___query.ignore_throttled' + - $ref: '#/components/parameters/search___query.ignore_unavailable' + - $ref: '#/components/parameters/search___query.include_named_queries_score' + - $ref: '#/components/parameters/search___query.lenient' + - $ref: '#/components/parameters/search___query.max_concurrent_shard_requests' + - $ref: '#/components/parameters/search___query.phase_took' + - $ref: '#/components/parameters/search___query.pre_filter_shard_size' + - $ref: '#/components/parameters/search___query.preference' + - $ref: '#/components/parameters/search___query.q' + - $ref: '#/components/parameters/search___query.request_cache' + - $ref: '#/components/parameters/search___query.rest_total_hits_as_int' + - $ref: '#/components/parameters/search___query.routing' + - $ref: '#/components/parameters/search___query.scroll' + - $ref: '#/components/parameters/search___query.search_pipeline' + - $ref: '#/components/parameters/search___query.search_type' + - $ref: '#/components/parameters/search___query.seq_no_primary_term' + - $ref: '#/components/parameters/search___query.size' + - $ref: '#/components/parameters/search___query.sort' + - $ref: '#/components/parameters/search___query.stats' + - $ref: '#/components/parameters/search___query.stored_fields' + - $ref: '#/components/parameters/search___query.suggest_field' + - $ref: '#/components/parameters/search___query.suggest_mode' + - $ref: '#/components/parameters/search___query.suggest_size' + - $ref: '#/components/parameters/search___query.suggest_text' + - $ref: '#/components/parameters/search___query.terminate_after' + - $ref: '#/components/parameters/search___query.timeout' + - $ref: '#/components/parameters/search___query.track_scores' + - $ref: '#/components/parameters/search___query.track_total_hits' + - $ref: '#/components/parameters/search___query.typed_keys' + - $ref: '#/components/parameters/search___query.version' + - $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/search' responses: '200': - $ref: '#/components/responses/search@200' + $ref: '#/components/responses/search___200' '400': - $ref: '#/components/responses/search@400' + $ref: '#/components/responses/search___400' '404': - $ref: '#/components/responses/search@404' + $ref: '#/components/responses/search___404' post: operationId: search.1 x-operation-group: search @@ -7881,111 +8294,111 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/search/ parameters: - - $ref: '#/components/parameters/search::query._source' - - $ref: '#/components/parameters/search::query._source_excludes' - - $ref: '#/components/parameters/search::query._source_includes' - - $ref: '#/components/parameters/search::query.allow_no_indices' - - $ref: '#/components/parameters/search::query.allow_partial_search_results' - - $ref: '#/components/parameters/search::query.analyze_wildcard' - - $ref: '#/components/parameters/search::query.analyzer' - - $ref: '#/components/parameters/search::query.batched_reduce_size' - - $ref: '#/components/parameters/search::query.cancel_after_time_interval' - - $ref: '#/components/parameters/search::query.ccs_minimize_roundtrips' - - $ref: '#/components/parameters/search::query.default_operator' - - $ref: '#/components/parameters/search::query.df' - - $ref: '#/components/parameters/search::query.docvalue_fields' - - $ref: '#/components/parameters/search::query.expand_wildcards' - - $ref: '#/components/parameters/search::query.explain' - - $ref: '#/components/parameters/search::query.from' - - $ref: '#/components/parameters/search::query.ignore_throttled' - - $ref: '#/components/parameters/search::query.ignore_unavailable' - - $ref: '#/components/parameters/search::query.include_named_queries_score' - - $ref: '#/components/parameters/search::query.lenient' - - $ref: '#/components/parameters/search::query.max_concurrent_shard_requests' - - $ref: '#/components/parameters/search::query.phase_took' - - $ref: '#/components/parameters/search::query.pre_filter_shard_size' - - $ref: '#/components/parameters/search::query.preference' - - $ref: '#/components/parameters/search::query.q' - - $ref: '#/components/parameters/search::query.request_cache' - - $ref: '#/components/parameters/search::query.rest_total_hits_as_int' - - $ref: '#/components/parameters/search::query.routing' - - $ref: '#/components/parameters/search::query.scroll' - - $ref: '#/components/parameters/search::query.search_pipeline' - - $ref: '#/components/parameters/search::query.search_type' - - $ref: '#/components/parameters/search::query.seq_no_primary_term' - - $ref: '#/components/parameters/search::query.size' - - $ref: '#/components/parameters/search::query.sort' - - $ref: '#/components/parameters/search::query.stats' - - $ref: '#/components/parameters/search::query.stored_fields' - - $ref: '#/components/parameters/search::query.suggest_field' - - $ref: '#/components/parameters/search::query.suggest_mode' - - $ref: '#/components/parameters/search::query.suggest_size' - - $ref: '#/components/parameters/search::query.suggest_text' - - $ref: '#/components/parameters/search::query.terminate_after' - - $ref: '#/components/parameters/search::query.timeout' - - $ref: '#/components/parameters/search::query.track_scores' - - $ref: '#/components/parameters/search::query.track_total_hits' - - $ref: '#/components/parameters/search::query.typed_keys' - - $ref: '#/components/parameters/search::query.version' - - $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' + - $ref: '#/components/parameters/search___query._source' + - $ref: '#/components/parameters/search___query._source_excludes' + - $ref: '#/components/parameters/search___query._source_includes' + - $ref: '#/components/parameters/search___query.allow_no_indices' + - $ref: '#/components/parameters/search___query.allow_partial_search_results' + - $ref: '#/components/parameters/search___query.analyze_wildcard' + - $ref: '#/components/parameters/search___query.analyzer' + - $ref: '#/components/parameters/search___query.batched_reduce_size' + - $ref: '#/components/parameters/search___query.cancel_after_time_interval' + - $ref: '#/components/parameters/search___query.ccs_minimize_roundtrips' + - $ref: '#/components/parameters/search___query.default_operator' + - $ref: '#/components/parameters/search___query.df' + - $ref: '#/components/parameters/search___query.docvalue_fields' + - $ref: '#/components/parameters/search___query.expand_wildcards' + - $ref: '#/components/parameters/search___query.explain' + - $ref: '#/components/parameters/search___query.from' + - $ref: '#/components/parameters/search___query.ignore_throttled' + - $ref: '#/components/parameters/search___query.ignore_unavailable' + - $ref: '#/components/parameters/search___query.include_named_queries_score' + - $ref: '#/components/parameters/search___query.lenient' + - $ref: '#/components/parameters/search___query.max_concurrent_shard_requests' + - $ref: '#/components/parameters/search___query.phase_took' + - $ref: '#/components/parameters/search___query.pre_filter_shard_size' + - $ref: '#/components/parameters/search___query.preference' + - $ref: '#/components/parameters/search___query.q' + - $ref: '#/components/parameters/search___query.request_cache' + - $ref: '#/components/parameters/search___query.rest_total_hits_as_int' + - $ref: '#/components/parameters/search___query.routing' + - $ref: '#/components/parameters/search___query.scroll' + - $ref: '#/components/parameters/search___query.search_pipeline' + - $ref: '#/components/parameters/search___query.search_type' + - $ref: '#/components/parameters/search___query.seq_no_primary_term' + - $ref: '#/components/parameters/search___query.size' + - $ref: '#/components/parameters/search___query.sort' + - $ref: '#/components/parameters/search___query.stats' + - $ref: '#/components/parameters/search___query.stored_fields' + - $ref: '#/components/parameters/search___query.suggest_field' + - $ref: '#/components/parameters/search___query.suggest_mode' + - $ref: '#/components/parameters/search___query.suggest_size' + - $ref: '#/components/parameters/search___query.suggest_text' + - $ref: '#/components/parameters/search___query.terminate_after' + - $ref: '#/components/parameters/search___query.timeout' + - $ref: '#/components/parameters/search___query.track_scores' + - $ref: '#/components/parameters/search___query.track_total_hits' + - $ref: '#/components/parameters/search___query.typed_keys' + - $ref: '#/components/parameters/search___query.version' + - $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/search' responses: '200': - $ref: '#/components/responses/search@200' + $ref: '#/components/responses/search___200' '400': - $ref: '#/components/responses/search@400' + $ref: '#/components/responses/search___400' '404': - $ref: '#/components/responses/search@404' + $ref: '#/components/responses/search___404' /_search_shards: get: operationId: search_shards.0 x-operation-group: search_shards x-version-added: '1.0' - description: Returns information about the indices and shards that a search request would be executed against. + description: Returns information about the indexes and shards that a search request would be executed against. externalDocs: url: https://opensearch.org/docs/latest parameters: - - $ref: '#/components/parameters/search_shards::query.allow_no_indices' - - $ref: '#/components/parameters/search_shards::query.expand_wildcards' - - $ref: '#/components/parameters/search_shards::query.ignore_unavailable' - - $ref: '#/components/parameters/search_shards::query.local' - - $ref: '#/components/parameters/search_shards::query.preference' - - $ref: '#/components/parameters/search_shards::query.routing' - - $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' + - $ref: '#/components/parameters/search_shards___query.allow_no_indices' + - $ref: '#/components/parameters/search_shards___query.expand_wildcards' + - $ref: '#/components/parameters/search_shards___query.ignore_unavailable' + - $ref: '#/components/parameters/search_shards___query.local' + - $ref: '#/components/parameters/search_shards___query.preference' + - $ref: '#/components/parameters/search_shards___query.routing' + - $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/search_shards@200' + $ref: '#/components/responses/search_shards___200' post: operationId: search_shards.1 x-operation-group: search_shards x-version-added: '1.0' - description: Returns information about the indices and shards that a search request would be executed against. + description: Returns information about the indexes and shards that a search request would be executed against. externalDocs: url: https://opensearch.org/docs/latest parameters: - - $ref: '#/components/parameters/search_shards::query.allow_no_indices' - - $ref: '#/components/parameters/search_shards::query.expand_wildcards' - - $ref: '#/components/parameters/search_shards::query.ignore_unavailable' - - $ref: '#/components/parameters/search_shards::query.local' - - $ref: '#/components/parameters/search_shards::query.preference' - - $ref: '#/components/parameters/search_shards::query.routing' - - $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' + - $ref: '#/components/parameters/search_shards___query.allow_no_indices' + - $ref: '#/components/parameters/search_shards___query.expand_wildcards' + - $ref: '#/components/parameters/search_shards___query.ignore_unavailable' + - $ref: '#/components/parameters/search_shards___query.local' + - $ref: '#/components/parameters/search_shards___query.preference' + - $ref: '#/components/parameters/search_shards___query.routing' + - $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/search_shards@200' + $ref: '#/components/responses/search_shards___200' /_search/pipeline: get: operationId: search_pipeline.get.0 @@ -7993,15 +8406,15 @@ paths: x-version-added: '2.9' description: Retrieves information about a specified search pipeline. parameters: - - $ref: '#/components/parameters/search_pipeline.get::query.cluster_manager_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' + - $ref: '#/components/parameters/search_pipeline.get___query.cluster_manager_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/search_pipeline.get@200' + $ref: '#/components/responses/search_pipeline.get___200' /_search/pipeline/{id}: delete: operationId: search_pipeline.delete.0 @@ -8009,33 +8422,33 @@ paths: x-version-added: '2.9' description: Deletes the specified search pipeline. parameters: - - $ref: '#/components/parameters/search_pipeline.delete::path.id' - - $ref: '#/components/parameters/search_pipeline.delete::query.cluster_manager_timeout' - - $ref: '#/components/parameters/search_pipeline.delete::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' + - $ref: '#/components/parameters/search_pipeline.delete___path.id' + - $ref: '#/components/parameters/search_pipeline.delete___query.cluster_manager_timeout' + - $ref: '#/components/parameters/search_pipeline.delete___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/search_pipeline.delete@200' + $ref: '#/components/responses/search_pipeline.delete___200' get: operationId: search_pipeline.get.1 x-operation-group: search_pipeline.get x-version-added: '2.9' description: Retrieves information about a specified search pipeline. parameters: - - $ref: '#/components/parameters/search_pipeline.get::path.id' - - $ref: '#/components/parameters/search_pipeline.get::query.cluster_manager_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' + - $ref: '#/components/parameters/search_pipeline.get___path.id' + - $ref: '#/components/parameters/search_pipeline.get___query.cluster_manager_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/search_pipeline.get@200' + $ref: '#/components/responses/search_pipeline.get___200' put: operationId: search_pipeline.put.0 x-operation-group: search_pipeline.put @@ -8044,19 +8457,19 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/search-plugins/search-pipelines/creating-search-pipeline/ parameters: - - $ref: '#/components/parameters/search_pipeline.put::path.id' - - $ref: '#/components/parameters/search_pipeline.put::query.cluster_manager_timeout' - - $ref: '#/components/parameters/search_pipeline.put::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' + - $ref: '#/components/parameters/search_pipeline.put___path.id' + - $ref: '#/components/parameters/search_pipeline.put___query.cluster_manager_timeout' + - $ref: '#/components/parameters/search_pipeline.put___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' requestBody: $ref: '#/components/requestBodies/search_pipeline.put' responses: '200': - $ref: '#/components/responses/search_pipeline.put@200' + $ref: '#/components/responses/search_pipeline.put___200' /_search/point_in_time: delete: operationId: delete_pit.0 @@ -8069,13 +8482,13 @@ paths: $ref: '#/components/requestBodies/delete_pit' responses: '200': - $ref: '#/components/responses/delete_pit@200' + $ref: '#/components/responses/delete_pit___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' + - $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' /_search/point_in_time/_all: delete: operationId: delete_all_pits.0 @@ -8086,13 +8499,13 @@ paths: url: https://opensearch.org/docs/latest/search-plugins/point-in-time-api/#delete-pits responses: '200': - $ref: '#/components/responses/delete_all_pits@200' + $ref: '#/components/responses/delete_all_pits___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' + - $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' get: operationId: get_all_pits.0 x-operation-group: get_all_pits @@ -8102,13 +8515,13 @@ paths: url: https://opensearch.org/docs/latest/search-plugins/point-in-time-api/#list-all-pits responses: '200': - $ref: '#/components/responses/get_all_pits@200' + $ref: '#/components/responses/get_all_pits___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' + - $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' /_search/scroll: delete: operationId: clear_scroll.0 @@ -8118,16 +8531,16 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/scroll/ 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' + - $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/clear_scroll' responses: '200': - $ref: '#/components/responses/clear_scroll@200' + $ref: '#/components/responses/clear_scroll___200' get: operationId: scroll.0 x-operation-group: scroll @@ -8136,19 +8549,19 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/scroll/#path-and-http-methods parameters: - - $ref: '#/components/parameters/scroll::query.rest_total_hits_as_int' - - $ref: '#/components/parameters/scroll::query.scroll' - - $ref: '#/components/parameters/scroll::query.scroll_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' + - $ref: '#/components/parameters/scroll___query.rest_total_hits_as_int' + - $ref: '#/components/parameters/scroll___query.scroll' + - $ref: '#/components/parameters/scroll___query.scroll_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/scroll' responses: '200': - $ref: '#/components/responses/scroll@200' + $ref: '#/components/responses/scroll___200' post: operationId: scroll.1 x-operation-group: scroll @@ -8157,19 +8570,19 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/scroll/#path-and-http-methods parameters: - - $ref: '#/components/parameters/scroll::query.rest_total_hits_as_int' - - $ref: '#/components/parameters/scroll::query.scroll' - - $ref: '#/components/parameters/scroll::query.scroll_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' + - $ref: '#/components/parameters/scroll___query.rest_total_hits_as_int' + - $ref: '#/components/parameters/scroll___query.scroll' + - $ref: '#/components/parameters/scroll___query.scroll_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/scroll' responses: '200': - $ref: '#/components/responses/scroll@200' + $ref: '#/components/responses/scroll___200' /_search/scroll/{scroll_id}: delete: operationId: clear_scroll.1 @@ -8182,17 +8595,17 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/scroll/ parameters: - - $ref: '#/components/parameters/clear_scroll::path.scroll_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' + - $ref: '#/components/parameters/clear_scroll___path.scroll_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/clear_scroll' responses: '200': - $ref: '#/components/responses/clear_scroll@200' + $ref: '#/components/responses/clear_scroll___200' get: operationId: scroll.2 x-operation-group: scroll @@ -8204,20 +8617,20 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/scroll/#path-and-http-methods parameters: - - $ref: '#/components/parameters/scroll::path.scroll_id' - - $ref: '#/components/parameters/scroll::query.rest_total_hits_as_int' - - $ref: '#/components/parameters/scroll::query.scroll' - - $ref: '#/components/parameters/scroll::query.scroll_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' + - $ref: '#/components/parameters/scroll___path.scroll_id' + - $ref: '#/components/parameters/scroll___query.rest_total_hits_as_int' + - $ref: '#/components/parameters/scroll___query.scroll' + - $ref: '#/components/parameters/scroll___query.scroll_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/scroll' responses: '200': - $ref: '#/components/responses/scroll@200' + $ref: '#/components/responses/scroll___200' post: operationId: scroll.3 x-operation-group: scroll @@ -8229,20 +8642,20 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/scroll/#path-and-http-methods parameters: - - $ref: '#/components/parameters/scroll::path.scroll_id' - - $ref: '#/components/parameters/scroll::query.rest_total_hits_as_int' - - $ref: '#/components/parameters/scroll::query.scroll' - - $ref: '#/components/parameters/scroll::query.scroll_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' + - $ref: '#/components/parameters/scroll___path.scroll_id' + - $ref: '#/components/parameters/scroll___query.rest_total_hits_as_int' + - $ref: '#/components/parameters/scroll___query.scroll' + - $ref: '#/components/parameters/scroll___query.scroll_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/scroll' responses: '200': - $ref: '#/components/responses/scroll@200' + $ref: '#/components/responses/scroll___200' /_search/template: get: operationId: search_template.0 @@ -8252,29 +8665,29 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/search-plugins/search-template/ parameters: - - $ref: '#/components/parameters/search_template::query.allow_no_indices' - - $ref: '#/components/parameters/search_template::query.ccs_minimize_roundtrips' - - $ref: '#/components/parameters/search_template::query.expand_wildcards' - - $ref: '#/components/parameters/search_template::query.explain' - - $ref: '#/components/parameters/search_template::query.ignore_throttled' - - $ref: '#/components/parameters/search_template::query.ignore_unavailable' - - $ref: '#/components/parameters/search_template::query.preference' - - $ref: '#/components/parameters/search_template::query.profile' - - $ref: '#/components/parameters/search_template::query.rest_total_hits_as_int' - - $ref: '#/components/parameters/search_template::query.routing' - - $ref: '#/components/parameters/search_template::query.scroll' - - $ref: '#/components/parameters/search_template::query.search_type' - - $ref: '#/components/parameters/search_template::query.typed_keys' - - $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' + - $ref: '#/components/parameters/search_template___query.allow_no_indices' + - $ref: '#/components/parameters/search_template___query.ccs_minimize_roundtrips' + - $ref: '#/components/parameters/search_template___query.expand_wildcards' + - $ref: '#/components/parameters/search_template___query.explain' + - $ref: '#/components/parameters/search_template___query.ignore_throttled' + - $ref: '#/components/parameters/search_template___query.ignore_unavailable' + - $ref: '#/components/parameters/search_template___query.preference' + - $ref: '#/components/parameters/search_template___query.profile' + - $ref: '#/components/parameters/search_template___query.rest_total_hits_as_int' + - $ref: '#/components/parameters/search_template___query.routing' + - $ref: '#/components/parameters/search_template___query.scroll' + - $ref: '#/components/parameters/search_template___query.search_type' + - $ref: '#/components/parameters/search_template___query.typed_keys' + - $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/search_template' responses: '200': - $ref: '#/components/responses/search_template@200' + $ref: '#/components/responses/search_template___200' post: operationId: search_template.1 x-operation-group: search_template @@ -8283,29 +8696,29 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/search-plugins/search-template/ parameters: - - $ref: '#/components/parameters/search_template::query.allow_no_indices' - - $ref: '#/components/parameters/search_template::query.ccs_minimize_roundtrips' - - $ref: '#/components/parameters/search_template::query.expand_wildcards' - - $ref: '#/components/parameters/search_template::query.explain' - - $ref: '#/components/parameters/search_template::query.ignore_throttled' - - $ref: '#/components/parameters/search_template::query.ignore_unavailable' - - $ref: '#/components/parameters/search_template::query.preference' - - $ref: '#/components/parameters/search_template::query.profile' - - $ref: '#/components/parameters/search_template::query.rest_total_hits_as_int' - - $ref: '#/components/parameters/search_template::query.routing' - - $ref: '#/components/parameters/search_template::query.scroll' - - $ref: '#/components/parameters/search_template::query.search_type' - - $ref: '#/components/parameters/search_template::query.typed_keys' - - $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' + - $ref: '#/components/parameters/search_template___query.allow_no_indices' + - $ref: '#/components/parameters/search_template___query.ccs_minimize_roundtrips' + - $ref: '#/components/parameters/search_template___query.expand_wildcards' + - $ref: '#/components/parameters/search_template___query.explain' + - $ref: '#/components/parameters/search_template___query.ignore_throttled' + - $ref: '#/components/parameters/search_template___query.ignore_unavailable' + - $ref: '#/components/parameters/search_template___query.preference' + - $ref: '#/components/parameters/search_template___query.profile' + - $ref: '#/components/parameters/search_template___query.rest_total_hits_as_int' + - $ref: '#/components/parameters/search_template___query.routing' + - $ref: '#/components/parameters/search_template___query.scroll' + - $ref: '#/components/parameters/search_template___query.search_type' + - $ref: '#/components/parameters/search_template___query.typed_keys' + - $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/search_template' responses: '200': - $ref: '#/components/responses/search_template@200' + $ref: '#/components/responses/search_template___200' /_segments: get: operationId: indices.segments.0 @@ -8318,18 +8731,18 @@ paths: externalDocs: url: https://opensearch.org/docs/latest parameters: - - $ref: '#/components/parameters/indices.segments::query.allow_no_indices' - - $ref: '#/components/parameters/indices.segments::query.expand_wildcards' - - $ref: '#/components/parameters/indices.segments::query.ignore_unavailable' - - $ref: '#/components/parameters/indices.segments::query.verbose' - - $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' + - $ref: '#/components/parameters/indices.segments___query.allow_no_indices' + - $ref: '#/components/parameters/indices.segments___query.expand_wildcards' + - $ref: '#/components/parameters/indices.segments___query.ignore_unavailable' + - $ref: '#/components/parameters/indices.segments___query.verbose' + - $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/indices.segments@200' + $ref: '#/components/responses/indices.segments___200' /_settings: get: operationId: indices.get_settings.0 @@ -8338,26 +8751,26 @@ paths: x-distributions-excluded: - amazon-managed - amazon-serverless - description: Returns settings for one or more indices. + description: Returns settings for one or more indexes. externalDocs: url: https://opensearch.org/docs/latest/api-reference/index-apis/get-settings/ parameters: - - $ref: '#/components/parameters/indices.get_settings::query.allow_no_indices' - - $ref: '#/components/parameters/indices.get_settings::query.cluster_manager_timeout' - - $ref: '#/components/parameters/indices.get_settings::query.expand_wildcards' - - $ref: '#/components/parameters/indices.get_settings::query.flat_settings' - - $ref: '#/components/parameters/indices.get_settings::query.ignore_unavailable' - - $ref: '#/components/parameters/indices.get_settings::query.include_defaults' - - $ref: '#/components/parameters/indices.get_settings::query.local' - - $ref: '#/components/parameters/indices.get_settings::query.master_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/indices.get_settings@200' + - $ref: '#/components/parameters/indices.get_settings___query.allow_no_indices' + - $ref: '#/components/parameters/indices.get_settings___query.cluster_manager_timeout' + - $ref: '#/components/parameters/indices.get_settings___query.expand_wildcards' + - $ref: '#/components/parameters/indices.get_settings___query.flat_settings' + - $ref: '#/components/parameters/indices.get_settings___query.ignore_unavailable' + - $ref: '#/components/parameters/indices.get_settings___query.include_defaults' + - $ref: '#/components/parameters/indices.get_settings___query.local' + - $ref: '#/components/parameters/indices.get_settings___query.master_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/indices.get_settings___200' put: operationId: indices.put_settings.0 x-operation-group: indices.put_settings @@ -8366,71 +8779,71 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/index-apis/update-settings/ parameters: - - $ref: '#/components/parameters/indices.put_settings::query.allow_no_indices' - - $ref: '#/components/parameters/indices.put_settings::query.cluster_manager_timeout' - - $ref: '#/components/parameters/indices.put_settings::query.expand_wildcards' - - $ref: '#/components/parameters/indices.put_settings::query.flat_settings' - - $ref: '#/components/parameters/indices.put_settings::query.ignore_unavailable' - - $ref: '#/components/parameters/indices.put_settings::query.master_timeout' - - $ref: '#/components/parameters/indices.put_settings::query.preserve_existing' - - $ref: '#/components/parameters/indices.put_settings::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' + - $ref: '#/components/parameters/indices.put_settings___query.allow_no_indices' + - $ref: '#/components/parameters/indices.put_settings___query.cluster_manager_timeout' + - $ref: '#/components/parameters/indices.put_settings___query.expand_wildcards' + - $ref: '#/components/parameters/indices.put_settings___query.flat_settings' + - $ref: '#/components/parameters/indices.put_settings___query.ignore_unavailable' + - $ref: '#/components/parameters/indices.put_settings___query.master_timeout' + - $ref: '#/components/parameters/indices.put_settings___query.preserve_existing' + - $ref: '#/components/parameters/indices.put_settings___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' requestBody: $ref: '#/components/requestBodies/indices.put_settings' responses: '200': - $ref: '#/components/responses/indices.put_settings@200' + $ref: '#/components/responses/indices.put_settings___200' /_settings/{name}: get: operationId: indices.get_settings.1 x-operation-group: indices.get_settings x-version-added: '1.0' - description: Returns settings for one or more indices. + description: Returns settings for one or more indexes. externalDocs: url: https://opensearch.org/docs/latest/api-reference/index-apis/get-settings/ parameters: - - $ref: '#/components/parameters/indices.get_settings::path.name' - - $ref: '#/components/parameters/indices.get_settings::query.allow_no_indices' - - $ref: '#/components/parameters/indices.get_settings::query.cluster_manager_timeout' - - $ref: '#/components/parameters/indices.get_settings::query.expand_wildcards' - - $ref: '#/components/parameters/indices.get_settings::query.flat_settings' - - $ref: '#/components/parameters/indices.get_settings::query.ignore_unavailable' - - $ref: '#/components/parameters/indices.get_settings::query.include_defaults' - - $ref: '#/components/parameters/indices.get_settings::query.local' - - $ref: '#/components/parameters/indices.get_settings::query.master_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/indices.get_settings@200' + - $ref: '#/components/parameters/indices.get_settings___path.name' + - $ref: '#/components/parameters/indices.get_settings___query.allow_no_indices' + - $ref: '#/components/parameters/indices.get_settings___query.cluster_manager_timeout' + - $ref: '#/components/parameters/indices.get_settings___query.expand_wildcards' + - $ref: '#/components/parameters/indices.get_settings___query.flat_settings' + - $ref: '#/components/parameters/indices.get_settings___query.ignore_unavailable' + - $ref: '#/components/parameters/indices.get_settings___query.include_defaults' + - $ref: '#/components/parameters/indices.get_settings___query.local' + - $ref: '#/components/parameters/indices.get_settings___query.master_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/indices.get_settings___200' /_shard_stores: get: operationId: indices.shard_stores.0 x-operation-group: indices.shard_stores x-version-added: '1.0' - description: Provides store information for shard copies of indices. + description: Provides store information for shard copies of indexes. externalDocs: url: https://opensearch.org/docs/latest parameters: - - $ref: '#/components/parameters/indices.shard_stores::query.allow_no_indices' - - $ref: '#/components/parameters/indices.shard_stores::query.expand_wildcards' - - $ref: '#/components/parameters/indices.shard_stores::query.ignore_unavailable' - - $ref: '#/components/parameters/indices.shard_stores::query.status' - - $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' + - $ref: '#/components/parameters/indices.shard_stores___query.allow_no_indices' + - $ref: '#/components/parameters/indices.shard_stores___query.expand_wildcards' + - $ref: '#/components/parameters/indices.shard_stores___query.ignore_unavailable' + - $ref: '#/components/parameters/indices.shard_stores___query.status' + - $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/indices.shard_stores@200' + $ref: '#/components/responses/indices.shard_stores___200' /_snapshot: get: operationId: snapshot.get_repository.0 @@ -8440,17 +8853,17 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/snapshots/get-snapshot-repository/ parameters: - - $ref: '#/components/parameters/snapshot.get_repository::query.cluster_manager_timeout' - - $ref: '#/components/parameters/snapshot.get_repository::query.local' - - $ref: '#/components/parameters/snapshot.get_repository::query.master_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' + - $ref: '#/components/parameters/snapshot.get_repository___query.cluster_manager_timeout' + - $ref: '#/components/parameters/snapshot.get_repository___query.local' + - $ref: '#/components/parameters/snapshot.get_repository___query.master_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/snapshot.get_repository@200' + $ref: '#/components/responses/snapshot.get_repository___200' /_snapshot/_status: get: operationId: snapshot.status.0 @@ -8460,17 +8873,17 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/snapshots/get-snapshot-status/ parameters: - - $ref: '#/components/parameters/snapshot.status::query.cluster_manager_timeout' - - $ref: '#/components/parameters/snapshot.status::query.ignore_unavailable' - - $ref: '#/components/parameters/snapshot.status::query.master_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' + - $ref: '#/components/parameters/snapshot.status___query.cluster_manager_timeout' + - $ref: '#/components/parameters/snapshot.status___query.ignore_unavailable' + - $ref: '#/components/parameters/snapshot.status___query.master_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/snapshot.status@200' + $ref: '#/components/responses/snapshot.status___200' /_snapshot/{repository}: delete: operationId: snapshot.delete_repository.0 @@ -8480,18 +8893,18 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/snapshots/delete-snapshot-repository/ parameters: - - $ref: '#/components/parameters/snapshot.delete_repository::path.repository' - - $ref: '#/components/parameters/snapshot.delete_repository::query.cluster_manager_timeout' - - $ref: '#/components/parameters/snapshot.delete_repository::query.master_timeout' - - $ref: '#/components/parameters/snapshot.delete_repository::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' + - $ref: '#/components/parameters/snapshot.delete_repository___path.repository' + - $ref: '#/components/parameters/snapshot.delete_repository___query.cluster_manager_timeout' + - $ref: '#/components/parameters/snapshot.delete_repository___query.master_timeout' + - $ref: '#/components/parameters/snapshot.delete_repository___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/snapshot.delete_repository@200' + $ref: '#/components/responses/snapshot.delete_repository___200' get: operationId: snapshot.get_repository.1 x-operation-group: snapshot.get_repository @@ -8500,18 +8913,18 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/snapshots/get-snapshot-repository/ parameters: - - $ref: '#/components/parameters/snapshot.get_repository::path.repository' - - $ref: '#/components/parameters/snapshot.get_repository::query.cluster_manager_timeout' - - $ref: '#/components/parameters/snapshot.get_repository::query.local' - - $ref: '#/components/parameters/snapshot.get_repository::query.master_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' + - $ref: '#/components/parameters/snapshot.get_repository___path.repository' + - $ref: '#/components/parameters/snapshot.get_repository___query.cluster_manager_timeout' + - $ref: '#/components/parameters/snapshot.get_repository___query.local' + - $ref: '#/components/parameters/snapshot.get_repository___query.master_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/snapshot.get_repository@200' + $ref: '#/components/responses/snapshot.get_repository___200' post: operationId: snapshot.create_repository.0 x-operation-group: snapshot.create_repository @@ -8520,21 +8933,21 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/snapshots/create-repository/ parameters: - - $ref: '#/components/parameters/snapshot.create_repository::path.repository' - - $ref: '#/components/parameters/snapshot.create_repository::query.cluster_manager_timeout' - - $ref: '#/components/parameters/snapshot.create_repository::query.master_timeout' - - $ref: '#/components/parameters/snapshot.create_repository::query.timeout' - - $ref: '#/components/parameters/snapshot.create_repository::query.verify' - - $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' + - $ref: '#/components/parameters/snapshot.create_repository___path.repository' + - $ref: '#/components/parameters/snapshot.create_repository___query.cluster_manager_timeout' + - $ref: '#/components/parameters/snapshot.create_repository___query.master_timeout' + - $ref: '#/components/parameters/snapshot.create_repository___query.timeout' + - $ref: '#/components/parameters/snapshot.create_repository___query.verify' + - $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/snapshot.create_repository' responses: '200': - $ref: '#/components/responses/snapshot.create_repository@200' + $ref: '#/components/responses/snapshot.create_repository___200' put: operationId: snapshot.create_repository.1 x-operation-group: snapshot.create_repository @@ -8543,21 +8956,21 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/snapshots/create-repository/ parameters: - - $ref: '#/components/parameters/snapshot.create_repository::path.repository' - - $ref: '#/components/parameters/snapshot.create_repository::query.cluster_manager_timeout' - - $ref: '#/components/parameters/snapshot.create_repository::query.master_timeout' - - $ref: '#/components/parameters/snapshot.create_repository::query.timeout' - - $ref: '#/components/parameters/snapshot.create_repository::query.verify' - - $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' + - $ref: '#/components/parameters/snapshot.create_repository___path.repository' + - $ref: '#/components/parameters/snapshot.create_repository___query.cluster_manager_timeout' + - $ref: '#/components/parameters/snapshot.create_repository___query.master_timeout' + - $ref: '#/components/parameters/snapshot.create_repository___query.timeout' + - $ref: '#/components/parameters/snapshot.create_repository___query.verify' + - $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/snapshot.create_repository' responses: '200': - $ref: '#/components/responses/snapshot.create_repository@200' + $ref: '#/components/responses/snapshot.create_repository___200' /_snapshot/{repository}/_cleanup: post: operationId: snapshot.cleanup_repository.0 @@ -8567,18 +8980,18 @@ paths: externalDocs: url: https://opensearch.org/docs/latest parameters: - - $ref: '#/components/parameters/snapshot.cleanup_repository::path.repository' - - $ref: '#/components/parameters/snapshot.cleanup_repository::query.cluster_manager_timeout' - - $ref: '#/components/parameters/snapshot.cleanup_repository::query.master_timeout' - - $ref: '#/components/parameters/snapshot.cleanup_repository::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' + - $ref: '#/components/parameters/snapshot.cleanup_repository___path.repository' + - $ref: '#/components/parameters/snapshot.cleanup_repository___query.cluster_manager_timeout' + - $ref: '#/components/parameters/snapshot.cleanup_repository___query.master_timeout' + - $ref: '#/components/parameters/snapshot.cleanup_repository___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/snapshot.cleanup_repository@200' + $ref: '#/components/responses/snapshot.cleanup_repository___200' /_snapshot/{repository}/_status: get: operationId: snapshot.status.1 @@ -8588,18 +9001,18 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/snapshots/get-snapshot-status/ parameters: - - $ref: '#/components/parameters/snapshot.status::path.repository' - - $ref: '#/components/parameters/snapshot.status::query.cluster_manager_timeout' - - $ref: '#/components/parameters/snapshot.status::query.ignore_unavailable' - - $ref: '#/components/parameters/snapshot.status::query.master_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' + - $ref: '#/components/parameters/snapshot.status___path.repository' + - $ref: '#/components/parameters/snapshot.status___query.cluster_manager_timeout' + - $ref: '#/components/parameters/snapshot.status___query.ignore_unavailable' + - $ref: '#/components/parameters/snapshot.status___query.master_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/snapshot.status@200' + $ref: '#/components/responses/snapshot.status___200' /_snapshot/{repository}/_verify: post: operationId: snapshot.verify_repository.0 @@ -8609,18 +9022,18 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/snapshots/verify-snapshot-repository/ parameters: - - $ref: '#/components/parameters/snapshot.verify_repository::path.repository' - - $ref: '#/components/parameters/snapshot.verify_repository::query.cluster_manager_timeout' - - $ref: '#/components/parameters/snapshot.verify_repository::query.master_timeout' - - $ref: '#/components/parameters/snapshot.verify_repository::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' + - $ref: '#/components/parameters/snapshot.verify_repository___path.repository' + - $ref: '#/components/parameters/snapshot.verify_repository___query.cluster_manager_timeout' + - $ref: '#/components/parameters/snapshot.verify_repository___query.master_timeout' + - $ref: '#/components/parameters/snapshot.verify_repository___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/snapshot.verify_repository@200' + $ref: '#/components/responses/snapshot.verify_repository___200' /_snapshot/{repository}/{snapshot}: delete: operationId: snapshot.delete.0 @@ -8630,18 +9043,18 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/snapshots/delete-snapshot/ parameters: - - $ref: '#/components/parameters/snapshot.delete::path.repository' - - $ref: '#/components/parameters/snapshot.delete::path.snapshot' - - $ref: '#/components/parameters/snapshot.delete::query.cluster_manager_timeout' - - $ref: '#/components/parameters/snapshot.delete::query.master_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' + - $ref: '#/components/parameters/snapshot.delete___path.repository' + - $ref: '#/components/parameters/snapshot.delete___path.snapshot' + - $ref: '#/components/parameters/snapshot.delete___query.cluster_manager_timeout' + - $ref: '#/components/parameters/snapshot.delete___query.master_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/snapshot.delete@200' + $ref: '#/components/responses/snapshot.delete___200' get: operationId: snapshot.get.0 x-operation-group: snapshot.get @@ -8650,20 +9063,20 @@ paths: externalDocs: url: https://opensearch.org/docs/latest parameters: - - $ref: '#/components/parameters/snapshot.get::path.repository' - - $ref: '#/components/parameters/snapshot.get::path.snapshot' - - $ref: '#/components/parameters/snapshot.get::query.cluster_manager_timeout' - - $ref: '#/components/parameters/snapshot.get::query.ignore_unavailable' - - $ref: '#/components/parameters/snapshot.get::query.master_timeout' - - $ref: '#/components/parameters/snapshot.get::query.verbose' - - $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' + - $ref: '#/components/parameters/snapshot.get___path.repository' + - $ref: '#/components/parameters/snapshot.get___path.snapshot' + - $ref: '#/components/parameters/snapshot.get___query.cluster_manager_timeout' + - $ref: '#/components/parameters/snapshot.get___query.ignore_unavailable' + - $ref: '#/components/parameters/snapshot.get___query.master_timeout' + - $ref: '#/components/parameters/snapshot.get___query.verbose' + - $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/snapshot.get@200' + $ref: '#/components/responses/snapshot.get___200' post: operationId: snapshot.create.0 x-operation-group: snapshot.create @@ -8672,21 +9085,21 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/snapshots/create-snapshot/ parameters: - - $ref: '#/components/parameters/snapshot.create::path.repository' - - $ref: '#/components/parameters/snapshot.create::path.snapshot' - - $ref: '#/components/parameters/snapshot.create::query.cluster_manager_timeout' - - $ref: '#/components/parameters/snapshot.create::query.master_timeout' - - $ref: '#/components/parameters/snapshot.create::query.wait_for_completion' - - $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' + - $ref: '#/components/parameters/snapshot.create___path.repository' + - $ref: '#/components/parameters/snapshot.create___path.snapshot' + - $ref: '#/components/parameters/snapshot.create___query.cluster_manager_timeout' + - $ref: '#/components/parameters/snapshot.create___query.master_timeout' + - $ref: '#/components/parameters/snapshot.create___query.wait_for_completion' + - $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/snapshot.create' responses: '200': - $ref: '#/components/responses/snapshot.create@200' + $ref: '#/components/responses/snapshot.create___200' put: operationId: snapshot.create.1 x-operation-group: snapshot.create @@ -8695,45 +9108,45 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/snapshots/create-snapshot/ parameters: - - $ref: '#/components/parameters/snapshot.create::path.repository' - - $ref: '#/components/parameters/snapshot.create::path.snapshot' - - $ref: '#/components/parameters/snapshot.create::query.cluster_manager_timeout' - - $ref: '#/components/parameters/snapshot.create::query.master_timeout' - - $ref: '#/components/parameters/snapshot.create::query.wait_for_completion' - - $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' + - $ref: '#/components/parameters/snapshot.create___path.repository' + - $ref: '#/components/parameters/snapshot.create___path.snapshot' + - $ref: '#/components/parameters/snapshot.create___query.cluster_manager_timeout' + - $ref: '#/components/parameters/snapshot.create___query.master_timeout' + - $ref: '#/components/parameters/snapshot.create___query.wait_for_completion' + - $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/snapshot.create' responses: '200': - $ref: '#/components/responses/snapshot.create@200' + $ref: '#/components/responses/snapshot.create___200' /_snapshot/{repository}/{snapshot}/_clone/{target_snapshot}: put: operationId: snapshot.clone.0 x-operation-group: snapshot.clone x-version-added: '1.0' - description: Clones indices from one snapshot into another snapshot in the same repository. + description: Clones indexes from one snapshot into another snapshot in the same repository. externalDocs: url: https://opensearch.org/docs/latest parameters: - - $ref: '#/components/parameters/snapshot.clone::path.repository' - - $ref: '#/components/parameters/snapshot.clone::path.snapshot' - - $ref: '#/components/parameters/snapshot.clone::path.target_snapshot' - - $ref: '#/components/parameters/snapshot.clone::query.cluster_manager_timeout' - - $ref: '#/components/parameters/snapshot.clone::query.master_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' + - $ref: '#/components/parameters/snapshot.clone___path.repository' + - $ref: '#/components/parameters/snapshot.clone___path.snapshot' + - $ref: '#/components/parameters/snapshot.clone___path.target_snapshot' + - $ref: '#/components/parameters/snapshot.clone___query.cluster_manager_timeout' + - $ref: '#/components/parameters/snapshot.clone___query.master_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/snapshot.clone' responses: '200': - $ref: '#/components/responses/snapshot.clone@200' + $ref: '#/components/responses/snapshot.clone___200' /_snapshot/{repository}/{snapshot}/_restore: post: operationId: snapshot.restore.0 @@ -8743,21 +9156,21 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/snapshots/restore-snapshot/ parameters: - - $ref: '#/components/parameters/snapshot.restore::path.repository' - - $ref: '#/components/parameters/snapshot.restore::path.snapshot' - - $ref: '#/components/parameters/snapshot.restore::query.cluster_manager_timeout' - - $ref: '#/components/parameters/snapshot.restore::query.master_timeout' - - $ref: '#/components/parameters/snapshot.restore::query.wait_for_completion' - - $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' + - $ref: '#/components/parameters/snapshot.restore___path.repository' + - $ref: '#/components/parameters/snapshot.restore___path.snapshot' + - $ref: '#/components/parameters/snapshot.restore___query.cluster_manager_timeout' + - $ref: '#/components/parameters/snapshot.restore___query.master_timeout' + - $ref: '#/components/parameters/snapshot.restore___query.wait_for_completion' + - $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/snapshot.restore' responses: '200': - $ref: '#/components/responses/snapshot.restore@200' + $ref: '#/components/responses/snapshot.restore___200' /_snapshot/{repository}/{snapshot}/_status: get: operationId: snapshot.status.2 @@ -8767,19 +9180,19 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/snapshots/get-snapshot-status/ parameters: - - $ref: '#/components/parameters/snapshot.status::path.repository' - - $ref: '#/components/parameters/snapshot.status::path.snapshot' - - $ref: '#/components/parameters/snapshot.status::query.cluster_manager_timeout' - - $ref: '#/components/parameters/snapshot.status::query.ignore_unavailable' - - $ref: '#/components/parameters/snapshot.status::query.master_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' + - $ref: '#/components/parameters/snapshot.status___path.repository' + - $ref: '#/components/parameters/snapshot.status___path.snapshot' + - $ref: '#/components/parameters/snapshot.status___query.cluster_manager_timeout' + - $ref: '#/components/parameters/snapshot.status___query.ignore_unavailable' + - $ref: '#/components/parameters/snapshot.status___query.master_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/snapshot.status@200' + $ref: '#/components/responses/snapshot.status___200' /_stats: get: operationId: indices.stats.0 @@ -8789,23 +9202,23 @@ paths: externalDocs: url: https://opensearch.org/docs/latest parameters: - - $ref: '#/components/parameters/indices.stats::query.completion_fields' - - $ref: '#/components/parameters/indices.stats::query.expand_wildcards' - - $ref: '#/components/parameters/indices.stats::query.fielddata_fields' - - $ref: '#/components/parameters/indices.stats::query.fields' - - $ref: '#/components/parameters/indices.stats::query.forbid_closed_indices' - - $ref: '#/components/parameters/indices.stats::query.groups' - - $ref: '#/components/parameters/indices.stats::query.include_segment_file_sizes' - - $ref: '#/components/parameters/indices.stats::query.include_unloaded_segments' - - $ref: '#/components/parameters/indices.stats::query.level' - - $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/indices.stats@200' + - $ref: '#/components/parameters/indices.stats___query.completion_fields' + - $ref: '#/components/parameters/indices.stats___query.expand_wildcards' + - $ref: '#/components/parameters/indices.stats___query.fielddata_fields' + - $ref: '#/components/parameters/indices.stats___query.fields' + - $ref: '#/components/parameters/indices.stats___query.forbid_closed_indices' + - $ref: '#/components/parameters/indices.stats___query.groups' + - $ref: '#/components/parameters/indices.stats___query.include_segment_file_sizes' + - $ref: '#/components/parameters/indices.stats___query.include_unloaded_segments' + - $ref: '#/components/parameters/indices.stats___query.level' + - $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/indices.stats___200' /_stats/{metric}: get: operationId: indices.stats.1 @@ -8815,24 +9228,24 @@ paths: externalDocs: url: https://opensearch.org/docs/latest parameters: - - $ref: '#/components/parameters/indices.stats::path.metric' - - $ref: '#/components/parameters/indices.stats::query.completion_fields' - - $ref: '#/components/parameters/indices.stats::query.expand_wildcards' - - $ref: '#/components/parameters/indices.stats::query.fielddata_fields' - - $ref: '#/components/parameters/indices.stats::query.fields' - - $ref: '#/components/parameters/indices.stats::query.forbid_closed_indices' - - $ref: '#/components/parameters/indices.stats::query.groups' - - $ref: '#/components/parameters/indices.stats::query.include_segment_file_sizes' - - $ref: '#/components/parameters/indices.stats::query.include_unloaded_segments' - - $ref: '#/components/parameters/indices.stats::query.level' - - $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/indices.stats@200' + - $ref: '#/components/parameters/indices.stats___path.metric' + - $ref: '#/components/parameters/indices.stats___query.completion_fields' + - $ref: '#/components/parameters/indices.stats___query.expand_wildcards' + - $ref: '#/components/parameters/indices.stats___query.fielddata_fields' + - $ref: '#/components/parameters/indices.stats___query.fields' + - $ref: '#/components/parameters/indices.stats___query.forbid_closed_indices' + - $ref: '#/components/parameters/indices.stats___query.groups' + - $ref: '#/components/parameters/indices.stats___query.include_segment_file_sizes' + - $ref: '#/components/parameters/indices.stats___query.include_unloaded_segments' + - $ref: '#/components/parameters/indices.stats___query.level' + - $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/indices.stats___200' /_tasks: get: operationId: tasks.list.0 @@ -8842,21 +9255,21 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/tasks/ parameters: - - $ref: '#/components/parameters/tasks.list::query.actions' - - $ref: '#/components/parameters/tasks.list::query.detailed' - - $ref: '#/components/parameters/tasks.list::query.group_by' - - $ref: '#/components/parameters/tasks.list::query.nodes' - - $ref: '#/components/parameters/tasks.list::query.parent_task_id' - - $ref: '#/components/parameters/tasks.list::query.timeout' - - $ref: '#/components/parameters/tasks.list::query.wait_for_completion' - - $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/tasks.list@200' + - $ref: '#/components/parameters/tasks.list___query.actions' + - $ref: '#/components/parameters/tasks.list___query.detailed' + - $ref: '#/components/parameters/tasks.list___query.group_by' + - $ref: '#/components/parameters/tasks.list___query.nodes' + - $ref: '#/components/parameters/tasks.list___query.parent_task_id' + - $ref: '#/components/parameters/tasks.list___query.timeout' + - $ref: '#/components/parameters/tasks.list___query.wait_for_completion' + - $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/tasks.list___200' /_tasks/_cancel: post: operationId: tasks.cancel.0 @@ -8866,18 +9279,18 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/tasks/#task-canceling parameters: - - $ref: '#/components/parameters/tasks.cancel::query.actions' - - $ref: '#/components/parameters/tasks.cancel::query.nodes' - - $ref: '#/components/parameters/tasks.cancel::query.parent_task_id' - - $ref: '#/components/parameters/tasks.cancel::query.wait_for_completion' - - $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' + - $ref: '#/components/parameters/tasks.cancel___query.actions' + - $ref: '#/components/parameters/tasks.cancel___query.nodes' + - $ref: '#/components/parameters/tasks.cancel___query.parent_task_id' + - $ref: '#/components/parameters/tasks.cancel___query.wait_for_completion' + - $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/tasks.cancel@200' + $ref: '#/components/responses/tasks.cancel___200' /_tasks/{task_id}: get: operationId: tasks.get.0 @@ -8887,17 +9300,17 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/tasks/ parameters: - - $ref: '#/components/parameters/tasks.get::path.task_id' - - $ref: '#/components/parameters/tasks.get::query.timeout' - - $ref: '#/components/parameters/tasks.get::query.wait_for_completion' - - $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' + - $ref: '#/components/parameters/tasks.get___path.task_id' + - $ref: '#/components/parameters/tasks.get___query.timeout' + - $ref: '#/components/parameters/tasks.get___query.wait_for_completion' + - $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/tasks.get@200' + $ref: '#/components/responses/tasks.get___200' /_tasks/{task_id}/_cancel: post: operationId: tasks.cancel.1 @@ -8907,19 +9320,19 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/tasks/#task-canceling parameters: - - $ref: '#/components/parameters/tasks.cancel::path.task_id' - - $ref: '#/components/parameters/tasks.cancel::query.actions' - - $ref: '#/components/parameters/tasks.cancel::query.nodes' - - $ref: '#/components/parameters/tasks.cancel::query.parent_task_id' - - $ref: '#/components/parameters/tasks.cancel::query.wait_for_completion' - - $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' + - $ref: '#/components/parameters/tasks.cancel___path.task_id' + - $ref: '#/components/parameters/tasks.cancel___query.actions' + - $ref: '#/components/parameters/tasks.cancel___query.nodes' + - $ref: '#/components/parameters/tasks.cancel___query.parent_task_id' + - $ref: '#/components/parameters/tasks.cancel___query.wait_for_completion' + - $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/tasks.cancel@200' + $ref: '#/components/responses/tasks.cancel___200' /_template: get: operationId: indices.get_template.0 @@ -8929,18 +9342,18 @@ paths: externalDocs: url: https://opensearch.org/docs/latest parameters: - - $ref: '#/components/parameters/indices.get_template::query.cluster_manager_timeout' - - $ref: '#/components/parameters/indices.get_template::query.flat_settings' - - $ref: '#/components/parameters/indices.get_template::query.local' - - $ref: '#/components/parameters/indices.get_template::query.master_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' + - $ref: '#/components/parameters/indices.get_template___query.cluster_manager_timeout' + - $ref: '#/components/parameters/indices.get_template___query.flat_settings' + - $ref: '#/components/parameters/indices.get_template___query.local' + - $ref: '#/components/parameters/indices.get_template___query.master_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/indices.get_template@200' + $ref: '#/components/responses/indices.get_template___200' /_template/{name}: delete: operationId: indices.delete_template.0 @@ -8950,18 +9363,18 @@ paths: externalDocs: url: https://opensearch.org/docs/latest parameters: - - $ref: '#/components/parameters/indices.delete_template::path.name' - - $ref: '#/components/parameters/indices.delete_template::query.cluster_manager_timeout' - - $ref: '#/components/parameters/indices.delete_template::query.master_timeout' - - $ref: '#/components/parameters/indices.delete_template::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' + - $ref: '#/components/parameters/indices.delete_template___path.name' + - $ref: '#/components/parameters/indices.delete_template___query.cluster_manager_timeout' + - $ref: '#/components/parameters/indices.delete_template___query.master_timeout' + - $ref: '#/components/parameters/indices.delete_template___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/indices.delete_template@200' + $ref: '#/components/responses/indices.delete_template___200' get: operationId: indices.get_template.1 x-operation-group: indices.get_template @@ -8970,19 +9383,19 @@ paths: externalDocs: url: https://opensearch.org/docs/latest parameters: - - $ref: '#/components/parameters/indices.get_template::path.name' - - $ref: '#/components/parameters/indices.get_template::query.cluster_manager_timeout' - - $ref: '#/components/parameters/indices.get_template::query.flat_settings' - - $ref: '#/components/parameters/indices.get_template::query.local' - - $ref: '#/components/parameters/indices.get_template::query.master_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' + - $ref: '#/components/parameters/indices.get_template___path.name' + - $ref: '#/components/parameters/indices.get_template___query.cluster_manager_timeout' + - $ref: '#/components/parameters/indices.get_template___query.flat_settings' + - $ref: '#/components/parameters/indices.get_template___query.local' + - $ref: '#/components/parameters/indices.get_template___query.master_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/indices.get_template@200' + $ref: '#/components/responses/indices.get_template___200' head: operationId: indices.exists_template.0 x-operation-group: indices.exists_template @@ -8991,19 +9404,19 @@ paths: externalDocs: url: https://opensearch.org/docs/latest parameters: - - $ref: '#/components/parameters/indices.exists_template::path.name' - - $ref: '#/components/parameters/indices.exists_template::query.cluster_manager_timeout' - - $ref: '#/components/parameters/indices.exists_template::query.flat_settings' - - $ref: '#/components/parameters/indices.exists_template::query.local' - - $ref: '#/components/parameters/indices.exists_template::query.master_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' + - $ref: '#/components/parameters/indices.exists_template___path.name' + - $ref: '#/components/parameters/indices.exists_template___query.cluster_manager_timeout' + - $ref: '#/components/parameters/indices.exists_template___query.flat_settings' + - $ref: '#/components/parameters/indices.exists_template___query.local' + - $ref: '#/components/parameters/indices.exists_template___query.master_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/indices.exists_template@200' + $ref: '#/components/responses/indices.exists_template___200' post: operationId: indices.put_template.0 x-operation-group: indices.put_template @@ -9012,21 +9425,21 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/im-plugin/index-templates/ parameters: - - $ref: '#/components/parameters/indices.put_template::path.name' - - $ref: '#/components/parameters/indices.put_template::query.cluster_manager_timeout' - - $ref: '#/components/parameters/indices.put_template::query.create' - - $ref: '#/components/parameters/indices.put_template::query.master_timeout' - - $ref: '#/components/parameters/indices.put_template::query.order' - - $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' + - $ref: '#/components/parameters/indices.put_template___path.name' + - $ref: '#/components/parameters/indices.put_template___query.cluster_manager_timeout' + - $ref: '#/components/parameters/indices.put_template___query.create' + - $ref: '#/components/parameters/indices.put_template___query.master_timeout' + - $ref: '#/components/parameters/indices.put_template___query.order' + - $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/indices.put_template' responses: '200': - $ref: '#/components/responses/indices.put_template@200' + $ref: '#/components/responses/indices.put_template___200' put: operationId: indices.put_template.1 x-operation-group: indices.put_template @@ -9035,21 +9448,21 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/im-plugin/index-templates/ parameters: - - $ref: '#/components/parameters/indices.put_template::path.name' - - $ref: '#/components/parameters/indices.put_template::query.cluster_manager_timeout' - - $ref: '#/components/parameters/indices.put_template::query.create' - - $ref: '#/components/parameters/indices.put_template::query.master_timeout' - - $ref: '#/components/parameters/indices.put_template::query.order' - - $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' + - $ref: '#/components/parameters/indices.put_template___path.name' + - $ref: '#/components/parameters/indices.put_template___query.cluster_manager_timeout' + - $ref: '#/components/parameters/indices.put_template___query.create' + - $ref: '#/components/parameters/indices.put_template___query.master_timeout' + - $ref: '#/components/parameters/indices.put_template___query.order' + - $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/indices.put_template' responses: '200': - $ref: '#/components/responses/indices.put_template@200' + $ref: '#/components/responses/indices.put_template___200' /_update_by_query/{task_id}/_rethrottle: post: operationId: update_by_query_rethrottle.0 @@ -9059,57 +9472,57 @@ paths: externalDocs: url: https://opensearch.org/docs/latest parameters: - - $ref: '#/components/parameters/update_by_query_rethrottle::path.task_id' - - $ref: '#/components/parameters/update_by_query_rethrottle::query.requests_per_second' - - $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' + - $ref: '#/components/parameters/update_by_query_rethrottle___path.task_id' + - $ref: '#/components/parameters/update_by_query_rethrottle___query.requests_per_second' + - $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/update_by_query_rethrottle@200' + $ref: '#/components/responses/update_by_query_rethrottle___200' /_upgrade: get: operationId: indices.get_upgrade.0 x-operation-group: indices.get_upgrade x-version-added: '1.0' - description: The _upgrade API is no longer useful and will be removed. + description: The `_upgrade` API is no longer useful and will be removed. externalDocs: url: https://opensearch.org/docs/latest parameters: - - $ref: '#/components/parameters/indices.get_upgrade::query.allow_no_indices' - - $ref: '#/components/parameters/indices.get_upgrade::query.expand_wildcards' - - $ref: '#/components/parameters/indices.get_upgrade::query.ignore_unavailable' - - $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' + - $ref: '#/components/parameters/indices.get_upgrade___query.allow_no_indices' + - $ref: '#/components/parameters/indices.get_upgrade___query.expand_wildcards' + - $ref: '#/components/parameters/indices.get_upgrade___query.ignore_unavailable' + - $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/indices.get_upgrade@200' + $ref: '#/components/responses/indices.get_upgrade___200' post: operationId: indices.upgrade.0 x-operation-group: indices.upgrade x-version-added: '1.0' - description: The _upgrade API is no longer useful and will be removed. + description: The `_upgrade` API is no longer useful and will be removed. externalDocs: url: https://opensearch.org/docs/latest parameters: - - $ref: '#/components/parameters/indices.upgrade::query.allow_no_indices' - - $ref: '#/components/parameters/indices.upgrade::query.expand_wildcards' - - $ref: '#/components/parameters/indices.upgrade::query.ignore_unavailable' - - $ref: '#/components/parameters/indices.upgrade::query.only_ancient_segments' - - $ref: '#/components/parameters/indices.upgrade::query.wait_for_completion' - - $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' + - $ref: '#/components/parameters/indices.upgrade___query.allow_no_indices' + - $ref: '#/components/parameters/indices.upgrade___query.expand_wildcards' + - $ref: '#/components/parameters/indices.upgrade___query.ignore_unavailable' + - $ref: '#/components/parameters/indices.upgrade___query.only_ancient_segments' + - $ref: '#/components/parameters/indices.upgrade___query.wait_for_completion' + - $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/indices.upgrade@200' + $ref: '#/components/responses/indices.upgrade___200' /_validate/query: get: operationId: indices.validate_query.0 @@ -9119,28 +9532,28 @@ paths: externalDocs: url: https://opensearch.org/docs/latest parameters: - - $ref: '#/components/parameters/indices.validate_query::query.all_shards' - - $ref: '#/components/parameters/indices.validate_query::query.allow_no_indices' - - $ref: '#/components/parameters/indices.validate_query::query.analyze_wildcard' - - $ref: '#/components/parameters/indices.validate_query::query.analyzer' - - $ref: '#/components/parameters/indices.validate_query::query.default_operator' - - $ref: '#/components/parameters/indices.validate_query::query.df' - - $ref: '#/components/parameters/indices.validate_query::query.expand_wildcards' - - $ref: '#/components/parameters/indices.validate_query::query.explain' - - $ref: '#/components/parameters/indices.validate_query::query.ignore_unavailable' - - $ref: '#/components/parameters/indices.validate_query::query.lenient' - - $ref: '#/components/parameters/indices.validate_query::query.q' - - $ref: '#/components/parameters/indices.validate_query::query.rewrite' - - $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' + - $ref: '#/components/parameters/indices.validate_query___query.all_shards' + - $ref: '#/components/parameters/indices.validate_query___query.allow_no_indices' + - $ref: '#/components/parameters/indices.validate_query___query.analyze_wildcard' + - $ref: '#/components/parameters/indices.validate_query___query.analyzer' + - $ref: '#/components/parameters/indices.validate_query___query.default_operator' + - $ref: '#/components/parameters/indices.validate_query___query.df' + - $ref: '#/components/parameters/indices.validate_query___query.expand_wildcards' + - $ref: '#/components/parameters/indices.validate_query___query.explain' + - $ref: '#/components/parameters/indices.validate_query___query.ignore_unavailable' + - $ref: '#/components/parameters/indices.validate_query___query.lenient' + - $ref: '#/components/parameters/indices.validate_query___query.q' + - $ref: '#/components/parameters/indices.validate_query___query.rewrite' + - $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/indices.validate_query' responses: '200': - $ref: '#/components/responses/indices.validate_query@200' + $ref: '#/components/responses/indices.validate_query___200' post: operationId: indices.validate_query.1 x-operation-group: indices.validate_query @@ -9149,28 +9562,107 @@ paths: externalDocs: url: https://opensearch.org/docs/latest parameters: - - $ref: '#/components/parameters/indices.validate_query::query.all_shards' - - $ref: '#/components/parameters/indices.validate_query::query.allow_no_indices' - - $ref: '#/components/parameters/indices.validate_query::query.analyze_wildcard' - - $ref: '#/components/parameters/indices.validate_query::query.analyzer' - - $ref: '#/components/parameters/indices.validate_query::query.default_operator' - - $ref: '#/components/parameters/indices.validate_query::query.df' - - $ref: '#/components/parameters/indices.validate_query::query.expand_wildcards' - - $ref: '#/components/parameters/indices.validate_query::query.explain' - - $ref: '#/components/parameters/indices.validate_query::query.ignore_unavailable' - - $ref: '#/components/parameters/indices.validate_query::query.lenient' - - $ref: '#/components/parameters/indices.validate_query::query.q' - - $ref: '#/components/parameters/indices.validate_query::query.rewrite' - - $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' + - $ref: '#/components/parameters/indices.validate_query___query.all_shards' + - $ref: '#/components/parameters/indices.validate_query___query.allow_no_indices' + - $ref: '#/components/parameters/indices.validate_query___query.analyze_wildcard' + - $ref: '#/components/parameters/indices.validate_query___query.analyzer' + - $ref: '#/components/parameters/indices.validate_query___query.default_operator' + - $ref: '#/components/parameters/indices.validate_query___query.df' + - $ref: '#/components/parameters/indices.validate_query___query.expand_wildcards' + - $ref: '#/components/parameters/indices.validate_query___query.explain' + - $ref: '#/components/parameters/indices.validate_query___query.ignore_unavailable' + - $ref: '#/components/parameters/indices.validate_query___query.lenient' + - $ref: '#/components/parameters/indices.validate_query___query.q' + - $ref: '#/components/parameters/indices.validate_query___query.rewrite' + - $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/indices.validate_query' responses: '200': - $ref: '#/components/responses/indices.validate_query@200' + $ref: '#/components/responses/indices.validate_query___200' + /_wlm/query_group: + get: + operationId: wlm.get_query_group.0 + x-operation-group: wlm.get_query_group + x-version-added: '2.17' + description: Retrieves the specified query group. If no query group is specified, all query groups in the cluster are retrieved. + responses: + '200': + $ref: '#/components/responses/wlm.get_query_group___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' + put: + operationId: wlm.create_query_group.0 + x-operation-group: wlm.create_query_group + x-version-added: '2.17' + description: Creates a new query group and sets the resource limits for the new query group. + requestBody: + $ref: '#/components/requestBodies/wlm.create_query_group' + responses: + '200': + $ref: '#/components/responses/wlm.create_query_group___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' + /_wlm/query_group/{name}: + delete: + operationId: wlm.delete_query_group.0 + x-operation-group: wlm.delete_query_group + x-version-added: '2.17' + description: Deletes the specified query group. + parameters: + - $ref: '#/components/parameters/wlm.delete_query_group___path.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/wlm.delete_query_group___200' + get: + operationId: wlm.get_query_group.1 + x-operation-group: wlm.get_query_group + x-version-added: '2.17' + description: Retrieves the specified query group. If no query group is specified, all query groups in the cluster are retrieved. + parameters: + - $ref: '#/components/parameters/wlm.get_query_group___path.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/wlm.get_query_group___200' + put: + operationId: wlm.update_query_group.0 + x-operation-group: wlm.update_query_group + x-version-added: '2.17' + description: Updates the specified query group. + parameters: + - $ref: '#/components/parameters/wlm.update_query_group___path.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' + requestBody: + $ref: '#/components/requestBodies/wlm.update_query_group' + responses: + '200': + $ref: '#/components/responses/wlm.update_query_group___200' /{alias}/_rollover: post: operationId: indices.rollover.0 @@ -9182,22 +9674,22 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/dashboards/im-dashboards/rollover/ parameters: - - $ref: '#/components/parameters/indices.rollover::path.alias' - - $ref: '#/components/parameters/indices.rollover::query.cluster_manager_timeout' - - $ref: '#/components/parameters/indices.rollover::query.dry_run' - - $ref: '#/components/parameters/indices.rollover::query.master_timeout' - - $ref: '#/components/parameters/indices.rollover::query.timeout' - - $ref: '#/components/parameters/indices.rollover::query.wait_for_active_shards' - - $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' + - $ref: '#/components/parameters/indices.rollover___path.alias' + - $ref: '#/components/parameters/indices.rollover___query.cluster_manager_timeout' + - $ref: '#/components/parameters/indices.rollover___query.dry_run' + - $ref: '#/components/parameters/indices.rollover___query.master_timeout' + - $ref: '#/components/parameters/indices.rollover___query.timeout' + - $ref: '#/components/parameters/indices.rollover___query.wait_for_active_shards' + - $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/indices.rollover' responses: '200': - $ref: '#/components/responses/indices.rollover@200' + $ref: '#/components/responses/indices.rollover___200' /{alias}/_rollover/{new_index}: post: operationId: indices.rollover.1 @@ -9209,23 +9701,23 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/dashboards/im-dashboards/rollover/ parameters: - - $ref: '#/components/parameters/indices.rollover::path.alias' - - $ref: '#/components/parameters/indices.rollover::path.new_index' - - $ref: '#/components/parameters/indices.rollover::query.cluster_manager_timeout' - - $ref: '#/components/parameters/indices.rollover::query.dry_run' - - $ref: '#/components/parameters/indices.rollover::query.master_timeout' - - $ref: '#/components/parameters/indices.rollover::query.timeout' - - $ref: '#/components/parameters/indices.rollover::query.wait_for_active_shards' - - $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' + - $ref: '#/components/parameters/indices.rollover___path.alias' + - $ref: '#/components/parameters/indices.rollover___path.new_index' + - $ref: '#/components/parameters/indices.rollover___query.cluster_manager_timeout' + - $ref: '#/components/parameters/indices.rollover___query.dry_run' + - $ref: '#/components/parameters/indices.rollover___query.master_timeout' + - $ref: '#/components/parameters/indices.rollover___query.timeout' + - $ref: '#/components/parameters/indices.rollover___query.wait_for_active_shards' + - $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/indices.rollover' responses: '200': - $ref: '#/components/responses/indices.rollover@200' + $ref: '#/components/responses/indices.rollover___200' /{index}: delete: operationId: indices.delete.0 @@ -9235,48 +9727,48 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/index-apis/delete-index/ parameters: - - $ref: '#/components/parameters/indices.delete::path.index' - - $ref: '#/components/parameters/indices.delete::query.allow_no_indices' - - $ref: '#/components/parameters/indices.delete::query.cluster_manager_timeout' - - $ref: '#/components/parameters/indices.delete::query.expand_wildcards' - - $ref: '#/components/parameters/indices.delete::query.ignore_unavailable' - - $ref: '#/components/parameters/indices.delete::query.master_timeout' - - $ref: '#/components/parameters/indices.delete::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/indices.delete@200' + - $ref: '#/components/parameters/indices.delete___path.index' + - $ref: '#/components/parameters/indices.delete___query.allow_no_indices' + - $ref: '#/components/parameters/indices.delete___query.cluster_manager_timeout' + - $ref: '#/components/parameters/indices.delete___query.expand_wildcards' + - $ref: '#/components/parameters/indices.delete___query.ignore_unavailable' + - $ref: '#/components/parameters/indices.delete___query.master_timeout' + - $ref: '#/components/parameters/indices.delete___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/indices.delete___200' '404': - $ref: '#/components/responses/indices.delete@404' + $ref: '#/components/responses/indices.delete___404' get: operationId: indices.get.0 x-operation-group: indices.get x-version-added: '1.0' - description: Returns information about one or more indices. + description: Returns information about one or more indexes. externalDocs: url: https://opensearch.org/docs/latest/api-reference/index-apis/get-index/ parameters: - - $ref: '#/components/parameters/indices.get::path.index' - - $ref: '#/components/parameters/indices.get::query.allow_no_indices' - - $ref: '#/components/parameters/indices.get::query.cluster_manager_timeout' - - $ref: '#/components/parameters/indices.get::query.expand_wildcards' - - $ref: '#/components/parameters/indices.get::query.flat_settings' - - $ref: '#/components/parameters/indices.get::query.ignore_unavailable' - - $ref: '#/components/parameters/indices.get::query.include_defaults' - - $ref: '#/components/parameters/indices.get::query.local' - - $ref: '#/components/parameters/indices.get::query.master_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/indices.get@200' + - $ref: '#/components/parameters/indices.get___path.index' + - $ref: '#/components/parameters/indices.get___query.allow_no_indices' + - $ref: '#/components/parameters/indices.get___query.cluster_manager_timeout' + - $ref: '#/components/parameters/indices.get___query.expand_wildcards' + - $ref: '#/components/parameters/indices.get___query.flat_settings' + - $ref: '#/components/parameters/indices.get___query.ignore_unavailable' + - $ref: '#/components/parameters/indices.get___query.include_defaults' + - $ref: '#/components/parameters/indices.get___query.local' + - $ref: '#/components/parameters/indices.get___query.master_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/indices.get___200' head: operationId: indices.exists.0 x-operation-group: indices.exists @@ -9285,24 +9777,24 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/index-apis/exists/ parameters: - - $ref: '#/components/parameters/indices.exists::path.index' - - $ref: '#/components/parameters/indices.exists::query.allow_no_indices' - - $ref: '#/components/parameters/indices.exists::query.cluster_manager_timeout' - - $ref: '#/components/parameters/indices.exists::query.expand_wildcards' - - $ref: '#/components/parameters/indices.exists::query.flat_settings' - - $ref: '#/components/parameters/indices.exists::query.ignore_unavailable' - - $ref: '#/components/parameters/indices.exists::query.include_defaults' - - $ref: '#/components/parameters/indices.exists::query.local' - - $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/indices.exists@200' + - $ref: '#/components/parameters/indices.exists___path.index' + - $ref: '#/components/parameters/indices.exists___query.allow_no_indices' + - $ref: '#/components/parameters/indices.exists___query.cluster_manager_timeout' + - $ref: '#/components/parameters/indices.exists___query.expand_wildcards' + - $ref: '#/components/parameters/indices.exists___query.flat_settings' + - $ref: '#/components/parameters/indices.exists___query.ignore_unavailable' + - $ref: '#/components/parameters/indices.exists___query.include_defaults' + - $ref: '#/components/parameters/indices.exists___query.local' + - $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/indices.exists___200' '404': - $ref: '#/components/responses/indices.exists@404' + $ref: '#/components/responses/indices.exists___404' put: operationId: indices.create.0 x-operation-group: indices.create @@ -9311,21 +9803,21 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/index-apis/create-index/ parameters: - - $ref: '#/components/parameters/indices.create::path.index' - - $ref: '#/components/parameters/indices.create::query.cluster_manager_timeout' - - $ref: '#/components/parameters/indices.create::query.master_timeout' - - $ref: '#/components/parameters/indices.create::query.timeout' - - $ref: '#/components/parameters/indices.create::query.wait_for_active_shards' - - $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' + - $ref: '#/components/parameters/indices.create___path.index' + - $ref: '#/components/parameters/indices.create___query.cluster_manager_timeout' + - $ref: '#/components/parameters/indices.create___query.master_timeout' + - $ref: '#/components/parameters/indices.create___query.timeout' + - $ref: '#/components/parameters/indices.create___query.wait_for_active_shards' + - $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/indices.create' responses: '200': - $ref: '#/components/responses/indices.create@200' + $ref: '#/components/responses/indices.create___200' /{index}/_alias: get: operationId: indices.get_alias.2 @@ -9335,21 +9827,21 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/im-plugin/index-alias/ parameters: - - $ref: '#/components/parameters/indices.get_alias::path.index' - - $ref: '#/components/parameters/indices.get_alias::query.allow_no_indices' - - $ref: '#/components/parameters/indices.get_alias::query.expand_wildcards' - - $ref: '#/components/parameters/indices.get_alias::query.ignore_unavailable' - - $ref: '#/components/parameters/indices.get_alias::query.local' - - $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' + - $ref: '#/components/parameters/indices.get_alias___path.index' + - $ref: '#/components/parameters/indices.get_alias___query.allow_no_indices' + - $ref: '#/components/parameters/indices.get_alias___query.expand_wildcards' + - $ref: '#/components/parameters/indices.get_alias___query.ignore_unavailable' + - $ref: '#/components/parameters/indices.get_alias___query.local' + - $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/indices.get_alias@200' + $ref: '#/components/responses/indices.get_alias___200' '404': - $ref: '#/components/responses/indices.get_alias@404' + $ref: '#/components/responses/indices.get_alias___404' put: operationId: indices.put_alias.5 x-operation-group: indices.put_alias @@ -9358,20 +9850,20 @@ paths: externalDocs: 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' - - $ref: '#/components/parameters/indices.put_alias::query.master_timeout' - - $ref: '#/components/parameters/indices.put_alias::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' + - $ref: '#/components/parameters/indices.put_alias___path.index' + - $ref: '#/components/parameters/indices.put_alias___query.cluster_manager_timeout' + - $ref: '#/components/parameters/indices.put_alias___query.master_timeout' + - $ref: '#/components/parameters/indices.put_alias___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' requestBody: $ref: '#/components/requestBodies/indices.put_alias' responses: '200': - $ref: '#/components/responses/indices.put_alias@200' + $ref: '#/components/responses/indices.put_alias___200' /{index}/_alias/{name}: delete: operationId: indices.delete_alias.0 @@ -9381,19 +9873,19 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/im-plugin/index-alias/#delete-aliases parameters: - - $ref: '#/components/parameters/indices.delete_alias::path.index' - - $ref: '#/components/parameters/indices.delete_alias::path.name' - - $ref: '#/components/parameters/indices.delete_alias::query.cluster_manager_timeout' - - $ref: '#/components/parameters/indices.delete_alias::query.master_timeout' - - $ref: '#/components/parameters/indices.delete_alias::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' + - $ref: '#/components/parameters/indices.delete_alias___path.index' + - $ref: '#/components/parameters/indices.delete_alias___path.name' + - $ref: '#/components/parameters/indices.delete_alias___query.cluster_manager_timeout' + - $ref: '#/components/parameters/indices.delete_alias___query.master_timeout' + - $ref: '#/components/parameters/indices.delete_alias___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/indices.delete_alias@200' + $ref: '#/components/responses/indices.delete_alias___200' get: operationId: indices.get_alias.3 x-operation-group: indices.get_alias @@ -9402,22 +9894,22 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/im-plugin/index-alias/ parameters: - - $ref: '#/components/parameters/indices.get_alias::path.index' - - $ref: '#/components/parameters/indices.get_alias::path.name' - - $ref: '#/components/parameters/indices.get_alias::query.allow_no_indices' - - $ref: '#/components/parameters/indices.get_alias::query.expand_wildcards' - - $ref: '#/components/parameters/indices.get_alias::query.ignore_unavailable' - - $ref: '#/components/parameters/indices.get_alias::query.local' - - $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' + - $ref: '#/components/parameters/indices.get_alias___path.index' + - $ref: '#/components/parameters/indices.get_alias___path.name' + - $ref: '#/components/parameters/indices.get_alias___query.allow_no_indices' + - $ref: '#/components/parameters/indices.get_alias___query.expand_wildcards' + - $ref: '#/components/parameters/indices.get_alias___query.ignore_unavailable' + - $ref: '#/components/parameters/indices.get_alias___query.local' + - $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/indices.get_alias@200' + $ref: '#/components/responses/indices.get_alias___200' '404': - $ref: '#/components/responses/indices.get_alias@404' + $ref: '#/components/responses/indices.get_alias___404' head: operationId: indices.exists_alias.1 x-operation-group: indices.exists_alias @@ -9426,22 +9918,22 @@ paths: externalDocs: url: https://opensearch.org/docs/latest parameters: - - $ref: '#/components/parameters/indices.exists_alias::path.index' - - $ref: '#/components/parameters/indices.exists_alias::path.name' - - $ref: '#/components/parameters/indices.exists_alias::query.allow_no_indices' - - $ref: '#/components/parameters/indices.exists_alias::query.expand_wildcards' - - $ref: '#/components/parameters/indices.exists_alias::query.ignore_unavailable' - - $ref: '#/components/parameters/indices.exists_alias::query.local' - - $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' + - $ref: '#/components/parameters/indices.exists_alias___path.index' + - $ref: '#/components/parameters/indices.exists_alias___path.name' + - $ref: '#/components/parameters/indices.exists_alias___query.allow_no_indices' + - $ref: '#/components/parameters/indices.exists_alias___query.expand_wildcards' + - $ref: '#/components/parameters/indices.exists_alias___query.ignore_unavailable' + - $ref: '#/components/parameters/indices.exists_alias___query.local' + - $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/indices.exists_alias@200' + $ref: '#/components/responses/indices.exists_alias___200' '404': - $ref: '#/components/responses/indices.exists_alias@404' + $ref: '#/components/responses/indices.exists_alias___404' post: operationId: indices.put_alias.6 x-operation-group: indices.put_alias @@ -9450,21 +9942,21 @@ paths: externalDocs: 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' - - $ref: '#/components/parameters/indices.put_alias::query.cluster_manager_timeout' - - $ref: '#/components/parameters/indices.put_alias::query.master_timeout' - - $ref: '#/components/parameters/indices.put_alias::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' + - $ref: '#/components/parameters/indices.put_alias___path.index' + - $ref: '#/components/parameters/indices.put_alias___path.name' + - $ref: '#/components/parameters/indices.put_alias___query.cluster_manager_timeout' + - $ref: '#/components/parameters/indices.put_alias___query.master_timeout' + - $ref: '#/components/parameters/indices.put_alias___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' requestBody: $ref: '#/components/requestBodies/indices.put_alias' responses: '200': - $ref: '#/components/responses/indices.put_alias@200' + $ref: '#/components/responses/indices.put_alias___200' put: operationId: indices.put_alias.7 x-operation-group: indices.put_alias @@ -9473,21 +9965,21 @@ paths: externalDocs: 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' - - $ref: '#/components/parameters/indices.put_alias::query.cluster_manager_timeout' - - $ref: '#/components/parameters/indices.put_alias::query.master_timeout' - - $ref: '#/components/parameters/indices.put_alias::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' + - $ref: '#/components/parameters/indices.put_alias___path.index' + - $ref: '#/components/parameters/indices.put_alias___path.name' + - $ref: '#/components/parameters/indices.put_alias___query.cluster_manager_timeout' + - $ref: '#/components/parameters/indices.put_alias___query.master_timeout' + - $ref: '#/components/parameters/indices.put_alias___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' requestBody: $ref: '#/components/requestBodies/indices.put_alias' responses: '200': - $ref: '#/components/responses/indices.put_alias@200' + $ref: '#/components/responses/indices.put_alias___200' /{index}/_aliases: put: operationId: indices.put_alias.8 @@ -9497,20 +9989,20 @@ paths: externalDocs: 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' - - $ref: '#/components/parameters/indices.put_alias::query.master_timeout' - - $ref: '#/components/parameters/indices.put_alias::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' + - $ref: '#/components/parameters/indices.put_alias___path.index' + - $ref: '#/components/parameters/indices.put_alias___query.cluster_manager_timeout' + - $ref: '#/components/parameters/indices.put_alias___query.master_timeout' + - $ref: '#/components/parameters/indices.put_alias___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' requestBody: $ref: '#/components/requestBodies/indices.put_alias' responses: '200': - $ref: '#/components/responses/indices.put_alias@200' + $ref: '#/components/responses/indices.put_alias___200' /{index}/_aliases/{name}: delete: operationId: indices.delete_alias.1 @@ -9520,19 +10012,19 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/im-plugin/index-alias/#delete-aliases parameters: - - $ref: '#/components/parameters/indices.delete_alias::path.index' - - $ref: '#/components/parameters/indices.delete_alias::path.name' - - $ref: '#/components/parameters/indices.delete_alias::query.cluster_manager_timeout' - - $ref: '#/components/parameters/indices.delete_alias::query.master_timeout' - - $ref: '#/components/parameters/indices.delete_alias::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' + - $ref: '#/components/parameters/indices.delete_alias___path.index' + - $ref: '#/components/parameters/indices.delete_alias___path.name' + - $ref: '#/components/parameters/indices.delete_alias___query.cluster_manager_timeout' + - $ref: '#/components/parameters/indices.delete_alias___query.master_timeout' + - $ref: '#/components/parameters/indices.delete_alias___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/indices.delete_alias@200' + $ref: '#/components/responses/indices.delete_alias___200' post: operationId: indices.put_alias.9 x-operation-group: indices.put_alias @@ -9541,21 +10033,21 @@ paths: externalDocs: 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' - - $ref: '#/components/parameters/indices.put_alias::query.cluster_manager_timeout' - - $ref: '#/components/parameters/indices.put_alias::query.master_timeout' - - $ref: '#/components/parameters/indices.put_alias::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' + - $ref: '#/components/parameters/indices.put_alias___path.index' + - $ref: '#/components/parameters/indices.put_alias___path.name' + - $ref: '#/components/parameters/indices.put_alias___query.cluster_manager_timeout' + - $ref: '#/components/parameters/indices.put_alias___query.master_timeout' + - $ref: '#/components/parameters/indices.put_alias___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' requestBody: $ref: '#/components/requestBodies/indices.put_alias' responses: '200': - $ref: '#/components/responses/indices.put_alias@200' + $ref: '#/components/responses/indices.put_alias___200' put: operationId: indices.put_alias.10 x-operation-group: indices.put_alias @@ -9564,21 +10056,21 @@ paths: externalDocs: 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' - - $ref: '#/components/parameters/indices.put_alias::query.cluster_manager_timeout' - - $ref: '#/components/parameters/indices.put_alias::query.master_timeout' - - $ref: '#/components/parameters/indices.put_alias::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' + - $ref: '#/components/parameters/indices.put_alias___path.index' + - $ref: '#/components/parameters/indices.put_alias___path.name' + - $ref: '#/components/parameters/indices.put_alias___query.cluster_manager_timeout' + - $ref: '#/components/parameters/indices.put_alias___query.master_timeout' + - $ref: '#/components/parameters/indices.put_alias___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' requestBody: $ref: '#/components/requestBodies/indices.put_alias' responses: '200': - $ref: '#/components/responses/indices.put_alias@200' + $ref: '#/components/responses/indices.put_alias___200' /{index}/_analyze: get: operationId: indices.analyze.2 @@ -9588,18 +10080,18 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/analyze-apis/perform-text-analysis/ parameters: - - $ref: '#/components/parameters/indices.analyze::path.index' - - $ref: '#/components/parameters/indices.analyze::query.index' - - $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' + - $ref: '#/components/parameters/indices.analyze___path.index' + - $ref: '#/components/parameters/indices.analyze___query.index' + - $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/indices.analyze' responses: '200': - $ref: '#/components/responses/indices.analyze@200' + $ref: '#/components/responses/indices.analyze___200' post: operationId: indices.analyze.3 x-operation-group: indices.analyze @@ -9608,18 +10100,18 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/analyze-apis/perform-text-analysis/ parameters: - - $ref: '#/components/parameters/indices.analyze::path.index' - - $ref: '#/components/parameters/indices.analyze::query.index' - - $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' + - $ref: '#/components/parameters/indices.analyze___path.index' + - $ref: '#/components/parameters/indices.analyze___query.index' + - $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/indices.analyze' responses: '200': - $ref: '#/components/responses/indices.analyze@200' + $ref: '#/components/responses/indices.analyze___200' /{index}/_block/{block}: put: operationId: indices.add_block.0 @@ -9629,22 +10121,22 @@ paths: externalDocs: url: https://opensearch.org/docs/latest parameters: - - $ref: '#/components/parameters/indices.add_block::path.block' - - $ref: '#/components/parameters/indices.add_block::path.index' - - $ref: '#/components/parameters/indices.add_block::query.allow_no_indices' - - $ref: '#/components/parameters/indices.add_block::query.cluster_manager_timeout' - - $ref: '#/components/parameters/indices.add_block::query.expand_wildcards' - - $ref: '#/components/parameters/indices.add_block::query.ignore_unavailable' - - $ref: '#/components/parameters/indices.add_block::query.master_timeout' - - $ref: '#/components/parameters/indices.add_block::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/indices.add_block@200' + - $ref: '#/components/parameters/indices.add_block___path.block' + - $ref: '#/components/parameters/indices.add_block___path.index' + - $ref: '#/components/parameters/indices.add_block___query.allow_no_indices' + - $ref: '#/components/parameters/indices.add_block___query.cluster_manager_timeout' + - $ref: '#/components/parameters/indices.add_block___query.expand_wildcards' + - $ref: '#/components/parameters/indices.add_block___query.ignore_unavailable' + - $ref: '#/components/parameters/indices.add_block___query.master_timeout' + - $ref: '#/components/parameters/indices.add_block___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/indices.add_block___200' /{index}/_bulk: post: operationId: bulk.2 @@ -9654,27 +10146,27 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/document-apis/bulk/ parameters: - - $ref: '#/components/parameters/bulk::path.index' - - $ref: '#/components/parameters/bulk::query._source' - - $ref: '#/components/parameters/bulk::query._source_excludes' - - $ref: '#/components/parameters/bulk::query._source_includes' - - $ref: '#/components/parameters/bulk::query.pipeline' - - $ref: '#/components/parameters/bulk::query.refresh' - - $ref: '#/components/parameters/bulk::query.require_alias' - - $ref: '#/components/parameters/bulk::query.routing' - - $ref: '#/components/parameters/bulk::query.timeout' - - $ref: '#/components/parameters/bulk::query.type' - - $ref: '#/components/parameters/bulk::query.wait_for_active_shards' - - $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' + - $ref: '#/components/parameters/bulk___path.index' + - $ref: '#/components/parameters/bulk___query._source' + - $ref: '#/components/parameters/bulk___query._source_excludes' + - $ref: '#/components/parameters/bulk___query._source_includes' + - $ref: '#/components/parameters/bulk___query.pipeline' + - $ref: '#/components/parameters/bulk___query.refresh' + - $ref: '#/components/parameters/bulk___query.require_alias' + - $ref: '#/components/parameters/bulk___query.routing' + - $ref: '#/components/parameters/bulk___query.timeout' + - $ref: '#/components/parameters/bulk___query.type' + - $ref: '#/components/parameters/bulk___query.wait_for_active_shards' + - $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/bulk' responses: '200': - $ref: '#/components/responses/bulk@200' + $ref: '#/components/responses/bulk___200' put: operationId: bulk.3 x-operation-group: bulk @@ -9683,27 +10175,27 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/document-apis/bulk/ parameters: - - $ref: '#/components/parameters/bulk::path.index' - - $ref: '#/components/parameters/bulk::query._source' - - $ref: '#/components/parameters/bulk::query._source_excludes' - - $ref: '#/components/parameters/bulk::query._source_includes' - - $ref: '#/components/parameters/bulk::query.pipeline' - - $ref: '#/components/parameters/bulk::query.refresh' - - $ref: '#/components/parameters/bulk::query.require_alias' - - $ref: '#/components/parameters/bulk::query.routing' - - $ref: '#/components/parameters/bulk::query.timeout' - - $ref: '#/components/parameters/bulk::query.type' - - $ref: '#/components/parameters/bulk::query.wait_for_active_shards' - - $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' + - $ref: '#/components/parameters/bulk___path.index' + - $ref: '#/components/parameters/bulk___query._source' + - $ref: '#/components/parameters/bulk___query._source_excludes' + - $ref: '#/components/parameters/bulk___query._source_includes' + - $ref: '#/components/parameters/bulk___query.pipeline' + - $ref: '#/components/parameters/bulk___query.refresh' + - $ref: '#/components/parameters/bulk___query.require_alias' + - $ref: '#/components/parameters/bulk___query.routing' + - $ref: '#/components/parameters/bulk___query.timeout' + - $ref: '#/components/parameters/bulk___query.type' + - $ref: '#/components/parameters/bulk___query.wait_for_active_shards' + - $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/bulk' responses: '200': - $ref: '#/components/responses/bulk@200' + $ref: '#/components/responses/bulk___200' /{index}/_bulk/stream: post: operationId: bulk_stream.2 @@ -9713,29 +10205,29 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/document-apis/bulk-streaming/ parameters: - - $ref: '#/components/parameters/bulk_stream::path.index' - - $ref: '#/components/parameters/bulk_stream::query._source' - - $ref: '#/components/parameters/bulk_stream::query._source_excludes' - - $ref: '#/components/parameters/bulk_stream::query._source_includes' - - $ref: '#/components/parameters/bulk_stream::query.batch_interval' - - $ref: '#/components/parameters/bulk_stream::query.batch_size' - - $ref: '#/components/parameters/bulk_stream::query.pipeline' - - $ref: '#/components/parameters/bulk_stream::query.refresh' - - $ref: '#/components/parameters/bulk_stream::query.require_alias' - - $ref: '#/components/parameters/bulk_stream::query.routing' - - $ref: '#/components/parameters/bulk_stream::query.timeout' - - $ref: '#/components/parameters/bulk_stream::query.type' - - $ref: '#/components/parameters/bulk_stream::query.wait_for_active_shards' - - $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' + - $ref: '#/components/parameters/bulk_stream___path.index' + - $ref: '#/components/parameters/bulk_stream___query._source' + - $ref: '#/components/parameters/bulk_stream___query._source_excludes' + - $ref: '#/components/parameters/bulk_stream___query._source_includes' + - $ref: '#/components/parameters/bulk_stream___query.batch_interval' + - $ref: '#/components/parameters/bulk_stream___query.batch_size' + - $ref: '#/components/parameters/bulk_stream___query.pipeline' + - $ref: '#/components/parameters/bulk_stream___query.refresh' + - $ref: '#/components/parameters/bulk_stream___query.require_alias' + - $ref: '#/components/parameters/bulk_stream___query.routing' + - $ref: '#/components/parameters/bulk_stream___query.timeout' + - $ref: '#/components/parameters/bulk_stream___query.type' + - $ref: '#/components/parameters/bulk_stream___query.wait_for_active_shards' + - $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/bulk_stream' responses: '200': - $ref: '#/components/responses/bulk_stream@200' + $ref: '#/components/responses/bulk_stream___200' put: operationId: bulk_stream.3 x-operation-group: bulk_stream @@ -9744,56 +10236,56 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/document-apis/bulk-streaming/ parameters: - - $ref: '#/components/parameters/bulk_stream::path.index' - - $ref: '#/components/parameters/bulk_stream::query._source' - - $ref: '#/components/parameters/bulk_stream::query._source_excludes' - - $ref: '#/components/parameters/bulk_stream::query._source_includes' - - $ref: '#/components/parameters/bulk_stream::query.batch_interval' - - $ref: '#/components/parameters/bulk_stream::query.batch_size' - - $ref: '#/components/parameters/bulk_stream::query.pipeline' - - $ref: '#/components/parameters/bulk_stream::query.refresh' - - $ref: '#/components/parameters/bulk_stream::query.require_alias' - - $ref: '#/components/parameters/bulk_stream::query.routing' - - $ref: '#/components/parameters/bulk_stream::query.timeout' - - $ref: '#/components/parameters/bulk_stream::query.type' - - $ref: '#/components/parameters/bulk_stream::query.wait_for_active_shards' - - $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' + - $ref: '#/components/parameters/bulk_stream___path.index' + - $ref: '#/components/parameters/bulk_stream___query._source' + - $ref: '#/components/parameters/bulk_stream___query._source_excludes' + - $ref: '#/components/parameters/bulk_stream___query._source_includes' + - $ref: '#/components/parameters/bulk_stream___query.batch_interval' + - $ref: '#/components/parameters/bulk_stream___query.batch_size' + - $ref: '#/components/parameters/bulk_stream___query.pipeline' + - $ref: '#/components/parameters/bulk_stream___query.refresh' + - $ref: '#/components/parameters/bulk_stream___query.require_alias' + - $ref: '#/components/parameters/bulk_stream___query.routing' + - $ref: '#/components/parameters/bulk_stream___query.timeout' + - $ref: '#/components/parameters/bulk_stream___query.type' + - $ref: '#/components/parameters/bulk_stream___query.wait_for_active_shards' + - $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/bulk_stream' responses: '200': - $ref: '#/components/responses/bulk_stream@200' + $ref: '#/components/responses/bulk_stream___200' /{index}/_cache/clear: post: operationId: indices.clear_cache.1 x-operation-group: indices.clear_cache x-version-added: '1.0' - description: Clears all or specific caches for one or more indices. + description: Clears all or specific caches for one or more indexes. externalDocs: url: https://opensearch.org/docs/latest/api-reference/index-apis/clear-index-cache/ parameters: - - $ref: '#/components/parameters/indices.clear_cache::path.index' - - $ref: '#/components/parameters/indices.clear_cache::query.allow_no_indices' - - $ref: '#/components/parameters/indices.clear_cache::query.expand_wildcards' - - $ref: '#/components/parameters/indices.clear_cache::query.fielddata' - - $ref: '#/components/parameters/indices.clear_cache::query.fields' - - $ref: '#/components/parameters/indices.clear_cache::query.file' - - $ref: '#/components/parameters/indices.clear_cache::query.ignore_unavailable' - - $ref: '#/components/parameters/indices.clear_cache::query.index' - - $ref: '#/components/parameters/indices.clear_cache::query.query' - - $ref: '#/components/parameters/indices.clear_cache::query.request' - - $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/indices.clear_cache@200' + - $ref: '#/components/parameters/indices.clear_cache___path.index' + - $ref: '#/components/parameters/indices.clear_cache___query.allow_no_indices' + - $ref: '#/components/parameters/indices.clear_cache___query.expand_wildcards' + - $ref: '#/components/parameters/indices.clear_cache___query.fielddata' + - $ref: '#/components/parameters/indices.clear_cache___query.fields' + - $ref: '#/components/parameters/indices.clear_cache___query.file' + - $ref: '#/components/parameters/indices.clear_cache___query.ignore_unavailable' + - $ref: '#/components/parameters/indices.clear_cache___query.index' + - $ref: '#/components/parameters/indices.clear_cache___query.query' + - $ref: '#/components/parameters/indices.clear_cache___query.request' + - $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/indices.clear_cache___200' /{index}/_clone/{target}: post: operationId: indices.clone.0 @@ -9803,24 +10295,24 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/index-apis/clone/ parameters: - - $ref: '#/components/parameters/indices.clone::path.index' - - $ref: '#/components/parameters/indices.clone::path.target' - - $ref: '#/components/parameters/indices.clone::query.cluster_manager_timeout' - - $ref: '#/components/parameters/indices.clone::query.master_timeout' - - $ref: '#/components/parameters/indices.clone::query.task_execution_timeout' - - $ref: '#/components/parameters/indices.clone::query.timeout' - - $ref: '#/components/parameters/indices.clone::query.wait_for_active_shards' - - $ref: '#/components/parameters/indices.clone::query.wait_for_completion' - - $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' + - $ref: '#/components/parameters/indices.clone___path.index' + - $ref: '#/components/parameters/indices.clone___path.target' + - $ref: '#/components/parameters/indices.clone___query.cluster_manager_timeout' + - $ref: '#/components/parameters/indices.clone___query.master_timeout' + - $ref: '#/components/parameters/indices.clone___query.task_execution_timeout' + - $ref: '#/components/parameters/indices.clone___query.timeout' + - $ref: '#/components/parameters/indices.clone___query.wait_for_active_shards' + - $ref: '#/components/parameters/indices.clone___query.wait_for_completion' + - $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/indices.clone' responses: '200': - $ref: '#/components/responses/indices.clone@200' + $ref: '#/components/responses/indices.clone___200' put: operationId: indices.clone.1 x-operation-group: indices.clone @@ -9829,24 +10321,24 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/index-apis/clone/ parameters: - - $ref: '#/components/parameters/indices.clone::path.index' - - $ref: '#/components/parameters/indices.clone::path.target' - - $ref: '#/components/parameters/indices.clone::query.cluster_manager_timeout' - - $ref: '#/components/parameters/indices.clone::query.master_timeout' - - $ref: '#/components/parameters/indices.clone::query.task_execution_timeout' - - $ref: '#/components/parameters/indices.clone::query.timeout' - - $ref: '#/components/parameters/indices.clone::query.wait_for_active_shards' - - $ref: '#/components/parameters/indices.clone::query.wait_for_completion' - - $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' + - $ref: '#/components/parameters/indices.clone___path.index' + - $ref: '#/components/parameters/indices.clone___path.target' + - $ref: '#/components/parameters/indices.clone___query.cluster_manager_timeout' + - $ref: '#/components/parameters/indices.clone___query.master_timeout' + - $ref: '#/components/parameters/indices.clone___query.task_execution_timeout' + - $ref: '#/components/parameters/indices.clone___query.timeout' + - $ref: '#/components/parameters/indices.clone___query.wait_for_active_shards' + - $ref: '#/components/parameters/indices.clone___query.wait_for_completion' + - $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/indices.clone' responses: '200': - $ref: '#/components/responses/indices.clone@200' + $ref: '#/components/responses/indices.clone___200' /{index}/_close: post: operationId: indices.close.0 @@ -9856,22 +10348,22 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/index-apis/close-index/ parameters: - - $ref: '#/components/parameters/indices.close::path.index' - - $ref: '#/components/parameters/indices.close::query.allow_no_indices' - - $ref: '#/components/parameters/indices.close::query.cluster_manager_timeout' - - $ref: '#/components/parameters/indices.close::query.expand_wildcards' - - $ref: '#/components/parameters/indices.close::query.ignore_unavailable' - - $ref: '#/components/parameters/indices.close::query.master_timeout' - - $ref: '#/components/parameters/indices.close::query.timeout' - - $ref: '#/components/parameters/indices.close::query.wait_for_active_shards' - - $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/indices.close@200' + - $ref: '#/components/parameters/indices.close___path.index' + - $ref: '#/components/parameters/indices.close___query.allow_no_indices' + - $ref: '#/components/parameters/indices.close___query.cluster_manager_timeout' + - $ref: '#/components/parameters/indices.close___query.expand_wildcards' + - $ref: '#/components/parameters/indices.close___query.ignore_unavailable' + - $ref: '#/components/parameters/indices.close___query.master_timeout' + - $ref: '#/components/parameters/indices.close___query.timeout' + - $ref: '#/components/parameters/indices.close___query.wait_for_active_shards' + - $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/indices.close___200' /{index}/_count: get: operationId: count.2 @@ -9881,31 +10373,31 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/count/ parameters: - - $ref: '#/components/parameters/count::path.index' - - $ref: '#/components/parameters/count::query.allow_no_indices' - - $ref: '#/components/parameters/count::query.analyze_wildcard' - - $ref: '#/components/parameters/count::query.analyzer' - - $ref: '#/components/parameters/count::query.default_operator' - - $ref: '#/components/parameters/count::query.df' - - $ref: '#/components/parameters/count::query.expand_wildcards' - - $ref: '#/components/parameters/count::query.ignore_throttled' - - $ref: '#/components/parameters/count::query.ignore_unavailable' - - $ref: '#/components/parameters/count::query.lenient' - - $ref: '#/components/parameters/count::query.min_score' - - $ref: '#/components/parameters/count::query.preference' - - $ref: '#/components/parameters/count::query.q' - - $ref: '#/components/parameters/count::query.routing' - - $ref: '#/components/parameters/count::query.terminate_after' - - $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' + - $ref: '#/components/parameters/count___path.index' + - $ref: '#/components/parameters/count___query.allow_no_indices' + - $ref: '#/components/parameters/count___query.analyze_wildcard' + - $ref: '#/components/parameters/count___query.analyzer' + - $ref: '#/components/parameters/count___query.default_operator' + - $ref: '#/components/parameters/count___query.df' + - $ref: '#/components/parameters/count___query.expand_wildcards' + - $ref: '#/components/parameters/count___query.ignore_throttled' + - $ref: '#/components/parameters/count___query.ignore_unavailable' + - $ref: '#/components/parameters/count___query.lenient' + - $ref: '#/components/parameters/count___query.min_score' + - $ref: '#/components/parameters/count___query.preference' + - $ref: '#/components/parameters/count___query.q' + - $ref: '#/components/parameters/count___query.routing' + - $ref: '#/components/parameters/count___query.terminate_after' + - $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/count' responses: '200': - $ref: '#/components/responses/count@200' + $ref: '#/components/responses/count___200' post: operationId: count.3 x-operation-group: count @@ -9914,31 +10406,31 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/count/ parameters: - - $ref: '#/components/parameters/count::path.index' - - $ref: '#/components/parameters/count::query.allow_no_indices' - - $ref: '#/components/parameters/count::query.analyze_wildcard' - - $ref: '#/components/parameters/count::query.analyzer' - - $ref: '#/components/parameters/count::query.default_operator' - - $ref: '#/components/parameters/count::query.df' - - $ref: '#/components/parameters/count::query.expand_wildcards' - - $ref: '#/components/parameters/count::query.ignore_throttled' - - $ref: '#/components/parameters/count::query.ignore_unavailable' - - $ref: '#/components/parameters/count::query.lenient' - - $ref: '#/components/parameters/count::query.min_score' - - $ref: '#/components/parameters/count::query.preference' - - $ref: '#/components/parameters/count::query.q' - - $ref: '#/components/parameters/count::query.routing' - - $ref: '#/components/parameters/count::query.terminate_after' - - $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' + - $ref: '#/components/parameters/count___path.index' + - $ref: '#/components/parameters/count___query.allow_no_indices' + - $ref: '#/components/parameters/count___query.analyze_wildcard' + - $ref: '#/components/parameters/count___query.analyzer' + - $ref: '#/components/parameters/count___query.default_operator' + - $ref: '#/components/parameters/count___query.df' + - $ref: '#/components/parameters/count___query.expand_wildcards' + - $ref: '#/components/parameters/count___query.ignore_throttled' + - $ref: '#/components/parameters/count___query.ignore_unavailable' + - $ref: '#/components/parameters/count___query.lenient' + - $ref: '#/components/parameters/count___query.min_score' + - $ref: '#/components/parameters/count___query.preference' + - $ref: '#/components/parameters/count___query.q' + - $ref: '#/components/parameters/count___query.routing' + - $ref: '#/components/parameters/count___query.terminate_after' + - $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/count' responses: '200': - $ref: '#/components/responses/count@200' + $ref: '#/components/responses/count___200' /{index}/_create/{id}: post: operationId: create.0 @@ -9951,25 +10443,25 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/document-apis/index-document/ parameters: - - $ref: '#/components/parameters/create::path.id' - - $ref: '#/components/parameters/create::path.index' - - $ref: '#/components/parameters/create::query.pipeline' - - $ref: '#/components/parameters/create::query.refresh' - - $ref: '#/components/parameters/create::query.routing' - - $ref: '#/components/parameters/create::query.timeout' - - $ref: '#/components/parameters/create::query.version' - - $ref: '#/components/parameters/create::query.version_type' - - $ref: '#/components/parameters/create::query.wait_for_active_shards' - - $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' + - $ref: '#/components/parameters/create___path.id' + - $ref: '#/components/parameters/create___path.index' + - $ref: '#/components/parameters/create___query.pipeline' + - $ref: '#/components/parameters/create___query.refresh' + - $ref: '#/components/parameters/create___query.routing' + - $ref: '#/components/parameters/create___query.timeout' + - $ref: '#/components/parameters/create___query.version' + - $ref: '#/components/parameters/create___query.version_type' + - $ref: '#/components/parameters/create___query.wait_for_active_shards' + - $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/create' responses: - '200': - $ref: '#/components/responses/create@200' + '201': + $ref: '#/components/responses/create___201' put: operationId: create.1 x-operation-group: create @@ -9981,25 +10473,25 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/document-apis/index-document/ parameters: - - $ref: '#/components/parameters/create::path.id' - - $ref: '#/components/parameters/create::path.index' - - $ref: '#/components/parameters/create::query.pipeline' - - $ref: '#/components/parameters/create::query.refresh' - - $ref: '#/components/parameters/create::query.routing' - - $ref: '#/components/parameters/create::query.timeout' - - $ref: '#/components/parameters/create::query.version' - - $ref: '#/components/parameters/create::query.version_type' - - $ref: '#/components/parameters/create::query.wait_for_active_shards' - - $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' + - $ref: '#/components/parameters/create___path.id' + - $ref: '#/components/parameters/create___path.index' + - $ref: '#/components/parameters/create___query.pipeline' + - $ref: '#/components/parameters/create___query.refresh' + - $ref: '#/components/parameters/create___query.routing' + - $ref: '#/components/parameters/create___query.timeout' + - $ref: '#/components/parameters/create___query.version' + - $ref: '#/components/parameters/create___query.version_type' + - $ref: '#/components/parameters/create___query.wait_for_active_shards' + - $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/create' responses: - '200': - $ref: '#/components/responses/create@200' + '201': + $ref: '#/components/responses/create___201' /{index}/_delete_by_query: post: operationId: delete_by_query.0 @@ -10009,50 +10501,50 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/document-apis/delete-by-query/ parameters: - - $ref: '#/components/parameters/delete_by_query::path.index' - - $ref: '#/components/parameters/delete_by_query::query._source' - - $ref: '#/components/parameters/delete_by_query::query._source_excludes' - - $ref: '#/components/parameters/delete_by_query::query._source_includes' - - $ref: '#/components/parameters/delete_by_query::query.allow_no_indices' - - $ref: '#/components/parameters/delete_by_query::query.analyze_wildcard' - - $ref: '#/components/parameters/delete_by_query::query.analyzer' - - $ref: '#/components/parameters/delete_by_query::query.conflicts' - - $ref: '#/components/parameters/delete_by_query::query.default_operator' - - $ref: '#/components/parameters/delete_by_query::query.df' - - $ref: '#/components/parameters/delete_by_query::query.expand_wildcards' - - $ref: '#/components/parameters/delete_by_query::query.from' - - $ref: '#/components/parameters/delete_by_query::query.ignore_unavailable' - - $ref: '#/components/parameters/delete_by_query::query.lenient' - - $ref: '#/components/parameters/delete_by_query::query.max_docs' - - $ref: '#/components/parameters/delete_by_query::query.preference' - - $ref: '#/components/parameters/delete_by_query::query.q' - - $ref: '#/components/parameters/delete_by_query::query.refresh' - - $ref: '#/components/parameters/delete_by_query::query.request_cache' - - $ref: '#/components/parameters/delete_by_query::query.requests_per_second' - - $ref: '#/components/parameters/delete_by_query::query.routing' - - $ref: '#/components/parameters/delete_by_query::query.scroll' - - $ref: '#/components/parameters/delete_by_query::query.scroll_size' - - $ref: '#/components/parameters/delete_by_query::query.search_timeout' - - $ref: '#/components/parameters/delete_by_query::query.search_type' - - $ref: '#/components/parameters/delete_by_query::query.size' - - $ref: '#/components/parameters/delete_by_query::query.slices' - - $ref: '#/components/parameters/delete_by_query::query.sort' - - $ref: '#/components/parameters/delete_by_query::query.stats' - - $ref: '#/components/parameters/delete_by_query::query.terminate_after' - - $ref: '#/components/parameters/delete_by_query::query.timeout' - - $ref: '#/components/parameters/delete_by_query::query.version' - - $ref: '#/components/parameters/delete_by_query::query.wait_for_active_shards' - - $ref: '#/components/parameters/delete_by_query::query.wait_for_completion' - - $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' + - $ref: '#/components/parameters/delete_by_query___path.index' + - $ref: '#/components/parameters/delete_by_query___query._source' + - $ref: '#/components/parameters/delete_by_query___query._source_excludes' + - $ref: '#/components/parameters/delete_by_query___query._source_includes' + - $ref: '#/components/parameters/delete_by_query___query.allow_no_indices' + - $ref: '#/components/parameters/delete_by_query___query.analyze_wildcard' + - $ref: '#/components/parameters/delete_by_query___query.analyzer' + - $ref: '#/components/parameters/delete_by_query___query.conflicts' + - $ref: '#/components/parameters/delete_by_query___query.default_operator' + - $ref: '#/components/parameters/delete_by_query___query.df' + - $ref: '#/components/parameters/delete_by_query___query.expand_wildcards' + - $ref: '#/components/parameters/delete_by_query___query.from' + - $ref: '#/components/parameters/delete_by_query___query.ignore_unavailable' + - $ref: '#/components/parameters/delete_by_query___query.lenient' + - $ref: '#/components/parameters/delete_by_query___query.max_docs' + - $ref: '#/components/parameters/delete_by_query___query.preference' + - $ref: '#/components/parameters/delete_by_query___query.q' + - $ref: '#/components/parameters/delete_by_query___query.refresh' + - $ref: '#/components/parameters/delete_by_query___query.request_cache' + - $ref: '#/components/parameters/delete_by_query___query.requests_per_second' + - $ref: '#/components/parameters/delete_by_query___query.routing' + - $ref: '#/components/parameters/delete_by_query___query.scroll' + - $ref: '#/components/parameters/delete_by_query___query.scroll_size' + - $ref: '#/components/parameters/delete_by_query___query.search_timeout' + - $ref: '#/components/parameters/delete_by_query___query.search_type' + - $ref: '#/components/parameters/delete_by_query___query.size' + - $ref: '#/components/parameters/delete_by_query___query.slices' + - $ref: '#/components/parameters/delete_by_query___query.sort' + - $ref: '#/components/parameters/delete_by_query___query.stats' + - $ref: '#/components/parameters/delete_by_query___query.terminate_after' + - $ref: '#/components/parameters/delete_by_query___query.timeout' + - $ref: '#/components/parameters/delete_by_query___query.version' + - $ref: '#/components/parameters/delete_by_query___query.wait_for_active_shards' + - $ref: '#/components/parameters/delete_by_query___query.wait_for_completion' + - $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/delete_by_query' responses: '200': - $ref: '#/components/responses/delete_by_query@200' + $ref: '#/components/responses/delete_by_query___200' /{index}/_doc: post: operationId: index.0 @@ -10062,30 +10554,30 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/document-apis/index-document/ parameters: - - $ref: '#/components/parameters/index::path.index' - - $ref: '#/components/parameters/index::query.if_primary_term' - - $ref: '#/components/parameters/index::query.if_seq_no' - - $ref: '#/components/parameters/index::query.op_type' - - $ref: '#/components/parameters/index::query.pipeline' - - $ref: '#/components/parameters/index::query.refresh' - - $ref: '#/components/parameters/index::query.require_alias' - - $ref: '#/components/parameters/index::query.routing' - - $ref: '#/components/parameters/index::query.timeout' - - $ref: '#/components/parameters/index::query.version' - - $ref: '#/components/parameters/index::query.version_type' - - $ref: '#/components/parameters/index::query.wait_for_active_shards' - - $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' + - $ref: '#/components/parameters/index___path.index' + - $ref: '#/components/parameters/index___query.if_primary_term' + - $ref: '#/components/parameters/index___query.if_seq_no' + - $ref: '#/components/parameters/index___query.op_type' + - $ref: '#/components/parameters/index___query.pipeline' + - $ref: '#/components/parameters/index___query.refresh' + - $ref: '#/components/parameters/index___query.require_alias' + - $ref: '#/components/parameters/index___query.routing' + - $ref: '#/components/parameters/index___query.timeout' + - $ref: '#/components/parameters/index___query.version' + - $ref: '#/components/parameters/index___query.version_type' + - $ref: '#/components/parameters/index___query.wait_for_active_shards' + - $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/index' responses: '200': - $ref: '#/components/responses/index@200' + $ref: '#/components/responses/index___200' '201': - $ref: '#/components/responses/index@201' + $ref: '#/components/responses/index___201' /{index}/_doc/{id}: delete: operationId: delete.0 @@ -10095,26 +10587,26 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/document-apis/delete-document/ parameters: - - $ref: '#/components/parameters/delete::path.id' - - $ref: '#/components/parameters/delete::path.index' - - $ref: '#/components/parameters/delete::query.if_primary_term' - - $ref: '#/components/parameters/delete::query.if_seq_no' - - $ref: '#/components/parameters/delete::query.refresh' - - $ref: '#/components/parameters/delete::query.routing' - - $ref: '#/components/parameters/delete::query.timeout' - - $ref: '#/components/parameters/delete::query.version' - - $ref: '#/components/parameters/delete::query.version_type' - - $ref: '#/components/parameters/delete::query.wait_for_active_shards' - - $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/delete@200' + - $ref: '#/components/parameters/delete___path.id' + - $ref: '#/components/parameters/delete___path.index' + - $ref: '#/components/parameters/delete___query.if_primary_term' + - $ref: '#/components/parameters/delete___query.if_seq_no' + - $ref: '#/components/parameters/delete___query.refresh' + - $ref: '#/components/parameters/delete___query.routing' + - $ref: '#/components/parameters/delete___query.timeout' + - $ref: '#/components/parameters/delete___query.version' + - $ref: '#/components/parameters/delete___query.version_type' + - $ref: '#/components/parameters/delete___query.wait_for_active_shards' + - $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/delete___200' '404': - $ref: '#/components/responses/delete@404' + $ref: '#/components/responses/delete___404' get: operationId: get.0 x-operation-group: get @@ -10123,28 +10615,28 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/document-apis/get-documents/ parameters: - - $ref: '#/components/parameters/get::path.id' - - $ref: '#/components/parameters/get::path.index' - - $ref: '#/components/parameters/get::query._source' - - $ref: '#/components/parameters/get::query._source_excludes' - - $ref: '#/components/parameters/get::query._source_includes' - - $ref: '#/components/parameters/get::query.preference' - - $ref: '#/components/parameters/get::query.realtime' - - $ref: '#/components/parameters/get::query.refresh' - - $ref: '#/components/parameters/get::query.routing' - - $ref: '#/components/parameters/get::query.stored_fields' - - $ref: '#/components/parameters/get::query.version' - - $ref: '#/components/parameters/get::query.version_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/get@200' + - $ref: '#/components/parameters/get___path.id' + - $ref: '#/components/parameters/get___path.index' + - $ref: '#/components/parameters/get___query._source' + - $ref: '#/components/parameters/get___query._source_excludes' + - $ref: '#/components/parameters/get___query._source_includes' + - $ref: '#/components/parameters/get___query.preference' + - $ref: '#/components/parameters/get___query.realtime' + - $ref: '#/components/parameters/get___query.refresh' + - $ref: '#/components/parameters/get___query.routing' + - $ref: '#/components/parameters/get___query.stored_fields' + - $ref: '#/components/parameters/get___query.version' + - $ref: '#/components/parameters/get___query.version_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/get___200' '404': - $ref: '#/components/responses/get@404' + $ref: '#/components/responses/get___404' head: operationId: exists.0 x-operation-group: exists @@ -10153,26 +10645,28 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/document-apis/get-documents/ parameters: - - $ref: '#/components/parameters/exists::path.id' - - $ref: '#/components/parameters/exists::path.index' - - $ref: '#/components/parameters/exists::query._source' - - $ref: '#/components/parameters/exists::query._source_excludes' - - $ref: '#/components/parameters/exists::query._source_includes' - - $ref: '#/components/parameters/exists::query.preference' - - $ref: '#/components/parameters/exists::query.realtime' - - $ref: '#/components/parameters/exists::query.refresh' - - $ref: '#/components/parameters/exists::query.routing' - - $ref: '#/components/parameters/exists::query.stored_fields' - - $ref: '#/components/parameters/exists::query.version' - - $ref: '#/components/parameters/exists::query.version_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/exists@200' + - $ref: '#/components/parameters/exists___path.id' + - $ref: '#/components/parameters/exists___path.index' + - $ref: '#/components/parameters/exists___query._source' + - $ref: '#/components/parameters/exists___query._source_excludes' + - $ref: '#/components/parameters/exists___query._source_includes' + - $ref: '#/components/parameters/exists___query.preference' + - $ref: '#/components/parameters/exists___query.realtime' + - $ref: '#/components/parameters/exists___query.refresh' + - $ref: '#/components/parameters/exists___query.routing' + - $ref: '#/components/parameters/exists___query.stored_fields' + - $ref: '#/components/parameters/exists___query.version' + - $ref: '#/components/parameters/exists___query.version_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/exists___200' + '404': + $ref: '#/components/responses/exists___404' post: operationId: index.1 x-operation-group: index @@ -10181,31 +10675,31 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/document-apis/index-document/ parameters: - - $ref: '#/components/parameters/index::path.id' - - $ref: '#/components/parameters/index::path.index' - - $ref: '#/components/parameters/index::query.if_primary_term' - - $ref: '#/components/parameters/index::query.if_seq_no' - - $ref: '#/components/parameters/index::query.op_type' - - $ref: '#/components/parameters/index::query.pipeline' - - $ref: '#/components/parameters/index::query.refresh' - - $ref: '#/components/parameters/index::query.require_alias' - - $ref: '#/components/parameters/index::query.routing' - - $ref: '#/components/parameters/index::query.timeout' - - $ref: '#/components/parameters/index::query.version' - - $ref: '#/components/parameters/index::query.version_type' - - $ref: '#/components/parameters/index::query.wait_for_active_shards' - - $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' + - $ref: '#/components/parameters/index___path.id' + - $ref: '#/components/parameters/index___path.index' + - $ref: '#/components/parameters/index___query.if_primary_term' + - $ref: '#/components/parameters/index___query.if_seq_no' + - $ref: '#/components/parameters/index___query.op_type' + - $ref: '#/components/parameters/index___query.pipeline' + - $ref: '#/components/parameters/index___query.refresh' + - $ref: '#/components/parameters/index___query.require_alias' + - $ref: '#/components/parameters/index___query.routing' + - $ref: '#/components/parameters/index___query.timeout' + - $ref: '#/components/parameters/index___query.version' + - $ref: '#/components/parameters/index___query.version_type' + - $ref: '#/components/parameters/index___query.wait_for_active_shards' + - $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/index' responses: '200': - $ref: '#/components/responses/index@200' + $ref: '#/components/responses/index___200' '201': - $ref: '#/components/responses/index@201' + $ref: '#/components/responses/index___201' put: operationId: index.2 x-operation-group: index @@ -10214,31 +10708,31 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/document-apis/index-document/ parameters: - - $ref: '#/components/parameters/index::path.id' - - $ref: '#/components/parameters/index::path.index' - - $ref: '#/components/parameters/index::query.if_primary_term' - - $ref: '#/components/parameters/index::query.if_seq_no' - - $ref: '#/components/parameters/index::query.op_type' - - $ref: '#/components/parameters/index::query.pipeline' - - $ref: '#/components/parameters/index::query.refresh' - - $ref: '#/components/parameters/index::query.require_alias' - - $ref: '#/components/parameters/index::query.routing' - - $ref: '#/components/parameters/index::query.timeout' - - $ref: '#/components/parameters/index::query.version' - - $ref: '#/components/parameters/index::query.version_type' - - $ref: '#/components/parameters/index::query.wait_for_active_shards' - - $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' + - $ref: '#/components/parameters/index___path.id' + - $ref: '#/components/parameters/index___path.index' + - $ref: '#/components/parameters/index___query.if_primary_term' + - $ref: '#/components/parameters/index___query.if_seq_no' + - $ref: '#/components/parameters/index___query.op_type' + - $ref: '#/components/parameters/index___query.pipeline' + - $ref: '#/components/parameters/index___query.refresh' + - $ref: '#/components/parameters/index___query.require_alias' + - $ref: '#/components/parameters/index___query.routing' + - $ref: '#/components/parameters/index___query.timeout' + - $ref: '#/components/parameters/index___query.version' + - $ref: '#/components/parameters/index___query.version_type' + - $ref: '#/components/parameters/index___query.wait_for_active_shards' + - $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/index' responses: '200': - $ref: '#/components/responses/index@200' + $ref: '#/components/responses/index___200' '201': - $ref: '#/components/responses/index@201' + $ref: '#/components/responses/index___201' /{index}/_explain/{id}: get: operationId: explain.0 @@ -10248,30 +10742,30 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/explain/ parameters: - - $ref: '#/components/parameters/explain::path.id' - - $ref: '#/components/parameters/explain::path.index' - - $ref: '#/components/parameters/explain::query._source' - - $ref: '#/components/parameters/explain::query._source_excludes' - - $ref: '#/components/parameters/explain::query._source_includes' - - $ref: '#/components/parameters/explain::query.analyze_wildcard' - - $ref: '#/components/parameters/explain::query.analyzer' - - $ref: '#/components/parameters/explain::query.default_operator' - - $ref: '#/components/parameters/explain::query.df' - - $ref: '#/components/parameters/explain::query.lenient' - - $ref: '#/components/parameters/explain::query.preference' - - $ref: '#/components/parameters/explain::query.q' - - $ref: '#/components/parameters/explain::query.routing' - - $ref: '#/components/parameters/explain::query.stored_fields' - - $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' + - $ref: '#/components/parameters/explain___path.id' + - $ref: '#/components/parameters/explain___path.index' + - $ref: '#/components/parameters/explain___query._source' + - $ref: '#/components/parameters/explain___query._source_excludes' + - $ref: '#/components/parameters/explain___query._source_includes' + - $ref: '#/components/parameters/explain___query.analyze_wildcard' + - $ref: '#/components/parameters/explain___query.analyzer' + - $ref: '#/components/parameters/explain___query.default_operator' + - $ref: '#/components/parameters/explain___query.df' + - $ref: '#/components/parameters/explain___query.lenient' + - $ref: '#/components/parameters/explain___query.preference' + - $ref: '#/components/parameters/explain___query.q' + - $ref: '#/components/parameters/explain___query.routing' + - $ref: '#/components/parameters/explain___query.stored_fields' + - $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/explain' responses: '200': - $ref: '#/components/responses/explain@200' + $ref: '#/components/responses/explain___200' post: operationId: explain.1 x-operation-group: explain @@ -10280,175 +10774,175 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/explain/ parameters: - - $ref: '#/components/parameters/explain::path.id' - - $ref: '#/components/parameters/explain::path.index' - - $ref: '#/components/parameters/explain::query._source' - - $ref: '#/components/parameters/explain::query._source_excludes' - - $ref: '#/components/parameters/explain::query._source_includes' - - $ref: '#/components/parameters/explain::query.analyze_wildcard' - - $ref: '#/components/parameters/explain::query.analyzer' - - $ref: '#/components/parameters/explain::query.default_operator' - - $ref: '#/components/parameters/explain::query.df' - - $ref: '#/components/parameters/explain::query.lenient' - - $ref: '#/components/parameters/explain::query.preference' - - $ref: '#/components/parameters/explain::query.q' - - $ref: '#/components/parameters/explain::query.routing' - - $ref: '#/components/parameters/explain::query.stored_fields' - - $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' + - $ref: '#/components/parameters/explain___path.id' + - $ref: '#/components/parameters/explain___path.index' + - $ref: '#/components/parameters/explain___query._source' + - $ref: '#/components/parameters/explain___query._source_excludes' + - $ref: '#/components/parameters/explain___query._source_includes' + - $ref: '#/components/parameters/explain___query.analyze_wildcard' + - $ref: '#/components/parameters/explain___query.analyzer' + - $ref: '#/components/parameters/explain___query.default_operator' + - $ref: '#/components/parameters/explain___query.df' + - $ref: '#/components/parameters/explain___query.lenient' + - $ref: '#/components/parameters/explain___query.preference' + - $ref: '#/components/parameters/explain___query.q' + - $ref: '#/components/parameters/explain___query.routing' + - $ref: '#/components/parameters/explain___query.stored_fields' + - $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/explain' responses: '200': - $ref: '#/components/responses/explain@200' + $ref: '#/components/responses/explain___200' /{index}/_field_caps: get: operationId: field_caps.2 x-operation-group: field_caps x-version-added: '1.0' - description: Returns the information about the capabilities of fields among multiple indices. + description: Returns the information about the capabilities of fields among multiple indexes. externalDocs: url: https://opensearch.org/docs/latest/field-types/supported-field-types/alias/#using-aliases-in-field-capabilities-api-operations parameters: - - $ref: '#/components/parameters/field_caps::path.index' - - $ref: '#/components/parameters/field_caps::query.allow_no_indices' - - $ref: '#/components/parameters/field_caps::query.expand_wildcards' - - $ref: '#/components/parameters/field_caps::query.fields' - - $ref: '#/components/parameters/field_caps::query.ignore_unavailable' - - $ref: '#/components/parameters/field_caps::query.include_unmapped' - - $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' + - $ref: '#/components/parameters/field_caps___path.index' + - $ref: '#/components/parameters/field_caps___query.allow_no_indices' + - $ref: '#/components/parameters/field_caps___query.expand_wildcards' + - $ref: '#/components/parameters/field_caps___query.fields' + - $ref: '#/components/parameters/field_caps___query.ignore_unavailable' + - $ref: '#/components/parameters/field_caps___query.include_unmapped' + - $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/field_caps' responses: '200': - $ref: '#/components/responses/field_caps@200' + $ref: '#/components/responses/field_caps___200' post: operationId: field_caps.3 x-operation-group: field_caps x-version-added: '1.0' - description: Returns the information about the capabilities of fields among multiple indices. + description: Returns the information about the capabilities of fields among multiple indexes. externalDocs: url: https://opensearch.org/docs/latest/field-types/supported-field-types/alias/#using-aliases-in-field-capabilities-api-operations parameters: - - $ref: '#/components/parameters/field_caps::path.index' - - $ref: '#/components/parameters/field_caps::query.allow_no_indices' - - $ref: '#/components/parameters/field_caps::query.expand_wildcards' - - $ref: '#/components/parameters/field_caps::query.fields' - - $ref: '#/components/parameters/field_caps::query.ignore_unavailable' - - $ref: '#/components/parameters/field_caps::query.include_unmapped' - - $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' + - $ref: '#/components/parameters/field_caps___path.index' + - $ref: '#/components/parameters/field_caps___query.allow_no_indices' + - $ref: '#/components/parameters/field_caps___query.expand_wildcards' + - $ref: '#/components/parameters/field_caps___query.fields' + - $ref: '#/components/parameters/field_caps___query.ignore_unavailable' + - $ref: '#/components/parameters/field_caps___query.include_unmapped' + - $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/field_caps' responses: '200': - $ref: '#/components/responses/field_caps@200' + $ref: '#/components/responses/field_caps___200' /{index}/_flush: get: operationId: indices.flush.2 x-operation-group: indices.flush x-version-added: '1.0' - description: Performs the flush operation on one or more indices. + description: Performs the flush operation on one or more indexes. externalDocs: url: https://opensearch.org/docs/latest parameters: - - $ref: '#/components/parameters/indices.flush::path.index' - - $ref: '#/components/parameters/indices.flush::query.allow_no_indices' - - $ref: '#/components/parameters/indices.flush::query.expand_wildcards' - - $ref: '#/components/parameters/indices.flush::query.force' - - $ref: '#/components/parameters/indices.flush::query.ignore_unavailable' - - $ref: '#/components/parameters/indices.flush::query.wait_if_ongoing' - - $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' + - $ref: '#/components/parameters/indices.flush___path.index' + - $ref: '#/components/parameters/indices.flush___query.allow_no_indices' + - $ref: '#/components/parameters/indices.flush___query.expand_wildcards' + - $ref: '#/components/parameters/indices.flush___query.force' + - $ref: '#/components/parameters/indices.flush___query.ignore_unavailable' + - $ref: '#/components/parameters/indices.flush___query.wait_if_ongoing' + - $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/indices.flush@200' + $ref: '#/components/responses/indices.flush___200' post: operationId: indices.flush.3 x-operation-group: indices.flush x-version-added: '1.0' - description: Performs the flush operation on one or more indices. + description: Performs the flush operation on one or more indexes. externalDocs: url: https://opensearch.org/docs/latest parameters: - - $ref: '#/components/parameters/indices.flush::path.index' - - $ref: '#/components/parameters/indices.flush::query.allow_no_indices' - - $ref: '#/components/parameters/indices.flush::query.expand_wildcards' - - $ref: '#/components/parameters/indices.flush::query.force' - - $ref: '#/components/parameters/indices.flush::query.ignore_unavailable' - - $ref: '#/components/parameters/indices.flush::query.wait_if_ongoing' - - $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' + - $ref: '#/components/parameters/indices.flush___path.index' + - $ref: '#/components/parameters/indices.flush___query.allow_no_indices' + - $ref: '#/components/parameters/indices.flush___query.expand_wildcards' + - $ref: '#/components/parameters/indices.flush___query.force' + - $ref: '#/components/parameters/indices.flush___query.ignore_unavailable' + - $ref: '#/components/parameters/indices.flush___query.wait_if_ongoing' + - $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/indices.flush@200' + $ref: '#/components/responses/indices.flush___200' /{index}/_forcemerge: post: operationId: indices.forcemerge.1 x-operation-group: indices.forcemerge x-version-added: '1.0' - description: Performs the force merge operation on one or more indices. + description: Performs the force merge operation on one or more indexes. externalDocs: url: https://opensearch.org/docs/latest parameters: - - $ref: '#/components/parameters/indices.forcemerge::path.index' - - $ref: '#/components/parameters/indices.forcemerge::query.allow_no_indices' - - $ref: '#/components/parameters/indices.forcemerge::query.expand_wildcards' - - $ref: '#/components/parameters/indices.forcemerge::query.flush' - - $ref: '#/components/parameters/indices.forcemerge::query.ignore_unavailable' - - $ref: '#/components/parameters/indices.forcemerge::query.max_num_segments' - - $ref: '#/components/parameters/indices.forcemerge::query.only_expunge_deletes' - - $ref: '#/components/parameters/indices.forcemerge::query.primary_only' - - $ref: '#/components/parameters/indices.forcemerge::query.wait_for_completion' - - $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/indices.forcemerge@200' + - $ref: '#/components/parameters/indices.forcemerge___path.index' + - $ref: '#/components/parameters/indices.forcemerge___query.allow_no_indices' + - $ref: '#/components/parameters/indices.forcemerge___query.expand_wildcards' + - $ref: '#/components/parameters/indices.forcemerge___query.flush' + - $ref: '#/components/parameters/indices.forcemerge___query.ignore_unavailable' + - $ref: '#/components/parameters/indices.forcemerge___query.max_num_segments' + - $ref: '#/components/parameters/indices.forcemerge___query.only_expunge_deletes' + - $ref: '#/components/parameters/indices.forcemerge___query.primary_only' + - $ref: '#/components/parameters/indices.forcemerge___query.wait_for_completion' + - $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/indices.forcemerge___200' /{index}/_mapping: get: operationId: indices.get_mapping.1 x-operation-group: indices.get_mapping x-version-added: '1.0' - description: Returns mappings for one or more indices. + description: Returns mappings for one or more indexes. externalDocs: url: https://opensearch.org/docs/latest/field-types/index/#get-a-mapping parameters: - - $ref: '#/components/parameters/indices.get_mapping::path.index' - - $ref: '#/components/parameters/indices.get_mapping::query.allow_no_indices' - - $ref: '#/components/parameters/indices.get_mapping::query.cluster_manager_timeout' - - $ref: '#/components/parameters/indices.get_mapping::query.expand_wildcards' - - $ref: '#/components/parameters/indices.get_mapping::query.ignore_unavailable' - - $ref: '#/components/parameters/indices.get_mapping::query.index' - - $ref: '#/components/parameters/indices.get_mapping::query.local' - - $ref: '#/components/parameters/indices.get_mapping::query.master_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/indices.get_mapping@200' + - $ref: '#/components/parameters/indices.get_mapping___path.index' + - $ref: '#/components/parameters/indices.get_mapping___query.allow_no_indices' + - $ref: '#/components/parameters/indices.get_mapping___query.cluster_manager_timeout' + - $ref: '#/components/parameters/indices.get_mapping___query.expand_wildcards' + - $ref: '#/components/parameters/indices.get_mapping___query.ignore_unavailable' + - $ref: '#/components/parameters/indices.get_mapping___query.index' + - $ref: '#/components/parameters/indices.get_mapping___query.local' + - $ref: '#/components/parameters/indices.get_mapping___query.master_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/indices.get_mapping___200' post: operationId: indices.put_mapping.0 x-operation-group: indices.put_mapping @@ -10457,24 +10951,24 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/index-apis/put-mapping/ parameters: - - $ref: '#/components/parameters/indices.put_mapping::path.index' - - $ref: '#/components/parameters/indices.put_mapping::query.allow_no_indices' - - $ref: '#/components/parameters/indices.put_mapping::query.cluster_manager_timeout' - - $ref: '#/components/parameters/indices.put_mapping::query.expand_wildcards' - - $ref: '#/components/parameters/indices.put_mapping::query.ignore_unavailable' - - $ref: '#/components/parameters/indices.put_mapping::query.master_timeout' - - $ref: '#/components/parameters/indices.put_mapping::query.timeout' - - $ref: '#/components/parameters/indices.put_mapping::query.write_index_only' - - $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' + - $ref: '#/components/parameters/indices.put_mapping___path.index' + - $ref: '#/components/parameters/indices.put_mapping___query.allow_no_indices' + - $ref: '#/components/parameters/indices.put_mapping___query.cluster_manager_timeout' + - $ref: '#/components/parameters/indices.put_mapping___query.expand_wildcards' + - $ref: '#/components/parameters/indices.put_mapping___query.ignore_unavailable' + - $ref: '#/components/parameters/indices.put_mapping___query.master_timeout' + - $ref: '#/components/parameters/indices.put_mapping___query.timeout' + - $ref: '#/components/parameters/indices.put_mapping___query.write_index_only' + - $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/indices.put_mapping' responses: '200': - $ref: '#/components/responses/indices.put_mapping@200' + $ref: '#/components/responses/indices.put_mapping___200' put: operationId: indices.put_mapping.1 x-operation-group: indices.put_mapping @@ -10483,24 +10977,24 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/index-apis/put-mapping/ parameters: - - $ref: '#/components/parameters/indices.put_mapping::path.index' - - $ref: '#/components/parameters/indices.put_mapping::query.allow_no_indices' - - $ref: '#/components/parameters/indices.put_mapping::query.cluster_manager_timeout' - - $ref: '#/components/parameters/indices.put_mapping::query.expand_wildcards' - - $ref: '#/components/parameters/indices.put_mapping::query.ignore_unavailable' - - $ref: '#/components/parameters/indices.put_mapping::query.master_timeout' - - $ref: '#/components/parameters/indices.put_mapping::query.timeout' - - $ref: '#/components/parameters/indices.put_mapping::query.write_index_only' - - $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' + - $ref: '#/components/parameters/indices.put_mapping___path.index' + - $ref: '#/components/parameters/indices.put_mapping___query.allow_no_indices' + - $ref: '#/components/parameters/indices.put_mapping___query.cluster_manager_timeout' + - $ref: '#/components/parameters/indices.put_mapping___query.expand_wildcards' + - $ref: '#/components/parameters/indices.put_mapping___query.ignore_unavailable' + - $ref: '#/components/parameters/indices.put_mapping___query.master_timeout' + - $ref: '#/components/parameters/indices.put_mapping___query.timeout' + - $ref: '#/components/parameters/indices.put_mapping___query.write_index_only' + - $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/indices.put_mapping' responses: '200': - $ref: '#/components/responses/indices.put_mapping@200' + $ref: '#/components/responses/indices.put_mapping___200' /{index}/_mapping/field/{fields}: get: operationId: indices.get_field_mapping.1 @@ -10510,21 +11004,21 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/field-types/index/ parameters: - - $ref: '#/components/parameters/indices.get_field_mapping::path.fields' - - $ref: '#/components/parameters/indices.get_field_mapping::path.index' - - $ref: '#/components/parameters/indices.get_field_mapping::query.allow_no_indices' - - $ref: '#/components/parameters/indices.get_field_mapping::query.expand_wildcards' - - $ref: '#/components/parameters/indices.get_field_mapping::query.ignore_unavailable' - - $ref: '#/components/parameters/indices.get_field_mapping::query.include_defaults' - - $ref: '#/components/parameters/indices.get_field_mapping::query.local' - - $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/indices.get_field_mapping@200' + - $ref: '#/components/parameters/indices.get_field_mapping___path.fields' + - $ref: '#/components/parameters/indices.get_field_mapping___path.index' + - $ref: '#/components/parameters/indices.get_field_mapping___query.allow_no_indices' + - $ref: '#/components/parameters/indices.get_field_mapping___query.expand_wildcards' + - $ref: '#/components/parameters/indices.get_field_mapping___query.ignore_unavailable' + - $ref: '#/components/parameters/indices.get_field_mapping___query.include_defaults' + - $ref: '#/components/parameters/indices.get_field_mapping___query.local' + - $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/indices.get_field_mapping___200' /{index}/_mget: get: operationId: mget.2 @@ -10534,25 +11028,25 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/document-apis/multi-get/ parameters: - - $ref: '#/components/parameters/mget::path.index' - - $ref: '#/components/parameters/mget::query._source' - - $ref: '#/components/parameters/mget::query._source_excludes' - - $ref: '#/components/parameters/mget::query._source_includes' - - $ref: '#/components/parameters/mget::query.preference' - - $ref: '#/components/parameters/mget::query.realtime' - - $ref: '#/components/parameters/mget::query.refresh' - - $ref: '#/components/parameters/mget::query.routing' - - $ref: '#/components/parameters/mget::query.stored_fields' - - $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' + - $ref: '#/components/parameters/mget___path.index' + - $ref: '#/components/parameters/mget___query._source' + - $ref: '#/components/parameters/mget___query._source_excludes' + - $ref: '#/components/parameters/mget___query._source_includes' + - $ref: '#/components/parameters/mget___query.preference' + - $ref: '#/components/parameters/mget___query.realtime' + - $ref: '#/components/parameters/mget___query.refresh' + - $ref: '#/components/parameters/mget___query.routing' + - $ref: '#/components/parameters/mget___query.stored_fields' + - $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/mget' responses: '200': - $ref: '#/components/responses/mget@200' + $ref: '#/components/responses/mget___200' post: operationId: mget.3 x-operation-group: mget @@ -10561,25 +11055,25 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/document-apis/multi-get/ parameters: - - $ref: '#/components/parameters/mget::path.index' - - $ref: '#/components/parameters/mget::query._source' - - $ref: '#/components/parameters/mget::query._source_excludes' - - $ref: '#/components/parameters/mget::query._source_includes' - - $ref: '#/components/parameters/mget::query.preference' - - $ref: '#/components/parameters/mget::query.realtime' - - $ref: '#/components/parameters/mget::query.refresh' - - $ref: '#/components/parameters/mget::query.routing' - - $ref: '#/components/parameters/mget::query.stored_fields' - - $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' + - $ref: '#/components/parameters/mget___path.index' + - $ref: '#/components/parameters/mget___query._source' + - $ref: '#/components/parameters/mget___query._source_excludes' + - $ref: '#/components/parameters/mget___query._source_includes' + - $ref: '#/components/parameters/mget___query.preference' + - $ref: '#/components/parameters/mget___query.realtime' + - $ref: '#/components/parameters/mget___query.refresh' + - $ref: '#/components/parameters/mget___query.routing' + - $ref: '#/components/parameters/mget___query.stored_fields' + - $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/mget' responses: '200': - $ref: '#/components/responses/mget@200' + $ref: '#/components/responses/mget___200' /{index}/_msearch: get: operationId: msearch.2 @@ -10589,24 +11083,24 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/multi-search/ parameters: - - $ref: '#/components/parameters/msearch::path.index' - - $ref: '#/components/parameters/msearch::query.ccs_minimize_roundtrips' - - $ref: '#/components/parameters/msearch::query.max_concurrent_searches' - - $ref: '#/components/parameters/msearch::query.max_concurrent_shard_requests' - - $ref: '#/components/parameters/msearch::query.pre_filter_shard_size' - - $ref: '#/components/parameters/msearch::query.rest_total_hits_as_int' - - $ref: '#/components/parameters/msearch::query.search_type' - - $ref: '#/components/parameters/msearch::query.typed_keys' - - $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' + - $ref: '#/components/parameters/msearch___path.index' + - $ref: '#/components/parameters/msearch___query.ccs_minimize_roundtrips' + - $ref: '#/components/parameters/msearch___query.max_concurrent_searches' + - $ref: '#/components/parameters/msearch___query.max_concurrent_shard_requests' + - $ref: '#/components/parameters/msearch___query.pre_filter_shard_size' + - $ref: '#/components/parameters/msearch___query.rest_total_hits_as_int' + - $ref: '#/components/parameters/msearch___query.search_type' + - $ref: '#/components/parameters/msearch___query.typed_keys' + - $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/msearch' responses: '200': - $ref: '#/components/responses/msearch@200' + $ref: '#/components/responses/msearch___200' post: operationId: msearch.3 x-operation-group: msearch @@ -10615,24 +11109,24 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/multi-search/ parameters: - - $ref: '#/components/parameters/msearch::path.index' - - $ref: '#/components/parameters/msearch::query.ccs_minimize_roundtrips' - - $ref: '#/components/parameters/msearch::query.max_concurrent_searches' - - $ref: '#/components/parameters/msearch::query.max_concurrent_shard_requests' - - $ref: '#/components/parameters/msearch::query.pre_filter_shard_size' - - $ref: '#/components/parameters/msearch::query.rest_total_hits_as_int' - - $ref: '#/components/parameters/msearch::query.search_type' - - $ref: '#/components/parameters/msearch::query.typed_keys' - - $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' + - $ref: '#/components/parameters/msearch___path.index' + - $ref: '#/components/parameters/msearch___query.ccs_minimize_roundtrips' + - $ref: '#/components/parameters/msearch___query.max_concurrent_searches' + - $ref: '#/components/parameters/msearch___query.max_concurrent_shard_requests' + - $ref: '#/components/parameters/msearch___query.pre_filter_shard_size' + - $ref: '#/components/parameters/msearch___query.rest_total_hits_as_int' + - $ref: '#/components/parameters/msearch___query.search_type' + - $ref: '#/components/parameters/msearch___query.typed_keys' + - $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/msearch' responses: '200': - $ref: '#/components/responses/msearch@200' + $ref: '#/components/responses/msearch___200' /{index}/_msearch/template: get: operationId: msearch_template.2 @@ -10642,22 +11136,22 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/search-plugins/search-template/ parameters: - - $ref: '#/components/parameters/msearch_template::path.index' - - $ref: '#/components/parameters/msearch_template::query.ccs_minimize_roundtrips' - - $ref: '#/components/parameters/msearch_template::query.max_concurrent_searches' - - $ref: '#/components/parameters/msearch_template::query.rest_total_hits_as_int' - - $ref: '#/components/parameters/msearch_template::query.search_type' - - $ref: '#/components/parameters/msearch_template::query.typed_keys' - - $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' + - $ref: '#/components/parameters/msearch_template___path.index' + - $ref: '#/components/parameters/msearch_template___query.ccs_minimize_roundtrips' + - $ref: '#/components/parameters/msearch_template___query.max_concurrent_searches' + - $ref: '#/components/parameters/msearch_template___query.rest_total_hits_as_int' + - $ref: '#/components/parameters/msearch_template___query.search_type' + - $ref: '#/components/parameters/msearch_template___query.typed_keys' + - $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/msearch_template' responses: '200': - $ref: '#/components/responses/msearch_template@200' + $ref: '#/components/responses/msearch_template___200' post: operationId: msearch_template.3 x-operation-group: msearch_template @@ -10666,22 +11160,22 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/search-plugins/search-template/ parameters: - - $ref: '#/components/parameters/msearch_template::path.index' - - $ref: '#/components/parameters/msearch_template::query.ccs_minimize_roundtrips' - - $ref: '#/components/parameters/msearch_template::query.max_concurrent_searches' - - $ref: '#/components/parameters/msearch_template::query.rest_total_hits_as_int' - - $ref: '#/components/parameters/msearch_template::query.search_type' - - $ref: '#/components/parameters/msearch_template::query.typed_keys' - - $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' + - $ref: '#/components/parameters/msearch_template___path.index' + - $ref: '#/components/parameters/msearch_template___query.ccs_minimize_roundtrips' + - $ref: '#/components/parameters/msearch_template___query.max_concurrent_searches' + - $ref: '#/components/parameters/msearch_template___query.rest_total_hits_as_int' + - $ref: '#/components/parameters/msearch_template___query.search_type' + - $ref: '#/components/parameters/msearch_template___query.typed_keys' + - $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/msearch_template' responses: '200': - $ref: '#/components/responses/msearch_template@200' + $ref: '#/components/responses/msearch_template___200' /{index}/_mtermvectors: get: operationId: mtermvectors.2 @@ -10691,29 +11185,29 @@ paths: externalDocs: url: https://opensearch.org/docs/latest parameters: - - $ref: '#/components/parameters/mtermvectors::path.index' - - $ref: '#/components/parameters/mtermvectors::query.field_statistics' - - $ref: '#/components/parameters/mtermvectors::query.fields' - - $ref: '#/components/parameters/mtermvectors::query.ids' - - $ref: '#/components/parameters/mtermvectors::query.offsets' - - $ref: '#/components/parameters/mtermvectors::query.payloads' - - $ref: '#/components/parameters/mtermvectors::query.positions' - - $ref: '#/components/parameters/mtermvectors::query.preference' - - $ref: '#/components/parameters/mtermvectors::query.realtime' - - $ref: '#/components/parameters/mtermvectors::query.routing' - - $ref: '#/components/parameters/mtermvectors::query.term_statistics' - - $ref: '#/components/parameters/mtermvectors::query.version' - - $ref: '#/components/parameters/mtermvectors::query.version_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' + - $ref: '#/components/parameters/mtermvectors___path.index' + - $ref: '#/components/parameters/mtermvectors___query.field_statistics' + - $ref: '#/components/parameters/mtermvectors___query.fields' + - $ref: '#/components/parameters/mtermvectors___query.ids' + - $ref: '#/components/parameters/mtermvectors___query.offsets' + - $ref: '#/components/parameters/mtermvectors___query.payloads' + - $ref: '#/components/parameters/mtermvectors___query.positions' + - $ref: '#/components/parameters/mtermvectors___query.preference' + - $ref: '#/components/parameters/mtermvectors___query.realtime' + - $ref: '#/components/parameters/mtermvectors___query.routing' + - $ref: '#/components/parameters/mtermvectors___query.term_statistics' + - $ref: '#/components/parameters/mtermvectors___query.version' + - $ref: '#/components/parameters/mtermvectors___query.version_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' requestBody: $ref: '#/components/requestBodies/mtermvectors' responses: '200': - $ref: '#/components/responses/mtermvectors@200' + $ref: '#/components/responses/mtermvectors___200' post: operationId: mtermvectors.3 x-operation-group: mtermvectors @@ -10722,29 +11216,29 @@ paths: externalDocs: url: https://opensearch.org/docs/latest parameters: - - $ref: '#/components/parameters/mtermvectors::path.index' - - $ref: '#/components/parameters/mtermvectors::query.field_statistics' - - $ref: '#/components/parameters/mtermvectors::query.fields' - - $ref: '#/components/parameters/mtermvectors::query.ids' - - $ref: '#/components/parameters/mtermvectors::query.offsets' - - $ref: '#/components/parameters/mtermvectors::query.payloads' - - $ref: '#/components/parameters/mtermvectors::query.positions' - - $ref: '#/components/parameters/mtermvectors::query.preference' - - $ref: '#/components/parameters/mtermvectors::query.realtime' - - $ref: '#/components/parameters/mtermvectors::query.routing' - - $ref: '#/components/parameters/mtermvectors::query.term_statistics' - - $ref: '#/components/parameters/mtermvectors::query.version' - - $ref: '#/components/parameters/mtermvectors::query.version_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' + - $ref: '#/components/parameters/mtermvectors___path.index' + - $ref: '#/components/parameters/mtermvectors___query.field_statistics' + - $ref: '#/components/parameters/mtermvectors___query.fields' + - $ref: '#/components/parameters/mtermvectors___query.ids' + - $ref: '#/components/parameters/mtermvectors___query.offsets' + - $ref: '#/components/parameters/mtermvectors___query.payloads' + - $ref: '#/components/parameters/mtermvectors___query.positions' + - $ref: '#/components/parameters/mtermvectors___query.preference' + - $ref: '#/components/parameters/mtermvectors___query.realtime' + - $ref: '#/components/parameters/mtermvectors___query.routing' + - $ref: '#/components/parameters/mtermvectors___query.term_statistics' + - $ref: '#/components/parameters/mtermvectors___query.version' + - $ref: '#/components/parameters/mtermvectors___query.version_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' requestBody: $ref: '#/components/requestBodies/mtermvectors' responses: '200': - $ref: '#/components/responses/mtermvectors@200' + $ref: '#/components/responses/mtermvectors___200' /{index}/_open: post: operationId: indices.open.0 @@ -10754,24 +11248,24 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/index-apis/open-index/ parameters: - - $ref: '#/components/parameters/indices.open::path.index' - - $ref: '#/components/parameters/indices.open::query.allow_no_indices' - - $ref: '#/components/parameters/indices.open::query.cluster_manager_timeout' - - $ref: '#/components/parameters/indices.open::query.expand_wildcards' - - $ref: '#/components/parameters/indices.open::query.ignore_unavailable' - - $ref: '#/components/parameters/indices.open::query.master_timeout' - - $ref: '#/components/parameters/indices.open::query.task_execution_timeout' - - $ref: '#/components/parameters/indices.open::query.timeout' - - $ref: '#/components/parameters/indices.open::query.wait_for_active_shards' - - $ref: '#/components/parameters/indices.open::query.wait_for_completion' - - $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/indices.open@200' + - $ref: '#/components/parameters/indices.open___path.index' + - $ref: '#/components/parameters/indices.open___query.allow_no_indices' + - $ref: '#/components/parameters/indices.open___query.cluster_manager_timeout' + - $ref: '#/components/parameters/indices.open___query.expand_wildcards' + - $ref: '#/components/parameters/indices.open___query.ignore_unavailable' + - $ref: '#/components/parameters/indices.open___query.master_timeout' + - $ref: '#/components/parameters/indices.open___query.task_execution_timeout' + - $ref: '#/components/parameters/indices.open___query.timeout' + - $ref: '#/components/parameters/indices.open___query.wait_for_active_shards' + - $ref: '#/components/parameters/indices.open___query.wait_for_completion' + - $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/indices.open___200' /{index}/_rank_eval: get: operationId: rank_eval.2 @@ -10781,21 +11275,21 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/rank-eval/ parameters: - - $ref: '#/components/parameters/rank_eval::path.index' - - $ref: '#/components/parameters/rank_eval::query.allow_no_indices' - - $ref: '#/components/parameters/rank_eval::query.expand_wildcards' - - $ref: '#/components/parameters/rank_eval::query.ignore_unavailable' - - $ref: '#/components/parameters/rank_eval::query.search_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' + - $ref: '#/components/parameters/rank_eval___path.index' + - $ref: '#/components/parameters/rank_eval___query.allow_no_indices' + - $ref: '#/components/parameters/rank_eval___query.expand_wildcards' + - $ref: '#/components/parameters/rank_eval___query.ignore_unavailable' + - $ref: '#/components/parameters/rank_eval___query.search_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' requestBody: $ref: '#/components/requestBodies/rank_eval' responses: '200': - $ref: '#/components/responses/rank_eval@200' + $ref: '#/components/responses/rank_eval___200' post: operationId: rank_eval.3 x-operation-group: rank_eval @@ -10804,21 +11298,21 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/rank-eval/ parameters: - - $ref: '#/components/parameters/rank_eval::path.index' - - $ref: '#/components/parameters/rank_eval::query.allow_no_indices' - - $ref: '#/components/parameters/rank_eval::query.expand_wildcards' - - $ref: '#/components/parameters/rank_eval::query.ignore_unavailable' - - $ref: '#/components/parameters/rank_eval::query.search_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' + - $ref: '#/components/parameters/rank_eval___path.index' + - $ref: '#/components/parameters/rank_eval___query.allow_no_indices' + - $ref: '#/components/parameters/rank_eval___query.expand_wildcards' + - $ref: '#/components/parameters/rank_eval___query.ignore_unavailable' + - $ref: '#/components/parameters/rank_eval___query.search_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' requestBody: $ref: '#/components/requestBodies/rank_eval' responses: '200': - $ref: '#/components/responses/rank_eval@200' + $ref: '#/components/responses/rank_eval___200' /{index}/_recovery: get: operationId: indices.recovery.1 @@ -10828,58 +11322,58 @@ paths: externalDocs: url: https://opensearch.org/docs/latest parameters: - - $ref: '#/components/parameters/indices.recovery::path.index' - - $ref: '#/components/parameters/indices.recovery::query.active_only' - - $ref: '#/components/parameters/indices.recovery::query.detailed' - - $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' + - $ref: '#/components/parameters/indices.recovery___path.index' + - $ref: '#/components/parameters/indices.recovery___query.active_only' + - $ref: '#/components/parameters/indices.recovery___query.detailed' + - $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/indices.recovery@200' + $ref: '#/components/responses/indices.recovery___200' /{index}/_refresh: get: operationId: indices.refresh.2 x-operation-group: indices.refresh x-version-added: '1.0' - description: Performs the refresh operation in one or more indices. + description: Performs the refresh operation in one or more indexes. externalDocs: url: https://opensearch.org/docs/latest/tuning-your-cluster/availability-and-recovery/remote-store/index/#refresh-level-and-request-level-durability parameters: - - $ref: '#/components/parameters/indices.refresh::path.index' - - $ref: '#/components/parameters/indices.refresh::query.allow_no_indices' - - $ref: '#/components/parameters/indices.refresh::query.expand_wildcards' - - $ref: '#/components/parameters/indices.refresh::query.ignore_unavailable' - - $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' + - $ref: '#/components/parameters/indices.refresh___path.index' + - $ref: '#/components/parameters/indices.refresh___query.allow_no_indices' + - $ref: '#/components/parameters/indices.refresh___query.expand_wildcards' + - $ref: '#/components/parameters/indices.refresh___query.ignore_unavailable' + - $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/indices.refresh@200' + $ref: '#/components/responses/indices.refresh___200' post: operationId: indices.refresh.3 x-operation-group: indices.refresh x-version-added: '1.0' - description: Performs the refresh operation in one or more indices. + description: Performs the refresh operation in one or more indexes. externalDocs: url: https://opensearch.org/docs/latest/tuning-your-cluster/availability-and-recovery/remote-store/index/#refresh-level-and-request-level-durability parameters: - - $ref: '#/components/parameters/indices.refresh::path.index' - - $ref: '#/components/parameters/indices.refresh::query.allow_no_indices' - - $ref: '#/components/parameters/indices.refresh::query.expand_wildcards' - - $ref: '#/components/parameters/indices.refresh::query.ignore_unavailable' - - $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' + - $ref: '#/components/parameters/indices.refresh___path.index' + - $ref: '#/components/parameters/indices.refresh___query.allow_no_indices' + - $ref: '#/components/parameters/indices.refresh___query.expand_wildcards' + - $ref: '#/components/parameters/indices.refresh___query.ignore_unavailable' + - $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/indices.refresh@200' + $ref: '#/components/responses/indices.refresh___200' /{index}/_search: get: operationId: search.2 @@ -10889,67 +11383,67 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/search/ parameters: - - $ref: '#/components/parameters/search::path.index' - - $ref: '#/components/parameters/search::query._source' - - $ref: '#/components/parameters/search::query._source_excludes' - - $ref: '#/components/parameters/search::query._source_includes' - - $ref: '#/components/parameters/search::query.allow_no_indices' - - $ref: '#/components/parameters/search::query.allow_partial_search_results' - - $ref: '#/components/parameters/search::query.analyze_wildcard' - - $ref: '#/components/parameters/search::query.analyzer' - - $ref: '#/components/parameters/search::query.batched_reduce_size' - - $ref: '#/components/parameters/search::query.cancel_after_time_interval' - - $ref: '#/components/parameters/search::query.ccs_minimize_roundtrips' - - $ref: '#/components/parameters/search::query.default_operator' - - $ref: '#/components/parameters/search::query.df' - - $ref: '#/components/parameters/search::query.docvalue_fields' - - $ref: '#/components/parameters/search::query.expand_wildcards' - - $ref: '#/components/parameters/search::query.explain' - - $ref: '#/components/parameters/search::query.from' - - $ref: '#/components/parameters/search::query.ignore_throttled' - - $ref: '#/components/parameters/search::query.ignore_unavailable' - - $ref: '#/components/parameters/search::query.include_named_queries_score' - - $ref: '#/components/parameters/search::query.lenient' - - $ref: '#/components/parameters/search::query.max_concurrent_shard_requests' - - $ref: '#/components/parameters/search::query.phase_took' - - $ref: '#/components/parameters/search::query.pre_filter_shard_size' - - $ref: '#/components/parameters/search::query.preference' - - $ref: '#/components/parameters/search::query.q' - - $ref: '#/components/parameters/search::query.request_cache' - - $ref: '#/components/parameters/search::query.rest_total_hits_as_int' - - $ref: '#/components/parameters/search::query.routing' - - $ref: '#/components/parameters/search::query.scroll' - - $ref: '#/components/parameters/search::query.search_pipeline' - - $ref: '#/components/parameters/search::query.search_type' - - $ref: '#/components/parameters/search::query.seq_no_primary_term' - - $ref: '#/components/parameters/search::query.size' - - $ref: '#/components/parameters/search::query.sort' - - $ref: '#/components/parameters/search::query.stats' - - $ref: '#/components/parameters/search::query.stored_fields' - - $ref: '#/components/parameters/search::query.suggest_field' - - $ref: '#/components/parameters/search::query.suggest_mode' - - $ref: '#/components/parameters/search::query.suggest_size' - - $ref: '#/components/parameters/search::query.suggest_text' - - $ref: '#/components/parameters/search::query.terminate_after' - - $ref: '#/components/parameters/search::query.timeout' - - $ref: '#/components/parameters/search::query.track_scores' - - $ref: '#/components/parameters/search::query.track_total_hits' - - $ref: '#/components/parameters/search::query.typed_keys' - - $ref: '#/components/parameters/search::query.version' - - $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' + - $ref: '#/components/parameters/search___path.index' + - $ref: '#/components/parameters/search___query._source' + - $ref: '#/components/parameters/search___query._source_excludes' + - $ref: '#/components/parameters/search___query._source_includes' + - $ref: '#/components/parameters/search___query.allow_no_indices' + - $ref: '#/components/parameters/search___query.allow_partial_search_results' + - $ref: '#/components/parameters/search___query.analyze_wildcard' + - $ref: '#/components/parameters/search___query.analyzer' + - $ref: '#/components/parameters/search___query.batched_reduce_size' + - $ref: '#/components/parameters/search___query.cancel_after_time_interval' + - $ref: '#/components/parameters/search___query.ccs_minimize_roundtrips' + - $ref: '#/components/parameters/search___query.default_operator' + - $ref: '#/components/parameters/search___query.df' + - $ref: '#/components/parameters/search___query.docvalue_fields' + - $ref: '#/components/parameters/search___query.expand_wildcards' + - $ref: '#/components/parameters/search___query.explain' + - $ref: '#/components/parameters/search___query.from' + - $ref: '#/components/parameters/search___query.ignore_throttled' + - $ref: '#/components/parameters/search___query.ignore_unavailable' + - $ref: '#/components/parameters/search___query.include_named_queries_score' + - $ref: '#/components/parameters/search___query.lenient' + - $ref: '#/components/parameters/search___query.max_concurrent_shard_requests' + - $ref: '#/components/parameters/search___query.phase_took' + - $ref: '#/components/parameters/search___query.pre_filter_shard_size' + - $ref: '#/components/parameters/search___query.preference' + - $ref: '#/components/parameters/search___query.q' + - $ref: '#/components/parameters/search___query.request_cache' + - $ref: '#/components/parameters/search___query.rest_total_hits_as_int' + - $ref: '#/components/parameters/search___query.routing' + - $ref: '#/components/parameters/search___query.scroll' + - $ref: '#/components/parameters/search___query.search_pipeline' + - $ref: '#/components/parameters/search___query.search_type' + - $ref: '#/components/parameters/search___query.seq_no_primary_term' + - $ref: '#/components/parameters/search___query.size' + - $ref: '#/components/parameters/search___query.sort' + - $ref: '#/components/parameters/search___query.stats' + - $ref: '#/components/parameters/search___query.stored_fields' + - $ref: '#/components/parameters/search___query.suggest_field' + - $ref: '#/components/parameters/search___query.suggest_mode' + - $ref: '#/components/parameters/search___query.suggest_size' + - $ref: '#/components/parameters/search___query.suggest_text' + - $ref: '#/components/parameters/search___query.terminate_after' + - $ref: '#/components/parameters/search___query.timeout' + - $ref: '#/components/parameters/search___query.track_scores' + - $ref: '#/components/parameters/search___query.track_total_hits' + - $ref: '#/components/parameters/search___query.typed_keys' + - $ref: '#/components/parameters/search___query.version' + - $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/search' responses: '200': - $ref: '#/components/responses/search@200' + $ref: '#/components/responses/search___200' '400': - $ref: '#/components/responses/search@400' + $ref: '#/components/responses/search___400' '404': - $ref: '#/components/responses/search@404' + $ref: '#/components/responses/search___404' post: operationId: search.3 x-operation-group: search @@ -10958,114 +11452,114 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/search/ parameters: - - $ref: '#/components/parameters/search::path.index' - - $ref: '#/components/parameters/search::query._source' - - $ref: '#/components/parameters/search::query._source_excludes' - - $ref: '#/components/parameters/search::query._source_includes' - - $ref: '#/components/parameters/search::query.allow_no_indices' - - $ref: '#/components/parameters/search::query.allow_partial_search_results' - - $ref: '#/components/parameters/search::query.analyze_wildcard' - - $ref: '#/components/parameters/search::query.analyzer' - - $ref: '#/components/parameters/search::query.batched_reduce_size' - - $ref: '#/components/parameters/search::query.cancel_after_time_interval' - - $ref: '#/components/parameters/search::query.ccs_minimize_roundtrips' - - $ref: '#/components/parameters/search::query.default_operator' - - $ref: '#/components/parameters/search::query.df' - - $ref: '#/components/parameters/search::query.docvalue_fields' - - $ref: '#/components/parameters/search::query.expand_wildcards' - - $ref: '#/components/parameters/search::query.explain' - - $ref: '#/components/parameters/search::query.from' - - $ref: '#/components/parameters/search::query.ignore_throttled' - - $ref: '#/components/parameters/search::query.ignore_unavailable' - - $ref: '#/components/parameters/search::query.include_named_queries_score' - - $ref: '#/components/parameters/search::query.lenient' - - $ref: '#/components/parameters/search::query.max_concurrent_shard_requests' - - $ref: '#/components/parameters/search::query.phase_took' - - $ref: '#/components/parameters/search::query.pre_filter_shard_size' - - $ref: '#/components/parameters/search::query.preference' - - $ref: '#/components/parameters/search::query.q' - - $ref: '#/components/parameters/search::query.request_cache' - - $ref: '#/components/parameters/search::query.rest_total_hits_as_int' - - $ref: '#/components/parameters/search::query.routing' - - $ref: '#/components/parameters/search::query.scroll' - - $ref: '#/components/parameters/search::query.search_pipeline' - - $ref: '#/components/parameters/search::query.search_type' - - $ref: '#/components/parameters/search::query.seq_no_primary_term' - - $ref: '#/components/parameters/search::query.size' - - $ref: '#/components/parameters/search::query.sort' - - $ref: '#/components/parameters/search::query.stats' - - $ref: '#/components/parameters/search::query.stored_fields' - - $ref: '#/components/parameters/search::query.suggest_field' - - $ref: '#/components/parameters/search::query.suggest_mode' - - $ref: '#/components/parameters/search::query.suggest_size' - - $ref: '#/components/parameters/search::query.suggest_text' - - $ref: '#/components/parameters/search::query.terminate_after' - - $ref: '#/components/parameters/search::query.timeout' - - $ref: '#/components/parameters/search::query.track_scores' - - $ref: '#/components/parameters/search::query.track_total_hits' - - $ref: '#/components/parameters/search::query.typed_keys' - - $ref: '#/components/parameters/search::query.version' - - $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' + - $ref: '#/components/parameters/search___path.index' + - $ref: '#/components/parameters/search___query._source' + - $ref: '#/components/parameters/search___query._source_excludes' + - $ref: '#/components/parameters/search___query._source_includes' + - $ref: '#/components/parameters/search___query.allow_no_indices' + - $ref: '#/components/parameters/search___query.allow_partial_search_results' + - $ref: '#/components/parameters/search___query.analyze_wildcard' + - $ref: '#/components/parameters/search___query.analyzer' + - $ref: '#/components/parameters/search___query.batched_reduce_size' + - $ref: '#/components/parameters/search___query.cancel_after_time_interval' + - $ref: '#/components/parameters/search___query.ccs_minimize_roundtrips' + - $ref: '#/components/parameters/search___query.default_operator' + - $ref: '#/components/parameters/search___query.df' + - $ref: '#/components/parameters/search___query.docvalue_fields' + - $ref: '#/components/parameters/search___query.expand_wildcards' + - $ref: '#/components/parameters/search___query.explain' + - $ref: '#/components/parameters/search___query.from' + - $ref: '#/components/parameters/search___query.ignore_throttled' + - $ref: '#/components/parameters/search___query.ignore_unavailable' + - $ref: '#/components/parameters/search___query.include_named_queries_score' + - $ref: '#/components/parameters/search___query.lenient' + - $ref: '#/components/parameters/search___query.max_concurrent_shard_requests' + - $ref: '#/components/parameters/search___query.phase_took' + - $ref: '#/components/parameters/search___query.pre_filter_shard_size' + - $ref: '#/components/parameters/search___query.preference' + - $ref: '#/components/parameters/search___query.q' + - $ref: '#/components/parameters/search___query.request_cache' + - $ref: '#/components/parameters/search___query.rest_total_hits_as_int' + - $ref: '#/components/parameters/search___query.routing' + - $ref: '#/components/parameters/search___query.scroll' + - $ref: '#/components/parameters/search___query.search_pipeline' + - $ref: '#/components/parameters/search___query.search_type' + - $ref: '#/components/parameters/search___query.seq_no_primary_term' + - $ref: '#/components/parameters/search___query.size' + - $ref: '#/components/parameters/search___query.sort' + - $ref: '#/components/parameters/search___query.stats' + - $ref: '#/components/parameters/search___query.stored_fields' + - $ref: '#/components/parameters/search___query.suggest_field' + - $ref: '#/components/parameters/search___query.suggest_mode' + - $ref: '#/components/parameters/search___query.suggest_size' + - $ref: '#/components/parameters/search___query.suggest_text' + - $ref: '#/components/parameters/search___query.terminate_after' + - $ref: '#/components/parameters/search___query.timeout' + - $ref: '#/components/parameters/search___query.track_scores' + - $ref: '#/components/parameters/search___query.track_total_hits' + - $ref: '#/components/parameters/search___query.typed_keys' + - $ref: '#/components/parameters/search___query.version' + - $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/search' responses: '200': - $ref: '#/components/responses/search@200' + $ref: '#/components/responses/search___200' '400': - $ref: '#/components/responses/search@400' + $ref: '#/components/responses/search___400' '404': - $ref: '#/components/responses/search@404' + $ref: '#/components/responses/search___404' /{index}/_search_shards: get: operationId: search_shards.2 x-operation-group: search_shards x-version-added: '1.0' - description: Returns information about the indices and shards that a search request would be executed against. + description: Returns information about the indexes and shards that a search request would be executed against. externalDocs: url: https://opensearch.org/docs/latest parameters: - - $ref: '#/components/parameters/search_shards::path.index' - - $ref: '#/components/parameters/search_shards::query.allow_no_indices' - - $ref: '#/components/parameters/search_shards::query.expand_wildcards' - - $ref: '#/components/parameters/search_shards::query.ignore_unavailable' - - $ref: '#/components/parameters/search_shards::query.local' - - $ref: '#/components/parameters/search_shards::query.preference' - - $ref: '#/components/parameters/search_shards::query.routing' - - $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/search_shards@200' + - $ref: '#/components/parameters/search_shards___path.index' + - $ref: '#/components/parameters/search_shards___query.allow_no_indices' + - $ref: '#/components/parameters/search_shards___query.expand_wildcards' + - $ref: '#/components/parameters/search_shards___query.ignore_unavailable' + - $ref: '#/components/parameters/search_shards___query.local' + - $ref: '#/components/parameters/search_shards___query.preference' + - $ref: '#/components/parameters/search_shards___query.routing' + - $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/search_shards___200' post: operationId: search_shards.3 x-operation-group: search_shards x-version-added: '1.0' - description: Returns information about the indices and shards that a search request would be executed against. + description: Returns information about the indexes and shards that a search request would be executed against. externalDocs: url: https://opensearch.org/docs/latest parameters: - - $ref: '#/components/parameters/search_shards::path.index' - - $ref: '#/components/parameters/search_shards::query.allow_no_indices' - - $ref: '#/components/parameters/search_shards::query.expand_wildcards' - - $ref: '#/components/parameters/search_shards::query.ignore_unavailable' - - $ref: '#/components/parameters/search_shards::query.local' - - $ref: '#/components/parameters/search_shards::query.preference' - - $ref: '#/components/parameters/search_shards::query.routing' - - $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/search_shards@200' + - $ref: '#/components/parameters/search_shards___path.index' + - $ref: '#/components/parameters/search_shards___query.allow_no_indices' + - $ref: '#/components/parameters/search_shards___query.expand_wildcards' + - $ref: '#/components/parameters/search_shards___query.ignore_unavailable' + - $ref: '#/components/parameters/search_shards___query.local' + - $ref: '#/components/parameters/search_shards___query.preference' + - $ref: '#/components/parameters/search_shards___query.routing' + - $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/search_shards___200' /{index}/_search/point_in_time: post: operationId: create_pit.0 @@ -11075,20 +11569,20 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/search-plugins/point-in-time-api/#create-a-pit parameters: - - $ref: '#/components/parameters/create_pit::path.index' - - $ref: '#/components/parameters/create_pit::query.allow_partial_pit_creation' - - $ref: '#/components/parameters/create_pit::query.expand_wildcards' - - $ref: '#/components/parameters/create_pit::query.keep_alive' - - $ref: '#/components/parameters/create_pit::query.preference' - - $ref: '#/components/parameters/create_pit::query.routing' - - $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' + - $ref: '#/components/parameters/create_pit___path.index' + - $ref: '#/components/parameters/create_pit___query.allow_partial_pit_creation' + - $ref: '#/components/parameters/create_pit___query.expand_wildcards' + - $ref: '#/components/parameters/create_pit___query.keep_alive' + - $ref: '#/components/parameters/create_pit___query.preference' + - $ref: '#/components/parameters/create_pit___query.routing' + - $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/create_pit@200' + $ref: '#/components/responses/create_pit___200' /{index}/_search/template: get: operationId: search_template.2 @@ -11098,30 +11592,30 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/search-plugins/search-template/ parameters: - - $ref: '#/components/parameters/search_template::path.index' - - $ref: '#/components/parameters/search_template::query.allow_no_indices' - - $ref: '#/components/parameters/search_template::query.ccs_minimize_roundtrips' - - $ref: '#/components/parameters/search_template::query.expand_wildcards' - - $ref: '#/components/parameters/search_template::query.explain' - - $ref: '#/components/parameters/search_template::query.ignore_throttled' - - $ref: '#/components/parameters/search_template::query.ignore_unavailable' - - $ref: '#/components/parameters/search_template::query.preference' - - $ref: '#/components/parameters/search_template::query.profile' - - $ref: '#/components/parameters/search_template::query.rest_total_hits_as_int' - - $ref: '#/components/parameters/search_template::query.routing' - - $ref: '#/components/parameters/search_template::query.scroll' - - $ref: '#/components/parameters/search_template::query.search_type' - - $ref: '#/components/parameters/search_template::query.typed_keys' - - $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' + - $ref: '#/components/parameters/search_template___path.index' + - $ref: '#/components/parameters/search_template___query.allow_no_indices' + - $ref: '#/components/parameters/search_template___query.ccs_minimize_roundtrips' + - $ref: '#/components/parameters/search_template___query.expand_wildcards' + - $ref: '#/components/parameters/search_template___query.explain' + - $ref: '#/components/parameters/search_template___query.ignore_throttled' + - $ref: '#/components/parameters/search_template___query.ignore_unavailable' + - $ref: '#/components/parameters/search_template___query.preference' + - $ref: '#/components/parameters/search_template___query.profile' + - $ref: '#/components/parameters/search_template___query.rest_total_hits_as_int' + - $ref: '#/components/parameters/search_template___query.routing' + - $ref: '#/components/parameters/search_template___query.scroll' + - $ref: '#/components/parameters/search_template___query.search_type' + - $ref: '#/components/parameters/search_template___query.typed_keys' + - $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/search_template' responses: '200': - $ref: '#/components/responses/search_template@200' + $ref: '#/components/responses/search_template___200' post: operationId: search_template.3 x-operation-group: search_template @@ -11130,30 +11624,30 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/search-plugins/search-template/ parameters: - - $ref: '#/components/parameters/search_template::path.index' - - $ref: '#/components/parameters/search_template::query.allow_no_indices' - - $ref: '#/components/parameters/search_template::query.ccs_minimize_roundtrips' - - $ref: '#/components/parameters/search_template::query.expand_wildcards' - - $ref: '#/components/parameters/search_template::query.explain' - - $ref: '#/components/parameters/search_template::query.ignore_throttled' - - $ref: '#/components/parameters/search_template::query.ignore_unavailable' - - $ref: '#/components/parameters/search_template::query.preference' - - $ref: '#/components/parameters/search_template::query.profile' - - $ref: '#/components/parameters/search_template::query.rest_total_hits_as_int' - - $ref: '#/components/parameters/search_template::query.routing' - - $ref: '#/components/parameters/search_template::query.scroll' - - $ref: '#/components/parameters/search_template::query.search_type' - - $ref: '#/components/parameters/search_template::query.typed_keys' - - $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' + - $ref: '#/components/parameters/search_template___path.index' + - $ref: '#/components/parameters/search_template___query.allow_no_indices' + - $ref: '#/components/parameters/search_template___query.ccs_minimize_roundtrips' + - $ref: '#/components/parameters/search_template___query.expand_wildcards' + - $ref: '#/components/parameters/search_template___query.explain' + - $ref: '#/components/parameters/search_template___query.ignore_throttled' + - $ref: '#/components/parameters/search_template___query.ignore_unavailable' + - $ref: '#/components/parameters/search_template___query.preference' + - $ref: '#/components/parameters/search_template___query.profile' + - $ref: '#/components/parameters/search_template___query.rest_total_hits_as_int' + - $ref: '#/components/parameters/search_template___query.routing' + - $ref: '#/components/parameters/search_template___query.scroll' + - $ref: '#/components/parameters/search_template___query.search_type' + - $ref: '#/components/parameters/search_template___query.typed_keys' + - $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/search_template' responses: '200': - $ref: '#/components/responses/search_template@200' + $ref: '#/components/responses/search_template___200' /{index}/_segments: get: operationId: indices.segments.1 @@ -11166,45 +11660,45 @@ paths: externalDocs: url: https://opensearch.org/docs/latest parameters: - - $ref: '#/components/parameters/indices.segments::path.index' - - $ref: '#/components/parameters/indices.segments::query.allow_no_indices' - - $ref: '#/components/parameters/indices.segments::query.expand_wildcards' - - $ref: '#/components/parameters/indices.segments::query.ignore_unavailable' - - $ref: '#/components/parameters/indices.segments::query.verbose' - - $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' + - $ref: '#/components/parameters/indices.segments___path.index' + - $ref: '#/components/parameters/indices.segments___query.allow_no_indices' + - $ref: '#/components/parameters/indices.segments___query.expand_wildcards' + - $ref: '#/components/parameters/indices.segments___query.ignore_unavailable' + - $ref: '#/components/parameters/indices.segments___query.verbose' + - $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/indices.segments@200' + $ref: '#/components/responses/indices.segments___200' /{index}/_settings: get: operationId: indices.get_settings.2 x-operation-group: indices.get_settings x-version-added: '1.0' - description: Returns settings for one or more indices. + description: Returns settings for one or more indexes. externalDocs: url: https://opensearch.org/docs/latest/api-reference/index-apis/get-settings/ parameters: - - $ref: '#/components/parameters/indices.get_settings::path.index' - - $ref: '#/components/parameters/indices.get_settings::query.allow_no_indices' - - $ref: '#/components/parameters/indices.get_settings::query.cluster_manager_timeout' - - $ref: '#/components/parameters/indices.get_settings::query.expand_wildcards' - - $ref: '#/components/parameters/indices.get_settings::query.flat_settings' - - $ref: '#/components/parameters/indices.get_settings::query.ignore_unavailable' - - $ref: '#/components/parameters/indices.get_settings::query.include_defaults' - - $ref: '#/components/parameters/indices.get_settings::query.local' - - $ref: '#/components/parameters/indices.get_settings::query.master_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/indices.get_settings@200' + - $ref: '#/components/parameters/indices.get_settings___path.index' + - $ref: '#/components/parameters/indices.get_settings___query.allow_no_indices' + - $ref: '#/components/parameters/indices.get_settings___query.cluster_manager_timeout' + - $ref: '#/components/parameters/indices.get_settings___query.expand_wildcards' + - $ref: '#/components/parameters/indices.get_settings___query.flat_settings' + - $ref: '#/components/parameters/indices.get_settings___query.ignore_unavailable' + - $ref: '#/components/parameters/indices.get_settings___query.include_defaults' + - $ref: '#/components/parameters/indices.get_settings___query.local' + - $ref: '#/components/parameters/indices.get_settings___query.master_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/indices.get_settings___200' put: operationId: indices.put_settings.1 x-operation-group: indices.put_settings @@ -11213,74 +11707,74 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/index-apis/update-settings/ parameters: - - $ref: '#/components/parameters/indices.put_settings::path.index' - - $ref: '#/components/parameters/indices.put_settings::query.allow_no_indices' - - $ref: '#/components/parameters/indices.put_settings::query.cluster_manager_timeout' - - $ref: '#/components/parameters/indices.put_settings::query.expand_wildcards' - - $ref: '#/components/parameters/indices.put_settings::query.flat_settings' - - $ref: '#/components/parameters/indices.put_settings::query.ignore_unavailable' - - $ref: '#/components/parameters/indices.put_settings::query.master_timeout' - - $ref: '#/components/parameters/indices.put_settings::query.preserve_existing' - - $ref: '#/components/parameters/indices.put_settings::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' + - $ref: '#/components/parameters/indices.put_settings___path.index' + - $ref: '#/components/parameters/indices.put_settings___query.allow_no_indices' + - $ref: '#/components/parameters/indices.put_settings___query.cluster_manager_timeout' + - $ref: '#/components/parameters/indices.put_settings___query.expand_wildcards' + - $ref: '#/components/parameters/indices.put_settings___query.flat_settings' + - $ref: '#/components/parameters/indices.put_settings___query.ignore_unavailable' + - $ref: '#/components/parameters/indices.put_settings___query.master_timeout' + - $ref: '#/components/parameters/indices.put_settings___query.preserve_existing' + - $ref: '#/components/parameters/indices.put_settings___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' requestBody: $ref: '#/components/requestBodies/indices.put_settings' responses: '200': - $ref: '#/components/responses/indices.put_settings@200' + $ref: '#/components/responses/indices.put_settings___200' /{index}/_settings/{name}: get: operationId: indices.get_settings.3 x-operation-group: indices.get_settings x-version-added: '1.0' - description: Returns settings for one or more indices. + description: Returns settings for one or more indexes. externalDocs: url: https://opensearch.org/docs/latest/api-reference/index-apis/get-settings/ parameters: - - $ref: '#/components/parameters/indices.get_settings::path.index' - - $ref: '#/components/parameters/indices.get_settings::path.name' - - $ref: '#/components/parameters/indices.get_settings::query.allow_no_indices' - - $ref: '#/components/parameters/indices.get_settings::query.cluster_manager_timeout' - - $ref: '#/components/parameters/indices.get_settings::query.expand_wildcards' - - $ref: '#/components/parameters/indices.get_settings::query.flat_settings' - - $ref: '#/components/parameters/indices.get_settings::query.ignore_unavailable' - - $ref: '#/components/parameters/indices.get_settings::query.include_defaults' - - $ref: '#/components/parameters/indices.get_settings::query.local' - - $ref: '#/components/parameters/indices.get_settings::query.master_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/indices.get_settings@200' + - $ref: '#/components/parameters/indices.get_settings___path.index' + - $ref: '#/components/parameters/indices.get_settings___path.name' + - $ref: '#/components/parameters/indices.get_settings___query.allow_no_indices' + - $ref: '#/components/parameters/indices.get_settings___query.cluster_manager_timeout' + - $ref: '#/components/parameters/indices.get_settings___query.expand_wildcards' + - $ref: '#/components/parameters/indices.get_settings___query.flat_settings' + - $ref: '#/components/parameters/indices.get_settings___query.ignore_unavailable' + - $ref: '#/components/parameters/indices.get_settings___query.include_defaults' + - $ref: '#/components/parameters/indices.get_settings___query.local' + - $ref: '#/components/parameters/indices.get_settings___query.master_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/indices.get_settings___200' /{index}/_shard_stores: get: operationId: indices.shard_stores.1 x-operation-group: indices.shard_stores x-version-added: '1.0' - description: Provides store information for shard copies of indices. + description: Provides store information for shard copies of indexes. externalDocs: url: https://opensearch.org/docs/latest parameters: - - $ref: '#/components/parameters/indices.shard_stores::path.index' - - $ref: '#/components/parameters/indices.shard_stores::query.allow_no_indices' - - $ref: '#/components/parameters/indices.shard_stores::query.expand_wildcards' - - $ref: '#/components/parameters/indices.shard_stores::query.ignore_unavailable' - - $ref: '#/components/parameters/indices.shard_stores::query.status' - - $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' + - $ref: '#/components/parameters/indices.shard_stores___path.index' + - $ref: '#/components/parameters/indices.shard_stores___query.allow_no_indices' + - $ref: '#/components/parameters/indices.shard_stores___query.expand_wildcards' + - $ref: '#/components/parameters/indices.shard_stores___query.ignore_unavailable' + - $ref: '#/components/parameters/indices.shard_stores___query.status' + - $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/indices.shard_stores@200' + $ref: '#/components/responses/indices.shard_stores___200' /{index}/_shrink/{target}: post: operationId: indices.shrink.0 @@ -11290,25 +11784,25 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/index-apis/shrink-index/ parameters: - - $ref: '#/components/parameters/indices.shrink::path.index' - - $ref: '#/components/parameters/indices.shrink::path.target' - - $ref: '#/components/parameters/indices.shrink::query.cluster_manager_timeout' - - $ref: '#/components/parameters/indices.shrink::query.copy_settings' - - $ref: '#/components/parameters/indices.shrink::query.master_timeout' - - $ref: '#/components/parameters/indices.shrink::query.task_execution_timeout' - - $ref: '#/components/parameters/indices.shrink::query.timeout' - - $ref: '#/components/parameters/indices.shrink::query.wait_for_active_shards' - - $ref: '#/components/parameters/indices.shrink::query.wait_for_completion' - - $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' + - $ref: '#/components/parameters/indices.shrink___path.index' + - $ref: '#/components/parameters/indices.shrink___path.target' + - $ref: '#/components/parameters/indices.shrink___query.cluster_manager_timeout' + - $ref: '#/components/parameters/indices.shrink___query.copy_settings' + - $ref: '#/components/parameters/indices.shrink___query.master_timeout' + - $ref: '#/components/parameters/indices.shrink___query.task_execution_timeout' + - $ref: '#/components/parameters/indices.shrink___query.timeout' + - $ref: '#/components/parameters/indices.shrink___query.wait_for_active_shards' + - $ref: '#/components/parameters/indices.shrink___query.wait_for_completion' + - $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/indices.shrink' responses: '200': - $ref: '#/components/responses/indices.shrink@200' + $ref: '#/components/responses/indices.shrink___200' put: operationId: indices.shrink.1 x-operation-group: indices.shrink @@ -11317,25 +11811,25 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/index-apis/shrink-index/ parameters: - - $ref: '#/components/parameters/indices.shrink::path.index' - - $ref: '#/components/parameters/indices.shrink::path.target' - - $ref: '#/components/parameters/indices.shrink::query.cluster_manager_timeout' - - $ref: '#/components/parameters/indices.shrink::query.copy_settings' - - $ref: '#/components/parameters/indices.shrink::query.master_timeout' - - $ref: '#/components/parameters/indices.shrink::query.task_execution_timeout' - - $ref: '#/components/parameters/indices.shrink::query.timeout' - - $ref: '#/components/parameters/indices.shrink::query.wait_for_active_shards' - - $ref: '#/components/parameters/indices.shrink::query.wait_for_completion' - - $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' + - $ref: '#/components/parameters/indices.shrink___path.index' + - $ref: '#/components/parameters/indices.shrink___path.target' + - $ref: '#/components/parameters/indices.shrink___query.cluster_manager_timeout' + - $ref: '#/components/parameters/indices.shrink___query.copy_settings' + - $ref: '#/components/parameters/indices.shrink___query.master_timeout' + - $ref: '#/components/parameters/indices.shrink___query.task_execution_timeout' + - $ref: '#/components/parameters/indices.shrink___query.timeout' + - $ref: '#/components/parameters/indices.shrink___query.wait_for_active_shards' + - $ref: '#/components/parameters/indices.shrink___query.wait_for_completion' + - $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/indices.shrink' responses: '200': - $ref: '#/components/responses/indices.shrink@200' + $ref: '#/components/responses/indices.shrink___200' /{index}/_source/{id}: get: operationId: get_source.0 @@ -11345,25 +11839,27 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/document-apis/get-documents/ parameters: - - $ref: '#/components/parameters/get_source::path.id' - - $ref: '#/components/parameters/get_source::path.index' - - $ref: '#/components/parameters/get_source::query._source' - - $ref: '#/components/parameters/get_source::query._source_excludes' - - $ref: '#/components/parameters/get_source::query._source_includes' - - $ref: '#/components/parameters/get_source::query.preference' - - $ref: '#/components/parameters/get_source::query.realtime' - - $ref: '#/components/parameters/get_source::query.refresh' - - $ref: '#/components/parameters/get_source::query.routing' - - $ref: '#/components/parameters/get_source::query.version' - - $ref: '#/components/parameters/get_source::query.version_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/get_source@200' + - $ref: '#/components/parameters/get_source___path.id' + - $ref: '#/components/parameters/get_source___path.index' + - $ref: '#/components/parameters/get_source___query._source' + - $ref: '#/components/parameters/get_source___query._source_excludes' + - $ref: '#/components/parameters/get_source___query._source_includes' + - $ref: '#/components/parameters/get_source___query.preference' + - $ref: '#/components/parameters/get_source___query.realtime' + - $ref: '#/components/parameters/get_source___query.refresh' + - $ref: '#/components/parameters/get_source___query.routing' + - $ref: '#/components/parameters/get_source___query.version' + - $ref: '#/components/parameters/get_source___query.version_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/get_source___200' + '404': + $ref: '#/components/responses/get_source___404' head: operationId: exists_source.0 x-operation-group: exists_source @@ -11372,25 +11868,27 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/document-apis/get-documents/ parameters: - - $ref: '#/components/parameters/exists_source::path.id' - - $ref: '#/components/parameters/exists_source::path.index' - - $ref: '#/components/parameters/exists_source::query._source' - - $ref: '#/components/parameters/exists_source::query._source_excludes' - - $ref: '#/components/parameters/exists_source::query._source_includes' - - $ref: '#/components/parameters/exists_source::query.preference' - - $ref: '#/components/parameters/exists_source::query.realtime' - - $ref: '#/components/parameters/exists_source::query.refresh' - - $ref: '#/components/parameters/exists_source::query.routing' - - $ref: '#/components/parameters/exists_source::query.version' - - $ref: '#/components/parameters/exists_source::query.version_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/exists_source@200' + - $ref: '#/components/parameters/exists_source___path.id' + - $ref: '#/components/parameters/exists_source___path.index' + - $ref: '#/components/parameters/exists_source___query._source' + - $ref: '#/components/parameters/exists_source___query._source_excludes' + - $ref: '#/components/parameters/exists_source___query._source_includes' + - $ref: '#/components/parameters/exists_source___query.preference' + - $ref: '#/components/parameters/exists_source___query.realtime' + - $ref: '#/components/parameters/exists_source___query.refresh' + - $ref: '#/components/parameters/exists_source___query.routing' + - $ref: '#/components/parameters/exists_source___query.version' + - $ref: '#/components/parameters/exists_source___query.version_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/exists_source___200' + '404': + $ref: '#/components/responses/exists_source___404' /{index}/_split/{target}: post: operationId: indices.split.0 @@ -11400,25 +11898,25 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/index-apis/split/ parameters: - - $ref: '#/components/parameters/indices.split::path.index' - - $ref: '#/components/parameters/indices.split::path.target' - - $ref: '#/components/parameters/indices.split::query.cluster_manager_timeout' - - $ref: '#/components/parameters/indices.split::query.copy_settings' - - $ref: '#/components/parameters/indices.split::query.master_timeout' - - $ref: '#/components/parameters/indices.split::query.task_execution_timeout' - - $ref: '#/components/parameters/indices.split::query.timeout' - - $ref: '#/components/parameters/indices.split::query.wait_for_active_shards' - - $ref: '#/components/parameters/indices.split::query.wait_for_completion' - - $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' + - $ref: '#/components/parameters/indices.split___path.index' + - $ref: '#/components/parameters/indices.split___path.target' + - $ref: '#/components/parameters/indices.split___query.cluster_manager_timeout' + - $ref: '#/components/parameters/indices.split___query.copy_settings' + - $ref: '#/components/parameters/indices.split___query.master_timeout' + - $ref: '#/components/parameters/indices.split___query.task_execution_timeout' + - $ref: '#/components/parameters/indices.split___query.timeout' + - $ref: '#/components/parameters/indices.split___query.wait_for_active_shards' + - $ref: '#/components/parameters/indices.split___query.wait_for_completion' + - $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/indices.split' responses: '200': - $ref: '#/components/responses/indices.split@200' + $ref: '#/components/responses/indices.split___200' put: operationId: indices.split.1 x-operation-group: indices.split @@ -11427,25 +11925,25 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/index-apis/split/ parameters: - - $ref: '#/components/parameters/indices.split::path.index' - - $ref: '#/components/parameters/indices.split::path.target' - - $ref: '#/components/parameters/indices.split::query.cluster_manager_timeout' - - $ref: '#/components/parameters/indices.split::query.copy_settings' - - $ref: '#/components/parameters/indices.split::query.master_timeout' - - $ref: '#/components/parameters/indices.split::query.task_execution_timeout' - - $ref: '#/components/parameters/indices.split::query.timeout' - - $ref: '#/components/parameters/indices.split::query.wait_for_active_shards' - - $ref: '#/components/parameters/indices.split::query.wait_for_completion' - - $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' + - $ref: '#/components/parameters/indices.split___path.index' + - $ref: '#/components/parameters/indices.split___path.target' + - $ref: '#/components/parameters/indices.split___query.cluster_manager_timeout' + - $ref: '#/components/parameters/indices.split___query.copy_settings' + - $ref: '#/components/parameters/indices.split___query.master_timeout' + - $ref: '#/components/parameters/indices.split___query.task_execution_timeout' + - $ref: '#/components/parameters/indices.split___query.timeout' + - $ref: '#/components/parameters/indices.split___query.wait_for_active_shards' + - $ref: '#/components/parameters/indices.split___query.wait_for_completion' + - $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/indices.split' responses: '200': - $ref: '#/components/responses/indices.split@200' + $ref: '#/components/responses/indices.split___200' /{index}/_stats: get: operationId: indices.stats.2 @@ -11455,24 +11953,24 @@ paths: externalDocs: url: https://opensearch.org/docs/latest parameters: - - $ref: '#/components/parameters/indices.stats::path.index' - - $ref: '#/components/parameters/indices.stats::query.completion_fields' - - $ref: '#/components/parameters/indices.stats::query.expand_wildcards' - - $ref: '#/components/parameters/indices.stats::query.fielddata_fields' - - $ref: '#/components/parameters/indices.stats::query.fields' - - $ref: '#/components/parameters/indices.stats::query.forbid_closed_indices' - - $ref: '#/components/parameters/indices.stats::query.groups' - - $ref: '#/components/parameters/indices.stats::query.include_segment_file_sizes' - - $ref: '#/components/parameters/indices.stats::query.include_unloaded_segments' - - $ref: '#/components/parameters/indices.stats::query.level' - - $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/indices.stats@200' + - $ref: '#/components/parameters/indices.stats___path.index' + - $ref: '#/components/parameters/indices.stats___query.completion_fields' + - $ref: '#/components/parameters/indices.stats___query.expand_wildcards' + - $ref: '#/components/parameters/indices.stats___query.fielddata_fields' + - $ref: '#/components/parameters/indices.stats___query.fields' + - $ref: '#/components/parameters/indices.stats___query.forbid_closed_indices' + - $ref: '#/components/parameters/indices.stats___query.groups' + - $ref: '#/components/parameters/indices.stats___query.include_segment_file_sizes' + - $ref: '#/components/parameters/indices.stats___query.include_unloaded_segments' + - $ref: '#/components/parameters/indices.stats___query.level' + - $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/indices.stats___200' /{index}/_stats/{metric}: get: operationId: indices.stats.3 @@ -11482,25 +11980,25 @@ paths: externalDocs: url: https://opensearch.org/docs/latest parameters: - - $ref: '#/components/parameters/indices.stats::path.index' - - $ref: '#/components/parameters/indices.stats::path.metric' - - $ref: '#/components/parameters/indices.stats::query.completion_fields' - - $ref: '#/components/parameters/indices.stats::query.expand_wildcards' - - $ref: '#/components/parameters/indices.stats::query.fielddata_fields' - - $ref: '#/components/parameters/indices.stats::query.fields' - - $ref: '#/components/parameters/indices.stats::query.forbid_closed_indices' - - $ref: '#/components/parameters/indices.stats::query.groups' - - $ref: '#/components/parameters/indices.stats::query.include_segment_file_sizes' - - $ref: '#/components/parameters/indices.stats::query.include_unloaded_segments' - - $ref: '#/components/parameters/indices.stats::query.level' - - $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/indices.stats@200' + - $ref: '#/components/parameters/indices.stats___path.index' + - $ref: '#/components/parameters/indices.stats___path.metric' + - $ref: '#/components/parameters/indices.stats___query.completion_fields' + - $ref: '#/components/parameters/indices.stats___query.expand_wildcards' + - $ref: '#/components/parameters/indices.stats___query.fielddata_fields' + - $ref: '#/components/parameters/indices.stats___query.fields' + - $ref: '#/components/parameters/indices.stats___query.forbid_closed_indices' + - $ref: '#/components/parameters/indices.stats___query.groups' + - $ref: '#/components/parameters/indices.stats___query.include_segment_file_sizes' + - $ref: '#/components/parameters/indices.stats___query.include_unloaded_segments' + - $ref: '#/components/parameters/indices.stats___query.level' + - $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/indices.stats___200' /{index}/_termvectors: get: operationId: termvectors.0 @@ -11510,28 +12008,28 @@ paths: externalDocs: url: https://opensearch.org/docs/latest parameters: - - $ref: '#/components/parameters/termvectors::path.index' - - $ref: '#/components/parameters/termvectors::query.field_statistics' - - $ref: '#/components/parameters/termvectors::query.fields' - - $ref: '#/components/parameters/termvectors::query.offsets' - - $ref: '#/components/parameters/termvectors::query.payloads' - - $ref: '#/components/parameters/termvectors::query.positions' - - $ref: '#/components/parameters/termvectors::query.preference' - - $ref: '#/components/parameters/termvectors::query.realtime' - - $ref: '#/components/parameters/termvectors::query.routing' - - $ref: '#/components/parameters/termvectors::query.term_statistics' - - $ref: '#/components/parameters/termvectors::query.version' - - $ref: '#/components/parameters/termvectors::query.version_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' + - $ref: '#/components/parameters/termvectors___path.index' + - $ref: '#/components/parameters/termvectors___query.field_statistics' + - $ref: '#/components/parameters/termvectors___query.fields' + - $ref: '#/components/parameters/termvectors___query.offsets' + - $ref: '#/components/parameters/termvectors___query.payloads' + - $ref: '#/components/parameters/termvectors___query.positions' + - $ref: '#/components/parameters/termvectors___query.preference' + - $ref: '#/components/parameters/termvectors___query.realtime' + - $ref: '#/components/parameters/termvectors___query.routing' + - $ref: '#/components/parameters/termvectors___query.term_statistics' + - $ref: '#/components/parameters/termvectors___query.version' + - $ref: '#/components/parameters/termvectors___query.version_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' requestBody: $ref: '#/components/requestBodies/termvectors' responses: '200': - $ref: '#/components/responses/termvectors@200' + $ref: '#/components/responses/termvectors___200' post: operationId: termvectors.1 x-operation-group: termvectors @@ -11540,28 +12038,28 @@ paths: externalDocs: url: https://opensearch.org/docs/latest parameters: - - $ref: '#/components/parameters/termvectors::path.index' - - $ref: '#/components/parameters/termvectors::query.field_statistics' - - $ref: '#/components/parameters/termvectors::query.fields' - - $ref: '#/components/parameters/termvectors::query.offsets' - - $ref: '#/components/parameters/termvectors::query.payloads' - - $ref: '#/components/parameters/termvectors::query.positions' - - $ref: '#/components/parameters/termvectors::query.preference' - - $ref: '#/components/parameters/termvectors::query.realtime' - - $ref: '#/components/parameters/termvectors::query.routing' - - $ref: '#/components/parameters/termvectors::query.term_statistics' - - $ref: '#/components/parameters/termvectors::query.version' - - $ref: '#/components/parameters/termvectors::query.version_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' + - $ref: '#/components/parameters/termvectors___path.index' + - $ref: '#/components/parameters/termvectors___query.field_statistics' + - $ref: '#/components/parameters/termvectors___query.fields' + - $ref: '#/components/parameters/termvectors___query.offsets' + - $ref: '#/components/parameters/termvectors___query.payloads' + - $ref: '#/components/parameters/termvectors___query.positions' + - $ref: '#/components/parameters/termvectors___query.preference' + - $ref: '#/components/parameters/termvectors___query.realtime' + - $ref: '#/components/parameters/termvectors___query.routing' + - $ref: '#/components/parameters/termvectors___query.term_statistics' + - $ref: '#/components/parameters/termvectors___query.version' + - $ref: '#/components/parameters/termvectors___query.version_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' requestBody: $ref: '#/components/requestBodies/termvectors' responses: '200': - $ref: '#/components/responses/termvectors@200' + $ref: '#/components/responses/termvectors___200' /{index}/_termvectors/{id}: get: operationId: termvectors.2 @@ -11571,29 +12069,29 @@ paths: externalDocs: url: https://opensearch.org/docs/latest parameters: - - $ref: '#/components/parameters/termvectors::path.id' - - $ref: '#/components/parameters/termvectors::path.index' - - $ref: '#/components/parameters/termvectors::query.field_statistics' - - $ref: '#/components/parameters/termvectors::query.fields' - - $ref: '#/components/parameters/termvectors::query.offsets' - - $ref: '#/components/parameters/termvectors::query.payloads' - - $ref: '#/components/parameters/termvectors::query.positions' - - $ref: '#/components/parameters/termvectors::query.preference' - - $ref: '#/components/parameters/termvectors::query.realtime' - - $ref: '#/components/parameters/termvectors::query.routing' - - $ref: '#/components/parameters/termvectors::query.term_statistics' - - $ref: '#/components/parameters/termvectors::query.version' - - $ref: '#/components/parameters/termvectors::query.version_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' + - $ref: '#/components/parameters/termvectors___path.id' + - $ref: '#/components/parameters/termvectors___path.index' + - $ref: '#/components/parameters/termvectors___query.field_statistics' + - $ref: '#/components/parameters/termvectors___query.fields' + - $ref: '#/components/parameters/termvectors___query.offsets' + - $ref: '#/components/parameters/termvectors___query.payloads' + - $ref: '#/components/parameters/termvectors___query.positions' + - $ref: '#/components/parameters/termvectors___query.preference' + - $ref: '#/components/parameters/termvectors___query.realtime' + - $ref: '#/components/parameters/termvectors___query.routing' + - $ref: '#/components/parameters/termvectors___query.term_statistics' + - $ref: '#/components/parameters/termvectors___query.version' + - $ref: '#/components/parameters/termvectors___query.version_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' requestBody: $ref: '#/components/requestBodies/termvectors' responses: '200': - $ref: '#/components/responses/termvectors@200' + $ref: '#/components/responses/termvectors___200' post: operationId: termvectors.3 x-operation-group: termvectors @@ -11602,29 +12100,29 @@ paths: externalDocs: url: https://opensearch.org/docs/latest parameters: - - $ref: '#/components/parameters/termvectors::path.id' - - $ref: '#/components/parameters/termvectors::path.index' - - $ref: '#/components/parameters/termvectors::query.field_statistics' - - $ref: '#/components/parameters/termvectors::query.fields' - - $ref: '#/components/parameters/termvectors::query.offsets' - - $ref: '#/components/parameters/termvectors::query.payloads' - - $ref: '#/components/parameters/termvectors::query.positions' - - $ref: '#/components/parameters/termvectors::query.preference' - - $ref: '#/components/parameters/termvectors::query.realtime' - - $ref: '#/components/parameters/termvectors::query.routing' - - $ref: '#/components/parameters/termvectors::query.term_statistics' - - $ref: '#/components/parameters/termvectors::query.version' - - $ref: '#/components/parameters/termvectors::query.version_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' + - $ref: '#/components/parameters/termvectors___path.id' + - $ref: '#/components/parameters/termvectors___path.index' + - $ref: '#/components/parameters/termvectors___query.field_statistics' + - $ref: '#/components/parameters/termvectors___query.fields' + - $ref: '#/components/parameters/termvectors___query.offsets' + - $ref: '#/components/parameters/termvectors___query.payloads' + - $ref: '#/components/parameters/termvectors___query.positions' + - $ref: '#/components/parameters/termvectors___query.preference' + - $ref: '#/components/parameters/termvectors___query.realtime' + - $ref: '#/components/parameters/termvectors___query.routing' + - $ref: '#/components/parameters/termvectors___query.term_statistics' + - $ref: '#/components/parameters/termvectors___query.version' + - $ref: '#/components/parameters/termvectors___query.version_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' requestBody: $ref: '#/components/requestBodies/termvectors' responses: '200': - $ref: '#/components/responses/termvectors@200' + $ref: '#/components/responses/termvectors___200' /{index}/_update_by_query: post: operationId: update_by_query.0 @@ -11636,51 +12134,51 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/document-apis/update-by-query/ parameters: - - $ref: '#/components/parameters/update_by_query::path.index' - - $ref: '#/components/parameters/update_by_query::query._source' - - $ref: '#/components/parameters/update_by_query::query._source_excludes' - - $ref: '#/components/parameters/update_by_query::query._source_includes' - - $ref: '#/components/parameters/update_by_query::query.allow_no_indices' - - $ref: '#/components/parameters/update_by_query::query.analyze_wildcard' - - $ref: '#/components/parameters/update_by_query::query.analyzer' - - $ref: '#/components/parameters/update_by_query::query.conflicts' - - $ref: '#/components/parameters/update_by_query::query.default_operator' - - $ref: '#/components/parameters/update_by_query::query.df' - - $ref: '#/components/parameters/update_by_query::query.expand_wildcards' - - $ref: '#/components/parameters/update_by_query::query.from' - - $ref: '#/components/parameters/update_by_query::query.ignore_unavailable' - - $ref: '#/components/parameters/update_by_query::query.lenient' - - $ref: '#/components/parameters/update_by_query::query.max_docs' - - $ref: '#/components/parameters/update_by_query::query.pipeline' - - $ref: '#/components/parameters/update_by_query::query.preference' - - $ref: '#/components/parameters/update_by_query::query.q' - - $ref: '#/components/parameters/update_by_query::query.refresh' - - $ref: '#/components/parameters/update_by_query::query.request_cache' - - $ref: '#/components/parameters/update_by_query::query.requests_per_second' - - $ref: '#/components/parameters/update_by_query::query.routing' - - $ref: '#/components/parameters/update_by_query::query.scroll' - - $ref: '#/components/parameters/update_by_query::query.scroll_size' - - $ref: '#/components/parameters/update_by_query::query.search_timeout' - - $ref: '#/components/parameters/update_by_query::query.search_type' - - $ref: '#/components/parameters/update_by_query::query.size' - - $ref: '#/components/parameters/update_by_query::query.slices' - - $ref: '#/components/parameters/update_by_query::query.sort' - - $ref: '#/components/parameters/update_by_query::query.stats' - - $ref: '#/components/parameters/update_by_query::query.terminate_after' - - $ref: '#/components/parameters/update_by_query::query.timeout' - - $ref: '#/components/parameters/update_by_query::query.version' - - $ref: '#/components/parameters/update_by_query::query.wait_for_active_shards' - - $ref: '#/components/parameters/update_by_query::query.wait_for_completion' - - $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' + - $ref: '#/components/parameters/update_by_query___path.index' + - $ref: '#/components/parameters/update_by_query___query._source' + - $ref: '#/components/parameters/update_by_query___query._source_excludes' + - $ref: '#/components/parameters/update_by_query___query._source_includes' + - $ref: '#/components/parameters/update_by_query___query.allow_no_indices' + - $ref: '#/components/parameters/update_by_query___query.analyze_wildcard' + - $ref: '#/components/parameters/update_by_query___query.analyzer' + - $ref: '#/components/parameters/update_by_query___query.conflicts' + - $ref: '#/components/parameters/update_by_query___query.default_operator' + - $ref: '#/components/parameters/update_by_query___query.df' + - $ref: '#/components/parameters/update_by_query___query.expand_wildcards' + - $ref: '#/components/parameters/update_by_query___query.from' + - $ref: '#/components/parameters/update_by_query___query.ignore_unavailable' + - $ref: '#/components/parameters/update_by_query___query.lenient' + - $ref: '#/components/parameters/update_by_query___query.max_docs' + - $ref: '#/components/parameters/update_by_query___query.pipeline' + - $ref: '#/components/parameters/update_by_query___query.preference' + - $ref: '#/components/parameters/update_by_query___query.q' + - $ref: '#/components/parameters/update_by_query___query.refresh' + - $ref: '#/components/parameters/update_by_query___query.request_cache' + - $ref: '#/components/parameters/update_by_query___query.requests_per_second' + - $ref: '#/components/parameters/update_by_query___query.routing' + - $ref: '#/components/parameters/update_by_query___query.scroll' + - $ref: '#/components/parameters/update_by_query___query.scroll_size' + - $ref: '#/components/parameters/update_by_query___query.search_timeout' + - $ref: '#/components/parameters/update_by_query___query.search_type' + - $ref: '#/components/parameters/update_by_query___query.size' + - $ref: '#/components/parameters/update_by_query___query.slices' + - $ref: '#/components/parameters/update_by_query___query.sort' + - $ref: '#/components/parameters/update_by_query___query.stats' + - $ref: '#/components/parameters/update_by_query___query.terminate_after' + - $ref: '#/components/parameters/update_by_query___query.timeout' + - $ref: '#/components/parameters/update_by_query___query.version' + - $ref: '#/components/parameters/update_by_query___query.wait_for_active_shards' + - $ref: '#/components/parameters/update_by_query___query.wait_for_completion' + - $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/update_by_query' responses: '200': - $ref: '#/components/responses/update_by_query@200' + $ref: '#/components/responses/update_by_query___200' /{index}/_update/{id}: post: operationId: update.0 @@ -11690,73 +12188,73 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/document-apis/update-document/ parameters: - - $ref: '#/components/parameters/update::path.id' - - $ref: '#/components/parameters/update::path.index' - - $ref: '#/components/parameters/update::query._source' - - $ref: '#/components/parameters/update::query._source_excludes' - - $ref: '#/components/parameters/update::query._source_includes' - - $ref: '#/components/parameters/update::query.if_primary_term' - - $ref: '#/components/parameters/update::query.if_seq_no' - - $ref: '#/components/parameters/update::query.lang' - - $ref: '#/components/parameters/update::query.refresh' - - $ref: '#/components/parameters/update::query.require_alias' - - $ref: '#/components/parameters/update::query.retry_on_conflict' - - $ref: '#/components/parameters/update::query.routing' - - $ref: '#/components/parameters/update::query.timeout' - - $ref: '#/components/parameters/update::query.wait_for_active_shards' - - $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' + - $ref: '#/components/parameters/update___path.id' + - $ref: '#/components/parameters/update___path.index' + - $ref: '#/components/parameters/update___query._source' + - $ref: '#/components/parameters/update___query._source_excludes' + - $ref: '#/components/parameters/update___query._source_includes' + - $ref: '#/components/parameters/update___query.if_primary_term' + - $ref: '#/components/parameters/update___query.if_seq_no' + - $ref: '#/components/parameters/update___query.lang' + - $ref: '#/components/parameters/update___query.refresh' + - $ref: '#/components/parameters/update___query.require_alias' + - $ref: '#/components/parameters/update___query.retry_on_conflict' + - $ref: '#/components/parameters/update___query.routing' + - $ref: '#/components/parameters/update___query.timeout' + - $ref: '#/components/parameters/update___query.wait_for_active_shards' + - $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/update' responses: '200': - $ref: '#/components/responses/update@200' + $ref: '#/components/responses/update___200' /{index}/_upgrade: get: operationId: indices.get_upgrade.1 x-operation-group: indices.get_upgrade x-version-added: '1.0' - description: The _upgrade API is no longer useful and will be removed. + description: The `_upgrade` API is no longer useful and will be removed. externalDocs: url: https://opensearch.org/docs/latest parameters: - - $ref: '#/components/parameters/indices.get_upgrade::path.index' - - $ref: '#/components/parameters/indices.get_upgrade::query.allow_no_indices' - - $ref: '#/components/parameters/indices.get_upgrade::query.expand_wildcards' - - $ref: '#/components/parameters/indices.get_upgrade::query.ignore_unavailable' - - $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' + - $ref: '#/components/parameters/indices.get_upgrade___path.index' + - $ref: '#/components/parameters/indices.get_upgrade___query.allow_no_indices' + - $ref: '#/components/parameters/indices.get_upgrade___query.expand_wildcards' + - $ref: '#/components/parameters/indices.get_upgrade___query.ignore_unavailable' + - $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/indices.get_upgrade@200' + $ref: '#/components/responses/indices.get_upgrade___200' post: operationId: indices.upgrade.1 x-operation-group: indices.upgrade x-version-added: '1.0' - description: The _upgrade API is no longer useful and will be removed. + description: The `_upgrade` API is no longer useful and will be removed. externalDocs: url: https://opensearch.org/docs/latest parameters: - - $ref: '#/components/parameters/indices.upgrade::path.index' - - $ref: '#/components/parameters/indices.upgrade::query.allow_no_indices' - - $ref: '#/components/parameters/indices.upgrade::query.expand_wildcards' - - $ref: '#/components/parameters/indices.upgrade::query.ignore_unavailable' - - $ref: '#/components/parameters/indices.upgrade::query.only_ancient_segments' - - $ref: '#/components/parameters/indices.upgrade::query.wait_for_completion' - - $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' + - $ref: '#/components/parameters/indices.upgrade___path.index' + - $ref: '#/components/parameters/indices.upgrade___query.allow_no_indices' + - $ref: '#/components/parameters/indices.upgrade___query.expand_wildcards' + - $ref: '#/components/parameters/indices.upgrade___query.ignore_unavailable' + - $ref: '#/components/parameters/indices.upgrade___query.only_ancient_segments' + - $ref: '#/components/parameters/indices.upgrade___query.wait_for_completion' + - $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/indices.upgrade@200' + $ref: '#/components/responses/indices.upgrade___200' /{index}/_validate/query: get: operationId: indices.validate_query.2 @@ -11766,29 +12264,29 @@ paths: externalDocs: url: https://opensearch.org/docs/latest parameters: - - $ref: '#/components/parameters/indices.validate_query::path.index' - - $ref: '#/components/parameters/indices.validate_query::query.all_shards' - - $ref: '#/components/parameters/indices.validate_query::query.allow_no_indices' - - $ref: '#/components/parameters/indices.validate_query::query.analyze_wildcard' - - $ref: '#/components/parameters/indices.validate_query::query.analyzer' - - $ref: '#/components/parameters/indices.validate_query::query.default_operator' - - $ref: '#/components/parameters/indices.validate_query::query.df' - - $ref: '#/components/parameters/indices.validate_query::query.expand_wildcards' - - $ref: '#/components/parameters/indices.validate_query::query.explain' - - $ref: '#/components/parameters/indices.validate_query::query.ignore_unavailable' - - $ref: '#/components/parameters/indices.validate_query::query.lenient' - - $ref: '#/components/parameters/indices.validate_query::query.q' - - $ref: '#/components/parameters/indices.validate_query::query.rewrite' - - $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' + - $ref: '#/components/parameters/indices.validate_query___path.index' + - $ref: '#/components/parameters/indices.validate_query___query.all_shards' + - $ref: '#/components/parameters/indices.validate_query___query.allow_no_indices' + - $ref: '#/components/parameters/indices.validate_query___query.analyze_wildcard' + - $ref: '#/components/parameters/indices.validate_query___query.analyzer' + - $ref: '#/components/parameters/indices.validate_query___query.default_operator' + - $ref: '#/components/parameters/indices.validate_query___query.df' + - $ref: '#/components/parameters/indices.validate_query___query.expand_wildcards' + - $ref: '#/components/parameters/indices.validate_query___query.explain' + - $ref: '#/components/parameters/indices.validate_query___query.ignore_unavailable' + - $ref: '#/components/parameters/indices.validate_query___query.lenient' + - $ref: '#/components/parameters/indices.validate_query___query.q' + - $ref: '#/components/parameters/indices.validate_query___query.rewrite' + - $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/indices.validate_query' responses: '200': - $ref: '#/components/responses/indices.validate_query@200' + $ref: '#/components/responses/indices.validate_query___200' post: operationId: indices.validate_query.3 x-operation-group: indices.validate_query @@ -11797,29 +12295,29 @@ paths: externalDocs: url: https://opensearch.org/docs/latest parameters: - - $ref: '#/components/parameters/indices.validate_query::path.index' - - $ref: '#/components/parameters/indices.validate_query::query.all_shards' - - $ref: '#/components/parameters/indices.validate_query::query.allow_no_indices' - - $ref: '#/components/parameters/indices.validate_query::query.analyze_wildcard' - - $ref: '#/components/parameters/indices.validate_query::query.analyzer' - - $ref: '#/components/parameters/indices.validate_query::query.default_operator' - - $ref: '#/components/parameters/indices.validate_query::query.df' - - $ref: '#/components/parameters/indices.validate_query::query.expand_wildcards' - - $ref: '#/components/parameters/indices.validate_query::query.explain' - - $ref: '#/components/parameters/indices.validate_query::query.ignore_unavailable' - - $ref: '#/components/parameters/indices.validate_query::query.lenient' - - $ref: '#/components/parameters/indices.validate_query::query.q' - - $ref: '#/components/parameters/indices.validate_query::query.rewrite' - - $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' + - $ref: '#/components/parameters/indices.validate_query___path.index' + - $ref: '#/components/parameters/indices.validate_query___query.all_shards' + - $ref: '#/components/parameters/indices.validate_query___query.allow_no_indices' + - $ref: '#/components/parameters/indices.validate_query___query.analyze_wildcard' + - $ref: '#/components/parameters/indices.validate_query___query.analyzer' + - $ref: '#/components/parameters/indices.validate_query___query.default_operator' + - $ref: '#/components/parameters/indices.validate_query___query.df' + - $ref: '#/components/parameters/indices.validate_query___query.expand_wildcards' + - $ref: '#/components/parameters/indices.validate_query___query.explain' + - $ref: '#/components/parameters/indices.validate_query___query.ignore_unavailable' + - $ref: '#/components/parameters/indices.validate_query___query.lenient' + - $ref: '#/components/parameters/indices.validate_query___query.q' + - $ref: '#/components/parameters/indices.validate_query___query.rewrite' + - $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/indices.validate_query' responses: '200': - $ref: '#/components/responses/indices.validate_query@200' + $ref: '#/components/responses/indices.validate_query___200' /_opendistro/_asynchronous_search: post: operationId: asynchronous_search.search.0_superseded @@ -11829,20 +12327,20 @@ paths: 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' + - $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' + $ref: '#/components/responses/asynchronous_search.search___200' deprecated: true x-ignorable: true /_opendistro/_asynchronous_search/stats: @@ -11855,13 +12353,13 @@ paths: url: https://opensearch.org/docs/latest/search-plugins/async/index/#monitor-stats responses: '200': - $ref: '#/components/responses/asynchronous_search.stats@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' + - $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}: @@ -11873,15 +12371,15 @@ paths: 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' + - $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' + $ref: '#/components/responses/asynchronous_search.get___200' deprecated: true x-ignorable: true delete: @@ -11892,15 +12390,15 @@ paths: 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' + - $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' + $ref: '#/components/responses/asynchronous_search.delete___200' deprecated: true x-ignorable: true /_opendistro/_ism/add: @@ -11911,17 +12409,17 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/im-plugin/ism/api/#add-policy parameters: - - $ref: '#/components/parameters/ism.add_policy::query.index' - - $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' + - $ref: '#/components/parameters/ism.add_policy___query.index' + - $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/ism.add_policy' responses: '200': - $ref: '#/components/responses/ism.add_policy@200' + $ref: '#/components/responses/ism.add_policy___200' deprecated: true x-ignorable: true /_opendistro/_ism/add/{index}: @@ -11932,18 +12430,18 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/im-plugin/ism/api/#add-policy parameters: - - $ref: '#/components/parameters/ism.add_policy::path.index' - - $ref: '#/components/parameters/ism.add_policy::query.index' - - $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' + - $ref: '#/components/parameters/ism.add_policy___path.index' + - $ref: '#/components/parameters/ism.add_policy___query.index' + - $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/ism.add_policy' responses: '200': - $ref: '#/components/responses/ism.add_policy@200' + $ref: '#/components/responses/ism.add_policy___200' deprecated: true x-ignorable: true /_opendistro/_ism/change_policy: @@ -11954,17 +12452,17 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/im-plugin/ism/api/#update-managed-index-policy parameters: - - $ref: '#/components/parameters/ism.change_policy::query.index' - - $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' + - $ref: '#/components/parameters/ism.change_policy___query.index' + - $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/ism.change_policy' responses: '200': - $ref: '#/components/responses/ism.change_policy@200' + $ref: '#/components/responses/ism.change_policy___200' deprecated: true x-ignorable: true /_opendistro/_ism/change_policy/{index}: @@ -11975,98 +12473,98 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/im-plugin/ism/api/#update-managed-index-policy parameters: - - $ref: '#/components/parameters/ism.change_policy::path.index' - - $ref: '#/components/parameters/ism.change_policy::query.index' - - $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' + - $ref: '#/components/parameters/ism.change_policy___path.index' + - $ref: '#/components/parameters/ism.change_policy___query.index' + - $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/ism.change_policy' responses: '200': - $ref: '#/components/responses/ism.change_policy@200' + $ref: '#/components/responses/ism.change_policy___200' deprecated: true x-ignorable: true /_opendistro/_ism/explain: get: operationId: ism.explain_policy.0_superseded x-operation-group: ism.explain_policy - description: Gets the currently applied policy on indices. + description: Gets the currently applied policy on indexes. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/ism/api/#explain-index requestBody: $ref: '#/components/requestBodies/ism.explain_policy' responses: '200': - $ref: '#/components/responses/ism.explain_policy@200' + $ref: '#/components/responses/ism.explain_policy___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' + - $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 post: - operationId: ism.explain_policy.0_superseded + operationId: ism.explain_policy.1_superseded x-operation-group: ism.explain_policy - description: Gets the currently applied policy on indices. + description: Gets the currently applied policy on indexes. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/ism/api/#explain-index requestBody: $ref: '#/components/requestBodies/ism.explain_policy' responses: '200': - $ref: '#/components/responses/ism.explain_policy@200' + $ref: '#/components/responses/ism.explain_policy___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' + - $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/_ism/explain/{index}: get: - operationId: ism.explain_policy.1_superseded + operationId: ism.explain_policy.3_superseded x-operation-group: ism.explain_policy - description: Gets the currently applied policy on indices. + description: Gets the currently applied policy on indexes. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/ism/api/#explain-index parameters: - - $ref: '#/components/parameters/ism.explain_policy::path.index' - - $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' + - $ref: '#/components/parameters/ism.explain_policy___path.index' + - $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/ism.explain_policy' responses: '200': - $ref: '#/components/responses/ism.explain_policy@200' + $ref: '#/components/responses/ism.explain_policy___200' deprecated: true x-ignorable: true post: - operationId: ism.explain_policy.1_superseded + operationId: ism.explain_policy.4_superseded x-operation-group: ism.explain_policy - description: Gets the currently applied policy on indices. + description: Gets the currently applied policy on indexes. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/ism/api/#explain-index parameters: - - $ref: '#/components/parameters/ism.explain_policy::path.index' - - $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' + - $ref: '#/components/parameters/ism.explain_policy___path.index' + - $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/ism.explain_policy' responses: '200': - $ref: '#/components/responses/ism.explain_policy@200' + $ref: '#/components/responses/ism.explain_policy___200' deprecated: true x-ignorable: true /_opendistro/_ism/policies: @@ -12078,13 +12576,13 @@ paths: url: https://opensearch.org/docs/latest/im-plugin/ism/api/#get-policy responses: '200': - $ref: '#/components/responses/ism.get_policies@200' + $ref: '#/components/responses/ism.get_policies___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' + - $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 put: @@ -12096,20 +12594,20 @@ paths: requestBody: $ref: '#/components/requestBodies/ism.put_policies' parameters: - - $ref: '#/components/parameters/ism.put_policies::query.if_primary_term' - - $ref: '#/components/parameters/ism.put_policies::query.if_seq_no' - - $ref: '#/components/parameters/ism.put_policies::query.policyID' - - $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' + - $ref: '#/components/parameters/ism.put_policies___query.if_primary_term' + - $ref: '#/components/parameters/ism.put_policies___query.if_seq_no' + - $ref: '#/components/parameters/ism.put_policies___query.policyID' + - $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/ism.put_policies@200' + $ref: '#/components/responses/ism.put_policies___200' deprecated: true x-ignorable: true - /_opendistro/_ism/policies/{policyID}: + /_opendistro/_ism/policies/{policy_id}: get: operationId: ism.get_policy.0_superseded x-operation-group: ism.get_policy @@ -12117,15 +12615,15 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/im-plugin/ism/api/#put-policy parameters: - - $ref: '#/components/parameters/ism.get_policy::path.policy_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' + - $ref: '#/components/parameters/ism.get_policy___path.policy_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/ism.get_policy@200' + $ref: '#/components/responses/ism.get_policy___200' deprecated: true x-ignorable: true head: @@ -12135,17 +12633,17 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/im-plugin/ism/api/#get-policy parameters: - - $ref: '#/components/parameters/ism.exists_policy::path.policy_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' + - $ref: '#/components/parameters/ism.exists_policy___path.policy_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/ism.exists_policy@200' + $ref: '#/components/responses/ism.exists_policy___200' '404': - $ref: '#/components/responses/ism.exists_policy@404' + $ref: '#/components/responses/ism.exists_policy___404' deprecated: true x-ignorable: true put: @@ -12155,21 +12653,21 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/im-plugin/ism/api/#create-policy parameters: - - $ref: '#/components/parameters/ism.put_policy::path.policy_id' - - $ref: '#/components/parameters/ism.put_policy::query.if_primary_term' - - $ref: '#/components/parameters/ism.put_policy::query.if_seq_no' - - $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' + - $ref: '#/components/parameters/ism.put_policy___path.policy_id' + - $ref: '#/components/parameters/ism.put_policy___query.if_primary_term' + - $ref: '#/components/parameters/ism.put_policy___query.if_seq_no' + - $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/ism.put_policy' responses: '200': - $ref: '#/components/responses/ism.put_policy@200' + $ref: '#/components/responses/ism.put_policy___200' '201': - $ref: '#/components/responses/ism.put_policy@201' + $ref: '#/components/responses/ism.put_policy___201' deprecated: true x-ignorable: true delete: @@ -12179,15 +12677,15 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/im-plugin/ism/api/#delete-policy parameters: - - $ref: '#/components/parameters/ism.delete_policy::path.policy_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' + - $ref: '#/components/parameters/ism.delete_policy___path.policy_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/ism.delete_policy@200' + $ref: '#/components/responses/ism.delete_policy___200' deprecated: true x-ignorable: true /_opendistro/_ism/remove: @@ -12198,15 +12696,15 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/im-plugin/ism/api/#remove-policy parameters: - - $ref: '#/components/parameters/ism.remove_policy::query.index' - - $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' + - $ref: '#/components/parameters/ism.remove_policy___query.index' + - $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/ism.remove_policy@200' + $ref: '#/components/responses/ism.remove_policy___200' deprecated: true x-ignorable: true /_opendistro/_ism/remove/{index}: @@ -12217,16 +12715,16 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/im-plugin/ism/api/#remove-policy parameters: - - $ref: '#/components/parameters/ism.remove_policy::path.index' - - $ref: '#/components/parameters/ism.remove_policy::query.index' - - $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' + - $ref: '#/components/parameters/ism.remove_policy___path.index' + - $ref: '#/components/parameters/ism.remove_policy___query.index' + - $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/ism.remove_policy@200' + $ref: '#/components/responses/ism.remove_policy___200' deprecated: true x-ignorable: true /_opendistro/_ism/retry: @@ -12237,17 +12735,17 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/im-plugin/ism/api/#retry-failed-index parameters: - - $ref: '#/components/parameters/ism.retry_index::query.index' - - $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' + - $ref: '#/components/parameters/ism.retry_index___query.index' + - $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/ism.retry_index' responses: '200': - $ref: '#/components/responses/ism.retry_index@200' + $ref: '#/components/responses/ism.retry_index___200' deprecated: true x-ignorable: true /_opendistro/_ism/retry/{index}: @@ -12258,18 +12756,18 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/im-plugin/ism/api/#retry-failed-index parameters: - - $ref: '#/components/parameters/ism.retry_index::path.index' - - $ref: '#/components/parameters/ism.retry_index::query.index' - - $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' + - $ref: '#/components/parameters/ism.retry_index___path.index' + - $ref: '#/components/parameters/ism.retry_index___query.index' + - $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/ism.retry_index' responses: '200': - $ref: '#/components/responses/ism.retry_index@200' + $ref: '#/components/responses/ism.retry_index___200' deprecated: true x-ignorable: true /_opendistro/_knn/stats/{stat}: @@ -12281,16 +12779,16 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/search-plugins/knn/api/#stats parameters: - - $ref: '#/components/parameters/knn.stats::path.stat' - - $ref: '#/components/parameters/knn.stats::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' + - $ref: '#/components/parameters/knn.stats___path.stat' + - $ref: '#/components/parameters/knn.stats___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/knn.stats@200' + $ref: '#/components/responses/knn.stats___200' deprecated: true x-ignorable: true /_opendistro/_knn/warmup/{index}: @@ -12302,18 +12800,18 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/search-plugins/knn/api/#warmup-operation parameters: - - $ref: '#/components/parameters/knn.warmup::path.index' - - $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' + - $ref: '#/components/parameters/knn.warmup___path.index' + - $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/knn.warmup@200' + $ref: '#/components/responses/knn.warmup___200' deprecated: true x-ignorable: true - /_opendistro/_knn/{nodeId}/stats/{stat}: + /_opendistro/_knn/{node_id}/stats/{stat}: get: operationId: knn.stats.3_superseded x-operation-group: knn.stats @@ -12322,17 +12820,17 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/search-plugins/knn/api/#stats parameters: - - $ref: '#/components/parameters/knn.stats::path.node_id' - - $ref: '#/components/parameters/knn.stats::path.stat' - - $ref: '#/components/parameters/knn.stats::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' + - $ref: '#/components/parameters/knn.stats___path.node_id' + - $ref: '#/components/parameters/knn.stats___path.stat' + - $ref: '#/components/parameters/knn.stats___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/knn.stats@200' + $ref: '#/components/responses/knn.stats___200' deprecated: true x-ignorable: true /_opendistro/_ppl: @@ -12344,18 +12842,18 @@ paths: 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' + - $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' + $ref: '#/components/responses/ppl.query___200' deprecated: true x-ignorable: true /_opendistro/_ppl/_explain: @@ -12367,18 +12865,18 @@ paths: 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' + - $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' + $ref: '#/components/responses/ppl.explain___200' deprecated: true x-ignorable: true /_opendistro/_ppl/stats: @@ -12390,16 +12888,16 @@ paths: 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' + - $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' + $ref: '#/components/responses/ppl.get_stats___200' deprecated: true x-ignorable: true post: @@ -12410,18 +12908,18 @@ paths: 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' + - $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' + $ref: '#/components/responses/ppl.post_stats___200' deprecated: true x-ignorable: true /_opendistro/_refresh_search_analyzers/{index}: @@ -12432,18 +12930,18 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/im-plugin/refresh-analyzer/ parameters: - - $ref: '#/components/parameters/ism.refresh_search_analyzers::path.index' - - $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' + - $ref: '#/components/parameters/ism.refresh_search_analyzers___path.index' + - $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/ism.refresh_search_analyzers@200' + $ref: '#/components/responses/ism.refresh_search_analyzers___200' deprecated: true x-ignorable: true - /_opendistro/_rollup/jobs/{rollupID}: + /_opendistro/_rollup/jobs/{id}: get: operationId: rollups.get.0_superseded x-operation-group: rollups.get @@ -12452,15 +12950,15 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/im-plugin/index-rollups/rollup-api/#get-an-index-rollup-job parameters: - - $ref: '#/components/parameters/rollups.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' + - $ref: '#/components/parameters/rollups.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/rollups.get@200' + $ref: '#/components/responses/rollups.get___200' deprecated: true x-ignorable: true put: @@ -12472,16 +12970,16 @@ paths: url: https://opensearch.org/docs/latest/im-plugin/index-rollups/rollup-api/#create-or-update-an-index-rollup-job responses: '200': - $ref: '#/components/responses/rollups.put@200' + $ref: '#/components/responses/rollups.put___200' parameters: - - $ref: '#/components/parameters/rollups.put::path.id' - - $ref: '#/components/parameters/rollups.put::query.if_primary_term' - - $ref: '#/components/parameters/rollups.put::query.if_seq_no' - - $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' + - $ref: '#/components/parameters/rollups.put___path.id' + - $ref: '#/components/parameters/rollups.put___query.if_primary_term' + - $ref: '#/components/parameters/rollups.put___query.if_seq_no' + - $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/rollups.put' deprecated: true @@ -12495,17 +12993,17 @@ paths: url: https://opensearch.org/docs/latest/im-plugin/index-rollups/rollup-api/#delete-an-index-rollup-job responses: '200': - $ref: '#/components/responses/rollups.delete@200' + $ref: '#/components/responses/rollups.delete___200' parameters: - - $ref: '#/components/parameters/rollups.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' + - $ref: '#/components/parameters/rollups.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' deprecated: true x-ignorable: true - /_opendistro/_rollup/jobs/{rollupID}/_explain: + /_opendistro/_rollup/jobs/{id}/_explain: get: operationId: rollups.explain.0_superseded x-operation-group: rollups.explain @@ -12514,18 +13012,18 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/im-plugin/index-rollups/rollup-api/#explain-an-index-rollup-job parameters: - - $ref: '#/components/parameters/rollups.explain::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' + - $ref: '#/components/parameters/rollups.explain___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/rollups.explain@200' + $ref: '#/components/responses/rollups.explain___200' deprecated: true x-ignorable: true - /_opendistro/_rollup/jobs/{rollupID}/_start: + /_opendistro/_rollup/jobs/{id}/_start: post: operationId: rollups.start.0_superseded x-operation-group: rollups.start @@ -12534,18 +13032,18 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/im-plugin/index-rollups/rollup-api/#start-or-stop-an-index-rollup-job parameters: - - $ref: '#/components/parameters/rollups.start::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' + - $ref: '#/components/parameters/rollups.start___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/rollups.start@200' + $ref: '#/components/responses/rollups.start___200' deprecated: true x-ignorable: true - /_opendistro/_rollup/jobs/{rollupID}/_stop: + /_opendistro/_rollup/jobs/{id}/_stop: post: operationId: rollups.stop.0_superseded x-operation-group: rollups.stop @@ -12554,15 +13052,15 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/im-plugin/index-rollups/rollup-api/#start-or-stop-an-index-rollup-job parameters: - - $ref: '#/components/parameters/rollups.stop::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' + - $ref: '#/components/parameters/rollups.stop___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/rollups.stop@200' + $ref: '#/components/responses/rollups.stop___200' deprecated: true x-ignorable: true /_opendistro/_security/api/account: @@ -12578,13 +13076,13 @@ paths: url: https://opensearch.org/docs/latest/security/access-control/api/#get-account-details responses: '200': - $ref: '#/components/responses/security.get_account_details@200' + $ref: '#/components/responses/security.get_account_details___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' + - $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 put: @@ -12601,18 +13099,18 @@ paths: $ref: '#/components/requestBodies/security.change_password' responses: '200': - $ref: '#/components/responses/security.change_password@200' + $ref: '#/components/responses/security.change_password___200' '403': - $ref: '#/components/responses/security.change_password@403' + $ref: '#/components/responses/security.change_password___403' 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' + - $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/_security/api/actiongroups/{name}: + /_opendistro/_security/api/actiongroups/{action_group}: get: operationId: security.get_action_group.0_superseded x-operation-group: security.get_action_group @@ -12624,15 +13122,15 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#get-action-group parameters: - - $ref: '#/components/parameters/security.get_action_group::path.action_group' - - $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' + - $ref: '#/components/parameters/security.get_action_group___path.action_group' + - $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_action_group@200' + $ref: '#/components/responses/security.get_action_group___200' deprecated: true x-ignorable: true put: @@ -12646,19 +13144,19 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#create-action-group parameters: - - $ref: '#/components/parameters/security.create_action_group::path.action_group' - - $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' + - $ref: '#/components/parameters/security.create_action_group___path.action_group' + - $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/security.create_action_group' responses: '200': - $ref: '#/components/responses/security.create_action_group@200' + $ref: '#/components/responses/security.create_action_group___200' '201': - $ref: '#/components/responses/security.create_action_group@201' + $ref: '#/components/responses/security.create_action_group___201' deprecated: true x-ignorable: true patch: @@ -12672,17 +13170,17 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#patch-action-group parameters: - - $ref: '#/components/parameters/security.patch_action_group::path.action_group' - - $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' + - $ref: '#/components/parameters/security.patch_action_group___path.action_group' + - $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/security.patch_action_group' responses: '200': - $ref: '#/components/responses/security.patch_action_group@200' + $ref: '#/components/responses/security.patch_action_group___200' deprecated: true x-ignorable: true delete: @@ -12696,15 +13194,15 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#delete-action-group parameters: - - $ref: '#/components/parameters/security.delete_action_group::path.action_group' - - $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' + - $ref: '#/components/parameters/security.delete_action_group___path.action_group' + - $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.delete_action_group@200' + $ref: '#/components/responses/security.delete_action_group___200' deprecated: true x-ignorable: true /_opendistro/_security/api/audit/config: @@ -12722,13 +13220,13 @@ paths: $ref: '#/components/requestBodies/security.update_audit_configuration' responses: '200': - $ref: '#/components/responses/security.update_audit_configuration@200' + $ref: '#/components/responses/security.update_audit_configuration___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' + - $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/_security/api/authtoken: @@ -12742,13 +13240,13 @@ paths: description: Returns the authorization token. responses: '200': - $ref: '#/components/responses/security.authtoken@200' + $ref: '#/components/responses/security.authtoken___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' + - $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/_security/api/cache: @@ -12763,13 +13261,13 @@ paths: description: Not supported for cache API. responses: '501': - $ref: '#/components/responses/security.cache@501' + $ref: '#/components/responses/security.cache___501' 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' + - $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 post: operationId: security.cache.2_superseded @@ -12782,13 +13280,13 @@ paths: description: Not supported for cache API. responses: '501': - $ref: '#/components/responses/security.cache@501' + $ref: '#/components/responses/security.cache___501' 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' + - $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 put: operationId: security.cache.3_superseded @@ -12801,13 +13299,13 @@ paths: description: Not supported for cache API. responses: '501': - $ref: '#/components/responses/security.cache@501' + $ref: '#/components/responses/security.cache___501' 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' + - $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 delete: operationId: security.flush_cache.0_superseded @@ -12821,16 +13319,16 @@ paths: url: https://opensearch.org/docs/latest/security/access-control/api/#flush-cache responses: '200': - $ref: '#/components/responses/security.flush_cache@200' + $ref: '#/components/responses/security.flush_cache___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' + - $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/_security/api/internalusers/{name}: + /_opendistro/_security/api/internalusers/{username}: get: operationId: security.get_user.0_superseded x-operation-group: security.get_user @@ -12842,15 +13340,15 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#get-user parameters: - - $ref: '#/components/parameters/security.get_user::path.username' - - $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' + - $ref: '#/components/parameters/security.get_user___path.username' + - $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_user@200' + $ref: '#/components/responses/security.get_user___200' deprecated: true x-ignorable: true put: @@ -12864,17 +13362,17 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#create-user parameters: - - $ref: '#/components/parameters/security.create_user::path.username' - - $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' + - $ref: '#/components/parameters/security.create_user___path.username' + - $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/security.create_user' responses: '200': - $ref: '#/components/responses/security.create_user@200' + $ref: '#/components/responses/security.create_user___200' deprecated: true x-ignorable: true patch: @@ -12888,17 +13386,17 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#patch-user parameters: - - $ref: '#/components/parameters/security.patch_user::path.username' - - $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' + - $ref: '#/components/parameters/security.patch_user___path.username' + - $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/security.patch_user' responses: '200': - $ref: '#/components/responses/security.patch_user@200' + $ref: '#/components/responses/security.patch_user___200' deprecated: true x-ignorable: true delete: @@ -12912,18 +13410,18 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#delete-user parameters: - - $ref: '#/components/parameters/security.delete_user::path.username' - - $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' + - $ref: '#/components/parameters/security.delete_user___path.username' + - $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.delete_user@200' + $ref: '#/components/responses/security.delete_user___200' deprecated: true x-ignorable: true - /_opendistro/_security/api/internalusers/{name}/authtoken: + /_opendistro/_security/api/internalusers/{username}/authtoken: post: operationId: security.generate_user_token.0_superseded x-operation-group: security.generate_user_token @@ -12933,17 +13431,17 @@ paths: - amazon-serverless description: Generates authorization token for the given user. parameters: - - $ref: '#/components/parameters/security.generate_user_token::path.username' - - $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' + - $ref: '#/components/parameters/security.generate_user_token___path.username' + - $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.generate_user_token@200' + $ref: '#/components/responses/security.generate_user_token___200' '400': - $ref: '#/components/responses/security.generate_user_token@400' + $ref: '#/components/responses/security.generate_user_token___400' deprecated: true x-ignorable: true /_opendistro/_security/api/migrate: @@ -12957,15 +13455,15 @@ paths: description: Migrates security configuration from v6 to v7. responses: '200': - $ref: '#/components/responses/security.migrate@200' + $ref: '#/components/responses/security.migrate___200' '400': - $ref: '#/components/responses/security.migrate@400' + $ref: '#/components/responses/security.migrate___400' 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' + - $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/_security/api/permissionsinfo: @@ -12979,18 +13477,18 @@ paths: description: Gets the evaluated REST API permissions for the currently logged in user. responses: '200': - $ref: '#/components/responses/security.get_permissions_info@200' + $ref: '#/components/responses/security.get_permissions_info___200' '500': - $ref: '#/components/responses/security.get_permissions_info@500' + $ref: '#/components/responses/security.get_permissions_info___500' 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' + - $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/_security/api/roles/{name}: + /_opendistro/_security/api/roles/{role}: get: operationId: security.get_role.0_superseded x-operation-group: security.get_role @@ -13002,15 +13500,15 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#get-role parameters: - - $ref: '#/components/parameters/security.get_role::path.role' - - $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' + - $ref: '#/components/parameters/security.get_role___path.role' + - $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_role@200' + $ref: '#/components/responses/security.get_role___200' deprecated: true x-ignorable: true put: @@ -13024,19 +13522,19 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#create-role parameters: - - $ref: '#/components/parameters/security.create_role::path.role' - - $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' + - $ref: '#/components/parameters/security.create_role___path.role' + - $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/security.create_role' responses: '200': - $ref: '#/components/responses/security.create_role@200' + $ref: '#/components/responses/security.create_role___200' '201': - $ref: '#/components/responses/security.create_role@201' + $ref: '#/components/responses/security.create_role___201' deprecated: true x-ignorable: true patch: @@ -13050,19 +13548,19 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#patch-role parameters: - - $ref: '#/components/parameters/security.patch_role::path.role' - - $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' + - $ref: '#/components/parameters/security.patch_role___path.role' + - $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/security.patch_role' responses: '200': - $ref: '#/components/responses/security.patch_role@200' + $ref: '#/components/responses/security.patch_role___200' '400': - $ref: '#/components/responses/security.patch_role@400' + $ref: '#/components/responses/security.patch_role___400' deprecated: true x-ignorable: true delete: @@ -13076,18 +13574,18 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#delete-role parameters: - - $ref: '#/components/parameters/security.delete_role::path.role' - - $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' + - $ref: '#/components/parameters/security.delete_role___path.role' + - $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.delete_role@200' + $ref: '#/components/responses/security.delete_role___200' deprecated: true x-ignorable: true - /_opendistro/_security/api/rolesmapping/{name}: + /_opendistro/_security/api/rolesmapping/{role}: get: operationId: security.get_role_mapping.0_superseded x-operation-group: security.get_role_mapping @@ -13099,15 +13597,15 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#get-role-mapping parameters: - - $ref: '#/components/parameters/security.get_role_mapping::path.role' - - $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' + - $ref: '#/components/parameters/security.get_role_mapping___path.role' + - $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_role_mapping@200' + $ref: '#/components/responses/security.get_role_mapping___200' deprecated: true x-ignorable: true put: @@ -13121,19 +13619,19 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#create-role-mapping parameters: - - $ref: '#/components/parameters/security.create_role_mapping::path.role' - - $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' + - $ref: '#/components/parameters/security.create_role_mapping___path.role' + - $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/security.create_role_mapping' responses: '200': - $ref: '#/components/responses/security.create_role_mapping@200' + $ref: '#/components/responses/security.create_role_mapping___200' '201': - $ref: '#/components/responses/security.create_role_mapping@201' + $ref: '#/components/responses/security.create_role_mapping___201' deprecated: true x-ignorable: true patch: @@ -13147,19 +13645,19 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#patch-role-mapping parameters: - - $ref: '#/components/parameters/security.patch_role_mapping::path.role' - - $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' + - $ref: '#/components/parameters/security.patch_role_mapping___path.role' + - $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/security.patch_role_mapping' responses: '200': - $ref: '#/components/responses/security.patch_role_mapping@200' + $ref: '#/components/responses/security.patch_role_mapping___200' '400': - $ref: '#/components/responses/security.patch_role_mapping@400' + $ref: '#/components/responses/security.patch_role_mapping___400' deprecated: true x-ignorable: true delete: @@ -13173,15 +13671,15 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#delete-role-mapping parameters: - - $ref: '#/components/parameters/security.delete_role_mapping::path.role' - - $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' + - $ref: '#/components/parameters/security.delete_role_mapping___path.role' + - $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.delete_role_mapping@200' + $ref: '#/components/responses/security.delete_role_mapping___200' deprecated: true x-ignorable: true /_opendistro/_security/api/securityconfig: @@ -13197,13 +13695,13 @@ paths: url: https://opensearch.org/docs/latest/security/access-control/api/#get-configuration responses: '200': - $ref: '#/components/responses/security.get_configuration@200' + $ref: '#/components/responses/security.get_configuration___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' + - $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 patch: @@ -13213,22 +13711,22 @@ paths: 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. + 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 requestBody: $ref: '#/components/requestBodies/security.patch_configuration' responses: '200': - $ref: '#/components/responses/security.patch_configuration@200' + $ref: '#/components/responses/security.patch_configuration___200' '403': - $ref: '#/components/responses/security.patch_configuration@403' + $ref: '#/components/responses/security.patch_configuration___403' 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' + - $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/_security/api/securityconfig/config: @@ -13239,22 +13737,22 @@ paths: 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. + 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 requestBody: $ref: '#/components/requestBodies/security.update_configuration' responses: '200': - $ref: '#/components/responses/security.update_configuration@200' + $ref: '#/components/responses/security.update_configuration___200' '403': - $ref: '#/components/responses/security.update_configuration@403' + $ref: '#/components/responses/security.update_configuration___403' 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' + - $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/_security/api/ssl/certs: @@ -13270,17 +13768,17 @@ paths: url: https://opensearch.org/docs/latest/security/access-control/api/#get-certificates responses: '200': - $ref: '#/components/responses/security.get_certificates@200' + $ref: '#/components/responses/security.get_certificates___200' '400': - $ref: '#/components/responses/security.get_certificates@400' + $ref: '#/components/responses/security.get_certificates___400' '403': - $ref: '#/components/responses/security.get_certificates@403' + $ref: '#/components/responses/security.get_certificates___403' 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' + - $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/_security/api/ssl/transport/reloadcerts: @@ -13296,17 +13794,17 @@ paths: url: https://opensearch.org/docs/latest/security/access-control/api/#reload-transport-certificates responses: '200': - $ref: '#/components/responses/security.reload_transport_certificates@200' + $ref: '#/components/responses/security.reload_transport_certificates___200' '400': - $ref: '#/components/responses/security.reload_transport_certificates@400' + $ref: '#/components/responses/security.reload_transport_certificates___400' '403': - $ref: '#/components/responses/security.reload_transport_certificates@403' + $ref: '#/components/responses/security.reload_transport_certificates___403' 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' + - $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/_security/api/ssl/http/reloadcerts: @@ -13322,17 +13820,17 @@ paths: url: https://opensearch.org/docs/latest/security/access-control/api/#reload-http-certificates responses: '200': - $ref: '#/components/responses/security.reload_http_certificates@200' + $ref: '#/components/responses/security.reload_http_certificates___200' '400': - $ref: '#/components/responses/security.reload_http_certificates@400' + $ref: '#/components/responses/security.reload_http_certificates___400' '403': - $ref: '#/components/responses/security.reload_http_certificates@403' + $ref: '#/components/responses/security.reload_http_certificates___403' 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' + - $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/_security/api/nodesdn/{cluster_name}: @@ -13347,20 +13845,20 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#get-distinguished-names parameters: - - $ref: '#/components/parameters/security.get_distinguished_name::path.cluster_name' - - $ref: '#/components/parameters/security.get_distinguished_name::query.show_all' - - $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' + - $ref: '#/components/parameters/security.get_distinguished_name___path.cluster_name' + - $ref: '#/components/parameters/security.get_distinguished_name___query.show_all' + - $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_distinguished_name@200' + $ref: '#/components/responses/security.get_distinguished_name___200' '400': - $ref: '#/components/responses/security.get_distinguished_name@400' + $ref: '#/components/responses/security.get_distinguished_name___400' '403': - $ref: '#/components/responses/security.get_distinguished_name@403' + $ref: '#/components/responses/security.get_distinguished_name___403' deprecated: true x-ignorable: true put: @@ -13374,21 +13872,21 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#update-distinguished-names parameters: - - $ref: '#/components/parameters/security.update_distinguished_name::path.cluster_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' + - $ref: '#/components/parameters/security.update_distinguished_name___path.cluster_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' requestBody: $ref: '#/components/requestBodies/security.update_distinguished_name' responses: '200': - $ref: '#/components/responses/security.update_distinguished_name@200' + $ref: '#/components/responses/security.update_distinguished_name___200' '400': - $ref: '#/components/responses/security.update_distinguished_name@400' + $ref: '#/components/responses/security.update_distinguished_name___400' '403': - $ref: '#/components/responses/security.update_distinguished_name@403' + $ref: '#/components/responses/security.update_distinguished_name___403' deprecated: true x-ignorable: true patch: @@ -13400,21 +13898,21 @@ paths: - 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' - - $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' + - $ref: '#/components/parameters/security.patch_distinguished_name___path.cluster_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' requestBody: $ref: '#/components/requestBodies/security.patch_distinguished_name' responses: '200': - $ref: '#/components/responses/security.patch_distinguished_name@200' + $ref: '#/components/responses/security.patch_distinguished_name___200' '400': - $ref: '#/components/responses/security.patch_distinguished_name@400' + $ref: '#/components/responses/security.patch_distinguished_name___400' '403': - $ref: '#/components/responses/security.patch_distinguished_name@403' + $ref: '#/components/responses/security.patch_distinguished_name___403' deprecated: true x-ignorable: true delete: @@ -13428,19 +13926,19 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#delete-distinguished-names parameters: - - $ref: '#/components/parameters/security.delete_distinguished_name::path.cluster_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' + - $ref: '#/components/parameters/security.delete_distinguished_name___path.cluster_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/security.delete_distinguished_name@200' + $ref: '#/components/responses/security.delete_distinguished_name___200' '400': - $ref: '#/components/responses/security.delete_distinguished_name@400' + $ref: '#/components/responses/security.delete_distinguished_name___400' '403': - $ref: '#/components/responses/security.delete_distinguished_name@403' + $ref: '#/components/responses/security.delete_distinguished_name___403' deprecated: true x-ignorable: true /_opendistro/_security/api/tenancy/config: @@ -13456,15 +13954,15 @@ paths: url: https://opensearch.org/docs/latest/security/multi-tenancy/dynamic-config/#configuring-multi-tenancy-with-the-rest-api responses: '200': - $ref: '#/components/responses/security.get_tenancy_config@200' + $ref: '#/components/responses/security.get_tenancy_config___200' '400': - $ref: '#/components/responses/security.get_tenancy_config@400' + $ref: '#/components/responses/security.get_tenancy_config___400' 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' + - $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 put: @@ -13481,15 +13979,15 @@ paths: $ref: '#/components/requestBodies/security.create_update_tenancy_config' responses: '200': - $ref: '#/components/responses/security.create_update_tenancy_config@200' + $ref: '#/components/responses/security.create_update_tenancy_config___200' '400': - $ref: '#/components/responses/security.create_update_tenancy_config@400' + $ref: '#/components/responses/security.create_update_tenancy_config___400' 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' + - $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/_security/api/tenants: @@ -13505,15 +14003,15 @@ paths: url: https://opensearch.org/docs/latest/security/access-control/api/#get-tenants responses: '200': - $ref: '#/components/responses/security.get_tenants@200' + $ref: '#/components/responses/security.get_tenants___200' '400': - $ref: '#/components/responses/security.get_tenants@400' + $ref: '#/components/responses/security.get_tenants___400' 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' + - $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 patch: @@ -13530,18 +14028,18 @@ paths: $ref: '#/components/requestBodies/security.patch_tenants' responses: '200': - $ref: '#/components/responses/security.patch_tenants@200' + $ref: '#/components/responses/security.patch_tenants___200' '400': - $ref: '#/components/responses/security.patch_tenants@400' + $ref: '#/components/responses/security.patch_tenants___400' 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' + - $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/_security/api/tenants/{name}: + /_opendistro/_security/api/tenants/{tenant}: get: operationId: security.get_tenant.0_superseded x-operation-group: security.get_tenant @@ -13553,15 +14051,15 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#get-tenant parameters: - - $ref: '#/components/parameters/security.get_tenant::path.tenant' - - $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' + - $ref: '#/components/parameters/security.get_tenant___path.tenant' + - $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_tenant@200' + $ref: '#/components/responses/security.get_tenant___200' deprecated: true x-ignorable: true put: @@ -13575,21 +14073,21 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#create-tenant parameters: - - $ref: '#/components/parameters/security.create_tenant::path.tenant' - - $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' + - $ref: '#/components/parameters/security.create_tenant___path.tenant' + - $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/security.create_tenant' responses: '200': - $ref: '#/components/responses/security.create_tenant@200' + $ref: '#/components/responses/security.create_tenant___200' '201': - $ref: '#/components/responses/security.create_tenant@201' + $ref: '#/components/responses/security.create_tenant___201' '400': - $ref: '#/components/responses/security.create_tenant@400' + $ref: '#/components/responses/security.create_tenant___400' deprecated: true x-ignorable: true patch: @@ -13603,19 +14101,19 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#patch-tenant parameters: - - $ref: '#/components/parameters/security.patch_tenant::path.tenant' - - $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' + - $ref: '#/components/parameters/security.patch_tenant___path.tenant' + - $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/security.patch_tenant' responses: '200': - $ref: '#/components/responses/security.patch_tenant@200' + $ref: '#/components/responses/security.patch_tenant___200' '400': - $ref: '#/components/responses/security.patch_tenant@400' + $ref: '#/components/responses/security.patch_tenant___400' deprecated: true x-ignorable: true delete: @@ -13629,17 +14127,17 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#delete-action-group parameters: - - $ref: '#/components/parameters/security.delete_tenant::path.tenant' - - $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' + - $ref: '#/components/parameters/security.delete_tenant___path.tenant' + - $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.delete_tenant@200' + $ref: '#/components/responses/security.delete_tenant___200' '400': - $ref: '#/components/responses/security.delete_tenant@400' + $ref: '#/components/responses/security.delete_tenant___400' deprecated: true x-ignorable: true /_opendistro/_security/api/user: @@ -13653,16 +14151,16 @@ paths: description: Retrieve all internal users. Legacy API. responses: '200': - $ref: '#/components/responses/security.get_users_legacy@200' + $ref: '#/components/responses/security.get_users_legacy___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' + - $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/_security/api/user/{name}: + /_opendistro/_security/api/user/{username}: get: operationId: security.get_user_legacy.0_superseded x-operation-group: security.get_user_legacy @@ -13672,15 +14170,15 @@ paths: - amazon-serverless description: Retrieve one user. Legacy API. parameters: - - $ref: '#/components/parameters/security.get_user_legacy::path.username' - - $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' + - $ref: '#/components/parameters/security.get_user_legacy___path.username' + - $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_user_legacy@200' + $ref: '#/components/responses/security.get_user_legacy___200' deprecated: true x-ignorable: true put: @@ -13692,19 +14190,19 @@ paths: - amazon-serverless description: Creates or replaces the specified user. Legacy API. parameters: - - $ref: '#/components/parameters/security.create_user_legacy::path.username' - - $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' + - $ref: '#/components/parameters/security.create_user_legacy___path.username' + - $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/security.create_user_legacy' responses: '200': - $ref: '#/components/responses/security.create_user_legacy@200' + $ref: '#/components/responses/security.create_user_legacy___200' '201': - $ref: '#/components/responses/security.create_user_legacy@201' + $ref: '#/components/responses/security.create_user_legacy___201' deprecated: true x-ignorable: true delete: @@ -13716,18 +14214,18 @@ paths: - amazon-serverless description: Delete the specified user. Legacy API. parameters: - - $ref: '#/components/parameters/security.delete_user_legacy::path.username' - - $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' + - $ref: '#/components/parameters/security.delete_user_legacy___path.username' + - $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.delete_user_legacy@200' + $ref: '#/components/responses/security.delete_user_legacy___200' deprecated: true x-ignorable: true - /_opendistro/_security/api/user/{name}/authtoken: + /_opendistro/_security/api/user/{username}/authtoken: post: operationId: security.generate_user_token_legacy.0_superseded x-operation-group: security.generate_user_token_legacy @@ -13735,17 +14233,17 @@ paths: x-distributions-excluded: - amazon-managed - amazon-serverless - description: Generates authorization token for the given user. Legacy API. Not Implemented. + 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' - - $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' + - $ref: '#/components/parameters/security.generate_user_token_legacy___path.username' + - $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: '501': - $ref: '#/components/responses/security.generate_user_token_legacy@501' + $ref: '#/components/responses/security.generate_user_token_legacy___501' deprecated: true x-ignorable: true /_opendistro/_security/api/validate: @@ -13758,17 +14256,17 @@ paths: - 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' - - $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' + - $ref: '#/components/parameters/security.validate___query.accept_invalid' + - $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.validate@200' + $ref: '#/components/responses/security.validate___200' '400': - $ref: '#/components/responses/security.validate@400' + $ref: '#/components/responses/security.validate___400' deprecated: true x-ignorable: true /_opendistro/_security/api/allowlist: @@ -13784,15 +14282,15 @@ paths: url: https://opensearch.org/docs/latest/security/access-control/api/#access-control-for-the-api responses: '200': - $ref: '#/components/responses/security.get_allowlist@200' + $ref: '#/components/responses/security.get_allowlist___200' '403': - $ref: '#/components/responses/security.get_allowlist@403' + $ref: '#/components/responses/security.get_allowlist___403' 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' + - $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 put: @@ -13802,22 +14300,22 @@ paths: x-distributions-excluded: - amazon-managed - amazon-serverless - description: Creates or replaces the allowlisted APIs. Accessible via Super Admin certificate or REST API permission. + description: Creates or replaces the permitted APIs. Accessible using Super Admin certificate or REST API permission. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#access-control-for-the-api requestBody: $ref: '#/components/requestBodies/security.create_allowlist' responses: '200': - $ref: '#/components/responses/security.create_allowlist@200' + $ref: '#/components/responses/security.create_allowlist___200' '403': - $ref: '#/components/responses/security.create_allowlist@403' + $ref: '#/components/responses/security.create_allowlist___403' 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' + - $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 patch: @@ -13834,15 +14332,15 @@ paths: $ref: '#/components/requestBodies/security.patch_allowlist' responses: '200': - $ref: '#/components/responses/security.patch_allowlist@200' + $ref: '#/components/responses/security.patch_allowlist___200' '403': - $ref: '#/components/responses/security.patch_allowlist@403' + $ref: '#/components/responses/security.patch_allowlist___403' 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' + - $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/_security/authinfo: @@ -13855,18 +14353,18 @@ paths: - amazon-serverless description: Returns the authentication information. parameters: - - $ref: '#/components/parameters/security.authinfo::query.auth_type' - - $ref: '#/components/parameters/security.authinfo::query.verbose' - - $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' + - $ref: '#/components/parameters/security.authinfo___query.auth_type' + - $ref: '#/components/parameters/security.authinfo___query.verbose' + - $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.authinfo@200' + $ref: '#/components/responses/security.authinfo___200' '500': - $ref: '#/components/responses/security.authinfo@500' + $ref: '#/components/responses/security.authinfo___500' deprecated: true x-ignorable: true post: @@ -13878,18 +14376,18 @@ paths: - amazon-serverless description: Returns the authentication information. parameters: - - $ref: '#/components/parameters/security.authinfo::query.auth_type' - - $ref: '#/components/parameters/security.authinfo::query.verbose' - - $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' + - $ref: '#/components/parameters/security.authinfo___query.auth_type' + - $ref: '#/components/parameters/security.authinfo___query.verbose' + - $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.authinfo@200' + $ref: '#/components/responses/security.authinfo___200' '500': - $ref: '#/components/responses/security.authinfo@500' + $ref: '#/components/responses/security.authinfo___500' deprecated: true x-ignorable: true /_opendistro/_security/health: @@ -13902,17 +14400,17 @@ paths: - amazon-serverless description: Checks to see if the Security plugin is up and running. parameters: - - $ref: '#/components/parameters/security.health::query.mode' - - $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' + - $ref: '#/components/parameters/security.health___query.mode' + - $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' externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#health-check responses: '200': - $ref: '#/components/responses/security.health@200' + $ref: '#/components/responses/security.health___200' deprecated: true x-ignorable: true post: @@ -13924,17 +14422,17 @@ paths: - amazon-serverless description: Checks to see if the Security plugin is up and running. parameters: - - $ref: '#/components/parameters/security.health::query.mode' - - $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' + - $ref: '#/components/parameters/security.health___query.mode' + - $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' externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#health-check responses: '200': - $ref: '#/components/responses/security.health@200' + $ref: '#/components/responses/security.health___200' deprecated: true x-ignorable: true /_opendistro/_security/kibanainfo: @@ -13948,15 +14446,15 @@ paths: description: Retrieves the current security-dashboards plugin configuration. responses: '200': - $ref: '#/components/responses/security.get_dashboards_info@200' + $ref: '#/components/responses/security.get_dashboards_info___200' '500': - $ref: '#/components/responses/security.get_dashboards_info@500' + $ref: '#/components/responses/security.get_dashboards_info___500' 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' + - $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 post: @@ -13969,15 +14467,15 @@ paths: description: Updates the current security-dashboards plugin configuration. responses: '200': - $ref: '#/components/responses/security.post_dashboards_info@200' + $ref: '#/components/responses/security.post_dashboards_info___200' '500': - $ref: '#/components/responses/security.post_dashboards_info@500' + $ref: '#/components/responses/security.post_dashboards_info___500' 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' + - $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/_security/tenantinfo: @@ -13991,17 +14489,17 @@ paths: 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' + $ref: '#/components/responses/security.tenant_info___200' '403': - $ref: '#/components/responses/security.tenant_info@403' + $ref: '#/components/responses/security.tenant_info___403' '500': - $ref: '#/components/responses/security.tenant_info@500' + $ref: '#/components/responses/security.tenant_info___500' 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' + - $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 post: @@ -14014,17 +14512,17 @@ paths: 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' + $ref: '#/components/responses/security.tenant_info___200' '403': - $ref: '#/components/responses/security.tenant_info@403' + $ref: '#/components/responses/security.tenant_info___403' '500': - $ref: '#/components/responses/security.tenant_info@500' + $ref: '#/components/responses/security.tenant_info___500' 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' + - $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/_sql: @@ -14036,18 +14534,18 @@ paths: 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' + - $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' + $ref: '#/components/responses/sql.query___200' deprecated: true x-ignorable: true /_opendistro/_sql/_explain: @@ -14059,18 +14557,18 @@ paths: 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' + - $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' + $ref: '#/components/responses/sql.explain___200' deprecated: true x-ignorable: true /_opendistro/_sql/close: @@ -14082,18 +14580,18 @@ paths: 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' + - $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' + $ref: '#/components/responses/sql.close___200' deprecated: true x-ignorable: true /_opendistro/_sql/settings: @@ -14105,17 +14603,17 @@ paths: 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' + - $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' + $ref: '#/components/responses/sql.settings___200' deprecated: true x-ignorable: true /_opendistro/_sql/stats: @@ -14127,16 +14625,16 @@ paths: 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' + - $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' + $ref: '#/components/responses/sql.get_stats___200' deprecated: true x-ignorable: true post: @@ -14147,18 +14645,18 @@ paths: 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' + - $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' + $ref: '#/components/responses/sql.post_stats___200' deprecated: true x-ignorable: true /_cluster/nodes/hotthreads: @@ -14174,20 +14672,20 @@ paths: 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' + - $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' + $ref: '#/components/responses/nodes.hot_threads___200' /_cluster/nodes/{node_id}/hotthreads: get: operationId: nodes.hot_threads.2_superseded @@ -14201,21 +14699,21 @@ paths: 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' + - $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 @@ -14225,21 +14723,21 @@ paths: 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' + - $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: @@ -14251,56 +14749,56 @@ paths: 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' + - $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' + $ref: '#/components/responses/nodes.hot_threads___200' deprecated: true x-ignorable: true components: parameters: - _global::query.pretty: + _global___query.pretty: name: pretty in: query description: Whether to pretty format the returned JSON response. schema: type: boolean - default: false + default: false x-global: true - _global::query.human: + _global___query.human: name: human in: query description: Whether to return human readable values for statistics. schema: type: boolean - default: true + default: true x-global: true - _global::query.error_trace: + _global___query.error_trace: name: error_trace in: query description: Whether to include the stack trace of returned errors. schema: type: boolean - default: false + default: false x-global: true - _global::query.source: + _global___query.source: name: source in: query description: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. schema: type: string x-global: true - _global::query.filter_path: + _global___query.filter_path: name: filter_path in: query description: Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-". @@ -14311,85 +14809,87 @@ components: items: type: string x-global: true - asynchronous_search.delete::path.id: + asynchronous_search.delete___path.id: name: id in: path schema: type: string - asynchronous_search.get::path.id: + required: true + asynchronous_search.get___path.id: name: id in: path schema: type: string - asynchronous_search.search::query.index: + required: true + 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: + 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: + 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: + 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_stream::path.index: + bulk_stream___path.index: in: path name: index description: Name of the data stream, index, or index alias to perform bulk actions on. required: true schema: - $ref: '#/components/schemas/_common:IndexName' + $ref: '#/components/schemas/_common___IndexName' style: simple - bulk_stream::query._source: + bulk_stream___query._source: in: query name: _source description: '`true` or `false` to return the `_source` field or not, or a list of fields to return.' schema: - $ref: '#/components/schemas/_core.search:SourceConfigParam' + $ref: '#/components/schemas/_core.search___SourceConfigParam' style: form - bulk_stream::query._source_excludes: + bulk_stream___query._source_excludes: in: query name: _source_excludes description: A comma-separated list of source fields to exclude from the response. schema: - $ref: '#/components/schemas/_common:Fields' + $ref: '#/components/schemas/_common___Fields' style: form - bulk_stream::query._source_includes: + bulk_stream___query._source_includes: in: query name: _source_includes description: A comma-separated list of source fields to include in the response. schema: - $ref: '#/components/schemas/_common:Fields' + $ref: '#/components/schemas/_common___Fields' style: form - bulk_stream::query.batch_interval: + bulk_stream___query.batch_interval: in: query name: batch_interval description: Specifies for how long bulk operations should be accumulated into a batch before sending the batch to data nodes. schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' style: form - bulk_stream::query.batch_size: + bulk_stream___query.batch_size: in: query name: batch_size description: Specifies how many bulk operations should be accumulated into a batch before sending the batch to data nodes. schema: - $ref: '#/components/schemas/_common:BatchSize' + $ref: '#/components/schemas/_common___BatchSize' style: form x-default: 1 - bulk_stream::query.pipeline: + bulk_stream___query.pipeline: in: query name: pipeline description: |- @@ -14399,16 +14899,16 @@ components: schema: type: string style: form - bulk_stream::query.refresh: + bulk_stream___query.refresh: in: query name: refresh description: |- If `true`, OpenSearch refreshes the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` do nothing with refreshes. Valid values: `true`, `false`, `wait_for`. schema: - $ref: '#/components/schemas/_common:Refresh' + $ref: '#/components/schemas/_common___Refresh' style: form - bulk_stream::query.require_alias: + bulk_stream___query.require_alias: in: query name: require_alias description: If `true`, the request's actions must target an index alias. @@ -14416,67 +14916,67 @@ components: type: boolean default: false style: form - bulk_stream::query.routing: + bulk_stream___query.routing: in: query name: routing description: Custom value used to route operations to a specific shard. schema: - $ref: '#/components/schemas/_common:RoutingInQueryString' + $ref: '#/components/schemas/_common___RoutingInQueryString' style: form - bulk_stream::query.timeout: + bulk_stream___query.timeout: in: query name: timeout description: 'Period each action waits for the following operations: automatic index creation, dynamic mapping updates, waiting for active shards.' schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' style: form - bulk_stream::query.type: + bulk_stream___query.type: name: type in: query description: Default document type for items which don't provide one. schema: type: string description: Default document type for items which don't provide one. - bulk_stream::query.wait_for_active_shards: + bulk_stream___query.wait_for_active_shards: in: query name: wait_for_active_shards description: |- The number of shard copies that must be active before proceeding with the operation. Set to all or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). schema: - $ref: '#/components/schemas/_common:WaitForActiveShards' + $ref: '#/components/schemas/_common___WaitForActiveShards' style: form x-default: '1' - bulk::path.index: + bulk___path.index: in: path name: index description: Name of the data stream, index, or index alias to perform bulk actions on. required: true schema: - $ref: '#/components/schemas/_common:IndexName' + $ref: '#/components/schemas/_common___IndexName' style: simple - bulk::query._source: + bulk___query._source: in: query name: _source description: '`true` or `false` to return the `_source` field or not, or a list of fields to return.' schema: - $ref: '#/components/schemas/_core.search:SourceConfigParam' + $ref: '#/components/schemas/_core.search___SourceConfigParam' style: form - bulk::query._source_excludes: + bulk___query._source_excludes: in: query name: _source_excludes description: A comma-separated list of source fields to exclude from the response. schema: - $ref: '#/components/schemas/_common:Fields' + $ref: '#/components/schemas/_common___Fields' style: form - bulk::query._source_includes: + bulk___query._source_includes: in: query name: _source_includes description: A comma-separated list of source fields to include in the response. schema: - $ref: '#/components/schemas/_common:Fields' + $ref: '#/components/schemas/_common___Fields' style: form - bulk::query.pipeline: + bulk___query.pipeline: in: query name: pipeline description: |- @@ -14486,16 +14986,16 @@ components: schema: type: string style: form - bulk::query.refresh: + bulk___query.refresh: in: query name: refresh description: |- If `true`, OpenSearch refreshes the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` do nothing with refreshes. Valid values: `true`, `false`, `wait_for`. schema: - $ref: '#/components/schemas/_common:Refresh' + $ref: '#/components/schemas/_common___Refresh' style: form - bulk::query.require_alias: + bulk___query.require_alias: in: query name: require_alias description: If `true`, the request's actions must target an index alias. @@ -14503,60 +15003,60 @@ components: type: boolean default: false style: form - bulk::query.routing: + bulk___query.routing: in: query name: routing description: Custom value used to route operations to a specific shard. schema: - $ref: '#/components/schemas/_common:RoutingInQueryString' + $ref: '#/components/schemas/_common___RoutingInQueryString' style: form - bulk::query.timeout: + bulk___query.timeout: in: query name: timeout description: 'Period each action waits for the following operations: automatic index creation, dynamic mapping updates, waiting for active shards.' schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' style: form - bulk::query.type: + bulk___query.type: name: type in: query description: Default document type for items which don't provide one. schema: type: string description: Default document type for items which don't provide one. - bulk::query.wait_for_active_shards: + bulk___query.wait_for_active_shards: in: query name: wait_for_active_shards description: |- The number of shard copies that must be active before proceeding with the operation. Set to all or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). schema: - $ref: '#/components/schemas/_common:WaitForActiveShards' + $ref: '#/components/schemas/_common___WaitForActiveShards' style: form x-default: '1' - cat.aliases::path.name: + cat.aliases___path.name: in: path name: name description: A comma-separated list of aliases to retrieve. Supports wildcards (`*`). To retrieve all aliases, omit this parameter or use `*` or `_all`. required: true schema: - $ref: '#/components/schemas/_common:Names' + $ref: '#/components/schemas/_common___Names' style: simple - cat.aliases::query.expand_wildcards: + cat.aliases___query.expand_wildcards: in: query name: expand_wildcards - description: Whether to expand wildcard expression to concrete indices that are open, closed or both. + description: Whether to expand wildcard expression to concrete indexes that are open, closed or both. schema: - $ref: '#/components/schemas/_common:ExpandWildcards' + $ref: '#/components/schemas/_common___ExpandWildcards' style: form - cat.aliases::query.format: + cat.aliases___query.format: name: format in: query - description: A short version of the Accept header, e.g. json, yaml. + description: A short version of the Accept header (for example, `json`, `yaml`). schema: type: string - description: A short version of the Accept header, e.g. json, yaml. - cat.aliases::query.h: + description: A short version of the Accept header (for example, `json`, `yaml`). + cat.aliases___query.h: name: h in: query description: Comma-separated list of column names to display. @@ -14567,7 +15067,7 @@ components: type: string description: Comma-separated list of column names to display. explode: true - cat.aliases::query.help: + cat.aliases___query.help: name: help in: query description: Return help information. @@ -14575,7 +15075,7 @@ components: description: Return help information. type: boolean default: false - cat.aliases::query.local: + cat.aliases___query.local: name: local in: query description: Return local information, do not retrieve the state from cluster-manager node. @@ -14583,7 +15083,7 @@ components: type: boolean default: false description: Return local information, do not retrieve the state from cluster-manager node. - cat.aliases::query.s: + cat.aliases___query.s: name: s in: query description: Comma-separated list of column names or column aliases to sort by. @@ -14594,7 +15094,7 @@ components: type: string description: Comma-separated list of column names or column aliases to sort by. explode: true - cat.aliases::query.v: + cat.aliases___query.v: name: v in: query description: Verbose mode. Display column headers. @@ -14602,20 +15102,20 @@ components: type: boolean default: false description: Verbose mode. Display column headers. - cat.all_pit_segments::query.bytes: + cat.all_pit_segments___query.bytes: name: bytes in: query description: The unit in which to display byte values. schema: - $ref: '#/components/schemas/_common:ByteUnit' - cat.all_pit_segments::query.format: + $ref: '#/components/schemas/_common___ByteUnit' + cat.all_pit_segments___query.format: name: format in: query - description: A short version of the Accept header, e.g. json, yaml. + description: A short version of the Accept header (for example, `json`, `yaml`). schema: type: string - description: A short version of the Accept header, e.g. json, yaml. - cat.all_pit_segments::query.h: + description: A short version of the Accept header (for example, `json`, `yaml`). + cat.all_pit_segments___query.h: name: h in: query description: Comma-separated list of column names to display. @@ -14626,7 +15126,7 @@ components: type: string description: Comma-separated list of column names to display. explode: true - cat.all_pit_segments::query.help: + cat.all_pit_segments___query.help: name: help in: query description: Return help information. @@ -14634,7 +15134,7 @@ components: type: boolean default: false description: Return help information. - cat.all_pit_segments::query.s: + cat.all_pit_segments___query.s: name: s in: query description: Comma-separated list of column names or column aliases to sort by. @@ -14645,7 +15145,7 @@ components: type: string description: Comma-separated list of column names or column aliases to sort by. explode: true - cat.all_pit_segments::query.v: + cat.all_pit_segments___query.v: name: v in: query description: Verbose mode. Display column headers. @@ -14653,36 +15153,36 @@ components: type: boolean default: false description: Verbose mode. Display column headers. - cat.allocation::path.node_id: + cat.allocation___path.node_id: in: path name: node_id description: Comma-separated list of node identifiers or names used to limit the returned information. required: true schema: - $ref: '#/components/schemas/_common:NodeIds' + $ref: '#/components/schemas/_common___NodeIds' style: simple - cat.allocation::query.bytes: + cat.allocation___query.bytes: in: query name: bytes description: The unit used to display byte values. schema: - $ref: '#/components/schemas/_common:ByteUnit' + $ref: '#/components/schemas/_common___ByteUnit' style: form - cat.allocation::query.cluster_manager_timeout: + cat.allocation___query.cluster_manager_timeout: name: cluster_manager_timeout in: query description: Operation timeout for connection to cluster-manager node. schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' x-version-added: '2.0' - cat.allocation::query.format: + cat.allocation___query.format: name: format in: query - description: A short version of the Accept header, e.g. json, yaml. + description: A short version of the Accept header (for example, `json`, `yaml`). schema: type: string - description: A short version of the Accept header, e.g. json, yaml. - cat.allocation::query.h: + description: A short version of the Accept header (for example, `json`, `yaml`). + cat.allocation___query.h: name: h in: query description: Comma-separated list of column names to display. @@ -14693,7 +15193,7 @@ components: type: string description: Comma-separated list of column names to display. explode: true - cat.allocation::query.help: + cat.allocation___query.help: name: help in: query description: Return help information. @@ -14701,7 +15201,7 @@ components: type: boolean default: false description: Return help information. - cat.allocation::query.local: + cat.allocation___query.local: name: local in: query description: Return local information, do not retrieve the state from cluster-manager node. @@ -14709,16 +15209,16 @@ components: type: boolean default: false description: Return local information, do not retrieve the state from cluster-manager node. - cat.allocation::query.master_timeout: + cat.allocation___query.master_timeout: name: master_timeout in: query - description: Operation timeout for connection to master node. + description: Operation timeout for connection to cluster-manager node. schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' x-version-deprecated: '2.0' - x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. deprecated: true - cat.allocation::query.s: + cat.allocation___query.s: name: s in: query description: Comma-separated list of column names or column aliases to sort by. @@ -14729,7 +15229,7 @@ components: type: string description: Comma-separated list of column names or column aliases to sort by. explode: true - cat.allocation::query.v: + cat.allocation___query.v: name: v in: query description: Verbose mode. Display column headers. @@ -14737,21 +15237,21 @@ components: type: boolean default: false description: Verbose mode. Display column headers. - cat.cluster_manager::query.cluster_manager_timeout: + cat.cluster_manager___query.cluster_manager_timeout: name: cluster_manager_timeout in: query description: Operation timeout for connection to cluster-manager node. schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' x-version-added: '2.0' - cat.cluster_manager::query.format: + cat.cluster_manager___query.format: name: format in: query - description: A short version of the Accept header, e.g. json, yaml. + description: A short version of the Accept header (for example, `json`, `yaml`). schema: type: string - description: A short version of the Accept header, e.g. json, yaml. - cat.cluster_manager::query.h: + description: A short version of the Accept header (for example, `json`, `yaml`). + cat.cluster_manager___query.h: name: h in: query description: Comma-separated list of column names to display. @@ -14762,7 +15262,7 @@ components: type: string description: Comma-separated list of column names to display. explode: true - cat.cluster_manager::query.help: + cat.cluster_manager___query.help: name: help in: query description: Return help information. @@ -14770,7 +15270,7 @@ components: type: boolean default: false description: Return help information. - cat.cluster_manager::query.local: + cat.cluster_manager___query.local: name: local in: query description: Return local information, do not retrieve the state from cluster-manager node. @@ -14778,16 +15278,16 @@ components: type: boolean default: false description: Return local information, do not retrieve the state from cluster-manager node. - cat.cluster_manager::query.master_timeout: + cat.cluster_manager___query.master_timeout: name: master_timeout in: query - description: Operation timeout for connection to master node. + description: Operation timeout for connection to cluster-manager node. schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' x-version-deprecated: '2.0' - x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. deprecated: true - cat.cluster_manager::query.s: + cat.cluster_manager___query.s: name: s in: query description: Comma-separated list of column names or column aliases to sort by. @@ -14798,7 +15298,7 @@ components: type: string description: Comma-separated list of column names or column aliases to sort by. explode: true - cat.cluster_manager::query.v: + cat.cluster_manager___query.v: name: v in: query description: Verbose mode. Display column headers. @@ -14806,24 +15306,24 @@ components: type: boolean default: false description: Verbose mode. Display column headers. - cat.count::path.index: + cat.count___path.index: in: path name: index description: |- - Comma-separated list of data streams, indices, and aliases used to limit the request. - Supports wildcards (`*`). To target all data streams and indices, omit this parameter or use `*` or `_all`. + Comma-separated list of data streams, indexes, and aliases used to limit the request. + Supports wildcards (`*`). To target all data streams and indexes, omit this parameter or use `*` or `_all`. required: true schema: - $ref: '#/components/schemas/_common:Indices' + $ref: '#/components/schemas/_common___Indices' style: simple - cat.count::query.format: + cat.count___query.format: name: format in: query - description: A short version of the Accept header, e.g. json, yaml. + description: A short version of the Accept header (for example, `json`, `yaml`). schema: type: string - description: A short version of the Accept header, e.g. json, yaml. - cat.count::query.h: + description: A short version of the Accept header (for example, `json`, `yaml`). + cat.count___query.h: name: h in: query description: Comma-separated list of column names to display. @@ -14834,7 +15334,7 @@ components: type: string description: Comma-separated list of column names to display. explode: true - cat.count::query.help: + cat.count___query.help: name: help in: query description: Return help information. @@ -14842,7 +15342,7 @@ components: type: boolean default: false description: Return help information. - cat.count::query.s: + cat.count___query.s: name: s in: query description: Comma-separated list of column names or column aliases to sort by. @@ -14853,7 +15353,7 @@ components: type: string description: Comma-separated list of column names or column aliases to sort by. explode: true - cat.count::query.v: + cat.count___query.v: name: v in: query description: Verbose mode. Display column headers. @@ -14861,7 +15361,7 @@ components: type: boolean default: false description: Verbose mode. Display column headers. - cat.fielddata::path.fields: + cat.fielddata___path.fields: in: path name: fields description: |- @@ -14869,30 +15369,30 @@ components: To retrieve all fields, omit this parameter. required: true schema: - $ref: '#/components/schemas/_common:Fields' + $ref: '#/components/schemas/_common___Fields' style: simple - cat.fielddata::query.bytes: + cat.fielddata___query.bytes: in: query name: bytes description: The unit used to display byte values. schema: - $ref: '#/components/schemas/_common:ByteUnit' + $ref: '#/components/schemas/_common___ByteUnit' style: form - cat.fielddata::query.fields: + cat.fielddata___query.fields: in: query name: fields description: Comma-separated list of fields used to limit returned information. schema: - $ref: '#/components/schemas/_common:Fields' + $ref: '#/components/schemas/_common___Fields' style: form - cat.fielddata::query.format: + cat.fielddata___query.format: name: format in: query - description: A short version of the Accept header, e.g. json, yaml. + description: A short version of the Accept header (for example, `json`, `yaml`). schema: type: string - description: A short version of the Accept header, e.g. json, yaml. - cat.fielddata::query.h: + description: A short version of the Accept header (for example, `json`, `yaml`). + cat.fielddata___query.h: name: h in: query description: Comma-separated list of column names to display. @@ -14903,7 +15403,7 @@ components: type: string description: Comma-separated list of column names to display. explode: true - cat.fielddata::query.help: + cat.fielddata___query.help: name: help in: query description: Return help information. @@ -14911,7 +15411,7 @@ components: type: boolean default: false description: Return help information. - cat.fielddata::query.s: + cat.fielddata___query.s: name: s in: query description: Comma-separated list of column names or column aliases to sort by. @@ -14922,7 +15422,7 @@ components: type: string description: Comma-separated list of column names or column aliases to sort by. explode: true - cat.fielddata::query.v: + cat.fielddata___query.v: name: v in: query description: Verbose mode. Display column headers. @@ -14930,14 +15430,14 @@ components: type: boolean default: false description: Verbose mode. Display column headers. - cat.health::query.format: + cat.health___query.format: name: format in: query - description: A short version of the Accept header, e.g. json, yaml. + description: A short version of the Accept header (for example, `json`, `yaml`). schema: type: string - description: A short version of the Accept header, e.g. json, yaml. - cat.health::query.h: + description: A short version of the Accept header (for example, `json`, `yaml`). + cat.health___query.h: name: h in: query description: Comma-separated list of column names to display. @@ -14948,7 +15448,7 @@ components: type: string description: Comma-separated list of column names to display. explode: true - cat.health::query.help: + cat.health___query.help: name: help in: query description: Return help information. @@ -14956,7 +15456,7 @@ components: type: boolean default: false description: Return help information. - cat.health::query.s: + cat.health___query.s: name: s in: query description: Comma-separated list of column names or column aliases to sort by. @@ -14967,22 +15467,22 @@ components: type: string description: Comma-separated list of column names or column aliases to sort by. explode: true - cat.health::query.time: + cat.health___query.time: in: query name: time description: The unit used to display time values. schema: - $ref: '#/components/schemas/_common:TimeUnit' + $ref: '#/components/schemas/_common___TimeUnit' style: form - cat.health::query.ts: + cat.health___query.ts: in: query name: ts - description: If true, returns `HH:MM:SS` and Unix epoch timestamps. + description: If `true`, returns `HH:MM:SS` and Unix epoch timestamps. schema: type: boolean default: true style: form - cat.health::query.v: + cat.health___query.v: name: v in: query description: Verbose mode. Display column headers. @@ -14990,45 +15490,45 @@ components: type: boolean default: false description: Verbose mode. Display column headers. - cat.indices::path.index: + cat.indices___path.index: in: path name: index description: |- - Comma-separated list of data streams, indices, and aliases used to limit the request. - Supports wildcards (`*`). To target all data streams and indices, omit this parameter or use `*` or `_all`. + Comma-separated list of data streams, indexes, and aliases used to limit the request. + Supports wildcards (`*`). To target all data streams and indexes, omit this parameter or use `*` or `_all`. required: true schema: - $ref: '#/components/schemas/_common:Indices' + $ref: '#/components/schemas/_common___Indices' style: simple - cat.indices::query.bytes: + cat.indices___query.bytes: in: query name: bytes description: The unit used to display byte values. schema: - $ref: '#/components/schemas/_common:ByteUnit' + $ref: '#/components/schemas/_common___ByteUnit' style: form - cat.indices::query.cluster_manager_timeout: + cat.indices___query.cluster_manager_timeout: name: cluster_manager_timeout in: query description: Operation timeout for connection to cluster-manager node. schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' x-version-added: '2.0' - cat.indices::query.expand_wildcards: + cat.indices___query.expand_wildcards: in: query name: expand_wildcards description: The type of index that wildcard patterns can match. schema: - $ref: '#/components/schemas/_common:ExpandWildcards' + $ref: '#/components/schemas/_common___ExpandWildcards' style: form - cat.indices::query.format: + cat.indices___query.format: name: format in: query - description: A short version of the Accept header, e.g. json, yaml. + description: A short version of the Accept header (for example, `json`, `yaml`). schema: type: string - description: A short version of the Accept header, e.g. json, yaml. - cat.indices::query.h: + description: A short version of the Accept header (for example, `json`, `yaml`). + cat.indices___query.h: name: h in: query description: Comma-separated list of column names to display. @@ -15039,14 +15539,14 @@ components: type: string description: Comma-separated list of column names to display. explode: true - cat.indices::query.health: + cat.indices___query.health: in: query name: health - description: The health status used to limit returned indices. By default, the response includes indices of any health status. + description: The health status used to limit returned indexes. By default, the response includes indexes of any health status. schema: - $ref: '#/components/schemas/_common:HealthStatus' + $ref: '#/components/schemas/_common___HealthStatus' style: form - cat.indices::query.help: + cat.indices___query.help: name: help in: query description: Return help information. @@ -15054,15 +15554,15 @@ components: type: boolean default: false description: Return help information. - cat.indices::query.include_unloaded_segments: + cat.indices___query.include_unloaded_segments: in: query name: include_unloaded_segments - description: If true, the response includes information from segments that are not loaded into memory. + description: If `true`, the response includes information from segments that are not loaded into memory. schema: type: boolean default: false style: form - cat.indices::query.local: + cat.indices___query.local: name: local in: query description: Return local information, do not retrieve the state from cluster-manager node. @@ -15070,24 +15570,24 @@ components: type: boolean default: false description: Return local information, do not retrieve the state from cluster-manager node. - cat.indices::query.master_timeout: + cat.indices___query.master_timeout: name: master_timeout in: query - description: Operation timeout for connection to master node. + description: Operation timeout for connection to cluster-manager node. schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' x-version-deprecated: '2.0' - x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. deprecated: true - cat.indices::query.pri: + cat.indices___query.pri: in: query name: pri - description: If true, the response only includes information from primary shards. + description: If `true`, the response only includes information from primary shards. schema: type: boolean default: false style: form - cat.indices::query.s: + cat.indices___query.s: name: s in: query description: Comma-separated list of column names or column aliases to sort by. @@ -15098,14 +15598,14 @@ components: type: string description: Comma-separated list of column names or column aliases to sort by. explode: true - cat.indices::query.time: + cat.indices___query.time: in: query name: time description: The unit used to display time values. schema: - $ref: '#/components/schemas/_common:TimeUnit' + $ref: '#/components/schemas/_common___TimeUnit' style: form - cat.indices::query.v: + cat.indices___query.v: name: v in: query description: Verbose mode. Display column headers. @@ -15113,21 +15613,21 @@ components: type: boolean default: false description: Verbose mode. Display column headers. - cat.master::query.cluster_manager_timeout: + cat.master___query.cluster_manager_timeout: name: cluster_manager_timeout in: query description: Operation timeout for connection to cluster-manager node. schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' x-version-added: '2.0' - cat.master::query.format: + cat.master___query.format: name: format in: query - description: A short version of the Accept header, e.g. json, yaml. + description: A short version of the Accept header (for example, `json`, `yaml`). schema: type: string - description: A short version of the Accept header, e.g. json, yaml. - cat.master::query.h: + description: A short version of the Accept header (for example, `json`, `yaml`). + cat.master___query.h: name: h in: query description: Comma-separated list of column names to display. @@ -15138,7 +15638,7 @@ components: type: string description: Comma-separated list of column names to display. explode: true - cat.master::query.help: + cat.master___query.help: name: help in: query description: Return help information. @@ -15146,7 +15646,7 @@ components: type: boolean default: false description: Return help information. - cat.master::query.local: + cat.master___query.local: name: local in: query description: Return local information, do not retrieve the state from cluster-manager node. @@ -15154,16 +15654,16 @@ components: type: boolean default: false description: Return local information, do not retrieve the state from cluster-manager node. - cat.master::query.master_timeout: + cat.master___query.master_timeout: name: master_timeout in: query - description: Operation timeout for connection to master node. + description: Operation timeout for connection to cluster-manager node. schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' x-version-deprecated: '2.0' - x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. deprecated: true - cat.master::query.s: + cat.master___query.s: name: s in: query description: Comma-separated list of column names or column aliases to sort by. @@ -15174,7 +15674,7 @@ components: type: string description: Comma-separated list of column names or column aliases to sort by. explode: true - cat.master::query.v: + cat.master___query.v: name: v in: query description: Verbose mode. Display column headers. @@ -15182,21 +15682,21 @@ components: type: boolean default: false description: Verbose mode. Display column headers. - cat.nodeattrs::query.cluster_manager_timeout: + cat.nodeattrs___query.cluster_manager_timeout: name: cluster_manager_timeout in: query description: Operation timeout for connection to cluster-manager node. schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' x-version-added: '2.0' - cat.nodeattrs::query.format: + cat.nodeattrs___query.format: name: format in: query - description: A short version of the Accept header, e.g. json, yaml. + description: A short version of the Accept header (for example, `json`, `yaml`). schema: type: string - description: A short version of the Accept header, e.g. json, yaml. - cat.nodeattrs::query.h: + description: A short version of the Accept header (for example, `json`, `yaml`). + cat.nodeattrs___query.h: name: h in: query description: Comma-separated list of column names to display. @@ -15207,7 +15707,7 @@ components: type: string description: Comma-separated list of column names to display. explode: true - cat.nodeattrs::query.help: + cat.nodeattrs___query.help: name: help in: query description: Return help information. @@ -15215,7 +15715,7 @@ components: type: boolean default: false description: Return help information. - cat.nodeattrs::query.local: + cat.nodeattrs___query.local: name: local in: query description: Return local information, do not retrieve the state from cluster-manager node. @@ -15223,16 +15723,16 @@ components: type: boolean default: false description: Return local information, do not retrieve the state from cluster-manager node. - cat.nodeattrs::query.master_timeout: + cat.nodeattrs___query.master_timeout: name: master_timeout in: query - description: Operation timeout for connection to master node. + description: Operation timeout for connection to cluster-manager node. schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' x-version-deprecated: '2.0' - x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. deprecated: true - cat.nodeattrs::query.s: + cat.nodeattrs___query.s: name: s in: query description: Comma-separated list of column names or column aliases to sort by. @@ -15243,7 +15743,7 @@ components: type: string description: Comma-separated list of column names or column aliases to sort by. explode: true - cat.nodeattrs::query.v: + cat.nodeattrs___query.v: name: v in: query description: Verbose mode. Display column headers. @@ -15251,28 +15751,28 @@ components: type: boolean default: false description: Verbose mode. Display column headers. - cat.nodes::query.bytes: + cat.nodes___query.bytes: in: query name: bytes description: The unit used to display byte values. schema: - $ref: '#/components/schemas/_common:ByteUnit' + $ref: '#/components/schemas/_common___ByteUnit' style: form - cat.nodes::query.cluster_manager_timeout: + cat.nodes___query.cluster_manager_timeout: name: cluster_manager_timeout in: query description: Operation timeout for connection to cluster-manager node. schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' x-version-added: '2.0' - cat.nodes::query.format: + cat.nodes___query.format: name: format in: query - description: A short version of the Accept header, e.g. json, yaml. + description: A short version of the Accept header (for example, `json`, `yaml`). schema: type: string - description: A short version of the Accept header, e.g. json, yaml. - cat.nodes::query.full_id: + description: A short version of the Accept header (for example, `json`, `yaml`). + cat.nodes___query.full_id: in: query name: full_id description: If `true`, return the full node ID. If `false`, return the shortened node ID. @@ -15282,7 +15782,7 @@ components: - type: string default: false style: form - cat.nodes::query.h: + cat.nodes___query.h: name: h in: query description: Comma-separated list of column names to display. @@ -15293,7 +15793,7 @@ components: type: string description: Comma-separated list of column names to display. explode: true - cat.nodes::query.help: + cat.nodes___query.help: name: help in: query description: Return help information. @@ -15301,7 +15801,7 @@ components: type: boolean default: false description: Return help information. - cat.nodes::query.local: + cat.nodes___query.local: name: local in: query description: Return local information, do not retrieve the state from cluster-manager node. @@ -15312,16 +15812,16 @@ components: type: boolean default: false description: Return local information, do not retrieve the state from cluster-manager node. - cat.nodes::query.master_timeout: + cat.nodes___query.master_timeout: name: master_timeout in: query - description: Operation timeout for connection to master node. + description: Operation timeout for connection to cluster-manager node. schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' x-version-deprecated: '2.0' - x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. deprecated: true - cat.nodes::query.s: + cat.nodes___query.s: name: s in: query description: Comma-separated list of column names or column aliases to sort by. @@ -15332,13 +15832,13 @@ components: type: string description: Comma-separated list of column names or column aliases to sort by. explode: true - cat.nodes::query.time: + cat.nodes___query.time: name: time in: query description: The unit in which to display time values. schema: - $ref: '#/components/schemas/_common:TimeUnit' - cat.nodes::query.v: + $ref: '#/components/schemas/_common___TimeUnit' + cat.nodes___query.v: name: v in: query description: Verbose mode. Display column headers. @@ -15346,21 +15846,21 @@ components: type: boolean default: false description: Verbose mode. Display column headers. - cat.pending_tasks::query.cluster_manager_timeout: + cat.pending_tasks___query.cluster_manager_timeout: name: cluster_manager_timeout in: query description: Operation timeout for connection to cluster-manager node. schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' x-version-added: '2.0' - cat.pending_tasks::query.format: + cat.pending_tasks___query.format: name: format in: query - description: A short version of the Accept header, e.g. json, yaml. + description: A short version of the Accept header (for example, `json`, `yaml`). schema: type: string - description: A short version of the Accept header, e.g. json, yaml. - cat.pending_tasks::query.h: + description: A short version of the Accept header (for example, `json`, `yaml`). + cat.pending_tasks___query.h: name: h in: query description: Comma-separated list of column names to display. @@ -15371,7 +15871,7 @@ components: type: string description: Comma-separated list of column names to display. explode: true - cat.pending_tasks::query.help: + cat.pending_tasks___query.help: name: help in: query description: Return help information. @@ -15379,7 +15879,7 @@ components: type: boolean default: false description: Return help information. - cat.pending_tasks::query.local: + cat.pending_tasks___query.local: name: local in: query description: Return local information, do not retrieve the state from cluster-manager node. @@ -15387,16 +15887,16 @@ components: type: boolean default: false description: Return local information, do not retrieve the state from cluster-manager node. - cat.pending_tasks::query.master_timeout: + cat.pending_tasks___query.master_timeout: name: master_timeout in: query - description: Operation timeout for connection to master node. + description: Operation timeout for connection to cluster-manager node. schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' x-version-deprecated: '2.0' - x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. deprecated: true - cat.pending_tasks::query.s: + cat.pending_tasks___query.s: name: s in: query description: Comma-separated list of column names or column aliases to sort by. @@ -15407,13 +15907,13 @@ components: type: string description: Comma-separated list of column names or column aliases to sort by. explode: true - cat.pending_tasks::query.time: + cat.pending_tasks___query.time: name: time in: query description: The unit in which to display time values. schema: - $ref: '#/components/schemas/_common:TimeUnit' - cat.pending_tasks::query.v: + $ref: '#/components/schemas/_common___TimeUnit' + cat.pending_tasks___query.v: name: v in: query description: Verbose mode. Display column headers. @@ -15421,20 +15921,20 @@ components: type: boolean default: false description: Verbose mode. Display column headers. - cat.pit_segments::query.bytes: + cat.pit_segments___query.bytes: name: bytes in: query description: The unit in which to display byte values. schema: - $ref: '#/components/schemas/_common:ByteUnit' - cat.pit_segments::query.format: + $ref: '#/components/schemas/_common___ByteUnit' + cat.pit_segments___query.format: name: format in: query - description: A short version of the Accept header, e.g. json, yaml. + description: A short version of the Accept header (for example, `json`, `yaml`). schema: type: string - description: A short version of the Accept header, e.g. json, yaml. - cat.pit_segments::query.h: + description: A short version of the Accept header (for example, `json`, `yaml`). + cat.pit_segments___query.h: name: h in: query description: Comma-separated list of column names to display. @@ -15445,7 +15945,7 @@ components: type: string description: Comma-separated list of column names to display. explode: true - cat.pit_segments::query.help: + cat.pit_segments___query.help: name: help in: query description: Return help information. @@ -15453,7 +15953,7 @@ components: type: boolean default: false description: Return help information. - cat.pit_segments::query.s: + cat.pit_segments___query.s: name: s in: query description: Comma-separated list of column names or column aliases to sort by. @@ -15464,7 +15964,7 @@ components: type: string description: Comma-separated list of column names or column aliases to sort by. explode: true - cat.pit_segments::query.v: + cat.pit_segments___query.v: name: v in: query description: Verbose mode. Display column headers. @@ -15472,21 +15972,21 @@ components: type: boolean default: false description: Verbose mode. Display column headers. - cat.plugins::query.cluster_manager_timeout: + cat.plugins___query.cluster_manager_timeout: name: cluster_manager_timeout in: query description: Operation timeout for connection to cluster-manager node. schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' x-version-added: '2.0' - cat.plugins::query.format: + cat.plugins___query.format: name: format in: query - description: A short version of the Accept header, e.g. json, yaml. + description: A short version of the Accept header (for example, `json`, `yaml`). schema: type: string - description: A short version of the Accept header, e.g. json, yaml. - cat.plugins::query.h: + description: A short version of the Accept header (for example, `json`, `yaml`). + cat.plugins___query.h: name: h in: query description: Comma-separated list of column names to display. @@ -15497,7 +15997,7 @@ components: type: string description: Comma-separated list of column names to display. explode: true - cat.plugins::query.help: + cat.plugins___query.help: name: help in: query description: Return help information. @@ -15505,7 +16005,7 @@ components: type: boolean default: false description: Return help information. - cat.plugins::query.local: + cat.plugins___query.local: name: local in: query description: Return local information, do not retrieve the state from cluster-manager node. @@ -15513,16 +16013,16 @@ components: type: boolean default: false description: Return local information, do not retrieve the state from cluster-manager node. - cat.plugins::query.master_timeout: + cat.plugins___query.master_timeout: name: master_timeout in: query - description: Operation timeout for connection to master node. + description: Operation timeout for connection to cluster-manager node. schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' x-version-deprecated: '2.0' - x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. deprecated: true - cat.plugins::query.s: + cat.plugins___query.s: name: s in: query description: Comma-separated list of column names or column aliases to sort by. @@ -15533,7 +16033,7 @@ components: type: string description: Comma-separated list of column names or column aliases to sort by. explode: true - cat.plugins::query.v: + cat.plugins___query.v: name: v in: query description: Verbose mode. Display column headers. @@ -15541,17 +16041,17 @@ components: type: boolean default: false description: Verbose mode. Display column headers. - cat.recovery::path.index: + cat.recovery___path.index: in: path name: index description: |- - A comma-separated list of data streams, indices, and aliases used to limit the request. - Supports wildcards (`*`). To target all data streams and indices, omit this parameter or use `*` or `_all`. + A comma-separated list of data streams, indexes, and aliases used to limit the request. + Supports wildcards (`*`). To target all data streams and indexes, omit this parameter or use `*` or `_all`. required: true schema: - $ref: '#/components/schemas/_common:Indices' + $ref: '#/components/schemas/_common___Indices' style: simple - cat.recovery::query.active_only: + cat.recovery___query.active_only: in: query name: active_only description: If `true`, the response only includes ongoing shard recoveries. @@ -15559,14 +16059,14 @@ components: type: boolean default: false style: form - cat.recovery::query.bytes: + cat.recovery___query.bytes: in: query name: bytes description: The unit used to display byte values. schema: - $ref: '#/components/schemas/_common:ByteUnit' + $ref: '#/components/schemas/_common___ByteUnit' style: form - cat.recovery::query.detailed: + cat.recovery___query.detailed: in: query name: detailed description: If `true`, the response includes detailed information about shard recoveries. @@ -15574,14 +16074,14 @@ components: type: boolean default: false style: form - cat.recovery::query.format: + cat.recovery___query.format: name: format in: query - description: A short version of the Accept header, e.g. json, yaml. + description: A short version of the Accept header (for example, `json`, `yaml`). schema: type: string - description: A short version of the Accept header, e.g. json, yaml. - cat.recovery::query.h: + description: A short version of the Accept header (for example, `json`, `yaml`). + cat.recovery___query.h: name: h in: query description: Comma-separated list of column names to display. @@ -15592,7 +16092,7 @@ components: type: string description: Comma-separated list of column names to display. explode: true - cat.recovery::query.help: + cat.recovery___query.help: name: help in: query description: Return help information. @@ -15600,7 +16100,7 @@ components: type: boolean default: false description: Return help information. - cat.recovery::query.index: + cat.recovery___query.index: name: index in: query description: Comma-separated list or wildcard expression of index names to limit the returned information. @@ -15611,7 +16111,7 @@ components: type: string description: Comma-separated list or wildcard expression of index names to limit the returned information. explode: true - cat.recovery::query.s: + cat.recovery___query.s: name: s in: query description: Comma-separated list of column names or column aliases to sort by. @@ -15622,13 +16122,13 @@ components: type: string description: Comma-separated list of column names or column aliases to sort by. explode: true - cat.recovery::query.time: + cat.recovery___query.time: name: time in: query description: The unit in which to display time values. schema: - $ref: '#/components/schemas/_common:TimeUnit' - cat.recovery::query.v: + $ref: '#/components/schemas/_common___TimeUnit' + cat.recovery___query.v: name: v in: query description: Verbose mode. Display column headers. @@ -15636,21 +16136,21 @@ components: type: boolean default: false description: Verbose mode. Display column headers. - cat.repositories::query.cluster_manager_timeout: + cat.repositories___query.cluster_manager_timeout: name: cluster_manager_timeout in: query description: Operation timeout for connection to cluster-manager node. schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' x-version-added: '2.0' - cat.repositories::query.format: + cat.repositories___query.format: name: format in: query - description: A short version of the Accept header, e.g. json, yaml. + description: A short version of the Accept header (for example, `json`, `yaml`). schema: type: string - description: A short version of the Accept header, e.g. json, yaml. - cat.repositories::query.h: + description: A short version of the Accept header (for example, `json`, `yaml`). + cat.repositories___query.h: name: h in: query description: Comma-separated list of column names to display. @@ -15661,7 +16161,7 @@ components: type: string description: Comma-separated list of column names to display. explode: true - cat.repositories::query.help: + cat.repositories___query.help: name: help in: query description: Return help information. @@ -15669,7 +16169,7 @@ components: type: boolean default: false description: Return help information. - cat.repositories::query.local: + cat.repositories___query.local: name: local in: query description: Return local information, do not retrieve the state from cluster-manager node. @@ -15677,16 +16177,16 @@ components: type: boolean default: false description: Return local information, do not retrieve the state from cluster-manager node. - cat.repositories::query.master_timeout: + cat.repositories___query.master_timeout: name: master_timeout in: query - description: Operation timeout for connection to master node. + description: Operation timeout for connection to cluster-manager node. schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' x-version-deprecated: '2.0' - x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. deprecated: true - cat.repositories::query.s: + cat.repositories___query.s: name: s in: query description: Comma-separated list of column names or column aliases to sort by. @@ -15697,7 +16197,7 @@ components: type: string description: Comma-separated list of column names or column aliases to sort by. explode: true - cat.repositories::query.v: + cat.repositories___query.v: name: v in: query description: Verbose mode. Display column headers. @@ -15705,7 +16205,7 @@ components: type: boolean default: false description: Verbose mode. Display column headers. - cat.segment_replication::path.index: + cat.segment_replication___path.index: name: index in: path description: Comma-separated list or wildcard expression of index names to limit the returned information. @@ -15715,7 +16215,7 @@ components: items: type: string required: true - cat.segment_replication::query.active_only: + cat.segment_replication___query.active_only: name: active_only in: query description: If `true`, the response only includes ongoing segment replication events. @@ -15723,20 +16223,20 @@ components: type: boolean default: false description: If `true`, the response only includes ongoing segment replication events. - cat.segment_replication::query.allow_no_indices: + cat.segment_replication___query.allow_no_indices: name: allow_no_indices in: query - description: Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified). + description: Whether to ignore if a wildcard indexes expression resolves into no concrete indexes. (This includes `_all` string or when no indexes have been specified). schema: type: boolean - description: Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified). - cat.segment_replication::query.bytes: + description: Whether to ignore if a wildcard indexes expression resolves into no concrete indexes. (This includes `_all` string or when no indexes have been specified). + cat.segment_replication___query.bytes: name: bytes in: query description: The unit in which to display byte values. schema: - $ref: '#/components/schemas/_common:ByteUnit' - cat.segment_replication::query.completed_only: + $ref: '#/components/schemas/_common___ByteUnit' + cat.segment_replication___query.completed_only: name: completed_only in: query description: If `true`, the response only includes latest completed segment replication events. @@ -15744,7 +16244,7 @@ components: type: boolean default: false description: If `true`, the response only includes latest completed segment replication events. - cat.segment_replication::query.detailed: + cat.segment_replication___query.detailed: name: detailed in: query description: If `true`, the response includes detailed information about segment replications. @@ -15752,20 +16252,20 @@ components: type: boolean default: false description: If `true`, the response includes detailed information about segment replications. - cat.segment_replication::query.expand_wildcards: + cat.segment_replication___query.expand_wildcards: name: expand_wildcards in: query - description: Whether to expand wildcard expression to concrete indices that are open, closed or both. + description: Whether to expand wildcard expression to concrete indexes that are open, closed or both. schema: - $ref: '#/components/schemas/_common:ExpandWildcards' - cat.segment_replication::query.format: + $ref: '#/components/schemas/_common___ExpandWildcards' + cat.segment_replication___query.format: name: format in: query - description: A short version of the Accept header, e.g. json, yaml. + description: A short version of the Accept header (for example, `json`, `yaml`). schema: type: string - description: A short version of the Accept header, e.g. json, yaml. - cat.segment_replication::query.h: + description: A short version of the Accept header (for example, `json`, `yaml`). + cat.segment_replication___query.h: name: h in: query description: Comma-separated list of column names to display. @@ -15776,7 +16276,7 @@ components: type: string description: Comma-separated list of column names to display. explode: true - cat.segment_replication::query.help: + cat.segment_replication___query.help: name: help in: query description: Return help information. @@ -15784,21 +16284,21 @@ components: type: boolean default: false description: Return help information. - cat.segment_replication::query.ignore_throttled: + cat.segment_replication___query.ignore_throttled: name: ignore_throttled in: query - description: Whether specified concrete, expanded or aliased indices should be ignored when throttled. + description: Whether specified concrete, expanded or aliased indexes should be ignored when throttled. schema: type: boolean - description: Whether specified concrete, expanded or aliased indices should be ignored when throttled. - cat.segment_replication::query.ignore_unavailable: + description: Whether specified concrete, expanded or aliased indexes should be ignored when throttled. + cat.segment_replication___query.ignore_unavailable: name: ignore_unavailable in: query - description: Whether specified concrete indices should be ignored when unavailable (missing or closed). + description: Whether specified concrete indexes should be ignored when unavailable (missing or closed). schema: type: boolean - description: Whether specified concrete indices should be ignored when unavailable (missing or closed). - cat.segment_replication::query.index: + description: Whether specified concrete indexes should be ignored when unavailable (missing or closed). + cat.segment_replication___query.index: name: index in: query description: Comma-separated list or wildcard expression of index names to limit the returned information. @@ -15809,7 +16309,7 @@ components: type: string description: Comma-separated list or wildcard expression of index names to limit the returned information. explode: true - cat.segment_replication::query.s: + cat.segment_replication___query.s: name: s in: query description: Comma-separated list of column names or column aliases to sort by. @@ -15820,7 +16320,7 @@ components: type: string description: Comma-separated list of column names or column aliases to sort by. explode: true - cat.segment_replication::query.shards: + cat.segment_replication___query.shards: name: shards in: query description: Comma-separated list of shards to display. @@ -15831,19 +16331,19 @@ components: type: string description: Comma-separated list of shards to display. explode: true - cat.segment_replication::query.time: + cat.segment_replication___query.time: name: time in: query description: The unit in which to display time values. schema: - $ref: '#/components/schemas/_common:TimeUnit' - cat.segment_replication::query.timeout: + $ref: '#/components/schemas/_common___TimeUnit' + cat.segment_replication___query.timeout: name: timeout in: query description: Operation timeout. schema: - $ref: '#/components/schemas/_common:Duration' - cat.segment_replication::query.v: + $ref: '#/components/schemas/_common___Duration' + cat.segment_replication___query.v: name: v in: query description: Verbose mode. Display column headers. @@ -15851,39 +16351,39 @@ components: type: boolean default: false description: Verbose mode. Display column headers. - cat.segments::path.index: + cat.segments___path.index: in: path name: index description: |- - A comma-separated list of data streams, indices, and aliases used to limit the request. + A comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (`*`). - To target all data streams and indices, omit this parameter or use `*` or `_all`. + To target all data streams and indexes, omit this parameter or use `*` or `_all`. required: true schema: - $ref: '#/components/schemas/_common:Indices' + $ref: '#/components/schemas/_common___Indices' style: simple - cat.segments::query.bytes: + cat.segments___query.bytes: in: query name: bytes description: The unit used to display byte values. schema: - $ref: '#/components/schemas/_common:ByteUnit' + $ref: '#/components/schemas/_common___ByteUnit' style: form - cat.segments::query.cluster_manager_timeout: + cat.segments___query.cluster_manager_timeout: name: cluster_manager_timeout in: query description: Operation timeout for connection to cluster-manager node. schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' x-version-added: '2.0' - cat.segments::query.format: + cat.segments___query.format: name: format in: query - description: A short version of the Accept header, e.g. json, yaml. + description: A short version of the Accept header (for example, `json`, `yaml`). schema: type: string - description: A short version of the Accept header, e.g. json, yaml. - cat.segments::query.h: + description: A short version of the Accept header (for example, `json`, `yaml`). + cat.segments___query.h: name: h in: query description: Comma-separated list of column names to display. @@ -15894,7 +16394,7 @@ components: type: string description: Comma-separated list of column names to display. explode: true - cat.segments::query.help: + cat.segments___query.help: name: help in: query description: Return help information. @@ -15902,16 +16402,16 @@ components: type: boolean default: false description: Return help information. - cat.segments::query.master_timeout: + cat.segments___query.master_timeout: name: master_timeout in: query - description: Operation timeout for connection to master node. + description: Operation timeout for connection to cluster-manager node. schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' x-version-deprecated: '2.0' - x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. deprecated: true - cat.segments::query.s: + cat.segments___query.s: name: s in: query description: Comma-separated list of column names or column aliases to sort by. @@ -15922,7 +16422,7 @@ components: type: string description: Comma-separated list of column names or column aliases to sort by. explode: true - cat.segments::query.v: + cat.segments___query.v: name: v in: query description: Verbose mode. Display column headers. @@ -15930,39 +16430,39 @@ components: type: boolean default: false description: Verbose mode. Display column headers. - cat.shards::path.index: + cat.shards___path.index: in: path name: index description: |- - A comma-separated list of data streams, indices, and aliases used to limit the request. + A comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (`*`). - To target all data streams and indices, omit this parameter or use `*` or `_all`. + To target all data streams and indexes, omit this parameter or use `*` or `_all`. required: true schema: - $ref: '#/components/schemas/_common:Indices' + $ref: '#/components/schemas/_common___Indices' style: simple - cat.shards::query.bytes: + cat.shards___query.bytes: in: query name: bytes description: The unit used to display byte values. schema: - $ref: '#/components/schemas/_common:ByteUnit' + $ref: '#/components/schemas/_common___ByteUnit' style: form - cat.shards::query.cluster_manager_timeout: + cat.shards___query.cluster_manager_timeout: name: cluster_manager_timeout in: query description: Operation timeout for connection to cluster-manager node. schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' x-version-added: '2.0' - cat.shards::query.format: + cat.shards___query.format: name: format in: query - description: A short version of the Accept header, e.g. json, yaml. + description: A short version of the Accept header (for example, `json`, `yaml`). schema: type: string - description: A short version of the Accept header, e.g. json, yaml. - cat.shards::query.h: + description: A short version of the Accept header (for example, `json`, `yaml`). + cat.shards___query.h: name: h in: query description: Comma-separated list of column names to display. @@ -15973,7 +16473,7 @@ components: type: string description: Comma-separated list of column names to display. explode: true - cat.shards::query.help: + cat.shards___query.help: name: help in: query description: Return help information. @@ -15981,7 +16481,7 @@ components: type: boolean default: false description: Return help information. - cat.shards::query.local: + cat.shards___query.local: name: local in: query description: Return local information, do not retrieve the state from cluster-manager node. @@ -15989,16 +16489,16 @@ components: type: boolean default: false description: Return local information, do not retrieve the state from cluster-manager node. - cat.shards::query.master_timeout: + cat.shards___query.master_timeout: name: master_timeout in: query - description: Operation timeout for connection to master node. + description: Operation timeout for connection to cluster-manager node. schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' x-version-deprecated: '2.0' - x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. deprecated: true - cat.shards::query.s: + cat.shards___query.s: name: s in: query description: Comma-separated list of column names or column aliases to sort by. @@ -16009,13 +16509,13 @@ components: type: string description: Comma-separated list of column names or column aliases to sort by. explode: true - cat.shards::query.time: + cat.shards___query.time: name: time in: query description: The unit in which to display time values. schema: - $ref: '#/components/schemas/_common:TimeUnit' - cat.shards::query.v: + $ref: '#/components/schemas/_common___TimeUnit' + cat.shards___query.v: name: v in: query description: Verbose mode. Display column headers. @@ -16023,7 +16523,7 @@ components: type: boolean default: false description: Verbose mode. Display column headers. - cat.snapshots::path.repository: + cat.snapshots___path.repository: in: path name: repository description: |- @@ -16033,23 +16533,23 @@ components: If any repository fails during the request, OpenSearch returns an error. required: true schema: - $ref: '#/components/schemas/_common:Names' + $ref: '#/components/schemas/_common___Names' style: simple - cat.snapshots::query.cluster_manager_timeout: + cat.snapshots___query.cluster_manager_timeout: name: cluster_manager_timeout in: query description: Operation timeout for connection to cluster-manager node. schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' x-version-added: '2.0' - cat.snapshots::query.format: + cat.snapshots___query.format: name: format in: query - description: A short version of the Accept header, e.g. json, yaml. + description: A short version of the Accept header (for example, `json`, `yaml`). schema: type: string - description: A short version of the Accept header, e.g. json, yaml. - cat.snapshots::query.h: + description: A short version of the Accept header (for example, `json`, `yaml`). + cat.snapshots___query.h: name: h in: query description: Comma-separated list of column names to display. @@ -16060,7 +16560,7 @@ components: type: string description: Comma-separated list of column names to display. explode: true - cat.snapshots::query.help: + cat.snapshots___query.help: name: help in: query description: Return help information. @@ -16068,7 +16568,7 @@ components: type: boolean default: false description: Return help information. - cat.snapshots::query.ignore_unavailable: + cat.snapshots___query.ignore_unavailable: in: query name: ignore_unavailable description: If `true`, the response does not include information from unavailable snapshots. @@ -16076,16 +16576,16 @@ components: type: boolean default: false style: form - cat.snapshots::query.master_timeout: + cat.snapshots___query.master_timeout: name: master_timeout in: query - description: Operation timeout for connection to master node. + description: Operation timeout for connection to cluster-manager node. schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' x-version-deprecated: '2.0' - x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. deprecated: true - cat.snapshots::query.s: + cat.snapshots___query.s: name: s in: query description: Comma-separated list of column names or column aliases to sort by. @@ -16096,13 +16596,13 @@ components: type: string description: Comma-separated list of column names or column aliases to sort by. explode: true - cat.snapshots::query.time: + cat.snapshots___query.time: name: time in: query description: The unit in which to display time values. schema: - $ref: '#/components/schemas/_common:TimeUnit' - cat.snapshots::query.v: + $ref: '#/components/schemas/_common___TimeUnit' + cat.snapshots___query.v: name: v in: query description: Verbose mode. Display column headers. @@ -16110,7 +16610,7 @@ components: type: boolean default: false description: Verbose mode. Display column headers. - cat.tasks::query.actions: + cat.tasks___query.actions: in: query name: actions description: The task action names, which are used to limit the response. @@ -16119,7 +16619,7 @@ components: items: type: string style: form - cat.tasks::query.detailed: + cat.tasks___query.detailed: in: query name: detailed description: If `true`, the response includes detailed information about shard recoveries. @@ -16127,14 +16627,14 @@ components: type: boolean default: false style: form - cat.tasks::query.format: + cat.tasks___query.format: name: format in: query - description: A short version of the Accept header, e.g. json, yaml. + description: A short version of the Accept header (for example, `json`, `yaml`). schema: type: string - description: A short version of the Accept header, e.g. json, yaml. - cat.tasks::query.h: + description: A short version of the Accept header (for example, `json`, `yaml`). + cat.tasks___query.h: name: h in: query description: Comma-separated list of column names to display. @@ -16145,7 +16645,7 @@ components: type: string description: Comma-separated list of column names to display. explode: true - cat.tasks::query.help: + cat.tasks___query.help: name: help in: query description: Return help information. @@ -16153,7 +16653,7 @@ components: type: boolean default: false description: Return help information. - cat.tasks::query.nodes: + cat.tasks___query.nodes: name: nodes in: query description: Comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes. @@ -16164,14 +16664,14 @@ components: type: string description: Comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes. explode: true - cat.tasks::query.parent_task_id: + cat.tasks___query.parent_task_id: in: query name: parent_task_id description: The parent task identifier, which is used to limit the response. schema: type: string style: form - cat.tasks::query.s: + cat.tasks___query.s: name: s in: query description: Comma-separated list of column names or column aliases to sort by. @@ -16182,13 +16682,13 @@ components: type: string description: Comma-separated list of column names or column aliases to sort by. explode: true - cat.tasks::query.time: + cat.tasks___query.time: name: time in: query description: The unit in which to display time values. schema: - $ref: '#/components/schemas/_common:TimeUnit' - cat.tasks::query.v: + $ref: '#/components/schemas/_common___TimeUnit' + cat.tasks___query.v: name: v in: query description: Verbose mode. Display column headers. @@ -16196,7 +16696,7 @@ components: type: boolean default: false description: Verbose mode. Display column headers. - cat.templates::path.name: + cat.templates___path.name: in: path name: name description: |- @@ -16204,23 +16704,23 @@ components: Accepts wildcard expressions. If omitted, all templates are returned. required: true schema: - $ref: '#/components/schemas/_common:Name' + $ref: '#/components/schemas/_common___Name' style: simple - cat.templates::query.cluster_manager_timeout: + cat.templates___query.cluster_manager_timeout: name: cluster_manager_timeout in: query description: Operation timeout for connection to cluster-manager node. schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' x-version-added: '2.0' - cat.templates::query.format: + cat.templates___query.format: name: format in: query - description: A short version of the Accept header, e.g. json, yaml. + description: A short version of the Accept header (for example, `json`, `yaml`). schema: type: string - description: A short version of the Accept header, e.g. json, yaml. - cat.templates::query.h: + description: A short version of the Accept header (for example, `json`, `yaml`). + cat.templates___query.h: name: h in: query description: Comma-separated list of column names to display. @@ -16231,7 +16731,7 @@ components: type: string description: Comma-separated list of column names to display. explode: true - cat.templates::query.help: + cat.templates___query.help: name: help in: query description: Return help information. @@ -16239,7 +16739,7 @@ components: type: boolean default: false description: Return help information. - cat.templates::query.local: + cat.templates___query.local: name: local in: query description: Return local information, do not retrieve the state from cluster-manager node. @@ -16247,16 +16747,16 @@ components: type: boolean default: false description: Return local information, do not retrieve the state from cluster-manager node. - cat.templates::query.master_timeout: + cat.templates___query.master_timeout: name: master_timeout in: query - description: Operation timeout for connection to master node. + description: Operation timeout for connection to cluster-manager node. schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' x-version-deprecated: '2.0' - x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. deprecated: true - cat.templates::query.s: + cat.templates___query.s: name: s in: query description: Comma-separated list of column names or column aliases to sort by. @@ -16267,7 +16767,7 @@ components: type: string description: Comma-separated list of column names or column aliases to sort by. explode: true - cat.templates::query.v: + cat.templates___query.v: name: v in: query description: Verbose mode. Display column headers. @@ -16275,7 +16775,7 @@ components: type: boolean default: false description: Verbose mode. Display column headers. - cat.thread_pool::path.thread_pool_patterns: + cat.thread_pool___path.thread_pool_patterns: in: path name: thread_pool_patterns description: |- @@ -16283,23 +16783,23 @@ components: Accepts wildcard expressions. required: true schema: - $ref: '#/components/schemas/_common:Names' + $ref: '#/components/schemas/_common___Names' style: simple - cat.thread_pool::query.cluster_manager_timeout: + cat.thread_pool___query.cluster_manager_timeout: name: cluster_manager_timeout in: query description: Operation timeout for connection to cluster-manager node. schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' x-version-added: '2.0' - cat.thread_pool::query.format: + cat.thread_pool___query.format: name: format in: query - description: A short version of the Accept header, e.g. json, yaml. + description: A short version of the Accept header (for example, `json`, `yaml`). schema: type: string - description: A short version of the Accept header, e.g. json, yaml. - cat.thread_pool::query.h: + description: A short version of the Accept header (for example, `json`, `yaml`). + cat.thread_pool___query.h: name: h in: query description: Comma-separated list of column names to display. @@ -16310,7 +16810,7 @@ components: type: string description: Comma-separated list of column names to display. explode: true - cat.thread_pool::query.help: + cat.thread_pool___query.help: name: help in: query description: Return help information. @@ -16318,7 +16818,7 @@ components: type: boolean default: false description: Return help information. - cat.thread_pool::query.local: + cat.thread_pool___query.local: name: local in: query description: Return local information, do not retrieve the state from cluster-manager node. @@ -16326,16 +16826,16 @@ components: type: boolean default: false description: Return local information, do not retrieve the state from cluster-manager node. - cat.thread_pool::query.master_timeout: + cat.thread_pool___query.master_timeout: name: master_timeout in: query - description: Operation timeout for connection to master node. + description: Operation timeout for connection to cluster-manager node. schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' x-version-deprecated: '2.0' - x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. deprecated: true - cat.thread_pool::query.s: + cat.thread_pool___query.s: name: s in: query description: Comma-separated list of column names or column aliases to sort by. @@ -16346,7 +16846,7 @@ components: type: string description: Comma-separated list of column names or column aliases to sort by. explode: true - cat.thread_pool::query.size: + cat.thread_pool___query.size: name: size in: query description: The multiplier in which to display values. @@ -16354,7 +16854,7 @@ components: type: integer description: The multiplier in which to display values. format: int32 - cat.thread_pool::query.v: + cat.thread_pool___query.v: name: v in: query description: Verbose mode. Display column headers. @@ -16362,7 +16862,7 @@ components: type: boolean default: false description: Verbose mode. Display column headers. - clear_scroll::path.scroll_id: + clear_scroll___path.scroll_id: in: path name: scroll_id description: |- @@ -16371,25 +16871,25 @@ components: required: true deprecated: true schema: - $ref: '#/components/schemas/_common:ScrollIds' + $ref: '#/components/schemas/_common___ScrollIds' style: simple - cluster.allocation_explain::query.include_disk_info: + cluster.allocation_explain___query.include_disk_info: in: query name: include_disk_info - description: If true, returns information about disk usage and shard sizes. + description: If `true`, returns information about disk usage and shard sizes. schema: type: boolean default: false style: form - cluster.allocation_explain::query.include_yes_decisions: + cluster.allocation_explain___query.include_yes_decisions: in: query name: include_yes_decisions - description: If true, returns YES decisions in explanation. + description: If `true`, returns YES decisions in explanation. schema: type: boolean default: false style: form - cluster.delete_component_template::path.name: + cluster.delete_component_template___path.name: in: path name: name description: |- @@ -16397,51 +16897,51 @@ components: Wildcard (*) expressions are supported. required: true schema: - $ref: '#/components/schemas/_common:Name' + $ref: '#/components/schemas/_common___Name' style: simple - cluster.delete_component_template::query.cluster_manager_timeout: + cluster.delete_component_template___query.cluster_manager_timeout: name: cluster_manager_timeout in: query description: Operation timeout for connection to cluster-manager node. schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' x-version-added: '2.0' - cluster.delete_component_template::query.master_timeout: + cluster.delete_component_template___query.master_timeout: in: query name: master_timeout description: |- - Period to wait for a connection to the master node. + Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error. deprecated: true schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' style: form x-version-deprecated: '2.0' - x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. - cluster.delete_component_template::query.timeout: + x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. + cluster.delete_component_template___query.timeout: in: query name: timeout description: |- Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' style: form - cluster.delete_voting_config_exclusions::query.wait_for_removal: + cluster.delete_voting_config_exclusions___query.wait_for_removal: in: query name: wait_for_removal description: |- Specifies whether to wait for all excluded nodes to be removed from the cluster before clearing the voting configuration exclusions list. Defaults to true, meaning that all excluded nodes must be removed from - the cluster before this API takes any action. If set to false then the + the cluster before this API takes any action. If set to `false` then the voting configuration exclusions list is cleared even if some excluded nodes are still in the cluster. schema: type: boolean default: true style: form - cluster.exists_component_template::path.name: + cluster.exists_component_template___path.name: in: path name: name description: |- @@ -16449,39 +16949,39 @@ components: Wildcard (*) expressions are supported. required: true schema: - $ref: '#/components/schemas/_common:Name' + $ref: '#/components/schemas/_common___Name' style: simple - cluster.exists_component_template::query.cluster_manager_timeout: + cluster.exists_component_template___query.cluster_manager_timeout: name: cluster_manager_timeout in: query description: Operation timeout for connection to cluster-manager node. schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' x-version-added: '2.0' - cluster.exists_component_template::query.local: + cluster.exists_component_template___query.local: in: query name: local description: |- - If true, the request retrieves information from the local node only. - Defaults to false, which means information is retrieved from the master node. + If `true`, the request retrieves information from the local node only. + Defaults to false, which means information is retrieved from the cluster-manager node. schema: type: boolean default: false style: form - cluster.exists_component_template::query.master_timeout: + cluster.exists_component_template___query.master_timeout: in: query name: master_timeout description: |- - Period to wait for a connection to the master node. If no response is + Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error. deprecated: true schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' style: form x-version-deprecated: '2.0' - x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. - cluster.get_component_template::path.name: + x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. + cluster.get_component_template___path.name: in: path name: name description: |- @@ -16489,38 +16989,38 @@ components: Wildcard (`*`) expressions are supported. required: true schema: - $ref: '#/components/schemas/_common:Name' + $ref: '#/components/schemas/_common___Name' style: simple - cluster.get_component_template::query.cluster_manager_timeout: + cluster.get_component_template___query.cluster_manager_timeout: name: cluster_manager_timeout in: query description: Operation timeout for connection to cluster-manager node. schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' x-version-added: '2.0' - cluster.get_component_template::query.local: + cluster.get_component_template___query.local: in: query name: local description: |- If `true`, the request retrieves information from the local node only. - If `false`, information is retrieved from the master node. + If `false`, information is retrieved from the cluster-manager node. schema: type: boolean default: false style: form - cluster.get_component_template::query.master_timeout: + cluster.get_component_template___query.master_timeout: in: query name: master_timeout description: |- - Period to wait for a connection to the master node. + Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error. deprecated: true schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' style: form 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: + x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. + cluster.get_decommission_awareness___path.awareness_attribute_name: name: awareness_attribute_name in: path description: Awareness attribute name. @@ -16528,14 +17028,14 @@ components: type: string description: Awareness attribute name. required: true - cluster.get_settings::query.cluster_manager_timeout: + cluster.get_settings___query.cluster_manager_timeout: name: cluster_manager_timeout in: query description: Operation timeout for connection to cluster-manager node. schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' x-version-added: '2.0' - cluster.get_settings::query.flat_settings: + cluster.get_settings___query.flat_settings: in: query name: flat_settings description: If `true`, returns settings in flat format. @@ -16543,7 +17043,7 @@ components: type: boolean default: false style: form - cluster.get_settings::query.include_defaults: + cluster.get_settings___query.include_defaults: in: query name: include_defaults description: If `true`, returns default cluster settings from the local node. @@ -16551,28 +17051,28 @@ components: type: boolean default: false style: form - cluster.get_settings::query.master_timeout: + cluster.get_settings___query.master_timeout: in: query name: master_timeout description: |- - Period to wait for a connection to the master node. + Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error. deprecated: true schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' style: form x-version-deprecated: '2.0' - x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. - cluster.get_settings::query.timeout: + x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. + cluster.get_settings___query.timeout: in: query name: timeout description: |- Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' style: form - cluster.get_weighted_routing::path.attribute: + cluster.get_weighted_routing___path.attribute: name: attribute in: path description: Awareness attribute name. @@ -16580,96 +17080,96 @@ components: type: string description: Awareness attribute name. required: true - cluster.health::path.index: + cluster.health___path.index: in: path name: index - description: Comma-separated list of data streams, indices, and index aliases used to limit the request. Wildcard expressions (*) are supported. To target all data streams and indices in a cluster, omit this parameter or use `_all` or `*`. + description: Comma-separated list of data streams, indexes, and index aliases used to limit the request. Wildcard expressions (*) are supported. To target all data streams and indexes in a cluster, omit this parameter or use `_all` or `*`. required: true schema: - $ref: '#/components/schemas/_common:Indices' + $ref: '#/components/schemas/_common___Indices' style: simple - cluster.health::query.awareness_attribute: + cluster.health___query.awareness_attribute: name: awareness_attribute in: query description: The awareness attribute for which the health is required. schema: type: string description: The awareness attribute for which the health is required. - cluster.health::query.cluster_manager_timeout: + cluster.health___query.cluster_manager_timeout: name: cluster_manager_timeout in: query description: Operation timeout for connection to cluster-manager node. schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' x-version-added: '2.0' - cluster.health::query.expand_wildcards: + cluster.health___query.expand_wildcards: in: query name: expand_wildcards - description: Whether to expand wildcard expression to concrete indices that are open, closed or both. + description: Whether to expand wildcard expression to concrete indexes that are open, closed or both. schema: - $ref: '#/components/schemas/_common:ExpandWildcards' + $ref: '#/components/schemas/_common___ExpandWildcards' style: form - cluster.health::query.level: + cluster.health___query.level: in: query name: level - description: Can be one of cluster, indices or shards. Controls the details level of the health information returned. + description: Can be one of cluster, indexes or shards. Controls the details level of the health information returned. schema: - $ref: '#/components/schemas/cluster.health:Level' + $ref: '#/components/schemas/cluster.health___Level' style: form - cluster.health::query.local: + cluster.health___query.local: in: query name: local - description: If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the master node. + description: If `true`, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the cluster-manager node. schema: type: boolean default: false style: form - cluster.health::query.master_timeout: + cluster.health___query.master_timeout: in: query name: master_timeout - description: Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + description: Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error. deprecated: true schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' style: form x-version-deprecated: '2.0' - x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. - cluster.health::query.timeout: + x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. + cluster.health___query.timeout: in: query name: timeout description: Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' style: form - cluster.health::query.wait_for_active_shards: + cluster.health___query.wait_for_active_shards: in: query name: wait_for_active_shards description: A number controlling to how many active shards to wait for, all to wait for all shards in the cluster to be active, or 0 to not wait. schema: - $ref: '#/components/schemas/_common:WaitForActiveShards' + $ref: '#/components/schemas/_common___WaitForActiveShards' style: form - cluster.health::query.wait_for_events: + cluster.health___query.wait_for_events: in: query name: wait_for_events description: Can be one of immediate, urgent, high, normal, low, languid. Wait until all currently queued events with the given priority are processed. schema: - $ref: '#/components/schemas/_common:WaitForEvents' + $ref: '#/components/schemas/_common___WaitForEvents' style: form - cluster.health::query.wait_for_no_initializing_shards: + cluster.health___query.wait_for_no_initializing_shards: in: query name: wait_for_no_initializing_shards - description: A boolean value which controls whether to wait (until the timeout provided) for the cluster to have no shard initializations. Defaults to false, which means it will not wait for initializing shards. + description: A Boolean value which controls whether to wait (until the timeout provided) for the cluster to have no shard initializations. Defaults to false, which means it will not wait for initializing shards. schema: type: boolean style: form - cluster.health::query.wait_for_no_relocating_shards: + cluster.health___query.wait_for_no_relocating_shards: in: query name: wait_for_no_relocating_shards - description: A boolean value which controls whether to wait (until the timeout provided) for the cluster to have no shard relocations. Defaults to false, which means it will not wait for relocating shards. + description: A Boolean value which controls whether to wait (until the timeout provided) for the cluster to have no shard relocations. Defaults to false, which means it will not wait for relocating shards. schema: type: boolean style: form - cluster.health::query.wait_for_nodes: + cluster.health___query.wait_for_nodes: in: query name: wait_for_nodes description: The request waits until the specified number N of nodes is available. It also accepts >=N, <=N, >N and yellow > red. By default, will not wait for any status. schema: - $ref: '#/components/schemas/_common:HealthStatus' + $ref: '#/components/schemas/_common___HealthStatus' style: form - cluster.pending_tasks::query.cluster_manager_timeout: + cluster.pending_tasks___query.cluster_manager_timeout: name: cluster_manager_timeout in: query description: Operation timeout for connection to cluster-manager node. schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' x-version-added: '2.0' - cluster.pending_tasks::query.local: + cluster.pending_tasks___query.local: in: query name: local description: |- If `true`, the request retrieves information from the local node only. - If `false`, information is retrieved from the master node. + If `false`, information is retrieved from the cluster-manager node. schema: type: boolean default: false style: form - cluster.pending_tasks::query.master_timeout: + cluster.pending_tasks___query.master_timeout: in: query name: master_timeout description: |- - Period to wait for a connection to the master node. + Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error. deprecated: true schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' style: form 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: + x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. + cluster.post_voting_config_exclusions___query.node_ids: in: query name: node_ids description: |- A comma-separated list of the persistent ids of the nodes to exclude - from the voting configuration. If specified, you may not also specify node_names. + from the voting configuration. If specified, you may not also specify `node_names`. schema: - $ref: '#/components/schemas/_common:Ids' + $ref: '#/components/schemas/_common___Ids' style: form - cluster.post_voting_config_exclusions::query.node_names: + cluster.post_voting_config_exclusions___query.node_names: in: query name: node_names description: |- A comma-separated list of the names of the nodes to exclude from the - voting configuration. If specified, you may not also specify node_ids. + voting configuration. If specified, you may not also specify `node_ids`. schema: - $ref: '#/components/schemas/_common:Names' + $ref: '#/components/schemas/_common___Names' style: form - cluster.post_voting_config_exclusions::query.timeout: + cluster.post_voting_config_exclusions___query.timeout: in: query name: timeout description: |- @@ -16741,29 +17241,29 @@ components: returning. If the timeout expires before the appropriate condition is satisfied, the request fails and returns an error. schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' style: form - cluster.put_component_template::path.name: + cluster.put_component_template___path.name: in: path name: name description: |- Name of the component template to create. OpenSearch includes the following built-in component templates: `logs-mappings`; 'logs-settings`; `metrics-mappings`; `metrics-settings`;`synthetics-mapping`; `synthetics-settings`. - OpenSearch Agent uses these templates to configure backing indices for its data streams. + OpenSearch Agent uses these templates to configure backing indexes for its data streams. If you use OpenSearch Agent and want to overwrite one of these templates, set the `version` for your replacement template higher than the current version. If you don't use OpenSearch Agent and want to disable all built-in component and index templates, set `stack.templates.enabled` to `false` using the cluster update settings API. required: true schema: - $ref: '#/components/schemas/_common:Name' + $ref: '#/components/schemas/_common___Name' style: simple - cluster.put_component_template::query.cluster_manager_timeout: + cluster.put_component_template___query.cluster_manager_timeout: name: cluster_manager_timeout in: query description: Operation timeout for connection to cluster-manager node. schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' x-version-added: '2.0' - cluster.put_component_template::query.create: + cluster.put_component_template___query.create: in: query name: create description: If `true`, this request cannot replace or update existing component templates. @@ -16771,25 +17271,25 @@ components: type: boolean default: false style: form - cluster.put_component_template::query.master_timeout: + cluster.put_component_template___query.master_timeout: in: query name: master_timeout description: |- - Period to wait for a connection to the master node. + Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error. deprecated: true schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' style: form x-version-deprecated: '2.0' - x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. - cluster.put_component_template::query.timeout: + x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. + cluster.put_component_template___query.timeout: name: timeout in: query description: Operation timeout. schema: - $ref: '#/components/schemas/_common:Duration' - cluster.put_decommission_awareness::path.awareness_attribute_name: + $ref: '#/components/schemas/_common___Duration' + cluster.put_decommission_awareness___path.awareness_attribute_name: name: awareness_attribute_name in: path description: Awareness attribute name. @@ -16797,7 +17297,7 @@ components: type: string description: Awareness attribute name. required: true - cluster.put_decommission_awareness::path.awareness_attribute_value: + cluster.put_decommission_awareness___path.awareness_attribute_value: name: awareness_attribute_value in: path description: Awareness attribute value. @@ -16805,14 +17305,14 @@ components: type: string description: Awareness attribute value. required: true - cluster.put_settings::query.cluster_manager_timeout: + cluster.put_settings___query.cluster_manager_timeout: name: cluster_manager_timeout in: query description: Operation timeout for connection to cluster-manager node. schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' x-version-added: '2.0' - cluster.put_settings::query.flat_settings: + cluster.put_settings___query.flat_settings: in: query name: flat_settings description: Return settings in flat format. @@ -16820,24 +17320,24 @@ components: type: boolean default: false style: form - cluster.put_settings::query.master_timeout: + cluster.put_settings___query.master_timeout: in: query name: master_timeout - description: Explicit operation timeout for connection to master node + description: Explicit operation timeout for connection to cluster-manager node deprecated: true schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' style: form x-version-deprecated: '2.0' - x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. - cluster.put_settings::query.timeout: + x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. + cluster.put_settings___query.timeout: in: query name: timeout description: Explicit operation timeout schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' style: form - cluster.put_weighted_routing::path.attribute: + cluster.put_weighted_routing___path.attribute: name: attribute in: path description: Awareness attribute name. @@ -16845,71 +17345,71 @@ components: type: string description: Awareness attribute name. required: true - cluster.reroute::query.cluster_manager_timeout: + cluster.reroute___query.cluster_manager_timeout: name: cluster_manager_timeout in: query description: Operation timeout for connection to cluster-manager node. schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' x-version-added: '2.0' - cluster.reroute::query.dry_run: + cluster.reroute___query.dry_run: in: query name: dry_run - description: If true, then the request simulates the operation only and returns the resulting state. + description: If `true`, then the request simulates the operation only and returns the resulting state. schema: type: boolean style: form - cluster.reroute::query.explain: + cluster.reroute___query.explain: in: query name: explain - description: If true, then the response contains an explanation of why the commands can or cannot be executed. + description: If `true`, then the response contains an explanation of why the commands can or cannot be executed. schema: type: boolean style: form - cluster.reroute::query.master_timeout: + cluster.reroute___query.master_timeout: in: query name: master_timeout - description: Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + description: Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error. deprecated: true schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' style: form x-version-deprecated: '2.0' - x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. - cluster.reroute::query.metric: + x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. + cluster.reroute___query.metric: in: query name: metric description: Limits the information returned to the specified metrics. schema: oneOf: - - $ref: '#/components/schemas/cluster.reroute:Metric' + - $ref: '#/components/schemas/cluster.reroute___Metric' - type: array items: - $ref: '#/components/schemas/cluster.reroute:Metric' + $ref: '#/components/schemas/cluster.reroute___Metric' style: form - cluster.reroute::query.retry_failed: + cluster.reroute___query.retry_failed: in: query name: retry_failed - description: If true, then retries allocation of shards that are blocked due to too many subsequent allocation failures. + description: If `true`, then retries allocation of shards that are blocked due to too many subsequent allocation failures. schema: type: boolean style: form - cluster.reroute::query.timeout: + cluster.reroute___query.timeout: in: query name: timeout description: Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' style: form - cluster.state::path.index: + cluster.state___path.index: in: path name: index - description: A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices + description: A comma-separated list of index names; use `_all` or empty string to perform the operation on all indexes required: true schema: - $ref: '#/components/schemas/_common:Indices' + $ref: '#/components/schemas/_common___Indices' style: simple - cluster.state::path.metric: + cluster.state___path.metric: in: path name: metric description: Limit the information returned to the specified metrics @@ -16917,30 +17417,30 @@ components: schema: type: array items: - $ref: '#/components/schemas/cluster.state:Metric' + $ref: '#/components/schemas/cluster.state___Metric' style: simple - cluster.state::query.allow_no_indices: + cluster.state___query.allow_no_indices: in: query name: allow_no_indices - description: Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) + description: Whether to ignore if a wildcard indexes expression resolves into no concrete indexes. (This includes `_all` string or when no indexes have been specified) schema: type: boolean style: form - cluster.state::query.cluster_manager_timeout: + cluster.state___query.cluster_manager_timeout: name: cluster_manager_timeout in: query description: Operation timeout for connection to cluster-manager node. schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' x-version-added: '2.0' - cluster.state::query.expand_wildcards: + cluster.state___query.expand_wildcards: in: query name: expand_wildcards - description: Whether to expand wildcard expression to concrete indices that are open, closed or both. + description: Whether to expand wildcard expression to concrete indexes that are open, closed or both. schema: - $ref: '#/components/schemas/_common:ExpandWildcards' + $ref: '#/components/schemas/_common___ExpandWildcards' style: form - cluster.state::query.flat_settings: + cluster.state___query.flat_settings: in: query name: flat_settings description: Return settings in flat format. @@ -16948,14 +17448,14 @@ components: type: boolean default: false style: form - cluster.state::query.ignore_unavailable: + cluster.state___query.ignore_unavailable: in: query name: ignore_unavailable - description: Whether specified concrete indices should be ignored when unavailable (missing or closed) + description: Whether specified concrete indexes should be ignored when unavailable (missing or closed) schema: type: boolean style: form - cluster.state::query.local: + cluster.state___query.local: in: query name: local description: Return local information, do not retrieve the state from cluster-manager node. @@ -16963,39 +17463,59 @@ components: type: boolean default: false style: form - cluster.state::query.master_timeout: + cluster.state___query.master_timeout: in: query name: master_timeout - description: Specify timeout for connection to master + description: Specify timeout for connection to cluster manager. deprecated: true schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' style: form x-version-deprecated: '2.0' - x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. - cluster.state::query.wait_for_metadata_version: + x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. + cluster.state___query.wait_for_metadata_version: in: query name: wait_for_metadata_version - description: Wait for the metadata version to be equal or greater than the specified metadata version + description: Wait for the metadata version to be equal or greater than the specified metadata version. schema: - $ref: '#/components/schemas/_common:VersionNumber' + $ref: '#/components/schemas/_common___VersionNumber' style: form - cluster.state::query.wait_for_timeout: + cluster.state___query.wait_for_timeout: in: query name: wait_for_timeout - description: The maximum time to wait for wait_for_metadata_version before timing out + description: The maximum time to wait for `wait_for_metadata_version` before timing out. schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' style: form - cluster.stats::path.node_id: + cluster.stats___path.index_metric: + in: path + name: index_metric + description: Limit the information returned for indexes metric to the specific index metrics. It can be used only if indexes (or all) metric is specified. + required: true + schema: + type: array + items: + $ref: '#/components/schemas/cluster.stats___IndexMetric' + style: simple + cluster.stats___path.metric: + in: path + name: metric + description: Limit the information returned to the specified metrics. + required: true + schema: + type: array + items: + $ref: '#/components/schemas/cluster.stats___Metric' + style: simple + cluster.stats___path.node_id: in: path name: node_id description: Comma-separated list of node filters used to limit returned information. Defaults to all nodes in the cluster. required: true schema: - $ref: '#/components/schemas/_common:NodeIds' + $ref: '#/components/schemas/_common___NodeIds' style: simple - cluster.stats::query.flat_settings: + cluster.stats___query.flat_settings: in: query name: flat_settings description: If `true`, returns settings in flat format. @@ -17003,7 +17523,7 @@ components: type: boolean default: false style: form - cluster.stats::query.timeout: + cluster.stats___query.timeout: in: query name: timeout description: |- @@ -17011,29 +17531,29 @@ components: If a node does not respond before its timeout expires, the response does not include its stats. However, timed out nodes are included in the response's `_nodes.failed` property. Defaults to no timeout. schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' style: form - count::path.index: + count___path.index: in: path name: index description: |- - Comma-separated list of data streams, indices, and aliases to search. + Comma-separated list of data streams, indexes, and aliases to search. Supports wildcards (`*`). - To search all data streams and indices, omit this parameter or use `*` or `_all`. + To search all data streams and indexes, omit this parameter or use `*` or `_all`. required: true schema: - $ref: '#/components/schemas/_common:Indices' + $ref: '#/components/schemas/_common___Indices' style: simple - count::query.allow_no_indices: + count___query.allow_no_indices: in: query name: allow_no_indices description: |- - If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. - This behavior applies even if the request targets other open indices. + If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indexes. + This behavior applies even if the request targets other open indexes. schema: type: boolean style: form - count::query.analyze_wildcard: + count___query.analyze_wildcard: in: query name: analyze_wildcard description: |- @@ -17043,7 +17563,7 @@ components: type: boolean default: false style: form - count::query.analyzer: + count___query.analyzer: in: query name: analyzer description: |- @@ -17052,16 +17572,16 @@ components: schema: type: string style: form - count::query.default_operator: + count___query.default_operator: in: query name: default_operator description: |- The default operator for query string query: `AND` or `OR`. This parameter can only be used when the `q` query string parameter is specified. schema: - $ref: '#/components/schemas/_common.query_dsl:Operator' + $ref: '#/components/schemas/_common.query_dsl___Operator' style: form - count::query.df: + count___query.df: in: query name: df description: |- @@ -17070,7 +17590,7 @@ components: schema: type: string style: form - count::query.expand_wildcards: + count___query.expand_wildcards: in: query name: expand_wildcards description: |- @@ -17078,30 +17598,30 @@ components: If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`. schema: - $ref: '#/components/schemas/_common:ExpandWildcards' + $ref: '#/components/schemas/_common___ExpandWildcards' style: form - count::query.ignore_throttled: + count___query.ignore_throttled: in: query name: ignore_throttled - description: If `true`, concrete, expanded or aliased indices are ignored when frozen. + description: If `true`, concrete, expanded or aliased indexes are ignored when frozen. schema: type: boolean style: form - count::query.ignore_unavailable: + count___query.ignore_unavailable: in: query name: ignore_unavailable description: If `false`, the request returns an error if it targets a missing or closed index. schema: type: boolean style: form - count::query.lenient: + count___query.lenient: in: query name: lenient description: If `true`, format-based query failures (such as providing text to a numeric field) in the query string will be ignored. schema: type: boolean style: form - count::query.min_score: + count___query.min_score: in: query name: min_score description: Sets the minimum `_score` value that documents must have to be included in the result. @@ -17109,7 +17629,7 @@ components: type: number format: float style: form - count::query.preference: + count___query.preference: in: query name: preference description: |- @@ -17119,21 +17639,21 @@ components: type: string default: random style: form - count::query.q: + count___query.q: in: query name: q description: Query in the Lucene query string syntax. schema: type: string style: form - count::query.routing: + count___query.routing: in: query name: routing description: Custom value used to route operations to a specific shard. schema: - $ref: '#/components/schemas/_common:RoutingInQueryString' + $ref: '#/components/schemas/_common___RoutingInQueryString' style: form - count::query.terminate_after: + count___query.terminate_after: in: query name: terminate_after description: |- @@ -17144,36 +17664,36 @@ components: type: integer format: int32 style: form - create_pit::path.index: + create_pit___path.index: name: index in: path - description: Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices. + description: Comma-separated list of indexes; use `_all` or empty string to perform the operation on all indexes. schema: type: array - description: Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices. + description: Comma-separated list of indexes; use `_all` or empty string to perform the operation on all indexes. items: type: string required: true - create_pit::query.allow_partial_pit_creation: + create_pit___query.allow_partial_pit_creation: name: allow_partial_pit_creation in: query description: Allow if point in time can be created with partial failures. schema: type: boolean description: Allow if point in time can be created with partial failures. - create_pit::query.expand_wildcards: + create_pit___query.expand_wildcards: name: expand_wildcards in: query - description: Whether to expand wildcard expression to concrete indices that are open, closed or both. + description: Whether to expand wildcard expression to concrete indexes that are open, closed or both. schema: - $ref: '#/components/schemas/_common:ExpandWildcards' - create_pit::query.keep_alive: + $ref: '#/components/schemas/_common___ExpandWildcards' + create_pit___query.keep_alive: name: keep_alive in: query description: Specify the keep alive for point in time. schema: - $ref: '#/components/schemas/_common:Duration' - create_pit::query.preference: + $ref: '#/components/schemas/_common___Duration' + create_pit___query.preference: name: preference in: query description: Specify the node or shard the operation should be performed on. @@ -17181,23 +17701,23 @@ components: type: string default: random description: Specify the node or shard the operation should be performed on. - create_pit::query.routing: + create_pit___query.routing: name: routing in: query description: Comma-separated list of specific routing values. style: form schema: - $ref: '#/components/schemas/_common:RoutingInQueryString' + $ref: '#/components/schemas/_common___RoutingInQueryString' explode: true - create::path.id: + create___path.id: in: path name: id description: Unique identifier for the document. required: true schema: - $ref: '#/components/schemas/_common:Id' + $ref: '#/components/schemas/_common___Id' style: simple - create::path.index: + create___path.index: in: path name: index description: |- @@ -17206,9 +17726,9 @@ components: If the target doesn't exist and doesn't match a data stream template, this request creates the index. required: true schema: - $ref: '#/components/schemas/_common:IndexName' + $ref: '#/components/schemas/_common___IndexName' style: simple - create::query.pipeline: + create___query.pipeline: in: query name: pipeline description: |- @@ -17218,144 +17738,144 @@ components: schema: type: string style: form - create::query.refresh: + create___query.refresh: in: query name: refresh description: |- If `true`, OpenSearch refreshes the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` do nothing with refreshes. Valid values: `true`, `false`, `wait_for`. schema: - $ref: '#/components/schemas/_common:Refresh' + $ref: '#/components/schemas/_common___Refresh' style: form - create::query.routing: + create___query.routing: in: query name: routing description: Custom value used to route operations to a specific shard. schema: - $ref: '#/components/schemas/_common:RoutingInQueryString' + $ref: '#/components/schemas/_common___RoutingInQueryString' style: form - create::query.timeout: + create___query.timeout: in: query name: timeout description: 'Period the request waits for the following operations: automatic index creation, dynamic mapping updates, waiting for active shards.' schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' style: form - create::query.version: + create___query.version: in: query name: version description: |- Explicit version number for concurrency control. The specified version must match the current version of the document for the request to succeed. schema: - $ref: '#/components/schemas/_common:VersionNumber' + $ref: '#/components/schemas/_common___VersionNumber' style: form - create::query.version_type: + create___query.version_type: in: query name: version_type description: 'Specific version type: `external`, `external_gte`.' schema: - $ref: '#/components/schemas/_common:VersionType' + $ref: '#/components/schemas/_common___VersionType' style: form - create::query.wait_for_active_shards: + create___query.wait_for_active_shards: in: query name: wait_for_active_shards description: |- The number of shard copies that must be active before proceeding with the operation. Set to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). schema: - $ref: '#/components/schemas/_common:WaitForActiveShards' + $ref: '#/components/schemas/_common___WaitForActiveShards' style: form x-default: '1' - dangling_indices.delete_dangling_index::path.index_uuid: + dangling_indices.delete_dangling_index___path.index_uuid: in: path name: index_uuid - description: The UUID of the dangling index + description: The UUID of the dangling index. required: true schema: - $ref: '#/components/schemas/_common:Uuid' + $ref: '#/components/schemas/_common___Uuid' style: simple - dangling_indices.delete_dangling_index::query.accept_data_loss: + dangling_indices.delete_dangling_index___query.accept_data_loss: in: query name: accept_data_loss - description: Must be set to true in order to delete the dangling index + description: Must be set to true in order to delete the dangling index. required: true schema: type: boolean style: form - dangling_indices.delete_dangling_index::query.cluster_manager_timeout: + dangling_indices.delete_dangling_index___query.cluster_manager_timeout: name: cluster_manager_timeout in: query description: Operation timeout for connection to cluster-manager node. schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' x-version-added: '2.0' - dangling_indices.delete_dangling_index::query.master_timeout: + dangling_indices.delete_dangling_index___query.master_timeout: in: query name: master_timeout - description: Specify timeout for connection to master + description: Specify timeout for connection to cluster manager. deprecated: true schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' style: form x-version-deprecated: '2.0' - x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. - dangling_indices.delete_dangling_index::query.timeout: + x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. + dangling_indices.delete_dangling_index___query.timeout: in: query name: timeout - description: Explicit operation timeout + description: Explicit operation timeout. schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' style: form - dangling_indices.import_dangling_index::path.index_uuid: + dangling_indices.import_dangling_index___path.index_uuid: in: path name: index_uuid - description: The UUID of the dangling index + description: The UUID of the dangling index. required: true schema: - $ref: '#/components/schemas/_common:Uuid' + $ref: '#/components/schemas/_common___Uuid' style: simple - dangling_indices.import_dangling_index::query.accept_data_loss: + dangling_indices.import_dangling_index___query.accept_data_loss: in: query name: accept_data_loss - description: Must be set to true in order to import the dangling index + description: Must be set to true in order to import the dangling index. required: true schema: type: boolean style: form - dangling_indices.import_dangling_index::query.cluster_manager_timeout: + dangling_indices.import_dangling_index___query.cluster_manager_timeout: name: cluster_manager_timeout in: query description: Operation timeout for connection to cluster-manager node. schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' x-version-added: '2.0' - dangling_indices.import_dangling_index::query.master_timeout: + dangling_indices.import_dangling_index___query.master_timeout: in: query name: master_timeout - description: Specify timeout for connection to master + description: Specify timeout for connection to cluster manager. deprecated: true schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' style: form x-version-deprecated: '2.0' - x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. - dangling_indices.import_dangling_index::query.timeout: + x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. + dangling_indices.import_dangling_index___query.timeout: in: query name: timeout - description: Explicit operation timeout + description: Explicit operation timeout. schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' style: form - delete_by_query_rethrottle::path.task_id: + delete_by_query_rethrottle___path.task_id: in: path name: task_id description: The ID for the task. required: true schema: - $ref: '#/components/schemas/_common:TaskId' + $ref: '#/components/schemas/_common___TaskId' style: simple - delete_by_query_rethrottle::query.requests_per_second: + delete_by_query_rethrottle___query.requests_per_second: in: query name: requests_per_second description: The throttle for this request in sub-requests per second. @@ -17363,61 +17883,61 @@ components: type: number format: float style: form - delete_by_query::path.index: + delete_by_query___path.index: in: path name: index description: |- - Comma-separated list of data streams, indices, and aliases to search. + Comma-separated list of data streams, indexes, and aliases to search. Supports wildcards (`*`). - To search all data streams or indices, omit this parameter or use `*` or `_all`. + To search all data streams or indexes, omit this parameter or use `*` or `_all`. required: true schema: - $ref: '#/components/schemas/_common:Indices' + $ref: '#/components/schemas/_common___Indices' style: simple - delete_by_query::query._source: + delete_by_query___query._source: name: _source in: query - description: True or false to return the _source field or not, or a list of fields to return. + description: Set to `true` or `false` to return the `_source` field or not, or a list of fields to return. style: form schema: type: array items: type: string - description: True or false to return the _source field or not, or a list of fields to return. + description: Set to `true` or `false` to return the `_source` field or not, or a list of fields to return. explode: true - delete_by_query::query._source_excludes: + delete_by_query___query._source_excludes: name: _source_excludes in: query - description: List of fields to exclude from the returned _source field. + description: List of fields to exclude from the returned `_source` field. style: form schema: type: array items: type: string - description: List of fields to exclude from the returned _source field. + description: List of fields to exclude from the returned `_source` field. explode: true - delete_by_query::query._source_includes: + delete_by_query___query._source_includes: name: _source_includes in: query - description: List of fields to extract and return from the _source field. + description: List of fields to extract and return from the `_source` field. style: form schema: type: array items: type: string - description: List of fields to extract and return from the _source field. + description: List of fields to extract and return from the `_source` field. explode: true - delete_by_query::query.allow_no_indices: + delete_by_query___query.allow_no_indices: in: query name: allow_no_indices description: |- - If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. - This behavior applies even if the request targets other open indices. + If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indexes. + This behavior applies even if the request targets other open indexes. For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. schema: type: boolean style: form - delete_by_query::query.analyze_wildcard: + delete_by_query___query.analyze_wildcard: in: query name: analyze_wildcard description: If `true`, wildcard and prefix queries are analyzed. @@ -17425,35 +17945,35 @@ components: type: boolean default: false style: form - delete_by_query::query.analyzer: + delete_by_query___query.analyzer: in: query name: analyzer description: Analyzer to use for the query string. schema: type: string style: form - delete_by_query::query.conflicts: + delete_by_query___query.conflicts: in: query name: conflicts description: 'What to do if delete by query hits version conflicts: `abort` or `proceed`.' schema: - $ref: '#/components/schemas/_common:Conflicts' + $ref: '#/components/schemas/_common___Conflicts' style: form - delete_by_query::query.default_operator: + delete_by_query___query.default_operator: in: query name: default_operator description: 'The default operator for query string query: `AND` or `OR`.' schema: - $ref: '#/components/schemas/_common.query_dsl:Operator' + $ref: '#/components/schemas/_common.query_dsl___Operator' style: form - delete_by_query::query.df: + delete_by_query___query.df: in: query name: df description: Field to use as default where no field prefix is given in the query string. schema: type: string style: form - delete_by_query::query.expand_wildcards: + delete_by_query___query.expand_wildcards: in: query name: expand_wildcards description: |- @@ -17461,9 +17981,9 @@ components: If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`. Valid values are: `all`, `open`, `closed`, `hidden`, `none`. schema: - $ref: '#/components/schemas/_common:ExpandWildcards' + $ref: '#/components/schemas/_common___ExpandWildcards' style: form - delete_by_query::query.from: + delete_by_query___query.from: in: query name: from description: Starting offset. @@ -17472,21 +17992,21 @@ components: format: int32 default: 0 style: form - delete_by_query::query.ignore_unavailable: + delete_by_query___query.ignore_unavailable: in: query name: ignore_unavailable description: If `false`, the request returns an error if it targets a missing or closed index. schema: type: boolean style: form - delete_by_query::query.lenient: + delete_by_query___query.lenient: in: query name: lenient description: If `true`, format-based query failures (such as providing text to a numeric field) in the query string will be ignored. schema: type: boolean style: form - delete_by_query::query.max_docs: + delete_by_query___query.max_docs: in: query name: max_docs description: |- @@ -17496,7 +18016,7 @@ components: type: integer format: int32 style: form - delete_by_query::query.preference: + delete_by_query___query.preference: in: query name: preference description: |- @@ -17506,21 +18026,21 @@ components: type: string default: random style: form - delete_by_query::query.q: + delete_by_query___query.q: in: query name: q description: Query in the Lucene query string syntax. schema: type: string style: form - delete_by_query::query.refresh: + delete_by_query___query.refresh: in: query name: refresh description: If `true`, OpenSearch refreshes all shards involved in the delete by query after the request completes. schema: - type: boolean + $ref: '#/components/schemas/_common___Refresh' style: form - delete_by_query::query.request_cache: + delete_by_query___query.request_cache: in: query name: request_cache description: |- @@ -17529,7 +18049,7 @@ components: schema: type: boolean style: form - delete_by_query::query.requests_per_second: + delete_by_query___query.requests_per_second: in: query name: requests_per_second description: The throttle for this request in sub-requests per second. @@ -17538,21 +18058,21 @@ components: format: float default: 0 style: form - delete_by_query::query.routing: + delete_by_query___query.routing: in: query name: routing description: Custom value used to route operations to a specific shard. schema: - $ref: '#/components/schemas/_common:RoutingInQueryString' + $ref: '#/components/schemas/_common___RoutingInQueryString' style: form - delete_by_query::query.scroll: + delete_by_query___query.scroll: in: query name: scroll description: Period to retain the search context for scrolling. schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' style: form - delete_by_query::query.scroll_size: + delete_by_query___query.scroll_size: in: query name: scroll_size description: Size of the scroll request that powers the operation. @@ -17561,41 +18081,41 @@ components: format: int32 default: 100 style: form - delete_by_query::query.search_timeout: + delete_by_query___query.search_timeout: in: query name: search_timeout description: |- Explicit timeout for each search request. Defaults to no timeout. schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' style: form - delete_by_query::query.search_type: + delete_by_query___query.search_type: in: query name: search_type description: |- The type of the search operation. Available options: `query_then_fetch`, `dfs_query_then_fetch`. schema: - $ref: '#/components/schemas/_common:SearchType' + $ref: '#/components/schemas/_common___SearchType' style: form - delete_by_query::query.size: + delete_by_query___query.size: name: size in: query - description: Deprecated, please use `max_docs` instead. + description: Deprecated, use `max_docs` instead. schema: type: integer - description: Deprecated, please use `max_docs` instead. + description: Deprecated, use `max_docs` instead. format: int32 - delete_by_query::query.slices: + delete_by_query___query.slices: in: query name: slices description: The number of slices this task should be divided into. schema: - $ref: '#/components/schemas/_common:Slices' + $ref: '#/components/schemas/_common___Slices' style: form x-default: '1' - delete_by_query::query.sort: + delete_by_query___query.sort: in: query name: sort description: A comma-separated list of : pairs. @@ -17604,7 +18124,7 @@ components: items: type: string style: form - delete_by_query::query.stats: + delete_by_query___query.stats: in: query name: stats description: Specific `tag` of the request for logging and statistical purposes. @@ -17613,7 +18133,7 @@ components: items: type: string style: form - delete_by_query::query.terminate_after: + delete_by_query___query.terminate_after: in: query name: terminate_after description: |- @@ -17623,37 +18143,37 @@ components: 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. + Avoid specifying this parameter for requests that target data streams with backing indexes across multiple data tiers. schema: type: integer format: int32 style: form - delete_by_query::query.timeout: + delete_by_query___query.timeout: in: query name: timeout description: Period each deletion request waits for active shards. schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' style: form x-default: 1m - delete_by_query::query.version: + delete_by_query___query.version: in: query name: version description: If `true`, returns the document version as part of a hit. schema: type: boolean style: form - delete_by_query::query.wait_for_active_shards: + delete_by_query___query.wait_for_active_shards: in: query name: wait_for_active_shards description: |- The number of shard copies that must be active before proceeding with the operation. Set to all or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). schema: - $ref: '#/components/schemas/_common:WaitForActiveShards' + $ref: '#/components/schemas/_common___WaitForActiveShards' style: form x-default: '1' - delete_by_query::query.wait_for_completion: + delete_by_query___query.wait_for_completion: in: query name: wait_for_completion description: If `true`, the request blocks until the operation is complete. @@ -17661,59 +18181,59 @@ components: type: boolean default: true style: form - delete_script::path.id: + delete_script___path.id: in: path name: id description: Identifier for the stored script or search template. required: true schema: - $ref: '#/components/schemas/_common:Id' + $ref: '#/components/schemas/_common___Id' style: simple - delete_script::query.cluster_manager_timeout: + delete_script___query.cluster_manager_timeout: name: cluster_manager_timeout in: query description: Operation timeout for connection to cluster-manager node. schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' x-version-added: '2.0' - delete_script::query.master_timeout: + delete_script___query.master_timeout: in: query name: master_timeout description: |- - Period to wait for a connection to the master node. + Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error. deprecated: true schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' style: form x-version-deprecated: '2.0' - x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. - delete_script::query.timeout: + x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. + delete_script___query.timeout: in: query name: timeout description: |- Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' style: form - delete::path.id: + delete___path.id: in: path name: id description: Unique identifier for the document. required: true schema: - $ref: '#/components/schemas/_common:Id' + $ref: '#/components/schemas/_common___Id' style: simple - delete::path.index: + delete___path.index: in: path name: index description: Name of the target index. required: true schema: - $ref: '#/components/schemas/_common:IndexName' + $ref: '#/components/schemas/_common___IndexName' style: simple - delete::query.if_primary_term: + delete___query.if_primary_term: in: query name: if_primary_term description: Only perform the operation if the document has this primary term. @@ -17721,102 +18241,102 @@ components: type: integer format: int64 style: form - delete::query.if_seq_no: + delete___query.if_seq_no: in: query name: if_seq_no description: Only perform the operation if the document has this sequence number. schema: - $ref: '#/components/schemas/_common:SequenceNumber' + $ref: '#/components/schemas/_common___SequenceNumber' style: form - delete::query.refresh: + delete___query.refresh: in: query name: refresh description: |- If `true`, OpenSearch refreshes the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` do nothing with refreshes. Valid values: `true`, `false`, `wait_for`. schema: - $ref: '#/components/schemas/_common:Refresh' + $ref: '#/components/schemas/_common___Refresh' style: form - delete::query.routing: + delete___query.routing: in: query name: routing description: Custom value used to route operations to a specific shard. schema: - $ref: '#/components/schemas/_common:RoutingInQueryString' + $ref: '#/components/schemas/_common___RoutingInQueryString' style: form - delete::query.timeout: + delete___query.timeout: in: query name: timeout description: Period to wait for active shards. schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' style: form - delete::query.version: + delete___query.version: in: query name: version description: |- Explicit version number for concurrency control. The specified version must match the current version of the document for the request to succeed. schema: - $ref: '#/components/schemas/_common:VersionNumber' + $ref: '#/components/schemas/_common___VersionNumber' style: form - delete::query.version_type: + delete___query.version_type: in: query name: version_type description: 'Specific version type: `external`, `external_gte`.' schema: - $ref: '#/components/schemas/_common:VersionType' + $ref: '#/components/schemas/_common___VersionType' style: form - delete::query.wait_for_active_shards: + delete___query.wait_for_active_shards: in: query name: wait_for_active_shards description: |- The number of shard copies that must be active before proceeding with the operation. Set to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). schema: - $ref: '#/components/schemas/_common:WaitForActiveShards' + $ref: '#/components/schemas/_common___WaitForActiveShards' style: form x-default: '1' - exists_source::path.id: + exists_source___path.id: in: path name: id description: Identifier of the document. required: true schema: - $ref: '#/components/schemas/_common:Id' + $ref: '#/components/schemas/_common___Id' style: simple - exists_source::path.index: + exists_source___path.index: in: path name: index description: |- - Comma-separated list of data streams, indices, and aliases. + Comma-separated list of data streams, indexes, and aliases. Supports wildcards (`*`). required: true schema: - $ref: '#/components/schemas/_common:IndexName' + $ref: '#/components/schemas/_common___IndexName' style: simple - exists_source::query._source: + exists_source___query._source: in: query name: _source description: '`true` or `false` to return the `_source` field or not, or a list of fields to return.' schema: - $ref: '#/components/schemas/_core.search:SourceConfigParam' + $ref: '#/components/schemas/_core.search___SourceConfigParam' style: form - exists_source::query._source_excludes: + exists_source___query._source_excludes: in: query name: _source_excludes description: A comma-separated list of source fields to exclude in the response. schema: - $ref: '#/components/schemas/_common:Fields' + $ref: '#/components/schemas/_common___Fields' style: form - exists_source::query._source_includes: + exists_source___query._source_includes: in: query name: _source_includes description: A comma-separated list of source fields to include in the response. schema: - $ref: '#/components/schemas/_common:Fields' + $ref: '#/components/schemas/_common___Fields' style: form - exists_source::query.preference: + exists_source___query.preference: in: query name: preference description: |- @@ -17826,83 +18346,83 @@ components: type: string default: random style: form - exists_source::query.realtime: + exists_source___query.realtime: in: query name: realtime - description: If true, the request is real-time as opposed to near-real-time. + description: If `true`, the request is real-time as opposed to near-real-time. schema: type: boolean style: form - exists_source::query.refresh: + exists_source___query.refresh: in: query name: refresh description: If `true`, OpenSearch refreshes all shards involved in the delete by query after the request completes. schema: - type: boolean + $ref: '#/components/schemas/_common___Refresh' style: form - exists_source::query.routing: + exists_source___query.routing: in: query name: routing description: Target the specified primary shard. schema: - $ref: '#/components/schemas/_common:RoutingInQueryString' + $ref: '#/components/schemas/_common___RoutingInQueryString' style: form - exists_source::query.version: + exists_source___query.version: in: query name: version description: |- Explicit version number for concurrency control. The specified version must match the current version of the document for the request to succeed. schema: - $ref: '#/components/schemas/_common:VersionNumber' + $ref: '#/components/schemas/_common___VersionNumber' style: form - exists_source::query.version_type: + exists_source___query.version_type: in: query name: version_type description: 'Specific version type: `external`, `external_gte`.' schema: - $ref: '#/components/schemas/_common:VersionType' + $ref: '#/components/schemas/_common___VersionType' style: form - exists::path.id: + exists___path.id: in: path name: id description: Identifier of the document. required: true schema: - $ref: '#/components/schemas/_common:Id' + $ref: '#/components/schemas/_common___Id' style: simple - exists::path.index: + exists___path.index: in: path name: index description: |- - Comma-separated list of data streams, indices, and aliases. + Comma-separated list of data streams, indexes, and aliases. Supports wildcards (`*`). required: true schema: - $ref: '#/components/schemas/_common:IndexName' + $ref: '#/components/schemas/_common___IndexName' style: simple - exists::query._source: + exists___query._source: in: query name: _source description: '`true` or `false` to return the `_source` field or not, or a list of fields to return.' schema: - $ref: '#/components/schemas/_core.search:SourceConfigParam' + $ref: '#/components/schemas/_core.search___SourceConfigParam' style: form - exists::query._source_excludes: + exists___query._source_excludes: in: query name: _source_excludes description: A comma-separated list of source fields to exclude in the response. schema: - $ref: '#/components/schemas/_common:Fields' + $ref: '#/components/schemas/_common___Fields' style: form - exists::query._source_includes: + exists___query._source_includes: in: query name: _source_includes description: A comma-separated list of source fields to include in the response. schema: - $ref: '#/components/schemas/_common:Fields' + $ref: '#/components/schemas/_common___Fields' style: form - exists::query.preference: + exists___query.preference: in: query name: preference description: |- @@ -17912,28 +18432,28 @@ components: type: string default: random style: form - exists::query.realtime: + exists___query.realtime: in: query name: realtime description: If `true`, the request is real-time as opposed to near-real-time. schema: type: boolean style: form - exists::query.refresh: + exists___query.refresh: in: query name: refresh description: If `true`, OpenSearch refreshes all shards involved in the delete by query after the request completes. schema: - type: boolean + $ref: '#/components/schemas/_common___Refresh' style: form - exists::query.routing: + exists___query.routing: in: query name: routing description: Target the specified primary shard. schema: - $ref: '#/components/schemas/_common:RoutingInQueryString' + $ref: '#/components/schemas/_common___RoutingInQueryString' style: form - exists::query.stored_fields: + exists___query.stored_fields: in: query name: stored_fields description: |- @@ -17941,33 +18461,33 @@ components: If no fields are specified, no stored fields are included in the response. If this field is specified, the `_source` parameter defaults to false. schema: - $ref: '#/components/schemas/_common:Fields' + $ref: '#/components/schemas/_common___Fields' style: form - exists::query.version: + exists___query.version: in: query name: version description: |- Explicit version number for concurrency control. The specified version must match the current version of the document for the request to succeed. schema: - $ref: '#/components/schemas/_common:VersionNumber' + $ref: '#/components/schemas/_common___VersionNumber' style: form - exists::query.version_type: + exists___query.version_type: in: query name: version_type description: 'Specific version type: `external`, `external_gte`.' schema: - $ref: '#/components/schemas/_common:VersionType' + $ref: '#/components/schemas/_common___VersionType' style: form - explain::path.id: + explain___path.id: in: path name: id description: Defines the document ID. required: true schema: - $ref: '#/components/schemas/_common:Id' + $ref: '#/components/schemas/_common___Id' style: simple - explain::path.index: + explain___path.index: in: path name: index description: |- @@ -17975,30 +18495,30 @@ components: Only a single index name can be provided to this parameter. required: true schema: - $ref: '#/components/schemas/_common:IndexName' + $ref: '#/components/schemas/_common___IndexName' style: simple - explain::query._source: + explain___query._source: in: query name: _source - description: True or false to return the `_source` field or not, or a list of fields to return. + description: Set to `true` or `false` to return the `_source` field or not, or a list of fields to return. schema: - $ref: '#/components/schemas/_core.search:SourceConfigParam' + $ref: '#/components/schemas/_core.search___SourceConfigParam' style: form - explain::query._source_excludes: + explain___query._source_excludes: in: query name: _source_excludes description: A comma-separated list of source fields to exclude from the response. schema: - $ref: '#/components/schemas/_common:Fields' + $ref: '#/components/schemas/_common___Fields' style: form - explain::query._source_includes: + explain___query._source_includes: in: query name: _source_includes description: A comma-separated list of source fields to include in the response. schema: - $ref: '#/components/schemas/_common:Fields' + $ref: '#/components/schemas/_common___Fields' style: form - explain::query.analyze_wildcard: + explain___query.analyze_wildcard: in: query name: analyze_wildcard description: If `true`, wildcard and prefix queries are analyzed. @@ -18006,7 +18526,7 @@ components: type: boolean default: false style: form - explain::query.analyzer: + explain___query.analyzer: in: query name: analyzer description: |- @@ -18015,14 +18535,14 @@ components: schema: type: string style: form - explain::query.default_operator: + explain___query.default_operator: in: query name: default_operator description: 'The default operator for query string query: `AND` or `OR`.' schema: - $ref: '#/components/schemas/_common.query_dsl:Operator' + $ref: '#/components/schemas/_common.query_dsl___Operator' style: form - explain::query.df: + explain___query.df: in: query name: df description: Field to use as default where no field prefix is given in the query string. @@ -18030,14 +18550,14 @@ components: type: string default: _all style: form - explain::query.lenient: + explain___query.lenient: in: query name: lenient description: If `true`, format-based query failures (such as providing text to a numeric field) in the query string will be ignored. schema: type: boolean style: form - explain::query.preference: + explain___query.preference: in: query name: preference description: |- @@ -18047,256 +18567,252 @@ components: type: string default: random style: form - explain::query.q: + explain___query.q: in: query name: q description: Query in the Lucene query string syntax. schema: type: string style: form - explain::query.routing: + explain___query.routing: in: query name: routing description: Custom value used to route operations to a specific shard. schema: - $ref: '#/components/schemas/_common:RoutingInQueryString' + $ref: '#/components/schemas/_common___RoutingInQueryString' style: form - explain::query.stored_fields: + explain___query.stored_fields: in: query name: stored_fields description: A comma-separated list of stored fields to return in the response. schema: - $ref: '#/components/schemas/_common:Fields' + $ref: '#/components/schemas/_common___Fields' style: form - field_caps::path.index: + field_caps___path.index: in: path name: index - description: Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (*). To target all data streams and indices, omit this parameter or use * or _all. + description: Comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (*). To target all data streams and indexes, omit this parameter or use * or `_all`. required: true schema: - $ref: '#/components/schemas/_common:Indices' + $ref: '#/components/schemas/_common___Indices' style: simple - field_caps::query.allow_no_indices: + field_caps___query.allow_no_indices: in: query name: allow_no_indices description: |- - If false, the request returns an error if any wildcard expression, index alias, - or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request + If `false`, the request returns an error if any wildcard expression, index alias, + or `_all` value targets only missing or closed indexes. This behavior applies even if the request targets other open indexes. For example, a request targeting `foo*,bar*` returns an error if an index starts with foo but no index starts with bar. schema: type: boolean style: form - field_caps::query.expand_wildcards: + field_caps___query.expand_wildcards: in: query name: expand_wildcards description: Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`. schema: - $ref: '#/components/schemas/_common:ExpandWildcards' + $ref: '#/components/schemas/_common___ExpandWildcards' style: form - field_caps::query.fields: + field_caps___query.fields: in: query name: fields description: Comma-separated list of fields to retrieve capabilities for. Wildcard (`*`) expressions are supported. schema: - $ref: '#/components/schemas/_common:Fields' + $ref: '#/components/schemas/_common___Fields' style: form - field_caps::query.ignore_unavailable: + field_caps___query.ignore_unavailable: in: query name: ignore_unavailable - description: If `true`, missing or closed indices are not included in the response. + description: If `true`, missing or closed indexes are not included in the response. schema: type: boolean style: form - field_caps::query.include_unmapped: + field_caps___query.include_unmapped: in: query name: include_unmapped - description: If true, unmapped fields are included in the response. + description: If `true`, unmapped fields are included in the response. schema: type: boolean default: false style: form - flow_framework.create::query.provision: + flow_framework.create___query.provision: in: query name: provision schema: - $ref: '#/components/schemas/flow_framework.common:Provision' - flow_framework.create::query.reprovision: + $ref: '#/components/schemas/flow_framework.common___Provision' + flow_framework.create___query.reprovision: x-version-added: '2.17' in: query name: reprovision schema: - $ref: '#/components/schemas/flow_framework.common:Reprovision' - flow_framework.create::query.update_fields: + $ref: '#/components/schemas/flow_framework.common___Reprovision' + flow_framework.create___query.update_fields: in: query name: update_fields schema: - $ref: '#/components/schemas/flow_framework.common:UpdateFields' - flow_framework.create::query.use_case: - description: To use a workflow template, specify it in the use_case query parameter when creating a workflow. - externalDocs: - url: https://opensearch.org/docs/latest/automating-configurations/workflow-templates/#supported-workflow-templates + $ref: '#/components/schemas/flow_framework.common___UpdateFields' + flow_framework.create___query.use_case: + description: To use a workflow template, specify it in the `use_case` query parameter when creating a workflow. in: query name: use_case schema: - $ref: '#/components/schemas/flow_framework.common:UseCase' - flow_framework.create::query.validation: + $ref: '#/components/schemas/flow_framework.common___UseCase' + flow_framework.create___query.validation: in: query name: validation schema: - $ref: '#/components/schemas/flow_framework.common:Validation' - flow_framework.delete::path.workflow_id: + $ref: '#/components/schemas/flow_framework.common___Validation' + flow_framework.delete___path.workflow_id: name: workflow_id in: path required: true schema: - $ref: '#/components/schemas/flow_framework.common:WorkflowID' - flow_framework.delete::query.clear_status: + $ref: '#/components/schemas/flow_framework.common___WorkflowID' + flow_framework.delete___query.clear_status: in: query name: clear_status schema: description: Delete the workflow state (without deprovisioning resources) after deleting the template. OpenSearch deletes the workflow state only if the provisioning status is not IN_PROGRESS. Default is false. type: boolean default: false - flow_framework.deprovision::path.workflow_id: + flow_framework.deprovision___path.workflow_id: name: workflow_id in: path required: true schema: - $ref: '#/components/schemas/flow_framework.common:WorkflowID' - flow_framework.deprovision::query.allow_delete: + $ref: '#/components/schemas/flow_framework.common___WorkflowID' + flow_framework.deprovision___query.allow_delete: in: query name: allow_delete schema: - $ref: '#/components/schemas/flow_framework.common:AllowDelete' - flow_framework.get_status::path.workflow_id: + $ref: '#/components/schemas/flow_framework.common___AllowDelete' + flow_framework.get_status___path.workflow_id: name: workflow_id in: path required: true schema: - $ref: '#/components/schemas/flow_framework.common:WorkflowID' - flow_framework.get_status::query.all: + $ref: '#/components/schemas/flow_framework.common___WorkflowID' + flow_framework.get_status___query.all: description: The all parameter specifies whether the response should return all fields. in: query name: all schema: - $ref: '#/components/schemas/flow_framework.common:All' - flow_framework.get_steps::query.workflow_step: + $ref: '#/components/schemas/flow_framework.common___All' + flow_framework.get_steps___query.workflow_step: in: query name: workflow_step required: false schema: description: The name of the step to retrieve. - $ref: '#/components/schemas/flow_framework.common:WorkflowStepName' - flow_framework.get::path.workflow_id: + $ref: '#/components/schemas/flow_framework.common___WorkflowStepName' + flow_framework.get___path.workflow_id: name: workflow_id in: path required: true schema: - $ref: '#/components/schemas/flow_framework.common:WorkflowID' - flow_framework.provision::path.workflow_id: + $ref: '#/components/schemas/flow_framework.common___WorkflowID' + flow_framework.provision___path.workflow_id: name: workflow_id in: path required: true schema: - $ref: '#/components/schemas/flow_framework.common:WorkflowID' - flow_framework.update::path.workflow_id: + $ref: '#/components/schemas/flow_framework.common___WorkflowID' + flow_framework.update___path.workflow_id: name: workflow_id in: path required: true schema: - $ref: '#/components/schemas/flow_framework.common:WorkflowID' - flow_framework.update::query.provision: + $ref: '#/components/schemas/flow_framework.common___WorkflowID' + flow_framework.update___query.provision: in: query name: provision schema: - $ref: '#/components/schemas/flow_framework.common:Provision' - flow_framework.update::query.reprovision: + $ref: '#/components/schemas/flow_framework.common___Provision' + flow_framework.update___query.reprovision: x-version-added: '2.17' in: query name: reprovision schema: - $ref: '#/components/schemas/flow_framework.common:Reprovision' - flow_framework.update::query.update_fields: + $ref: '#/components/schemas/flow_framework.common___Reprovision' + flow_framework.update___query.update_fields: in: query name: update_fields schema: - $ref: '#/components/schemas/flow_framework.common:UpdateFields' - flow_framework.update::query.use_case: - description: To use a workflow template, specify it in the use_case query parameter when creating a workflow. - externalDocs: - url: https://opensearch.org/docs/latest/automating-configurations/workflow-templates/#supported-workflow-templates + $ref: '#/components/schemas/flow_framework.common___UpdateFields' + flow_framework.update___query.use_case: + description: To use a workflow template, specify it in the `use_case` query parameter when creating a workflow. in: query name: use_case schema: - $ref: '#/components/schemas/flow_framework.common:UseCase' - flow_framework.update::query.validation: + $ref: '#/components/schemas/flow_framework.common___UseCase' + flow_framework.update___query.validation: in: query name: validation schema: - $ref: '#/components/schemas/flow_framework.common:Validation' - get_script::path.id: + $ref: '#/components/schemas/flow_framework.common___Validation' + get_script___path.id: in: path name: id description: Identifier for the stored script or search template. required: true schema: - $ref: '#/components/schemas/_common:Id' + $ref: '#/components/schemas/_common___Id' style: simple - get_script::query.cluster_manager_timeout: + get_script___query.cluster_manager_timeout: name: cluster_manager_timeout in: query description: Operation timeout for connection to cluster-manager node. schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' x-version-added: '2.0' - get_script::query.master_timeout: + get_script___query.master_timeout: in: query name: master_timeout description: Specify timeout for connection to master deprecated: true schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' style: form x-version-deprecated: '2.0' - x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. - get_source::path.id: + x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. + get_source___path.id: in: path name: id description: Unique identifier of the document. required: true schema: - $ref: '#/components/schemas/_common:Id' + $ref: '#/components/schemas/_common___Id' style: simple - get_source::path.index: + get_source___path.index: in: path name: index description: Name of the index that contains the document. required: true schema: - $ref: '#/components/schemas/_common:IndexName' + $ref: '#/components/schemas/_common___IndexName' style: simple - get_source::query._source: + get_source___query._source: in: query name: _source - description: True or false to return the _source field or not, or a list of fields to return. + description: Set to `true` or `false` to return the `_source` field or not, or a list of fields to return. schema: - $ref: '#/components/schemas/_core.search:SourceConfigParam' + $ref: '#/components/schemas/_core.search___SourceConfigParam' style: form - get_source::query._source_excludes: + get_source___query._source_excludes: in: query name: _source_excludes description: A comma-separated list of source fields to exclude in the response. schema: - $ref: '#/components/schemas/_common:Fields' + $ref: '#/components/schemas/_common___Fields' style: form - get_source::query._source_includes: + get_source___query._source_includes: in: query name: _source_includes description: A comma-separated list of source fields to include in the response. schema: - $ref: '#/components/schemas/_common:Fields' + $ref: '#/components/schemas/_common___Fields' style: form - get_source::query.preference: + get_source___query.preference: in: query name: preference description: Specifies the node or shard the operation should be performed on. Random by default. @@ -18304,79 +18820,79 @@ components: type: string default: random style: form - get_source::query.realtime: + get_source___query.realtime: in: query name: realtime - description: Boolean) If true, the request is real-time as opposed to near-real-time. + description: Boolean) If `true`, the request is real-time as opposed to near-real-time. schema: type: boolean style: form - get_source::query.refresh: + get_source___query.refresh: in: query name: refresh - description: If true, OpenSearch refreshes the affected shards to make this operation visible to search. If false, do nothing with refreshes. + description: If `true`, OpenSearch refreshes the affected shards to make this operation visible to search. If `false`, do nothing with refreshes. schema: - type: boolean + $ref: '#/components/schemas/_common___Refresh' style: form - get_source::query.routing: + get_source___query.routing: in: query name: routing description: Target the specified primary shard. schema: - $ref: '#/components/schemas/_common:RoutingInQueryString' + $ref: '#/components/schemas/_common___RoutingInQueryString' style: form - get_source::query.version: + get_source___query.version: in: query name: version description: Explicit version number for concurrency control. The specified version must match the current version of the document for the request to succeed. schema: - $ref: '#/components/schemas/_common:VersionNumber' + $ref: '#/components/schemas/_common___VersionNumber' style: form - get_source::query.version_type: + get_source___query.version_type: in: query name: version_type - description: 'Specific version type: internal, external, external_gte.' + description: Specific version type. One of `internal`, `external`, `external_gte`. schema: - $ref: '#/components/schemas/_common:VersionType' + $ref: '#/components/schemas/_common___VersionType' style: form - get::path.id: + get___path.id: in: path name: id description: Unique identifier of the document. required: true schema: - $ref: '#/components/schemas/_common:Id' + $ref: '#/components/schemas/_common___Id' style: simple - get::path.index: + get___path.index: in: path name: index description: Name of the index that contains the document. required: true schema: - $ref: '#/components/schemas/_common:IndexName' + $ref: '#/components/schemas/_common___IndexName' style: simple - get::query._source: + get___query._source: in: query name: _source - description: True or false to return the _source field or not, or a list of fields to return. + description: Set to `true` or `false` to return the `_source` field or not, or a list of fields to return. schema: - $ref: '#/components/schemas/_core.search:SourceConfigParam' + $ref: '#/components/schemas/_core.search___SourceConfigParam' style: form - get::query._source_excludes: + get___query._source_excludes: in: query name: _source_excludes description: A comma-separated list of source fields to exclude in the response. schema: - $ref: '#/components/schemas/_common:Fields' + $ref: '#/components/schemas/_common___Fields' style: form - get::query._source_includes: + get___query._source_includes: in: query name: _source_includes description: A comma-separated list of source fields to include in the response. schema: - $ref: '#/components/schemas/_common:Fields' + $ref: '#/components/schemas/_common___Fields' style: form - get::query.preference: + get___query.preference: in: query name: preference description: Specifies the node or shard the operation should be performed on. Random by default. @@ -18384,28 +18900,28 @@ components: type: string default: random style: form - get::query.realtime: + get___query.realtime: in: query name: realtime description: If `true`, the request is real-time as opposed to near-real-time. schema: type: boolean style: form - get::query.refresh: + get___query.refresh: in: query name: refresh - description: If true, OpenSearch refreshes the affected shards to make this operation visible to search. If false, do nothing with refreshes. + description: If `true`, OpenSearch refreshes the affected shards to make this operation visible to search. If `false`, do nothing with refreshes. schema: - type: boolean + $ref: '#/components/schemas/_common___Refresh' style: form - get::query.routing: + get___query.routing: in: query name: routing description: Target the specified primary shard. schema: - $ref: '#/components/schemas/_common:RoutingInQueryString' + $ref: '#/components/schemas/_common___RoutingInQueryString' style: form - get::query.stored_fields: + get___query.stored_fields: in: query name: stored_fields description: |- @@ -18413,39 +18929,39 @@ components: If no fields are specified, no stored fields are included in the response. If this field is specified, the `_source` parameter defaults to false. schema: - $ref: '#/components/schemas/_common:Fields' + $ref: '#/components/schemas/_common___Fields' style: form - get::query.version: + get___query.version: in: query name: version description: Explicit version number for concurrency control. The specified version must match the current version of the document for the request to succeed. schema: - $ref: '#/components/schemas/_common:VersionNumber' + $ref: '#/components/schemas/_common___VersionNumber' style: form - get::query.version_type: + get___query.version_type: in: query name: version_type - description: 'Specific version type: internal, external, external_gte.' + description: 'Specific version type: `internal`, `external`, `external_gte`.' schema: - $ref: '#/components/schemas/_common:VersionType' + $ref: '#/components/schemas/_common___VersionType' style: form - index::path.id: + index___path.id: in: path name: id description: Unique identifier for the document. required: true schema: - $ref: '#/components/schemas/_common:Id' + $ref: '#/components/schemas/_common___Id' style: simple - index::path.index: + index___path.index: in: path name: index description: Name of the data stream or index to target. required: true schema: - $ref: '#/components/schemas/_common:IndexName' + $ref: '#/components/schemas/_common___IndexName' style: simple - index::query.if_primary_term: + index___query.if_primary_term: in: query name: if_primary_term description: Only perform the operation if the document has this primary term. @@ -18453,14 +18969,14 @@ components: type: integer format: int64 style: form - index::query.if_seq_no: + index___query.if_seq_no: in: query name: if_seq_no description: Only perform the operation if the document has this sequence number. schema: - $ref: '#/components/schemas/_common:SequenceNumber' + $ref: '#/components/schemas/_common___SequenceNumber' style: form - index::query.op_type: + index___query.op_type: in: query name: op_type description: |- @@ -18471,9 +18987,9 @@ components: If document id is specified, it defaults to `index`. Otherwise, it defaults to `create`. schema: - $ref: '#/components/schemas/_common:OpType' + $ref: '#/components/schemas/_common___OpType' style: form - index::query.pipeline: + index___query.pipeline: in: query name: pipeline description: |- @@ -18483,16 +18999,16 @@ components: schema: type: string style: form - index::query.refresh: + index___query.refresh: in: query name: refresh description: |- If `true`, OpenSearch refreshes the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` do nothing with refreshes. Valid values: `true`, `false`, `wait_for`. schema: - $ref: '#/components/schemas/_common:Refresh' + $ref: '#/components/schemas/_common___Refresh' style: form - index::query.require_alias: + index___query.require_alias: in: query name: require_alias description: If `true`, the destination must be an index alias. @@ -18500,108 +19016,108 @@ components: type: boolean default: false style: form - index::query.routing: + index___query.routing: in: query name: routing description: Custom value used to route operations to a specific shard. schema: - $ref: '#/components/schemas/_common:RoutingInQueryString' + $ref: '#/components/schemas/_common___RoutingInQueryString' style: form - index::query.timeout: + index___query.timeout: in: query name: timeout description: 'Period the request waits for the following operations: automatic index creation, dynamic mapping updates, waiting for active shards.' schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' style: form - index::query.version: + index___query.version: in: query name: version description: |- Explicit version number for concurrency control. The specified version must match the current version of the document for the request to succeed. schema: - $ref: '#/components/schemas/_common:VersionNumber' + $ref: '#/components/schemas/_common___VersionNumber' style: form - index::query.version_type: + index___query.version_type: in: query name: version_type description: 'Specific version type: `external`, `external_gte`.' schema: - $ref: '#/components/schemas/_common:VersionType' + $ref: '#/components/schemas/_common___VersionType' style: form - index::query.wait_for_active_shards: + index___query.wait_for_active_shards: in: query name: wait_for_active_shards description: |- The number of shard copies that must be active before proceeding with the operation. Set to all or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). schema: - $ref: '#/components/schemas/_common:WaitForActiveShards' + $ref: '#/components/schemas/_common___WaitForActiveShards' style: form x-default: '1' - indices.add_block::path.block: + indices.add_block___path.block: in: path name: block - description: The block to add (one of read, write, read_only or metadata) + description: The block to add (one of `read`, `write`, `read_only` or `metadata`). required: true schema: - $ref: '#/components/schemas/indices.add_block:IndicesBlockOptions' + $ref: '#/components/schemas/indices.add_block___IndicesBlockOptions' style: simple - indices.add_block::path.index: + indices.add_block___path.index: in: path name: index - description: A comma separated list of indices to add a block to + description: A comma separated list of indexes to add a block to. required: true schema: - $ref: '#/components/schemas/_common:Indices' + $ref: '#/components/schemas/_common___Indices' style: simple - indices.add_block::query.allow_no_indices: + indices.add_block___query.allow_no_indices: in: query name: allow_no_indices - description: Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) + description: Whether to ignore if a wildcard indexes expression resolves into no concrete indexes. (This includes `_all` string or when no indexes have been specified). schema: type: boolean style: form - indices.add_block::query.cluster_manager_timeout: + indices.add_block___query.cluster_manager_timeout: name: cluster_manager_timeout in: query description: Operation timeout for connection to cluster-manager node. schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' x-version-added: '2.0' - indices.add_block::query.expand_wildcards: + indices.add_block___query.expand_wildcards: in: query name: expand_wildcards - description: Whether to expand wildcard expression to concrete indices that are open, closed or both. + description: Whether to expand wildcard expression to concrete indexes that are open, closed or both. schema: - $ref: '#/components/schemas/_common:ExpandWildcards' + $ref: '#/components/schemas/_common___ExpandWildcards' style: form - indices.add_block::query.ignore_unavailable: + indices.add_block___query.ignore_unavailable: in: query name: ignore_unavailable - description: Whether specified concrete indices should be ignored when unavailable (missing or closed) + description: Whether specified concrete indexes should be ignored when unavailable (missing or closed). schema: type: boolean style: form - indices.add_block::query.master_timeout: + indices.add_block___query.master_timeout: in: query name: master_timeout - description: Specify timeout for connection to master + description: Specify timeout for connection to cluster manager. deprecated: true schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' style: form x-version-deprecated: '2.0' - x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. - indices.add_block::query.timeout: + x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. + indices.add_block___query.timeout: in: query name: timeout description: Explicit operation timeout schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' style: form - indices.analyze::path.index: + indices.analyze___path.index: in: path name: index description: |- @@ -18610,36 +19126,36 @@ components: If no index is specified or the index does not have a default analyzer, the analyze API uses the standard analyzer. required: true schema: - $ref: '#/components/schemas/_common:IndexName' + $ref: '#/components/schemas/_common___IndexName' style: simple - indices.analyze::query.index: + indices.analyze___query.index: name: index in: query description: The name of the index to scope the operation. schema: type: string description: The name of the index to scope the operation. - indices.clear_cache::path.index: + indices.clear_cache___path.index: in: path name: index description: |- - Comma-separated list of data streams, indices, and aliases used to limit the request. + Comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (`*`). - To target all data streams and indices, omit this parameter or use `*` or `_all`. + To target all data streams and indexes, omit this parameter or use `*` or `_all`. required: true schema: - $ref: '#/components/schemas/_common:Indices' + $ref: '#/components/schemas/_common___Indices' style: simple - indices.clear_cache::query.allow_no_indices: + indices.clear_cache___query.allow_no_indices: in: query name: allow_no_indices description: |- - If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. - This behavior applies even if the request targets other open indices. + If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indexes. + This behavior applies even if the request targets other open indexes. schema: type: boolean style: form - indices.clear_cache::query.expand_wildcards: + indices.clear_cache___query.expand_wildcards: in: query name: expand_wildcards description: |- @@ -18648,9 +19164,9 @@ components: Supports comma-separated values, such as `open,hidden`. Valid values are: `all`, `open`, `closed`, `hidden`, `none`. schema: - $ref: '#/components/schemas/_common:ExpandWildcards' + $ref: '#/components/schemas/_common___ExpandWildcards' style: form - indices.clear_cache::query.fielddata: + indices.clear_cache___query.fielddata: in: query name: fielddata description: |- @@ -18659,114 +19175,114 @@ components: schema: type: boolean style: form - indices.clear_cache::query.fields: + indices.clear_cache___query.fields: in: query name: fields description: Comma-separated list of field names used to limit the `fielddata` parameter. schema: - $ref: '#/components/schemas/_common:Fields' + $ref: '#/components/schemas/_common___Fields' style: form - indices.clear_cache::query.file: + indices.clear_cache___query.file: x-version-added: '2.8' in: query name: file - description: If true, clears the unused entries from the file cache on nodes with the Search role. + description: If `true`, clears the unused entries from the file cache on nodes with the Search role. schema: type: boolean default: false style: form - indices.clear_cache::query.ignore_unavailable: + indices.clear_cache___query.ignore_unavailable: in: query name: ignore_unavailable description: If `false`, the request returns an error if it targets a missing or closed index. schema: type: boolean style: form - indices.clear_cache::query.index: + indices.clear_cache___query.index: name: index in: query - description: Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices. + description: Comma-separated list of indexes; use `_all` or empty string to perform the operation on all indexes. style: form schema: type: array items: type: string - description: Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices. + description: Comma-separated list of indexes; use `_all` or empty string to perform the operation on all indexes. explode: true - indices.clear_cache::query.query: + indices.clear_cache___query.query: in: query name: query description: If `true`, clears the query cache. schema: type: boolean style: form - indices.clear_cache::query.request: + indices.clear_cache___query.request: in: query name: request description: If `true`, clears the request cache. schema: type: boolean style: form - indices.clone::path.index: + indices.clone___path.index: in: path name: index description: Name of the source index to clone. required: true schema: - $ref: '#/components/schemas/_common:IndexName' + $ref: '#/components/schemas/_common___IndexName' style: simple - indices.clone::path.target: + indices.clone___path.target: in: path name: target description: Name of the target index to create. required: true schema: - $ref: '#/components/schemas/_common:Name' + $ref: '#/components/schemas/_common___Name' style: simple - indices.clone::query.cluster_manager_timeout: + indices.clone___query.cluster_manager_timeout: name: cluster_manager_timeout in: query description: Operation timeout for connection to cluster-manager node. schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' x-version-added: '2.0' - indices.clone::query.master_timeout: + indices.clone___query.master_timeout: in: query name: master_timeout description: |- - Period to wait for a connection to the master node. + Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error. deprecated: true schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' style: form x-version-deprecated: '2.0' - x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. - indices.clone::query.task_execution_timeout: + x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. + indices.clone___query.task_execution_timeout: name: task_execution_timeout in: query - description: Explicit task execution timeout, only useful when wait_for_completion is false, defaults to 1h. + description: Explicit task execution timeout, only useful when `wait_for_completion` is false, defaults to `1h`. schema: - $ref: '#/components/schemas/_common:Duration' - indices.clone::query.timeout: + $ref: '#/components/schemas/_common___Duration' + indices.clone___query.timeout: in: query name: timeout description: |- Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' style: form - indices.clone::query.wait_for_active_shards: + indices.clone___query.wait_for_active_shards: in: query name: wait_for_active_shards description: |- The number of shard copies that must be active before proceeding with the operation. Set to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). schema: - $ref: '#/components/schemas/_common:WaitForActiveShards' + $ref: '#/components/schemas/_common___WaitForActiveShards' style: form - indices.clone::query.wait_for_completion: + indices.clone___query.wait_for_completion: x-version-added: '2.7' name: wait_for_completion in: query @@ -18775,31 +19291,31 @@ components: type: boolean default: true description: Should this request wait until the operation has completed before returning. - indices.close::path.index: + indices.close___path.index: in: path name: index description: Comma-separated list or wildcard expression of index names used to limit the request. required: true schema: - $ref: '#/components/schemas/_common:Indices' + $ref: '#/components/schemas/_common___Indices' style: simple - indices.close::query.allow_no_indices: + indices.close___query.allow_no_indices: in: query name: allow_no_indices description: |- - If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. - This behavior applies even if the request targets other open indices. + If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indexes. + This behavior applies even if the request targets other open indexes. schema: type: boolean style: form - indices.close::query.cluster_manager_timeout: + indices.close___query.cluster_manager_timeout: name: cluster_manager_timeout in: query description: Operation timeout for connection to cluster-manager node. schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' x-version-added: '2.0' - indices.close::query.expand_wildcards: + indices.close___query.expand_wildcards: in: query name: expand_wildcards description: |- @@ -18808,46 +19324,46 @@ components: Supports comma-separated values, such as `open,hidden`. Valid values are: `all`, `open`, `closed`, `hidden`, `none`. schema: - $ref: '#/components/schemas/_common:ExpandWildcards' + $ref: '#/components/schemas/_common___ExpandWildcards' style: form - indices.close::query.ignore_unavailable: + indices.close___query.ignore_unavailable: in: query name: ignore_unavailable description: If `false`, the request returns an error if it targets a missing or closed index. schema: type: boolean style: form - indices.close::query.master_timeout: + indices.close___query.master_timeout: in: query name: master_timeout description: |- - Period to wait for a connection to the master node. + Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error. deprecated: true schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' style: form x-version-deprecated: '2.0' - x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. - indices.close::query.timeout: + x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. + indices.close___query.timeout: in: query name: timeout description: |- Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' style: form - indices.close::query.wait_for_active_shards: + indices.close___query.wait_for_active_shards: in: query name: wait_for_active_shards description: |- The number of shard copies that must be active before proceeding with the operation. Set to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). schema: - $ref: '#/components/schemas/_common:WaitForActiveShards' + $ref: '#/components/schemas/_common___WaitForActiveShards' style: form - indices.create_data_stream::path.name: + indices.create_data_stream___path.name: in: path name: name description: |- @@ -18859,54 +19375,54 @@ components: Cannot be longer than 255 bytes. Multi-byte characters count towards this limit faster. required: true schema: - $ref: '#/components/schemas/_common:DataStreamName' + $ref: '#/components/schemas/_common___DataStreamName' style: simple - indices.create::path.index: + indices.create___path.index: in: path name: index description: Name of the index you wish to create. required: true schema: - $ref: '#/components/schemas/_common:IndexName' + $ref: '#/components/schemas/_common___IndexName' style: simple - indices.create::query.cluster_manager_timeout: + indices.create___query.cluster_manager_timeout: name: cluster_manager_timeout in: query description: Operation timeout for connection to cluster-manager node. schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' x-version-added: '2.0' - indices.create::query.master_timeout: + indices.create___query.master_timeout: in: query name: master_timeout description: |- - Period to wait for a connection to the master node. + Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error. deprecated: true schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' style: form x-version-deprecated: '2.0' - x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. - indices.create::query.timeout: + x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. + indices.create___query.timeout: in: query name: timeout description: |- Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' style: form - indices.create::query.wait_for_active_shards: + indices.create___query.wait_for_active_shards: in: query name: wait_for_active_shards description: |- The number of shard copies that must be active before proceeding with the operation. Set to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). schema: - $ref: '#/components/schemas/_common:WaitForActiveShards' + $ref: '#/components/schemas/_common___WaitForActiveShards' style: form - indices.data_streams_stats::path.name: + indices.data_streams_stats___path.name: in: path name: name description: |- @@ -18915,19 +19431,19 @@ components: To target all data streams in a cluster, omit this parameter or use `*`. required: true schema: - $ref: '#/components/schemas/_common:Indices' + $ref: '#/components/schemas/_common___Indices' style: simple - indices.delete_alias::path.index: + indices.delete_alias___path.index: in: path name: index description: |- - Comma-separated list of data streams or indices used to limit the request. + Comma-separated list of data streams or indexes used to limit the request. Supports wildcards (`*`). required: true schema: - $ref: '#/components/schemas/_common:Indices' + $ref: '#/components/schemas/_common___Indices' style: simple - indices.delete_alias::path.name: + indices.delete_alias___path.name: in: path name: name description: |- @@ -18935,77 +19451,77 @@ components: Supports wildcards (`*`). To remove all aliases, use `*` or `_all`. required: true schema: - $ref: '#/components/schemas/_common:Names' + $ref: '#/components/schemas/_common___Names' style: simple - indices.delete_alias::query.cluster_manager_timeout: + indices.delete_alias___query.cluster_manager_timeout: name: cluster_manager_timeout in: query description: Operation timeout for connection to cluster-manager node. schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' x-version-added: '2.0' - indices.delete_alias::query.master_timeout: + indices.delete_alias___query.master_timeout: in: query name: master_timeout description: |- - Period to wait for a connection to the master node. + Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error. deprecated: true schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' style: form x-version-deprecated: '2.0' - x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. - indices.delete_alias::query.timeout: + x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. + indices.delete_alias___query.timeout: in: query name: timeout description: |- Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' style: form - indices.delete_data_stream::path.name: + indices.delete_data_stream___path.name: in: path name: name description: Comma-separated list of data streams to delete. Wildcard (`*`) expressions are supported. required: true schema: - $ref: '#/components/schemas/_common:DataStreamNames' + $ref: '#/components/schemas/_common___DataStreamNames' style: simple - indices.delete_index_template::path.name: + indices.delete_index_template___path.name: in: path name: name description: Name of the index template to delete. Wildcard (*) expressions are supported. required: true schema: - $ref: '#/components/schemas/_common:Name' + $ref: '#/components/schemas/_common___Name' style: simple - indices.delete_index_template::query.cluster_manager_timeout: + indices.delete_index_template___query.cluster_manager_timeout: name: cluster_manager_timeout in: query description: Operation timeout for connection to cluster-manager node. schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' x-version-added: '2.0' - indices.delete_index_template::query.master_timeout: + indices.delete_index_template___query.master_timeout: in: query name: master_timeout - description: Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + description: Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error. deprecated: true schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' style: form x-version-deprecated: '2.0' - x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. - indices.delete_index_template::query.timeout: + x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. + indices.delete_index_template___query.timeout: in: query name: timeout description: Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' style: form - indices.delete_template::path.name: + indices.delete_template___path.name: in: path name: name description: |- @@ -19013,66 +19529,66 @@ components: Wildcard (`*`) expressions are supported. required: true schema: - $ref: '#/components/schemas/_common:Name' + $ref: '#/components/schemas/_common___Name' style: simple - indices.delete_template::query.cluster_manager_timeout: + indices.delete_template___query.cluster_manager_timeout: name: cluster_manager_timeout in: query description: Operation timeout for connection to cluster-manager node. schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' x-version-added: '2.0' - indices.delete_template::query.master_timeout: + indices.delete_template___query.master_timeout: in: query name: master_timeout description: |- - Period to wait for a connection to the master node. + Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error. deprecated: true schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' style: form x-version-deprecated: '2.0' - x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. - indices.delete_template::query.timeout: + x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. + indices.delete_template___query.timeout: in: query name: timeout description: |- Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' style: form - indices.delete::path.index: + indices.delete___path.index: in: path name: index description: |- - Comma-separated list of indices to delete. + Comma-separated list of indexes to delete. You cannot specify index aliases. By default, this parameter does not support wildcards (`*`) or `_all`. To use wildcards or `_all`, set the `action.destructive_requires_name` cluster setting to `false`. required: true schema: - $ref: '#/components/schemas/_common:Indices' + $ref: '#/components/schemas/_common___Indices' style: simple - indices.delete::query.allow_no_indices: + indices.delete___query.allow_no_indices: in: query name: allow_no_indices description: |- - If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. - This behavior applies even if the request targets other open indices. + If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indexes. + This behavior applies even if the request targets other open indexes. schema: type: boolean default: false style: form - indices.delete::query.cluster_manager_timeout: + indices.delete___query.cluster_manager_timeout: name: cluster_manager_timeout in: query description: Operation timeout for connection to cluster-manager node. schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' x-version-added: '2.0' - indices.delete::query.expand_wildcards: + indices.delete___query.expand_wildcards: in: query name: expand_wildcards description: |- @@ -19081,9 +19597,9 @@ components: Supports comma-separated values, such as `open,hidden`. Valid values are: `all`, `open`, `closed`, `hidden`, `none`. schema: - $ref: '#/components/schemas/_common:ExpandWildcards' + $ref: '#/components/schemas/_common___ExpandWildcards' style: form - indices.delete::query.ignore_unavailable: + indices.delete___query.ignore_unavailable: in: query name: ignore_unavailable description: If `false`, the request returns an error if it targets a missing or closed index. @@ -19091,55 +19607,55 @@ components: type: boolean default: false style: form - indices.delete::query.master_timeout: + indices.delete___query.master_timeout: in: query name: master_timeout description: |- - Period to wait for a connection to the master node. + Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error. deprecated: true schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' style: form x-version-deprecated: '2.0' - x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. - indices.delete::query.timeout: + x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. + indices.delete___query.timeout: in: query name: timeout description: |- Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' style: form - indices.exists_alias::path.index: + indices.exists_alias___path.index: in: path name: index description: |- - Comma-separated list of data streams or indices used to limit the request. Supports wildcards (`*`). - To target all data streams and indices, omit this parameter or use `*` or `_all`. + Comma-separated list of data streams or indexes used to limit the request. Supports wildcards (`*`). + To target all data streams and indexes, omit this parameter or use `*` or `_all`. required: true schema: - $ref: '#/components/schemas/_common:Indices' + $ref: '#/components/schemas/_common___Indices' style: simple - indices.exists_alias::path.name: + indices.exists_alias___path.name: in: path name: name description: Comma-separated list of aliases to check. Supports wildcards (`*`). required: true schema: - $ref: '#/components/schemas/_common:Names' + $ref: '#/components/schemas/_common___Names' style: simple - indices.exists_alias::query.allow_no_indices: + indices.exists_alias___query.allow_no_indices: in: query name: allow_no_indices description: |- - If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. - This behavior applies even if the request targets other open indices. + If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indexes. + This behavior applies even if the request targets other open indexes. schema: type: boolean style: form - indices.exists_alias::query.expand_wildcards: + indices.exists_alias___query.expand_wildcards: in: query name: expand_wildcards description: |- @@ -19148,16 +19664,16 @@ components: Supports comma-separated values, such as `open,hidden`. Valid values are: `all`, `open`, `closed`, `hidden`, `none`. schema: - $ref: '#/components/schemas/_common:ExpandWildcards' + $ref: '#/components/schemas/_common___ExpandWildcards' style: form - indices.exists_alias::query.ignore_unavailable: + indices.exists_alias___query.ignore_unavailable: in: query name: ignore_unavailable - description: If `false`, requests that include a missing data stream or index in the target indices or data streams return an error. + description: If `false`, requests that include a missing data stream or index in the target indexes or data streams return an error. schema: type: boolean style: form - indices.exists_alias::query.local: + indices.exists_alias___query.local: in: query name: local description: If `true`, the request retrieves information from the local node only. @@ -19165,22 +19681,22 @@ components: type: boolean default: false style: form - indices.exists_index_template::path.name: + indices.exists_index_template___path.name: in: path name: name description: Name of the index template to check existence of. Wildcard (*) expressions are supported. required: true schema: - $ref: '#/components/schemas/_common:Name' + $ref: '#/components/schemas/_common___Name' style: simple - indices.exists_index_template::query.cluster_manager_timeout: + indices.exists_index_template___query.cluster_manager_timeout: name: cluster_manager_timeout in: query description: Operation timeout for connection to cluster-manager node. schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' x-version-added: '2.0' - indices.exists_index_template::query.flat_settings: + indices.exists_index_template___query.flat_settings: name: flat_settings in: query description: Return settings in flat format. @@ -19188,7 +19704,7 @@ components: type: boolean default: false description: Return settings in flat format. - indices.exists_index_template::query.local: + indices.exists_index_template___query.local: name: local in: query description: Return local information, do not retrieve the state from cluster-manager node. @@ -19196,32 +19712,32 @@ components: type: boolean default: false description: Return local information, do not retrieve the state from cluster-manager node. - indices.exists_index_template::query.master_timeout: + indices.exists_index_template___query.master_timeout: in: query name: master_timeout - description: Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + description: Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error. deprecated: true schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' style: form x-version-deprecated: '2.0' - x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. - indices.exists_template::path.name: + x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. + indices.exists_template___path.name: in: path name: name description: The comma separated names of the index templates required: true schema: - $ref: '#/components/schemas/_common:Names' + $ref: '#/components/schemas/_common___Names' style: simple - indices.exists_template::query.cluster_manager_timeout: + indices.exists_template___query.cluster_manager_timeout: name: cluster_manager_timeout in: query description: Operation timeout for connection to cluster-manager node. schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' x-version-added: '2.0' - indices.exists_template::query.flat_settings: + indices.exists_template___query.flat_settings: in: query name: flat_settings description: Return settings in flat format. @@ -19229,7 +19745,7 @@ components: type: boolean default: false style: form - indices.exists_template::query.local: + indices.exists_template___query.local: in: query name: local description: Return local information, do not retrieve the state from cluster-manager node. @@ -19237,42 +19753,42 @@ components: type: boolean default: false style: form - indices.exists_template::query.master_timeout: + indices.exists_template___query.master_timeout: in: query name: master_timeout - description: Explicit operation timeout for connection to master node + description: Explicit operation timeout for connection to cluster-manager node deprecated: true schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' style: form x-version-deprecated: '2.0' - x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. - indices.exists::path.index: + x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. + indices.exists___path.index: in: path name: index - description: Comma-separated list of data streams, indices, and aliases. Supports wildcards (`*`). + description: Comma-separated list of data streams, indexes, and aliases. Supports wildcards (`*`). required: true schema: - $ref: '#/components/schemas/_common:Indices' + $ref: '#/components/schemas/_common___Indices' style: simple - indices.exists::query.allow_no_indices: + indices.exists___query.allow_no_indices: in: query name: allow_no_indices description: |- - If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. - This behavior applies even if the request targets other open indices. + If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indexes. + This behavior applies even if the request targets other open indexes. schema: type: boolean default: false style: form - indices.exists::query.cluster_manager_timeout: + indices.exists___query.cluster_manager_timeout: name: cluster_manager_timeout in: query description: Operation timeout for connection to cluster-manager node. schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' x-version-added: '2.0' - indices.exists::query.expand_wildcards: + indices.exists___query.expand_wildcards: in: query name: expand_wildcards description: |- @@ -19281,9 +19797,9 @@ components: Supports comma-separated values, such as `open,hidden`. Valid values are: `all`, `open`, `closed`, `hidden`, `none`. schema: - $ref: '#/components/schemas/_common:ExpandWildcards' + $ref: '#/components/schemas/_common___ExpandWildcards' style: form - indices.exists::query.flat_settings: + indices.exists___query.flat_settings: in: query name: flat_settings description: If `true`, returns settings in flat format. @@ -19291,7 +19807,7 @@ components: type: boolean default: false style: form - indices.exists::query.ignore_unavailable: + indices.exists___query.ignore_unavailable: in: query name: ignore_unavailable description: If `false`, the request returns an error if it targets a missing or closed index. @@ -19299,7 +19815,7 @@ components: type: boolean default: false style: form - indices.exists::query.include_defaults: + indices.exists___query.include_defaults: in: query name: include_defaults description: If `true`, return all default settings in the response. @@ -19307,7 +19823,7 @@ components: type: boolean default: false style: form - indices.exists::query.local: + indices.exists___query.local: in: query name: local description: If `true`, the request retrieves information from the local node only. @@ -19315,27 +19831,27 @@ components: type: boolean default: false style: form - indices.flush::path.index: + indices.flush___path.index: in: path name: index description: |- - Comma-separated list of data streams, indices, and aliases to flush. + Comma-separated list of data streams, indexes, and aliases to flush. Supports wildcards (`*`). - To flush all data streams and indices, omit this parameter or use `*` or `_all`. + To flush all data streams and indexes, omit this parameter or use `*` or `_all`. required: true schema: - $ref: '#/components/schemas/_common:Indices' + $ref: '#/components/schemas/_common___Indices' style: simple - indices.flush::query.allow_no_indices: + indices.flush___query.allow_no_indices: in: query name: allow_no_indices description: |- - If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. - This behavior applies even if the request targets other open indices. + If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indexes. + This behavior applies even if the request targets other open indexes. schema: type: boolean style: form - indices.flush::query.expand_wildcards: + indices.flush___query.expand_wildcards: in: query name: expand_wildcards description: |- @@ -19344,23 +19860,23 @@ components: Supports comma-separated values, such as `open,hidden`. Valid values are: `all`, `open`, `closed`, `hidden`, `none`. schema: - $ref: '#/components/schemas/_common:ExpandWildcards' + $ref: '#/components/schemas/_common___ExpandWildcards' style: form - indices.flush::query.force: + indices.flush___query.force: in: query name: force description: If `true`, the request forces a flush even if there are no changes to commit to the index. schema: type: boolean style: form - indices.flush::query.ignore_unavailable: + indices.flush___query.ignore_unavailable: in: query name: ignore_unavailable description: If `false`, the request returns an error if it targets a missing or closed index. schema: type: boolean style: form - indices.flush::query.wait_if_ongoing: + indices.flush___query.wait_if_ongoing: in: query name: wait_if_ongoing description: |- @@ -19370,29 +19886,29 @@ components: type: boolean default: true style: form - indices.forcemerge::path.index: + indices.forcemerge___path.index: in: path name: index - description: A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices + description: A comma-separated list of index names; use `_all` or empty string to perform the operation on all indexes required: true schema: - $ref: '#/components/schemas/_common:Indices' + $ref: '#/components/schemas/_common___Indices' style: simple - indices.forcemerge::query.allow_no_indices: + indices.forcemerge___query.allow_no_indices: in: query name: allow_no_indices - description: Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) + description: Whether to ignore if a wildcard indexes expression resolves into no concrete indexes. (This includes `_all` string or when no indexes have been specified) schema: type: boolean style: form - indices.forcemerge::query.expand_wildcards: + indices.forcemerge___query.expand_wildcards: in: query name: expand_wildcards - description: Whether to expand wildcard expression to concrete indices that are open, closed or both. + description: Whether to expand wildcard expression to concrete indexes that are open, closed or both. schema: - $ref: '#/components/schemas/_common:ExpandWildcards' + $ref: '#/components/schemas/_common___ExpandWildcards' style: form - indices.forcemerge::query.flush: + indices.forcemerge___query.flush: in: query name: flush description: Specify whether the index should be flushed after performing the operation. @@ -19400,14 +19916,14 @@ components: type: boolean default: true style: form - indices.forcemerge::query.ignore_unavailable: + indices.forcemerge___query.ignore_unavailable: in: query name: ignore_unavailable - description: Whether specified concrete indices should be ignored when unavailable (missing or closed) + description: Whether specified concrete indexes should be ignored when unavailable (missing or closed) schema: type: boolean style: form - indices.forcemerge::query.max_num_segments: + indices.forcemerge___query.max_num_segments: in: query name: max_num_segments description: |- @@ -19417,14 +19933,14 @@ components: schema: type: number style: form - indices.forcemerge::query.only_expunge_deletes: + indices.forcemerge___query.only_expunge_deletes: in: query name: only_expunge_deletes description: Specify whether the operation should only expunge deleted documents schema: type: boolean style: form - indices.forcemerge::query.primary_only: + indices.forcemerge___query.primary_only: x-version-added: '2.13' name: primary_only in: query @@ -19433,7 +19949,7 @@ components: type: boolean default: false description: Specify whether the operation should only perform on primary shards. Defaults to false. - indices.forcemerge::query.wait_for_completion: + indices.forcemerge___query.wait_for_completion: x-version-added: '2.7' in: query name: wait_for_completion @@ -19442,18 +19958,18 @@ components: type: boolean default: true style: form - indices.get_alias::path.index: + indices.get_alias___path.index: in: path name: index description: |- - Comma-separated list of data streams or indices used to limit the request. + Comma-separated list of data streams or indexes used to limit the request. Supports wildcards (`*`). - To target all data streams and indices, omit this parameter or use `*` or `_all`. + To target all data streams and indexes, omit this parameter or use `*` or `_all`. required: true schema: - $ref: '#/components/schemas/_common:Indices' + $ref: '#/components/schemas/_common___Indices' style: simple - indices.get_alias::path.name: + indices.get_alias___path.name: in: path name: name description: |- @@ -19462,18 +19978,18 @@ components: To retrieve all aliases, omit this parameter or use `*` or `_all`. required: true schema: - $ref: '#/components/schemas/_common:Names' + $ref: '#/components/schemas/_common___Names' style: simple - indices.get_alias::query.allow_no_indices: + indices.get_alias___query.allow_no_indices: in: query name: allow_no_indices description: |- - If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. - This behavior applies even if the request targets other open indices. + If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indexes. + This behavior applies even if the request targets other open indexes. schema: type: boolean style: form - indices.get_alias::query.expand_wildcards: + indices.get_alias___query.expand_wildcards: in: query name: expand_wildcards description: |- @@ -19482,16 +19998,16 @@ components: Supports comma-separated values, such as `open,hidden`. Valid values are: `all`, `open`, `closed`, `hidden`, `none`. schema: - $ref: '#/components/schemas/_common:ExpandWildcards' + $ref: '#/components/schemas/_common___ExpandWildcards' style: form - indices.get_alias::query.ignore_unavailable: + indices.get_alias___query.ignore_unavailable: in: query name: ignore_unavailable description: If `false`, the request returns an error if it targets a missing or closed index. schema: type: boolean style: form - indices.get_alias::query.local: + indices.get_alias___query.local: in: query name: local description: If `true`, the request retrieves information from the local node only. @@ -19499,7 +20015,7 @@ components: type: boolean default: false style: form - indices.get_data_stream::path.name: + indices.get_data_stream___path.name: in: path name: name description: |- @@ -19507,37 +20023,37 @@ components: Wildcard (`*`) expressions are supported. If omitted, all data streams are returned. required: true schema: - $ref: '#/components/schemas/_common:DataStreamNames' + $ref: '#/components/schemas/_common___DataStreamNames' style: simple - indices.get_field_mapping::path.fields: + indices.get_field_mapping___path.fields: in: path name: fields description: Comma-separated list or wildcard expression of fields used to limit returned information. required: true schema: - $ref: '#/components/schemas/_common:Fields' + $ref: '#/components/schemas/_common___Fields' style: simple - indices.get_field_mapping::path.index: + indices.get_field_mapping___path.index: in: path name: index description: |- - Comma-separated list of data streams, indices, and aliases used to limit the request. + Comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (`*`). - To target all data streams and indices, omit this parameter or use `*` or `_all`. + To target all data streams and indexes, omit this parameter or use `*` or `_all`. required: true schema: - $ref: '#/components/schemas/_common:Indices' + $ref: '#/components/schemas/_common___Indices' style: simple - indices.get_field_mapping::query.allow_no_indices: + indices.get_field_mapping___query.allow_no_indices: in: query name: allow_no_indices description: |- - If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. - This behavior applies even if the request targets other open indices. + If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indexes. + This behavior applies even if the request targets other open indexes. schema: type: boolean style: form - indices.get_field_mapping::query.expand_wildcards: + indices.get_field_mapping___query.expand_wildcards: in: query name: expand_wildcards description: |- @@ -19546,23 +20062,23 @@ components: Supports comma-separated values, such as `open,hidden`. Valid values are: `all`, `open`, `closed`, `hidden`, `none`. schema: - $ref: '#/components/schemas/_common:ExpandWildcards' + $ref: '#/components/schemas/_common___ExpandWildcards' style: form - indices.get_field_mapping::query.ignore_unavailable: + indices.get_field_mapping___query.ignore_unavailable: in: query name: ignore_unavailable description: If `false`, the request returns an error if it targets a missing or closed index. schema: type: boolean style: form - indices.get_field_mapping::query.include_defaults: + indices.get_field_mapping___query.include_defaults: in: query name: include_defaults description: If `true`, return all default settings in the response. schema: type: boolean style: form - indices.get_field_mapping::query.local: + indices.get_field_mapping___query.local: in: query name: local description: If `true`, the request retrieves information from the local node only. @@ -19570,75 +20086,75 @@ components: type: boolean default: false style: form - indices.get_index_template::path.name: + indices.get_index_template___path.name: in: path name: name description: Name of the index template to retrieve. Wildcard (*) expressions are supported. required: true schema: - $ref: '#/components/schemas/_common:Name' + $ref: '#/components/schemas/_common___Name' style: simple - indices.get_index_template::query.cluster_manager_timeout: + indices.get_index_template___query.cluster_manager_timeout: name: cluster_manager_timeout in: query description: Operation timeout for connection to cluster-manager node. schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' x-version-added: '2.0' - indices.get_index_template::query.flat_settings: + indices.get_index_template___query.flat_settings: in: query name: flat_settings - description: If true, returns settings in flat format. + description: If `true`, returns settings in flat format. schema: type: boolean default: false style: form - indices.get_index_template::query.local: + indices.get_index_template___query.local: in: query name: local - description: If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the master node. + description: If `true`, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the cluster-manager node. schema: type: boolean default: false style: form - indices.get_index_template::query.master_timeout: + indices.get_index_template___query.master_timeout: in: query name: master_timeout - description: Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + description: Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error. deprecated: true schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' style: form x-version-deprecated: '2.0' - x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. - indices.get_mapping::path.index: + x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. + indices.get_mapping___path.index: in: path name: index description: |- - Comma-separated list of data streams, indices, and aliases used to limit the request. + Comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (`*`). - To target all data streams and indices, omit this parameter or use `*` or `_all`. + To target all data streams and indexes, omit this parameter or use `*` or `_all`. required: true schema: - $ref: '#/components/schemas/_common:Indices' + $ref: '#/components/schemas/_common___Indices' style: simple - indices.get_mapping::query.allow_no_indices: + indices.get_mapping___query.allow_no_indices: in: query name: allow_no_indices description: |- - If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. - This behavior applies even if the request targets other open indices. + If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indexes. + This behavior applies even if the request targets other open indexes. schema: type: boolean style: form - indices.get_mapping::query.cluster_manager_timeout: + indices.get_mapping___query.cluster_manager_timeout: name: cluster_manager_timeout in: query description: Operation timeout for connection to cluster-manager node. schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' x-version-added: '2.0' - indices.get_mapping::query.expand_wildcards: + indices.get_mapping___query.expand_wildcards: in: query name: expand_wildcards description: |- @@ -19647,26 +20163,26 @@ components: Supports comma-separated values, such as `open,hidden`. Valid values are: `all`, `open`, `closed`, `hidden`, `none`. schema: - $ref: '#/components/schemas/_common:ExpandWildcards' + $ref: '#/components/schemas/_common___ExpandWildcards' style: form - indices.get_mapping::query.ignore_unavailable: + indices.get_mapping___query.ignore_unavailable: in: query name: ignore_unavailable description: If `false`, the request returns an error if it targets a missing or closed index. schema: type: boolean style: form - indices.get_mapping::query.index: + indices.get_mapping___query.index: in: query name: index description: |- - Comma-separated list of data streams, indices, and aliases used to limit the request. + Comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (`*`). - To target all data streams and indices, omit this parameter or use `*` or `_all`. + To target all data streams and indexes, omit this parameter or use `*` or `_all`. schema: - $ref: '#/components/schemas/_common:Indices' - style: simple - indices.get_mapping::query.local: + $ref: '#/components/schemas/_common___Indices' + style: form + indices.get_mapping___query.local: in: query name: local description: If `true`, the request retrieves information from the local node only. @@ -19674,57 +20190,57 @@ components: type: boolean default: false style: form - indices.get_mapping::query.master_timeout: + indices.get_mapping___query.master_timeout: in: query name: master_timeout description: |- - Period to wait for a connection to the master node. + Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error. deprecated: true schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' style: form x-version-deprecated: '2.0' - x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. - indices.get_settings::path.index: + x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. + indices.get_settings___path.index: in: path name: index description: |- - Comma-separated list of data streams, indices, and aliases used to limit + Comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams and - indices, omit this parameter or use `*` or `_all`. + indexes, omit this parameter or use `*` or `_all`. required: true schema: - $ref: '#/components/schemas/_common:Indices' + $ref: '#/components/schemas/_common___Indices' style: simple - indices.get_settings::path.name: + indices.get_settings___path.name: in: path name: name description: Comma-separated list or wildcard expression of settings to retrieve. required: true schema: - $ref: '#/components/schemas/_common:Names' + $ref: '#/components/schemas/_common___Names' style: simple - indices.get_settings::query.allow_no_indices: + indices.get_settings___query.allow_no_indices: in: query name: allow_no_indices description: |- If `false`, the request returns an error if any wildcard expression, index - alias, or `_all` value targets only missing or closed indices. This - behavior applies even if the request targets other open indices. For + alias, or `_all` value targets only missing or closed indexes. This + behavior applies even if the request targets other open indexes. For example, a request targeting `foo*,bar*` returns an error if an index starts with foo but no index starts with `bar`. schema: type: boolean style: form - indices.get_settings::query.cluster_manager_timeout: + indices.get_settings___query.cluster_manager_timeout: name: cluster_manager_timeout in: query description: Operation timeout for connection to cluster-manager node. schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' x-version-added: '2.0' - indices.get_settings::query.expand_wildcards: + indices.get_settings___query.expand_wildcards: in: query name: expand_wildcards description: |- @@ -19732,9 +20248,9 @@ components: If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`. schema: - $ref: '#/components/schemas/_common:ExpandWildcards' + $ref: '#/components/schemas/_common___ExpandWildcards' style: form - indices.get_settings::query.flat_settings: + indices.get_settings___query.flat_settings: in: query name: flat_settings description: If `true`, returns settings in flat format. @@ -19742,14 +20258,14 @@ components: type: boolean default: false style: form - indices.get_settings::query.ignore_unavailable: + indices.get_settings___query.ignore_unavailable: in: query name: ignore_unavailable description: If `false`, the request returns an error if it targets a missing or closed index. schema: type: boolean style: form - indices.get_settings::query.include_defaults: + indices.get_settings___query.include_defaults: in: query name: include_defaults description: If `true`, return all default settings in the response. @@ -19757,30 +20273,30 @@ components: type: boolean default: false style: form - indices.get_settings::query.local: + indices.get_settings___query.local: in: query name: local description: |- If `true`, the request retrieves information from the local node only. If - `false`, information is retrieved from the master node. + `false`, information is retrieved from the cluster-manager node. schema: type: boolean default: false style: form - indices.get_settings::query.master_timeout: + indices.get_settings___query.master_timeout: in: query name: master_timeout description: |- - Period to wait for a connection to the master node. If no response is + Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error. deprecated: true schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' style: form x-version-deprecated: '2.0' - x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. - indices.get_template::path.name: + x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. + indices.get_template___path.name: in: path name: name description: |- @@ -19789,16 +20305,16 @@ components: To return all index templates, omit this parameter or use a value of `_all` or `*`. required: true schema: - $ref: '#/components/schemas/_common:Names' + $ref: '#/components/schemas/_common___Names' style: simple - indices.get_template::query.cluster_manager_timeout: + indices.get_template___query.cluster_manager_timeout: name: cluster_manager_timeout in: query description: Operation timeout for connection to cluster-manager node. schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' x-version-added: '2.0' - indices.get_template::query.flat_settings: + indices.get_template___query.flat_settings: in: query name: flat_settings description: If `true`, returns settings in flat format. @@ -19806,7 +20322,7 @@ components: type: boolean default: false style: form - indices.get_template::query.local: + indices.get_template___query.local: in: query name: local description: If `true`, the request retrieves information from the local node only. @@ -19814,158 +20330,158 @@ components: type: boolean default: false style: form - indices.get_template::query.master_timeout: + indices.get_template___query.master_timeout: in: query name: master_timeout description: |- - Period to wait for a connection to the master node. + Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error. deprecated: true schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' style: form x-version-deprecated: '2.0' - x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. - indices.get_upgrade::path.index: + x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. + indices.get_upgrade___path.index: name: index in: path - description: Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices. + description: Comma-separated list of indexes; use `_all` or empty string to perform the operation on all indexes. schema: type: array - description: Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices. + description: Comma-separated list of indexes; use `_all` or empty string to perform the operation on all indexes. items: type: string required: true - indices.get_upgrade::query.allow_no_indices: + indices.get_upgrade___query.allow_no_indices: name: allow_no_indices in: query - description: Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified). + description: Whether to ignore if a wildcard indexes expression resolves into no concrete indexes. (This includes `_all` string or when no indexes have been specified). schema: type: boolean - description: Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified). - indices.get_upgrade::query.expand_wildcards: + description: Whether to ignore if a wildcard indexes expression resolves into no concrete indexes. (This includes `_all` string or when no indexes have been specified). + indices.get_upgrade___query.expand_wildcards: name: expand_wildcards in: query - description: Whether to expand wildcard expression to concrete indices that are open, closed or both. + description: Whether to expand wildcard expression to concrete indexes that are open, closed or both. schema: - $ref: '#/components/schemas/_common:ExpandWildcards' - indices.get_upgrade::query.ignore_unavailable: + $ref: '#/components/schemas/_common___ExpandWildcards' + indices.get_upgrade___query.ignore_unavailable: name: ignore_unavailable in: query - description: Whether specified concrete indices should be ignored when unavailable (missing or closed). + description: Whether specified concrete indexes should be ignored when unavailable (missing or closed). schema: type: boolean - description: Whether specified concrete indices should be ignored when unavailable (missing or closed). - indices.get::path.index: + description: Whether specified concrete indexes should be ignored when unavailable (missing or closed). + indices.get___path.index: in: path name: index description: |- - Comma-separated list of data streams, indices, and index aliases used to limit the request. + Comma-separated list of data streams, indexes, and index aliases used to limit the request. Wildcard expressions (*) are supported. required: true schema: - $ref: '#/components/schemas/_common:Indices' + $ref: '#/components/schemas/_common___Indices' style: simple - indices.get::query.allow_no_indices: + indices.get___query.allow_no_indices: in: query name: allow_no_indices description: |- - If false, the request returns an error if any wildcard expression, index alias, or _all value targets only - missing or closed indices. This behavior applies even if the request targets other open indices. For example, + If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only + missing or closed indexes. This behavior applies even if the request targets other open indexes. For example, a request targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar. schema: type: boolean default: false style: form - indices.get::query.cluster_manager_timeout: + indices.get___query.cluster_manager_timeout: name: cluster_manager_timeout in: query description: Operation timeout for connection to cluster-manager node. schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' x-version-added: '2.0' - indices.get::query.expand_wildcards: + indices.get___query.expand_wildcards: in: query name: expand_wildcards description: |- Type of index that wildcard expressions can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, - such as open,hidden. + such as `open,hidden`. schema: - $ref: '#/components/schemas/_common:ExpandWildcards' + $ref: '#/components/schemas/_common___ExpandWildcards' style: form - indices.get::query.flat_settings: + indices.get___query.flat_settings: in: query name: flat_settings - description: If true, returns settings in flat format. + description: If `true`, returns settings in flat format. schema: type: boolean default: false style: form - indices.get::query.ignore_unavailable: + indices.get___query.ignore_unavailable: in: query name: ignore_unavailable - description: If false, requests that target a missing index return an error. + description: If `false`, requests that target a missing index return an error. schema: type: boolean default: false style: form - indices.get::query.include_defaults: + indices.get___query.include_defaults: in: query name: include_defaults - description: If true, return all default settings in the response. + description: If `true`, return all default settings in the response. schema: type: boolean default: false style: form - indices.get::query.local: + indices.get___query.local: in: query name: local - description: If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the master node. + description: If `true`, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the cluster-manager node. schema: type: boolean default: false style: form - indices.get::query.master_timeout: + indices.get___query.master_timeout: in: query name: master_timeout - description: Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + description: Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error. deprecated: true schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' style: form x-version-deprecated: '2.0' - x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. - indices.open::path.index: + x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. + indices.open___path.index: in: path name: index description: |- - Comma-separated list of data streams, indices, and aliases used to limit the request. + Comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (`*`). - By default, you must explicitly name the indices you using to limit the request. + By default, you must explicitly name the indexes you using to limit the request. To limit a request using `_all`, `*`, or other wildcard expressions, change the `action.destructive_requires_name` setting to false. You can update this setting in the `opensearch.yml` file or using the cluster update settings API. required: true schema: - $ref: '#/components/schemas/_common:Indices' + $ref: '#/components/schemas/_common___Indices' style: simple - indices.open::query.allow_no_indices: + indices.open___query.allow_no_indices: in: query name: allow_no_indices description: |- - If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. - This behavior applies even if the request targets other open indices. + If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indexes. + This behavior applies even if the request targets other open indexes. schema: type: boolean style: form - indices.open::query.cluster_manager_timeout: + indices.open___query.cluster_manager_timeout: name: cluster_manager_timeout in: query description: Operation timeout for connection to cluster-manager node. schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' x-version-added: '2.0' - indices.open::query.expand_wildcards: + indices.open___query.expand_wildcards: in: query name: expand_wildcards description: |- @@ -19974,52 +20490,52 @@ components: Supports comma-separated values, such as `open,hidden`. Valid values are: `all`, `open`, `closed`, `hidden`, `none`. schema: - $ref: '#/components/schemas/_common:ExpandWildcards' + $ref: '#/components/schemas/_common___ExpandWildcards' style: form - indices.open::query.ignore_unavailable: + indices.open___query.ignore_unavailable: in: query name: ignore_unavailable description: If `false`, the request returns an error if it targets a missing or closed index. schema: type: boolean style: form - indices.open::query.master_timeout: + indices.open___query.master_timeout: in: query name: master_timeout description: |- - Period to wait for a connection to the master node. + Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error. deprecated: true schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' style: form x-version-deprecated: '2.0' - x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. - indices.open::query.task_execution_timeout: + x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. + indices.open___query.task_execution_timeout: name: task_execution_timeout in: query - description: Explicit task execution timeout, only useful when wait_for_completion is false, defaults to 1h. + description: Explicit task execution timeout, only useful when `wait_for_completion` is false, defaults to `1h`. schema: - $ref: '#/components/schemas/_common:Duration' - indices.open::query.timeout: + $ref: '#/components/schemas/_common___Duration' + indices.open___query.timeout: in: query name: timeout description: |- Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' style: form - indices.open::query.wait_for_active_shards: + indices.open___query.wait_for_active_shards: in: query name: wait_for_active_shards description: |- The number of shard copies that must be active before proceeding with the operation. Set to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). schema: - $ref: '#/components/schemas/_common:WaitForActiveShards' + $ref: '#/components/schemas/_common___WaitForActiveShards' style: form - indices.open::query.wait_for_completion: + indices.open___query.wait_for_completion: x-version-added: '2.7' name: wait_for_completion in: query @@ -20028,18 +20544,18 @@ components: type: boolean default: true description: Should this request wait until the operation has completed before returning. - indices.put_alias::path.index: + indices.put_alias___path.index: in: path name: index description: |- - Comma-separated list of data streams or indices to add. + Comma-separated list of data streams or indexes to add. Supports wildcards (`*`). - Wildcard patterns that match both data streams and indices return an error. + Wildcard patterns that match both data streams and indexes return an error. required: true schema: - $ref: '#/components/schemas/_common:Indices' + $ref: '#/components/schemas/_common___Indices' style: simple - indices.put_alias::path.name: + indices.put_alias___path.name: in: path name: name description: |- @@ -20048,45 +20564,45 @@ components: Index alias names support date math. required: true schema: - $ref: '#/components/schemas/_common:Name' + $ref: '#/components/schemas/_common___Name' style: simple - indices.put_alias::query.cluster_manager_timeout: + indices.put_alias___query.cluster_manager_timeout: name: cluster_manager_timeout in: query description: Operation timeout for connection to cluster-manager node. schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' x-version-added: '2.0' - indices.put_alias::query.master_timeout: + indices.put_alias___query.master_timeout: in: query name: master_timeout description: |- - Period to wait for a connection to the master node. + Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error. deprecated: true schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' style: form x-version-deprecated: '2.0' - x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. - indices.put_alias::query.timeout: + x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. + indices.put_alias___query.timeout: in: query name: timeout description: |- Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' style: form - indices.put_index_template::path.name: + indices.put_index_template___path.name: in: path name: name description: Index or template name required: true schema: - $ref: '#/components/schemas/_common:Name' + $ref: '#/components/schemas/_common___Name' style: simple - indices.put_index_template::query.cause: + indices.put_index_template___query.cause: name: cause in: query description: User defined reason for creating/updating the index template. @@ -20094,14 +20610,14 @@ components: type: string default: 'false' description: User defined reason for creating/updating the index template. - indices.put_index_template::query.cluster_manager_timeout: + indices.put_index_template___query.cluster_manager_timeout: name: cluster_manager_timeout in: query description: Operation timeout for connection to cluster-manager node. schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' x-version-added: '2.0' - indices.put_index_template::query.create: + indices.put_index_template___query.create: in: query name: create description: If `true`, this request cannot replace or update existing index templates. @@ -20109,40 +20625,40 @@ components: type: boolean default: false style: form - indices.put_index_template::query.master_timeout: + indices.put_index_template___query.master_timeout: name: master_timeout in: query - description: Operation timeout for connection to master node. + description: Operation timeout for connection to cluster-manager node. schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' x-version-deprecated: '2.0' - x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. deprecated: true - indices.put_mapping::path.index: + indices.put_mapping___path.index: in: path name: index - description: A comma-separated list of index names the mapping should be added to (supports wildcards); use `_all` or omit to add the mapping on all indices. + description: A comma-separated list of index names the mapping should be added to (supports wildcards); use `_all` or omit to add the mapping on all indexes. required: true schema: - $ref: '#/components/schemas/_common:Indices' + $ref: '#/components/schemas/_common___Indices' style: simple - indices.put_mapping::query.allow_no_indices: + indices.put_mapping___query.allow_no_indices: in: query name: allow_no_indices description: |- - If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. - This behavior applies even if the request targets other open indices. + If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indexes. + This behavior applies even if the request targets other open indexes. schema: type: boolean style: form - indices.put_mapping::query.cluster_manager_timeout: + indices.put_mapping___query.cluster_manager_timeout: name: cluster_manager_timeout in: query description: Operation timeout for connection to cluster-manager node. schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' x-version-added: '2.0' - indices.put_mapping::query.expand_wildcards: + indices.put_mapping___query.expand_wildcards: in: query name: expand_wildcards description: |- @@ -20151,37 +20667,37 @@ components: Supports comma-separated values, such as `open,hidden`. Valid values are: `all`, `open`, `closed`, `hidden`, `none`. schema: - $ref: '#/components/schemas/_common:ExpandWildcards' + $ref: '#/components/schemas/_common___ExpandWildcards' style: form - indices.put_mapping::query.ignore_unavailable: + indices.put_mapping___query.ignore_unavailable: in: query name: ignore_unavailable description: If `false`, the request returns an error if it targets a missing or closed index. schema: type: boolean style: form - indices.put_mapping::query.master_timeout: + indices.put_mapping___query.master_timeout: in: query name: master_timeout description: |- - Period to wait for a connection to the master node. + Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error. deprecated: true schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' style: form x-version-deprecated: '2.0' - x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. - indices.put_mapping::query.timeout: + x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. + indices.put_mapping___query.timeout: in: query name: timeout description: |- Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' style: form - indices.put_mapping::query.write_index_only: + indices.put_mapping___query.write_index_only: in: query name: write_index_only description: If `true`, the mappings are applied only to the current write index for the target. @@ -20189,37 +20705,37 @@ components: type: boolean default: false style: form - indices.put_settings::path.index: + indices.put_settings___path.index: in: path name: index description: |- - Comma-separated list of data streams, indices, and aliases used to limit + Comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams and - indices, omit this parameter or use `*` or `_all`. + indexes, omit this parameter or use `*` or `_all`. required: true schema: - $ref: '#/components/schemas/_common:Indices' + $ref: '#/components/schemas/_common___Indices' style: simple - indices.put_settings::query.allow_no_indices: + indices.put_settings___query.allow_no_indices: in: query name: allow_no_indices description: |- If `false`, the request returns an error if any wildcard expression, index - alias, or `_all` value targets only missing or closed indices. This - behavior applies even if the request targets other open indices. For + alias, or `_all` value targets only missing or closed indexes. This + behavior applies even if the request targets other open indexes. For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. schema: type: boolean style: form - indices.put_settings::query.cluster_manager_timeout: + indices.put_settings___query.cluster_manager_timeout: name: cluster_manager_timeout in: query description: Operation timeout for connection to cluster-manager node. schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' x-version-added: '2.0' - indices.put_settings::query.expand_wildcards: + indices.put_settings___query.expand_wildcards: in: query name: expand_wildcards description: |- @@ -20228,9 +20744,9 @@ components: hidden data streams. Supports comma-separated values, such as `open,hidden`. schema: - $ref: '#/components/schemas/_common:ExpandWildcards' + $ref: '#/components/schemas/_common___ExpandWildcards' style: form - indices.put_settings::query.flat_settings: + indices.put_settings___query.flat_settings: in: query name: flat_settings description: If `true`, returns settings in flat format. @@ -20238,27 +20754,27 @@ components: type: boolean default: false style: form - indices.put_settings::query.ignore_unavailable: + indices.put_settings___query.ignore_unavailable: in: query name: ignore_unavailable - description: Whether specified concrete indices should be ignored when unavailable (missing or closed). + description: Whether specified concrete indexes should be ignored when unavailable (missing or closed). schema: type: boolean style: form - indices.put_settings::query.master_timeout: + indices.put_settings___query.master_timeout: in: query name: master_timeout description: |- - Period to wait for a connection to the master node. If no response is + Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error. deprecated: true schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' style: form x-version-deprecated: '2.0' - x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. - indices.put_settings::query.preserve_existing: + x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. + indices.put_settings___query.preserve_existing: in: query name: preserve_existing description: If `true`, existing index settings remain unchanged. @@ -20266,51 +20782,51 @@ components: type: boolean default: false style: form - indices.put_settings::query.timeout: + indices.put_settings___query.timeout: in: query name: timeout description: |- Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' style: form - indices.put_template::path.name: + indices.put_template___path.name: in: path name: name description: The name of the template required: true schema: - $ref: '#/components/schemas/_common:Name' + $ref: '#/components/schemas/_common___Name' style: simple - indices.put_template::query.cluster_manager_timeout: + indices.put_template___query.cluster_manager_timeout: name: cluster_manager_timeout in: query description: Operation timeout for connection to cluster-manager node. schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' x-version-added: '2.0' - indices.put_template::query.create: + indices.put_template___query.create: in: query name: create - description: If true, this request cannot replace or update existing index templates. + description: If `true`, this request cannot replace or update existing index templates. schema: type: boolean default: false style: form - indices.put_template::query.master_timeout: + indices.put_template___query.master_timeout: in: query name: master_timeout description: |- - Period to wait for a connection to the master node. If no response is + Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error. deprecated: true schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' style: form x-version-deprecated: '2.0' - x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. - indices.put_template::query.order: + x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. + indices.put_template___query.order: in: query name: order description: |- @@ -20322,18 +20838,18 @@ components: schema: type: number style: form - indices.recovery::path.index: + indices.recovery___path.index: in: path name: index description: |- - Comma-separated list of data streams, indices, and aliases used to limit the request. + Comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (`*`). - To target all data streams and indices, omit this parameter or use `*` or `_all`. + To target all data streams and indexes, omit this parameter or use `*` or `_all`. required: true schema: - $ref: '#/components/schemas/_common:Indices' + $ref: '#/components/schemas/_common___Indices' style: simple - indices.recovery::query.active_only: + indices.recovery___query.active_only: in: query name: active_only description: If `true`, the response only includes ongoing shard recoveries. @@ -20341,7 +20857,7 @@ components: type: boolean default: false style: form - indices.recovery::query.detailed: + indices.recovery___query.detailed: in: query name: detailed description: If `true`, the response includes detailed information about shard recoveries. @@ -20349,27 +20865,27 @@ components: type: boolean default: false style: form - indices.refresh::path.index: + indices.refresh___path.index: in: path name: index description: |- - Comma-separated list of data streams, indices, and aliases used to limit the request. + Comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (`*`). - To target all data streams and indices, omit this parameter or use `*` or `_all`. + To target all data streams and indexes, omit this parameter or use `*` or `_all`. required: true schema: - $ref: '#/components/schemas/_common:Indices' + $ref: '#/components/schemas/_common___Indices' style: simple - indices.refresh::query.allow_no_indices: + indices.refresh___query.allow_no_indices: in: query name: allow_no_indices description: |- - If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. - This behavior applies even if the request targets other open indices. + If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indexes. + This behavior applies even if the request targets other open indexes. schema: type: boolean style: form - indices.refresh::query.expand_wildcards: + indices.refresh___query.expand_wildcards: in: query name: expand_wildcards description: |- @@ -20378,26 +20894,26 @@ components: Supports comma-separated values, such as `open,hidden`. Valid values are: `all`, `open`, `closed`, `hidden`, `none`. schema: - $ref: '#/components/schemas/_common:ExpandWildcards' + $ref: '#/components/schemas/_common___ExpandWildcards' style: form - indices.refresh::query.ignore_unavailable: + indices.refresh___query.ignore_unavailable: in: query name: ignore_unavailable description: If `false`, the request returns an error if it targets a missing or closed index. schema: type: boolean style: form - indices.resolve_index::path.name: + indices.resolve_index___path.name: in: path name: name description: |- - Comma-separated name(s) or index pattern(s) of the indices, aliases, and data streams to resolve. + Comma-separated name(s) or index pattern(s) of the indexes, aliases, and data streams to resolve. Resources on remote clusters can be specified using the ``:`` syntax. required: true schema: - $ref: '#/components/schemas/_common:Names' + $ref: '#/components/schemas/_common___Names' style: simple - indices.resolve_index::query.expand_wildcards: + indices.resolve_index___query.expand_wildcards: in: query name: expand_wildcards description: |- @@ -20406,17 +20922,17 @@ components: Supports comma-separated values, such as `open,hidden`. Valid values are: `all`, `open`, `closed`, `hidden`, `none`. schema: - $ref: '#/components/schemas/_common:ExpandWildcards' + $ref: '#/components/schemas/_common___ExpandWildcards' style: form - indices.rollover::path.alias: + indices.rollover___path.alias: in: path name: alias description: Name of the data stream or index alias to roll over. required: true schema: - $ref: '#/components/schemas/_common:IndexAlias' + $ref: '#/components/schemas/_common___IndexAlias' style: simple - indices.rollover::path.new_index: + indices.rollover___path.new_index: in: path name: new_index description: |- @@ -20425,16 +20941,16 @@ components: Data streams do not support this parameter. required: true schema: - $ref: '#/components/schemas/_common:IndexName' + $ref: '#/components/schemas/_common___IndexName' style: simple - indices.rollover::query.cluster_manager_timeout: + indices.rollover___query.cluster_manager_timeout: name: cluster_manager_timeout in: query description: Operation timeout for connection to cluster-manager node. schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' x-version-added: '2.0' - indices.rollover::query.dry_run: + indices.rollover___query.dry_run: in: query name: dry_run description: If `true`, checks whether the current index satisfies the specified conditions but does not perform a rollover. @@ -20442,57 +20958,57 @@ components: type: boolean default: false style: form - indices.rollover::query.master_timeout: + indices.rollover___query.master_timeout: in: query name: master_timeout description: |- - Period to wait for a connection to the master node. + Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error. deprecated: true schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' style: form x-version-deprecated: '2.0' - x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. - indices.rollover::query.timeout: + x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. + indices.rollover___query.timeout: in: query name: timeout description: |- Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' style: form - indices.rollover::query.wait_for_active_shards: + indices.rollover___query.wait_for_active_shards: in: query name: wait_for_active_shards description: |- The number of shard copies that must be active before proceeding with the operation. Set to all or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). schema: - $ref: '#/components/schemas/_common:WaitForActiveShards' + $ref: '#/components/schemas/_common___WaitForActiveShards' style: form - indices.segments::path.index: + indices.segments___path.index: in: path name: index description: |- - Comma-separated list of data streams, indices, and aliases used to limit the request. + Comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (`*`). - To target all data streams and indices, omit this parameter or use `*` or `_all`. + To target all data streams and indexes, omit this parameter or use `*` or `_all`. required: true schema: - $ref: '#/components/schemas/_common:Indices' + $ref: '#/components/schemas/_common___Indices' style: simple - indices.segments::query.allow_no_indices: + indices.segments___query.allow_no_indices: in: query name: allow_no_indices description: |- - If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. - This behavior applies even if the request targets other open indices. + If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indexes. + This behavior applies even if the request targets other open indexes. schema: type: boolean style: form - indices.segments::query.expand_wildcards: + indices.segments___query.expand_wildcards: in: query name: expand_wildcards description: |- @@ -20501,16 +21017,16 @@ components: Supports comma-separated values, such as `open,hidden`. Valid values are: `all`, `open`, `closed`, `hidden`, `none`. schema: - $ref: '#/components/schemas/_common:ExpandWildcards' + $ref: '#/components/schemas/_common___ExpandWildcards' style: form - indices.segments::query.ignore_unavailable: + indices.segments___query.ignore_unavailable: in: query name: ignore_unavailable description: If `false`, the request returns an error if it targets a missing or closed index. schema: type: boolean style: form - indices.segments::query.verbose: + indices.segments___query.verbose: in: query name: verbose description: If `true`, the request returns a verbose response. @@ -20518,75 +21034,75 @@ components: type: boolean default: false style: form - indices.shard_stores::path.index: + indices.shard_stores___path.index: in: path name: index - description: List of data streams, indices, and aliases used to limit the request. + description: List of data streams, indexes, and aliases used to limit the request. required: true schema: - $ref: '#/components/schemas/_common:Indices' + $ref: '#/components/schemas/_common___Indices' style: simple - indices.shard_stores::query.allow_no_indices: + indices.shard_stores___query.allow_no_indices: in: query name: allow_no_indices description: |- - If false, the request returns an error if any wildcard expression, index alias, or _all - value targets only missing or closed indices. This behavior applies even if the request - targets other open indices. + If `false`, the request returns an error if any wildcard expression, index alias, or `_all` + value targets only missing or closed indexes. This behavior applies even if the request + targets other open indexes. schema: type: boolean style: form - indices.shard_stores::query.expand_wildcards: + indices.shard_stores___query.expand_wildcards: in: query name: expand_wildcards description: |- Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. schema: - $ref: '#/components/schemas/_common:ExpandWildcards' + $ref: '#/components/schemas/_common___ExpandWildcards' style: form - indices.shard_stores::query.ignore_unavailable: + indices.shard_stores___query.ignore_unavailable: in: query name: ignore_unavailable - description: If true, missing or closed indices are not included in the response. + description: If `true`, missing or closed indexes are not included in the response. schema: type: boolean style: form - indices.shard_stores::query.status: + indices.shard_stores___query.status: in: query name: status description: List of shard health statuses used to limit the request. schema: oneOf: - - $ref: '#/components/schemas/indices.shard_stores:Status' + - $ref: '#/components/schemas/indices.shard_stores___Status' - type: array items: - $ref: '#/components/schemas/indices.shard_stores:Status' + $ref: '#/components/schemas/indices.shard_stores___Status' style: form - indices.shrink::path.index: + indices.shrink___path.index: in: path name: index description: Name of the source index to shrink. required: true schema: - $ref: '#/components/schemas/_common:IndexName' + $ref: '#/components/schemas/_common___IndexName' style: simple - indices.shrink::path.target: + indices.shrink___path.target: in: path name: target description: Name of the target index to create. required: true schema: - $ref: '#/components/schemas/_common:IndexName' + $ref: '#/components/schemas/_common___IndexName' style: simple - indices.shrink::query.cluster_manager_timeout: + indices.shrink___query.cluster_manager_timeout: name: cluster_manager_timeout in: query description: Operation timeout for connection to cluster-manager node. schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' x-version-added: '2.0' - indices.shrink::query.copy_settings: + indices.shrink___query.copy_settings: name: copy_settings in: query description: whether or not to copy settings from the source index. @@ -20594,43 +21110,43 @@ components: type: boolean default: false description: whether or not to copy settings from the source index. - indices.shrink::query.master_timeout: + indices.shrink___query.master_timeout: in: query name: master_timeout description: |- - Period to wait for a connection to the master node. + Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error. deprecated: true schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' style: form x-version-deprecated: '2.0' - x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. - indices.shrink::query.task_execution_timeout: + x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. + indices.shrink___query.task_execution_timeout: name: task_execution_timeout in: query - description: Explicit task execution timeout, only useful when wait_for_completion is false, defaults to 1h. + description: Explicit task execution timeout, only useful when `wait_for_completion` is false, defaults to `1h`. schema: - $ref: '#/components/schemas/_common:Duration' - indices.shrink::query.timeout: + $ref: '#/components/schemas/_common___Duration' + indices.shrink___query.timeout: in: query name: timeout description: |- Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' style: form - indices.shrink::query.wait_for_active_shards: + indices.shrink___query.wait_for_active_shards: in: query name: wait_for_active_shards description: |- The number of shard copies that must be active before proceeding with the operation. Set to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). schema: - $ref: '#/components/schemas/_common:WaitForActiveShards' + $ref: '#/components/schemas/_common___WaitForActiveShards' style: form - indices.shrink::query.wait_for_completion: + indices.shrink___query.wait_for_completion: x-version-added: '2.7' name: wait_for_completion in: query @@ -20639,15 +21155,15 @@ components: type: boolean default: true description: Should this request wait until the operation has completed before returning. - indices.simulate_index_template::path.name: + indices.simulate_index_template___path.name: in: path name: name description: Index or template name to simulate required: true schema: - $ref: '#/components/schemas/_common:Name' + $ref: '#/components/schemas/_common___Name' style: simple - indices.simulate_index_template::query.cause: + indices.simulate_index_template___query.cause: name: cause in: query description: User defined reason for dry-run creating the new template for simulation purposes. @@ -20655,14 +21171,14 @@ components: type: string default: 'false' description: User defined reason for dry-run creating the new template for simulation purposes. - indices.simulate_index_template::query.cluster_manager_timeout: + indices.simulate_index_template___query.cluster_manager_timeout: name: cluster_manager_timeout in: query description: Operation timeout for connection to cluster-manager node. schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' x-version-added: '2.0' - indices.simulate_index_template::query.create: + indices.simulate_index_template___query.create: in: query name: create description: |- @@ -20675,19 +21191,19 @@ components: type: boolean default: false style: form - indices.simulate_index_template::query.master_timeout: + indices.simulate_index_template___query.master_timeout: in: query name: master_timeout description: |- - Period to wait for a connection to the master node. If no response is received + Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error. deprecated: true schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' style: form x-version-deprecated: '2.0' - x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. - indices.simulate_template::path.name: + x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. + indices.simulate_template___path.name: in: path name: name description: |- @@ -20695,9 +21211,9 @@ components: this parameter and specify the template configuration in the request body. required: true schema: - $ref: '#/components/schemas/_common:Name' + $ref: '#/components/schemas/_common___Name' style: simple - indices.simulate_template::query.cause: + indices.simulate_template___query.cause: name: cause in: query description: User defined reason for dry-run creating the new template for simulation purposes. @@ -20705,55 +21221,55 @@ components: type: string default: 'false' description: User defined reason for dry-run creating the new template for simulation purposes. - indices.simulate_template::query.cluster_manager_timeout: + indices.simulate_template___query.cluster_manager_timeout: name: cluster_manager_timeout in: query description: Operation timeout for connection to cluster-manager node. schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' x-version-added: '2.0' - indices.simulate_template::query.create: + indices.simulate_template___query.create: in: query name: create - description: If true, the template passed in the body is only used if no existing templates match the same index patterns. If false, the simulation uses the template with the highest priority. Note that the template is not permanently added or updated in either case; it is only used for the simulation. + description: If `true`, the template passed in the body is only used if no existing templates match the same index patterns. If `false`, the simulation uses the template with the highest priority. Note that the template is not permanently added or updated in either case; it is only used for the simulation. schema: type: boolean default: false style: form - indices.simulate_template::query.master_timeout: + indices.simulate_template___query.master_timeout: in: query name: master_timeout - description: Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + description: Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error. deprecated: true schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' style: form x-version-deprecated: '2.0' - x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. - indices.split::path.index: + x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. + indices.split___path.index: in: path name: index description: Name of the source index to split. required: true schema: - $ref: '#/components/schemas/_common:IndexName' + $ref: '#/components/schemas/_common___IndexName' style: simple - indices.split::path.target: + indices.split___path.target: in: path name: target description: Name of the target index to create. required: true schema: - $ref: '#/components/schemas/_common:IndexName' + $ref: '#/components/schemas/_common___IndexName' style: simple - indices.split::query.cluster_manager_timeout: + indices.split___query.cluster_manager_timeout: name: cluster_manager_timeout in: query description: Operation timeout for connection to cluster-manager node. schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' x-version-added: '2.0' - indices.split::query.copy_settings: + indices.split___query.copy_settings: name: copy_settings in: query description: whether or not to copy settings from the source index. @@ -20761,43 +21277,43 @@ components: type: boolean default: false description: whether or not to copy settings from the source index. - indices.split::query.master_timeout: + indices.split___query.master_timeout: in: query name: master_timeout description: |- - Period to wait for a connection to the master node. + Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error. deprecated: true schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' style: form x-version-deprecated: '2.0' - x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. - indices.split::query.task_execution_timeout: + x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. + indices.split___query.task_execution_timeout: name: task_execution_timeout in: query - description: Explicit task execution timeout, only useful when wait_for_completion is false, defaults to 1h. + description: Explicit task execution timeout, only useful when `wait_for_completion` is false, defaults to `1h`. schema: - $ref: '#/components/schemas/_common:Duration' - indices.split::query.timeout: + $ref: '#/components/schemas/_common___Duration' + indices.split___query.timeout: in: query name: timeout description: |- Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' style: form - indices.split::query.wait_for_active_shards: + indices.split___query.wait_for_active_shards: in: query name: wait_for_active_shards description: |- The number of shard copies that must be active before proceeding with the operation. Set to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). schema: - $ref: '#/components/schemas/_common:WaitForActiveShards' + $ref: '#/components/schemas/_common___WaitForActiveShards' style: form - indices.split::query.wait_for_completion: + indices.split___query.wait_for_completion: x-version-added: '2.7' name: wait_for_completion in: query @@ -20806,34 +21322,34 @@ components: type: boolean default: true description: Should this request wait until the operation has completed before returning. - indices.stats::path.index: + indices.stats___path.index: in: path name: index - description: A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices + description: A comma-separated list of index names; use `_all` or empty string to perform the operation on all indexes required: true schema: - $ref: '#/components/schemas/_common:Indices' + $ref: '#/components/schemas/_common___Indices' style: simple - indices.stats::path.metric: + indices.stats___path.metric: in: path name: metric description: Limit the information returned the specific metrics. required: true schema: oneOf: - - $ref: '#/components/schemas/indices.stats:Metric' + - $ref: '#/components/schemas/indices.stats___Metric' - type: array items: - $ref: '#/components/schemas/indices.stats:Metric' + $ref: '#/components/schemas/indices.stats___Metric' style: simple - indices.stats::query.completion_fields: + indices.stats___query.completion_fields: in: query name: completion_fields - description: Comma-separated list or wildcard expressions of fields to include in fielddata and suggest statistics. + description: Comma-separated list or wildcard expressions of fields to include in field data and suggest statistics. schema: - $ref: '#/components/schemas/_common:Fields' + $ref: '#/components/schemas/_common___Fields' style: form - indices.stats::query.expand_wildcards: + indices.stats___query.expand_wildcards: in: query name: expand_wildcards description: |- @@ -20841,31 +21357,31 @@ components: determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`. schema: - $ref: '#/components/schemas/_common:ExpandWildcards' + $ref: '#/components/schemas/_common___ExpandWildcards' style: form - indices.stats::query.fielddata_fields: + indices.stats___query.fielddata_fields: in: query name: fielddata_fields - description: Comma-separated list or wildcard expressions of fields to include in fielddata statistics. + description: Comma-separated list or wildcard expressions of fields to include in field data statistics. schema: - $ref: '#/components/schemas/_common:Fields' + $ref: '#/components/schemas/_common___Fields' style: form - indices.stats::query.fields: + indices.stats___query.fields: in: query name: fields description: Comma-separated list or wildcard expressions of fields to include in the statistics. schema: - $ref: '#/components/schemas/_common:Fields' + $ref: '#/components/schemas/_common___Fields' style: form - indices.stats::query.forbid_closed_indices: + indices.stats___query.forbid_closed_indices: in: query name: forbid_closed_indices - description: If true, statistics are not collected from closed indices. + description: If `true`, statistics are not collected from closed indexes. schema: type: boolean default: true style: form - indices.stats::query.groups: + indices.stats___query.groups: in: query name: groups description: Comma-separated list of search groups to include in the search statistics. @@ -20876,95 +21392,95 @@ components: items: type: string style: form - indices.stats::query.include_segment_file_sizes: + indices.stats___query.include_segment_file_sizes: in: query name: include_segment_file_sizes - description: If true, the call reports the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested). + description: If `true`, the call reports the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested). schema: type: boolean default: false style: form - indices.stats::query.include_unloaded_segments: + indices.stats___query.include_unloaded_segments: in: query name: include_unloaded_segments - description: If true, the response includes information from segments that are not loaded into memory. + description: If `true`, the response includes information from segments that are not loaded into memory. schema: type: boolean default: false style: form - indices.stats::query.level: + indices.stats___query.level: in: query name: level description: Indicates whether statistics are aggregated at the cluster, index, or shard level. schema: - $ref: '#/components/schemas/_common:Level' + $ref: '#/components/schemas/_common___Level' style: form - indices.update_aliases::query.cluster_manager_timeout: + indices.update_aliases___query.cluster_manager_timeout: name: cluster_manager_timeout in: query description: Operation timeout for connection to cluster-manager node. schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' x-version-added: '2.0' - indices.update_aliases::query.master_timeout: + indices.update_aliases___query.master_timeout: in: query name: master_timeout description: |- - Period to wait for a connection to the master node. + Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error. deprecated: true schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' style: form x-version-deprecated: '2.0' - x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. - indices.update_aliases::query.timeout: + x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. + indices.update_aliases___query.timeout: in: query name: timeout description: |- Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' style: form - indices.upgrade::path.index: + indices.upgrade___path.index: name: index in: path - description: Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices. + description: Comma-separated list of indexes; use `_all` or empty string to perform the operation on all indexes. schema: type: array - description: Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices. + description: Comma-separated list of indexes; use `_all` or empty string to perform the operation on all indexes. items: type: string required: true - indices.upgrade::query.allow_no_indices: + indices.upgrade___query.allow_no_indices: name: allow_no_indices in: query - description: Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified). + description: Whether to ignore if a wildcard indexes expression resolves into no concrete indexes. (This includes `_all` string or when no indexes have been specified). schema: type: boolean - description: Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified). - indices.upgrade::query.expand_wildcards: + description: Whether to ignore if a wildcard indexes expression resolves into no concrete indexes. (This includes `_all` string or when no indexes have been specified). + indices.upgrade___query.expand_wildcards: name: expand_wildcards in: query - description: Whether to expand wildcard expression to concrete indices that are open, closed or both. + description: Whether to expand wildcard expression to concrete indexes that are open, closed or both. schema: - $ref: '#/components/schemas/_common:ExpandWildcards' - indices.upgrade::query.ignore_unavailable: + $ref: '#/components/schemas/_common___ExpandWildcards' + indices.upgrade___query.ignore_unavailable: name: ignore_unavailable in: query - description: Whether specified concrete indices should be ignored when unavailable (missing or closed). + description: Whether specified concrete indexes should be ignored when unavailable (missing or closed). schema: type: boolean - description: Whether specified concrete indices should be ignored when unavailable (missing or closed). - indices.upgrade::query.only_ancient_segments: + description: Whether specified concrete indexes should be ignored when unavailable (missing or closed). + indices.upgrade___query.only_ancient_segments: name: only_ancient_segments in: query - description: If true, only ancient (an older Lucene major release) segments will be upgraded. + description: If `true`, only ancient (an older Lucene major release) segments will be upgraded. schema: type: boolean - description: If true, only ancient (an older Lucene major release) segments will be upgraded. - indices.upgrade::query.wait_for_completion: + description: If `true`, only ancient (an older Lucene major release) segments will be upgraded. + indices.upgrade___query.wait_for_completion: x-version-added: '2.7' name: wait_for_completion in: query @@ -20973,34 +21489,34 @@ components: type: boolean default: false description: Should this request wait until the operation has completed before returning. - indices.validate_query::path.index: + indices.validate_query___path.index: in: path name: index description: |- - Comma-separated list of data streams, indices, and aliases to search. + Comma-separated list of data streams, indexes, and aliases to search. Supports wildcards (`*`). - To search all data streams or indices, omit this parameter or use `*` or `_all`. + To search all data streams or indexes, omit this parameter or use `*` or `_all`. required: true schema: - $ref: '#/components/schemas/_common:Indices' + $ref: '#/components/schemas/_common___Indices' style: simple - indices.validate_query::query.all_shards: + indices.validate_query___query.all_shards: in: query name: all_shards description: If `true`, the validation is executed on all shards instead of one random shard per index. schema: type: boolean style: form - indices.validate_query::query.allow_no_indices: + indices.validate_query___query.allow_no_indices: in: query name: allow_no_indices description: |- - If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. - This behavior applies even if the request targets other open indices. + If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indexes. + This behavior applies even if the request targets other open indexes. schema: type: boolean style: form - indices.validate_query::query.analyze_wildcard: + indices.validate_query___query.analyze_wildcard: in: query name: analyze_wildcard description: If `true`, wildcard and prefix queries are analyzed. @@ -21008,7 +21524,7 @@ components: type: boolean default: false style: form - indices.validate_query::query.analyzer: + indices.validate_query___query.analyzer: in: query name: analyzer description: |- @@ -21017,14 +21533,14 @@ components: schema: type: string style: form - indices.validate_query::query.default_operator: + indices.validate_query___query.default_operator: in: query name: default_operator description: 'The default operator for query string query: `AND` or `OR`.' schema: - $ref: '#/components/schemas/_common.query_dsl:Operator' + $ref: '#/components/schemas/_common.query_dsl___Operator' style: form - indices.validate_query::query.df: + indices.validate_query___query.df: in: query name: df description: |- @@ -21033,7 +21549,7 @@ components: schema: type: string style: form - indices.validate_query::query.expand_wildcards: + indices.validate_query___query.expand_wildcards: in: query name: expand_wildcards description: |- @@ -21042,44 +21558,44 @@ components: Supports comma-separated values, such as `open,hidden`. Valid values are: `all`, `open`, `closed`, `hidden`, `none`. schema: - $ref: '#/components/schemas/_common:ExpandWildcards' + $ref: '#/components/schemas/_common___ExpandWildcards' style: form - indices.validate_query::query.explain: + indices.validate_query___query.explain: in: query name: explain description: If `true`, the response returns detailed information if an error has occurred. schema: type: boolean style: form - indices.validate_query::query.ignore_unavailable: + indices.validate_query___query.ignore_unavailable: in: query name: ignore_unavailable description: If `false`, the request returns an error if it targets a missing or closed index. schema: type: boolean style: form - indices.validate_query::query.lenient: + indices.validate_query___query.lenient: in: query name: lenient description: If `true`, format-based query failures (such as providing text to a numeric field) in the query string will be ignored. schema: type: boolean style: form - indices.validate_query::query.q: + indices.validate_query___query.q: in: query name: q description: Query in the Lucene query string syntax. schema: type: string style: form - indices.validate_query::query.rewrite: + indices.validate_query___query.rewrite: in: query name: rewrite description: If `true`, returns a more detailed explanation showing the actual Lucene query that will be executed. schema: type: boolean style: form - ingest.delete_pipeline::path.id: + ingest.delete_pipeline___path.id: in: path name: id description: |- @@ -21087,37 +21603,37 @@ components: To delete all ingest pipelines in a cluster, use a value of `*`. required: true schema: - $ref: '#/components/schemas/_common:Id' + $ref: '#/components/schemas/_common___Id' style: simple - ingest.delete_pipeline::query.cluster_manager_timeout: + ingest.delete_pipeline___query.cluster_manager_timeout: name: cluster_manager_timeout in: query description: Operation timeout for connection to cluster-manager node. schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' x-version-added: '2.0' - ingest.delete_pipeline::query.master_timeout: + ingest.delete_pipeline___query.master_timeout: in: query name: master_timeout description: |- - Period to wait for a connection to the master node. + Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error. deprecated: true schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' style: form x-version-deprecated: '2.0' - x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. - ingest.delete_pipeline::query.timeout: + x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. + ingest.delete_pipeline___query.timeout: in: query name: timeout description: |- Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' style: form - ingest.get_pipeline::path.id: + ingest.get_pipeline___path.id: in: path name: id description: |- @@ -21126,60 +21642,67 @@ components: To get all ingest pipelines, omit this parameter or use `*`. required: true schema: - $ref: '#/components/schemas/_common:Id' + $ref: '#/components/schemas/_common___Id' style: simple - ingest.get_pipeline::query.cluster_manager_timeout: + ingest.get_pipeline___query.cluster_manager_timeout: name: cluster_manager_timeout in: query description: Operation timeout for connection to cluster-manager node. schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' x-version-added: '2.0' - ingest.get_pipeline::query.master_timeout: + ingest.get_pipeline___query.master_timeout: in: query name: master_timeout description: |- - Period to wait for a connection to the master node. + Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error. deprecated: true schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' style: form x-version-deprecated: '2.0' - x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. - ingest.put_pipeline::path.id: + x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. + ingest.processor_grok___query.s: + name: s + in: query + description: Sort returned patterns by key name. + schema: + type: boolean + default: false + ingest.put_pipeline___path.id: in: path name: id description: ID of the ingest pipeline to create or update. required: true schema: - $ref: '#/components/schemas/_common:Id' + $ref: '#/components/schemas/_common___Id' style: simple - ingest.put_pipeline::query.cluster_manager_timeout: + ingest.put_pipeline___query.cluster_manager_timeout: name: cluster_manager_timeout in: query description: Operation timeout for connection to cluster-manager node. schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' x-version-added: '2.0' - ingest.put_pipeline::query.master_timeout: + ingest.put_pipeline___query.master_timeout: in: query name: master_timeout - description: Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + description: Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error. deprecated: true schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' style: form x-version-deprecated: '2.0' - x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. - ingest.put_pipeline::query.timeout: + x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. + ingest.put_pipeline___query.timeout: in: query name: timeout description: Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' style: form - ingest.simulate::path.id: + ingest.simulate___path.id: in: path name: id description: |- @@ -21187,9 +21710,9 @@ components: If you don't specify a `pipeline` in the request body, this parameter is required. required: true schema: - $ref: '#/components/schemas/_common:Id' + $ref: '#/components/schemas/_common___Id' style: simple - ingest.simulate::query.verbose: + ingest.simulate___query.verbose: in: query name: verbose description: If `true`, the response includes output data for each processor in the executed pipeline. @@ -21197,162 +21720,173 @@ components: type: boolean default: false style: form - ism.add_policy::path.index: + insights.top_queries___query.type: + name: type + in: query + required: true + description: Get top n queries by a specific metric. + schema: + type: string + enum: + - cpu + - latency + - memory + ism.add_policy___path.index: name: index in: path description: |- - Comma-separated list of data streams, indices, and aliases. + Comma-separated list of data streams, indexes, and aliases. Supports wildcards (`*`). required: true schema: - $ref: '#/components/schemas/_common:IndexName' + $ref: '#/components/schemas/_common___IndexName' style: simple - ism.add_policy::query.index: + ism.add_policy___query.index: name: index in: query description: |- - Comma-separated list of data streams, indices, and aliases. + Comma-separated list of data streams, indexes, and aliases. Supports wildcards (`*`). required: true schema: - $ref: '#/components/schemas/_common:IndexName' - ism.change_policy::path.index: + $ref: '#/components/schemas/_common___IndexName' + ism.change_policy___path.index: name: index in: path description: |- - Comma-separated list of data streams, indices, and aliases. + Comma-separated list of data streams, indexes, and aliases. Supports wildcards (`*`). required: true schema: - $ref: '#/components/schemas/_common:IndexName' + $ref: '#/components/schemas/_common___IndexName' style: simple - ism.change_policy::query.index: + ism.change_policy___query.index: name: index in: query description: |- - Comma-separated list of data streams, indices, and aliases. + Comma-separated list of data streams, indexes, and aliases. Supports wildcards (`*`). required: true schema: - $ref: '#/components/schemas/_common:IndexName' - ism.delete_policy::path.policy_id: + $ref: '#/components/schemas/_common___IndexName' + ism.delete_policy___path.policy_id: name: policy_id in: path required: true schema: type: string - ism.exists_policy::path.policy_id: + ism.exists_policy___path.policy_id: name: policy_id in: path required: true schema: type: string - ism.explain_policy::path.index: + ism.explain_policy___path.index: name: index in: path description: |- - Comma-separated list of data streams, indices, and aliases. + Comma-separated list of data streams, indexes, and aliases. Supports wildcards (`*`). required: true schema: - $ref: '#/components/schemas/_common:IndexName' + $ref: '#/components/schemas/_common___IndexName' style: simple - ism.get_policy::path.policy_id: + ism.get_policy___path.policy_id: name: policy_id in: path required: true schema: type: string - ism.put_policies::query.if_primary_term: + ism.put_policies___query.if_primary_term: name: if_primary_term in: query description: Only perform the operation if the document has this primary term. schema: type: number style: form - ism.put_policies::query.if_seq_no: + ism.put_policies___query.if_seq_no: name: if_seq_no in: query description: Only perform the operation if the document has this sequence number. schema: - $ref: '#/components/schemas/_common:SequenceNumber' + $ref: '#/components/schemas/_common___SequenceNumber' style: form - ism.put_policies::query.policyID: + ism.put_policies___query.policyID: name: policyID in: query required: true schema: type: string style: form - ism.put_policy::path.policy_id: + ism.put_policy___path.policy_id: name: policy_id in: path required: true schema: type: string - ism.put_policy::query.if_primary_term: + ism.put_policy___query.if_primary_term: name: if_primary_term in: query description: Only perform the operation if the document has this primary term. schema: type: number style: form - ism.put_policy::query.if_seq_no: + ism.put_policy___query.if_seq_no: name: if_seq_no in: query description: Only perform the operation if the document has this sequence number. schema: - $ref: '#/components/schemas/_common:SequenceNumber' + $ref: '#/components/schemas/_common___SequenceNumber' style: form - ism.refresh_search_analyzers::path.index: + ism.refresh_search_analyzers___path.index: name: index in: path description: |- - Comma-separated list of data streams, indices, and aliases. + Comma-separated list of data streams, indexes, and aliases. Supports wildcards (`*`). required: true schema: - $ref: '#/components/schemas/_common:IndexName' + $ref: '#/components/schemas/_common___IndexName' style: simple - ism.remove_policy::path.index: + ism.remove_policy___path.index: name: index in: path description: |- - Comma-separated list of data streams, indices, and aliases. + Comma-separated list of data streams, indexes, and aliases. Supports wildcards (`*`). required: true schema: - $ref: '#/components/schemas/_common:IndexName' + $ref: '#/components/schemas/_common___IndexName' style: simple - ism.remove_policy::query.index: + ism.remove_policy___query.index: name: index in: query description: |- - Comma-separated list of data streams, indices, and aliases. + Comma-separated list of data streams, indexes, and aliases. Supports wildcards (`*`). required: true schema: - $ref: '#/components/schemas/_common:IndexName' - ism.retry_index::path.index: + $ref: '#/components/schemas/_common___IndexName' + ism.retry_index___path.index: name: index in: path description: |- - Comma-separated list of data streams, indices, and aliases. + Comma-separated list of data streams, indexes, and aliases. Supports wildcards (`*`). required: true schema: - $ref: '#/components/schemas/_common:IndexName' + $ref: '#/components/schemas/_common___IndexName' style: simple - ism.retry_index::query.index: + ism.retry_index___query.index: name: index in: query description: |- - Comma-separated list of data streams, indices, and aliases. + Comma-separated list of data streams, indexes, and aliases. Supports wildcards (`*`). required: true schema: - $ref: '#/components/schemas/_common:IndexName' - knn.delete_model::path.model_id: + $ref: '#/components/schemas/_common___IndexName' + knn.delete_model___path.model_id: name: model_id in: path description: The id of the model. @@ -21360,7 +21894,7 @@ components: type: string description: The id of the model. required: true - knn.get_model::path.model_id: + knn.get_model___path.model_id: name: model_id in: path description: The id of the model. @@ -21368,47 +21902,47 @@ components: type: string description: The id of the model. required: true - knn.search_models::query._source: + knn.search_models___query._source: name: _source in: query - description: True or false to return the _source field or not, or a list of fields to return. + description: Set to `true` or `false` to return the `_source` field or not, or a list of fields to return. style: form schema: type: array items: type: string - description: True or false to return the _source field or not, or a list of fields to return. + description: Set to `true` or `false` to return the `_source` field or not, or a list of fields to return. explode: true - knn.search_models::query._source_excludes: + knn.search_models___query._source_excludes: name: _source_excludes in: query - description: List of fields to exclude from the returned _source field. + description: List of fields to exclude from the returned `_source` field. style: form schema: type: array items: type: string - description: List of fields to exclude from the returned _source field. + description: List of fields to exclude from the returned `_source` field. explode: true - knn.search_models::query._source_includes: + knn.search_models___query._source_includes: name: _source_includes in: query - description: List of fields to extract and return from the _source field. + description: List of fields to extract and return from the `_source` field. style: form schema: type: array items: type: string - description: List of fields to extract and return from the _source field. + description: List of fields to extract and return from the `_source` field. explode: true - knn.search_models::query.allow_no_indices: + knn.search_models___query.allow_no_indices: name: allow_no_indices in: query - description: Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified). + description: Whether to ignore if a wildcard indexes expression resolves into no concrete indexes. (This includes `_all` string or when no indexes have been specified). schema: type: boolean - description: Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified). - knn.search_models::query.allow_partial_search_results: + description: Whether to ignore if a wildcard indexes expression resolves into no concrete indexes. (This includes `_all` string or when no indexes have been specified). + knn.search_models___query.allow_partial_search_results: name: allow_partial_search_results in: query description: Indicate if an error should be returned if there is a partial search failure or timeout. @@ -21416,7 +21950,7 @@ components: type: boolean default: true description: Indicate if an error should be returned if there is a partial search failure or timeout. - knn.search_models::query.analyze_wildcard: + knn.search_models___query.analyze_wildcard: name: analyze_wildcard in: query description: Specify whether wildcard and prefix queries should be analyzed. @@ -21424,14 +21958,14 @@ components: type: boolean default: false description: Specify whether wildcard and prefix queries should be analyzed. - knn.search_models::query.analyzer: + knn.search_models___query.analyzer: name: analyzer in: query description: The analyzer to use for the query string. schema: type: string description: The analyzer to use for the query string. - knn.search_models::query.batched_reduce_size: + knn.search_models___query.batched_reduce_size: name: batched_reduce_size in: query description: The number of shard results that should be reduced at once on the coordinating node. This value should be used as a protection mechanism to reduce the memory overhead per search request if the potential number of shards in the request can be large. @@ -21440,7 +21974,7 @@ components: default: 512 description: The number of shard results that should be reduced at once on the coordinating node. This value should be used as a protection mechanism to reduce the memory overhead per search request if the potential number of shards in the request can be large. format: int32 - knn.search_models::query.ccs_minimize_roundtrips: + knn.search_models___query.ccs_minimize_roundtrips: name: ccs_minimize_roundtrips in: query description: Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution. @@ -21448,20 +21982,20 @@ components: type: boolean default: true description: Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution. - knn.search_models::query.default_operator: + knn.search_models___query.default_operator: name: default_operator in: query description: The default operator for query string query (AND or OR). schema: - $ref: '#/components/schemas/knn._common:DefaultOperator' - knn.search_models::query.df: + $ref: '#/components/schemas/knn._common___DefaultOperator' + knn.search_models___query.df: name: df in: query description: The field to use as default where no field prefix is given in the query string. schema: type: string description: The field to use as default where no field prefix is given in the query string. - knn.search_models::query.docvalue_fields: + knn.search_models___query.docvalue_fields: name: docvalue_fields in: query description: Comma-separated list of fields to return as the docvalue representation of a field for each hit. @@ -21472,20 +22006,20 @@ components: type: string description: Comma-separated list of fields to return as the docvalue representation of a field for each hit. explode: true - knn.search_models::query.expand_wildcards: + knn.search_models___query.expand_wildcards: name: expand_wildcards in: query - description: Whether to expand wildcard expression to concrete indices that are open, closed or both. + description: Whether to expand wildcard expression to concrete indexes that are open, closed or both. schema: - $ref: '#/components/schemas/_common:ExpandWildcards' - knn.search_models::query.explain: + $ref: '#/components/schemas/_common___ExpandWildcards' + knn.search_models___query.explain: name: explain in: query description: Specify whether to return detailed information about score computation as part of a hit. schema: type: boolean description: Specify whether to return detailed information about score computation as part of a hit. - knn.search_models::query.from: + knn.search_models___query.from: name: from in: query description: Starting offset. @@ -21494,28 +22028,28 @@ components: default: 0 description: Starting offset. format: int32 - knn.search_models::query.ignore_throttled: + knn.search_models___query.ignore_throttled: name: ignore_throttled in: query - description: Whether specified concrete, expanded or aliased indices should be ignored when throttled. + description: Whether specified concrete, expanded or aliased indexes should be ignored when throttled. schema: type: boolean - description: Whether specified concrete, expanded or aliased indices should be ignored when throttled. - knn.search_models::query.ignore_unavailable: + description: Whether specified concrete, expanded or aliased indexes should be ignored when throttled. + knn.search_models___query.ignore_unavailable: name: ignore_unavailable in: query - description: Whether specified concrete indices should be ignored when unavailable (missing or closed). + description: Whether specified concrete indexes should be ignored when unavailable (missing or closed). schema: type: boolean - description: Whether specified concrete indices should be ignored when unavailable (missing or closed). - knn.search_models::query.lenient: + description: Whether specified concrete indexes should be ignored when unavailable (missing or closed). + knn.search_models___query.lenient: name: lenient in: query description: Specify whether format-based query failures (such as providing text to a numeric field) should be ignored. schema: type: boolean description: Specify whether format-based query failures (such as providing text to a numeric field) should be ignored. - knn.search_models::query.max_concurrent_shard_requests: + knn.search_models___query.max_concurrent_shard_requests: name: max_concurrent_shard_requests in: query description: The number of concurrent shard requests per node this search executes concurrently. This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests. @@ -21524,15 +22058,15 @@ components: default: 5 description: The number of concurrent shard requests per node this search executes concurrently. This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests. format: int32 - knn.search_models::query.pre_filter_shard_size: + knn.search_models___query.pre_filter_shard_size: name: pre_filter_shard_size in: query - description: Threshold that enforces a pre-filter round-trip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter round-trip can limit the number of shards significantly if for instance a shard can not match any documents based on its rewrite method ie. if date filters are mandatory to match but the shard bounds and the query are disjoint. + description: Threshold that enforces a pre-filter round-trip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter round-trip can limit the number of shards significantly if for instance a shard can not match any documents based on its rewrite method, that is if date filters are mandatory to match but the shard bounds and the query are disjoint. schema: type: integer - description: Threshold that enforces a pre-filter round-trip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter round-trip can limit the number of shards significantly if for instance a shard can not match any documents based on its rewrite method ie. if date filters are mandatory to match but the shard bounds and the query are disjoint. + description: Threshold that enforces a pre-filter round-trip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter round-trip can limit the number of shards significantly if for instance a shard can not match any documents based on its rewrite method, that is if date filters are mandatory to match but the shard bounds and the query are disjoint. format: int32 - knn.search_models::query.preference: + knn.search_models___query.preference: name: preference in: query description: Specify the node or shard the operation should be performed on. @@ -21540,56 +22074,56 @@ components: type: string default: random description: Specify the node or shard the operation should be performed on. - knn.search_models::query.q: + knn.search_models___query.q: name: q in: query description: Query in the Lucene query string syntax. schema: type: string description: Query in the Lucene query string syntax. - knn.search_models::query.request_cache: + knn.search_models___query.request_cache: name: request_cache in: query description: Specify if request cache should be used for this request or not, defaults to index level setting. schema: type: boolean description: Specify if request cache should be used for this request or not, defaults to index level setting. - knn.search_models::query.rest_total_hits_as_int: + knn.search_models___query.rest_total_hits_as_int: name: rest_total_hits_as_int in: query - description: Indicates whether hits.total should be rendered as an integer or an object in the rest search response. + description: Indicates whether `hits.total` should be rendered as an integer or an object in the rest search response. schema: type: boolean default: false - description: Indicates whether hits.total should be rendered as an integer or an object in the rest search response. - knn.search_models::query.routing: + description: Indicates whether `hits.total` should be rendered as an integer or an object in the rest search response. + knn.search_models___query.routing: name: routing in: query description: Comma-separated list of specific routing values. style: form schema: - $ref: '#/components/schemas/_common:RoutingInQueryString' + $ref: '#/components/schemas/_common___RoutingInQueryString' explode: true - knn.search_models::query.scroll: + knn.search_models___query.scroll: name: scroll in: query description: Specify how long a consistent view of the index should be maintained for scrolled search. schema: - $ref: '#/components/schemas/_common:Duration' - knn.search_models::query.search_type: + $ref: '#/components/schemas/_common___Duration' + knn.search_models___query.search_type: name: search_type in: query description: Search operation type. schema: - $ref: '#/components/schemas/knn._common:SearchType' - knn.search_models::query.seq_no_primary_term: + $ref: '#/components/schemas/knn._common___SearchType' + knn.search_models___query.seq_no_primary_term: name: seq_no_primary_term in: query description: Specify whether to return sequence number and primary term of the last modification of each hit. schema: type: boolean description: Specify whether to return sequence number and primary term of the last modification of each hit. - knn.search_models::query.size: + knn.search_models___query.size: name: size in: query description: Number of hits to return. @@ -21598,7 +22132,7 @@ components: default: 10 description: Number of hits to return. format: int32 - knn.search_models::query.sort: + knn.search_models___query.sort: name: sort in: query description: Comma-separated list of : pairs. @@ -21609,7 +22143,7 @@ components: type: string description: Comma-separated list of : pairs. explode: true - knn.search_models::query.stats: + knn.search_models___query.stats: name: stats in: query description: Specific 'tag' of the request for logging and statistical purposes. @@ -21620,7 +22154,7 @@ components: type: string description: Specific 'tag' of the request for logging and statistical purposes. explode: true - knn.search_models::query.stored_fields: + knn.search_models___query.stored_fields: name: stored_fields in: query description: Comma-separated list of stored fields to return. @@ -21631,20 +22165,20 @@ components: type: string description: Comma-separated list of stored fields to return. explode: true - knn.search_models::query.suggest_field: + knn.search_models___query.suggest_field: name: suggest_field in: query description: Specify which field to use for suggestions. schema: type: string description: Specify which field to use for suggestions. - knn.search_models::query.suggest_mode: + knn.search_models___query.suggest_mode: name: suggest_mode in: query description: Specify suggest mode. schema: - $ref: '#/components/schemas/knn._common:SuggestMode' - knn.search_models::query.suggest_size: + $ref: '#/components/schemas/knn._common___SuggestMode' + knn.search_models___query.suggest_size: name: suggest_size in: query description: How many suggestions to return in response. @@ -21652,14 +22186,14 @@ components: type: integer description: How many suggestions to return in response. format: int32 - knn.search_models::query.suggest_text: + knn.search_models___query.suggest_text: name: suggest_text in: query description: The source text for which the suggestions should be returned. schema: type: string description: The source text for which the suggestions should be returned. - knn.search_models::query.terminate_after: + knn.search_models___query.terminate_after: name: terminate_after in: query description: The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early. @@ -21667,41 +22201,41 @@ components: type: integer description: The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early. format: int32 - knn.search_models::query.timeout: + knn.search_models___query.timeout: name: timeout in: query description: Operation timeout. schema: - $ref: '#/components/schemas/_common:Duration' - knn.search_models::query.track_scores: + $ref: '#/components/schemas/_common___Duration' + knn.search_models___query.track_scores: name: track_scores in: query description: Whether to calculate and return scores even if they are not used for sorting. schema: type: boolean description: Whether to calculate and return scores even if they are not used for sorting. - knn.search_models::query.track_total_hits: + knn.search_models___query.track_total_hits: name: track_total_hits in: query description: Indicate if the number of documents that match the query should be tracked. schema: type: boolean description: Indicate if the number of documents that match the query should be tracked. - knn.search_models::query.typed_keys: + knn.search_models___query.typed_keys: name: typed_keys in: query description: Specify whether aggregation and suggester names should be prefixed by their respective types in the response. schema: type: boolean description: Specify whether aggregation and suggester names should be prefixed by their respective types in the response. - knn.search_models::query.version: + knn.search_models___query.version: name: version in: query description: Whether to return document version as part of a hit. schema: type: boolean description: Whether to return document version as part of a hit. - knn.stats::path.node_id: + knn.stats___path.node_id: name: node_id in: path description: Comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes. @@ -21711,7 +22245,7 @@ components: items: type: string required: true - knn.stats::path.stat: + knn.stats___path.stat: name: stat in: path description: Comma-separated list of stats to retrieve; use `_all` or empty string to retrieve all stats. @@ -21750,13 +22284,13 @@ components: - training_memory_usage_percentage - training_requests required: true - knn.stats::query.timeout: + knn.stats___query.timeout: name: timeout in: query description: Operation timeout. schema: - $ref: '#/components/schemas/_common:Duration' - knn.train_model::path.model_id: + $ref: '#/components/schemas/_common___Duration' + knn.train_model___path.model_id: name: model_id in: path description: The id of the model. @@ -21764,48 +22298,314 @@ components: type: string description: The id of the model. required: true - knn.train_model::query.preference: + knn.train_model___query.preference: name: preference in: query description: Preferred node to execute training. schema: type: string description: Preferred node to execute training. - knn.warmup::path.index: + knn.warmup___path.index: name: index in: path - description: Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices. + description: Comma-separated list of indexes; use `_all` or empty string to perform the operation on all indexes. schema: type: array - description: Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices. + description: Comma-separated list of indexes; use `_all` or empty string to perform the operation on all indexes. items: type: string required: true - mget::path.index: + list.indices___path.index: + in: path + name: index + description: |- + Comma-separated list of data streams, indexes, and aliases used to limit the request. + Supports wildcards (`*`). To target all data streams and indexes, omit this parameter or use `*` or `_all`. + required: true + schema: + $ref: '#/components/schemas/_common___Indices' + style: simple + list.indices___query.bytes: + in: query + name: bytes + description: The unit used to display byte values. + schema: + $ref: '#/components/schemas/_common___ByteUnit' + style: form + list.indices___query.cluster_manager_timeout: + name: cluster_manager_timeout + in: query + description: Operation timeout for connection to cluster-manager node. + schema: + $ref: '#/components/schemas/_common___Duration' + x-version-added: '2.0' + list.indices___query.expand_wildcards: + in: query + name: expand_wildcards + description: The type of index that wildcard patterns can match. + schema: + $ref: '#/components/schemas/_common___ExpandWildcards' + style: form + list.indices___query.format: + name: format + in: query + description: A short version of the Accept header, such as `JSON`, `YAML`. + schema: + type: string + description: A short version of the Accept header, such as `JSON`, `YAML`. + list.indices___query.h: + name: h + in: query + description: Comma-separated list of column names to display. + style: form + schema: + type: array + items: + type: string + description: Comma-separated list of column names to display. + explode: true + list.indices___query.health: + in: query + name: health + description: The health status used to limit returned indexes. By default, the response includes indexes of any health status. + schema: + $ref: '#/components/schemas/_common___HealthStatus' + style: form + list.indices___query.help: + name: help + in: query + description: Return help information. + schema: + type: boolean + default: false + description: Return help information. + list.indices___query.include_unloaded_segments: + in: query + name: include_unloaded_segments + description: If `true`, the response includes information from segments that are not loaded into memory. + schema: + type: boolean + default: false + style: form + list.indices___query.local: + name: local + in: query + description: Return local information, do not retrieve the state from cluster-manager node. + schema: + type: boolean + default: false + description: Return local information, do not retrieve the state from cluster-manager node. + list.indices___query.master_timeout: + name: master_timeout + in: query + description: Operation timeout for connection to cluster-manager node. + schema: + $ref: '#/components/schemas/_common___Duration' + x-version-deprecated: '2.0' + x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. + deprecated: true + list.indices___query.next_token: + name: next_token + in: query + description: Token to retrieve next page of indexes. + schema: + type: + - 'null' + - string + description: Token to retrieve next page of indexes. + list.indices___query.pri: + in: query + name: pri + description: If `true`, the response only includes information from primary shards. + schema: + type: boolean + default: false + style: form + list.indices___query.s: + name: s + in: query + description: Comma-separated list of column names or column aliases to sort by. + style: form + schema: + type: array + items: + type: string + description: Comma-separated list of column names or column aliases to sort by. + explode: true + list.indices___query.size: + name: size + in: query + description: Maximum number of indexes to be displayed in a page. + schema: + type: integer + format: int32 + list.indices___query.sort: + name: sort + in: query + description: Defines order in which indexes will be displayed. Accepted values are `asc` and `desc`. If `desc`, most recently created indexes would be displayed first. + schema: + type: string + enum: + - asc + - desc + list.indices___query.time: + in: query + name: time + description: The unit used to display time values. + schema: + $ref: '#/components/schemas/_common___TimeUnit' + style: form + list.indices___query.v: + name: v + in: query + description: Verbose mode. Display column headers. + schema: + type: boolean + default: false + description: Verbose mode. Display column headers. + list.shards___path.index: + in: path + name: index + description: |- + A comma-separated list of data streams, indexes, and aliases used to limit the request. + Supports wildcards (`*`). + To target all data streams and indexes, omit this parameter or use `*` or `_all`. + required: true + schema: + $ref: '#/components/schemas/_common___Indices' + style: simple + list.shards___query.bytes: + in: query + name: bytes + description: The unit used to display byte values. + schema: + $ref: '#/components/schemas/_common___ByteUnit' + style: form + list.shards___query.cluster_manager_timeout: + name: cluster_manager_timeout + in: query + description: Operation timeout for connection to cluster-manager node. + schema: + $ref: '#/components/schemas/_common___Duration' + x-version-added: '2.0' + list.shards___query.format: + name: format + in: query + description: A short version of the Accept header, such as `JSON`, `YAML`. + schema: + type: string + description: A short version of the Accept header, such as `JSON`, `YAML`. + list.shards___query.h: + name: h + in: query + description: Comma-separated list of column names to display. + style: form + schema: + type: array + items: + type: string + description: Comma-separated list of column names to display. + explode: true + list.shards___query.help: + name: help + in: query + description: Return help information. + schema: + type: boolean + default: false + description: Return help information. + list.shards___query.local: + name: local + in: query + description: Return local information, do not retrieve the state from cluster-manager node. + schema: + type: boolean + default: false + description: Return local information, do not retrieve the state from cluster-manager node. + list.shards___query.master_timeout: + name: master_timeout + in: query + description: Operation timeout for connection to cluster-manager node. + schema: + $ref: '#/components/schemas/_common___Duration' + x-version-deprecated: '2.0' + x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. + deprecated: true + list.shards___query.next_token: + name: next_token + in: query + description: Token to retrieve next page of shards. + schema: + type: + - 'null' + - string + description: Token to retrieve next page of shards. + list.shards___query.s: + name: s + in: query + description: Comma-separated list of column names or column aliases to sort by. + style: form + schema: + type: array + items: + type: string + description: Comma-separated list of column names or column aliases to sort by. + explode: true + list.shards___query.size: + name: size + in: query + description: Maximum number of shards to be displayed in a page. + schema: + type: integer + format: int32 + list.shards___query.sort: + name: sort + in: query + description: Defines order in which shards will be displayed. Accepted values are `asc` and `desc`. If `desc`, most recently created shards would be displayed first. + schema: + type: string + enum: + - asc + - desc + list.shards___query.time: + name: time + in: query + description: The unit in which to display time values. + schema: + $ref: '#/components/schemas/_common___TimeUnit' + list.shards___query.v: + name: v + in: query + description: Verbose mode. Display column headers. + schema: + type: boolean + default: false + description: Verbose mode. Display column headers. + mget___path.index: in: path name: index description: Name of the index to retrieve documents from when `ids` are specified, or when a document in the `docs` array does not specify an index. required: true schema: - $ref: '#/components/schemas/_common:IndexName' + $ref: '#/components/schemas/_common___IndexName' style: simple - mget::query._source: + mget___query._source: in: query name: _source - description: True or false to return the `_source` field or not, or a list of fields to return. + description: Set to `true` or `false` to return the `_source` field or not, or a list of fields to return. schema: - $ref: '#/components/schemas/_core.search:SourceConfigParam' + $ref: '#/components/schemas/_core.search___SourceConfigParam' style: form - mget::query._source_excludes: + mget___query._source_excludes: in: query name: _source_excludes description: |- A comma-separated list of source fields to exclude from the response. You can also use this parameter to exclude fields from the subset specified in `_source_includes` query parameter. schema: - $ref: '#/components/schemas/_common:Fields' + $ref: '#/components/schemas/_common___Fields' style: form - mget::query._source_includes: + mget___query._source_includes: in: query name: _source_includes description: |- @@ -21813,9 +22613,9 @@ components: If this parameter is specified, only these source fields are returned. You can exclude fields from this subset using the `_source_excludes` query parameter. If the `_source` parameter is `false`, this parameter is ignored. schema: - $ref: '#/components/schemas/_common:Fields' + $ref: '#/components/schemas/_common___Fields' style: form - mget::query.preference: + mget___query.preference: in: query name: preference description: Specifies the node or shard the operation should be performed on. Random by default. @@ -21823,100 +22623,100 @@ components: type: string default: random style: form - mget::query.realtime: + mget___query.realtime: in: query name: realtime description: If `true`, the request is real-time as opposed to near-real-time. schema: type: boolean style: form - mget::query.refresh: + mget___query.refresh: in: query name: refresh description: If `true`, the request refreshes relevant shards before retrieving documents. schema: - type: boolean + $ref: '#/components/schemas/_common___Refresh' style: form - mget::query.routing: + mget___query.routing: in: query name: routing description: Custom value used to route operations to a specific shard. schema: - $ref: '#/components/schemas/_common:RoutingInQueryString' + $ref: '#/components/schemas/_common___RoutingInQueryString' style: form - mget::query.stored_fields: + mget___query.stored_fields: in: query name: stored_fields description: If `true`, retrieves the document fields stored in the index rather than the document `_source`. schema: - $ref: '#/components/schemas/_common:Fields' + $ref: '#/components/schemas/_common___Fields' style: form - ml.delete_agent::path.agent_id: + ml.delete_agent___path.agent_id: name: agent_id in: path required: true schema: type: string - ml.delete_connector::path.connector_id: + ml.delete_connector___path.connector_id: name: connector_id in: path required: true schema: type: string - ml.delete_model_group::path.model_group_id: + ml.delete_model_group___path.model_group_id: name: model_group_id in: path required: true schema: type: string - ml.delete_model::path.model_id: + ml.delete_model___path.model_id: name: model_id in: path required: true schema: type: string - ml.delete_task::path.task_id: + ml.delete_task___path.task_id: name: task_id in: path required: true schema: type: string - ml.deploy_model::path.model_id: + ml.deploy_model___path.model_id: name: model_id in: path required: true schema: type: string - ml.get_model_group::path.model_group_id: + ml.get_model_group___path.model_group_id: name: model_group_id in: path required: true schema: type: string - ml.get_task::path.task_id: + ml.get_task___path.task_id: name: task_id in: path required: true schema: type: string - ml.undeploy_model::path.model_id: + ml.undeploy_model___path.model_id: name: model_id in: path required: true schema: type: string - msearch_template::path.index: + msearch_template___path.index: in: path name: index description: |- - Comma-separated list of data streams, indices, and aliases to search. + Comma-separated list of data streams, indexes, and aliases to search. Supports wildcards (`*`). - To search all data streams and indices, omit this parameter or use `*`. + To search all data streams and indexes, omit this parameter or use `*`. required: true schema: - $ref: '#/components/schemas/_common:Indices' + $ref: '#/components/schemas/_common___Indices' style: simple - msearch_template::query.ccs_minimize_roundtrips: + msearch_template___query.ccs_minimize_roundtrips: in: query name: ccs_minimize_roundtrips description: If `true`, network round-trips are minimized for cross-cluster search requests. @@ -21924,7 +22724,7 @@ components: type: boolean default: true style: form - msearch_template::query.max_concurrent_searches: + msearch_template___query.max_concurrent_searches: in: query name: max_concurrent_searches description: Maximum number of concurrent searches the API can run. @@ -21932,7 +22732,7 @@ components: type: integer format: int32 style: form - msearch_template::query.rest_total_hits_as_int: + msearch_template___query.rest_total_hits_as_int: in: query name: rest_total_hits_as_int description: |- @@ -21942,39 +22742,39 @@ components: type: boolean default: false style: form - msearch_template::query.search_type: + msearch_template___query.search_type: in: query name: search_type description: |- The type of the search operation. Available options: `query_then_fetch`, `dfs_query_then_fetch`. schema: - $ref: '#/components/schemas/_common:SearchType' + $ref: '#/components/schemas/_common___SearchType' style: form - msearch_template::query.typed_keys: + msearch_template___query.typed_keys: in: query name: typed_keys description: If `true`, the response prefixes aggregation and suggester names with their respective types. schema: type: boolean style: form - msearch::path.index: + msearch___path.index: in: path name: index - description: Comma-separated list of data streams, indices, and index aliases to search. + description: Comma-separated list of data streams, indexes, and index aliases to search. required: true schema: - $ref: '#/components/schemas/_common:Indices' + $ref: '#/components/schemas/_common___Indices' style: simple - msearch::query.ccs_minimize_roundtrips: + msearch___query.ccs_minimize_roundtrips: in: query name: ccs_minimize_roundtrips - description: If true, network roundtrips between the coordinating node and remote clusters are minimized for cross-cluster search requests. + description: If `true`, network round-trips between the coordinating node and remote clusters are minimized for cross-cluster search requests. schema: type: boolean default: true style: form - msearch::query.max_concurrent_searches: + msearch___query.max_concurrent_searches: in: query name: max_concurrent_searches description: Maximum number of concurrent searches the multi search API can execute. @@ -21982,7 +22782,7 @@ components: type: integer format: int32 style: form - msearch::query.max_concurrent_shard_requests: + msearch___query.max_concurrent_shard_requests: in: query name: max_concurrent_shard_requests description: Maximum number of concurrent shard requests that each sub-search request executes per node. @@ -21991,7 +22791,7 @@ components: format: int32 default: 5 style: form - msearch::query.pre_filter_shard_size: + msearch___query.pre_filter_shard_size: in: query name: pre_filter_shard_size description: Defines a threshold that enforces a pre-filter roundtrip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter roundtrip can limit the number of shards significantly if for instance a shard can not match any documents based on its rewrite method i.e., if date filters are mandatory to match but the shard bounds and the query are disjoint. @@ -21999,37 +22799,37 @@ components: type: integer format: int32 style: form - msearch::query.rest_total_hits_as_int: + msearch___query.rest_total_hits_as_int: in: query name: rest_total_hits_as_int - description: If true, hits.total are returned as an integer in the response. Defaults to false, which returns an object. + description: If `true`, `hits.total` are returned as an integer in the response. Defaults to false, which returns an object. schema: type: boolean default: false style: form - msearch::query.search_type: + msearch___query.search_type: in: query name: search_type description: Indicates whether global term and document frequencies should be used when scoring returned documents. schema: - $ref: '#/components/schemas/_common:SearchType' + $ref: '#/components/schemas/_common___SearchType' style: form - msearch::query.typed_keys: + msearch___query.typed_keys: in: query name: typed_keys description: Specifies whether aggregation and suggester names should be prefixed by their respective types in the response. schema: type: boolean style: form - mtermvectors::path.index: + mtermvectors___path.index: in: path name: index description: Name of the index that contains the documents. required: true schema: - $ref: '#/components/schemas/_common:IndexName' + $ref: '#/components/schemas/_common___IndexName' style: simple - mtermvectors::query.field_statistics: + mtermvectors___query.field_statistics: in: query name: field_statistics description: If `true`, the response includes the document count, sum of document frequencies, and sum of total term frequencies. @@ -22037,25 +22837,25 @@ components: type: boolean default: true style: form - mtermvectors::query.fields: + mtermvectors___query.fields: in: query name: fields description: |- Comma-separated list or wildcard expressions of fields to include in the statistics. Used as the default list unless a specific field list is provided in the `completion_fields` or `fielddata_fields` parameters. schema: - $ref: '#/components/schemas/_common:Fields' + $ref: '#/components/schemas/_common___Fields' style: form - mtermvectors::query.ids: + mtermvectors___query.ids: in: query name: ids description: A comma-separated list of documents ids. You must define ids as parameter or set "ids" or "docs" in the request body schema: type: array items: - $ref: '#/components/schemas/_common:Id' + $ref: '#/components/schemas/_common___Id' style: form - mtermvectors::query.offsets: + mtermvectors___query.offsets: in: query name: offsets description: If `true`, the response includes term offsets. @@ -22063,7 +22863,7 @@ components: type: boolean default: true style: form - mtermvectors::query.payloads: + mtermvectors___query.payloads: in: query name: payloads description: If `true`, the response includes term payloads. @@ -22071,7 +22871,7 @@ components: type: boolean default: true style: form - mtermvectors::query.positions: + mtermvectors___query.positions: in: query name: positions description: If `true`, the response includes term positions. @@ -22079,7 +22879,7 @@ components: type: boolean default: true style: form - mtermvectors::query.preference: + mtermvectors___query.preference: in: query name: preference description: |- @@ -22089,44 +22889,44 @@ components: type: string default: random style: form - mtermvectors::query.realtime: + mtermvectors___query.realtime: in: query name: realtime - description: If true, the request is real-time as opposed to near-real-time. + description: If `true`, the request is real-time as opposed to near-real-time. schema: type: boolean default: true style: form - mtermvectors::query.routing: + mtermvectors___query.routing: in: query name: routing description: Custom value used to route operations to a specific shard. schema: - $ref: '#/components/schemas/_common:RoutingInQueryString' + $ref: '#/components/schemas/_common___RoutingInQueryString' style: form - mtermvectors::query.term_statistics: + mtermvectors___query.term_statistics: in: query name: term_statistics - description: If true, the response includes term frequency and document frequency. + description: If `true`, the response includes term frequency and document frequency. schema: type: boolean default: false style: form - mtermvectors::query.version: + mtermvectors___query.version: in: query name: version description: If `true`, returns the document version as part of a hit. schema: - $ref: '#/components/schemas/_common:VersionNumber' + $ref: '#/components/schemas/_common___VersionNumber' style: form - mtermvectors::query.version_type: + mtermvectors___query.version_type: in: query name: version_type description: Specific version type. schema: - $ref: '#/components/schemas/_common:VersionType' + $ref: '#/components/schemas/_common___VersionType' style: form - nodes.hot_threads::path.node_id: + nodes.hot_threads___path.node_id: name: node_id in: path description: Comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes. @@ -22136,7 +22936,7 @@ components: items: type: string required: true - nodes.hot_threads::query.ignore_idle_threads: + nodes.hot_threads___query.ignore_idle_threads: name: ignore_idle_threads in: query description: Don't show threads that are in known-idle places, such as waiting on a socket select or pulling from an empty task queue. @@ -22144,22 +22944,22 @@ components: type: boolean default: true description: Don't show threads that are in known-idle places, such as waiting on a socket select or pulling from an empty task queue. - nodes.hot_threads::query.interval: + nodes.hot_threads___query.interval: name: interval in: query description: The interval for the second sampling of threads. schema: - $ref: '#/components/schemas/_common:Duration' - nodes.hot_threads::query.snapshots: + $ref: '#/components/schemas/_common___Duration' + nodes.hot_threads___query.snapshots: name: snapshots in: query - description: Number of samples of thread stacktrace. + description: Number of samples of thread stack trace. schema: type: integer default: 10 - description: Number of samples of thread stacktrace. + description: Number of samples of thread stack trace. format: int32 - nodes.hot_threads::query.threads: + nodes.hot_threads___query.threads: name: threads in: query description: Specify the number of threads to provide information for. @@ -22168,95 +22968,95 @@ components: default: 3 description: Specify the number of threads to provide information for. format: int32 - nodes.hot_threads::query.timeout: + nodes.hot_threads___query.timeout: name: timeout in: query description: Operation timeout. schema: - $ref: '#/components/schemas/_common:Duration' - nodes.hot_threads::query.type: + $ref: '#/components/schemas/_common___Duration' + nodes.hot_threads___query.type: name: type in: query description: The type to sample. schema: - $ref: '#/components/schemas/nodes._common:SampleType' - nodes.info::path.metric: + $ref: '#/components/schemas/nodes._common___SampleType' + nodes.info___path.metric: in: path name: metric - description: Limits the information returned to the specific metrics. Supports a comma-separated list, such as http,ingest. + description: Limits the information returned to the specific metrics. Supports a comma-separated list, such as `http,ingest`. required: true schema: type: array items: - $ref: '#/components/schemas/nodes.info:Metric' + $ref: '#/components/schemas/nodes.info___Metric' style: simple - nodes.info::path.node_id: + nodes.info___path.node_id: in: path name: node_id description: Comma-separated list of node IDs or names used to limit returned information. required: true schema: - $ref: '#/components/schemas/_common:NodeIds' + $ref: '#/components/schemas/_common___NodeIds' style: simple - nodes.info::path.node_id_or_metric: + nodes.info___path.node_id_or_metric: in: path name: node_id_or_metric description: | Limits the information returned to a list of node IDs or specific metrics. - Supports a comma-separated list, such as node1,node2 or http,ingest. + Supports a comma-separated list, such as `node1,node2` or `http,ingest`. required: true schema: anyOf: - title: node_id - $ref: '#/components/schemas/_common:NodeIds' + $ref: '#/components/schemas/_common___NodeIds' - title: metric type: array items: - $ref: '#/components/schemas/nodes.info:Metric' + $ref: '#/components/schemas/nodes.info___Metric' style: simple - nodes.info::query.flat_settings: + nodes.info___query.flat_settings: in: query name: flat_settings - description: If true, returns settings in flat format. + description: If `true`, returns settings in flat format. schema: type: boolean default: false style: form - nodes.info::query.timeout: + nodes.info___query.timeout: in: query name: timeout description: Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' style: form - nodes.reload_secure_settings::path.node_id: + nodes.reload_secure_settings___path.node_id: in: path name: node_id description: The names of particular nodes in the cluster to target. required: true schema: - $ref: '#/components/schemas/_common:NodeIds' + $ref: '#/components/schemas/_common___NodeIds' style: simple - nodes.reload_secure_settings::query.timeout: + nodes.reload_secure_settings___query.timeout: in: query name: timeout description: |- Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' style: form - nodes.stats::path.index_metric: + nodes.stats___path.index_metric: in: path name: index_metric - description: Limit the information returned for indices metric to the specific index metrics. It can be used only if indices (or all) metric is specified. + description: Limit the information returned for indexes metric to the specific index metrics. It can be used only if indexes (or all) metric is specified. required: true schema: type: array items: - $ref: '#/components/schemas/nodes.stats:IndexMetric' + $ref: '#/components/schemas/nodes.stats___IndexMetric' style: simple - nodes.stats::path.metric: + nodes.stats___path.metric: in: path name: metric description: Limit the information returned to the specified metrics @@ -22264,38 +23064,38 @@ components: schema: type: array items: - $ref: '#/components/schemas/nodes.stats:Metric' + $ref: '#/components/schemas/nodes.stats___Metric' style: simple - nodes.stats::path.node_id: + nodes.stats___path.node_id: in: path name: node_id description: Comma-separated list of node IDs or names used to limit returned information. required: true schema: - $ref: '#/components/schemas/_common:NodeIds' + $ref: '#/components/schemas/_common___NodeIds' style: simple - nodes.stats::query.completion_fields: + nodes.stats___query.completion_fields: in: query name: completion_fields - description: Comma-separated list or wildcard expressions of fields to include in fielddata and suggest statistics. + description: Comma-separated list or wildcard expressions of fields to include in field data and suggest statistics. schema: - $ref: '#/components/schemas/_common:Fields' + $ref: '#/components/schemas/_common___Fields' style: form - nodes.stats::query.fielddata_fields: + nodes.stats___query.fielddata_fields: in: query name: fielddata_fields - description: Comma-separated list or wildcard expressions of fields to include in fielddata statistics. + description: Comma-separated list or wildcard expressions of fields to include in field data statistics. schema: - $ref: '#/components/schemas/_common:Fields' + $ref: '#/components/schemas/_common___Fields' style: form - nodes.stats::query.fields: + nodes.stats___query.fields: in: query name: fields description: Comma-separated list or wildcard expressions of fields to include in the statistics. schema: - $ref: '#/components/schemas/_common:Fields' + $ref: '#/components/schemas/_common___Fields' style: form - nodes.stats::query.groups: + nodes.stats___query.groups: in: query name: groups description: Comma-separated list of search groups to include in the search statistics. @@ -22304,29 +23104,29 @@ components: items: type: string style: form - nodes.stats::query.include_segment_file_sizes: + nodes.stats___query.include_segment_file_sizes: in: query name: include_segment_file_sizes - description: If true, the call reports the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested). + description: If `true`, the call reports the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested). schema: type: boolean default: false style: form - nodes.stats::query.level: + nodes.stats___query.level: in: query name: level description: Indicates whether statistics are aggregated at the cluster, index, or shard level. schema: - $ref: '#/components/schemas/_common:Level' + $ref: '#/components/schemas/_common___Level' style: form - nodes.stats::query.timeout: + nodes.stats___query.timeout: in: query name: timeout description: Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' style: form - nodes.stats::query.types: + nodes.stats___query.types: in: query name: types description: A comma-separated list of document types for the indexing index metric. @@ -22335,7 +23135,7 @@ components: items: type: string style: form - nodes.usage::path.metric: + nodes.usage___path.metric: in: path name: metric description: |- @@ -22345,68 +23145,68 @@ components: schema: type: array items: - $ref: '#/components/schemas/nodes.usage:Metric' + $ref: '#/components/schemas/nodes.usage___Metric' style: simple - nodes.usage::path.node_id: + nodes.usage___path.node_id: in: path name: node_id description: A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes required: true schema: - $ref: '#/components/schemas/_common:NodeIds' + $ref: '#/components/schemas/_common___NodeIds' style: simple - nodes.usage::query.timeout: + nodes.usage___query.timeout: in: query name: timeout description: |- Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' style: form - notifications.delete_config::path.config_id: + notifications.delete_config___path.config_id: name: config_id in: path description: The ID of the channel configuration to delete. schema: type: string required: true - notifications.delete_configs::query.config_id: + notifications.delete_configs___query.config_id: name: config_id in: query description: The ID of the channel configuration to delete. schema: type: string required: true - notifications.delete_configs::query.config_id_list: + notifications.delete_configs___query.config_id_list: name: config_id_list in: query description: A comma-separated list of channel IDs to delete. schema: type: string - notifications.get_config::path.config_id: + notifications.get_config___path.config_id: name: config_id in: path schema: type: string required: true - notifications.get_configs::query.chime.url: + notifications.get_configs___query.chime.url: name: chime.url in: query schema: type: string - notifications.get_configs::query.chime.url.keyword: + notifications.get_configs___query.chime.url.keyword: name: chime.url.keyword in: query schema: type: string - notifications.get_configs::query.config_id: + notifications.get_configs___query.config_id: name: config_id in: query description: Notification configuration ID. schema: type: string - notifications.get_configs::query.config_id_list: + notifications.get_configs___query.config_id_list: name: config_id_list in: query description: Notification configuration IDs. @@ -22414,202 +23214,202 @@ components: type: array items: type: string - notifications.get_configs::query.config_type: + notifications.get_configs___query.config_type: name: config_type in: query description: Type of notification configuration. schema: - $ref: '#/components/schemas/notifications._common:NotificationConfigType' - notifications.get_configs::query.created_time_ms: + $ref: '#/components/schemas/notifications._common___NotificationConfigType' + notifications.get_configs___query.created_time_ms: name: created_time_ms in: query schema: type: integer format: int64 - notifications.get_configs::query.description: + notifications.get_configs___query.description: name: description in: query schema: type: string - notifications.get_configs::query.description.keyword: + notifications.get_configs___query.description.keyword: name: description.keyword in: query schema: type: string - notifications.get_configs::query.email_group.recipient_list.recipient: + notifications.get_configs___query.email_group.recipient_list.recipient: name: email_group.recipient_list.recipient in: query schema: type: string - notifications.get_configs::query.email_group.recipient_list.recipient.keyword: + notifications.get_configs___query.email_group.recipient_list.recipient.keyword: name: email_group.recipient_list.recipient.keyword in: query schema: type: string - notifications.get_configs::query.email.email_account_id: + notifications.get_configs___query.email.email_account_id: name: email.email_account_id in: query schema: type: string - notifications.get_configs::query.email.email_group_id_list: + notifications.get_configs___query.email.email_group_id_list: name: email.email_group_id_list in: query schema: type: string - notifications.get_configs::query.email.recipient_list.recipient: + notifications.get_configs___query.email.recipient_list.recipient: name: email.recipient_list.recipient in: query schema: type: string - notifications.get_configs::query.email.recipient_list.recipient.keyword: + notifications.get_configs___query.email.recipient_list.recipient.keyword: name: email.recipient_list.recipient.keyword in: query schema: type: string - notifications.get_configs::query.is_enabled: + notifications.get_configs___query.is_enabled: name: is_enabled in: query schema: type: boolean - notifications.get_configs::query.last_updated_time_ms: + notifications.get_configs___query.last_updated_time_ms: name: last_updated_time_ms in: query schema: type: integer format: int64 - notifications.get_configs::query.microsoft_teams.url: + notifications.get_configs___query.microsoft_teams.url: name: microsoft_teams.url in: query schema: type: string - notifications.get_configs::query.microsoft_teams.url.keyword: + notifications.get_configs___query.microsoft_teams.url.keyword: name: microsoft_teams.url.keyword in: query schema: type: string - notifications.get_configs::query.name: + notifications.get_configs___query.name: name: name in: query schema: type: string - notifications.get_configs::query.name.keyword: + notifications.get_configs___query.name.keyword: name: name.keyword in: query schema: type: string - notifications.get_configs::query.query: + notifications.get_configs___query.query: name: query in: query schema: type: string - notifications.get_configs::query.ses_account.from_address: + notifications.get_configs___query.ses_account.from_address: name: ses_account.from_address in: query schema: type: string - notifications.get_configs::query.ses_account.from_address.keyword: + notifications.get_configs___query.ses_account.from_address.keyword: name: ses_account.from_address.keyword in: query schema: type: string - notifications.get_configs::query.ses_account.region: + notifications.get_configs___query.ses_account.region: name: ses_account.region in: query schema: type: string - notifications.get_configs::query.ses_account.role_arn: + notifications.get_configs___query.ses_account.role_arn: name: ses_account.role_arn in: query schema: type: string - notifications.get_configs::query.ses_account.role_arn.keyword: + notifications.get_configs___query.ses_account.role_arn.keyword: name: ses_account.role_arn.keyword in: query schema: type: string - notifications.get_configs::query.slack.url: + notifications.get_configs___query.slack.url: name: slack.url in: query schema: type: string - notifications.get_configs::query.slack.url.keyword: + notifications.get_configs___query.slack.url.keyword: name: slack.url.keyword in: query schema: type: string - notifications.get_configs::query.smtp_account.from_address: + notifications.get_configs___query.smtp_account.from_address: name: smtp_account.from_address in: query schema: type: string - notifications.get_configs::query.smtp_account.from_address.keyword: + notifications.get_configs___query.smtp_account.from_address.keyword: name: smtp_account.from_address.keyword in: query schema: type: string - notifications.get_configs::query.smtp_account.host: + notifications.get_configs___query.smtp_account.host: name: smtp_account.host in: query schema: type: string - notifications.get_configs::query.smtp_account.host.keyword: + notifications.get_configs___query.smtp_account.host.keyword: name: smtp_account.host.keyword in: query schema: type: string - notifications.get_configs::query.smtp_account.method: + notifications.get_configs___query.smtp_account.method: name: smtp_account.method in: query schema: type: string - notifications.get_configs::query.sns.role_arn: + notifications.get_configs___query.sns.role_arn: name: sns.role_arn in: query schema: type: string - notifications.get_configs::query.sns.role_arn.keyword: + notifications.get_configs___query.sns.role_arn.keyword: name: sns.role_arn.keyword in: query schema: type: string - notifications.get_configs::query.sns.topic_arn: + notifications.get_configs___query.sns.topic_arn: name: sns.topic_arn in: query schema: type: string - notifications.get_configs::query.sns.topic_arn.keyword: + notifications.get_configs___query.sns.topic_arn.keyword: name: sns.topic_arn.keyword in: query schema: type: string - notifications.get_configs::query.text_query: + notifications.get_configs___query.text_query: name: text_query in: query schema: type: string - notifications.get_configs::query.webhook.url: + notifications.get_configs___query.webhook.url: name: webhook.url in: query schema: type: string - notifications.get_configs::query.webhook.url.keyword: + notifications.get_configs___query.webhook.url.keyword: name: webhook.url.keyword in: query schema: type: string - notifications.send_test::path.config_id: + notifications.send_test___path.config_id: name: config_id in: path schema: type: string required: true - notifications.update_config::path.config_id: + notifications.update_config___path.config_id: name: config_id in: path schema: type: string required: true - observability.delete_object::path.object_id: + observability.delete_object___path.object_id: in: path name: object_id description: The ID of the Observability Object. @@ -22617,7 +23417,7 @@ components: schema: type: string style: simple - observability.delete_objects::query.objectId: + observability.delete_objects___query.objectId: in: query name: objectId description: The ID of a single Observability Object to delete. @@ -22625,7 +23425,7 @@ components: schema: type: string style: form - observability.delete_objects::query.objectIdList: + observability.delete_objects___query.objectIdList: in: query name: objectIdList description: A comma-separated list of Observability Object IDs to delete. @@ -22633,7 +23433,7 @@ components: schema: type: string style: form - observability.get_object::path.object_id: + observability.get_object___path.object_id: in: path name: object_id description: The ID of the Observability Object. @@ -22641,7 +23441,7 @@ components: schema: type: string style: simple - observability.update_object::path.object_id: + observability.update_object___path.object_id: in: path name: object_id description: The ID of the Observability Object. @@ -22649,59 +23449,59 @@ components: schema: type: string style: simple - ppl.explain::query.format: + ppl.explain___query.format: name: format in: query - description: A short version of the Accept header, e.g. json, yaml. + description: A short version of the Accept header (for example, `json`, `yaml`). schema: type: string - ppl.explain::query.sanitize: + 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: + ppl.get_stats___query.format: name: format in: query - description: A short version of the Accept header, e.g. json, yaml. + description: A short version of the Accept header (for example, `json`, `yaml`). schema: type: string - ppl.get_stats::query.sanitize: + 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: + ppl.post_stats___query.format: name: format in: query - description: A short version of the Accept header, e.g. json, yaml. + description: A short version of the Accept header (for example, `json`, `yaml`). schema: type: string - ppl.post_stats::query.sanitize: + 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: + ppl.query___query.format: name: format in: query - description: A short version of the Accept header, e.g. json, yaml. + description: A short version of the Accept header (for example, `json`, `yaml`). schema: type: string - ppl.query::query.sanitize: + 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: + put_script___path.context: in: path name: context description: |- @@ -22709,9 +23509,9 @@ components: To prevent errors, the API immediately compiles the script or template in this context. required: true schema: - $ref: '#/components/schemas/_common:Name' + $ref: '#/components/schemas/_common___Name' style: simple - put_script::path.id: + put_script___path.id: in: path name: id description: |- @@ -22719,16 +23519,16 @@ components: Must be unique within the cluster. required: true schema: - $ref: '#/components/schemas/_common:Id' + $ref: '#/components/schemas/_common___Id' style: simple - put_script::query.cluster_manager_timeout: + put_script___query.cluster_manager_timeout: name: cluster_manager_timeout in: query description: Operation timeout for connection to cluster-manager node. schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' x-version-added: '2.0' - put_script::query.context: + put_script___query.context: name: context in: query description: |- @@ -22736,88 +23536,88 @@ components: To prevent errors, the API immediately compiles the script or template in this context. schema: type: string - put_script::query.master_timeout: + put_script___query.master_timeout: in: query name: master_timeout description: |- - Period to wait for a connection to the master node. + Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error. deprecated: true schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' style: form x-version-deprecated: '2.0' - x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. - put_script::query.timeout: + x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. + put_script___query.timeout: in: query name: timeout description: |- Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' style: form - query.datasource_delete::path.datasource_name: + 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: + 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: + rank_eval___path.index: in: path name: index description: |- - Comma-separated list of data streams, indices, and index aliases used to limit the request. Wildcard (`*`) expressions are supported. - To target all data streams and indices in a cluster, omit this parameter or use `_all` or `*`. + Comma-separated list of data streams, indexes, and index aliases used to limit the request. Wildcard (`*`) expressions are supported. + To target all data streams and indexes in a cluster, omit this parameter or use `_all` or `*`. required: true schema: - $ref: '#/components/schemas/_common:Indices' + $ref: '#/components/schemas/_common___Indices' style: simple - rank_eval::query.allow_no_indices: + rank_eval___query.allow_no_indices: in: query name: allow_no_indices - description: If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. + description: If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indexes. This behavior applies even if the request targets other open indexes. For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. schema: type: boolean style: form - rank_eval::query.expand_wildcards: + rank_eval___query.expand_wildcards: in: query name: expand_wildcards - description: Whether to expand wildcard expression to concrete indices that are open, closed or both. + description: Whether to expand wildcard expression to concrete indexes that are open, closed or both. schema: - $ref: '#/components/schemas/_common:ExpandWildcards' + $ref: '#/components/schemas/_common___ExpandWildcards' style: form - rank_eval::query.ignore_unavailable: + rank_eval___query.ignore_unavailable: in: query name: ignore_unavailable - description: If `true`, missing or closed indices are not included in the response. + description: If `true`, missing or closed indexes are not included in the response. schema: type: boolean style: form - rank_eval::query.search_type: + rank_eval___query.search_type: in: query name: search_type description: Search operation type schema: - $ref: '#/components/schemas/_common:SearchType' + $ref: '#/components/schemas/_common___SearchType' style: form - reindex_rethrottle::path.task_id: + reindex_rethrottle___path.task_id: in: path name: task_id description: Identifier for the task. required: true schema: - $ref: '#/components/schemas/_common:Id' + $ref: '#/components/schemas/_common___Id' style: simple - reindex_rethrottle::query.requests_per_second: + reindex_rethrottle___query.requests_per_second: in: query name: requests_per_second description: The throttle for this request in sub-requests per second. @@ -22825,7 +23625,7 @@ components: type: number format: float style: form - reindex::query.max_docs: + reindex___query.max_docs: name: max_docs in: query description: Maximum number of documents to process. By default, all documents. @@ -22833,14 +23633,14 @@ components: type: integer description: Maximum number of documents to process. By default, all documents. format: int32 - reindex::query.refresh: + reindex___query.refresh: in: query name: refresh description: If `true`, the request refreshes affected shards to make this operation visible to search. schema: - type: boolean + $ref: '#/components/schemas/_common___Refresh' style: form - reindex::query.requests_per_second: + reindex___query.requests_per_second: in: query name: requests_per_second description: |- @@ -22851,42 +23651,42 @@ components: format: float default: 0 style: form - reindex::query.scroll: + reindex___query.scroll: in: query name: scroll description: Specifies how long a consistent view of the index should be maintained for scrolled search. schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' style: form - reindex::query.slices: + reindex___query.slices: in: query name: slices description: |- The number of slices this task should be divided into. Defaults to 1 slice, meaning the task isn't sliced into subtasks. schema: - $ref: '#/components/schemas/_common:Slices' + $ref: '#/components/schemas/_common___Slices' style: form x-default: '1' - reindex::query.timeout: + reindex___query.timeout: in: query name: timeout description: Period each indexing waits for automatic index creation, dynamic mapping updates, and waiting for active shards. schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' style: form x-default: 1m - reindex::query.wait_for_active_shards: + reindex___query.wait_for_active_shards: in: query name: wait_for_active_shards description: |- The number of shard copies that must be active before proceeding with the operation. Set to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). schema: - $ref: '#/components/schemas/_common:WaitForActiveShards' + $ref: '#/components/schemas/_common___WaitForActiveShards' style: form x-default: '1' - reindex::query.wait_for_completion: + reindex___query.wait_for_completion: in: query name: wait_for_completion description: If `true`, the request blocks until the operation is complete. @@ -22894,14 +23694,14 @@ components: type: boolean default: true style: form - remote_store.restore::query.cluster_manager_timeout: + remote_store.restore___query.cluster_manager_timeout: name: cluster_manager_timeout in: query description: Operation timeout for connection to cluster-manager node. schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' x-version-added: '2.0' - remote_store.restore::query.wait_for_completion: + remote_store.restore___query.wait_for_completion: name: wait_for_completion in: query description: Should this request wait until the operation has completed before returning. @@ -22909,7 +23709,7 @@ components: type: boolean default: false description: Should this request wait until the operation has completed before returning. - render_search_template::path.id: + render_search_template___path.id: in: path name: id description: |- @@ -22917,174 +23717,223 @@ components: If no `source` is specified, this or the `id` request body parameter is required. required: true schema: - $ref: '#/components/schemas/_common:Id' + $ref: '#/components/schemas/_common___Id' + style: simple + replication.pause___path.index: + in: path + name: index + description: Name of the data stream, index, or index alias to perform bulk actions on. + required: true + schema: + $ref: '#/components/schemas/_common___IndexName' + style: simple + replication.resume___path.index: + in: path + name: index + description: Name of the data stream, index, or index alias to perform bulk actions on. + required: true + schema: + $ref: '#/components/schemas/_common___IndexName' + style: simple + replication.start___path.index: + in: path + name: index + description: Name of the data stream, index, or index alias to perform bulk actions on. + required: true + schema: + $ref: '#/components/schemas/_common___IndexName' + style: simple + replication.status___path.index: + in: path + name: index + description: Name of the data stream, index, or index alias to perform bulk actions on. + required: true + schema: + $ref: '#/components/schemas/_common___IndexName' + style: simple + replication.stop___path.index: + in: path + name: index + description: Name of the data stream, index, or index alias to perform bulk actions on. + required: true + schema: + $ref: '#/components/schemas/_common___IndexName' style: simple - rollups.delete::path.id: + replication.update_settings___path.index: + in: path + name: index + description: Name of the data stream, index, or index alias to perform bulk actions on. + required: true + schema: + $ref: '#/components/schemas/_common___IndexName' + style: simple + rollups.delete___path.id: name: id in: path description: Rollup to access required: true schema: - $ref: '#/components/schemas/_common:Id' + $ref: '#/components/schemas/_common___Id' style: simple - rollups.explain::path.id: + rollups.explain___path.id: name: id in: path description: Rollup to access required: true schema: - $ref: '#/components/schemas/_common:Id' + $ref: '#/components/schemas/_common___Id' style: simple - rollups.get::path.id: + rollups.get___path.id: name: id in: path description: Rollup to access required: true schema: - $ref: '#/components/schemas/_common:Id' + $ref: '#/components/schemas/_common___Id' style: simple - rollups.put::path.id: + rollups.put___path.id: name: id in: path description: Rollup to access required: true schema: - $ref: '#/components/schemas/_common:Id' + $ref: '#/components/schemas/_common___Id' style: simple - rollups.put::query.if_primary_term: + rollups.put___query.if_primary_term: name: if_primary_term in: query description: Only perform the operation if the document has this primary term. schema: type: number style: form - rollups.put::query.if_seq_no: + rollups.put___query.if_seq_no: name: if_seq_no in: query description: Only perform the operation if the document has this sequence number. schema: - $ref: '#/components/schemas/_common:SequenceNumber' + $ref: '#/components/schemas/_common___SequenceNumber' style: form - rollups.start::path.id: + rollups.start___path.id: name: id in: path description: Rollup to access required: true schema: - $ref: '#/components/schemas/_common:Id' + $ref: '#/components/schemas/_common___Id' style: simple - rollups.stop::path.id: + rollups.stop___path.id: name: id in: path description: Rollup to access required: true schema: - $ref: '#/components/schemas/_common:Id' + $ref: '#/components/schemas/_common___Id' style: simple - scroll::path.scroll_id: + scroll___path.scroll_id: in: path name: scroll_id description: The scroll ID required: true deprecated: true schema: - $ref: '#/components/schemas/_common:ScrollId' + $ref: '#/components/schemas/_common___ScrollId' style: simple - scroll::query.rest_total_hits_as_int: + scroll___query.rest_total_hits_as_int: in: query name: rest_total_hits_as_int - description: If true, the API response's hit.total property is returned as an integer. If false, the API response's hit.total property is returned as an object. + description: If `true`, the API response's `hit.total` property is returned as an integer. If `false`, the API response's `hit.total` property is returned as an object. schema: type: boolean default: false style: form - scroll::query.scroll: + scroll___query.scroll: in: query name: scroll description: Period to retain the search context for scrolling. schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' style: form - scroll::query.scroll_id: + scroll___query.scroll_id: in: query name: scroll_id description: The scroll ID for scrolled search deprecated: true schema: - $ref: '#/components/schemas/_common:ScrollId' + $ref: '#/components/schemas/_common___ScrollId' style: form - search_pipeline.delete::path.id: + search_pipeline.delete___path.id: name: id in: path description: Pipeline ID. schema: type: string required: true - search_pipeline.delete::query.cluster_manager_timeout: + search_pipeline.delete___query.cluster_manager_timeout: name: cluster_manager_timeout in: query description: Operation timeout for connection to cluster-manager node. schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' x-version-added: '2.0' - search_pipeline.delete::query.timeout: + search_pipeline.delete___query.timeout: name: timeout in: query description: Operation timeout. schema: - $ref: '#/components/schemas/_common:Duration' - search_pipeline.get::path.id: + $ref: '#/components/schemas/_common___Duration' + search_pipeline.get___path.id: name: id in: path description: Comma-separated list of search pipeline ids. Wildcards supported. schema: type: string - search_pipeline.get::query.cluster_manager_timeout: + required: true + search_pipeline.get___query.cluster_manager_timeout: name: cluster_manager_timeout in: query description: operation timeout for connection to cluster-manager node. schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' x-version-added: '2.0' - search_pipeline.put::path.id: + search_pipeline.put___path.id: name: id in: path description: Pipeline ID. schema: type: string required: true - search_pipeline.put::query.cluster_manager_timeout: + search_pipeline.put___query.cluster_manager_timeout: name: cluster_manager_timeout in: query description: operation timeout for connection to cluster-manager node. schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' x-version-added: '2.0' - search_pipeline.put::query.timeout: + search_pipeline.put___query.timeout: name: timeout in: query description: Operation timeout. schema: - $ref: '#/components/schemas/_common:Duration' - search_shards::path.index: + $ref: '#/components/schemas/_common___Duration' + search_shards___path.index: in: path name: index - description: Returns the indices and shards that a search request would be executed against. + description: Returns the indexes and shards that a search request would be executed against. required: true schema: - $ref: '#/components/schemas/_common:Indices' + $ref: '#/components/schemas/_common___Indices' style: simple - search_shards::query.allow_no_indices: + search_shards___query.allow_no_indices: in: query name: allow_no_indices description: |- - If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. - This behavior applies even if the request targets other open indices. + If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indexes. + This behavior applies even if the request targets other open indexes. For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. schema: type: boolean style: form - search_shards::query.expand_wildcards: + search_shards___query.expand_wildcards: in: query name: expand_wildcards description: |- @@ -23093,16 +23942,16 @@ components: Supports comma-separated values, such as `open,hidden`. Valid values are: `all`, `open`, `closed`, `hidden`, `none`. schema: - $ref: '#/components/schemas/_common:ExpandWildcards' + $ref: '#/components/schemas/_common___ExpandWildcards' style: form - search_shards::query.ignore_unavailable: + search_shards___query.ignore_unavailable: in: query name: ignore_unavailable description: If `false`, the request returns an error if it targets a missing or closed index. schema: type: boolean style: form - search_shards::query.local: + search_shards___query.local: in: query name: local description: If `true`, the request retrieves information from the local node only. @@ -23110,7 +23959,7 @@ components: type: boolean default: false style: form - search_shards::query.preference: + search_shards___query.preference: in: query name: preference description: |- @@ -23120,34 +23969,34 @@ components: type: string default: random style: form - search_shards::query.routing: + search_shards___query.routing: in: query name: routing description: Custom value used to route operations to a specific shard. schema: - $ref: '#/components/schemas/_common:RoutingInQueryString' + $ref: '#/components/schemas/_common___RoutingInQueryString' style: form - search_template::path.index: + search_template___path.index: in: path name: index description: |- - Comma-separated list of data streams, indices, + Comma-separated list of data streams, indexes, and aliases to search. Supports wildcards (*). required: true schema: - $ref: '#/components/schemas/_common:Indices' + $ref: '#/components/schemas/_common___Indices' style: simple - search_template::query.allow_no_indices: + search_template___query.allow_no_indices: in: query name: allow_no_indices description: |- - If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. - This behavior applies even if the request targets other open indices. + If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indexes. + This behavior applies even if the request targets other open indexes. For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. schema: type: boolean style: form - search_template::query.ccs_minimize_roundtrips: + search_template___query.ccs_minimize_roundtrips: in: query name: ccs_minimize_roundtrips description: If `true`, network round-trips are minimized for cross-cluster search requests. @@ -23155,7 +24004,7 @@ components: type: boolean default: true style: form - search_template::query.expand_wildcards: + search_template___query.expand_wildcards: in: query name: expand_wildcards description: |- @@ -23164,30 +24013,30 @@ components: Supports comma-separated values, such as `open,hidden`. Valid values are: `all`, `open`, `closed`, `hidden`, `none`. schema: - $ref: '#/components/schemas/_common:ExpandWildcards' + $ref: '#/components/schemas/_common___ExpandWildcards' style: form - search_template::query.explain: + search_template___query.explain: in: query name: explain description: If `true`, the response includes additional details about score computation as part of a hit. schema: type: boolean style: form - search_template::query.ignore_throttled: + search_template___query.ignore_throttled: in: query name: ignore_throttled - description: If `true`, specified concrete, expanded, or aliased indices are not included in the response when throttled. + description: If `true`, specified concrete, expanded, or aliased indexes are not included in the response when throttled. schema: type: boolean style: form - search_template::query.ignore_unavailable: + search_template___query.ignore_unavailable: in: query name: ignore_unavailable description: If `false`, the request returns an error if it targets a missing or closed index. schema: type: boolean style: form - search_template::query.preference: + search_template___query.preference: in: query name: preference description: |- @@ -23197,63 +24046,63 @@ components: type: string default: random style: form - search_template::query.profile: + search_template___query.profile: in: query name: profile description: If `true`, the query execution is profiled. schema: type: boolean style: form - search_template::query.rest_total_hits_as_int: + search_template___query.rest_total_hits_as_int: in: query name: rest_total_hits_as_int - description: If true, hits.total are rendered as an integer in the response. + description: If `true`, `hits.total` are rendered as an integer in the response. schema: type: boolean default: false style: form - search_template::query.routing: + search_template___query.routing: in: query name: routing description: Custom value used to route operations to a specific shard. schema: - $ref: '#/components/schemas/_common:RoutingInQueryString' + $ref: '#/components/schemas/_common___RoutingInQueryString' style: form - search_template::query.scroll: + search_template___query.scroll: in: query name: scroll description: |- Specifies how long a consistent view of the index should be maintained for scrolled search. schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' style: form - search_template::query.search_type: + search_template___query.search_type: in: query name: search_type description: The type of the search operation. schema: - $ref: '#/components/schemas/_common:SearchType' + $ref: '#/components/schemas/_common___SearchType' style: form - search_template::query.typed_keys: + search_template___query.typed_keys: in: query name: typed_keys description: If `true`, the response prefixes aggregation and suggester names with their respective types. schema: type: boolean style: form - search::path.index: + search___path.index: in: path name: index description: |- - Comma-separated list of data streams, indices, and aliases to search. + Comma-separated list of data streams, indexes, and aliases to search. Supports wildcards (`*`). - To search all data streams and indices, omit this parameter or use `*` or `_all`. + To search all data streams and indexes, omit this parameter or use `*` or `_all`. required: true schema: - $ref: '#/components/schemas/_common:Indices' + $ref: '#/components/schemas/_common___Indices' style: simple - search::query._source: + search___query._source: in: query name: _source description: |- @@ -23264,9 +24113,9 @@ components: `false` to not return the document source; `` to return the source fields that are specified as a comma-separated list (supports wildcard (`*`) patterns). schema: - $ref: '#/components/schemas/_core.search:SourceConfigParam' + $ref: '#/components/schemas/_core.search___SourceConfigParam' style: form - search::query._source_excludes: + search___query._source_excludes: in: query name: _source_excludes description: |- @@ -23274,9 +24123,9 @@ components: You can also use this parameter to exclude fields from the subset specified in `_source_includes` query parameter. If the `_source` parameter is `false`, this parameter is ignored. schema: - $ref: '#/components/schemas/_common:Fields' + $ref: '#/components/schemas/_common___Fields' style: form - search::query._source_includes: + search___query._source_includes: in: query name: _source_includes description: |- @@ -23285,37 +24134,37 @@ components: You can exclude fields from this subset using the `_source_excludes` query parameter. If the `_source` parameter is `false`, this parameter is ignored. schema: - $ref: '#/components/schemas/_common:Fields' + $ref: '#/components/schemas/_common___Fields' style: form - search::query.allow_no_indices: + search___query.allow_no_indices: in: query name: allow_no_indices description: |- - If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. - This behavior applies even if the request targets other open indices. + If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indexes. + This behavior applies even if the request targets other open indexes. For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. schema: type: boolean style: form - search::query.allow_partial_search_results: + search___query.allow_partial_search_results: in: query name: allow_partial_search_results - description: If true, returns partial results if there are shard request timeouts or shard failures. If false, returns an error with no partial results. + description: If `true`, returns partial results if there are shard request timeouts or shard failures. If `false`, returns an error with no partial results. schema: type: boolean default: true style: form - search::query.analyze_wildcard: + search___query.analyze_wildcard: in: query name: analyze_wildcard description: |- - If true, wildcard and prefix queries are analyzed. + If `true`, wildcard and prefix queries are analyzed. This parameter can only be used when the q query string parameter is specified. schema: type: boolean default: false style: form - search::query.analyzer: + search___query.analyzer: in: query name: analyzer description: |- @@ -23324,7 +24173,7 @@ components: schema: type: string style: form - search::query.batched_reduce_size: + search___query.batched_reduce_size: in: query name: batched_reduce_size description: |- @@ -23335,33 +24184,33 @@ components: format: int32 default: 512 style: form - search::query.cancel_after_time_interval: + search___query.cancel_after_time_interval: in: query name: cancel_after_time_interval description: |- The time after which the search request will be canceled. Request-level parameter takes precedence over `cancel_after_time_interval` cluster setting. schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' style: form - search::query.ccs_minimize_roundtrips: + search___query.ccs_minimize_roundtrips: in: query name: ccs_minimize_roundtrips - description: If true, network round-trips between the coordinating node and the remote clusters are minimized when executing cross-cluster search (CCS) requests. + description: If `true`, network round-trips between the coordinating node and the remote clusters are minimized when executing cross-cluster search (CCS) requests. schema: type: boolean default: true style: form - search::query.default_operator: + search___query.default_operator: in: query name: default_operator description: |- The default operator for query string query: AND or OR. This parameter can only be used when the `q` query string parameter is specified. schema: - $ref: '#/components/schemas/_common.query_dsl:Operator' + $ref: '#/components/schemas/_common.query_dsl___Operator' style: form - search::query.df: + search___query.df: in: query name: df description: |- @@ -23370,14 +24219,14 @@ components: schema: type: string style: form - search::query.docvalue_fields: + search___query.docvalue_fields: in: query name: docvalue_fields description: A comma-separated list of fields to return as the docvalue representation for each hit. schema: - $ref: '#/components/schemas/_common:Fields' + $ref: '#/components/schemas/_common___Fields' style: form - search::query.expand_wildcards: + search___query.expand_wildcards: in: query name: expand_wildcards description: |- @@ -23385,16 +24234,16 @@ components: If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`. schema: - $ref: '#/components/schemas/_common:ExpandWildcards' + $ref: '#/components/schemas/_common___ExpandWildcards' style: form - search::query.explain: + search___query.explain: in: query name: explain description: If `true`, returns detailed information about score computation as part of a hit. schema: type: boolean style: form - search::query.from: + search___query.from: in: query name: from description: |- @@ -23407,29 +24256,29 @@ components: format: int32 default: 0 style: form - search::query.ignore_throttled: + search___query.ignore_throttled: in: query name: ignore_throttled - description: If `true`, concrete, expanded or aliased indices will be ignored when frozen. + description: If `true`, concrete, expanded or aliased indexes will be ignored when frozen. schema: type: boolean style: form - search::query.ignore_unavailable: + search___query.ignore_unavailable: in: query name: ignore_unavailable description: If `false`, the request returns an error if it targets a missing or closed index. schema: type: boolean style: form - search::query.include_named_queries_score: + search___query.include_named_queries_score: name: include_named_queries_score in: query - description: Indicates whether hit.matched_queries should be rendered as a map that includes the name of the matched query associated with its score (true) or as an array containing the name of the matched queries (false) + description: Indicates whether `hit.matched_queries` should be rendered as a map that includes the name of the matched query associated with its score (true) or as an array containing the name of the matched queries (false) schema: type: boolean default: false - description: Indicates whether hit.matched_queries should be rendered as a map that includes the name of the matched query associated with its score (true) or as an array containing the name of the matched queries (false) - search::query.lenient: + description: Indicates whether `hit.matched_queries` should be rendered as a map that includes the name of the matched query associated with its score (true) or as an array containing the name of the matched queries (false) + search___query.lenient: in: query name: lenient description: |- @@ -23438,7 +24287,7 @@ components: schema: type: boolean style: form - search::query.max_concurrent_shard_requests: + search___query.max_concurrent_shard_requests: in: query name: max_concurrent_shard_requests description: |- @@ -23449,7 +24298,7 @@ components: format: int32 default: 5 style: form - search::query.phase_took: + search___query.phase_took: name: phase_took in: query description: Indicates whether to return phase-level `took` time values in the response. @@ -23457,7 +24306,7 @@ components: type: boolean default: false style: form - search::query.pre_filter_shard_size: + search___query.pre_filter_shard_size: in: query name: pre_filter_shard_size description: |- @@ -23471,7 +24320,7 @@ components: type: integer format: int32 style: form - search::query.preference: + search___query.preference: in: query name: preference description: |- @@ -23487,7 +24336,7 @@ components: type: string default: random style: form - search::query.q: + search___query.q: in: query name: q description: |- @@ -23496,7 +24345,7 @@ components: schema: type: string style: form - search::query.request_cache: + search___query.request_cache: in: query name: request_cache description: |- @@ -23505,7 +24354,7 @@ components: schema: type: boolean style: form - search::query.rest_total_hits_as_int: + search___query.rest_total_hits_as_int: in: query name: rest_total_hits_as_int description: Indicates whether `hits.total` should be rendered as an integer or an object in the rest search response. @@ -23513,14 +24362,14 @@ components: type: boolean default: false style: form - search::query.routing: + search___query.routing: in: query name: routing description: Custom value used to route operations to a specific shard. schema: - $ref: '#/components/schemas/_common:RoutingInQueryString' + $ref: '#/components/schemas/_common___RoutingInQueryString' style: form - search::query.scroll: + search___query.scroll: in: query name: scroll description: |- @@ -23528,30 +24377,30 @@ components: By default, this value cannot exceed `1d` (24 hours). You can change this limit using the `search.max_keep_alive` cluster-level setting. schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' style: form - search::query.search_pipeline: + search___query.search_pipeline: name: search_pipeline in: query description: Customizable sequence of processing stages applied to search queries. schema: type: string description: Customizable sequence of processing stages applied to search queries. - search::query.search_type: + search___query.search_type: in: query name: search_type description: How distributed term frequencies are calculated for relevance scoring. schema: - $ref: '#/components/schemas/_common:SearchType' + $ref: '#/components/schemas/_common___SearchType' style: form - search::query.seq_no_primary_term: + search___query.seq_no_primary_term: in: query name: seq_no_primary_term description: If `true`, returns sequence number and primary term of the last modification of each hit. schema: type: boolean style: form - search::query.size: + search___query.size: in: query name: size description: |- @@ -23563,7 +24412,7 @@ components: format: int32 default: 10 style: form - search::query.sort: + search___query.sort: in: query name: sort description: A comma-separated list of : pairs. @@ -23574,7 +24423,7 @@ components: items: type: string style: form - search::query.stats: + search___query.stats: in: query name: stats description: Specific `tag` of the request for logging and statistical purposes. @@ -23583,7 +24432,7 @@ components: items: type: string style: form - search::query.stored_fields: + search___query.stored_fields: in: query name: stored_fields description: |- @@ -23592,25 +24441,25 @@ components: If this field is specified, the `_source` parameter defaults to `false`. You can pass `_source: true` to return both source fields and stored fields in the search response. schema: - $ref: '#/components/schemas/_common:Fields' + $ref: '#/components/schemas/_common___Fields' style: form - search::query.suggest_field: + search___query.suggest_field: in: query name: suggest_field description: Specifies which field to use for suggestions. schema: - $ref: '#/components/schemas/_common:Field' + $ref: '#/components/schemas/_common___Field' style: form - search::query.suggest_mode: + search___query.suggest_mode: in: query name: suggest_mode description: |- Specifies the suggest mode. This parameter can only be used when the `suggest_field` and `suggest_text` query string parameters are specified. schema: - $ref: '#/components/schemas/_common:SuggestMode' + $ref: '#/components/schemas/_common___SuggestMode' style: form - search::query.suggest_size: + search___query.suggest_size: in: query name: suggest_size description: |- @@ -23620,7 +24469,7 @@ components: type: integer format: int32 style: form - search::query.suggest_text: + search___query.suggest_text: in: query name: suggest_text description: |- @@ -23629,7 +24478,7 @@ components: schema: type: string style: form - search::query.terminate_after: + search___query.terminate_after: in: query name: terminate_after description: |- @@ -23639,29 +24488,29 @@ components: 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. + Avoid specifying this parameter for requests that target data streams with backing indexes across multiple data tiers. If set to `0` (default), the query does not terminate early. schema: type: integer format: int32 style: form - search::query.timeout: + search___query.timeout: in: query name: 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. schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' style: form - search::query.track_scores: + search___query.track_scores: in: query name: track_scores description: If `true`, calculate and return document scores, even if the scores are not used for sorting. schema: type: boolean style: form - search::query.track_total_hits: + search___query.track_total_hits: in: query name: track_total_hits description: |- @@ -23669,455 +24518,455 @@ components: If `true`, the exact number of hits is returned at the cost of some performance. If `false`, the response does not include the total number of hits matching the query. schema: - $ref: '#/components/schemas/_core.search:TrackHits' + $ref: '#/components/schemas/_core.search___TrackHits' style: form - search::query.typed_keys: + search___query.typed_keys: in: query name: typed_keys description: If `true`, aggregation and suggester names are be prefixed by their respective types in the response. schema: type: boolean style: form - search::query.version: + search___query.version: in: query name: version description: If `true`, returns document version as part of a hit. schema: type: boolean style: form - security.authinfo::query.auth_type: + security.authinfo___query.auth_type: name: auth_type in: query description: The type of current authentication request. schema: type: string required: false - security.authinfo::query.verbose: + security.authinfo___query.verbose: name: verbose in: query description: Indicates whether a verbose response should be returned. schema: type: boolean required: false - security.create_action_group::path.action_group: + security.create_action_group___path.action_group: name: action_group in: path description: The name of the action group to create or replace. schema: type: string required: true - security.create_role_mapping::path.role: + 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: + 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: + 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: + 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: + 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: + security.delete_action_group___path.action_group: name: action_group in: path description: The name of the action group to delete. schema: type: string required: true - security.delete_distinguished_name::path.cluster_name: + 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: + 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: + 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: + 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: + 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: + 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: + 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: + 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: + security.get_action_group___path.action_group: name: action_group in: path description: The name of the action group to retrieve. schema: type: string required: true - security.get_all_certificates::query.cert_type: + 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: + 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' + $ref: '#/components/schemas/_common___Duration' required: false - security.get_distinguished_name::path.cluster_name: + 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: + 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. + 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: + 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. + 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: + 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: + 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: + 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' + $ref: '#/components/schemas/_common___Duration' required: false - security.get_role_mapping::path.role: + security.get_role_mapping___path.role: name: role in: path schema: type: string required: true - security.get_role::path.role: + security.get_role___path.role: name: role in: path schema: type: string required: true - security.get_sslinfo::query.show_dn: + security.get_sslinfo___query.show_dn: name: show_dn in: query - description: A boolean flag to indicate whether all domain names should be returned. + description: A Boolean flag to indicate whether all domain names should be returned. schema: type: - boolean - string required: false - security.get_tenant::path.tenant: + 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: + 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: + 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: + 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. + 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: + 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: + security.patch_distinguished_name___path.cluster_name: name: cluster_name in: path - description: The cluster-name to update nodesDn value. + description: The cluster name to update `nodesDn` value. schema: type: string required: true - security.patch_role_mapping::path.role: + 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: + 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: + 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: + 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: + security.update_distinguished_name___path.cluster_name: name: cluster_name in: path - description: The cluster-name to create/update nodesDn value for. + description: The cluster-name to create/update `nodesDn` value for. schema: type: string required: true - security.validate::query.accept_invalid: + security.validate___query.accept_invalid: name: accept_invalid in: query - description: A boolean flag to indicate whether invalid v6 configuration should be allowed. + description: A Boolean flag to indicate whether invalid v6 configuration should be allowed. schema: type: boolean required: false - snapshot.cleanup_repository::path.repository: + snapshot.cleanup_repository___path.repository: in: path name: repository description: Snapshot repository to clean up. required: true schema: - $ref: '#/components/schemas/_common:Name' + $ref: '#/components/schemas/_common___Name' style: simple - snapshot.cleanup_repository::query.cluster_manager_timeout: + snapshot.cleanup_repository___query.cluster_manager_timeout: name: cluster_manager_timeout in: query description: Operation timeout for connection to cluster-manager node. schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' x-version-added: '2.0' - snapshot.cleanup_repository::query.master_timeout: + snapshot.cleanup_repository___query.master_timeout: in: query name: master_timeout - description: Period to wait for a connection to the master node. + description: Period to wait for a connection to the cluster-manager node. deprecated: true schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' style: form x-version-deprecated: '2.0' - x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. - snapshot.cleanup_repository::query.timeout: + x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. + snapshot.cleanup_repository___query.timeout: in: query name: timeout description: Period to wait for a response. schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' style: form - snapshot.clone::path.repository: + snapshot.clone___path.repository: in: path name: repository description: A repository name required: true schema: - $ref: '#/components/schemas/_common:Name' + $ref: '#/components/schemas/_common___Name' style: simple - snapshot.clone::path.snapshot: + snapshot.clone___path.snapshot: in: path name: snapshot description: The name of the snapshot to clone from required: true schema: - $ref: '#/components/schemas/_common:Name' + $ref: '#/components/schemas/_common___Name' style: simple - snapshot.clone::path.target_snapshot: + snapshot.clone___path.target_snapshot: in: path name: target_snapshot description: The name of the cloned snapshot to create required: true schema: - $ref: '#/components/schemas/_common:Name' + $ref: '#/components/schemas/_common___Name' style: simple - snapshot.clone::query.cluster_manager_timeout: + snapshot.clone___query.cluster_manager_timeout: name: cluster_manager_timeout in: query description: Operation timeout for connection to cluster-manager node. schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' x-version-added: '2.0' - snapshot.clone::query.master_timeout: + snapshot.clone___query.master_timeout: in: query name: master_timeout - description: Explicit operation timeout for connection to master node + description: Explicit operation timeout for connection to cluster-manager node deprecated: true schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' style: form x-version-deprecated: '2.0' - x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. - snapshot.create_repository::path.repository: + x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. + snapshot.create_repository___path.repository: in: path name: repository description: A repository name required: true schema: - $ref: '#/components/schemas/_common:Name' + $ref: '#/components/schemas/_common___Name' style: simple - snapshot.create_repository::query.cluster_manager_timeout: + snapshot.create_repository___query.cluster_manager_timeout: name: cluster_manager_timeout in: query description: Operation timeout for connection to cluster-manager node. schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' x-version-added: '2.0' - snapshot.create_repository::query.master_timeout: + snapshot.create_repository___query.master_timeout: in: query name: master_timeout - description: Explicit operation timeout for connection to master node + description: Explicit operation timeout for connection to cluster-manager node deprecated: true schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' style: form x-version-deprecated: '2.0' - x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. - snapshot.create_repository::query.timeout: + x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. + snapshot.create_repository___query.timeout: in: query name: timeout description: Explicit operation timeout schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' style: form - snapshot.create_repository::query.verify: + snapshot.create_repository___query.verify: in: query name: verify description: Whether to verify the repository after creation schema: type: boolean style: form - snapshot.create::path.repository: + snapshot.create___path.repository: in: path name: repository description: Repository for the snapshot. required: true schema: - $ref: '#/components/schemas/_common:Name' + $ref: '#/components/schemas/_common___Name' style: simple - snapshot.create::path.snapshot: + snapshot.create___path.snapshot: in: path name: snapshot description: Name of the snapshot. Must be unique in the repository. required: true schema: - $ref: '#/components/schemas/_common:Name' + $ref: '#/components/schemas/_common___Name' style: simple - snapshot.create::query.cluster_manager_timeout: + snapshot.create___query.cluster_manager_timeout: name: cluster_manager_timeout in: query description: Operation timeout for connection to cluster-manager node. schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' x-version-added: '2.0' - snapshot.create::query.master_timeout: + snapshot.create___query.master_timeout: in: query name: master_timeout - description: Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + description: Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error. deprecated: true schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' style: form x-version-deprecated: '2.0' - x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. - snapshot.create::query.wait_for_completion: + x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. + snapshot.create___query.wait_for_completion: in: query name: wait_for_completion description: If `true`, the request returns a response when the snapshot is complete. If `false`, the request returns a response when the snapshot initializes. @@ -24125,87 +24974,87 @@ components: type: boolean default: false style: form - snapshot.delete_repository::path.repository: + snapshot.delete_repository___path.repository: in: path name: repository description: Name of the snapshot repository to unregister. Wildcard (`*`) patterns are supported. required: true schema: - $ref: '#/components/schemas/_common:Names' + $ref: '#/components/schemas/_common___Names' style: simple - snapshot.delete_repository::query.cluster_manager_timeout: + snapshot.delete_repository___query.cluster_manager_timeout: name: cluster_manager_timeout in: query description: Operation timeout for connection to cluster-manager node. schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' x-version-added: '2.0' - snapshot.delete_repository::query.master_timeout: + snapshot.delete_repository___query.master_timeout: in: query name: master_timeout - description: Explicit operation timeout for connection to master node + description: Explicit operation timeout for connection to cluster-manager node deprecated: true schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' style: form x-version-deprecated: '2.0' - x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. - snapshot.delete_repository::query.timeout: + x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. + snapshot.delete_repository___query.timeout: in: query name: timeout description: Explicit operation timeout schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' style: form - snapshot.delete::path.repository: + snapshot.delete___path.repository: in: path name: repository description: A repository name required: true schema: - $ref: '#/components/schemas/_common:Name' + $ref: '#/components/schemas/_common___Name' style: simple - snapshot.delete::path.snapshot: + snapshot.delete___path.snapshot: in: path name: snapshot description: A comma-separated list of snapshot names required: true schema: - $ref: '#/components/schemas/_common:Name' + $ref: '#/components/schemas/_common___Name' style: simple - snapshot.delete::query.cluster_manager_timeout: + snapshot.delete___query.cluster_manager_timeout: name: cluster_manager_timeout in: query description: Operation timeout for connection to cluster-manager node. schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' x-version-added: '2.0' - snapshot.delete::query.master_timeout: + snapshot.delete___query.master_timeout: in: query name: master_timeout - description: Explicit operation timeout for connection to master node + description: Explicit operation timeout for connection to cluster-manager node deprecated: true schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' style: form x-version-deprecated: '2.0' - x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. - snapshot.get_repository::path.repository: + x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. + snapshot.get_repository___path.repository: in: path name: repository description: A comma-separated list of repository names required: true schema: - $ref: '#/components/schemas/_common:Names' + $ref: '#/components/schemas/_common___Names' style: simple - snapshot.get_repository::query.cluster_manager_timeout: + snapshot.get_repository___query.cluster_manager_timeout: name: cluster_manager_timeout in: query description: Operation timeout for connection to cluster-manager node. schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' x-version-added: '2.0' - snapshot.get_repository::query.local: + snapshot.get_repository___query.local: in: query name: local description: Return local information, do not retrieve the state from cluster-manager node. @@ -24213,101 +25062,101 @@ components: type: boolean default: false style: form - snapshot.get_repository::query.master_timeout: + snapshot.get_repository___query.master_timeout: in: query name: master_timeout - description: Explicit operation timeout for connection to master node + description: Explicit operation timeout for connection to cluster-manager node deprecated: true schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' style: form x-version-deprecated: '2.0' - x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. - snapshot.get::path.repository: + x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. + snapshot.get___path.repository: in: path name: repository description: Comma-separated list of snapshot repository names used to limit the request. Wildcard (*) expressions are supported. required: true schema: - $ref: '#/components/schemas/_common:Name' + $ref: '#/components/schemas/_common___Name' style: simple - snapshot.get::path.snapshot: + snapshot.get___path.snapshot: in: path name: snapshot description: |- - Comma-separated list of snapshot names to retrieve. Also accepts wildcards (*). - - To get information about all snapshots in a registered repository, use a wildcard (*) or _all. - - To get information about any snapshots that are currently running, use _current. + Comma-separated list of snapshot names to retrieve. Also accepts wildcards (`*`). + - To get information about all snapshots in a registered repository, use a wildcard (`*`) or `_all`. + - To get information about any snapshots that are currently running, use `_current`. required: true schema: - $ref: '#/components/schemas/_common:Names' + $ref: '#/components/schemas/_common___Names' style: simple - snapshot.get::query.cluster_manager_timeout: + snapshot.get___query.cluster_manager_timeout: name: cluster_manager_timeout in: query description: Operation timeout for connection to cluster-manager node. schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' x-version-added: '2.0' - snapshot.get::query.ignore_unavailable: + snapshot.get___query.ignore_unavailable: in: query name: ignore_unavailable - description: If false, the request returns an error for any snapshots that are unavailable. + description: If `false`, the request returns an error for any snapshots that are unavailable. schema: type: boolean default: false style: form - snapshot.get::query.master_timeout: + snapshot.get___query.master_timeout: in: query name: master_timeout - description: Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + description: Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error. deprecated: true schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' style: form x-version-deprecated: '2.0' - x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. - snapshot.get::query.verbose: + x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. + snapshot.get___query.verbose: in: query name: verbose - description: If true, returns additional information about each snapshot such as the version of OpenSearch which took the snapshot, the start and end times of the snapshot, and the number of shards snapshotted. + description: If `true`, returns additional information about each snapshot such as the version of OpenSearch which took the snapshot, the start and end times of the snapshot, and the number of shards snapshotted. schema: type: boolean style: form - snapshot.restore::path.repository: + snapshot.restore___path.repository: in: path name: repository description: A repository name required: true schema: - $ref: '#/components/schemas/_common:Name' + $ref: '#/components/schemas/_common___Name' style: simple - snapshot.restore::path.snapshot: + snapshot.restore___path.snapshot: in: path name: snapshot description: A snapshot name required: true schema: - $ref: '#/components/schemas/_common:Name' + $ref: '#/components/schemas/_common___Name' style: simple - snapshot.restore::query.cluster_manager_timeout: + snapshot.restore___query.cluster_manager_timeout: name: cluster_manager_timeout in: query description: Operation timeout for connection to cluster-manager node. schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' x-version-added: '2.0' - snapshot.restore::query.master_timeout: + snapshot.restore___query.master_timeout: in: query name: master_timeout - description: Explicit operation timeout for connection to master node + description: Explicit operation timeout for connection to cluster-manager node deprecated: true schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' style: form x-version-deprecated: '2.0' - x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. - snapshot.restore::query.wait_for_completion: + x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. + snapshot.restore___query.wait_for_completion: in: query name: wait_for_completion description: Should this request wait until the operation has completed before returning @@ -24315,159 +25164,159 @@ components: type: boolean default: false style: form - snapshot.status::path.repository: + snapshot.status___path.repository: in: path name: repository description: A repository name required: true schema: - $ref: '#/components/schemas/_common:Name' + $ref: '#/components/schemas/_common___Name' style: simple - snapshot.status::path.snapshot: + snapshot.status___path.snapshot: in: path name: snapshot description: A comma-separated list of snapshot names required: true schema: - $ref: '#/components/schemas/_common:Names' + $ref: '#/components/schemas/_common___Names' style: simple - snapshot.status::query.cluster_manager_timeout: + snapshot.status___query.cluster_manager_timeout: name: cluster_manager_timeout in: query description: Operation timeout for connection to cluster-manager node. schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' x-version-added: '2.0' - snapshot.status::query.ignore_unavailable: + snapshot.status___query.ignore_unavailable: in: query name: ignore_unavailable - description: Whether to ignore unavailable snapshots, defaults to false which means a SnapshotMissingException is thrown + description: Whether to ignore unavailable snapshots, defaults to `false` which means a SnapshotMissingException is thrown schema: type: boolean default: false style: form - snapshot.status::query.master_timeout: + snapshot.status___query.master_timeout: in: query name: master_timeout - description: Explicit operation timeout for connection to master node + description: Explicit operation timeout for connection to cluster-manager node deprecated: true schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' style: form x-version-deprecated: '2.0' - x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. - snapshot.verify_repository::path.repository: + x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. + snapshot.verify_repository___path.repository: in: path name: repository description: A repository name required: true schema: - $ref: '#/components/schemas/_common:Name' + $ref: '#/components/schemas/_common___Name' style: simple - snapshot.verify_repository::query.cluster_manager_timeout: + snapshot.verify_repository___query.cluster_manager_timeout: name: cluster_manager_timeout in: query description: Operation timeout for connection to cluster-manager node. schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' x-version-added: '2.0' - snapshot.verify_repository::query.master_timeout: + snapshot.verify_repository___query.master_timeout: in: query name: master_timeout - description: Explicit operation timeout for connection to master node + description: Explicit operation timeout for connection to cluster-manager node deprecated: true schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' style: form x-version-deprecated: '2.0' - x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. - snapshot.verify_repository::query.timeout: + x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. + snapshot.verify_repository___query.timeout: in: query name: timeout description: Explicit operation timeout schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' style: form - sql.close::query.format: + sql.close___query.format: name: format in: query - description: A short version of the Accept header, e.g. json, yaml. + description: A short version of the Accept header (for example, `json`, `yaml`). schema: type: string - sql.close::query.sanitize: + 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: + sql.explain___query.format: name: format in: query - description: A short version of the Accept header, e.g. json, yaml. + description: A short version of the Accept header (for example, `json`, `yaml`). schema: type: string - sql.explain::query.sanitize: + 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: + sql.get_stats___query.format: name: format in: query - description: A short version of the Accept header, e.g. json, yaml. + description: A short version of the Accept header (for example, `json`, `yaml`). schema: type: string - sql.get_stats::query.sanitize: + 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: + sql.post_stats___query.format: name: format in: query - description: A short version of the Accept header, e.g. json, yaml. + description: A short version of the Accept header (for example, `json`, `yaml`). schema: type: string - sql.post_stats::query.sanitize: + 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: + sql.query___query.format: name: format in: query - description: A short version of the Accept header, e.g. json, yaml. + description: A short version of the Accept header (for example, `json`, `yaml`). schema: type: string - sql.query::query.sanitize: + 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: + sql.settings___query.format: name: format in: query - description: A short version of the Accept header, e.g. json, yaml. + description: A short version of the Accept header (for example, `json`, `yaml`). schema: type: string - tasks.cancel::path.task_id: + tasks.cancel___path.task_id: in: path name: task_id description: ID of the task. required: true schema: - $ref: '#/components/schemas/_common:TaskId' + $ref: '#/components/schemas/_common___TaskId' style: simple - tasks.cancel::query.actions: + tasks.cancel___query.actions: in: query name: actions description: Comma-separated list or wildcard expression of actions used to limit the request. @@ -24478,7 +25327,7 @@ components: items: type: string style: form - tasks.cancel::query.nodes: + tasks.cancel___query.nodes: in: query name: nodes description: Comma-separated list of node IDs or names used to limit the request. @@ -24487,14 +25336,14 @@ components: items: type: string style: form - tasks.cancel::query.parent_task_id: + tasks.cancel___query.parent_task_id: in: query name: parent_task_id description: Parent task ID used to limit the tasks. schema: type: string style: form - tasks.cancel::query.wait_for_completion: + tasks.cancel___query.wait_for_completion: in: query name: wait_for_completion description: Should the request block until the cancellation of the task and its descendant tasks is completed. Defaults to false @@ -24502,24 +25351,24 @@ components: type: boolean default: false style: form - tasks.get::path.task_id: + tasks.get___path.task_id: in: path name: task_id description: ID of the task. required: true schema: - $ref: '#/components/schemas/_common:Id' + $ref: '#/components/schemas/_common___Id' style: simple - tasks.get::query.timeout: + tasks.get___query.timeout: in: query name: timeout description: |- Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' style: form - tasks.get::query.wait_for_completion: + tasks.get___query.wait_for_completion: in: query name: wait_for_completion description: If `true`, the request blocks until the task has completed. @@ -24527,7 +25376,7 @@ components: type: boolean default: false style: form - tasks.list::query.actions: + tasks.list___query.actions: in: query name: actions description: Comma-separated list or wildcard expression of actions used to limit the request. @@ -24538,7 +25387,7 @@ components: items: type: string style: form - tasks.list::query.detailed: + tasks.list___query.detailed: in: query name: detailed description: If `true`, the response includes detailed information about shard recoveries. @@ -24546,14 +25395,14 @@ components: type: boolean default: false style: form - tasks.list::query.group_by: + tasks.list___query.group_by: in: query name: group_by description: Key used to group tasks in the response. schema: - $ref: '#/components/schemas/tasks._common:GroupBy' + $ref: '#/components/schemas/tasks._common___GroupBy' style: form - tasks.list::query.nodes: + tasks.list___query.nodes: name: nodes in: query description: Comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes. @@ -24564,21 +25413,21 @@ components: type: string description: Comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes. explode: true - tasks.list::query.parent_task_id: + tasks.list___query.parent_task_id: in: query name: parent_task_id description: Parent task ID used to limit returned information. To return all tasks, omit this parameter or use a value of `-1`. schema: - $ref: '#/components/schemas/_common:Id' + $ref: '#/components/schemas/_common___Id' style: form - tasks.list::query.timeout: + tasks.list___query.timeout: in: query name: timeout description: Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' style: form - tasks.list::query.wait_for_completion: + tasks.list___query.wait_for_completion: in: query name: wait_for_completion description: If `true`, the request blocks until the operation is complete. @@ -24586,23 +25435,23 @@ components: type: boolean default: false style: form - termvectors::path.id: + termvectors___path.id: in: path name: id description: Unique identifier of the document. required: true schema: - $ref: '#/components/schemas/_common:Id' + $ref: '#/components/schemas/_common___Id' style: simple - termvectors::path.index: + termvectors___path.index: in: path name: index description: Name of the index that contains the document. required: true schema: - $ref: '#/components/schemas/_common:IndexName' + $ref: '#/components/schemas/_common___IndexName' style: simple - termvectors::query.field_statistics: + termvectors___query.field_statistics: in: query name: field_statistics description: If `true`, the response includes the document count, sum of document frequencies, and sum of total term frequencies. @@ -24610,16 +25459,16 @@ components: type: boolean default: true style: form - termvectors::query.fields: + termvectors___query.fields: in: query name: fields description: |- Comma-separated list or wildcard expressions of fields to include in the statistics. Used as the default list unless a specific field list is provided in the `completion_fields` or `fielddata_fields` parameters. schema: - $ref: '#/components/schemas/_common:Fields' + $ref: '#/components/schemas/_common___Fields' style: form - termvectors::query.offsets: + termvectors___query.offsets: in: query name: offsets description: If `true`, the response includes term offsets. @@ -24627,7 +25476,7 @@ components: type: boolean default: true style: form - termvectors::query.payloads: + termvectors___query.payloads: in: query name: payloads description: If `true`, the response includes term payloads. @@ -24635,7 +25484,7 @@ components: type: boolean default: true style: form - termvectors::query.positions: + termvectors___query.positions: in: query name: positions description: If `true`, the response includes term positions. @@ -24643,7 +25492,7 @@ components: type: boolean default: true style: form - termvectors::query.preference: + termvectors___query.preference: in: query name: preference description: |- @@ -24653,22 +25502,22 @@ components: type: string default: random style: form - termvectors::query.realtime: + termvectors___query.realtime: in: query name: realtime - description: If true, the request is real-time as opposed to near-real-time. + description: If `true`, the request is real-time as opposed to near-real-time. schema: type: boolean default: true style: form - termvectors::query.routing: + termvectors___query.routing: in: query name: routing description: Custom value used to route operations to a specific shard. schema: - $ref: '#/components/schemas/_common:RoutingInQueryString' + $ref: '#/components/schemas/_common___RoutingInQueryString' style: form - termvectors::query.term_statistics: + termvectors___query.term_statistics: in: query name: term_statistics description: If `true`, the response includes term frequency and document frequency. @@ -24676,53 +25525,53 @@ components: type: boolean default: false style: form - termvectors::query.version: + termvectors___query.version: in: query name: version description: If `true`, returns the document version as part of a hit. schema: - $ref: '#/components/schemas/_common:VersionNumber' + $ref: '#/components/schemas/_common___VersionNumber' style: form - termvectors::query.version_type: + termvectors___query.version_type: in: query name: version_type description: Specific version type. schema: - $ref: '#/components/schemas/_common:VersionType' + $ref: '#/components/schemas/_common___VersionType' style: form - transforms.delete::path.id: + transforms.delete___path.id: name: id in: path description: Transform to delete required: true schema: - $ref: '#/components/schemas/_common:Id' + $ref: '#/components/schemas/_common___Id' style: simple - transforms.explain::path.id: + transforms.explain___path.id: name: id in: path description: Transform to explain required: true schema: - $ref: '#/components/schemas/_common:Id' + $ref: '#/components/schemas/_common___Id' style: simple - transforms.get::path.id: + transforms.get___path.id: name: id in: path description: Transform to access required: true schema: - $ref: '#/components/schemas/_common:Id' + $ref: '#/components/schemas/_common___Id' style: simple - transforms.put::path.id: + transforms.put___path.id: name: id in: path description: Transform to create/update required: true schema: - $ref: '#/components/schemas/_common:Id' + $ref: '#/components/schemas/_common___Id' style: simple - transforms.put::query.if_primary_term: + transforms.put___query.if_primary_term: name: if_primary_term in: query description: Only perform the operation if the document has this primary term. @@ -24730,15 +25579,15 @@ components: schema: type: number style: form - transforms.put::query.if_seq_no: + transforms.put___query.if_seq_no: name: if_seq_no in: query description: Only perform the operation if the document has this sequence number. required: false schema: - $ref: '#/components/schemas/_common:SequenceNumber' + $ref: '#/components/schemas/_common___SequenceNumber' style: form - transforms.search::query.from: + transforms.search___query.from: name: from in: query description: The starting transform to return. Default is `0`. @@ -24746,7 +25595,7 @@ components: schema: type: number style: form - transforms.search::query.search: + transforms.search___query.search: name: search in: query description: The search term to use to filter results. @@ -24754,7 +25603,7 @@ components: schema: type: string style: form - transforms.search::query.size: + transforms.search___query.size: name: size in: query description: Specifies the number of transforms to return. Default is `10`. @@ -24762,7 +25611,7 @@ components: schema: type: number style: form - transforms.search::query.sortDirection: + transforms.search___query.sortDirection: name: sortDirection in: query description: Specifies the direction to sort results in. Can be `ASC` or `DESC`. Default is `ASC`. @@ -24770,7 +25619,7 @@ components: schema: type: string style: form - transforms.search::query.sortField: + transforms.search___query.sortField: name: sortField in: query description: The field to sort results with. @@ -24778,31 +25627,31 @@ components: schema: type: string style: form - transforms.start::path.id: + transforms.start___path.id: name: id in: path description: Transform to start required: true schema: - $ref: '#/components/schemas/_common:Id' + $ref: '#/components/schemas/_common___Id' style: simple - transforms.stop::path.id: + transforms.stop___path.id: name: id in: path description: Transform to stop required: true schema: - $ref: '#/components/schemas/_common:Id' + $ref: '#/components/schemas/_common___Id' style: simple - update_by_query_rethrottle::path.task_id: + update_by_query_rethrottle___path.task_id: in: path name: task_id description: The ID for the task. required: true schema: - $ref: '#/components/schemas/_common:Id' + $ref: '#/components/schemas/_common___Id' style: simple - update_by_query_rethrottle::query.requests_per_second: + update_by_query_rethrottle___query.requests_per_second: in: query name: requests_per_second description: The throttle for this request in sub-requests per second. @@ -24810,61 +25659,61 @@ components: type: number format: float style: form - update_by_query::path.index: + update_by_query___path.index: in: path name: index description: |- - Comma-separated list of data streams, indices, and aliases to search. + Comma-separated list of data streams, indexes, and aliases to search. Supports wildcards (`*`). - To search all data streams or indices, omit this parameter or use `*` or `_all`. + To search all data streams or indexes, omit this parameter or use `*` or `_all`. required: true schema: - $ref: '#/components/schemas/_common:Indices' + $ref: '#/components/schemas/_common___Indices' style: simple - update_by_query::query._source: + update_by_query___query._source: name: _source in: query - description: True or false to return the _source field or not, or a list of fields to return. + description: Set to `true` or `false` to return the `_source` field or not, or a list of fields to return. style: form schema: type: array items: type: string - description: True or false to return the _source field or not, or a list of fields to return. + description: Set to `true` or `false` to return the `_source` field or not, or a list of fields to return. explode: true - update_by_query::query._source_excludes: + update_by_query___query._source_excludes: name: _source_excludes in: query - description: List of fields to exclude from the returned _source field. + description: List of fields to exclude from the returned `_source` field. style: form schema: type: array items: type: string - description: List of fields to exclude from the returned _source field. + description: List of fields to exclude from the returned `_source` field. explode: true - update_by_query::query._source_includes: + update_by_query___query._source_includes: name: _source_includes in: query - description: List of fields to extract and return from the _source field. + description: List of fields to extract and return from the `_source` field. style: form schema: type: array items: type: string - description: List of fields to extract and return from the _source field. + description: List of fields to extract and return from the `_source` field. explode: true - update_by_query::query.allow_no_indices: + update_by_query___query.allow_no_indices: in: query name: allow_no_indices description: |- - If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. - This behavior applies even if the request targets other open indices. + If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indexes. + This behavior applies even if the request targets other open indexes. For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. schema: type: boolean style: form - update_by_query::query.analyze_wildcard: + update_by_query___query.analyze_wildcard: in: query name: analyze_wildcard description: If `true`, wildcard and prefix queries are analyzed. @@ -24872,35 +25721,35 @@ components: type: boolean default: false style: form - update_by_query::query.analyzer: + update_by_query___query.analyzer: in: query name: analyzer description: Analyzer to use for the query string. schema: type: string style: form - update_by_query::query.conflicts: + update_by_query___query.conflicts: in: query name: conflicts description: 'What to do if update by query hits version conflicts: `abort` or `proceed`.' schema: - $ref: '#/components/schemas/_common:Conflicts' + $ref: '#/components/schemas/_common___Conflicts' style: form - update_by_query::query.default_operator: + update_by_query___query.default_operator: in: query name: default_operator description: 'The default operator for query string query: `AND` or `OR`.' schema: - $ref: '#/components/schemas/_common.query_dsl:Operator' + $ref: '#/components/schemas/_common.query_dsl___Operator' style: form - update_by_query::query.df: + update_by_query___query.df: in: query name: df description: Field to use as default where no field prefix is given in the query string. schema: type: string style: form - update_by_query::query.expand_wildcards: + update_by_query___query.expand_wildcards: in: query name: expand_wildcards description: |- @@ -24909,9 +25758,9 @@ components: Supports comma-separated values, such as `open,hidden`. Valid values are: `all`, `open`, `closed`, `hidden`, `none`. schema: - $ref: '#/components/schemas/_common:ExpandWildcards' + $ref: '#/components/schemas/_common___ExpandWildcards' style: form - update_by_query::query.from: + update_by_query___query.from: in: query name: from description: Starting offset. @@ -24920,21 +25769,21 @@ components: format: int32 default: 0 style: form - update_by_query::query.ignore_unavailable: + update_by_query___query.ignore_unavailable: in: query name: ignore_unavailable description: If `false`, the request returns an error if it targets a missing or closed index. schema: type: boolean style: form - update_by_query::query.lenient: + update_by_query___query.lenient: in: query name: lenient description: If `true`, format-based query failures (such as providing text to a numeric field) in the query string will be ignored. schema: type: boolean style: form - update_by_query::query.max_docs: + update_by_query___query.max_docs: in: query name: max_docs description: |- @@ -24944,7 +25793,7 @@ components: type: integer format: int32 style: form - update_by_query::query.pipeline: + update_by_query___query.pipeline: in: query name: pipeline description: |- @@ -24954,7 +25803,7 @@ components: schema: type: string style: form - update_by_query::query.preference: + update_by_query___query.preference: in: query name: preference description: |- @@ -24964,28 +25813,28 @@ components: type: string default: random style: form - update_by_query::query.q: + update_by_query___query.q: name: q in: query description: Query in the Lucene query string syntax. schema: type: string description: Query in the Lucene query string syntax. - update_by_query::query.refresh: + update_by_query___query.refresh: in: query name: refresh description: If `true`, OpenSearch refreshes affected shards to make the operation visible to search. schema: - type: boolean + $ref: '#/components/schemas/_common___Refresh' style: form - update_by_query::query.request_cache: + update_by_query___query.request_cache: in: query name: request_cache description: If `true`, the request cache is used for this request. schema: type: boolean style: form - update_by_query::query.requests_per_second: + update_by_query___query.requests_per_second: in: query name: requests_per_second description: The throttle for this request in sub-requests per second. @@ -24994,21 +25843,21 @@ components: format: float default: 0 style: form - update_by_query::query.routing: + update_by_query___query.routing: in: query name: routing description: Custom value used to route operations to a specific shard. schema: - $ref: '#/components/schemas/_common:RoutingInQueryString' + $ref: '#/components/schemas/_common___RoutingInQueryString' style: form - update_by_query::query.scroll: + update_by_query___query.scroll: in: query name: scroll description: Period to retain the search context for scrolling. schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' style: form - update_by_query::query.scroll_size: + update_by_query___query.scroll_size: in: query name: scroll_size description: Size of the scroll request that powers the operation. @@ -25017,37 +25866,37 @@ components: format: int32 default: 100 style: form - update_by_query::query.search_timeout: + update_by_query___query.search_timeout: in: query name: search_timeout description: Explicit timeout for each search request. schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' style: form - update_by_query::query.search_type: + update_by_query___query.search_type: in: query name: search_type description: 'The type of the search operation. Available options: `query_then_fetch`, `dfs_query_then_fetch`.' schema: - $ref: '#/components/schemas/_common:SearchType' + $ref: '#/components/schemas/_common___SearchType' style: form - update_by_query::query.size: + update_by_query___query.size: name: size in: query - description: Deprecated, please use `max_docs` instead. + description: Deprecated, use `max_docs` instead. schema: type: integer - description: Deprecated, please use `max_docs` instead. + description: Deprecated, use `max_docs` instead. format: int32 - update_by_query::query.slices: + update_by_query___query.slices: in: query name: slices description: The number of slices this task should be divided into. schema: - $ref: '#/components/schemas/_common:Slices' + $ref: '#/components/schemas/_common___Slices' style: form x-default: '1' - update_by_query::query.sort: + update_by_query___query.sort: in: query name: sort description: A comma-separated list of : pairs. @@ -25056,7 +25905,7 @@ components: items: type: string style: form - update_by_query::query.stats: + update_by_query___query.stats: in: query name: stats description: Specific `tag` of the request for logging and statistical purposes. @@ -25065,7 +25914,7 @@ components: items: type: string style: form - update_by_query::query.terminate_after: + update_by_query___query.terminate_after: in: query name: terminate_after description: |- @@ -25075,37 +25924,37 @@ components: 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. + Avoid specifying this parameter for requests that target data streams with backing indexes across multiple data tiers. schema: type: integer format: int32 style: form - update_by_query::query.timeout: + update_by_query___query.timeout: in: query name: timeout description: 'Period each update request waits for the following operations: dynamic mapping updates, waiting for active shards.' schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' style: form x-default: 1m - update_by_query::query.version: + update_by_query___query.version: in: query name: version description: If `true`, returns the document version as part of a hit. schema: type: boolean style: form - update_by_query::query.wait_for_active_shards: + update_by_query___query.wait_for_active_shards: in: query name: wait_for_active_shards description: |- The number of shard copies that must be active before proceeding with the operation. Set to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). schema: - $ref: '#/components/schemas/_common:WaitForActiveShards' + $ref: '#/components/schemas/_common___WaitForActiveShards' style: form x-default: '1' - update_by_query::query.wait_for_completion: + update_by_query___query.wait_for_completion: in: query name: wait_for_completion description: If `true`, the request blocks until the operation is complete. @@ -25113,46 +25962,46 @@ components: type: boolean default: true style: form - update::path.id: + update___path.id: in: path name: id description: Document ID required: true schema: - $ref: '#/components/schemas/_common:Id' + $ref: '#/components/schemas/_common___Id' style: simple - update::path.index: + update___path.index: in: path name: index description: The name of the index required: true schema: - $ref: '#/components/schemas/_common:IndexName' + $ref: '#/components/schemas/_common___IndexName' style: simple - update::query._source: + update___query._source: in: query name: _source description: |- - Set to false to disable source retrieval. You can also specify a comma-separated + Set to `false` to disable source retrieval. You can also specify a comma-separated list of the fields you want to retrieve. schema: - $ref: '#/components/schemas/_core.search:SourceConfigParam' + $ref: '#/components/schemas/_core.search___SourceConfigParam' style: form - update::query._source_excludes: + update___query._source_excludes: in: query name: _source_excludes description: Specify the source fields you want to exclude. schema: - $ref: '#/components/schemas/_common:Fields' + $ref: '#/components/schemas/_common___Fields' style: form - update::query._source_includes: + update___query._source_includes: in: query name: _source_includes description: Specify the source fields you want to retrieve. schema: - $ref: '#/components/schemas/_common:Fields' + $ref: '#/components/schemas/_common___Fields' style: form - update::query.if_primary_term: + update___query.if_primary_term: in: query name: if_primary_term description: Only perform the operation if the document has this primary term. @@ -25160,14 +26009,14 @@ components: type: integer format: int64 style: form - update::query.if_seq_no: + update___query.if_seq_no: in: query name: if_seq_no description: Only perform the operation if the document has this sequence number. schema: - $ref: '#/components/schemas/_common:SequenceNumber' + $ref: '#/components/schemas/_common___SequenceNumber' style: form - update::query.lang: + update___query.lang: in: query name: lang description: The script language. @@ -25175,25 +26024,25 @@ components: type: string default: painless style: form - update::query.refresh: + update___query.refresh: in: query name: refresh description: |- If 'true', OpenSearch refreshes the affected shards to make this operation - visible to search, if 'wait_for' then wait for a refresh to make this operation - visible to search, if 'false' do nothing with refreshes. + visible to search, if `wait_for` then wait for a refresh to make this operation + visible to search, if `false` do nothing with refreshes. schema: - $ref: '#/components/schemas/_common:Refresh' + $ref: '#/components/schemas/_common___Refresh' style: form - update::query.require_alias: + update___query.require_alias: in: query name: require_alias - description: If true, the destination must be an index alias. + description: If `true`, the destination must be an index alias. schema: type: boolean default: false style: form - update::query.retry_on_conflict: + update___query.retry_on_conflict: in: query name: retry_on_conflict description: Specify how many times should the operation be retried when a conflict occurs. @@ -25202,14 +26051,14 @@ components: format: int32 default: 0 style: form - update::query.routing: + update___query.routing: in: query name: routing description: Custom value used to route operations to a specific shard. schema: - $ref: '#/components/schemas/_common:RoutingInQueryString' + $ref: '#/components/schemas/_common___RoutingInQueryString' style: form - update::query.timeout: + update___query.timeout: in: query name: timeout description: |- @@ -25217,9 +26066,9 @@ components: This guarantees OpenSearch waits for at least the timeout before failing. The actual wait time could be longer, particularly when multiple waits occur. schema: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' style: form - update::query.wait_for_active_shards: + update___query.wait_for_active_shards: in: query name: wait_for_active_shards description: |- @@ -25227,15 +26076,36 @@ components: Set to 'all' or any positive integer up to the total number of shards in the index (number_of_replicas+1). Defaults to 1 meaning the primary shard. schema: - $ref: '#/components/schemas/_common:WaitForActiveShards' + $ref: '#/components/schemas/_common___WaitForActiveShards' style: form x-default: '1' + wlm.delete_query_group___path.name: + name: name + in: path + description: The name of the query group. + schema: + type: string + required: true + wlm.get_query_group___path.name: + name: name + in: path + description: The name of the query group. + schema: + type: string + required: true + wlm.update_query_group___path.name: + name: name + in: path + description: The name of the query group. + schema: + type: string + required: true requestBodies: asynchronous_search.search: content: application/json: schema: - $ref: '#/components/schemas/asynchronous_search._common:Search' + $ref: '#/components/schemas/asynchronous_search._common___Search' bulk: content: application/x-ndjson: @@ -25243,8 +26113,8 @@ components: type: array items: anyOf: - - $ref: '#/components/schemas/_core.bulk:OperationContainer' - - $ref: '#/components/schemas/_core.bulk:UpdateAction' + - $ref: '#/components/schemas/_core.bulk___OperationContainer' + - $ref: '#/components/schemas/_core.bulk___UpdateAction' - type: object description: The operation definition and data (action-data pairs), separated by newlines required: true @@ -25255,8 +26125,8 @@ components: type: array items: anyOf: - - $ref: '#/components/schemas/_core.bulk:OperationContainer' - - $ref: '#/components/schemas/_core.bulk:UpdateAction' + - $ref: '#/components/schemas/_core.bulk___OperationContainer' + - $ref: '#/components/schemas/_core.bulk___UpdateAction' - type: object description: The operation definition and data (action-data pairs), separated by newlines required: true @@ -25279,8 +26149,8 @@ components: type: object properties: scroll_id: - $ref: '#/components/schemas/_common:ScrollIds' - description: Comma-separated list of scroll IDs to clear if none was specified via the scroll_id parameter + $ref: '#/components/schemas/_common___ScrollIds' + description: Comma-separated list of scroll IDs to clear if none was specified using the `scroll_id` parameter cluster.allocation_explain: content: application/json: @@ -25291,9 +26161,9 @@ components: description: Specifies the node ID or the name of the node to only explain a shard that is currently located on the specified node. type: string index: - $ref: '#/components/schemas/_common:IndexName' + $ref: '#/components/schemas/_common___IndexName' primary: - description: If true, returns explanation for the primary shard for the given shard ID. + description: If `true`, returns explanation for the primary shard for the given shard ID. type: boolean shard: description: Specifies the ID of the shard that you would like an explanation for. @@ -25303,7 +26173,7 @@ components: content: application/json: schema: - $ref: '#/components/schemas/cluster.weighted_routing:WeightsBase' + $ref: '#/components/schemas/cluster.weighted_routing___WeightsBase' cluster.put_component_template: content: application/json: @@ -25313,16 +26183,16 @@ components: allow_auto_create: description: |- This setting overrides the value of the `action.auto_create_index` cluster setting. - If set to `true` in a template, then indices can be automatically created using that - template even if auto-creation of indices is disabled via `actions.auto_create_index`. + If set to `true` in a template, then indexes can be automatically created using that + template even if auto-creation of indexes is disabled using `actions.auto_create_index`. If set to `false` then data streams matching the template must always be explicitly created. type: boolean template: - $ref: '#/components/schemas/indices._common:IndexState' + $ref: '#/components/schemas/indices._common___IndexState' version: - $ref: '#/components/schemas/_common:VersionNumber' + $ref: '#/components/schemas/_common___VersionNumber' _meta: - $ref: '#/components/schemas/_common:Metadata' + $ref: '#/components/schemas/_common___Metadata' required: - template description: The template definition @@ -25345,7 +26215,7 @@ components: content: application/json: schema: - $ref: '#/components/schemas/cluster.weighted_routing:Weights' + $ref: '#/components/schemas/cluster.weighted_routing___Weights' cluster.reroute: content: application/json: @@ -25356,7 +26226,7 @@ components: description: Defines the commands to perform. type: array items: - $ref: '#/components/schemas/cluster.reroute:Command' + $ref: '#/components/schemas/cluster.reroute___Command' description: The definition of `commands` to perform (`move`, `cancel`, `allocate`) count: content: @@ -25365,7 +26235,7 @@ components: type: object properties: query: - $ref: '#/components/schemas/_common.query_dsl:QueryContainer' + $ref: '#/components/schemas/_common.query_dsl___QueryContainer' description: Query to restrict the results specified with the Query DSL (optional) create: content: @@ -25385,9 +26255,9 @@ components: type: integer format: int32 query: - $ref: '#/components/schemas/_common.query_dsl:QueryContainer' + $ref: '#/components/schemas/_common.query_dsl___QueryContainer' slice: - $ref: '#/components/schemas/_common:SlicedScroll' + $ref: '#/components/schemas/_common___SlicedScroll' description: The search definition using the Query DSL required: true delete_pit: @@ -25410,7 +26280,7 @@ components: type: object properties: query: - $ref: '#/components/schemas/_common.query_dsl:QueryContainer' + $ref: '#/components/schemas/_common.query_dsl___QueryContainer' description: The query definition using the Query DSL field_caps: content: @@ -25419,40 +26289,38 @@ components: type: object properties: fields: - $ref: '#/components/schemas/_common:Fields' + $ref: '#/components/schemas/_common___Fields' index_filter: - $ref: '#/components/schemas/_common.query_dsl:QueryContainer' - runtime_mappings: - $ref: '#/components/schemas/_common.mapping:RuntimeFields' + $ref: '#/components/schemas/_common.query_dsl___QueryContainer' description: An index filter specified with the Query DSL flow_framework.create: content: application/json: schema: - $ref: '#/components/schemas/flow_framework.common:FlowFrameworkCreate' + $ref: '#/components/schemas/flow_framework.common___FlowFrameworkCreate' flow_framework.provision: required: false content: application/json: schema: - $ref: '#/components/schemas/flow_framework.common:UserProvidedSubstitutionExpressions' + $ref: '#/components/schemas/flow_framework.common___UserProvidedSubstitutionExpressions' flow_framework.search: required: true content: application/json: schema: - $ref: '#/components/schemas/flow_framework.common:SearchWorkflowRequest' + $ref: '#/components/schemas/flow_framework.common___SearchWorkflowRequest' flow_framework.search_state: required: true content: application/json: schema: - $ref: '#/components/schemas/flow_framework.common:SearchWorkflowRequest' + $ref: '#/components/schemas/flow_framework.common___SearchWorkflowRequest' flow_framework.update: content: application/json: schema: - $ref: '#/components/schemas/flow_framework.common:FlowFrameworkUpdate' + $ref: '#/components/schemas/flow_framework.common___FlowFrameworkUpdate' index: content: application/json: @@ -25480,24 +26348,24 @@ components: description: Array of character filters used to preprocess characters before the tokenizer. type: array items: - $ref: '#/components/schemas/_common.analysis:CharFilter' + $ref: '#/components/schemas/_common.analysis___CharFilter' explain: description: If `true`, the response includes token attributes and additional details. type: boolean field: - $ref: '#/components/schemas/_common:Field' + $ref: '#/components/schemas/_common___Field' filter: description: Array of token filters used to apply after the tokenizer. type: array items: - $ref: '#/components/schemas/_common.analysis:TokenFilter' + $ref: '#/components/schemas/_common.analysis___TokenFilter' normalizer: description: Normalizer to use to convert text into a single token. type: string text: - $ref: '#/components/schemas/indices.analyze:TextToAnalyze' + $ref: '#/components/schemas/indices.analyze___TextToAnalyze' tokenizer: - $ref: '#/components/schemas/_common.analysis:Tokenizer' + $ref: '#/components/schemas/_common.analysis___Tokenizer' description: Define analyzer/tokenizer parameters and the text on which the analysis should be performed indices.clone: content: @@ -25509,7 +26377,7 @@ components: description: Aliases for the resulting index. type: object additionalProperties: - $ref: '#/components/schemas/indices._common:Alias' + $ref: '#/components/schemas/indices._common___Alias' settings: description: Configuration options for the target index. type: object @@ -25526,11 +26394,11 @@ components: description: Aliases for the index. type: object additionalProperties: - $ref: '#/components/schemas/indices._common:Alias' + $ref: '#/components/schemas/indices._common___Alias' mappings: - $ref: '#/components/schemas/_common.mapping:TypeMapping' + $ref: '#/components/schemas/_common.mapping___TypeMapping' settings: - $ref: '#/components/schemas/indices._common:IndexSettings' + $ref: '#/components/schemas/indices._common___IndexSettings' description: The configuration for the index (`settings` and `mappings`) indices.create_data_stream: content: @@ -25547,22 +26415,22 @@ components: alias: type: string filter: - $ref: '#/components/schemas/_common.query_dsl:QueryContainer' + $ref: '#/components/schemas/_common.query_dsl___QueryContainer' index: type: string index_routing: - $ref: '#/components/schemas/_common:Routing' + $ref: '#/components/schemas/_common___Routing' is_write_index: description: |- If `true`, sets the write index or data stream for the alias. - If an alias points to multiple indices or data streams and `is_write_index` isn't set, the alias rejects write requests. + If an alias points to multiple indexes or data streams and `is_write_index` isn't set, the alias rejects write requests. If an index alias points to one index and `is_write_index` isn't set, the index automatically acts as the write index. Data stream aliases don't automatically set a write data stream, even if the alias points to one data stream. type: boolean routing: - $ref: '#/components/schemas/_common:Routing' + $ref: '#/components/schemas/_common___Routing' search_routing: - $ref: '#/components/schemas/_common:Routing' + $ref: '#/components/schemas/_common___Routing' is_hidden: x-version-added: '2.16' description: If `true`, the alias will be hidden`. @@ -25576,29 +26444,29 @@ components: type: object properties: index_patterns: - $ref: '#/components/schemas/_common:Indices' + $ref: '#/components/schemas/_common___Indices' composed_of: description: |- An ordered list of component template names. Component templates are merged in the order specified, meaning that the last component template specified has the highest precedence. type: array items: - $ref: '#/components/schemas/_common:Name' + $ref: '#/components/schemas/_common___Name' template: - $ref: '#/components/schemas/indices.put_index_template:IndexTemplateMapping' + $ref: '#/components/schemas/indices.put_index_template___IndexTemplateMapping' data_stream: - $ref: '#/components/schemas/indices._common:IndexTemplateDataStreamConfiguration' + $ref: '#/components/schemas/indices._common___IndexTemplateDataStreamConfiguration' priority: description: |- Priority to determine index template precedence when a new data stream or index is created. The index template with the highest priority is chosen. If no priority is specified the template is treated as though it is of priority 0 (lowest priority). This number is not automatically generated by OpenSearch. - type: number + type: integer version: - $ref: '#/components/schemas/_common:VersionNumber' + $ref: '#/components/schemas/_common___VersionNumber' _meta: - $ref: '#/components/schemas/_common:Metadata' + $ref: '#/components/schemas/_common___Metadata' description: The template definition required: true indices.put_mapping: @@ -25611,11 +26479,11 @@ components: description: Controls whether dynamic date detection is enabled. type: boolean dynamic: - $ref: '#/components/schemas/_common.mapping:DynamicMapping' + $ref: '#/components/schemas/_common.mapping___DynamicMapping' dynamic_date_formats: description: |- If date detection is enabled then new string fields are checked - against 'dynamic_date_formats' and if the value matches then + against `dynamic_date_formats` and if the value matches then a new date field is added instead of string. type: array items: @@ -25625,16 +26493,16 @@ components: oneOf: - type: object additionalProperties: - $ref: '#/components/schemas/_common.mapping:DynamicTemplate' + $ref: '#/components/schemas/_common.mapping___DynamicTemplate' - type: array items: type: object additionalProperties: - $ref: '#/components/schemas/_common.mapping:DynamicTemplate' + $ref: '#/components/schemas/_common.mapping___DynamicTemplate' _field_names: - $ref: '#/components/schemas/_common.mapping:FieldNamesField' + $ref: '#/components/schemas/_common.mapping___FieldNamesField' _meta: - $ref: '#/components/schemas/_common:Metadata' + $ref: '#/components/schemas/_common___Metadata' numeric_detection: description: Automatically map strings into numeric data types for all fields. type: boolean @@ -25647,20 +26515,18 @@ components: - Mapping parameters type: object additionalProperties: - $ref: '#/components/schemas/_common.mapping:Property' + $ref: '#/components/schemas/_common.mapping___Property' _routing: - $ref: '#/components/schemas/_common.mapping:RoutingField' + $ref: '#/components/schemas/_common.mapping___RoutingField' _source: - $ref: '#/components/schemas/_common.mapping:SourceField' - runtime: - $ref: '#/components/schemas/_common.mapping:RuntimeFields' + $ref: '#/components/schemas/_common.mapping___SourceField' description: The mapping definition required: true indices.put_settings: content: application/json: schema: - $ref: '#/components/schemas/indices._common:IndexSettings' + $ref: '#/components/schemas/indices._common___IndexSettings' required: true indices.put_template: content: @@ -25672,18 +26538,18 @@ components: description: Aliases for the index. type: object additionalProperties: - $ref: '#/components/schemas/indices._common:Alias' + $ref: '#/components/schemas/indices._common___Alias' index_patterns: description: |- Array of wildcard expressions used to match the names - of indices during creation. + of indexes during creation. oneOf: - type: string - type: array items: type: string mappings: - $ref: '#/components/schemas/_common.mapping:TypeMapping' + $ref: '#/components/schemas/_common.mapping___TypeMapping' order: description: |- Order in which OpenSearch applies this template if index @@ -25698,7 +26564,7 @@ components: additionalProperties: type: object version: - $ref: '#/components/schemas/_common:VersionNumber' + $ref: '#/components/schemas/_common___VersionNumber' description: The template definition required: true indices.rollover: @@ -25713,11 +26579,11 @@ components: Data streams do not support this parameter. type: object additionalProperties: - $ref: '#/components/schemas/indices._common:Alias' + $ref: '#/components/schemas/indices._common___Alias' conditions: - $ref: '#/components/schemas/indices.rollover:RolloverConditions' + $ref: '#/components/schemas/indices.rollover___RolloverConditions' mappings: - $ref: '#/components/schemas/_common.mapping:TypeMapping' + $ref: '#/components/schemas/_common.mapping___TypeMapping' settings: description: |- Configuration options for the index. @@ -25738,7 +26604,7 @@ components: Index alias names support date math. type: object additionalProperties: - $ref: '#/components/schemas/indices._common:Alias' + $ref: '#/components/schemas/indices._common___Alias' settings: description: Configuration options for the target index. type: object @@ -25754,39 +26620,39 @@ components: allow_auto_create: description: |- This setting overrides the value of the `action.auto_create_index` cluster setting. - If set to `true` in a template, then indices can be automatically created using that template even if auto-creation of indices is disabled via `actions.auto_create_index`. - If set to `false`, then indices or data streams matching the template must always be explicitly created, and may never be automatically created. + If set to `true` in a template, then indexes can be automatically created using that template even if auto-creation of indexes is disabled using `actions.auto_create_index`. + If set to `false`, then indexes or data streams matching the template must always be explicitly created, and may never be automatically created. type: boolean index_patterns: - $ref: '#/components/schemas/_common:Indices' + $ref: '#/components/schemas/_common___Indices' composed_of: description: |- An ordered list of component template names. Component templates are merged in the order specified, meaning that the last component template specified has the highest precedence. type: array items: - $ref: '#/components/schemas/_common:Name' + $ref: '#/components/schemas/_common___Name' template: - $ref: '#/components/schemas/indices.put_index_template:IndexTemplateMapping' + $ref: '#/components/schemas/indices.put_index_template___IndexTemplateMapping' data_stream: - $ref: '#/components/schemas/indices._common:IndexTemplateDataStreamConfiguration' + $ref: '#/components/schemas/indices._common___IndexTemplateDataStreamConfiguration' priority: description: |- Priority to determine index template precedence when a new data stream or index is created. The index template with the highest priority is chosen. If no priority is specified the template is treated as though it is of priority 0 (lowest priority). This number is not automatically generated by OpenSearch. - type: number + type: integer version: - $ref: '#/components/schemas/_common:VersionNumber' + $ref: '#/components/schemas/_common___VersionNumber' _meta: - $ref: '#/components/schemas/_common:Metadata' + $ref: '#/components/schemas/_common___Metadata' description: New index template definition, which will be included in the simulation, as if it already exists in the system indices.simulate_template: content: application/json: schema: - $ref: '#/components/schemas/indices._common:IndexTemplate' + $ref: '#/components/schemas/indices._common___IndexTemplate' indices.split: content: application/json: @@ -25797,7 +26663,7 @@ components: description: Aliases for the resulting index. type: object additionalProperties: - $ref: '#/components/schemas/indices._common:Alias' + $ref: '#/components/schemas/indices._common___Alias' settings: description: Configuration options for the target index. type: object @@ -25813,7 +26679,7 @@ components: description: Actions to perform. type: array items: - $ref: '#/components/schemas/indices.update_aliases:Action' + $ref: '#/components/schemas/indices.update_aliases___Action' description: The definition of `actions` to perform required: true indices.validate_query: @@ -25823,7 +26689,7 @@ components: type: object properties: query: - $ref: '#/components/schemas/_common.query_dsl:QueryContainer' + $ref: '#/components/schemas/_common.query_dsl___QueryContainer' description: The query definition specified with the Query DSL ingest.put_pipeline: content: @@ -25832,7 +26698,7 @@ components: type: object properties: _meta: - $ref: '#/components/schemas/_common:Metadata' + $ref: '#/components/schemas/_common___Metadata' description: description: Description of the ingest pipeline. type: string @@ -25840,14 +26706,14 @@ components: description: Processors to run immediately after a processor failure. Each processor supports a processor-level `on_failure` value. If a processor without an `on_failure` value fails, OpenSearch uses this pipeline-level parameter as a fallback. The processors in this parameter run sequentially in the order specified. OpenSearch will not attempt to run the pipeline's remaining processors. type: array items: - $ref: '#/components/schemas/ingest._common:ProcessorContainer' + $ref: '#/components/schemas/ingest._common___ProcessorContainer' processors: description: Processors used to perform transformations on documents before indexing. Processors run sequentially in the order specified. type: array items: - $ref: '#/components/schemas/ingest._common:ProcessorContainer' + $ref: '#/components/schemas/ingest._common___ProcessorContainer' version: - $ref: '#/components/schemas/_common:VersionNumber' + $ref: '#/components/schemas/_common___VersionNumber' description: The ingest definition required: true ingest.simulate: @@ -25860,21 +26726,21 @@ components: description: Sample documents to test in the pipeline. type: array items: - $ref: '#/components/schemas/ingest.simulate:Document' + $ref: '#/components/schemas/ingest.simulate___Document' pipeline: - $ref: '#/components/schemas/ingest._common:Pipeline' + $ref: '#/components/schemas/ingest._common___Pipeline' description: The simulate definition required: true ism.add_policy: content: application/json: schema: - $ref: '#/components/schemas/ism._common:AddPolicyRequest' + $ref: '#/components/schemas/ism._common___AddPolicyRequest' ism.change_policy: content: application/json: schema: - $ref: '#/components/schemas/ism._common:ChangePolicyRequest' + $ref: '#/components/schemas/ism._common___ChangePolicyRequest' ism.explain_policy: content: application/json: @@ -25883,17 +26749,17 @@ components: content: application/json: schema: - $ref: '#/components/schemas/ism._common:PutPolicyRequest' + $ref: '#/components/schemas/ism._common___PutPolicyRequest' ism.put_policy: content: application/json: schema: - $ref: '#/components/schemas/ism._common:PutPolicyRequest' + $ref: '#/components/schemas/ism._common___PutPolicyRequest' ism.retry_index: content: application/json: schema: - $ref: '#/components/schemas/ism._common:RetryIndexRequest' + $ref: '#/components/schemas/ism._common___RetryIndexRequest' knn.search_models: content: application/json: @@ -25943,21 +26809,21 @@ components: description: The documents you want to retrieve. Required if no index is specified in the request URI. type: array items: - $ref: '#/components/schemas/_core.mget:Operation' + $ref: '#/components/schemas/_core.mget___Operation' ids: - $ref: '#/components/schemas/_common:Ids' + $ref: '#/components/schemas/_common___Ids' description: Document identifiers; can be either `docs` (containing full document information) or `ids` (when index is provided in the URL. required: true ml.create_connector: content: application/json: schema: - $ref: '#/components/schemas/ml._common:CreateConnectorRequest' + $ref: '#/components/schemas/ml._common___CreateConnectorRequest' ml.register_agents: content: application/json: schema: - $ref: '#/components/schemas/ml._common:RegisterAgentsRequest' + $ref: '#/components/schemas/ml._common___RegisterAgentsRequest' ml.register_model: content: application/json: @@ -26019,14 +26885,14 @@ components: content: application/json: schema: - $ref: '#/components/schemas/ml._common:SearchModelsQuery' + $ref: '#/components/schemas/ml._common___SearchModelsQuery' msearch: content: application/x-ndjson: schema: type: array items: - $ref: '#/components/schemas/_core.msearch:RequestItem' + $ref: '#/components/schemas/_core.msearch___RequestItem' description: The request definitions (metadata-search request definition pairs), separated by newlines required: true msearch_template: @@ -26035,7 +26901,7 @@ components: schema: type: array items: - $ref: '#/components/schemas/_core.msearch_template:RequestItem' + $ref: '#/components/schemas/_core.msearch_template___RequestItem' description: The request definitions (metadata-search request definition pairs), separated by newlines required: true mtermvectors: @@ -26048,12 +26914,12 @@ components: description: Array of existing or artificial documents. type: array items: - $ref: '#/components/schemas/_core.mtermvectors:Operation' + $ref: '#/components/schemas/_core.mtermvectors___Operation' ids: description: Simplified syntax to specify documents by their ID if they're in the same index. type: array items: - $ref: '#/components/schemas/_common:Id' + $ref: '#/components/schemas/_common___Id' description: Define ids, documents, parameters or a list of parameters per document here. You must at least provide a list of document ids. See documentation. nodes.reload_secure_settings: content: @@ -26062,13 +26928,13 @@ components: type: object properties: secure_settings_password: - $ref: '#/components/schemas/_common:Password' - description: An object containing the password for the opensearch keystore + $ref: '#/components/schemas/_common___Password' + description: An object containing the password for the OpenSearch keystore. notifications.create_config: content: application/json: schema: - $ref: '#/components/schemas/notifications._common:NotificationsConfig' + $ref: '#/components/schemas/notifications._common___NotificationsConfig' required: true notifications.get_configs: content: @@ -26094,35 +26960,35 @@ components: content: application/json: schema: - $ref: '#/components/schemas/notifications._common:NotificationsConfig' + $ref: '#/components/schemas/notifications._common___NotificationsConfig' required: true observability.create_object: content: application/json: schema: - $ref: '#/components/schemas/observability._common:ObservabilityObject' + $ref: '#/components/schemas/observability._common___ObservabilityObject' observability.update_object: content: application/json: schema: - $ref: '#/components/schemas/observability._common:ObservabilityObject' + $ref: '#/components/schemas/observability._common___ObservabilityObject' ppl.explain: content: application/json: schema: - $ref: '#/components/schemas/sql._common:Explain' + $ref: '#/components/schemas/sql._common___Explain' required: true ppl.post_stats: content: application/json: schema: - $ref: '#/components/schemas/sql._common:Stats' + $ref: '#/components/schemas/sql._common___Stats' required: true ppl.query: content: application/json: schema: - $ref: '#/components/schemas/sql._common:Query' + $ref: '#/components/schemas/sql._common___Query' required: true put_script: content: @@ -26131,7 +26997,7 @@ components: type: object properties: script: - $ref: '#/components/schemas/_common:StoredScript' + $ref: '#/components/schemas/_common___StoredScript' required: - script description: The document @@ -26140,12 +27006,12 @@ components: content: application/json: schema: - $ref: '#/components/schemas/query._common:DataSource' + $ref: '#/components/schemas/query._common___DataSource' query.datasources_update: content: application/json: schema: - $ref: '#/components/schemas/query._common:DataSource' + $ref: '#/components/schemas/query._common___DataSource' rank_eval: content: application/json: @@ -26156,9 +27022,9 @@ components: description: A set of typical search requests, together with their provided ratings. type: array items: - $ref: '#/components/schemas/_core.rank_eval:RankEvalRequestItem' + $ref: '#/components/schemas/_core.rank_eval___RankEvalRequestItem' metric: - $ref: '#/components/schemas/_core.rank_eval:RankEvalMetric' + $ref: '#/components/schemas/_core.rank_eval___RankEvalMetric' required: - requests description: The ranking evaluation search definition, including search requests, document ratings and ranking metric definition. @@ -26170,20 +27036,20 @@ components: type: object properties: conflicts: - $ref: '#/components/schemas/_common:Conflicts' + $ref: '#/components/schemas/_common___Conflicts' dest: - $ref: '#/components/schemas/_core.reindex:Destination' + $ref: '#/components/schemas/_core.reindex___Destination' max_docs: description: The maximum number of documents to reindex. type: integer format: int32 script: - $ref: '#/components/schemas/_common:Script' + $ref: '#/components/schemas/_common___Script' size: type: integer format: int32 source: - $ref: '#/components/schemas/_core.reindex:Source' + $ref: '#/components/schemas/_core.reindex___Source' required: - dest - source @@ -26228,16 +27094,58 @@ components: source: description: |- An inline search template. - Supports the same parameters as the search API's request body. + Supports the same parameters as the search API request body. These parameters also support Mustache variables. If no `id` or `` is specified, this parameter is required. type: string - description: The search definition template and its params + description: The search definition template and its parameters. + replication.create_replication_rule: + content: + application/json: + schema: + $ref: '#/components/schemas/replication._common___CreateReplicationRule' + required: true + replication.delete_replication_rule: + content: + application/json: + schema: + $ref: '#/components/schemas/replication._common___DeleteReplicationRule' + required: true + replication.pause: + content: + application/json: + schema: + type: object + required: true + replication.resume: + content: + application/json: + schema: + type: object + required: true + replication.start: + content: + application/json: + schema: + $ref: '#/components/schemas/replication._common___Replication' + required: true + replication.stop: + content: + application/json: + schema: + type: object + required: true + replication.update_settings: + content: + application/json: + schema: + $ref: '#/components/schemas/replication._common___UpdateSettings' + required: true rollups.put: content: application/json: schema: - $ref: '#/components/schemas/rollups._common:RollupEntity' + $ref: '#/components/schemas/rollups._common___RollupEntity' scripts_painless_execute: content: application/json: @@ -26248,9 +27156,9 @@ components: description: The context that the script should run in. type: string context_setup: - $ref: '#/components/schemas/_core.scripts_painless_execute:PainlessContextSetup' + $ref: '#/components/schemas/_core.scripts_painless_execute___PainlessContextSetup' script: - $ref: '#/components/schemas/_common:InlineScript' + $ref: '#/components/schemas/_common___InlineScript' description: The script to execute scroll: content: @@ -26259,9 +27167,9 @@ components: type: object properties: scroll: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' scroll_id: - $ref: '#/components/schemas/_common:ScrollId' + $ref: '#/components/schemas/_common___ScrollId' required: - scroll_id description: The scroll ID if not passed by URL or query parameter. @@ -26275,11 +27183,11 @@ components: description: Defines the aggregations that are run as part of the search request. type: object additionalProperties: - $ref: '#/components/schemas/_common.aggregations:AggregationContainer' + $ref: '#/components/schemas/_common.aggregations___AggregationContainer' collapse: - $ref: '#/components/schemas/_core.search:FieldCollapse' + $ref: '#/components/schemas/_core.search___FieldCollapse' explain: - description: If true, returns detailed information about score computation as part of a hit. + 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. @@ -26295,11 +27203,11 @@ components: type: integer format: int32 highlight: - $ref: '#/components/schemas/_core.search:Highlight' + $ref: '#/components/schemas/_core.search___Highlight' track_total_hits: - $ref: '#/components/schemas/_core.search:TrackHits' + $ref: '#/components/schemas/_core.search___TrackHits' indices_boost: - description: Boosts the _score of documents from specified indices. + description: Boosts the `_score` of documents from specified indexes. type: array items: type: object @@ -26312,9 +27220,9 @@ components: 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' + $ref: '#/components/schemas/_common.query_dsl___FieldAndFormat' rank: - $ref: '#/components/schemas/_common:RankContainer' + $ref: '#/components/schemas/_common___RankContainer' min_score: description: |- Minimum `_score` for matching documents. @@ -26322,28 +27230,28 @@ components: type: number format: float post_filter: - $ref: '#/components/schemas/_common.query_dsl:QueryContainer' + $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' + $ref: '#/components/schemas/_common.query_dsl___QueryContainer' rescore: description: Can be used to improve precision by reordering just the top (for example 100 - 500) documents returned by the `query` and `post_filter` phases. oneOf: - - $ref: '#/components/schemas/_core.search:Rescore' + - $ref: '#/components/schemas/_core.search___Rescore' - type: array items: - $ref: '#/components/schemas/_core.search:Rescore' + $ref: '#/components/schemas/_core.search___Rescore' script_fields: description: Retrieve a script evaluation (based on different fields) for each hit. type: object additionalProperties: - $ref: '#/components/schemas/_common:ScriptField' + $ref: '#/components/schemas/_common___ScriptField' search_after: - $ref: '#/components/schemas/_common:SortResults' + $ref: '#/components/schemas/_common___SortResults' size: description: |- The number of hits to return. @@ -26352,20 +27260,20 @@ components: type: integer format: int32 slice: - $ref: '#/components/schemas/_common:SlicedScroll' + $ref: '#/components/schemas/_common___SlicedScroll' sort: - $ref: '#/components/schemas/_common:Sort' + $ref: '#/components/schemas/_common___Sort' _source: - $ref: '#/components/schemas/_core.search:SourceConfig' + $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' + $ref: '#/components/schemas/_common.query_dsl___FieldAndFormat' suggest: - $ref: '#/components/schemas/_core.search:Suggester' + $ref: '#/components/schemas/_core.search___Suggester' terminate_after: description: |- Maximum number of documents to collect for each shard. @@ -26374,7 +27282,7 @@ components: 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. + Avoid specifying this parameter for requests that target data streams with backing indexes across multiple data tiers. If set to `0` (default), the query does not terminate early. type: integer format: int32 @@ -26385,25 +27293,23 @@ components: 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. + 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. + 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' + $ref: '#/components/schemas/_common___Fields' pit: - $ref: '#/components/schemas/_core.search:PointInTimeReference' - runtime_mappings: - $ref: '#/components/schemas/_common.mapping:RuntimeFields' + $ref: '#/components/schemas/_core.search___PointInTimeReference' 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. + You can retrieve these stats using the indexes stats API. type: array items: type: string @@ -26412,7 +27318,7 @@ components: content: application/json: schema: - $ref: '#/components/schemas/search_pipeline._common:SearchPipelineStructure' + $ref: '#/components/schemas/search_pipeline._common___SearchPipelineStructure' required: true search_template: content: @@ -26424,7 +27330,7 @@ components: description: If `true`, returns detailed information about score calculation as part of each hit. type: boolean id: - $ref: '#/components/schemas/_common:Id' + $ref: '#/components/schemas/_common___Id' params: description: |- Key-value pairs used to replace Mustache variables in the template. @@ -26438,76 +27344,76 @@ components: type: boolean source: description: |- - An inline search template. Supports the same parameters as the search API's + An inline search template. Supports the same parameters as the search API request body. Also supports Mustache variables. If no id is specified, this parameter is required. type: string - description: The search definition template and its params + description: The search definition template and its parameters. required: true security.change_password: content: application/json: schema: - $ref: '#/components/schemas/security._common:ChangePasswordRequestContent' + $ref: '#/components/schemas/security._common___ChangePasswordRequestContent' required: true security.config_upgrade_perform: content: application/json: schema: - $ref: '#/components/schemas/security._common:ConfigUpgradePayload' + $ref: '#/components/schemas/security._common___ConfigUpgradePayload' security.create_action_group: content: application/json: schema: - $ref: '#/components/schemas/security._common:ActionGroup' + $ref: '#/components/schemas/security._common___ActionGroup' required: true security.create_allowlist: content: application/json: schema: - $ref: '#/components/schemas/security._common:AllowListConfig' + $ref: '#/components/schemas/security._common___AllowListConfig' required: true security.create_role: content: application/json: schema: - $ref: '#/components/schemas/security._common:Role' + $ref: '#/components/schemas/security._common___Role' required: true security.create_role_mapping: content: application/json: schema: - $ref: '#/components/schemas/security._common:RoleMapping' + $ref: '#/components/schemas/security._common___RoleMapping' required: true security.create_tenant: content: application/json: schema: - $ref: '#/components/schemas/security._common:CreateTenantParams' + $ref: '#/components/schemas/security._common___CreateTenantParams' required: true security.create_update_tenancy_config: content: application/json: schema: - $ref: '#/components/schemas/security._common:MultiTenancyConfig' + $ref: '#/components/schemas/security._common___MultiTenancyConfig' required: true security.create_user: content: application/json: schema: - $ref: '#/components/schemas/security._common:User' + $ref: '#/components/schemas/security._common___User' required: true security.create_user_legacy: content: application/json: schema: - $ref: '#/components/schemas/security._common:User' + $ref: '#/components/schemas/security._common___User' required: true security.generate_obo_token: content: application/json: schema: - $ref: '#/components/schemas/security._common:OBOToken' + $ref: '#/components/schemas/security._common___OBOToken' required: true security.patch_action_group: content: @@ -26515,7 +27421,7 @@ components: schema: type: array items: - $ref: '#/components/schemas/security._common:PatchOperation' + $ref: '#/components/schemas/security._common___PatchOperation' required: true security.patch_action_groups: content: @@ -26523,7 +27429,7 @@ components: schema: type: array items: - $ref: '#/components/schemas/security._common:PatchOperation' + $ref: '#/components/schemas/security._common___PatchOperation' required: true security.patch_allowlist: content: @@ -26531,7 +27437,7 @@ components: schema: type: array items: - $ref: '#/components/schemas/security._common:PatchOperation' + $ref: '#/components/schemas/security._common___PatchOperation' required: true security.patch_audit_configuration: content: @@ -26539,7 +27445,7 @@ components: schema: type: array items: - $ref: '#/components/schemas/security._common:PatchOperation' + $ref: '#/components/schemas/security._common___PatchOperation' required: true security.patch_configuration: content: @@ -26547,20 +27453,20 @@ components: schema: type: array items: - $ref: '#/components/schemas/security._common:PatchOperation' + $ref: '#/components/schemas/security._common___PatchOperation' required: true security.patch_distinguished_name: content: application/json: schema: - $ref: '#/components/schemas/security._common:PatchOperation' + $ref: '#/components/schemas/security._common___PatchOperation' security.patch_distinguished_names: content: application/json: schema: type: array items: - $ref: '#/components/schemas/security._common:PatchOperation' + $ref: '#/components/schemas/security._common___PatchOperation' required: true security.patch_role: content: @@ -26568,7 +27474,7 @@ components: schema: type: array items: - $ref: '#/components/schemas/security._common:PatchOperation' + $ref: '#/components/schemas/security._common___PatchOperation' required: true security.patch_role_mapping: content: @@ -26576,7 +27482,7 @@ components: schema: type: array items: - $ref: '#/components/schemas/security._common:PatchOperation' + $ref: '#/components/schemas/security._common___PatchOperation' required: true security.patch_role_mappings: content: @@ -26584,7 +27490,7 @@ components: schema: type: array items: - $ref: '#/components/schemas/security._common:PatchOperation' + $ref: '#/components/schemas/security._common___PatchOperation' required: true security.patch_roles: content: @@ -26592,7 +27498,7 @@ components: schema: type: array items: - $ref: '#/components/schemas/security._common:PatchOperation' + $ref: '#/components/schemas/security._common___PatchOperation' required: true security.patch_tenant: content: @@ -26600,7 +27506,7 @@ components: schema: type: array items: - $ref: '#/components/schemas/security._common:PatchOperation' + $ref: '#/components/schemas/security._common___PatchOperation' required: true security.patch_tenants: content: @@ -26608,7 +27514,7 @@ components: schema: type: array items: - $ref: '#/components/schemas/security._common:PatchOperation' + $ref: '#/components/schemas/security._common___PatchOperation' required: true security.patch_user: content: @@ -26616,7 +27522,7 @@ components: schema: type: array items: - $ref: '#/components/schemas/security._common:PatchOperation' + $ref: '#/components/schemas/security._common___PatchOperation' required: true security.patch_users: content: @@ -26624,25 +27530,25 @@ components: schema: type: array items: - $ref: '#/components/schemas/security._common:PatchOperation' + $ref: '#/components/schemas/security._common___PatchOperation' required: true security.update_audit_configuration: content: application/json: schema: - $ref: '#/components/schemas/security._common:AuditConfig' + $ref: '#/components/schemas/security._common___AuditConfig' required: true security.update_configuration: content: application/json: schema: - $ref: '#/components/schemas/security._common:DynamicConfig' + $ref: '#/components/schemas/security._common___DynamicConfig' required: true security.update_distinguished_name: content: application/json: schema: - $ref: '#/components/schemas/security._common:DistinguishedNames' + $ref: '#/components/schemas/security._common___DistinguishedNames' snapshot.clone: content: application/json: @@ -26662,22 +27568,22 @@ components: type: object properties: ignore_unavailable: - description: If `true`, the request ignores data streams and indices in `indices` that are missing or closed. If `false`, the request returns an error for any data stream or index that is missing or closed. + description: If `true`, the request ignores data streams and indexes in `indexes` that are missing or closed. If `false`, the request returns an error for any data stream or index that is missing or closed. type: boolean include_global_state: - description: If `true`, the current cluster state is included in the snapshot. The cluster state includes persistent cluster settings, composable index templates, legacy index templates, ingest pipelines, and ILM policies. It also includes data stored in system indices, such as Watches and task records (configurable via `feature_states`). + description: If `true`, the current cluster state is included in the snapshot. The cluster state includes persistent cluster settings, composable index templates, legacy index templates, ingest pipelines, and ILM policies. It also includes data stored in system indexes, such as Watches and task records (configurable with `feature_states`). type: boolean indices: - $ref: '#/components/schemas/_common:Indices' + $ref: '#/components/schemas/_common___Indices' feature_states: - description: Feature states to include in the snapshot. Each feature state includes one or more system indices containing related data. You can view a list of eligible features using the get features API. If `include_global_state` is `true`, all current feature states are included by default. If `include_global_state` is `false`, no feature states are included by default. + description: Feature states to include in the snapshot. Each feature state includes one or more system indexes containing related data. You can view a list of eligible features using the get features API. If `include_global_state` is `true`, all current feature states are included by default. If `include_global_state` is `false`, no feature states are included by default. type: array items: type: string metadata: - $ref: '#/components/schemas/_common:Metadata' + $ref: '#/components/schemas/_common___Metadata' partial: - description: If `true`, allows restoring a partial snapshot of indices with unavailable shards. Only shards that were successfully included in the snapshot will be restored. All missing shards will be recreated as empty. If `false`, the entire restore operation will fail if one or more indices included in the snapshot do not have all primary shards available. + description: If `true`, allows restoring a partial snapshot of indexes with unavailable shards. Only shards that were successfully included in the snapshot will be restored. All missing shards will be recreated as empty. If `false`, the entire restore operation will fail if one or more indexes included in the snapshot do not have all primary shards available. type: boolean description: The snapshot definition snapshot.create_repository: @@ -26687,11 +27593,11 @@ components: type: object properties: repository: - $ref: '#/components/schemas/snapshot._common:Repository' + $ref: '#/components/schemas/snapshot._common___Repository' type: type: string settings: - $ref: '#/components/schemas/snapshot._common:RepositorySettings' + $ref: '#/components/schemas/snapshot._common___RepositorySettings' required: - settings - type @@ -26703,63 +27609,95 @@ components: schema: type: object properties: - feature_states: - type: array - items: - type: string ignore_index_settings: + description: A comma-delimited list of index settings that you don't want to restore from a snapshot. type: array items: type: string ignore_unavailable: type: boolean + description: How to handle data streams or indexes that are missing or closed. If `false`, the request returns an error for any data stream or index that is missing or closed. If `true`, the request ignores data streams and indexes in indexes that are missing or closed. Defaults to `false`. include_aliases: type: boolean + description: How to handle index aliases from the original snapshot. If `true`, index aliases from the original snapshot are restored. If `false`, aliases along with associated indexes are not restored. Defaults to `true`. include_global_state: type: boolean + description: Whether to restore the current cluster state. If `false`, the cluster state is not restored. If true, the current cluster state is restored. Defaults to `false`. index_settings: - $ref: '#/components/schemas/indices._common:IndexSettings' + description: A comma-delimited list of settings to add or change in all restored indexes. Use this parameter to override index settings during snapshot restoration. For data streams, these index settings are applied to the restored backing indexes. + $ref: '#/components/schemas/indices._common___IndexSettings' indices: - $ref: '#/components/schemas/_common:Indices' + description: A comma-delimited list of data streams and indexes to restore from the snapshot. Multi-index syntax is supported. By default, a restore operation includes all data streams and indexes in the snapshot. If this argument is provided, the restore operation only includes the data streams and indexes that you specify. + $ref: '#/components/schemas/_common___Indices' partial: type: boolean + description: |- + How the restore operation will behave if indexes in the snapshot do not have all primary shards available. + If `false`, the entire restore operation fails if any indexes in the snapshot do not have all primary shards available. + If `true`, allows the restoration of a partial snapshot of indexes with unavailable shards. Only shards that were successfully included in the snapshot are restored. All missing shards are recreated as empty. By default, the entire restore operation fails if one or more indexes included in the snapshot do not have all primary shards available. To change this behavior, set `partial` to `true`. + Defaults to `false`. rename_pattern: type: string + description: |- + The pattern to apply to the restored data streams and indexes. Data streams and indexes matching the rename pattern will be renamed according to the `rename_replacement` setting. + The rename pattern is applied as defined by the regular expression that supports referencing the original text. + The request fails if two or more data streams or indexes are renamed into the same name. + If you rename a restored data stream, its backing indexes are also renamed. For example, if you rename the logs data stream to `recovered-logs`, the backing index `.ds-logs-1` is renamed to `.ds-recovered-logs-1`. + If you rename a restored stream, ensure an index template matches the new stream name. If there are no matching index template names, the stream cannot roll over and new backing indexes are not created. rename_replacement: type: string + description: The rename replacement string. + rename_alias_pattern: + x-version-added: '2.18' + type: string + description: |- + The pattern to apply to the restored aliases. Aliases matching the rename pattern will be renamed according to the `rename_alias_replacement` setting. + The rename pattern is applied as defined by the regular expression that supports referencing the original text. + If two or more aliases are renamed into the same name, these aliases will be merged into one. + rename_alias_replacement: + x-version-added: '2.18' + type: string + description: The rename replacement string for aliases. + source_remote_store_repository: + x-version-added: '2.10' + type: string + description: The name of the remote store repository of the source index being restored. If not provided, the Snapshot Restore API will use the repository that was registered when the snapshot was created. + storage_type: + x-version-added: '2.7' + type: string + description: |- + Where will be the authoritative store of the restored indexes' data. + A value of `local` indicates that all snapshot metadata and index data will be downloaded to local storage. + A value of `remote_snapshot` indicates that snapshot metadata will be downloaded to the cluster, but the remote repository will remain the authoritative store of the index data. Data will be downloaded and cached as necessary to service queries. At least one node in the cluster must be configured with the search role in order to restore a snapshot using the type `remote_snapshot`. + Defaults to `local`. description: Details of what to restore sql.close: content: application/json: schema: - $ref: '#/components/schemas/sql._common:SqlClose' - required: true + $ref: '#/components/schemas/sql._common___SqlClose' sql.explain: content: application/json: schema: - $ref: '#/components/schemas/sql._common:Explain' - required: true + $ref: '#/components/schemas/sql._common___Explain' sql.post_stats: content: application/json: schema: - $ref: '#/components/schemas/sql._common:Stats' - required: true + $ref: '#/components/schemas/sql._common___Stats' sql.query: content: application/json: schema: - $ref: '#/components/schemas/sql._common:Query' - required: true + $ref: '#/components/schemas/sql._common___Query' sql.settings: content: application/json: schema: anyOf: - - $ref: '#/components/schemas/sql._common:SqlSettingsPlain' - - $ref: '#/components/schemas/sql._common:SqlSettings' - required: true + - $ref: '#/components/schemas/sql._common___SqlSettingsPlain' + - $ref: '#/components/schemas/sql._common___SqlSettings' termvectors: content: application/json: @@ -26770,7 +27708,7 @@ components: description: An artificial document (a document not present in the index) for which you want to retrieve term vectors. type: object filter: - $ref: '#/components/schemas/_core.termvectors:Filter' + $ref: '#/components/schemas/_core.termvectors___Filter' per_field_analyzer: description: Overrides the default per-field analyzer. type: object @@ -26784,14 +27722,14 @@ components: type: object properties: transform: - $ref: '#/components/schemas/transforms._common:Transform' + $ref: '#/components/schemas/transforms._common___Transform' required: - transform transforms.put: content: application/json: schema: - $ref: '#/components/schemas/transforms._common:Transform' + $ref: '#/components/schemas/transforms._common___Transform' update: content: application/json: @@ -26800,22 +27738,22 @@ components: properties: detect_noop: description: |- - Set to false to disable setting 'result' in the response - to 'noop' if no change to the document occurred. + Set to `false` to disable setting `result` in the response + to `noop` if no change to the document occurred. type: boolean doc: description: A partial update to an existing document. type: object doc_as_upsert: - description: Set to true to use the contents of 'doc' as the value of 'upsert' + description: Set to `true` to use the contents of 'doc' as the value of 'upsert' type: boolean script: - $ref: '#/components/schemas/_common:Script' + $ref: '#/components/schemas/_common___Script' scripted_upsert: - description: Set to true to execute the script whether or not the document exists. + description: Set to `true` to execute the script whether or not the document exists. type: boolean _source: - $ref: '#/components/schemas/_core.search:SourceConfig' + $ref: '#/components/schemas/_core.search___SourceConfig' upsert: description: |- If the document does not already exist, the contents of 'upsert' are inserted as a @@ -26834,16 +27772,28 @@ components: type: integer format: int32 query: - $ref: '#/components/schemas/_common.query_dsl:QueryContainer' + $ref: '#/components/schemas/_common.query_dsl___QueryContainer' script: - $ref: '#/components/schemas/_common:Script' + $ref: '#/components/schemas/_common___Script' slice: - $ref: '#/components/schemas/_common:SlicedScroll' + $ref: '#/components/schemas/_common___SlicedScroll' conflicts: - $ref: '#/components/schemas/_common:Conflicts' + $ref: '#/components/schemas/_common___Conflicts' description: The search definition using the Query DSL + wlm.create_query_group: + content: + application/json: + schema: + $ref: '#/components/schemas/wlm._common___QueryGroupCreate' + required: true + wlm.update_query_group: + content: + application/json: + schema: + $ref: '#/components/schemas/wlm._common___QueryGroupUpdate' + required: true responses: - asynchronous_search.delete@200: + asynchronous_search.delete___200: content: application/json: schema: @@ -26851,22 +27801,26 @@ components: properties: acknowledged: type: boolean - asynchronous_search.get@200: + description: '' + asynchronous_search.get___200: content: application/json: schema: - $ref: '#/components/schemas/asynchronous_search._common:ResponseBody' - asynchronous_search.search@200: + $ref: '#/components/schemas/asynchronous_search._common___ResponseBody' + description: '' + asynchronous_search.search___200: content: application/json: schema: - $ref: '#/components/schemas/asynchronous_search._common:ResponseBody' - asynchronous_search.stats@200: + $ref: '#/components/schemas/asynchronous_search._common___ResponseBody' + description: '' + asynchronous_search.stats___200: content: application/json: schema: - $ref: '#/components/schemas/asynchronous_search._common:StatsResponse' - bulk_stream@200: + $ref: '#/components/schemas/asynchronous_search._common___StatsResponse' + description: '' + bulk_stream___200: content: application/json: schema: @@ -26879,7 +27833,7 @@ components: items: type: object additionalProperties: - $ref: '#/components/schemas/_core.bulk:ResponseItem' + $ref: '#/components/schemas/_core.bulk___ResponseItem' minProperties: 1 maxProperties: 1 took: @@ -26892,7 +27846,8 @@ components: - errors - items - took - bulk@200: + description: '' + bulk___200: content: application/json: schema: @@ -26905,7 +27860,7 @@ components: items: type: object additionalProperties: - $ref: '#/components/schemas/_core.bulk:ResponseItem' + $ref: '#/components/schemas/_core.bulk___ResponseItem' minProperties: 1 maxProperties: 1 took: @@ -26918,249 +27873,297 @@ components: - errors - items - took - cat.aliases@200: + description: '' + cat.aliases___200: content: text/plain: - type: string + schema: + type: string application/json: schema: type: array items: - $ref: '#/components/schemas/cat.aliases:AliasesRecord' - cat.all_pit_segments@200: + $ref: '#/components/schemas/cat.aliases___AliasesRecord' + description: '' + cat.all_pit_segments___200: content: text/plain: - type: string + schema: + type: string application/json: schema: type: array items: - $ref: '#/components/schemas/cat._common:CatPitSegmentsRecord' - cat.allocation@200: + $ref: '#/components/schemas/cat._common___CatPitSegmentsRecord' + description: '' + cat.allocation___200: content: text/plain: - type: string + schema: + type: string application/json: schema: type: array items: - $ref: '#/components/schemas/cat.allocation:AllocationRecord' - cat.cluster_manager@200: + $ref: '#/components/schemas/cat.allocation___AllocationRecord' + description: '' + cat.cluster_manager___200: content: text/plain: - type: string + schema: + type: string application/json: schema: type: array items: - $ref: '#/components/schemas/cat.cluster_manager:ClusterManagerRecord' - cat.count@200: + $ref: '#/components/schemas/cat.cluster_manager___ClusterManagerRecord' + description: '' + cat.count___200: content: text/plain: - type: string + schema: + type: string application/json: schema: type: array items: - $ref: '#/components/schemas/cat.count:CountRecord' - cat.fielddata@200: + $ref: '#/components/schemas/cat.count___CountRecord' + description: '' + cat.fielddata___200: content: text/plain: - type: string + schema: + type: string application/json: schema: type: array items: - $ref: '#/components/schemas/cat.fielddata:FielddataRecord' - cat.health@200: + $ref: '#/components/schemas/cat.fielddata___FielddataRecord' + description: '' + cat.health___200: content: text/plain: - type: string + schema: + type: string application/json: schema: type: array items: - $ref: '#/components/schemas/cat.health:HealthRecord' + $ref: '#/components/schemas/cat.health___HealthRecord' application/yaml: schema: type: array items: - $ref: '#/components/schemas/cat.health:HealthRecord' + $ref: '#/components/schemas/cat.health___HealthRecord' application/cbor: schema: type: array items: - $ref: '#/components/schemas/cat.health:HealthRecord' + $ref: '#/components/schemas/cat.health___HealthRecord' application/smile: schema: type: array items: - $ref: '#/components/schemas/cat.health:HealthRecord' - cat.help@200: + $ref: '#/components/schemas/cat.health___HealthRecord' + description: '' + cat.help___200: content: text/plain: schema: type: string - cat.indices@200: + description: '' + cat.indices___200: content: text/plain: - type: string + schema: + type: string application/json: schema: type: array items: - $ref: '#/components/schemas/cat.indices:IndicesRecord' + $ref: '#/components/schemas/cat.indices___IndicesRecord' application/yaml: schema: type: array items: - $ref: '#/components/schemas/cat.indices:IndicesRecord' + $ref: '#/components/schemas/cat.indices___IndicesRecord' application/cbor: schema: type: array items: - $ref: '#/components/schemas/cat.indices:IndicesRecord' + $ref: '#/components/schemas/cat.indices___IndicesRecord' application/smile: schema: type: array items: - $ref: '#/components/schemas/cat.indices:IndicesRecord' - cat.master@200: + $ref: '#/components/schemas/cat.indices___IndicesRecord' + description: '' + cat.master___200: content: text/plain: - type: string + schema: + type: string application/json: schema: type: array items: - $ref: '#/components/schemas/cat.master:MasterRecord' - cat.nodeattrs@200: + $ref: '#/components/schemas/cat.master___MasterRecord' + description: '' + cat.nodeattrs___200: content: text/plain: - type: string + schema: + type: string application/json: schema: type: array items: - $ref: '#/components/schemas/cat.nodeattrs:NodeAttributesRecord' - cat.nodes@200: + $ref: '#/components/schemas/cat.nodeattrs___NodeAttributesRecord' + description: '' + cat.nodes___200: content: text/plain: - type: string + schema: + type: string application/json: schema: type: array items: - $ref: '#/components/schemas/cat.nodes:NodesRecord' - cat.pending_tasks@200: + $ref: '#/components/schemas/cat.nodes___NodesRecord' + description: '' + cat.pending_tasks___200: content: text/plain: - type: string + schema: + type: string application/json: schema: type: array items: - $ref: '#/components/schemas/cat.pending_tasks:PendingTasksRecord' - cat.pit_segments@200: + $ref: '#/components/schemas/cat.pending_tasks___PendingTasksRecord' + description: '' + cat.pit_segments___200: content: text/plain: - type: string + schema: + type: string application/json: schema: type: array items: - $ref: '#/components/schemas/cat._common:CatPitSegmentsRecord' - cat.plugins@200: + $ref: '#/components/schemas/cat._common___CatPitSegmentsRecord' + description: '' + cat.plugins___200: content: text/plain: - type: string + schema: + type: string application/json: schema: type: array items: - $ref: '#/components/schemas/cat.plugins:PluginsRecord' - cat.recovery@200: + $ref: '#/components/schemas/cat.plugins___PluginsRecord' + description: '' + cat.recovery___200: content: text/plain: - type: string + schema: + type: string application/json: schema: type: array items: - $ref: '#/components/schemas/cat.recovery:RecoveryRecord' - cat.repositories@200: + $ref: '#/components/schemas/cat.recovery___RecoveryRecord' + description: '' + cat.repositories___200: content: text/plain: - type: string + schema: + type: string application/json: schema: type: array items: - $ref: '#/components/schemas/cat.repositories:RepositoriesRecord' - cat.segment_replication@200: + $ref: '#/components/schemas/cat.repositories___RepositoriesRecord' + description: '' + cat.segment_replication___200: content: text/plain: - type: string + schema: + type: string application/json: schema: type: array items: - $ref: '#/components/schemas/cat._common:CatSegmentReplicationRecord' - cat.segments@200: + $ref: '#/components/schemas/cat._common___CatSegmentReplicationRecord' + description: '' + cat.segments___200: content: text/plain: - type: string + schema: + type: string application/json: schema: type: array items: - $ref: '#/components/schemas/cat.segments:SegmentsRecord' - cat.shards@200: + $ref: '#/components/schemas/cat.segments___SegmentsRecord' + description: '' + cat.shards___200: content: text/plain: - type: string + schema: + type: string application/json: schema: type: array items: - $ref: '#/components/schemas/cat.shards:ShardsRecord' - cat.snapshots@200: + $ref: '#/components/schemas/cat.shards___ShardsRecord' + description: '' + cat.snapshots___200: content: text/plain: - type: string + schema: + type: string application/json: schema: type: array items: - $ref: '#/components/schemas/cat.snapshots:SnapshotsRecord' - cat.tasks@200: + $ref: '#/components/schemas/cat.snapshots___SnapshotsRecord' + description: '' + cat.tasks___200: content: text/plain: - type: string + schema: + type: string application/json: schema: type: array items: - $ref: '#/components/schemas/cat.tasks:TasksRecord' - cat.templates@200: + $ref: '#/components/schemas/cat.tasks___TasksRecord' + description: '' + cat.templates___200: content: text/plain: - type: string + schema: + type: string application/json: schema: type: array items: - $ref: '#/components/schemas/cat.templates:TemplatesRecord' - cat.thread_pool@200: + $ref: '#/components/schemas/cat.templates___TemplatesRecord' + description: '' + cat.thread_pool___200: content: text/plain: - type: string + schema: + type: string application/json: schema: type: array items: - $ref: '#/components/schemas/cat.thread_pool:ThreadPoolRecord' - clear_scroll@200: + $ref: '#/components/schemas/cat.thread_pool___ThreadPoolRecord' + description: '' + clear_scroll___200: content: application/json: schema: @@ -27174,7 +28177,8 @@ components: required: - num_freed - succeeded - cluster.allocation_explain@200: + description: '' + cluster.allocation_explain___200: content: application/json: schema: @@ -27183,57 +28187,57 @@ components: allocate_explanation: type: string allocation_delay: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' allocation_delay_in_millis: - $ref: '#/components/schemas/_common:DurationValueUnitMillis' + $ref: '#/components/schemas/_common___DurationValueUnitMillis' can_allocate: - $ref: '#/components/schemas/cluster.allocation_explain:Decision' + $ref: '#/components/schemas/cluster.allocation_explain___Decision' can_move_to_other_node: - $ref: '#/components/schemas/cluster.allocation_explain:Decision' + $ref: '#/components/schemas/cluster.allocation_explain___Decision' can_rebalance_cluster: - $ref: '#/components/schemas/cluster.allocation_explain:Decision' + $ref: '#/components/schemas/cluster.allocation_explain___Decision' can_rebalance_cluster_decisions: type: array items: - $ref: '#/components/schemas/cluster.allocation_explain:AllocationDecision' + $ref: '#/components/schemas/cluster.allocation_explain___AllocationDecision' can_rebalance_to_other_node: - $ref: '#/components/schemas/cluster.allocation_explain:Decision' + $ref: '#/components/schemas/cluster.allocation_explain___Decision' can_remain_decisions: type: array items: - $ref: '#/components/schemas/cluster.allocation_explain:AllocationDecision' + $ref: '#/components/schemas/cluster.allocation_explain___AllocationDecision' can_remain_on_current_node: - $ref: '#/components/schemas/cluster.allocation_explain:Decision' + $ref: '#/components/schemas/cluster.allocation_explain___Decision' cluster_info: - $ref: '#/components/schemas/cluster.allocation_explain:ClusterInfo' + $ref: '#/components/schemas/cluster.allocation_explain___ClusterInfo' configured_delay: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' configured_delay_in_millis: - $ref: '#/components/schemas/_common:DurationValueUnitMillis' + $ref: '#/components/schemas/_common___DurationValueUnitMillis' current_node: - $ref: '#/components/schemas/cluster.allocation_explain:CurrentNode' + $ref: '#/components/schemas/cluster.allocation_explain___CurrentNode' current_state: type: string index: - $ref: '#/components/schemas/_common:IndexName' + $ref: '#/components/schemas/_common___IndexName' move_explanation: type: string node_allocation_decisions: type: array items: - $ref: '#/components/schemas/cluster.allocation_explain:NodeAllocationExplanation' + $ref: '#/components/schemas/cluster.allocation_explain___NodeAllocationExplanation' primary: type: boolean rebalance_explanation: type: string remaining_delay: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' remaining_delay_in_millis: - $ref: '#/components/schemas/_common:DurationValueUnitMillis' + $ref: '#/components/schemas/_common___DurationValueUnitMillis' shard: type: number unassigned_info: - $ref: '#/components/schemas/cluster.allocation_explain:UnassignedInformation' + $ref: '#/components/schemas/cluster.allocation_explain___UnassignedInformation' note: type: string required: @@ -27241,28 +28245,34 @@ components: - index - primary - shard - cluster.delete_component_template@200: + description: '' + cluster.delete_component_template___200: content: application/json: schema: - $ref: '#/components/schemas/_common:AcknowledgedResponseBase' - cluster.delete_decommission_awareness@200: + $ref: '#/components/schemas/_common___AcknowledgedResponseBase' + description: '' + cluster.delete_decommission_awareness___200: content: application/json: schema: - $ref: '#/components/schemas/_common:AcknowledgedResponseBase' - cluster.delete_voting_config_exclusions@200: + $ref: '#/components/schemas/_common___AcknowledgedResponseBase' + description: '' + cluster.delete_voting_config_exclusions___200: content: application/json: {} - cluster.delete_weighted_routing@200: + description: '' + cluster.delete_weighted_routing___200: content: application/json: schema: - $ref: '#/components/schemas/_common:AcknowledgedResponseBase' - cluster.exists_component_template@200: + $ref: '#/components/schemas/_common___AcknowledgedResponseBase' + description: '' + cluster.exists_component_template___200: content: application/json: {} - cluster.get_component_template@200: + description: '' + cluster.get_component_template___200: content: application/json: schema: @@ -27271,15 +28281,17 @@ components: component_templates: type: array items: - $ref: '#/components/schemas/cluster._common:ComponentTemplate' + $ref: '#/components/schemas/cluster._common___ComponentTemplate' required: - component_templates - cluster.get_decommission_awareness@200: + description: '' + cluster.get_decommission_awareness___200: content: application/json: schema: - $ref: '#/components/schemas/cluster.decommission_awareness:DecommissionStatusResponse' - cluster.get_settings@200: + $ref: '#/components/schemas/cluster.decommission_awareness___DecommissionStatusResponse' + description: '' + cluster.get_settings___200: content: application/json: schema: @@ -27297,17 +28309,20 @@ components: required: - persistent - transient - cluster.get_weighted_routing@200: + description: '' + cluster.get_weighted_routing___200: content: application/json: schema: - $ref: '#/components/schemas/cluster.weighted_routing:WeightsResponse' - cluster.health@200: + $ref: '#/components/schemas/cluster.weighted_routing___WeightsResponse' + description: '' + cluster.health___200: content: application/json: schema: - $ref: '#/components/schemas/cluster.health:HealthResponseBody' - cluster.pending_tasks@200: + $ref: '#/components/schemas/cluster.health___HealthResponseBody' + description: '' + cluster.pending_tasks___200: content: application/json: schema: @@ -27316,23 +28331,27 @@ components: tasks: type: array items: - $ref: '#/components/schemas/cluster.pending_tasks:PendingTask' + $ref: '#/components/schemas/cluster.pending_tasks___PendingTask' required: - tasks - cluster.post_voting_config_exclusions@200: + description: '' + cluster.post_voting_config_exclusions___200: content: application/json: {} - cluster.put_component_template@200: + description: '' + cluster.put_component_template___200: content: application/json: schema: - $ref: '#/components/schemas/_common:AcknowledgedResponseBase' - cluster.put_decommission_awareness@200: + $ref: '#/components/schemas/_common___AcknowledgedResponseBase' + description: '' + cluster.put_decommission_awareness___200: content: application/json: schema: - $ref: '#/components/schemas/_common:AcknowledgedResponseBase' - cluster.put_settings@200: + $ref: '#/components/schemas/_common___AcknowledgedResponseBase' + description: '' + cluster.put_settings___200: content: application/json: schema: @@ -27350,19 +28369,22 @@ components: - acknowledged - persistent - transient - cluster.put_weighted_routing@200: + description: '' + cluster.put_weighted_routing___200: content: application/json: schema: type: object - cluster.remote_info@200: + description: '' + cluster.remote_info___200: content: application/json: schema: type: object additionalProperties: - $ref: '#/components/schemas/cluster.remote_info:ClusterRemoteInfo' - cluster.reroute@200: + $ref: '#/components/schemas/cluster.remote_info___ClusterRemoteInfo' + description: '' + cluster.reroute___200: content: application/json: schema: @@ -27373,7 +28395,7 @@ components: explanations: type: array items: - $ref: '#/components/schemas/cluster.reroute:RerouteExplanation' + $ref: '#/components/schemas/cluster.reroute___RerouteExplanation' state: description: |- There aren't any guarantees on the output/structure of the raw cluster state. @@ -27382,17 +28404,20 @@ components: type: object required: - acknowledged - cluster.state@200: + description: '' + cluster.state___200: content: application/json: schema: type: object - cluster.stats@200: + description: '' + cluster.stats___200: content: application/json: schema: - $ref: '#/components/schemas/cluster.stats:StatsResponseBase' - count@200: + $ref: '#/components/schemas/cluster.stats___StatsResponseBase' + description: '' + count___200: content: application/json: schema: @@ -27404,11 +28429,12 @@ components: type: integer format: int64 _shards: - $ref: '#/components/schemas/_common:ShardStatistics' + $ref: '#/components/schemas/_common___ShardStatistics' required: - _shards - count - create_pit@200: + description: '' + create_pit___200: content: application/json: schema: @@ -27417,42 +28443,47 @@ components: pit_id: type: string _shards: - $ref: '#/components/schemas/_core._common:ShardStatistics' + $ref: '#/components/schemas/_core._common___ShardStatistics' creation_time: type: integer format: int64 - create@200: + description: '' + create___201: content: application/json: schema: - $ref: '#/components/schemas/_common:WriteResponseBase' - dangling_indices.delete_dangling_index@200: + $ref: '#/components/schemas/_common___WriteResponseBase' + description: '' + dangling_indices.delete_dangling_index___202: content: application/json: schema: - $ref: '#/components/schemas/_common:AcknowledgedResponseBase' - dangling_indices.import_dangling_index@200: + $ref: '#/components/schemas/_common___AcknowledgedResponseBase' + description: '' + dangling_indices.import_dangling_index___202: content: application/json: schema: - $ref: '#/components/schemas/_common:AcknowledgedResponseBase' - dangling_indices.list_dangling_indices@200: + $ref: '#/components/schemas/_common___AcknowledgedResponseBase' + description: '' + dangling_indices.list_dangling_indices___200: content: application/json: schema: type: object properties: _nodes: - $ref: '#/components/schemas/_common:NodeStatistics' + $ref: '#/components/schemas/_common___NodeStatistics' cluster_name: - $ref: '#/components/schemas/_common:Name' + $ref: '#/components/schemas/_common___Name' dangling_indices: type: array items: - $ref: '#/components/schemas/dangling_indices.list_dangling_indices:DanglingIndex' + $ref: '#/components/schemas/dangling_indices.list_dangling_indices___DanglingIndex' required: - dangling_indices - delete_all_pits@200: + description: '' + delete_all_pits___200: content: application/json: schema: @@ -27461,23 +28492,26 @@ components: pits: type: array items: - $ref: '#/components/schemas/_core._common:PitsDetailsDeleteAll' - delete_by_query_rethrottle@200: + $ref: '#/components/schemas/_core._common___PitsDetailsDeleteAll' + description: '' + delete_by_query_rethrottle___200: content: application/json: schema: - $ref: '#/components/schemas/tasks._common:TaskListResponseBase' - delete_by_query@200: + $ref: '#/components/schemas/tasks._common___TaskListResponseBase' + description: '' + delete_by_query___200: content: application/json: schema: oneOf: - - $ref: '#/components/schemas/_common:BulkByScrollResponseBase' + - $ref: '#/components/schemas/_common___BulkByScrollResponseBase' - type: object properties: task: - $ref: '#/components/schemas/_common:TaskId' - delete_pit@200: + $ref: '#/components/schemas/_common___TaskId' + description: '' + delete_pit___200: content: application/json: schema: @@ -27486,66 +28520,84 @@ components: pits: type: array items: - $ref: '#/components/schemas/_core._common:DeletedPit' - delete_script@200: + $ref: '#/components/schemas/_core._common___DeletedPit' + description: '' + delete_script___200: content: application/json: schema: - $ref: '#/components/schemas/_common:AcknowledgedResponseBase' - delete@200: + $ref: '#/components/schemas/_common___AcknowledgedResponseBase' + description: '' + delete___200: content: application/json: schema: - $ref: '#/components/schemas/_common:WriteResponseBase' - delete@404: + $ref: '#/components/schemas/_common___WriteResponseBase' + description: '' + delete___404: content: application/json: schema: - $ref: '#/components/schemas/_common:WriteResponseBase' - exists_source@200: + $ref: '#/components/schemas/_common___WriteResponseBase' + description: '' + exists_source___200: content: application/json: {} - exists@200: + description: '' + exists_source___404: content: application/json: {} - explain@200: + description: '' + exists___200: + content: + application/json: {} + description: '' + exists___404: + content: + application/json: {} + description: '' + explain___200: content: application/json: schema: type: object properties: + _type: + $ref: '#/components/schemas/_common___Type' _index: - $ref: '#/components/schemas/_common:IndexName' + $ref: '#/components/schemas/_common___IndexName' _id: - $ref: '#/components/schemas/_common:Id' + $ref: '#/components/schemas/_common___Id' matched: type: boolean explanation: - $ref: '#/components/schemas/_core.explain:ExplanationDetail' + $ref: '#/components/schemas/_core.explain___ExplanationDetail' get: - $ref: '#/components/schemas/_common:InlineGet' + $ref: '#/components/schemas/_common___InlineGet' required: - _id - _index - matched - field_caps@200: + description: '' + field_caps___200: content: application/json: schema: type: object properties: indices: - $ref: '#/components/schemas/_common:Indices' + $ref: '#/components/schemas/_common___Indices' fields: type: object additionalProperties: type: object additionalProperties: - $ref: '#/components/schemas/_core.field_caps:FieldCapability' + $ref: '#/components/schemas/_core.field_caps___FieldCapability' required: - fields - indices - flow_framework.create@201: + description: '' + flow_framework.create___201: content: application/json: schema: @@ -27556,142 +28608,194 @@ components: description: The ID of the workflow to be updated. Required for the PUT method. required: - workflow_id - flow_framework.create@400: + description: '' + flow_framework.create___400: description: Bad Request - Multiple possible reasons content: application/json: - oneOf: - - $ref: '#/components/schemas/flow_framework.errors:InvalidParameterError' - - $ref: '#/components/schemas/flow_framework.errors:ConflictError' - - $ref: '#/components/schemas/flow_framework.errors:MissingParameterError' - - $ref: '#/components/schemas/flow_framework.errors:ParameterConflictError' - - $ref: '#/components/schemas/flow_framework.errors:MaxWorkflowsLimitError' - - $ref: '#/components/schemas/flow_framework.errors:WorkflowSaveError' - - $ref: '#/components/schemas/flow_framework.errors:WorkflowParsingError' - - $ref: '#/components/schemas/flow_framework.errors:UnsupportedFieldUpdateError' - - $ref: '#/components/schemas/flow_framework.errors:InvalidTemplateVersionError' - - $ref: '#/components/schemas/flow_framework.errors:TemplateNameRequiredError' - flow_framework.create@403: + schema: + anyOf: + - $ref: '#/components/schemas/flow_framework.errors___InvalidParameterError' + - $ref: '#/components/schemas/flow_framework.errors___ConflictError' + - $ref: '#/components/schemas/flow_framework.errors___MissingParameterError' + - $ref: '#/components/schemas/flow_framework.errors___ParameterConflictError' + - $ref: '#/components/schemas/flow_framework.errors___MaxWorkflowsLimitError' + - $ref: '#/components/schemas/flow_framework.errors___WorkflowSaveError' + - $ref: '#/components/schemas/flow_framework.errors___WorkflowParsingError' + - $ref: '#/components/schemas/flow_framework.errors___UnsupportedFieldUpdateError' + - $ref: '#/components/schemas/flow_framework.errors___InvalidTemplateVersionError' + - $ref: '#/components/schemas/flow_framework.errors___TemplateNameRequiredError' + flow_framework.create___403: content: application/json: - $ref: '#/components/schemas/flow_framework.errors:FlowFrameworkAPIDisabledError' - flow_framework.delete@200: + schema: + $ref: '#/components/schemas/flow_framework.errors___FlowFrameworkAPIDisabledError' + description: '' + flow_framework.delete___200: content: application/json: - $ref: '#/components/schemas/flow_framework.common:FlowFrameworkDeleteResponse' - flow_framework.delete@400: + schema: + $ref: '#/components/schemas/flow_framework.common___FlowFrameworkDeleteResponse' + description: '' + flow_framework.delete___400: description: Work Flow Id Null Error content: application/json: - $ref: '#/components/schemas/flow_framework.errors:WorkFlowIdNullError' - flow_framework.delete@403: + schema: + $ref: '#/components/schemas/flow_framework.errors___WorkFlowIdNullError' + flow_framework.delete___403: description: Flow Framework API Disabled Error content: application/json: - $ref: '#/components/schemas/flow_framework.errors:FlowFrameworkAPIDisabledError' - flow_framework.deprovision@200: + schema: + $ref: '#/components/schemas/flow_framework.errors___FlowFrameworkAPIDisabledError' + flow_framework.deprovision___200: content: application/json: - $ref: '#/components/schemas/flow_framework.common:WorkflowID' - flow_framework.deprovision@202: + schema: + $ref: '#/components/schemas/flow_framework.common___WorkflowIDResponse' + description: '' + flow_framework.deprovision___202: content: application/json: - $ref: '#/components/schemas/flow_framework.errors:DeprovisioningError' - flow_framework.deprovision@403: + schema: + $ref: '#/components/schemas/flow_framework.errors___DeprovisioningError' + description: '' + flow_framework.deprovision___403: content: application/json: - oneOf: - - $ref: '#/components/schemas/flow_framework.errors:FlowFrameworkAPIDisabledError' - - $ref: '#/components/schemas/flow_framework.errors:DeprovisioningForbiddenError' - flow_framework.deprovision@404: + schema: + oneOf: + - $ref: '#/components/schemas/flow_framework.errors___FlowFrameworkAPIDisabledError' + - $ref: '#/components/schemas/flow_framework.errors___DeprovisioningForbiddenError' + description: '' + flow_framework.deprovision___404: content: application/json: - $ref: '#/components/schemas/flow_framework.errors:TemplateNotFoundError' - flow_framework.get_status@200: + schema: + $ref: '#/components/schemas/flow_framework.errors___TemplateNotFoundError' + description: '' + flow_framework.get_status___200: content: application/json: - oneOf: - - $ref: '#/components/schemas/flow_framework.common:WorkFlowStatusFullResponse' - - $ref: '#/components/schemas/flow_framework.common:WorkFlowStatusDefaultResponse' - flow_framework.get_status@403: + schema: + anyOf: + - $ref: '#/components/schemas/flow_framework.common___WorkFlowStatusFullResponse' + - $ref: '#/components/schemas/flow_framework.common___WorkFlowStatusDefaultResponse' + description: '' + flow_framework.get_status___403: content: application/json: - $ref: '#/components/schemas/flow_framework.errors:FlowFrameworkAPIDisabledError' - flow_framework.get_status@404: + schema: + $ref: '#/components/schemas/flow_framework.errors___FlowFrameworkAPIDisabledError' + description: '' + flow_framework.get_status___404: content: application/json: - $ref: '#/components/schemas/flow_framework.errors:TemplateNotFoundError' - flow_framework.get_steps@200: + schema: + $ref: '#/components/schemas/flow_framework.errors___TemplateNotFoundError' + description: '' + flow_framework.get_steps___200: content: application/json: - $ref: '#/components/schemas/flow_framework.common:WorkflowStep' - flow_framework.get_steps@400: + schema: + $ref: '#/components/schemas/flow_framework.common___WorkflowSteps' + description: '' + flow_framework.get_steps___400: content: application/json: - $ref: '#/components/schemas/flow_framework.errors:WorkflowStepsRetrieveError' - flow_framework.get_steps@403: + schema: + $ref: '#/components/schemas/flow_framework.errors___WorkflowStepsRetrieveError' + description: '' + flow_framework.get_steps___403: description: Flow Framework API Disabled Error content: application/json: - $ref: '#/components/schemas/flow_framework.errors:FlowFrameworkAPIDisabledError' - flow_framework.get@200: + schema: + $ref: '#/components/schemas/flow_framework.errors___FlowFrameworkAPIDisabledError' + flow_framework.get___200: content: application/json: - $ref: '#/components/schemas/flow_framework.common:FlowFrameworkGetResponse' - flow_framework.get@404: + schema: + $ref: '#/components/schemas/flow_framework.common___FlowFrameworkGetResponse' + description: '' + flow_framework.get___404: description: Template Not Found Error content: application/json: - $ref: '#/components/schemas/flow_framework.errors:TemplateNotFoundError' - flow_framework.provision@200: + schema: + $ref: '#/components/schemas/flow_framework.errors___TemplateNotFoundError' + flow_framework.provision___200: content: application/json: - $ref: '#/components/schemas/flow_framework.common:WorkflowID' - flow_framework.provision@400: + schema: + $ref: '#/components/schemas/flow_framework.common___WorkflowIDResponse' + description: '' + flow_framework.provision___400: content: application/json: - oneOf: - - $ref: '#/components/schemas/flow_framework.errors:WorkFlowIdNullError' - - $ref: '#/components/schemas/flow_framework.errors:RequestBodyParsingFailedError' - - $ref: '#/components/schemas/flow_framework.errors:InvalidRequestBodyFieldError' - - $ref: '#/components/schemas/flow_framework.errors:DuplicateKeyError' - flow_framework.provision@403: + schema: + oneOf: + - $ref: '#/components/schemas/flow_framework.errors___WorkFlowIdNullError' + - $ref: '#/components/schemas/flow_framework.errors___RequestBodyParsingFailedError' + - $ref: '#/components/schemas/flow_framework.errors___InvalidRequestBodyFieldError' + - $ref: '#/components/schemas/flow_framework.errors___DuplicateKeyError' + description: '' + flow_framework.provision___403: content: application/json: - $ref: '#/components/schemas/flow_framework.errors:FlowFrameworkAPIDisabledError' - flow_framework.search_state@200: + schema: + $ref: '#/components/schemas/flow_framework.errors___FlowFrameworkAPIDisabledError' + description: '' + flow_framework.search_state___200: content: application/json: - $ref: '#/components/schemas/flow_framework.common:WorkflowSearchStateResponse' - flow_framework.search_state@400: + schema: + $ref: '#/components/schemas/flow_framework.common___WorkflowSearchStateResponse' + description: '' + flow_framework.search_state___400: content: application/json: - $ref: '#/components/schemas/flow_framework.errors:BadRequestError' - flow_framework.search_state@403: + schema: + $ref: '#/components/schemas/flow_framework.errors___BadRequestError' + description: '' + flow_framework.search_state___403: content: application/json: - $ref: '#/components/schemas/flow_framework.errors:FlowFrameworkAPIDisabledError' - flow_framework.search_state@408: + schema: + $ref: '#/components/schemas/flow_framework.errors___FlowFrameworkAPIDisabledError' + description: '' + flow_framework.search_state___408: content: application/json: - $ref: '#/components/schemas/flow_framework.errors:RequestTimeoutError' - flow_framework.search@200: + schema: + $ref: '#/components/schemas/flow_framework.errors___RequestTimeoutError' + description: '' + flow_framework.search___200: content: application/json: - $ref: '#/components/schemas/flow_framework.common:WorkflowSearchResponse' - flow_framework.search@400: + schema: + $ref: '#/components/schemas/flow_framework.common___WorkflowSearchResponse' + description: '' + flow_framework.search___400: content: application/json: - $ref: '#/components/schemas/flow_framework.errors:BadRequestError' - flow_framework.search@403: + schema: + $ref: '#/components/schemas/flow_framework.errors___BadRequestError' + description: '' + flow_framework.search___403: content: application/json: - $ref: '#/components/schemas/flow_framework.errors:FlowFrameworkAPIDisabledError' - flow_framework.search@408: + schema: + $ref: '#/components/schemas/flow_framework.errors___FlowFrameworkAPIDisabledError' + description: '' + flow_framework.search___408: content: application/json: - $ref: '#/components/schemas/flow_framework.errors:RequestTimeoutError' - flow_framework.update@201: + schema: + $ref: '#/components/schemas/flow_framework.errors___RequestTimeoutError' + description: '' + flow_framework.update___201: content: application/json: schema: @@ -27702,26 +28806,29 @@ components: description: The ID of the workflow to be updated. Required for the PUT method. required: - workflow_id - flow_framework.update@400: + description: '' + flow_framework.update___400: description: Bad Request - Multiple possible reasons content: application/json: - oneOf: - - $ref: '#/components/schemas/flow_framework.errors:InvalidParameterError' - - $ref: '#/components/schemas/flow_framework.errors:ConflictError' - - $ref: '#/components/schemas/flow_framework.errors:MissingParameterError' - - $ref: '#/components/schemas/flow_framework.errors:ParameterConflictError' - - $ref: '#/components/schemas/flow_framework.errors:MaxWorkflowsLimitError' - - $ref: '#/components/schemas/flow_framework.errors:WorkflowSaveError' - - $ref: '#/components/schemas/flow_framework.errors:InvalidTemplateVersionError' - - $ref: '#/components/schemas/flow_framework.errors:UnsupportedFieldUpdateError' - - $ref: '#/components/schemas/flow_framework.errors:WorkflowParsingError' - flow_framework.update@404: + schema: + anyOf: + - $ref: '#/components/schemas/flow_framework.errors___InvalidParameterError' + - $ref: '#/components/schemas/flow_framework.errors___ConflictError' + - $ref: '#/components/schemas/flow_framework.errors___MissingParameterError' + - $ref: '#/components/schemas/flow_framework.errors___ParameterConflictError' + - $ref: '#/components/schemas/flow_framework.errors___MaxWorkflowsLimitError' + - $ref: '#/components/schemas/flow_framework.errors___WorkflowSaveError' + - $ref: '#/components/schemas/flow_framework.errors___InvalidTemplateVersionError' + - $ref: '#/components/schemas/flow_framework.errors___UnsupportedFieldUpdateError' + - $ref: '#/components/schemas/flow_framework.errors___WorkflowParsingError' + flow_framework.update___404: description: Template Not Found Error content: application/json: - $ref: '#/components/schemas/flow_framework.errors:TemplateNotFoundError' - get_all_pits@200: + schema: + $ref: '#/components/schemas/flow_framework.errors___TemplateNotFoundError' + get_all_pits___200: content: application/json: schema: @@ -27730,8 +28837,9 @@ components: pits: type: array items: - $ref: '#/components/schemas/_core._common:PitDetail' - get_script_context@200: + $ref: '#/components/schemas/_core._common___PitDetail' + description: '' + get_script_context___200: content: application/json: schema: @@ -27740,10 +28848,11 @@ components: contexts: type: array items: - $ref: '#/components/schemas/_core.get_script_context:Context' + $ref: '#/components/schemas/_core.get_script_context___Context' required: - contexts - get_script_languages@200: + description: '' + get_script_languages___200: content: application/json: schema: @@ -27752,7 +28861,7 @@ components: language_contexts: type: array items: - $ref: '#/components/schemas/_core.get_script_languages:LanguageContext' + $ref: '#/components/schemas/_core.get_script_languages___LanguageContext' types_allowed: type: array items: @@ -27760,47 +28869,60 @@ components: required: - language_contexts - types_allowed - get_script@200: + description: '' + get_script___200: content: application/json: schema: type: object properties: _id: - $ref: '#/components/schemas/_common:Id' + $ref: '#/components/schemas/_common___Id' found: type: boolean script: - $ref: '#/components/schemas/_common:StoredScript' + $ref: '#/components/schemas/_common___StoredScript' required: - _id - found - get_source@200: + description: '' + get_source___200: content: application/json: schema: type: object - get@200: + description: '' + get_source___404: content: application/json: schema: - $ref: '#/components/schemas/_core.get:GetResult' - get@404: + $ref: '#/components/schemas/query._common___ErrorResponse' + description: '' + get___200: content: application/json: schema: - $ref: '#/components/schemas/_core.get:GetResult' - index@200: + $ref: '#/components/schemas/_core.get___GetResult' + description: '' + get___404: content: application/json: schema: - $ref: '#/components/schemas/_common:WriteResponseBase' - index@201: + $ref: '#/components/schemas/_core.get___GetResult' + description: '' + index___200: content: application/json: schema: - $ref: '#/components/schemas/_common:WriteResponseBase' - indices.add_block@200: + $ref: '#/components/schemas/_common___WriteResponseBase' + description: '' + index___201: + content: + application/json: + schema: + $ref: '#/components/schemas/_common___WriteResponseBase' + description: '' + indices.add_block___200: content: application/json: schema: @@ -27813,29 +28935,32 @@ components: indices: type: array items: - $ref: '#/components/schemas/indices.add_block:IndicesBlockStatus' + $ref: '#/components/schemas/indices.add_block___IndicesBlockStatus' required: - acknowledged - indices - shards_acknowledged - indices.analyze@200: + description: '' + indices.analyze___200: content: application/json: schema: type: object properties: detail: - $ref: '#/components/schemas/indices.analyze:AnalyzeDetail' + $ref: '#/components/schemas/indices.analyze___AnalyzeDetail' tokens: type: array items: - $ref: '#/components/schemas/indices.analyze:AnalyzeToken' - indices.clear_cache@200: + $ref: '#/components/schemas/indices.analyze___AnalyzeToken' + description: '' + indices.clear_cache___200: content: application/json: schema: - $ref: '#/components/schemas/_common:ShardsOperationResponseBase' - indices.clone@200: + $ref: '#/components/schemas/_common___ShardsOperationResponseBase' + description: '' + indices.clone___200: content: application/json: schema: @@ -27844,14 +28969,15 @@ components: acknowledged: type: boolean index: - $ref: '#/components/schemas/_common:IndexName' + $ref: '#/components/schemas/_common___IndexName' shards_acknowledged: type: boolean required: - acknowledged - index - shards_acknowledged - indices.close@200: + description: '' + indices.close___200: content: application/json: schema: @@ -27862,26 +28988,28 @@ components: indices: type: object additionalProperties: - $ref: '#/components/schemas/indices.close:CloseIndexResult' + $ref: '#/components/schemas/indices.close___CloseIndexResult' shards_acknowledged: type: boolean required: - acknowledged - indices - shards_acknowledged - indices.create_data_stream@200: + description: '' + indices.create_data_stream___200: content: application/json: schema: - $ref: '#/components/schemas/_common:AcknowledgedResponseBase' - indices.create@200: + $ref: '#/components/schemas/_common___AcknowledgedResponseBase' + description: '' + indices.create___200: content: application/json: schema: type: object properties: index: - $ref: '#/components/schemas/_common:IndexName' + $ref: '#/components/schemas/_common___IndexName' shards_acknowledged: type: boolean acknowledged: @@ -27890,16 +29018,17 @@ components: - acknowledged - index - shards_acknowledged - indices.data_streams_stats@200: + description: '' + indices.data_streams_stats___200: content: application/json: schema: type: object properties: _shards: - $ref: '#/components/schemas/_common:ShardStatistics' + $ref: '#/components/schemas/_common___ShardStatistics' backing_indices: - description: Total number of backing indices for the selected data streams. + description: Total number of backing indexes for the selected data streams. type: number data_stream_count: description: Total number of selected data streams. @@ -27908,95 +29037,112 @@ components: description: Contains statistics for the selected data streams. type: array items: - $ref: '#/components/schemas/indices.data_streams_stats:DataStreamsStatsItem' + $ref: '#/components/schemas/indices.data_streams_stats___DataStreamsStatsItem' total_store_sizes: - $ref: '#/components/schemas/_common:HumanReadableByteCount' + $ref: '#/components/schemas/_common___HumanReadableByteCount' total_store_size_bytes: description: Total size, in bytes, of all shards for the selected data streams. - $ref: '#/components/schemas/_common:ByteCount' + $ref: '#/components/schemas/_common___ByteCount' required: - _shards - backing_indices - data_stream_count - data_streams - total_store_size_bytes - indices.delete_alias@200: + description: '' + indices.delete_alias___200: content: application/json: schema: - $ref: '#/components/schemas/_common:AcknowledgedResponseBase' - indices.delete_data_stream@200: + $ref: '#/components/schemas/_common___AcknowledgedResponseBase' + description: '' + indices.delete_data_stream___200: content: application/json: schema: - $ref: '#/components/schemas/_common:AcknowledgedResponseBase' - indices.delete_index_template@200: + $ref: '#/components/schemas/_common___AcknowledgedResponseBase' + description: '' + indices.delete_index_template___200: content: application/json: schema: - $ref: '#/components/schemas/_common:AcknowledgedResponseBase' - indices.delete_template@200: + $ref: '#/components/schemas/_common___AcknowledgedResponseBase' + description: '' + indices.delete_template___200: content: application/json: schema: - $ref: '#/components/schemas/_common:AcknowledgedResponseBase' - indices.delete@200: + $ref: '#/components/schemas/_common___AcknowledgedResponseBase' + description: '' + indices.delete___200: content: application/json: schema: - $ref: '#/components/schemas/_common:IndicesResponseBase' - indices.delete@404: + $ref: '#/components/schemas/_common___IndicesResponseBase' + description: '' + indices.delete___404: content: application/json: schema: - $ref: '#/components/schemas/indices._common:IndexErrorCause' - indices.exists_alias@200: + $ref: '#/components/schemas/indices._common___IndexError' + description: '' + indices.exists_alias___200: content: application/json: {} - indices.exists_alias@404: + description: '' + indices.exists_alias___404: content: application/json: {} - indices.exists_index_template@200: + description: '' + indices.exists_index_template___200: content: application/json: {} - indices.exists_template@200: + description: '' + indices.exists_template___200: content: application/json: {} - indices.exists@200: + description: '' + indices.exists___200: content: application/json: {} - indices.exists@404: + description: '' + indices.exists___404: content: application/json: {} - indices.flush@200: + description: '' + indices.flush___200: content: application/json: schema: - $ref: '#/components/schemas/_common:ShardsOperationResponseBase' - indices.forcemerge@200: + $ref: '#/components/schemas/_common___ShardsOperationResponseBase' + description: '' + indices.forcemerge___200: content: application/json: schema: allOf: - - $ref: '#/components/schemas/_common:ShardsOperationResponseBase' + - $ref: '#/components/schemas/_common___ShardsOperationResponseBase' - type: object properties: task: description: |- - task contains a task id returned when wait_for_completion=false, - you can use the task_id to get the status of the task at _tasks/ + Task contains a task id returned when `wait_for_completion=false`, + you can use the `task_id` to get the status of the task at _tasks/. type: string - indices.get_alias@200: + description: '' + indices.get_alias___200: content: application/json: schema: type: object additionalProperties: - $ref: '#/components/schemas/indices.get_alias:IndexAliases' - indices.get_alias@404: + $ref: '#/components/schemas/indices.get_alias___IndexAliases' + description: '' + indices.get_alias___404: content: application/json: {} - indices.get_data_stream@200: + description: '' + indices.get_data_stream___200: content: application/json: schema: @@ -28005,17 +29151,19 @@ components: data_streams: type: array items: - $ref: '#/components/schemas/indices._common:DataStream' + $ref: '#/components/schemas/indices._common___DataStream' required: - data_streams - indices.get_field_mapping@200: + description: '' + indices.get_field_mapping___200: content: application/json: schema: type: object additionalProperties: - $ref: '#/components/schemas/indices.get_field_mapping:TypeFieldMappings' - indices.get_index_template@200: + $ref: '#/components/schemas/indices.get_field_mapping___TypeFieldMappings' + description: '' + indices.get_index_template___200: content: application/json: schema: @@ -28024,39 +29172,45 @@ components: index_templates: type: array items: - $ref: '#/components/schemas/indices.get_index_template:IndexTemplateItem' + $ref: '#/components/schemas/indices.get_index_template___IndexTemplateItem' required: - index_templates - indices.get_mapping@200: + description: '' + indices.get_mapping___200: content: application/json: schema: type: object additionalProperties: - $ref: '#/components/schemas/indices.get_mapping:IndexMappingRecord' - indices.get_settings@200: + $ref: '#/components/schemas/indices.get_mapping___IndexMappingRecord' + description: '' + indices.get_settings___200: content: application/json: schema: type: object additionalProperties: - $ref: '#/components/schemas/indices._common:IndexState' - indices.get_template@200: + $ref: '#/components/schemas/indices._common___IndexState' + description: '' + indices.get_template___200: content: application/json: schema: type: object additionalProperties: - $ref: '#/components/schemas/indices._common:TemplateMapping' - indices.get_upgrade@200: {} - indices.get@200: + $ref: '#/components/schemas/indices._common___TemplateMapping' + description: '' + indices.get_upgrade___200: + description: '' + indices.get___200: content: application/json: schema: type: object additionalProperties: - $ref: '#/components/schemas/indices._common:IndexState' - indices.open@200: + $ref: '#/components/schemas/indices._common___IndexState' + description: '' + indices.open___200: content: application/json: schema: @@ -28064,7 +29218,7 @@ components: - type: object properties: task: - $ref: '#/components/schemas/_common:TaskId' + $ref: '#/components/schemas/_common___TaskId' additionalProperties: false - type: object properties: @@ -28076,44 +29230,52 @@ components: - acknowledged - shards_acknowledged additionalProperties: false - indices.put_alias@200: + description: '' + indices.put_alias___200: content: application/json: schema: - $ref: '#/components/schemas/_common:AcknowledgedResponseBase' - indices.put_index_template@200: + $ref: '#/components/schemas/_common___AcknowledgedResponseBase' + description: '' + indices.put_index_template___200: content: application/json: schema: - $ref: '#/components/schemas/_common:AcknowledgedResponseBase' - indices.put_mapping@200: + $ref: '#/components/schemas/_common___AcknowledgedResponseBase' + description: '' + indices.put_mapping___200: content: application/json: schema: - $ref: '#/components/schemas/_common:IndicesResponseBase' - indices.put_settings@200: + $ref: '#/components/schemas/_common___IndicesResponseBase' + description: '' + indices.put_settings___200: content: application/json: schema: - $ref: '#/components/schemas/_common:AcknowledgedResponseBase' - indices.put_template@200: + $ref: '#/components/schemas/_common___AcknowledgedResponseBase' + description: '' + indices.put_template___200: content: application/json: schema: - $ref: '#/components/schemas/_common:AcknowledgedResponseBase' - indices.recovery@200: + $ref: '#/components/schemas/_common___AcknowledgedResponseBase' + description: '' + indices.recovery___200: content: application/json: schema: type: object additionalProperties: - $ref: '#/components/schemas/indices.recovery:RecoveryStatus' - indices.refresh@200: + $ref: '#/components/schemas/indices.recovery___RecoveryStatus' + description: '' + indices.refresh___200: content: application/json: schema: - $ref: '#/components/schemas/_common:ShardsOperationResponseBase' - indices.resolve_index@200: + $ref: '#/components/schemas/_common___ShardsOperationResponseBase' + description: '' + indices.resolve_index___200: content: application/json: schema: @@ -28122,20 +29284,21 @@ components: indices: type: array items: - $ref: '#/components/schemas/indices.resolve_index:ResolveIndexItem' + $ref: '#/components/schemas/indices.resolve_index___ResolveIndexItem' aliases: type: array items: - $ref: '#/components/schemas/indices.resolve_index:ResolveIndexAliasItem' + $ref: '#/components/schemas/indices.resolve_index___ResolveIndexAliasItem' data_streams: type: array items: - $ref: '#/components/schemas/indices.resolve_index:ResolveIndexDataStreamsItem' + $ref: '#/components/schemas/indices.resolve_index___ResolveIndexDataStreamsItem' required: - aliases - data_streams - indices - indices.rollover@200: + description: '' + indices.rollover___200: content: application/json: schema: @@ -28165,7 +29328,8 @@ components: - old_index - rolled_over - shards_acknowledged - indices.segments@200: + description: '' + indices.segments___200: content: application/json: schema: @@ -28174,13 +29338,14 @@ components: indices: type: object additionalProperties: - $ref: '#/components/schemas/indices.segments:IndexSegment' + $ref: '#/components/schemas/indices.segments___IndexSegment' _shards: - $ref: '#/components/schemas/_common:ShardStatistics' + $ref: '#/components/schemas/_common___ShardStatistics' required: - _shards - indices - indices.shard_stores@200: + description: '' + indices.shard_stores___200: content: application/json: schema: @@ -28189,10 +29354,11 @@ components: indices: type: object additionalProperties: - $ref: '#/components/schemas/indices.shard_stores:IndicesShardStores' + $ref: '#/components/schemas/indices.shard_stores___IndicesShardStores' required: - indices - indices.shrink@200: + description: '' + indices.shrink___200: content: application/json: schema: @@ -28203,17 +29369,19 @@ components: shards_acknowledged: type: boolean index: - $ref: '#/components/schemas/_common:IndexName' + $ref: '#/components/schemas/_common___IndexName' required: - acknowledged - index - shards_acknowledged - indices.simulate_index_template@200: + description: '' + indices.simulate_index_template___200: content: application/json: schema: type: object - indices.simulate_template@200: + description: '' + indices.simulate_template___200: content: application/json: schema: @@ -28222,12 +29390,13 @@ components: overlapping: type: array items: - $ref: '#/components/schemas/indices.simulate_template:Overlapping' + $ref: '#/components/schemas/indices.simulate_template___Overlapping' template: - $ref: '#/components/schemas/indices.simulate_template:Template' + $ref: '#/components/schemas/indices.simulate_template___Template' required: - template - indices.split@200: + description: '' + indices.split___200: content: application/json: schema: @@ -28238,35 +29407,39 @@ components: shards_acknowledged: type: boolean index: - $ref: '#/components/schemas/_common:IndexName' + $ref: '#/components/schemas/_common___IndexName' required: - acknowledged - index - shards_acknowledged - indices.stats@200: + description: '' + indices.stats___200: content: application/json: schema: type: object properties: _shards: - $ref: '#/components/schemas/_common:ShardStatistics' + $ref: '#/components/schemas/_common___ShardStatistics' _all: - $ref: '#/components/schemas/indices.stats:AllIndicesStats' + $ref: '#/components/schemas/indices.stats___AllIndicesStats' indices: type: object additionalProperties: - $ref: '#/components/schemas/indices.stats:IndicesStats' + $ref: '#/components/schemas/indices.stats___IndicesStats' required: - _all - _shards - indices.update_aliases@200: + description: '' + indices.update_aliases___200: content: application/json: schema: - $ref: '#/components/schemas/_common:AcknowledgedResponseBase' - indices.upgrade@200: {} - indices.validate_query@200: + $ref: '#/components/schemas/_common___AcknowledgedResponseBase' + description: '' + indices.upgrade___200: + description: '' + indices.validate_query___200: content: application/json: schema: @@ -28275,50 +29448,54 @@ components: explanations: type: array items: - $ref: '#/components/schemas/indices.validate_query:IndicesValidationExplanation' + $ref: '#/components/schemas/indices.validate_query___IndicesValidationExplanation' _shards: - $ref: '#/components/schemas/_common:ShardStatistics' + $ref: '#/components/schemas/_common___ShardStatistics' valid: type: boolean error: type: string required: - valid - info@200: + description: '' + info___200: content: application/json: schema: type: object properties: cluster_name: - $ref: '#/components/schemas/_common:Name' + $ref: '#/components/schemas/_common___Name' cluster_uuid: - $ref: '#/components/schemas/_common:Uuid' + $ref: '#/components/schemas/_common___Uuid' name: - $ref: '#/components/schemas/_common:Name' + $ref: '#/components/schemas/_common___Name' tagline: type: string version: - $ref: '#/components/schemas/_common:OpenSearchVersionInfo' + $ref: '#/components/schemas/_common___OpenSearchVersionInfo' required: - cluster_name - cluster_uuid - name - tagline - version - ingest.delete_pipeline@200: + description: '' + ingest.delete_pipeline___200: content: application/json: schema: - $ref: '#/components/schemas/_common:AcknowledgedResponseBase' - ingest.get_pipeline@200: + $ref: '#/components/schemas/_common___AcknowledgedResponseBase' + description: '' + ingest.get_pipeline___200: content: application/json: schema: type: object additionalProperties: - $ref: '#/components/schemas/ingest._common:Pipeline' - ingest.processor_grok@200: + $ref: '#/components/schemas/ingest._common___Pipeline' + description: '' + ingest.processor_grok___200: content: application/json: schema: @@ -28330,12 +29507,14 @@ components: type: string required: - patterns - ingest.put_pipeline@200: + description: '' + ingest.put_pipeline___200: content: application/json: schema: - $ref: '#/components/schemas/_common:AcknowledgedResponseBase' - ingest.simulate@200: + $ref: '#/components/schemas/_common___AcknowledgedResponseBase' + description: '' + ingest.simulate___200: content: application/json: schema: @@ -28344,82 +29523,111 @@ components: docs: type: array items: - $ref: '#/components/schemas/ingest.simulate:PipelineSimulation' + $ref: '#/components/schemas/ingest.simulate___PipelineSimulation' required: - docs - ism.add_policy@200: + description: '' + insights.top_queries___200: + content: + application/json: + schema: + $ref: '#/components/schemas/insights._common___TopQueriesResponse' + description: '' + ism.add_policy___200: content: application/json: schema: - $ref: '#/components/schemas/ism._common:AddPolicyResponse' - ism.change_policy@200: + $ref: '#/components/schemas/ism._common___AddPolicyResponse' + description: '' + ism.change_policy___200: content: application/json: schema: - $ref: '#/components/schemas/ism._common:ChangePolicyResponse' - ism.delete_policy@200: + $ref: '#/components/schemas/ism._common___ChangePolicyResponse' + description: '' + ism.delete_policy___200: content: application/json: schema: - $ref: '#/components/schemas/ism._common:DeletePolicyResponse' - ism.exists_policy@200: + $ref: '#/components/schemas/ism._common___DeletePolicyResponse' + description: '' + ism.exists_policy___200: content: application/json: schema: {} - ism.exists_policy@404: + description: '' + ism.exists_policy___404: content: application/json: schema: {} - ism.explain_policy@200: + description: '' + ism.explain_policy___200: + content: + application/json: + schema: + $ref: '#/components/schemas/ism._common___ExplainIndexResponse' + description: '' + ism.get_policies___200: content: application/json: schema: - $ref: '#/components/schemas/ism._common:ExplainIndexResponse' - ism.get_policies@200: + $ref: '#/components/schemas/ism._common___GetPoliciesResponse' + description: '' + ism.get_policy___200: content: application/json: schema: - $ref: '#/components/schemas/ism._common:GetPoliciesResponse' - ism.get_policy@200: + $ref: '#/components/schemas/ism._common___GetPolicyResponse' + description: '' + ism.put_policies___200: content: application/json: schema: - $ref: '#/components/schemas/ism._common:GetPolicyResponse' - ism.put_policies@200: + $ref: '#/components/schemas/ism._common___PutPolicyResponse' + description: '' + ism.put_policy___200: content: application/json: schema: - $ref: '#/components/schemas/ism._common:PutPolicyResponse' - ism.put_policy@200: + $ref: '#/components/schemas/ism._common___PutPolicyResponse' + description: '' + ism.put_policy___201: content: application/json: schema: - $ref: '#/components/schemas/ism._common:PutPolicyResponse' - ism.put_policy@201: + $ref: '#/components/schemas/ism._common___PutPolicyResponse' + description: '' + ism.refresh_search_analyzers___200: content: application/json: schema: - $ref: '#/components/schemas/ism._common:PutPolicyResponse' - ism.refresh_search_analyzers@200: + $ref: '#/components/schemas/ism._common___RefreshSearchAnalyzersResponse' + description: '' + ism.remove_policy___200: content: application/json: schema: - $ref: '#/components/schemas/ism._common:RefreshSearchAnalyzersResponse' - ism.remove_policy@200: + $ref: '#/components/schemas/ism._common___RemovePolicyResponse' + description: '' + ism.retry_index___200: content: application/json: schema: - $ref: '#/components/schemas/ism._common:RemovePolicyResponse' - ism.retry_index@200: + $ref: '#/components/schemas/ism._common___RetryIndexResponse' + description: '' + knn.delete_model___200: + description: '' + knn.get_model___200: content: application/json: schema: - $ref: '#/components/schemas/ism._common:RetryIndexResponse' - knn.delete_model@200: {} - knn.get_model@200: {} - knn.search_models@200: {} - knn.stats@200: {} - knn.train_model@200: + type: object + description: '' + knn.search_models___200: + description: '' + knn.stats___200: + description: '' + knn.train_model___200: content: application/json: schema: @@ -28429,8 +29637,124 @@ components: type: string required: - model_id - knn.warmup@200: {} - mget@200: + description: '' + knn.warmup___200: + description: '' + list.help___200: + content: + text/plain: + schema: + type: string + description: '' + list.indices___200: + content: + text/plain: + schema: + type: string + application/json: + schema: + type: object + properties: + next_token: + type: + - 'null' + - string + indices: + type: array + items: + $ref: '#/components/schemas/cat.indices___IndicesRecord' + application/yaml: + schema: + type: object + properties: + next_token: + type: + - 'null' + - string + indices: + type: array + items: + $ref: '#/components/schemas/cat.indices___IndicesRecord' + application/cbor: + schema: + type: object + properties: + next_token: + type: + - 'null' + - string + indices: + type: array + items: + $ref: '#/components/schemas/cat.indices___IndicesRecord' + application/smile: + schema: + type: object + properties: + next_token: + type: + - 'null' + - string + indices: + type: array + items: + $ref: '#/components/schemas/cat.indices___IndicesRecord' + description: '' + list.shards___200: + content: + text/plain: + schema: + type: string + application/json: + schema: + type: object + properties: + next_token: + type: + - 'null' + - string + shards: + type: array + items: + $ref: '#/components/schemas/cat.shards___ShardsRecord' + application/yaml: + schema: + type: object + properties: + next_token: + type: + - 'null' + - string + shards: + type: array + items: + $ref: '#/components/schemas/cat.shards___ShardsRecord' + application/cbor: + schema: + type: object + properties: + next_token: + type: + - 'null' + - string + shards: + type: array + items: + $ref: '#/components/schemas/cat.shards___ShardsRecord' + application/smile: + schema: + type: object + properties: + next_token: + type: + - 'null' + - string + shards: + type: array + items: + $ref: '#/components/schemas/cat.shards___ShardsRecord' + description: '' + mget___200: content: application/json: schema: @@ -28439,10 +29763,11 @@ components: docs: type: array items: - $ref: '#/components/schemas/_core.mget:ResponseItem' + $ref: '#/components/schemas/_core.mget___ResponseItem' required: - docs - ml.create_connector@200: + description: '' + ml.create_connector___200: content: application/json: schema: @@ -28450,32 +29775,38 @@ components: properties: connector_id: type: string - ml.delete_agent@200: + description: '' + ml.delete_agent___200: content: application/json: schema: - $ref: '#/components/schemas/_common:WriteResponseBase' - ml.delete_connector@200: + $ref: '#/components/schemas/_common___WriteResponseBase' + description: '' + ml.delete_connector___200: content: application/json: schema: - $ref: '#/components/schemas/_common:WriteResponseBase' - ml.delete_model_group@200: + $ref: '#/components/schemas/_common___WriteResponseBase' + description: '' + ml.delete_model_group___200: content: application/json: schema: - $ref: '#/components/schemas/_common:WriteResponseBase' - ml.delete_model@200: + $ref: '#/components/schemas/_common___WriteResponseBase' + description: '' + ml.delete_model___200: content: application/json: schema: - $ref: '#/components/schemas/_common:WriteResponseBase' - ml.delete_task@200: + $ref: '#/components/schemas/_common___WriteResponseBase' + description: '' + ml.delete_task___200: content: application/json: schema: - $ref: '#/components/schemas/_common:WriteResponseBase' - ml.deploy_model@200: + $ref: '#/components/schemas/_common___WriteResponseBase' + description: '' + ml.deploy_model___200: content: application/json: schema: @@ -28490,17 +29821,20 @@ components: required: - status - task_id - ml.get_model_group@200: + description: '' + ml.get_model_group___200: content: application/json: schema: - $ref: '#/components/schemas/ml._common:ModelGroup' - ml.get_task@200: + $ref: '#/components/schemas/ml._common___ModelGroup' + description: '' + ml.get_task___200: content: application/json: schema: - $ref: '#/components/schemas/ml._common:Task' - ml.register_agents@200: + $ref: '#/components/schemas/ml._common___Task' + description: '' + ml.register_agents___200: content: application/json: schema: @@ -28508,12 +29842,14 @@ components: properties: agent_id: type: string - ml.register_model_group@200: + description: '' + ml.register_model_group___200: content: application/json: schema: - $ref: '#/components/schemas/ml._common:ModelGroupRegistration' - ml.register_model@200: + $ref: '#/components/schemas/ml._common___ModelGroupRegistration' + description: '' + ml.register_model___200: content: application/json: schema: @@ -28526,27 +29862,32 @@ components: required: - status - task_id - ml.search_models@200: + description: '' + ml.search_models___200: content: application/json: schema: - $ref: '#/components/schemas/ml._common:SearchModelsResponse' - ml.undeploy_model@200: + $ref: '#/components/schemas/ml._common___SearchModelsResponse' + description: '' + ml.undeploy_model___200: content: application/json: schema: - $ref: '#/components/schemas/ml._common:UndeployModelResponse' - msearch_template@200: + $ref: '#/components/schemas/ml._common___UndeployModelResponse' + description: '' + msearch_template___200: content: application/json: schema: - $ref: '#/components/schemas/_core.msearch:MultiSearchResult' - msearch@200: + $ref: '#/components/schemas/_core.msearch___MultiSearchResult' + description: '' + msearch___200: content: application/json: schema: - $ref: '#/components/schemas/_core.msearch:MultiSearchResult' - mtermvectors@200: + $ref: '#/components/schemas/_core.msearch___MultiSearchResult' + description: '' + mtermvectors___200: content: application/json: schema: @@ -28555,33 +29896,39 @@ components: docs: type: array items: - $ref: '#/components/schemas/_core.mtermvectors:TermVectorsResult' + $ref: '#/components/schemas/_core.mtermvectors___TermVectorsResult' required: - docs - nodes.hot_threads@200: + description: '' + nodes.hot_threads___200: content: text/plain: {} - nodes.info@200: + description: '' + nodes.info___200: content: application/json: schema: - $ref: '#/components/schemas/nodes.info:ResponseBase' - nodes.reload_secure_settings@200: + $ref: '#/components/schemas/nodes.info___ResponseBase' + description: '' + nodes.reload_secure_settings___200: content: application/json: schema: - $ref: '#/components/schemas/nodes.reload_secure_settings:ResponseBase' - nodes.stats@200: + $ref: '#/components/schemas/nodes.reload_secure_settings___ResponseBase' + description: '' + nodes.stats___200: content: application/json: schema: - $ref: '#/components/schemas/nodes.stats:ResponseBase' - nodes.usage@200: + $ref: '#/components/schemas/nodes.stats___ResponseBase' + description: '' + nodes.usage___200: content: application/json: schema: - $ref: '#/components/schemas/nodes.usage:ResponseBase' - notifications.create_config@200: + $ref: '#/components/schemas/nodes.usage___ResponseBase' + description: '' + notifications.create_config___200: content: application/json: schema: @@ -28589,27 +29936,32 @@ components: properties: config_id: type: string - notifications.delete_config@200: + description: '' + notifications.delete_config___200: content: application/json: schema: - $ref: '#/components/schemas/notifications._common:DeleteConfigsResponse' - notifications.delete_configs@200: + $ref: '#/components/schemas/notifications._common___DeleteConfigsResponse' + description: '' + notifications.delete_configs___200: content: application/json: schema: - $ref: '#/components/schemas/notifications._common:DeleteConfigsResponse' - notifications.get_config@200: + $ref: '#/components/schemas/notifications._common___DeleteConfigsResponse' + description: '' + notifications.get_config___200: content: application/json: schema: - $ref: '#/components/schemas/notifications._common:GetConfigsResponse' - notifications.get_configs@200: + $ref: '#/components/schemas/notifications._common___GetConfigsResponse' + description: '' + notifications.get_configs___200: content: application/json: schema: - $ref: '#/components/schemas/notifications._common:GetConfigsResponse' - notifications.list_channels@200: + $ref: '#/components/schemas/notifications._common___GetConfigsResponse' + description: '' + notifications.list_channels___200: content: application/json: schema: @@ -28622,12 +29974,13 @@ components: type: integer format: int64 total_hit_relation: - $ref: '#/components/schemas/notifications._common:TotalHitRelation' + $ref: '#/components/schemas/notifications._common___TotalHitRelation' channel_list: type: array items: - $ref: '#/components/schemas/notifications._common:NotificationChannel' - notifications.list_features@200: + $ref: '#/components/schemas/notifications._common___NotificationChannel' + description: '' + notifications.list_features___200: content: application/json: schema: @@ -28636,22 +29989,24 @@ components: allowed_config_type_list: type: array items: - $ref: '#/components/schemas/notifications._common:NotificationConfigType' + $ref: '#/components/schemas/notifications._common___NotificationConfigType' plugin_features: - $ref: '#/components/schemas/notifications._common:NotificationsPluginFeaturesMap' - notifications.send_test@200: + $ref: '#/components/schemas/notifications._common___NotificationsPluginFeaturesMap' + description: '' + notifications.send_test___200: content: application/json: schema: type: object properties: event_source: - $ref: '#/components/schemas/notifications._common:EventSource' + $ref: '#/components/schemas/notifications._common___EventSource' status_list: type: array items: - $ref: '#/components/schemas/notifications._common:EventStatus' - notifications.update_config@200: + $ref: '#/components/schemas/notifications._common___EventStatus' + description: '' + notifications.update_config___200: content: application/json: schema: @@ -28659,7 +30014,8 @@ components: properties: config_id: type: string - observability.create_object@200: + description: '' + observability.create_object___200: description: Created content: application/json: @@ -28668,7 +30024,7 @@ components: properties: objectId: type: string - observability.delete_object@200: + observability.delete_object___200: description: Deleted content: application/json: @@ -28679,14 +30035,13 @@ components: type: object additionalProperties: type: string - example: OK - observability.delete_object@404: + observability.delete_object___404: description: Not Found content: application/json: schema: - $ref: '#/components/schemas/observability._common:NotFoundResponse' - observability.delete_objects@200: + $ref: '#/components/schemas/observability._common___NotFoundResponse' + observability.delete_objects___200: description: Deleted content: application/json: @@ -28697,38 +30052,37 @@ components: type: object additionalProperties: type: string - example: OK - observability.delete_objects@404: + observability.delete_objects___404: description: Not Found content: application/json: schema: - $ref: '#/components/schemas/observability._common:NotFoundResponse' - observability.get_localstats@200: + $ref: '#/components/schemas/observability._common___NotFoundResponse' + observability.get_localstats___200: description: Retrieves content: application/json: schema: type: string - observability.get_object@200: + 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: + $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: + $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: + $ref: '#/components/schemas/observability._common___ObservabilityObjectList' + observability.update_object___200: description: Updated content: application/json: @@ -28737,94 +30091,96 @@ components: properties: objectId: type: string - observability.update_object@404: + observability.update_object___404: description: Not Found content: application/json: schema: - $ref: '#/components/schemas/observability._common:NotFoundResponse' - ping@200: + $ref: '#/components/schemas/observability._common___NotFoundResponse' + ping___200: content: application/json: {} - ppl.explain@200: + description: '' + ppl.explain___200: content: application/json: schema: - $ref: '#/components/schemas/sql._common:ExplainResponse' - required: true - ppl.get_stats@200: + $ref: '#/components/schemas/sql._common___ExplainResponse' + description: '' + ppl.get_stats___200: content: text/plain: schema: type: string - required: true - ppl.post_stats@200: + description: '' + ppl.post_stats___200: content: text/plain: schema: type: string - required: true - ppl.query@200: + description: '' + ppl.query___200: description: '' content: application/json: schema: - $ref: '#/components/schemas/sql._common:QueryResponse' - put_script@200: + $ref: '#/components/schemas/sql._common___QueryResponse' + put_script___200: content: application/json: schema: - $ref: '#/components/schemas/_common:AcknowledgedResponseBase' - query.datasource_delete@204: + $ref: '#/components/schemas/_common___AcknowledgedResponseBase' + description: '' + query.datasource_delete___204: description: No Content content: application/json: schema: type: object properties: {} - query.datasource_delete@404: + query.datasource_delete___404: description: Not Found content: application/json: schema: - $ref: '#/components/schemas/query._common:DataSourceNotFound' - query.datasource_retrieve@200: + $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: + $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: + $ref: '#/components/schemas/query._common___DataSourceNotFound' + query.datasources_create___201: description: Created content: application/json: schema: type: string - query.datasources_list@200: + 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: + $ref: '#/components/schemas/query._common___DataSourceList' + query.datasources_update___200: description: Updated content: application/json: schema: type: string - query.datasources_update@404: + query.datasources_update___404: description: Not Found content: application/json: schema: - $ref: '#/components/schemas/query._common:DataSourceNotFound' - rank_eval@200: + $ref: '#/components/schemas/query._common___DataSourceNotFound' + rank_eval___200: content: application/json: schema: @@ -28838,7 +30194,7 @@ components: description: The details section contains one entry for every query in the original requests section, keyed by the search request id type: object additionalProperties: - $ref: '#/components/schemas/_core.rank_eval:RankEvalMetricDetail' + $ref: '#/components/schemas/_core.rank_eval___RankEvalMetricDetail' failures: type: object additionalProperties: @@ -28847,7 +30203,8 @@ components: - details - failures - metric_score - reindex_rethrottle@200: + description: '' + reindex_rethrottle___200: content: application/json: schema: @@ -28856,20 +30213,22 @@ components: nodes: type: object additionalProperties: - $ref: '#/components/schemas/_core.reindex_rethrottle:ReindexNode' + $ref: '#/components/schemas/_core.reindex_rethrottle___ReindexNode' required: - nodes - reindex@200: + description: '' + reindex___200: content: application/json: schema: oneOf: - - $ref: '#/components/schemas/_common:BulkByScrollResponseBase' + - $ref: '#/components/schemas/_common___BulkByScrollResponseBase' - type: object properties: task: - $ref: '#/components/schemas/_common:TaskId' - remote_store.restore@200: + $ref: '#/components/schemas/_common___TaskId' + description: '' + remote_store.restore___200: content: application/json: schema: @@ -28878,7 +30237,7 @@ components: accepted: type: boolean remote_store: - $ref: '#/components/schemas/remote_store._common:RemoteStoreRestoreInfo' + $ref: '#/components/schemas/remote_store._common___RemoteStoreRestoreInfo' examples: RemoteStoreRestore_example1: summary: Examples for Post Remote Storage Restore Operation. @@ -28890,7 +30249,8 @@ components: total: 1 failed: 0 successful: 1 - render_search_template@200: + description: '' + render_search_template___200: content: application/json: schema: @@ -28902,25 +30262,98 @@ components: type: object required: - template_output - rollups.delete@200: {} - rollups.explain@200: + description: '' + replication.autofollow_stats___200: content: application/json: schema: - $ref: '#/components/schemas/rollups._common:ExplainEntities' - rollups.get@200: + $ref: '#/components/schemas/replication._common___AutoFollowStatus' + description: '' + replication.create_replication_rule___200: content: application/json: schema: - $ref: '#/components/schemas/rollups._common:RollupEntity' - rollups.put@200: + $ref: '#/components/schemas/_common___AcknowledgedResponseBase' + description: '' + replication.delete_replication_rule___200: content: application/json: schema: - $ref: '#/components/schemas/rollups._common:RollupEntity' - rollups.start@200: {} - rollups.stop@200: {} - scripts_painless_execute@200: + $ref: '#/components/schemas/_common___AcknowledgedResponseBase' + description: '' + replication.follower_stats___200: + content: + application/json: + schema: + $ref: '#/components/schemas/replication._common___FollowerStatus' + description: '' + replication.leader_stats___200: + content: + application/json: + schema: + $ref: '#/components/schemas/replication._common___LeaderStatus' + description: '' + replication.pause___200: + content: + application/json: + schema: + $ref: '#/components/schemas/_common___AcknowledgedResponseBase' + description: '' + replication.resume___200: + content: + application/json: + schema: + $ref: '#/components/schemas/_common___AcknowledgedResponseBase' + description: '' + replication.start___200: + content: + application/json: + schema: + $ref: '#/components/schemas/_common___AcknowledgedResponseBase' + description: '' + replication.status___200: + content: + application/json: + schema: + $ref: '#/components/schemas/replication._common___Status' + description: '' + replication.stop___200: + content: + application/json: + schema: + $ref: '#/components/schemas/_common___AcknowledgedResponseBase' + description: '' + replication.update_settings___200: + content: + application/json: + schema: + $ref: '#/components/schemas/_common___AcknowledgedResponseBase' + description: '' + rollups.delete___200: + description: '' + rollups.explain___200: + content: + application/json: + schema: + $ref: '#/components/schemas/rollups._common___ExplainEntities' + description: '' + rollups.get___200: + content: + application/json: + schema: + $ref: '#/components/schemas/rollups._common___RollupEntity' + description: '' + rollups.put___200: + content: + application/json: + schema: + $ref: '#/components/schemas/rollups._common___RollupEntity' + description: '' + rollups.start___200: + description: '' + rollups.stop___200: + description: '' + scripts_painless_execute___200: content: application/json: schema: @@ -28930,12 +30363,14 @@ components: type: object required: - result - scroll@200: + description: '' + scroll___200: content: application/json: schema: - $ref: '#/components/schemas/_core.search:ResponseBody' - search_pipeline.delete@200: + $ref: '#/components/schemas/_core.search___ResponseBody' + description: '' + search_pipeline.delete___200: content: application/json: schema: @@ -28943,12 +30378,14 @@ components: properties: acknowledged: type: boolean - search_pipeline.get@200: + description: '' + search_pipeline.get___200: content: application/json: schema: - $ref: '#/components/schemas/search_pipeline._common:SearchPipelineMap' - search_pipeline.put@200: + $ref: '#/components/schemas/search_pipeline._common___SearchPipelineMap' + description: '' + search_pipeline.put___200: content: application/json: schema: @@ -28956,7 +30393,8 @@ components: properties: acknowledged: type: boolean - search_shards@200: + description: '' + search_shards___200: content: application/json: schema: @@ -28965,22 +30403,23 @@ components: nodes: type: object additionalProperties: - $ref: '#/components/schemas/_common:NodeAttributes' + $ref: '#/components/schemas/_common___NodeAttributes' shards: type: array items: type: array items: - $ref: '#/components/schemas/_common:NodeShard' + $ref: '#/components/schemas/_common___NodeShard' indices: type: object additionalProperties: - $ref: '#/components/schemas/_core.search_shards:ShardStoreIndex' + $ref: '#/components/schemas/_core.search_shards___ShardStoreIndex' required: - indices - nodes - shards - search_template@200: + description: '' + search_template___200: content: application/json: schema: @@ -28992,15 +30431,15 @@ components: timed_out: type: boolean _shards: - $ref: '#/components/schemas/_common:ShardStatistics' + $ref: '#/components/schemas/_common___ShardStatistics' hits: - $ref: '#/components/schemas/_core.search:HitsMetadata' + $ref: '#/components/schemas/_core.search___HitsMetadata' aggregations: type: object additionalProperties: - $ref: '#/components/schemas/_common.aggregations:Aggregate' + $ref: '#/components/schemas/_common.aggregations___Aggregate' _clusters: - $ref: '#/components/schemas/_common:ClusterStatistics' + $ref: '#/components/schemas/_common___ClusterStatistics' fields: type: object additionalProperties: @@ -29012,17 +30451,17 @@ components: type: integer format: int32 profile: - $ref: '#/components/schemas/_core.search:Profile' + $ref: '#/components/schemas/_core.search___Profile' pit_id: - $ref: '#/components/schemas/_common:Id' + $ref: '#/components/schemas/_common___Id' _scroll_id: - $ref: '#/components/schemas/_common:ScrollId' + $ref: '#/components/schemas/_common___ScrollId' suggest: type: object additionalProperties: type: array items: - $ref: '#/components/schemas/_core.search:Suggest' + $ref: '#/components/schemas/_core.search___Suggest' terminated_early: type: boolean required: @@ -29030,678 +30469,865 @@ components: - hits - timed_out - took - search@200: + description: '' + search___200: content: application/json: schema: - $ref: '#/components/schemas/_core.search:ResponseBody' - search@400: + $ref: '#/components/schemas/_core.search___ResponseBody' + description: '' + search___400: content: application/json: schema: - $ref: '#/components/schemas/query._common:ErrorResponse' - search@404: + $ref: '#/components/schemas/query._common___ErrorResponse' + description: '' + search___404: content: application/json: schema: - $ref: '#/components/schemas/query._common:ErrorResponse' - security.authinfo@200: + $ref: '#/components/schemas/query._common___ErrorResponse' + description: '' + security.authinfo___200: content: application/json: schema: - $ref: '#/components/schemas/security._common:AuthInfo' - security.authinfo@500: + $ref: '#/components/schemas/security._common___AuthInfo' + description: '' + security.authinfo___500: content: application/json: schema: - $ref: '#/components/schemas/security._common:InternalServerError' - security.authtoken@200: + $ref: '#/components/schemas/security._common___InternalServerError' + description: '' + security.authtoken___200: content: application/json: schema: - $ref: '#/components/schemas/security._common:Ok' - security.cache@501: + $ref: '#/components/schemas/security._common___Ok' + description: '' + security.cache___501: content: application/json: - schema: null - security.change_password@200: + schema: + $ref: '#/components/schemas/security._common___Error' + description: '' + security.change_password___200: content: application/json: schema: - $ref: '#/components/schemas/security._common:Ok' - security.change_password@403: + $ref: '#/components/schemas/security._common___Ok' + description: '' + security.change_password___403: content: application/json: - schema: null - security.config_upgrade_check@200: + schema: + $ref: '#/components/schemas/security._common___Error' + description: '' + security.config_upgrade_check___200: content: application/json: schema: - $ref: '#/components/schemas/security._common:UpgradeCheck' - security.config_upgrade_perform@200: + $ref: '#/components/schemas/security._common___UpgradeCheck' + description: '' + security.config_upgrade_perform___200: content: application/json: schema: - $ref: '#/components/schemas/security._common:UpgradePerform' - security.config_upgrade_perform@400: + $ref: '#/components/schemas/security._common___UpgradePerform' + description: '' + security.config_upgrade_perform___400: content: application/json: - schema: null - security.create_action_group@200: + schema: + $ref: '#/components/schemas/security._common___Error' + description: '' + security.create_action_group___200: content: application/json: schema: - $ref: '#/components/schemas/security._common:Ok' - security.create_action_group@201: + $ref: '#/components/schemas/security._common___Ok' + description: '' + security.create_action_group___201: content: application/json: schema: - $ref: '#/components/schemas/security._common:Created' - security.create_allowlist@200: + $ref: '#/components/schemas/security._common___Created' + description: '' + security.create_allowlist___200: content: application/json: schema: - $ref: '#/components/schemas/security._common:AllowListConfig' - security.create_allowlist@403: + $ref: '#/components/schemas/security._common___AllowListConfig' + description: '' + security.create_allowlist___403: content: application/json: - schema: null - security.create_role_mapping@200: + schema: + $ref: '#/components/schemas/security._common___Error' + description: '' + security.create_role_mapping___200: content: application/json: schema: - $ref: '#/components/schemas/security._common:Ok' - security.create_role_mapping@201: + $ref: '#/components/schemas/security._common___Ok' + description: '' + security.create_role_mapping___201: content: application/json: schema: - $ref: '#/components/schemas/security._common:Created' - security.create_role@200: + $ref: '#/components/schemas/security._common___Created' + description: '' + security.create_role___200: content: application/json: schema: - $ref: '#/components/schemas/security._common:Ok' - security.create_role@201: + $ref: '#/components/schemas/security._common___Ok' + description: '' + security.create_role___201: content: application/json: schema: - $ref: '#/components/schemas/security._common:Created' - security.create_tenant@200: + $ref: '#/components/schemas/security._common___Created' + description: '' + security.create_tenant___200: content: application/json: schema: - $ref: '#/components/schemas/security._common:Ok' - security.create_tenant@201: + $ref: '#/components/schemas/security._common___Ok' + description: '' + security.create_tenant___201: content: application/json: schema: - $ref: '#/components/schemas/security._common:Created' - security.create_tenant@400: + $ref: '#/components/schemas/security._common___Created' + description: '' + security.create_tenant___400: content: application/json: - schema: null - security.create_update_tenancy_config@200: + schema: + $ref: '#/components/schemas/security._common___Error' + description: '' + security.create_update_tenancy_config___200: content: application/json: schema: - $ref: '#/components/schemas/security._common:MultiTenancyConfig' - security.create_update_tenancy_config@400: + $ref: '#/components/schemas/security._common___MultiTenancyConfig' + description: '' + security.create_update_tenancy_config___400: content: application/json: - schema: null - security.create_user_legacy@200: + schema: + $ref: '#/components/schemas/security._common___Error' + description: '' + security.create_user_legacy___200: content: application/json: schema: - $ref: '#/components/schemas/security._common:Ok' - security.create_user_legacy@201: + $ref: '#/components/schemas/security._common___Ok' + description: '' + security.create_user_legacy___201: content: application/json: schema: - $ref: '#/components/schemas/security._common:Created' - security.create_user@200: + $ref: '#/components/schemas/security._common___Created' + description: '' + security.create_user___200: content: application/json: schema: - $ref: '#/components/schemas/security._common:Ok' - security.delete_action_group@200: + $ref: '#/components/schemas/security._common___Ok' + description: '' + security.delete_action_group___200: content: application/json: schema: - $ref: '#/components/schemas/security._common:Ok' - security.delete_distinguished_name@200: + $ref: '#/components/schemas/security._common___Ok' + description: '' + security.delete_distinguished_name___200: content: application/json: schema: - $ref: '#/components/schemas/security._common:Ok' - security.delete_distinguished_name@400: + $ref: '#/components/schemas/security._common___Ok' + description: '' + security.delete_distinguished_name___400: content: application/json: - schema: null - security.delete_distinguished_name@403: + schema: + $ref: '#/components/schemas/security._common___Error' + description: '' + security.delete_distinguished_name___403: content: application/json: - schema: null - security.delete_role_mapping@200: + schema: + $ref: '#/components/schemas/security._common___Error' + description: '' + security.delete_role_mapping___200: content: application/json: schema: - $ref: '#/components/schemas/security._common:Ok' - security.delete_role@200: + $ref: '#/components/schemas/security._common___Ok' + description: '' + security.delete_role___200: content: application/json: schema: - $ref: '#/components/schemas/security._common:Ok' - security.delete_tenant@200: + $ref: '#/components/schemas/security._common___Ok' + description: '' + security.delete_tenant___200: content: application/json: schema: - $ref: '#/components/schemas/security._common:Ok' - security.delete_tenant@400: + $ref: '#/components/schemas/security._common___Ok' + description: '' + security.delete_tenant___400: content: application/json: - schema: null - security.delete_user_legacy@200: + schema: + $ref: '#/components/schemas/security._common___Error' + description: '' + security.delete_user_legacy___200: content: application/json: schema: - $ref: '#/components/schemas/security._common:Ok' - security.delete_user@200: + $ref: '#/components/schemas/security._common___Ok' + description: '' + security.delete_user___200: content: application/json: schema: - $ref: '#/components/schemas/security._common:Ok' - security.flush_cache@200: + $ref: '#/components/schemas/security._common___Ok' + description: '' + security.flush_cache___200: content: application/json: schema: - $ref: '#/components/schemas/security._common:Ok' - security.generate_obo_token@200: + $ref: '#/components/schemas/security._common___Ok' + description: '' + security.generate_obo_token___200: content: application/json: schema: - $ref: '#/components/schemas/security._common:GenerateOBOToken' - security.generate_obo_token@400: + $ref: '#/components/schemas/security._common___GenerateOBOToken' + description: '' + security.generate_obo_token___400: content: text/plain: - type: string + schema: + type: string application/json: - schema: null - security.generate_user_token_legacy@501: + schema: + $ref: '#/components/schemas/security._common___Error' + description: '' + security.generate_user_token_legacy___501: content: application/json: - schema: null - security.generate_user_token@200: + schema: + $ref: '#/components/schemas/security._common___Error' + description: '' + security.generate_user_token___200: content: application/json: schema: - $ref: '#/components/schemas/security._common:Ok' - security.generate_user_token@400: + $ref: '#/components/schemas/security._common___Ok' + description: '' + security.generate_user_token___400: content: application/json: - schema: null - security.get_account_details@200: + schema: + $ref: '#/components/schemas/security._common___Error' + description: '' + security.get_account_details___200: content: application/json: schema: - $ref: '#/components/schemas/security._common:AccountDetails' - security.get_action_group@200: + $ref: '#/components/schemas/security._common___AccountDetails' + description: '' + security.get_action_group___200: content: application/json: schema: - $ref: '#/components/schemas/security._common:ActionGroupsMap' - security.get_action_groups@200: + $ref: '#/components/schemas/security._common___ActionGroupsMap' + description: '' + security.get_action_groups___200: content: application/json: schema: - $ref: '#/components/schemas/security._common:ActionGroupsMap' - security.get_all_certificates@200: + $ref: '#/components/schemas/security._common___ActionGroupsMap' + description: '' + security.get_all_certificates___200: content: application/json: schema: - $ref: '#/components/schemas/security._common:GetCertificatesNew' - security.get_all_certificates@403: + $ref: '#/components/schemas/security._common___GetCertificatesNew' + description: '' + security.get_all_certificates___403: content: application/json: - schema: null - security.get_all_certificates@500: + schema: + $ref: '#/components/schemas/security._common___Error' + description: '' + security.get_all_certificates___500: content: application/json: schema: - $ref: '#/components/schemas/security._common:InternalServerError' - security.get_allowlist@200: + $ref: '#/components/schemas/security._common___InternalServerError' + description: '' + security.get_allowlist___200: content: application/json: schema: - $ref: '#/components/schemas/security._common:AllowListConfig' - security.get_allowlist@403: + $ref: '#/components/schemas/security._common___AllowListConfig' + description: '' + security.get_allowlist___403: content: application/json: - schema: null - security.get_audit_configuration@200: + schema: + $ref: '#/components/schemas/security._common___Error' + description: '' + security.get_audit_configuration___200: content: application/json: schema: - $ref: '#/components/schemas/security._common:AuditConfigWithReadOnly' - security.get_certificates@200: + $ref: '#/components/schemas/security._common___AuditConfigWithReadOnly' + description: '' + security.get_certificates___200: content: application/json: schema: - $ref: '#/components/schemas/security._common:GetCertificates' - security.get_certificates@400: + $ref: '#/components/schemas/security._common___GetCertificates' + description: '' + security.get_certificates___400: content: application/json: - schema: null - security.get_certificates@403: + schema: + $ref: '#/components/schemas/security._common___Error' + description: '' + security.get_certificates___403: content: application/json: - schema: null - security.get_configuration@200: + schema: + $ref: '#/components/schemas/security._common___Error' + description: '' + security.get_configuration___200: content: application/json: schema: - $ref: '#/components/schemas/security._common:SecurityConfig' - security.get_dashboards_info@200: + $ref: '#/components/schemas/security._common___SecurityConfig' + description: '' + security.get_dashboards_info___200: content: application/json: schema: - $ref: '#/components/schemas/security._common:DashboardsInfo' - security.get_dashboards_info@500: + $ref: '#/components/schemas/security._common___DashboardsInfo' + description: '' + security.get_dashboards_info___500: content: application/json: schema: - $ref: '#/components/schemas/security._common:InternalServerError' - security.get_distinguished_name@200: - description: Show nodesDn setting for given cluster. + $ref: '#/components/schemas/security._common___InternalServerError' + description: '' + security.get_distinguished_name___200: + description: Show `nodesDn` setting for given cluster. content: application/json: schema: - $ref: '#/components/schemas/security._common:DistinguishedNames' - security.get_distinguished_name@400: + $ref: '#/components/schemas/security._common___DistinguishedNames' + security.get_distinguished_name___400: content: application/json: - schema: null - security.get_distinguished_name@403: + schema: + $ref: '#/components/schemas/security._common___Error' + description: '' + security.get_distinguished_name___403: content: application/json: - schema: null - security.get_distinguished_names@200: + schema: + $ref: '#/components/schemas/security._common___Error' + description: '' + security.get_distinguished_names___200: content: application/json: schema: - $ref: '#/components/schemas/security._common:DistinguishedNamesMap' - security.get_distinguished_names@400: - description: Show nodesDn setting for given cluster. + $ref: '#/components/schemas/security._common___DistinguishedNamesMap' + description: '' + security.get_distinguished_names___400: + description: Show `nodesDn` setting for given cluster. content: application/json: - schema: null - security.get_distinguished_names@403: + schema: + $ref: '#/components/schemas/security._common___Error' + security.get_distinguished_names___403: content: application/json: - schema: null - security.get_node_certificates@200: + schema: + $ref: '#/components/schemas/security._common___Error' + description: '' + security.get_node_certificates___200: content: application/json: schema: - $ref: '#/components/schemas/security._common:GetCertificatesNew' - security.get_node_certificates@403: + $ref: '#/components/schemas/security._common___GetCertificatesNew' + description: '' + security.get_node_certificates___403: content: application/json: - schema: null - security.get_node_certificates@500: + schema: + $ref: '#/components/schemas/security._common___Error' + description: '' + security.get_node_certificates___500: content: application/json: schema: - $ref: '#/components/schemas/security._common:InternalServerError' - security.get_permissions_info@200: + $ref: '#/components/schemas/security._common___InternalServerError' + description: '' + security.get_permissions_info___200: content: application/json: schema: - $ref: '#/components/schemas/security._common:PermissionsInfo' - security.get_permissions_info@500: + $ref: '#/components/schemas/security._common___PermissionsInfo' + description: '' + security.get_permissions_info___500: content: application/json: schema: - $ref: '#/components/schemas/security._common:InternalServerError' - security.get_role_mapping@200: + $ref: '#/components/schemas/security._common___InternalServerError' + description: '' + security.get_role_mapping___200: content: application/json: schema: - $ref: '#/components/schemas/security._common:RoleMappings' - security.get_role_mappings@200: + $ref: '#/components/schemas/security._common___RoleMappings' + description: '' + security.get_role_mappings___200: content: application/json: schema: - $ref: '#/components/schemas/security._common:RoleMappings' - security.get_role@200: + $ref: '#/components/schemas/security._common___RoleMappings' + description: '' + security.get_role___200: content: application/json: schema: - $ref: '#/components/schemas/security._common:RolesMap' - security.get_roles@200: + $ref: '#/components/schemas/security._common___RolesMap' + description: '' + security.get_roles___200: content: application/json: schema: - $ref: '#/components/schemas/security._common:RolesMap' - security.get_sslinfo@200: + $ref: '#/components/schemas/security._common___RolesMap' + description: '' + security.get_sslinfo___200: content: application/json: schema: - $ref: '#/components/schemas/security._common:SSLInfo' - security.get_sslinfo@500: + $ref: '#/components/schemas/security._common___SSLInfo' + description: '' + security.get_sslinfo___500: content: application/json: schema: - $ref: '#/components/schemas/security._common:InternalServerError' - security.get_tenancy_config@200: + $ref: '#/components/schemas/security._common___InternalServerError' + description: '' + security.get_tenancy_config___200: content: application/json: schema: - $ref: '#/components/schemas/security._common:MultiTenancyConfig' - security.get_tenancy_config@400: + $ref: '#/components/schemas/security._common___MultiTenancyConfig' + description: '' + security.get_tenancy_config___400: content: application/json: - schema: null - security.get_tenant@200: + schema: + $ref: '#/components/schemas/security._common___Error' + description: '' + security.get_tenant___200: content: application/json: schema: - $ref: '#/components/schemas/security._common:TenantsMap' - security.get_tenants@200: + $ref: '#/components/schemas/security._common___TenantsMap' + description: '' + security.get_tenants___200: content: application/json: schema: - $ref: '#/components/schemas/security._common:TenantsMap' - security.get_tenants@400: + $ref: '#/components/schemas/security._common___TenantsMap' + description: '' + security.get_tenants___400: content: application/json: - schema: null - security.get_user_legacy@200: + schema: + $ref: '#/components/schemas/security._common___Error' + description: '' + security.get_user_legacy___200: content: application/json: schema: - $ref: '#/components/schemas/security._common:UsersMap' - security.get_user@200: + $ref: '#/components/schemas/security._common___UsersMap' + description: '' + security.get_user___200: content: application/json: schema: - $ref: '#/components/schemas/security._common:UsersMap' - security.get_users_legacy@200: + $ref: '#/components/schemas/security._common___UsersMap' + description: '' + security.get_users_legacy___200: content: application/json: schema: - $ref: '#/components/schemas/security._common:UsersMap' - security.get_users@200: + $ref: '#/components/schemas/security._common___UsersMap' + description: '' + security.get_users___200: content: application/json: schema: - $ref: '#/components/schemas/security._common:UsersMap' - security.health@200: + $ref: '#/components/schemas/security._common___UsersMap' + description: '' + security.health___200: content: application/json: schema: - $ref: '#/components/schemas/security._common:HealthInfo' - security.migrate@200: + $ref: '#/components/schemas/security._common___HealthInfo' + description: '' + security.migrate___200: content: application/json: schema: - $ref: '#/components/schemas/security._common:Ok' - security.migrate@400: + $ref: '#/components/schemas/security._common___Ok' + description: '' + security.migrate___400: content: application/json: - schema: null - security.patch_action_group@200: + schema: + $ref: '#/components/schemas/security._common___Error' + description: '' + security.patch_action_group___200: content: application/json: schema: - $ref: '#/components/schemas/security._common:Ok' - security.patch_action_groups@200: + $ref: '#/components/schemas/security._common___Ok' + description: '' + security.patch_action_groups___200: content: application/json: schema: - $ref: '#/components/schemas/security._common:Ok' - security.patch_allowlist@200: + $ref: '#/components/schemas/security._common___Ok' + description: '' + security.patch_allowlist___200: content: application/json: schema: - $ref: '#/components/schemas/security._common:AllowListConfig' - security.patch_allowlist@403: + $ref: '#/components/schemas/security._common___AllowListConfig' + description: '' + security.patch_allowlist___403: content: application/json: - schema: null - security.patch_audit_configuration@200: + schema: + $ref: '#/components/schemas/security._common___Error' + description: '' + security.patch_audit_configuration___200: content: application/json: schema: - $ref: '#/components/schemas/security._common:Ok' - security.patch_configuration@200: + $ref: '#/components/schemas/security._common___Ok' + description: '' + security.patch_configuration___200: content: application/json: schema: - $ref: '#/components/schemas/security._common:Ok' - security.patch_configuration@403: + $ref: '#/components/schemas/security._common___Ok' + description: '' + security.patch_configuration___403: content: application/json: - schema: null - security.patch_distinguished_name@200: + schema: + $ref: '#/components/schemas/security._common___Error' + description: '' + security.patch_distinguished_name___200: content: application/json: schema: - $ref: '#/components/schemas/security._common:Ok' - security.patch_distinguished_name@400: + $ref: '#/components/schemas/security._common___Ok' + description: '' + security.patch_distinguished_name___400: content: application/json: - schema: null - security.patch_distinguished_name@403: + schema: + $ref: '#/components/schemas/security._common___Error' + description: '' + security.patch_distinguished_name___403: content: application/json: - schema: null - security.patch_distinguished_names@200: + schema: + $ref: '#/components/schemas/security._common___Error' + description: '' + security.patch_distinguished_names___200: content: application/json: schema: - $ref: '#/components/schemas/security._common:Ok' - security.patch_distinguished_names@400: + $ref: '#/components/schemas/security._common___Ok' + description: '' + security.patch_distinguished_names___400: content: application/json: - schema: null - security.patch_distinguished_names@403: + schema: + $ref: '#/components/schemas/security._common___Error' + description: '' + security.patch_distinguished_names___403: content: application/json: - schema: null - security.patch_role_mapping@200: + schema: + $ref: '#/components/schemas/security._common___Error' + description: '' + security.patch_role_mapping___200: content: application/json: schema: - $ref: '#/components/schemas/security._common:Ok' - security.patch_role_mapping@400: + $ref: '#/components/schemas/security._common___Ok' + description: '' + security.patch_role_mapping___400: content: application/json: - schema: null - security.patch_role_mappings@200: + schema: + $ref: '#/components/schemas/security._common___Error' + description: '' + security.patch_role_mappings___200: content: application/json: schema: - $ref: '#/components/schemas/security._common:Ok' - security.patch_role_mappings@400: + $ref: '#/components/schemas/security._common___Ok' + description: '' + security.patch_role_mappings___400: content: application/json: - schema: null - security.patch_role@200: + schema: + $ref: '#/components/schemas/security._common___Error' + description: '' + security.patch_role___200: content: application/json: schema: - $ref: '#/components/schemas/security._common:Ok' - security.patch_role@400: + $ref: '#/components/schemas/security._common___Ok' + description: '' + security.patch_role___400: content: application/json: - schema: null - security.patch_roles@200: + schema: + $ref: '#/components/schemas/security._common___Error' + description: '' + security.patch_roles___200: content: application/json: schema: - $ref: '#/components/schemas/security._common:Ok' - security.patch_roles@400: + $ref: '#/components/schemas/security._common___Ok' + description: '' + security.patch_roles___400: content: application/json: - schema: null - security.patch_tenant@200: + schema: + $ref: '#/components/schemas/security._common___Error' + description: '' + security.patch_tenant___200: content: application/json: schema: - $ref: '#/components/schemas/security._common:Ok' - security.patch_tenant@400: + $ref: '#/components/schemas/security._common___Ok' + description: '' + security.patch_tenant___400: content: application/json: - schema: null - security.patch_tenants@200: + schema: + $ref: '#/components/schemas/security._common___Error' + description: '' + security.patch_tenants___200: content: application/json: schema: - $ref: '#/components/schemas/security._common:Ok' - security.patch_tenants@400: + $ref: '#/components/schemas/security._common___Ok' + description: '' + security.patch_tenants___400: content: application/json: - schema: null - security.patch_user@200: + schema: + $ref: '#/components/schemas/security._common___Error' + description: '' + security.patch_user___200: content: application/json: schema: - $ref: '#/components/schemas/security._common:Ok' - security.patch_users@200: + $ref: '#/components/schemas/security._common___Ok' + description: '' + security.patch_users___200: content: application/json: schema: - $ref: '#/components/schemas/security._common:Ok' - security.post_dashboards_info@200: + $ref: '#/components/schemas/security._common___Ok' + description: '' + security.post_dashboards_info___200: content: application/json: schema: - $ref: '#/components/schemas/security._common:DashboardsInfo' - security.post_dashboards_info@500: + $ref: '#/components/schemas/security._common___DashboardsInfo' + description: '' + security.post_dashboards_info___500: content: application/json: schema: - $ref: '#/components/schemas/security._common:InternalServerError' - security.reload_http_certificates@200: + $ref: '#/components/schemas/security._common___InternalServerError' + description: '' + security.reload_http_certificates___200: content: application/json: schema: - $ref: '#/components/schemas/security._common:Ok' - security.reload_http_certificates@400: + $ref: '#/components/schemas/security._common___Ok' + description: '' + security.reload_http_certificates___400: content: application/json: - schema: null - security.reload_http_certificates@403: + schema: + $ref: '#/components/schemas/security._common___Error' + description: '' + security.reload_http_certificates___403: content: application/json: - schema: null - security.reload_transport_certificates@200: + schema: + $ref: '#/components/schemas/security._common___Error' + description: '' + security.reload_transport_certificates___200: content: application/json: schema: - $ref: '#/components/schemas/security._common:Ok' - security.reload_transport_certificates@400: + $ref: '#/components/schemas/security._common___Ok' + description: '' + security.reload_transport_certificates___400: content: application/json: - schema: null - security.reload_transport_certificates@403: + schema: + $ref: '#/components/schemas/security._common___Error' + description: '' + security.reload_transport_certificates___403: content: application/json: - schema: null - security.tenant_info@200: + schema: + $ref: '#/components/schemas/security._common___Error' + description: '' + security.tenant_info___200: content: application/json: schema: - $ref: '#/components/schemas/security._common:TenantInfo' - security.tenant_info@403: + $ref: '#/components/schemas/security._common___TenantInfo' + description: '' + security.tenant_info___403: content: text/plain: - type: string + schema: + type: string application/json: - schema: null - security.tenant_info@500: + schema: + $ref: '#/components/schemas/security._common___Error' + description: '' + security.tenant_info___500: content: application/json: schema: - $ref: '#/components/schemas/security._common:InternalServerError' - security.update_audit_configuration@200: + $ref: '#/components/schemas/security._common___InternalServerError' + description: '' + security.update_audit_configuration___200: content: application/json: schema: - $ref: '#/components/schemas/security._common:Ok' - security.update_configuration@200: + $ref: '#/components/schemas/security._common___Ok' + description: '' + security.update_configuration___200: content: application/json: schema: - $ref: '#/components/schemas/security._common:Ok' - security.update_configuration@403: + $ref: '#/components/schemas/security._common___Ok' + description: '' + security.update_configuration___403: content: application/json: - schema: null - security.update_distinguished_name@200: + schema: + $ref: '#/components/schemas/security._common___Error' + description: '' + security.update_distinguished_name___200: content: application/json: schema: - $ref: '#/components/schemas/security._common:Ok' - security.update_distinguished_name@400: + $ref: '#/components/schemas/security._common___Ok' + description: '' + security.update_distinguished_name___400: content: application/json: - schema: null - security.update_distinguished_name@403: + schema: + $ref: '#/components/schemas/security._common___Error' + description: '' + security.update_distinguished_name___403: content: application/json: - schema: null - security.validate@200: + schema: + $ref: '#/components/schemas/security._common___Error' + description: '' + security.validate___200: content: application/json: schema: - $ref: '#/components/schemas/security._common:Ok' - security.validate@400: + $ref: '#/components/schemas/security._common___Ok' + description: '' + security.validate___400: content: application/json: - schema: null - security.who_am_i_protected@200: + schema: + $ref: '#/components/schemas/security._common___Error' + description: '' + security.who_am_i_protected___200: content: application/json: schema: - $ref: '#/components/schemas/security._common:WhoAmI' - security.who_am_i_protected@500: + $ref: '#/components/schemas/security._common___WhoAmI' + description: '' + security.who_am_i_protected___500: content: application/json: schema: - $ref: '#/components/schemas/security._common:InternalServerError' - security.who_am_i@200: + $ref: '#/components/schemas/security._common___InternalServerError' + description: '' + security.who_am_i___200: content: application/json: schema: - $ref: '#/components/schemas/security._common:WhoAmI' - security.who_am_i@500: + $ref: '#/components/schemas/security._common___WhoAmI' + description: '' + security.who_am_i___500: content: application/json: schema: - $ref: '#/components/schemas/security._common:InternalServerError' - snapshot.cleanup_repository@200: + $ref: '#/components/schemas/security._common___InternalServerError' + description: '' + snapshot.cleanup_repository___200: content: application/json: schema: type: object properties: results: - $ref: '#/components/schemas/snapshot.cleanup_repository:CleanupRepositoryResults' + $ref: '#/components/schemas/snapshot.cleanup_repository___CleanupRepositoryResults' required: - results - snapshot.clone@200: + description: '' + snapshot.clone___200: content: application/json: schema: - $ref: '#/components/schemas/_common:AcknowledgedResponseBase' - snapshot.create_repository@200: + $ref: '#/components/schemas/_common___AcknowledgedResponseBase' + description: '' + snapshot.create_repository___200: content: application/json: schema: - $ref: '#/components/schemas/_common:AcknowledgedResponseBase' - snapshot.create@200: + $ref: '#/components/schemas/_common___AcknowledgedResponseBase' + description: '' + snapshot.create___200: content: application/json: schema: @@ -29711,25 +31337,29 @@ components: description: Returns `true` if the snapshot was accepted. Present when the request had `wait_for_completion` set to `false`. type: boolean snapshot: - $ref: '#/components/schemas/snapshot._common:SnapshotInfo' - snapshot.delete_repository@200: + $ref: '#/components/schemas/snapshot._common___SnapshotInfo' + description: '' + snapshot.delete_repository___200: content: application/json: schema: - $ref: '#/components/schemas/_common:AcknowledgedResponseBase' - snapshot.delete@200: + $ref: '#/components/schemas/_common___AcknowledgedResponseBase' + description: '' + snapshot.delete___200: content: application/json: schema: - $ref: '#/components/schemas/_common:AcknowledgedResponseBase' - snapshot.get_repository@200: + $ref: '#/components/schemas/_common___AcknowledgedResponseBase' + description: '' + snapshot.get_repository___200: content: application/json: schema: type: object additionalProperties: - $ref: '#/components/schemas/snapshot._common:Repository' - snapshot.get@200: + $ref: '#/components/schemas/snapshot._common___Repository' + description: '' + snapshot.get___200: content: application/json: schema: @@ -29738,10 +31368,11 @@ components: snapshots: type: array items: - $ref: '#/components/schemas/snapshot._common:SnapshotInfo' + $ref: '#/components/schemas/snapshot._common___SnapshotInfo' required: - snapshots - snapshot.restore@200: + description: '' + snapshot.restore___200: content: application/json: schema: @@ -29751,8 +31382,9 @@ components: description: Returns `true` if the restore was accepted. Present when the request had `wait_for_completion` set to `false`. type: boolean snapshot: - $ref: '#/components/schemas/snapshot.restore:SnapshotRestore' - snapshot.status@200: + $ref: '#/components/schemas/snapshot.restore___SnapshotRestore' + description: '' + snapshot.status___200: content: application/json: schema: @@ -29761,10 +31393,11 @@ components: snapshots: type: array items: - $ref: '#/components/schemas/snapshot._common:Status' + $ref: '#/components/schemas/snapshot._common___Status' required: - snapshots - snapshot.verify_repository@200: + description: '' + snapshot.verify_repository___200: content: application/json: schema: @@ -29773,49 +31406,53 @@ components: nodes: type: object additionalProperties: - $ref: '#/components/schemas/snapshot.verify_repository:CompactNodeInfo' + $ref: '#/components/schemas/snapshot.verify_repository___CompactNodeInfo' required: - nodes - sql.close@200: + description: '' + sql.close___200: content: application/json: schema: - $ref: '#/components/schemas/sql._common:SqlCloseResponse' - required: true - sql.explain@200: + $ref: '#/components/schemas/sql._common___SqlCloseResponse' + description: '' + sql.explain___200: content: application/json: schema: - $ref: '#/components/schemas/sql._common:ExplainResponse' - required: true - sql.get_stats@200: + $ref: '#/components/schemas/sql._common___ExplainResponse' + description: '' + sql.get_stats___200: content: text/plain: schema: type: string - required: true - sql.post_stats@200: + description: '' + sql.post_stats___200: content: text/plain: schema: type: string - required: true - sql.query@200: + description: '' + sql.query___200: content: application/json: schema: - $ref: '#/components/schemas/sql._common:QueryResponse' - sql.settings@200: + $ref: '#/components/schemas/sql._common___QueryResponse' + description: '' + sql.settings___200: content: application/json: schema: - $ref: '#/components/schemas/sql._common:SqlSettingsResponse' - tasks.cancel@200: + $ref: '#/components/schemas/sql._common___SqlSettingsResponse' + description: '' + tasks.cancel___200: content: application/json: schema: - $ref: '#/components/schemas/tasks._common:TaskListResponseBase' - tasks.get@200: + $ref: '#/components/schemas/tasks._common___TaskListResponseBase' + description: '' + tasks.get___200: content: application/json: schema: @@ -29824,20 +31461,22 @@ components: completed: type: boolean task: - $ref: '#/components/schemas/tasks._common:TaskInfo' + $ref: '#/components/schemas/tasks._common___TaskInfo' response: - $ref: '#/components/schemas/tasks._common:TaskResponse' + $ref: '#/components/schemas/tasks._common___TaskResponse' error: - $ref: '#/components/schemas/_common:ErrorCause' + $ref: '#/components/schemas/_common___ErrorCause' required: - completed - task - tasks.list@200: + description: '' + tasks.list___200: content: application/json: schema: - $ref: '#/components/schemas/tasks._common:TaskListResponseBase' - termvectors@200: + $ref: '#/components/schemas/tasks._common___TaskListResponseBase' + description: '' + termvectors___200: content: application/json: schema: @@ -29846,61 +31485,70 @@ components: found: type: boolean _id: - $ref: '#/components/schemas/_common:Id' + $ref: '#/components/schemas/_common___Id' _index: - $ref: '#/components/schemas/_common:IndexName' + $ref: '#/components/schemas/_common___IndexName' term_vectors: type: object additionalProperties: - $ref: '#/components/schemas/_core.termvectors:TermVector' + $ref: '#/components/schemas/_core.termvectors___TermVector' took: type: integer format: int64 _version: - $ref: '#/components/schemas/_common:VersionNumber' + $ref: '#/components/schemas/_common___VersionNumber' required: - _id - _index - _version - found - took - transforms.delete@200: {} - transforms.explain@200: + description: '' + transforms.delete___200: + description: '' + transforms.explain___200: content: application/json: schema: - $ref: '#/components/schemas/transforms._common:ExplainResponse' - transforms.get@200: + $ref: '#/components/schemas/transforms._common___ExplainResponse' + description: '' + transforms.get___200: content: application/json: schema: - $ref: '#/components/schemas/transforms._common:TransformEntity' - transforms.preview@200: + $ref: '#/components/schemas/transforms._common___TransformEntity' + description: '' + transforms.preview___200: content: application/json: schema: - $ref: '#/components/schemas/transforms._common:Preview' - transforms.put@200: + $ref: '#/components/schemas/transforms._common___Preview' + description: '' + transforms.put___200: content: application/json: schema: - $ref: '#/components/schemas/transforms._common:TransformEntity' - transforms.search@200: + $ref: '#/components/schemas/transforms._common___TransformEntity' + description: '' + transforms.search___200: content: application/json: schema: - $ref: '#/components/schemas/transforms._common:TransformsResponse' - transforms.start@200: + $ref: '#/components/schemas/transforms._common___TransformsResponse' + description: '' + transforms.start___200: content: application/json: schema: - $ref: '#/components/schemas/_common:AcknowledgedResponseBase' - transforms.stop@200: + $ref: '#/components/schemas/_common___AcknowledgedResponseBase' + description: '' + transforms.stop___200: content: application/json: schema: - $ref: '#/components/schemas/_common:AcknowledgedResponseBase' - update_by_query_rethrottle@200: + $ref: '#/components/schemas/_common___AcknowledgedResponseBase' + description: '' + update_by_query_rethrottle___200: content: application/json: schema: @@ -29909,26 +31557,61 @@ components: nodes: type: object additionalProperties: - $ref: '#/components/schemas/_core.update_by_query_rethrottle:UpdateByQueryRethrottleNode' + $ref: '#/components/schemas/_core.update_by_query_rethrottle___UpdateByQueryRethrottleNode' required: - nodes - update_by_query@200: + description: '' + update_by_query___200: content: application/json: schema: oneOf: - - $ref: '#/components/schemas/_common:BulkByScrollResponseBase' + - $ref: '#/components/schemas/_common___BulkByScrollResponseBase' - type: object properties: task: - $ref: '#/components/schemas/_common:TaskId' - update@200: + $ref: '#/components/schemas/_common___TaskId' + description: '' + update___200: + content: + application/json: + schema: + $ref: '#/components/schemas/_core.update___UpdateWriteResponseBase' + description: '' + wlm.create_query_group___200: + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/wlm._common___QueryGroupResponse' + wlm.delete_query_group___200: + description: '' + content: + application/json: + schema: + type: object + properties: + acknowledged: + type: boolean + wlm.get_query_group___200: + description: '' + content: + application/json: + schema: + type: object + properties: + query_groups: + type: array + items: + $ref: '#/components/schemas/wlm._common___QueryGroupResponse' + wlm.update_query_group___200: + description: '' content: application/json: schema: - $ref: '#/components/schemas/_core.update:UpdateWriteResponseBase' + $ref: '#/components/schemas/wlm._common___QueryGroupResponse' schemas: - _common:AcknowledgedResponseBase: + _common___AcknowledgedResponseBase: type: object properties: acknowledged: @@ -29936,14 +31619,14 @@ components: type: boolean required: - acknowledged - _common:ActionStatusOptions: + _common___ActionStatusOptions: type: string enum: - failure - simulated - success - throttled - _common:BaseNode: + _common___BaseNode: type: object properties: attributes: @@ -29951,34 +31634,34 @@ components: additionalProperties: type: string host: - $ref: '#/components/schemas/_common:Host' + $ref: '#/components/schemas/_common___Host' ip: - $ref: '#/components/schemas/_common:Ip' + $ref: '#/components/schemas/_common___Ip' name: - $ref: '#/components/schemas/_common:Name' + $ref: '#/components/schemas/_common___Name' roles: - $ref: '#/components/schemas/_common:NodeRoles' + $ref: '#/components/schemas/_common___NodeRoles' transport_address: - $ref: '#/components/schemas/_common:TransportAddress' + $ref: '#/components/schemas/_common___TransportAddress' required: - name - _common:BatchSize: + _common___BatchSize: type: integer format: int64 - _common:BuiltinScriptLanguage: + _common___BuiltinScriptLanguage: type: string enum: - expression - java - mustache - painless - _common:BulkByScrollFailure: + _common___BulkByScrollFailure: anyOf: - - $ref: '#/components/schemas/_common:BulkItemResponseFailure' - - $ref: '#/components/schemas/_common:ScrollableHitSourceSearchFailure' - _common:BulkByScrollResponseBase: + - $ref: '#/components/schemas/_common___BulkItemResponseFailure' + - $ref: '#/components/schemas/_common___ScrollableHitSourceSearchFailure' + _common___BulkByScrollResponseBase: allOf: - - $ref: '#/components/schemas/_common:BulkByScrollTaskStatus' + - $ref: '#/components/schemas/_common___BulkByScrollTaskStatus' - type: object properties: took: @@ -29989,12 +31672,12 @@ components: failures: type: array items: - $ref: '#/components/schemas/_common:BulkByScrollFailure' + $ref: '#/components/schemas/_common___BulkByScrollFailure' required: - failures - timed_out - took - _common:BulkByScrollTaskStatus: + _common___BulkByScrollTaskStatus: type: object properties: slice_id: @@ -30029,11 +31712,11 @@ components: type: integer format: int64 retries: - $ref: '#/components/schemas/_common:Retries' + $ref: '#/components/schemas/_common___Retries' throttled_millis: - $ref: '#/components/schemas/_common:DurationValueUnitMillis' + $ref: '#/components/schemas/_common___DurationValueUnitMillis' throttled: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' requests_per_second: description: The number of requests per second effectively executed during the reindex operation. type: number @@ -30041,13 +31724,13 @@ components: canceled: type: string throttled_until_millis: - $ref: '#/components/schemas/_common:DurationValueUnitMillis' + $ref: '#/components/schemas/_common___DurationValueUnitMillis' throttled_until: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' slices: type: array items: - $ref: '#/components/schemas/_common:BulkByScrollTaskStatusOrException' + $ref: '#/components/schemas/_common___BulkByScrollTaskStatusOrException' required: - batches - deleted @@ -30058,21 +31741,21 @@ components: - throttled_until_millis - total - version_conflicts - _common:BulkByScrollTaskStatusOrException: + _common___BulkByScrollTaskStatusOrException: oneOf: - title: status - $ref: '#/components/schemas/_common:BulkByScrollTaskStatus' + $ref: '#/components/schemas/_common___BulkByScrollTaskStatus' - title: exception - $ref: '#/components/schemas/_common:ErrorCause' - _common:BulkItemResponseFailure: + $ref: '#/components/schemas/_common___ErrorCause' + _common___BulkItemResponseFailure: type: object properties: cause: - $ref: '#/components/schemas/_common:ErrorCause' + $ref: '#/components/schemas/_common___ErrorCause' id: - $ref: '#/components/schemas/_common:Id' + $ref: '#/components/schemas/_common___Id' index: - $ref: '#/components/schemas/_common:IndexName' + $ref: '#/components/schemas/_common___IndexName' status: type: integer format: int32 @@ -30080,12 +31763,12 @@ components: - cause - index - status - _common:byte: + _common___byte: type: number - _common:ByteCount: + _common___ByteCount: type: integer format: int64 - _common:ByteUnit: + _common___ByteUnit: type: string enum: - b @@ -30099,28 +31782,28 @@ components: - pb - t - tb - _common:ClusterDetails: + _common___ClusterDetails: type: object properties: status: - $ref: '#/components/schemas/_common:ClusterSearchStatus' + $ref: '#/components/schemas/_common___ClusterSearchStatus' indices: type: string took: - $ref: '#/components/schemas/_common:DurationValueUnitMillis' + $ref: '#/components/schemas/_common___DurationValueUnitMillis' timed_out: type: boolean _shards: - $ref: '#/components/schemas/_common:ShardStatistics' + $ref: '#/components/schemas/_common___ShardStatistics' failures: type: array items: - $ref: '#/components/schemas/_common:ShardFailure' + $ref: '#/components/schemas/_common___ShardFailure' required: - indices - status - timed_out - _common:ClusterSearchStatus: + _common___ClusterSearchStatus: type: string enum: - failed @@ -30128,7 +31811,7 @@ components: - running - skipped - successful - _common:ClusterStatistics: + _common___ClusterStatistics: type: object properties: skipped: @@ -30152,7 +31835,7 @@ components: details: type: object additionalProperties: - $ref: '#/components/schemas/_common:ClusterDetails' + $ref: '#/components/schemas/_common___ClusterDetails' required: - failed - partial @@ -30160,26 +31843,26 @@ components: - skipped - successful - total - _common:CompletionStats: + _common___CompletionStats: type: object properties: size_in_bytes: description: The total amount, in bytes, of memory used for completion across all shards assigned to the selected nodes. - $ref: '#/components/schemas/_common:ByteCount' + $ref: '#/components/schemas/_common___ByteCount' size: - $ref: '#/components/schemas/_common:HumanReadableByteCount' + $ref: '#/components/schemas/_common___HumanReadableByteCount' fields: type: object additionalProperties: - $ref: '#/components/schemas/_common:FieldSizeUsage' + $ref: '#/components/schemas/_common___FieldSizeUsage' required: - size_in_bytes - _common:Conflicts: + _common___Conflicts: type: string enum: - abort - proceed - _common:CoordsGeoBounds: + _common___CoordsGeoBounds: type: object properties: top: @@ -30199,39 +31882,39 @@ components: - left - right - top - _common:DataStreamName: + _common___DataStreamName: type: string - _common:DataStreamNames: + _common___DataStreamNames: oneOf: - - $ref: '#/components/schemas/_common:DataStreamName' + - $ref: '#/components/schemas/_common___DataStreamName' - type: array items: - $ref: '#/components/schemas/_common:DataStreamName' - _common:DateFormat: + $ref: '#/components/schemas/_common___DataStreamName' + _common___DateFormat: type: string - _common:DateMath: + _common___DateMath: type: string - _common:DateTime: + _common___DateTime: description: |- A date and time, either as a string whose format depends on the context (defaulting to ISO_8601) or the number of milliseconds since the epoch. OpenSearch accepts both as an input but will generally output a string. representation. oneOf: - type: string - - $ref: '#/components/schemas/_common:EpochTimeUnitMillis' - _common:DFIIndependenceMeasure: + - $ref: '#/components/schemas/_common___EpochTimeUnitMillis' + _common___DFIIndependenceMeasure: type: string enum: - chisquared - saturated - standardized - _common:DFRAfterEffect: + _common___DFRAfterEffect: type: string enum: - b - l - 'no' - _common:DFRBasicModel: + _common___DFRBasicModel: type: string enum: - be @@ -30241,9 +31924,9 @@ components: - in - ine - p - _common:Distance: + _common___Distance: type: string - _common:DistanceUnit: + _common___DistanceUnit: type: string enum: - cm @@ -30255,7 +31938,7 @@ components: - mm - nmi - yd - _common:DocStats: + _common___DocStats: type: object properties: count: @@ -30271,7 +31954,7 @@ components: type: number required: - count - _common:DocStatus: + _common___DocStatus: description: The item level REST category class codes during indexing. type: object properties: @@ -30290,30 +31973,30 @@ components: 5xx: type: integer format: int32 - _common:Duration: + _common___Duration: 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: ^(?:(-1)|([0-9\.]+)(?:d|h|m|s|ms|micros|nanos))$ type: string - _common:DurationLarge: + _common___DurationLarge: description: 'A date histogram interval, similar to `Duration`, with support for additional units: `w` (week), `M` (month), `q` (quarter), and `y` (year).' type: string - _common:DurationValueUnitMillis: + _common___DurationValueUnitMillis: allOf: - - $ref: '#/components/schemas/_common:UnitMillis' - _common:DurationValueUnitNanos: + - $ref: '#/components/schemas/_common___UnitMillis' + _common___DurationValueUnitNanos: allOf: - - $ref: '#/components/schemas/_common:UnitNanos' - _common:EmptyObject: + - $ref: '#/components/schemas/_common___UnitNanos' + _common___EmptyObject: type: object - _common:EpochTimeUnitMillis: + _common___EpochTimeUnitMillis: allOf: - - $ref: '#/components/schemas/_common:UnitMillis' - _common:EpochTimeUnitSeconds: + - $ref: '#/components/schemas/_common___UnitMillis' + _common___EpochTimeUnitSeconds: allOf: - - $ref: '#/components/schemas/_common:UnitSeconds' - _common:ErrorCause: + - $ref: '#/components/schemas/_common___UnitSeconds' + _common___ErrorCause: type: object properties: type: @@ -30326,96 +32009,96 @@ components: description: The server stack trace, present only if the `error_trace=true` parameter was sent with the request. type: string caused_by: - $ref: '#/components/schemas/_common:ErrorCause' + $ref: '#/components/schemas/_common___ErrorCause' root_cause: type: array items: - $ref: '#/components/schemas/_common:ErrorCause' + $ref: '#/components/schemas/_common___ErrorCause' suppressed: type: array items: - $ref: '#/components/schemas/_common:ErrorCause' + $ref: '#/components/schemas/_common___ErrorCause' required: - type additionalProperties: title: metadata description: Any additional information about the error. - _common:ErrorResponseBase: + _common___ErrorResponseBase: type: object properties: error: - $ref: '#/components/schemas/_common:ErrorCause' + $ref: '#/components/schemas/_common___ErrorCause' status: type: number required: - error - status - _common:ExpandWildcard: + _common___ExpandWildcard: oneOf: - type: string const: all description: Match any index, including hidden ones. - type: string const: closed - description: Match closed, non-hidden indices. + description: Match closed, non-hidden indexes. - type: string const: hidden - description: Match hidden indices. Must be combined with open, closed, or both. + description: Match hidden indexes. Must be combined with open, closed, or both. - type: string const: none description: Wildcard expressions are not accepted. - type: string const: open - description: Match open, non-hidden indices. - _common:ExpandWildcards: + description: Match open, non-hidden indexes. + _common___ExpandWildcards: oneOf: - - $ref: '#/components/schemas/_common:ExpandWildcard' + - $ref: '#/components/schemas/_common___ExpandWildcard' - type: array items: - $ref: '#/components/schemas/_common:ExpandWildcard' - _common:Field: + $ref: '#/components/schemas/_common___ExpandWildcard' + _common___Field: description: The path to a field or an array of paths. Some APIs support wildcards in the path, which allows you to select multiple fields. type: string - _common:FielddataStats: + _common___FielddataStats: type: object properties: evictions: type: number memory_size: - $ref: '#/components/schemas/_common:HumanReadableByteCount' + $ref: '#/components/schemas/_common___HumanReadableByteCount' memory_size_in_bytes: - $ref: '#/components/schemas/_common:ByteCount' + $ref: '#/components/schemas/_common___ByteCount' fields: type: object additionalProperties: - $ref: '#/components/schemas/_common:FieldMemoryUsage' + $ref: '#/components/schemas/_common___FieldMemoryUsage' required: - memory_size_in_bytes - _common:FieldMemoryUsage: + _common___FieldMemoryUsage: type: object properties: memory_size: - $ref: '#/components/schemas/_common:HumanReadableByteCount' + $ref: '#/components/schemas/_common___HumanReadableByteCount' memory_size_in_bytes: - $ref: '#/components/schemas/_common:ByteCount' + $ref: '#/components/schemas/_common___ByteCount' required: - memory_size_in_bytes - _common:Fields: + _common___Fields: oneOf: - - $ref: '#/components/schemas/_common:Field' + - $ref: '#/components/schemas/_common___Field' - type: array items: - $ref: '#/components/schemas/_common:Field' - _common:FieldSizeUsage: + $ref: '#/components/schemas/_common___Field' + _common___FieldSizeUsage: type: object properties: size: - $ref: '#/components/schemas/_common:HumanReadableByteCount' + $ref: '#/components/schemas/_common___HumanReadableByteCount' size_in_bytes: - $ref: '#/components/schemas/_common:ByteCount' + $ref: '#/components/schemas/_common___ByteCount' required: - size_in_bytes - _common:FieldValue: + _common___FieldValue: description: A field value. type: - boolean @@ -30423,11 +32106,15 @@ components: - number - object - string - _common:FieldWithOrder: + _common___FieldWithDirection: type: object additionalProperties: - $ref: '#/components/schemas/_common:ScoreSort' - _common:FlushStats: + $ref: '#/components/schemas/_common___SortOrder' + _common___FieldWithOrder: + type: object + additionalProperties: + $ref: '#/components/schemas/_common___ScoreSort' + _common___FlushStats: type: object properties: periodic: @@ -30435,19 +32122,19 @@ components: total: type: number total_time: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' total_time_in_millis: - $ref: '#/components/schemas/_common:DurationValueUnitMillis' + $ref: '#/components/schemas/_common___DurationValueUnitMillis' required: - periodic - total - total_time_in_millis - _common:Fuzziness: + _common___Fuzziness: oneOf: - type: string - type: integer format: int32 - _common:GeoBounds: + _common___GeoBounds: description: |- A geo-bounding box. It can be represented in the following ways: - As 4 top/bottom/left/right coordinates. @@ -30456,50 +32143,50 @@ components: - As a Well Known Text (WKT) bounding box. oneOf: - title: coords - $ref: '#/components/schemas/_common:CoordsGeoBounds' + $ref: '#/components/schemas/_common___CoordsGeoBounds' - title: tlbr - $ref: '#/components/schemas/_common:TopLeftBottomRightGeoBounds' + $ref: '#/components/schemas/_common___TopLeftBottomRightGeoBounds' - title: trbl - $ref: '#/components/schemas/_common:TopRightBottomLeftGeoBounds' + $ref: '#/components/schemas/_common___TopRightBottomLeftGeoBounds' - title: wkt - $ref: '#/components/schemas/_common:WktGeoBounds' - _common:GeoDistanceSort: + $ref: '#/components/schemas/_common___WktGeoBounds' + _common___GeoDistanceSort: type: object properties: mode: - $ref: '#/components/schemas/_common:SortMode' + $ref: '#/components/schemas/_common___SortMode' distance_type: - $ref: '#/components/schemas/_common:GeoDistanceType' + $ref: '#/components/schemas/_common___GeoDistanceType' ignore_unmapped: type: boolean order: - $ref: '#/components/schemas/_common:SortOrder' + $ref: '#/components/schemas/_common___SortOrder' unit: - $ref: '#/components/schemas/_common:DistanceUnit' - _common:GeoDistanceType: + $ref: '#/components/schemas/_common___DistanceUnit' + _common___GeoDistanceType: type: string enum: - arc - plane - _common:GeoHash: + _common___GeoHash: type: string - _common:GeoHashLocation: + _common___GeoHashLocation: type: object properties: geohash: - $ref: '#/components/schemas/_common:GeoHash' + $ref: '#/components/schemas/_common___GeoHash' required: - geohash - _common:GeoHashPrecision: + _common___GeoHashPrecision: description: The level of geohash precision, which can be expressed as a geohash length between 1 and 12 or as a distance measure, such as "1km" or "10m". oneOf: - type: integer format: int32 - type: string - _common:GeoHexCell: + _common___GeoHexCell: description: A map hex cell (H3) reference. type: string - _common:GeoLine: + _common___GeoLine: type: object properties: type: @@ -30516,7 +32203,7 @@ components: required: - coordinates - type - _common:GeoLocation: + _common___GeoLocation: description: |- A latitude/longitude as a two-dimensional point. It can be represented in the following ways: - As a `{lat, long}` object. @@ -30525,9 +32212,9 @@ components: - As a string in `", "` or WKT point format. oneOf: - title: latlon - $ref: '#/components/schemas/_common:LatLonGeoLocation' + $ref: '#/components/schemas/_common___LatLonGeoLocation' - title: geohash - $ref: '#/components/schemas/_common:GeoHashLocation' + $ref: '#/components/schemas/_common___GeoHashLocation' - title: coords type: array items: @@ -30535,39 +32222,39 @@ components: format: double - title: text type: string - _common:GeoShapeRelation: + _common___GeoShapeRelation: type: string enum: - contains - disjoint - intersects - within - _common:GeoTile: + _common___GeoTile: description: A map tile reference, represented as `{zoom}/{x}/{y}`. type: string - _common:GeoTilePrecision: + _common___GeoTilePrecision: type: number - _common:GetStats: + _common___GetStats: type: object properties: total: type: number getTime: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' time_in_millis: - $ref: '#/components/schemas/_common:DurationValueUnitMillis' + $ref: '#/components/schemas/_common___DurationValueUnitMillis' exists_total: type: number exists_time: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' exists_time_in_millis: - $ref: '#/components/schemas/_common:DurationValueUnitMillis' + $ref: '#/components/schemas/_common___DurationValueUnitMillis' missing_total: type: number missing_time: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' missing_time_in_millis: - $ref: '#/components/schemas/_common:DurationValueUnitMillis' + $ref: '#/components/schemas/_common___DurationValueUnitMillis' current: type: number required: @@ -30578,21 +32265,21 @@ components: - missing_total - time_in_millis - total - _common:HealthStatus: + _common___HealthStatus: type: string enum: - green - red - yellow - _common:HealthStatusCapitalized: + _common___HealthStatusCapitalized: type: string enum: - GREEN - RED - YELLOW - _common:Host: + _common___Host: type: string - _common:HourAndMinute: + _common___HourAndMinute: type: object properties: hour: @@ -30606,7 +32293,7 @@ components: required: - hour - minute - _common:HttpHeaders: + _common___HttpHeaders: type: object additionalProperties: oneOf: @@ -30614,38 +32301,38 @@ components: - type: array items: type: string - _common:HumanReadableByteCount: + _common___HumanReadableByteCount: type: string - pattern: \d+(\.\d+)?(b|kb|k|mb|m|gb|g|tb|t|pb|p) - _common:IBDistribution: + pattern: (?:(-1)|(0)|\d+(\.\d+)?(b|kb|k|mb|m|gb|g|tb|t|pb|p)) + _common___IBDistribution: type: string enum: - ll - spl - _common:IBLambda: + _common___IBLambda: type: string enum: - df - ttf - _common:Id: + _common___Id: type: string - _common:Ids: + _common___Ids: oneOf: - - $ref: '#/components/schemas/_common:Id' + - $ref: '#/components/schemas/_common___Id' - type: array items: - $ref: '#/components/schemas/_common:Id' - _common:IndexAlias: + $ref: '#/components/schemas/_common___Id' + _common___IndexAlias: type: string - _common:IndexingStats: + _common___IndexingStats: type: object properties: index_total: type: number index_time: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' index_time_in_millis: - $ref: '#/components/schemas/_common:DurationValueUnitMillis' + $ref: '#/components/schemas/_common___DurationValueUnitMillis' index_current: type: number index_failed: @@ -30653,9 +32340,9 @@ components: delete_total: type: number delete_time: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' delete_time_in_millis: - $ref: '#/components/schemas/_common:DurationValueUnitMillis' + $ref: '#/components/schemas/_common___DurationValueUnitMillis' delete_current: type: number noop_update_total: @@ -30663,16 +32350,16 @@ components: is_throttled: type: boolean throttle_time: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' throttle_time_in_millis: - $ref: '#/components/schemas/_common:DurationValueUnitMillis' + $ref: '#/components/schemas/_common___DurationValueUnitMillis' doc_status: - $ref: '#/components/schemas/_common:DocStatus' + $ref: '#/components/schemas/_common___DocStatus' types: x-version-removed: '2.0' type: object additionalProperties: - $ref: '#/components/schemas/_common:IndexingStats' + $ref: '#/components/schemas/_common___IndexingStats' required: - delete_current - delete_time_in_millis @@ -30684,22 +32371,22 @@ components: - is_throttled - noop_update_total - throttle_time_in_millis - _common:IndexName: + _common___IndexName: type: string - _common:Indices: + _common___Indices: oneOf: - - $ref: '#/components/schemas/_common:IndexName' + - $ref: '#/components/schemas/_common___IndexName' - type: array items: - $ref: '#/components/schemas/_common:IndexName' - _common:IndicesResponseBase: + $ref: '#/components/schemas/_common___IndexName' + _common___IndicesResponseBase: allOf: - - $ref: '#/components/schemas/_common:AcknowledgedResponseBase' + - $ref: '#/components/schemas/_common___AcknowledgedResponseBase' - type: object properties: _shards: - $ref: '#/components/schemas/_common:ShardStatistics' - _common:InlineGet: + $ref: '#/components/schemas/_common___ShardStatistics' + _common___InlineGet: type: object properties: fields: @@ -30709,16 +32396,16 @@ components: found: type: boolean _seq_no: - $ref: '#/components/schemas/_common:SequenceNumber' + $ref: '#/components/schemas/_common___SequenceNumber' _primary_term: type: number _routing: - $ref: '#/components/schemas/_common:Routing' + $ref: '#/components/schemas/_common___Routing' _source: type: object required: - found - _common:InlineGetDictUserDefined: + _common___InlineGetDictUserDefined: type: object properties: fields: @@ -30728,27 +32415,27 @@ components: found: type: boolean _seq_no: - $ref: '#/components/schemas/_common:SequenceNumber' + $ref: '#/components/schemas/_common___SequenceNumber' _primary_term: type: integer format: int32 _routing: - $ref: '#/components/schemas/_common:Routing' + $ref: '#/components/schemas/_common___Routing' _source: type: object additionalProperties: true required: - found - _common:InlineScript: + _common___InlineScript: oneOf: - title: source type: string - allOf: - - $ref: '#/components/schemas/_common:ScriptBase' + - $ref: '#/components/schemas/_common___ScriptBase' - type: object properties: lang: - $ref: '#/components/schemas/_common:ScriptLanguage' + $ref: '#/components/schemas/_common___ScriptLanguage' options: type: object additionalProperties: @@ -30758,13 +32445,13 @@ components: type: string required: - source - _common:Ip: + _common___Ip: type: string - _common:KnnField: + _common___KnnField: type: object properties: vector: - $ref: '#/components/schemas/_common:QueryVector' + $ref: '#/components/schemas/_common___QueryVector' k: description: The total number of nearest neighbors to return as top hits. type: integer @@ -30782,10 +32469,10 @@ components: filter: description: The filters for the k-NN search query. oneOf: - - $ref: '#/components/schemas/_common.query_dsl:QueryContainer' + - $ref: '#/components/schemas/_common.query_dsl___QueryContainer' - type: array items: - $ref: '#/components/schemas/_common.query_dsl:QueryContainer' + $ref: '#/components/schemas/_common.query_dsl___QueryContainer' boost: description: The boost value applied to k-NN scores. type: number @@ -30804,7 +32491,7 @@ components: format: float required: - vector - _common:LatLonGeoLocation: + _common___LatLonGeoLocation: type: object properties: lat: @@ -30818,13 +32505,13 @@ components: required: - lat - lon - _common:Level: + _common___Level: type: string enum: - cluster - indices - shards - _common:MergesStats: + _common___MergesStats: type: object properties: current: @@ -30832,33 +32519,33 @@ components: current_docs: type: number current_size: - $ref: '#/components/schemas/_common:HumanReadableByteCount' + $ref: '#/components/schemas/_common___HumanReadableByteCount' current_size_in_bytes: - $ref: '#/components/schemas/_common:ByteCount' + $ref: '#/components/schemas/_common___ByteCount' total: type: number total_auto_throttle: - $ref: '#/components/schemas/_common:HumanReadableByteCount' + $ref: '#/components/schemas/_common___HumanReadableByteCount' total_auto_throttle_in_bytes: - $ref: '#/components/schemas/_common:ByteCount' + $ref: '#/components/schemas/_common___ByteCount' total_docs: type: number total_size: - $ref: '#/components/schemas/_common:HumanReadableByteCount' + $ref: '#/components/schemas/_common___HumanReadableByteCount' total_size_in_bytes: - $ref: '#/components/schemas/_common:ByteCount' + $ref: '#/components/schemas/_common___ByteCount' total_stopped_time: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' total_stopped_time_in_millis: - $ref: '#/components/schemas/_common:DurationValueUnitMillis' + $ref: '#/components/schemas/_common___DurationValueUnitMillis' total_throttled_time: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' total_throttled_time_in_millis: - $ref: '#/components/schemas/_common:DurationValueUnitMillis' + $ref: '#/components/schemas/_common___DurationValueUnitMillis' total_time: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' total_time_in_millis: - $ref: '#/components/schemas/_common:DurationValueUnitMillis' + $ref: '#/components/schemas/_common___DurationValueUnitMillis' unreferenced_file_cleanups_performed: type: number required: @@ -30872,16 +32559,16 @@ components: - total_stopped_time_in_millis - total_throttled_time_in_millis - total_time_in_millis - _common:Metadata: + _common___Metadata: type: object additionalProperties: true - _common:MinimumShouldMatch: + _common___MinimumShouldMatch: description: The minimum number of terms that should match as an integer, percentage, or range. oneOf: - type: integer format: int32 - type: string - _common:MultiTermQueryRewrite: + _common___MultiTermQueryRewrite: type: string enum: - constant_score @@ -30890,29 +32577,29 @@ components: - top_terms_N - top_terms_blended_freqs_N - top_terms_boost_N - _common:Name: + _common___Name: type: string - _common:Names: + _common___Names: oneOf: - - $ref: '#/components/schemas/_common:Name' + - $ref: '#/components/schemas/_common___Name' - type: array items: - $ref: '#/components/schemas/_common:Name' - _common:NestedSortValue: + $ref: '#/components/schemas/_common___Name' + _common___NestedSortValue: type: object properties: filter: - $ref: '#/components/schemas/_common.query_dsl:QueryContainer' + $ref: '#/components/schemas/_common.query_dsl___QueryContainer' max_children: type: integer format: int32 nested: - $ref: '#/components/schemas/_common:NestedSortValue' + $ref: '#/components/schemas/_common___NestedSortValue' path: - $ref: '#/components/schemas/_common:Field' + $ref: '#/components/schemas/_common___Field' required: - path - _common:NodeAttributes: + _common___NodeAttributes: type: object properties: attributes: @@ -30921,15 +32608,15 @@ components: additionalProperties: type: string ephemeral_id: - $ref: '#/components/schemas/_common:Id' + $ref: '#/components/schemas/_common___Id' id: - $ref: '#/components/schemas/_common:NodeId' + $ref: '#/components/schemas/_common___NodeId' name: - $ref: '#/components/schemas/_common:NodeName' + $ref: '#/components/schemas/_common___NodeName' transport_address: - $ref: '#/components/schemas/_common:TransportAddress' + $ref: '#/components/schemas/_common___TransportAddress' roles: - $ref: '#/components/schemas/_common:NodeRoles' + $ref: '#/components/schemas/_common___NodeRoles' external_id: type: string required: @@ -30937,17 +32624,17 @@ components: - ephemeral_id - name - transport_address - _common:NodeId: + _common___NodeId: type: string - _common:NodeIds: + _common___NodeIds: oneOf: - - $ref: '#/components/schemas/_common:NodeId' + - $ref: '#/components/schemas/_common___NodeId' - type: array items: - $ref: '#/components/schemas/_common:NodeId' - _common:NodeName: + $ref: '#/components/schemas/_common___NodeId' + _common___NodeName: type: string - _common:NodeRole: + _common___NodeRole: oneOf: - type: string enum: @@ -30969,57 +32656,57 @@ components: - master deprecated: true x-version-deprecated: '2.0' - x-deprecation-message: Use 'cluster_manager' instead. + x-deprecation-message: Use `cluster_manager` instead. - type: string enum: - cluster_manager x-version-added: '2.0' - _common:NodeRoles: + _common___NodeRoles: description: Node roles. type: array items: - $ref: '#/components/schemas/_common:NodeRole' - _common:NodeShard: + $ref: '#/components/schemas/_common___NodeRole' + _common___NodeShard: type: object properties: state: - $ref: '#/components/schemas/indices.stats:ShardRoutingState' + $ref: '#/components/schemas/indices.stats___ShardRoutingState' primary: type: boolean node: - $ref: '#/components/schemas/_common:NodeName' + $ref: '#/components/schemas/_common___NodeName' shard: type: number index: - $ref: '#/components/schemas/_common:IndexName' + $ref: '#/components/schemas/_common___IndexName' allocation_id: type: object additionalProperties: - $ref: '#/components/schemas/_common:Id' + $ref: '#/components/schemas/_common___Id' recovery_source: type: object additionalProperties: - $ref: '#/components/schemas/_common:Id' + $ref: '#/components/schemas/_common___Id' unassigned_info: - $ref: '#/components/schemas/cluster.allocation_explain:UnassignedInformation' + $ref: '#/components/schemas/cluster.allocation_explain___UnassignedInformation' relocating_node: oneOf: - - $ref: '#/components/schemas/_common:NodeId' + - $ref: '#/components/schemas/_common___NodeId' - type: 'null' relocation_failure_info: - $ref: '#/components/schemas/_common:RelocationFailureInfo' + $ref: '#/components/schemas/_common___RelocationFailureInfo' required: - index - primary - shard - state - _common:NodeStatistics: + _common___NodeStatistics: type: object properties: failures: type: array items: - $ref: '#/components/schemas/_common:ErrorCause' + $ref: '#/components/schemas/_common___ErrorCause' total: description: The total number of nodes selected by the request. type: integer @@ -31033,11 +32720,11 @@ components: - failed - successful - total - _common:OpenSearchVersionInfo: + _common___OpenSearchVersionInfo: type: object properties: build_date: - $ref: '#/components/schemas/_common:DateTime' + $ref: '#/components/schemas/_common___DateTime' build_flavor: type: string build_hash: @@ -31049,11 +32736,11 @@ components: distribution: type: string lucene_version: - $ref: '#/components/schemas/_common:VersionString' + $ref: '#/components/schemas/_common___VersionString' minimum_index_compatibility_version: - $ref: '#/components/schemas/_common:VersionString' + $ref: '#/components/schemas/_common___VersionString' minimum_wire_compatibility_version: - $ref: '#/components/schemas/_common:VersionString' + $ref: '#/components/schemas/_common___VersionString' number: type: string required: @@ -31066,34 +32753,34 @@ components: - minimum_index_compatibility_version - minimum_wire_compatibility_version - number - _common:OpType: + _common___OpType: type: string enum: - create - index - _common:Password: + _common___Password: type: string - _common:PercentageNumber: + _common___PercentageNumber: type: number format: double - _common:PercentageString: + _common___PercentageString: type: string pattern: \d+(\.\d+)? - _common:PhaseTook: + _common___PhaseTook: type: object properties: dfs_pre_query: - $ref: '#/components/schemas/_common:uint' + $ref: '#/components/schemas/_common___uint' query: - $ref: '#/components/schemas/_common:uint' + $ref: '#/components/schemas/_common___uint' fetch: - $ref: '#/components/schemas/_common:uint' + $ref: '#/components/schemas/_common___uint' dfs_query: - $ref: '#/components/schemas/_common:uint' + $ref: '#/components/schemas/_common___uint' expand: - $ref: '#/components/schemas/_common:uint' + $ref: '#/components/schemas/_common___uint' can_match: - $ref: '#/components/schemas/_common:uint' + $ref: '#/components/schemas/_common___uint' required: - can_match - dfs_pre_query @@ -31101,9 +32788,9 @@ components: - expand - fetch - query - _common:PipelineName: + _common___PipelineName: type: string - _common:PipeSeparatedFlagsSimpleQueryStringFlag: + _common___PipeSeparatedFlagsSimpleQueryStringFlag: description: |- A set of flags represented as a single enum value or a set of values that are encoded as a pipe-separated string. @@ -31111,9 +32798,9 @@ components: Depending on the target language, code generators can use this hint to generate language specific flags enum constructs and the corresponding (de-)serialization code. oneOf: - - $ref: '#/components/schemas/_common.query_dsl:SimpleQueryStringFlag' + - $ref: '#/components/schemas/_common.query_dsl___SimpleQueryStringFlag' - type: string - _common:PluginStats: + _common___PluginStats: type: object properties: classname: @@ -31127,11 +32814,11 @@ components: has_native_controller: type: boolean java_version: - $ref: '#/components/schemas/_common:VersionString' + $ref: '#/components/schemas/_common___VersionString' name: - $ref: '#/components/schemas/_common:Name' + $ref: '#/components/schemas/_common___Name' version: - $ref: '#/components/schemas/_common:VersionString' + $ref: '#/components/schemas/_common___VersionString' licensed: type: boolean custom_foldername: @@ -31139,7 +32826,7 @@ components: - 'null' - string opensearch_version: - $ref: '#/components/schemas/_common:VersionString' + $ref: '#/components/schemas/_common___VersionString' required: - classname - description @@ -31149,7 +32836,7 @@ components: - name - opensearch_version - version - _common:QueryCacheStats: + _common___QueryCacheStats: type: object properties: cache_count: @@ -31167,10 +32854,10 @@ components: description: The total number of query cache hits across all shards assigned to the selected nodes. type: number memory_size: - $ref: '#/components/schemas/_common:HumanReadableByteCount' + $ref: '#/components/schemas/_common___HumanReadableByteCount' memory_size_in_bytes: description: The total amount, in bytes, of memory used for the query cache across all shards assigned to the selected nodes. - $ref: '#/components/schemas/_common:ByteCount' + $ref: '#/components/schemas/_common___ByteCount' miss_count: description: The total number of query cache misses across all shards assigned to the selected nodes. type: number @@ -31185,21 +32872,21 @@ components: - memory_size_in_bytes - miss_count - total_count - _common:QueryVector: + _common___QueryVector: type: array items: type: number format: float - _common:RankBase: + _common___RankBase: type: object - _common:RankContainer: + _common___RankContainer: type: object properties: rrf: - $ref: '#/components/schemas/_common:RrfRank' + $ref: '#/components/schemas/_common___RrfRank' minProperties: 1 maxProperties: 1 - _common:RecoveryStats: + _common___RecoveryStats: type: object properties: current_as_source: @@ -31207,123 +32894,125 @@ components: current_as_target: type: number throttle_time: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' throttle_time_in_millis: - $ref: '#/components/schemas/_common:DurationValueUnitMillis' + $ref: '#/components/schemas/_common___DurationValueUnitMillis' required: - current_as_source - current_as_target - throttle_time_in_millis - _common:Refresh: - type: string - enum: - - 'false' - - 'true' - - wait_for - _common:RefreshStats: + _common___Refresh: + oneOf: + - type: boolean + - type: string + enum: + - 'false' + - 'true' + - wait_for + _common___RefreshStats: type: object properties: external_total: type: number external_total_time: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' external_total_time_in_millis: - $ref: '#/components/schemas/_common:DurationValueUnitMillis' + $ref: '#/components/schemas/_common___DurationValueUnitMillis' listeners: type: number total: type: number total_time: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' total_time_in_millis: - $ref: '#/components/schemas/_common:DurationValueUnitMillis' + $ref: '#/components/schemas/_common___DurationValueUnitMillis' required: - external_total - external_total_time_in_millis - listeners - total - total_time_in_millis - _common:RelationName: + _common___RelationName: type: string - _common:RelocationFailureInfo: + _common___RelocationFailureInfo: type: object properties: failed_attempts: type: number required: - failed_attempts - _common:RemoteStoreDownloadStats: + _common___RemoteStoreDownloadStats: type: object description: Statistics related to downloads to the remote segment store. properties: total_download_size: description: The total amount of data downloaded from the remote segment store. - $ref: '#/components/schemas/_common:RemoteStoreUploadDownloadStats' + $ref: '#/components/schemas/_common___RemoteStoreUploadDownloadStats' total_time_spent: description: The total amount of time spent on downloads from the remote segment store. - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' total_time_spent_in_millis: description: The total duration, in milliseconds, spent on downloads from the remote segment store. - $ref: '#/components/schemas/_common:DurationValueUnitMillis' + $ref: '#/components/schemas/_common___DurationValueUnitMillis' required: - total_download_size - total_time_spent_in_millis - _common:RemoteStoreStats: + _common___RemoteStoreStats: type: object description: Statistics related to remote segment store operations. properties: upload: - $ref: '#/components/schemas/_common:RemoteStoreUploadStats' + $ref: '#/components/schemas/_common___RemoteStoreUploadStats' download: - $ref: '#/components/schemas/_common:RemoteStoreDownloadStats' + $ref: '#/components/schemas/_common___RemoteStoreDownloadStats' required: - download - upload - _common:RemoteStoreTranslogStats: + _common___RemoteStoreTranslogStats: type: object properties: upload: - $ref: '#/components/schemas/_common:RemoteStoreTranslogUploadStats' + $ref: '#/components/schemas/_common___RemoteStoreTranslogUploadStats' required: - upload - _common:RemoteStoreTranslogUploadStats: + _common___RemoteStoreTranslogUploadStats: type: object description: Statistics related to uploads to the remote translog store. properties: total_uploads: - $ref: '#/components/schemas/_common:RemoteStoreTranslogUploadTotalUploadsStats' + $ref: '#/components/schemas/_common___RemoteStoreTranslogUploadTotalUploadsStats' total_upload_size: - $ref: '#/components/schemas/_common:RemoteStoreTranslogUploadTotalUploadSizeStats' + $ref: '#/components/schemas/_common___RemoteStoreTranslogUploadTotalUploadSizeStats' required: - total_upload_size - total_uploads - _common:RemoteStoreTranslogUploadTotalUploadSizeStats: + _common___RemoteStoreTranslogUploadTotalUploadSizeStats: type: object description: The total amount of data uploaded to the remote translog store. properties: failed: description: The number of bytes that failed to upload to the remote translog store. - $ref: '#/components/schemas/_common:HumanReadableByteCount' + $ref: '#/components/schemas/_common___HumanReadableByteCount' failed_bytes: description: The number of bytes that failed to upload to the remote translog store. - $ref: '#/components/schemas/_common:ByteCount' + $ref: '#/components/schemas/_common___ByteCount' started: description: The number of bytes successfully uploaded to the remote translog store. - $ref: '#/components/schemas/_common:HumanReadableByteCount' + $ref: '#/components/schemas/_common___HumanReadableByteCount' started_bytes: description: The number of bytes successfully uploaded to the remote translog store. - $ref: '#/components/schemas/_common:ByteCount' + $ref: '#/components/schemas/_common___ByteCount' succeeded: description: The number of bytes successfully uploaded to the remote translog store. - $ref: '#/components/schemas/_common:HumanReadableByteCount' + $ref: '#/components/schemas/_common___HumanReadableByteCount' succeeded_bytes: description: The number of bytes successfully uploaded to the remote translog store. - $ref: '#/components/schemas/_common:ByteCount' + $ref: '#/components/schemas/_common___ByteCount' required: - failed_bytes - started_bytes - succeeded_bytes - _common:RemoteStoreTranslogUploadTotalUploadsStats: + _common___RemoteStoreTranslogUploadTotalUploadsStats: type: object description: The number of syncs to the remote translog store. properties: @@ -31340,33 +33029,33 @@ components: - failed - started - succeeded - _common:RemoteStoreUploadDownloadStats: + _common___RemoteStoreUploadDownloadStats: type: object description: The amount of data, in bytes, uploaded or downloaded to/from the remote segment store. properties: failed: description: The number of bytes that failed to upload to/from the remote segment store. - $ref: '#/components/schemas/_common:HumanReadableByteCount' + $ref: '#/components/schemas/_common___HumanReadableByteCount' failed_bytes: description: The number of bytes that failed to upload to/from the remote segment store. - $ref: '#/components/schemas/_common:ByteCount' + $ref: '#/components/schemas/_common___ByteCount' started: description: The number of bytes to upload/download to/from the remote segment store after the upload/download has started. - $ref: '#/components/schemas/_common:HumanReadableByteCount' + $ref: '#/components/schemas/_common___HumanReadableByteCount' started_bytes: description: The number of bytes to upload/download to/from the remote segment store after the upload/download has started. - $ref: '#/components/schemas/_common:ByteCount' + $ref: '#/components/schemas/_common___ByteCount' succeeded: description: The number of bytes successfully uploaded/downloaded to/from the remote segment store. - $ref: '#/components/schemas/_common:HumanReadableByteCount' + $ref: '#/components/schemas/_common___HumanReadableByteCount' succeeded_bytes: description: The number of bytes successfully uploaded/downloaded to/from the remote segment store. - $ref: '#/components/schemas/_common:ByteCount' + $ref: '#/components/schemas/_common___ByteCount' required: - failed_bytes - started_bytes - succeeded_bytes - _common:RemoteStoreUploadPressureStats: + _common___RemoteStoreUploadPressureStats: type: object description: Statistics related to segment store upload backpressure. properties: @@ -31375,54 +33064,54 @@ components: type: number required: - total_rejections - _common:RemoteStoreUploadRefreshSizeLagStats: + _common___RemoteStoreUploadRefreshSizeLagStats: type: object description: The amount of lag during upload between the remote segment store and the local store. properties: max: description: The maximum amount of lag, in bytes, during the upload refresh between the remote segment store and the local store. - $ref: '#/components/schemas/_common:HumanReadableByteCount' + $ref: '#/components/schemas/_common___HumanReadableByteCount' max_bytes: description: The maximum amount of lag, in bytes, during the upload refresh between the remote segment store and the local store. - $ref: '#/components/schemas/_common:ByteCount' + $ref: '#/components/schemas/_common___ByteCount' total: description: The total number of bytes that lagged during the upload refresh between the remote segment store and the local store. - $ref: '#/components/schemas/_common:HumanReadableByteCount' + $ref: '#/components/schemas/_common___HumanReadableByteCount' total_bytes: description: The total number of bytes that lagged during the upload refresh between the remote segment store and the local store. - $ref: '#/components/schemas/_common:ByteCount' + $ref: '#/components/schemas/_common___ByteCount' required: - max_bytes - total_bytes - _common:RemoteStoreUploadStats: + _common___RemoteStoreUploadStats: type: object description: Statistics related to uploads to the remote segment store. properties: max_refresh_time_lag: description: The maximum duration that the remote refresh is behind the local refresh. - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' max_refresh_time_lag_in_millis: description: The maximum duration, in milliseconds, that the remote refresh is behind the local refresh. - $ref: '#/components/schemas/_common:DurationValueUnitMillis' + $ref: '#/components/schemas/_common___DurationValueUnitMillis' pressure: - $ref: '#/components/schemas/_common:RemoteStoreUploadPressureStats' + $ref: '#/components/schemas/_common___RemoteStoreUploadPressureStats' refresh_size_lag: - $ref: '#/components/schemas/_common:RemoteStoreUploadRefreshSizeLagStats' + $ref: '#/components/schemas/_common___RemoteStoreUploadRefreshSizeLagStats' total_time_spent: description: The total amount of time spent on uploads to the remote segment store. - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' total_time_spent_in_millis: description: The total amount of time, in milliseconds, spent on uploads to the remote segment store. - $ref: '#/components/schemas/_common:DurationValueUnitMillis' + $ref: '#/components/schemas/_common___DurationValueUnitMillis' total_upload_size: - $ref: '#/components/schemas/_common:RemoteStoreUploadDownloadStats' + $ref: '#/components/schemas/_common___RemoteStoreUploadDownloadStats' required: - max_refresh_time_lag_in_millis - pressure - refresh_size_lag - total_time_spent_in_millis - total_upload_size - _common:RequestCacheStats: + _common___RequestCacheStats: type: object properties: evictions: @@ -31430,9 +33119,9 @@ components: hit_count: type: number memory_size: - $ref: '#/components/schemas/_common:HumanReadableByteCount' + $ref: '#/components/schemas/_common___HumanReadableByteCount' memory_size_in_bytes: - $ref: '#/components/schemas/_common:ByteCount' + $ref: '#/components/schemas/_common___ByteCount' miss_count: type: number required: @@ -31440,22 +33129,22 @@ components: - hit_count - memory_size_in_bytes - miss_count - _common:RequestStats: + _common___RequestStats: type: object properties: time: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' time_in_millis: - $ref: '#/components/schemas/_common:DurationValueUnitMillis' + $ref: '#/components/schemas/_common___DurationValueUnitMillis' current: type: number total: type: number - _common:ResourceType: + _common___ResourceType: type: string enum: - index_or_alias - _common:Result: + _common___Result: type: string enum: - created @@ -31463,7 +33152,7 @@ components: - noop - not_found - updated - _common:Retries: + _common___Retries: type: object properties: bulk: @@ -31475,17 +33164,17 @@ components: required: - bulk - search - _common:Routing: + _common___Routing: type: string - _common:RoutingInQueryString: + _common___RoutingInQueryString: oneOf: - type: string - type: array items: type: string - _common:RrfRank: + _common___RrfRank: allOf: - - $ref: '#/components/schemas/_common:RankBase' + - $ref: '#/components/schemas/_common___RankBase' - type: object properties: rank_constant: @@ -31494,23 +33183,23 @@ components: window_size: description: The size of the individual result sets per query. type: number - _common:ScheduleTimeOfDay: + _common___ScheduleTimeOfDay: description: A time of day, expressed either as `hh:mm`, `noon`, `midnight`, or an hour/minutes structure. oneOf: - type: string - - $ref: '#/components/schemas/_common:HourAndMinute' - _common:ScoreSort: + - $ref: '#/components/schemas/_common___HourAndMinute' + _common___ScoreSort: type: object properties: order: - $ref: '#/components/schemas/_common:SortOrder' - _common:Script: + $ref: '#/components/schemas/_common___SortOrder' + _common___Script: oneOf: - title: inline - $ref: '#/components/schemas/_common:InlineScript' + $ref: '#/components/schemas/_common___InlineScript' - title: stored - $ref: '#/components/schemas/_common:StoredScriptId' - _common:ScriptBase: + $ref: '#/components/schemas/_common___StoredScriptId' + _common___ScriptBase: type: object properties: params: @@ -31519,47 +33208,47 @@ components: Use parameters instead of hard-coded values to decrease compilation time. type: object additionalProperties: true - _common:ScriptField: + _common___ScriptField: type: object properties: script: - $ref: '#/components/schemas/_common:Script' + $ref: '#/components/schemas/_common___Script' ignore_failure: type: boolean required: - script - _common:ScriptLanguage: + _common___ScriptLanguage: anyOf: - title: builtin - $ref: '#/components/schemas/_common:BuiltinScriptLanguage' + $ref: '#/components/schemas/_common___BuiltinScriptLanguage' - title: custom type: string - _common:ScriptSort: + _common___ScriptSort: type: object properties: order: - $ref: '#/components/schemas/_common:SortOrder' + $ref: '#/components/schemas/_common___SortOrder' script: - $ref: '#/components/schemas/_common:Script' + $ref: '#/components/schemas/_common___Script' type: - $ref: '#/components/schemas/_common:ScriptSortType' + $ref: '#/components/schemas/_common___ScriptSortType' mode: - $ref: '#/components/schemas/_common:SortMode' + $ref: '#/components/schemas/_common___SortMode' nested: - $ref: '#/components/schemas/_common:NestedSortValue' + $ref: '#/components/schemas/_common___NestedSortValue' required: - script - _common:ScriptSortType: + _common___ScriptSortType: type: string enum: - number - string - version - _common:ScrollableHitSourceSearchFailure: + _common___ScrollableHitSourceSearchFailure: type: object properties: index: - $ref: '#/components/schemas/_common:IndexName' + $ref: '#/components/schemas/_common___IndexName' shard: type: integer format: int32 @@ -31569,19 +33258,19 @@ components: type: integer format: int32 reason: - $ref: '#/components/schemas/_common:ErrorCause' + $ref: '#/components/schemas/_common___ErrorCause' required: - reason - status - _common:ScrollId: + _common___ScrollId: type: string - _common:ScrollIds: + _common___ScrollIds: oneOf: - - $ref: '#/components/schemas/_common:ScrollId' + - $ref: '#/components/schemas/_common___ScrollId' - type: array items: - $ref: '#/components/schemas/_common:ScrollId' - _common:SearchStats: + $ref: '#/components/schemas/_common___ScrollId' + _common___SearchStats: type: object properties: open_contexts: @@ -31592,10 +33281,10 @@ components: type: number query_time: description: The total amount of time taken to complete all shard query operations. - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' query_time_in_millis: description: The total amount of time taken to complete all shard query operations, in milliseconds. - $ref: '#/components/schemas/_common:DurationValueUnitMillis' + $ref: '#/components/schemas/_common___DurationValueUnitMillis' query_total: description: The total number of shard query operations. type: number @@ -31603,10 +33292,10 @@ components: description: The total number of query operations using concurrent segment search. type: number concurrent_query_time: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' concurrent_query_time_in_millis: description: The total amount of time taken by all query operations using concurrent segment search, in milliseconds. - $ref: '#/components/schemas/_common:DurationValueUnitMillis' + $ref: '#/components/schemas/_common___DurationValueUnitMillis' concurrent_query_current: description: The number of currently running query operations using concurrent segment search. type: number @@ -31618,10 +33307,10 @@ components: type: number fetch_time: description: The total amount of time taken to complete all shard fetch operations. - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' fetch_time_in_millis: description: The total amount of time taken to complete all shard fetch operations, in milliseconds. - $ref: '#/components/schemas/_common:DurationValueUnitMillis' + $ref: '#/components/schemas/_common___DurationValueUnitMillis' fetch_total: description: The total number of shard fetch operations. type: number @@ -31630,10 +33319,10 @@ components: type: number scroll_time: description: The total amount of time taken to complete all shard scroll operations. - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' scroll_time_in_millis: description: The total amount of time taken to complete all shard scroll operations, in milliseconds. - $ref: '#/components/schemas/_common:DurationValueUnitMillis' + $ref: '#/components/schemas/_common___DurationValueUnitMillis' scroll_total: description: The total number of shard scroll operations. type: number @@ -31641,10 +33330,10 @@ components: description: The total number of shard Point in Time (PIT) contexts created (completed and active) since the node last restarted. type: number point_in_time_time: - $ref: '#/components/schemas/_common:Duration' + $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' + $ref: '#/components/schemas/_common___DurationValueUnitMillis' point_in_time_current: description: The number of currently open shard PIT contexts. type: number @@ -31653,10 +33342,10 @@ components: type: number suggest_time: description: The total amount of time take to complete all shard suggest operations. - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' suggest_time_in_millis: description: The total amount of time taken to complete all shard suggest operations, in milliseconds. - $ref: '#/components/schemas/_common:DurationValueUnitMillis' + $ref: '#/components/schemas/_common___DurationValueUnitMillis' suggest_total: description: The total number of shard suggest operations. type: number @@ -31666,11 +33355,11 @@ components: type: object description: Statistics related to coordinator search operations for the node. additionalProperties: - $ref: '#/components/schemas/_common:RequestStats' + $ref: '#/components/schemas/_common___RequestStats' groups: type: object additionalProperties: - $ref: '#/components/schemas/_common:SearchStats' + $ref: '#/components/schemas/_common___SearchStats' required: - fetch_current - fetch_time_in_millis @@ -31684,103 +33373,103 @@ components: - suggest_current - suggest_time_in_millis - suggest_total - _common:SearchType: + _common___SearchType: type: string enum: - dfs_query_then_fetch - query_then_fetch - _common:SegmentReplicationStats: + _common___SegmentReplicationStats: type: object properties: max_bytes_behind: - $ref: '#/components/schemas/_common:ByteCount' + $ref: '#/components/schemas/_common___ByteCount' max_replication_lag: - $ref: '#/components/schemas/_common:ByteCount' + $ref: '#/components/schemas/_common___ByteCount' total_bytes_behind: - $ref: '#/components/schemas/_common:ByteCount' + $ref: '#/components/schemas/_common___ByteCount' required: - max_bytes_behind - max_replication_lag - total_bytes_behind - _common:SegmentsStats: + _common___SegmentsStats: type: object properties: count: description: The total number of segments across all shards assigned to the selected nodes. type: number doc_values_memory: - $ref: '#/components/schemas/_common:HumanReadableByteCount' + $ref: '#/components/schemas/_common___HumanReadableByteCount' doc_values_memory_in_bytes: description: The total amount, in bytes, of memory used for document values across all shards assigned to the selected nodes. - $ref: '#/components/schemas/_common:ByteCount' + $ref: '#/components/schemas/_common___ByteCount' file_sizes: description: |- This object is not populated by the cluster stats API. To get information on segment files, use the node stats API. type: object additionalProperties: - $ref: '#/components/schemas/indices.stats:ShardFileSizeInfo' + $ref: '#/components/schemas/indices.stats___ShardFileSizeInfo' fixed_bit_set: - $ref: '#/components/schemas/_common:HumanReadableByteCount' + $ref: '#/components/schemas/_common___HumanReadableByteCount' fixed_bit_set_memory_in_bytes: description: The total amount of memory, in bytes, used by fixed bit sets across all shards assigned to the selected nodes. - $ref: '#/components/schemas/_common:ByteCount' + $ref: '#/components/schemas/_common___ByteCount' index_writer_memory: - $ref: '#/components/schemas/_common:HumanReadableByteCount' + $ref: '#/components/schemas/_common___HumanReadableByteCount' index_writer_max_memory_in_bytes: - $ref: '#/components/schemas/_common:ByteCount' + $ref: '#/components/schemas/_common___ByteCount' index_writer_memory_in_bytes: description: The total amount, in bytes, of memory used by all index writers across all shards assigned to the selected nodes. - $ref: '#/components/schemas/_common:ByteCount' + $ref: '#/components/schemas/_common___ByteCount' max_unsafe_auto_id_timestamp: description: The Unix timestamp, in milliseconds, of the most recently retried indexing request. type: number memory: description: The total amount of memory used for segments across all shards assigned to the selected nodes. - $ref: '#/components/schemas/_common:HumanReadableByteCount' + $ref: '#/components/schemas/_common___HumanReadableByteCount' memory_in_bytes: description: The total amount, in bytes, of memory used for segments across all shards assigned to the selected nodes. - $ref: '#/components/schemas/_common:ByteCount' + $ref: '#/components/schemas/_common___ByteCount' norms_memory: description: The total amount of memory used for normalization factors across all shards assigned to the selected nodes. - $ref: '#/components/schemas/_common:HumanReadableByteCount' + $ref: '#/components/schemas/_common___HumanReadableByteCount' norms_memory_in_bytes: description: The total amount, in bytes, of memory used for normalization factors across all shards assigned to the selected nodes. - $ref: '#/components/schemas/_common:ByteCount' + $ref: '#/components/schemas/_common___ByteCount' points_memory: description: The total amount of memory used for points across all shards assigned to the selected nodes. - $ref: '#/components/schemas/_common:HumanReadableByteCount' + $ref: '#/components/schemas/_common___HumanReadableByteCount' points_memory_in_bytes: description: The total amount, in bytes, of memory used for points across all shards assigned to the selected nodes. - $ref: '#/components/schemas/_common:ByteCount' + $ref: '#/components/schemas/_common___ByteCount' stored_fields_memory: description: The total amount of memory used for stored fields across all shards assigned to the selected nodes. - $ref: '#/components/schemas/_common:HumanReadableByteCount' + $ref: '#/components/schemas/_common___HumanReadableByteCount' stored_fields_memory_in_bytes: description: The total amount, in bytes, of memory used for stored fields across all shards assigned to the selected nodes. - $ref: '#/components/schemas/_common:ByteCount' + $ref: '#/components/schemas/_common___ByteCount' terms_memory: description: The total amount of memory used for terms across all shards assigned to the selected nodes. - $ref: '#/components/schemas/_common:HumanReadableByteCount' + $ref: '#/components/schemas/_common___HumanReadableByteCount' terms_memory_in_bytes: description: The total amount, in bytes, of memory used for terms across all shards assigned to the selected nodes. - $ref: '#/components/schemas/_common:ByteCount' + $ref: '#/components/schemas/_common___ByteCount' term_vectors_memory: description: The total amount of memory used for term vectors across all shards assigned to the selected nodes. - $ref: '#/components/schemas/_common:HumanReadableByteCount' + $ref: '#/components/schemas/_common___HumanReadableByteCount' term_vectors_memory_in_bytes: description: The total amount, in bytes, of memory used for term vectors across all shards assigned to the selected nodes. - $ref: '#/components/schemas/_common:ByteCount' + $ref: '#/components/schemas/_common___ByteCount' version_map_memory: description: The total amount of memory used by all version maps across all shards assigned to the selected nodes. - $ref: '#/components/schemas/_common:HumanReadableByteCount' + $ref: '#/components/schemas/_common___HumanReadableByteCount' version_map_memory_in_bytes: description: The total amount, in bytes, of memory used by all version maps across all shards assigned to the selected nodes. - $ref: '#/components/schemas/_common:ByteCount' + $ref: '#/components/schemas/_common___ByteCount' remote_store: - $ref: '#/components/schemas/_common:RemoteStoreStats' + $ref: '#/components/schemas/_common___RemoteStoreStats' segment_replication: - $ref: '#/components/schemas/_common:SegmentReplicationStats' + $ref: '#/components/schemas/_common___SegmentReplicationStats' required: - count - doc_values_memory_in_bytes @@ -31795,18 +33484,18 @@ components: - term_vectors_memory_in_bytes - terms_memory_in_bytes - version_map_memory_in_bytes - _common:SequenceNumber: + _common___SequenceNumber: type: integer format: int64 - _common:ShardFailure: + _common___ShardFailure: type: object properties: index: - $ref: '#/components/schemas/_common:IndexName' + $ref: '#/components/schemas/_common___IndexName' node: type: string reason: - $ref: '#/components/schemas/_common:ErrorCause' + $ref: '#/components/schemas/_common___ErrorCause' shard: type: integer status: @@ -31814,71 +33503,73 @@ components: required: - reason - shard - _common:ShardsOperationResponseBase: + _common___ShardsOperationResponseBase: type: object properties: _shards: - $ref: '#/components/schemas/_common:ShardStatistics' + $ref: '#/components/schemas/_common___ShardStatistics' required: - _shards - _common:ShardStatistics: + _common___ShardStatistics: type: object properties: failed: - $ref: '#/components/schemas/_common:uint' + $ref: '#/components/schemas/_common___uint' successful: - $ref: '#/components/schemas/_common:uint' + $ref: '#/components/schemas/_common___uint' total: - $ref: '#/components/schemas/_common:uint' + $ref: '#/components/schemas/_common___uint' failures: type: array items: - $ref: '#/components/schemas/_common:ShardFailure' + $ref: '#/components/schemas/_common___ShardFailure' skipped: - $ref: '#/components/schemas/_common:uint' + $ref: '#/components/schemas/_common___uint' required: - failed - successful - total - _common:short: + _common___short: type: number - _common:SlicedScroll: + _common___SlicedScroll: type: object properties: field: - $ref: '#/components/schemas/_common:Field' + $ref: '#/components/schemas/_common___Field' id: - $ref: '#/components/schemas/_common:Id' + $ref: '#/components/schemas/_common___Id' max: type: integer format: int32 required: - id - max - _common:Slices: + _common___Slices: description: The slice configuration used to parallelize a process. oneOf: - type: number - - $ref: '#/components/schemas/_common:SlicesCalculation' - _common:SlicesCalculation: + - $ref: '#/components/schemas/_common___SlicesCalculation' + _common___SlicesCalculation: type: string enum: - auto - _common:Sort: + _common___Sort: oneOf: - - $ref: '#/components/schemas/_common:SortCombinations' + - $ref: '#/components/schemas/_common___SortCombinations' - type: array items: - $ref: '#/components/schemas/_common:SortCombinations' - _common:SortCombinations: + $ref: '#/components/schemas/_common___SortCombinations' + _common___SortCombinations: oneOf: - title: field - $ref: '#/components/schemas/_common:Field' + $ref: '#/components/schemas/_common___Field' + - title: field_with_direction + $ref: '#/components/schemas/_common___FieldWithDirection' - title: field_with_order - $ref: '#/components/schemas/_common:FieldWithOrder' + $ref: '#/components/schemas/_common___FieldWithOrder' - title: options - $ref: '#/components/schemas/_common:SortOptions' - _common:SortMode: + $ref: '#/components/schemas/_common___SortOptions' + _common___SortMode: type: string enum: - avg @@ -31886,33 +33577,33 @@ components: - median - min - sum - _common:SortOptions: + _common___SortOptions: type: object properties: _score: - $ref: '#/components/schemas/_common:ScoreSort' + $ref: '#/components/schemas/_common___ScoreSort' _doc: - $ref: '#/components/schemas/_common:ScoreSort' + $ref: '#/components/schemas/_common___ScoreSort' _geo_distance: - $ref: '#/components/schemas/_common:GeoDistanceSort' + $ref: '#/components/schemas/_common___GeoDistanceSort' _script: - $ref: '#/components/schemas/_common:ScriptSort' + $ref: '#/components/schemas/_common___ScriptSort' minProperties: 1 maxProperties: 1 - _common:SortOrder: + _common___SortOrder: type: string enum: - asc - desc - _common:SortResults: + _common___SortResults: type: array items: - $ref: '#/components/schemas/_common:FieldValue' - _common:StoredScript: + $ref: '#/components/schemas/_common___FieldValue' + _common___StoredScript: type: object properties: lang: - $ref: '#/components/schemas/_common:ScriptLanguage' + $ref: '#/components/schemas/_common___ScriptLanguage' options: type: object additionalProperties: @@ -31923,32 +33614,32 @@ components: required: - lang - source - _common:StoredScriptId: + _common___StoredScriptId: allOf: - - $ref: '#/components/schemas/_common:ScriptBase' + - $ref: '#/components/schemas/_common___ScriptBase' - type: object properties: id: - $ref: '#/components/schemas/_common:Id' + $ref: '#/components/schemas/_common___Id' required: - id - _common:StoreStats: + _common___StoreStats: type: object properties: size: - $ref: '#/components/schemas/_common:HumanReadableByteCount' + $ref: '#/components/schemas/_common___HumanReadableByteCount' size_in_bytes: description: The total size, in bytes, of all shards assigned to the selected nodes. - $ref: '#/components/schemas/_common:ByteCount' + $ref: '#/components/schemas/_common___ByteCount' reserved: - $ref: '#/components/schemas/_common:HumanReadableByteCount' + $ref: '#/components/schemas/_common___HumanReadableByteCount' 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. - $ref: '#/components/schemas/_common:ByteCount' + $ref: '#/components/schemas/_common___ByteCount' required: - reserved_in_bytes - size_in_bytes - _common:Stringifiedboolean: + _common___StringifiedBoolean: description: |- Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. @@ -31958,7 +33649,12 @@ components: oneOf: - type: boolean - type: string - _common:StringifiedEpochTimeUnitMillis: + _common___StringifiedDouble: + oneOf: + - type: number + format: double + - type: string + _common___StringifiedEpochTimeUnitMillis: description: |- Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. @@ -31966,9 +33662,9 @@ components: Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. oneOf: - - $ref: '#/components/schemas/_common:EpochTimeUnitMillis' + - $ref: '#/components/schemas/_common___EpochTimeUnitMillis' - type: string - _common:StringifiedEpochTimeUnitSeconds: + _common___StringifiedEpochTimeUnitSeconds: description: |- Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. @@ -31976,9 +33672,9 @@ components: Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. oneOf: - - $ref: '#/components/schemas/_common:EpochTimeUnitSeconds' + - $ref: '#/components/schemas/_common___EpochTimeUnitSeconds' - type: string - _common:Stringifiedinteger: + _common___StringifiedInteger: description: |- Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. @@ -31988,7 +33684,12 @@ components: oneOf: - type: integer - type: string - _common:StringifiedVersionNumber: + _common___StringifiedLong: + oneOf: + - type: integer + format: int64 + - type: string + _common___StringifiedVersionNumber: description: |- Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. @@ -31996,35 +33697,35 @@ components: Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type. oneOf: - - $ref: '#/components/schemas/_common:VersionNumber' + - $ref: '#/components/schemas/_common___VersionNumber' - type: string - _common:SuggestMode: + _common___SuggestMode: type: string enum: - always - missing - popular - _common:TaskFailure: + _common___TaskFailure: type: object properties: task_id: type: integer node_id: - $ref: '#/components/schemas/_common:NodeId' + $ref: '#/components/schemas/_common___NodeId' status: type: string reason: - $ref: '#/components/schemas/_common:ErrorCause' + $ref: '#/components/schemas/_common___ErrorCause' required: - node_id - reason - status - task_id - _common:TaskId: + _common___TaskId: oneOf: - type: string - type: number - _common:TermFrequencyNormalization: + _common___TermFrequencyNormalization: type: string enum: - h1 @@ -32032,10 +33733,10 @@ components: - h3 - 'no' - z - _common:TimeOfDay: + _common___TimeOfDay: description: Time of day, expressed as HH:MM:SS. type: string - _common:TimeUnit: + _common___TimeUnit: type: string enum: - d @@ -32045,29 +33746,29 @@ components: - ms - nanos - s - _common:TimeZone: + _common___TimeZone: type: string - _common:TopLeftBottomRightGeoBounds: + _common___TopLeftBottomRightGeoBounds: type: object properties: top_left: - $ref: '#/components/schemas/_common:GeoLocation' + $ref: '#/components/schemas/_common___GeoLocation' bottom_right: - $ref: '#/components/schemas/_common:GeoLocation' + $ref: '#/components/schemas/_common___GeoLocation' required: - bottom_right - top_left - _common:TopRightBottomLeftGeoBounds: + _common___TopRightBottomLeftGeoBounds: type: object properties: top_right: - $ref: '#/components/schemas/_common:GeoLocation' + $ref: '#/components/schemas/_common___GeoLocation' bottom_left: - $ref: '#/components/schemas/_common:GeoLocation' + $ref: '#/components/schemas/_common___GeoLocation' required: - bottom_left - top_right - _common:TranslogStats: + _common___TranslogStats: type: object properties: earliest_last_modified_age: @@ -32075,61 +33776,61 @@ components: operations: type: number remote_store: - $ref: '#/components/schemas/_common:RemoteStoreTranslogStats' + $ref: '#/components/schemas/_common___RemoteStoreTranslogStats' size: - $ref: '#/components/schemas/_common:HumanReadableByteCount' + $ref: '#/components/schemas/_common___HumanReadableByteCount' size_in_bytes: - $ref: '#/components/schemas/_common:ByteCount' + $ref: '#/components/schemas/_common___ByteCount' uncommitted_operations: type: number uncommitted_size: - $ref: '#/components/schemas/_common:HumanReadableByteCount' + $ref: '#/components/schemas/_common___HumanReadableByteCount' uncommitted_size_in_bytes: - $ref: '#/components/schemas/_common:ByteCount' + $ref: '#/components/schemas/_common___ByteCount' required: - earliest_last_modified_age - operations - size_in_bytes - uncommitted_operations - uncommitted_size_in_bytes - _common:TransportAddress: + _common___TransportAddress: type: string - _common:Type: + _common___Type: type: string x-version-removed: '2.0' - _common:uint: + _common___uint: type: integer - _common:ulong: + _common___ulong: type: number - _common:UnitMillis: + _common___UnitMillis: description: The time unit for milliseconds. type: integer format: int64 - _common:UnitNanos: + _common___UnitNanos: description: Time unit for nanoseconds. type: integer format: int64 - _common:UnitSeconds: + _common___UnitSeconds: description: Time unit for seconds. type: integer format: int64 - _common:Username: + _common___Username: type: string - _common:Uuid: + _common___Uuid: type: string - _common:VersionNumber: + _common___VersionNumber: type: integer format: int64 - _common:VersionString: + _common___VersionString: type: string - _common:VersionType: + _common___VersionType: type: string enum: - external - external_gte - force - internal - _common:Void: + _common___Void: description: |- The absence of any type. This is commonly used in APIs that don't return a body. @@ -32138,16 +33839,18 @@ components: See https://en.m.wikipedia.org/wiki/Unit_type and https://en.m.wikipedia.org/wiki/Bottom_type. type: object - _common:WaitForActiveShardOptions: + _common___WaitForActiveShardOptions: type: string enum: - all - index-setting - _common:WaitForActiveShards: + _common___WaitForActiveShards: oneOf: - - type: number - - $ref: '#/components/schemas/_common:WaitForActiveShardOptions' - _common:WaitForEvents: + - title: count + type: integer + - title: option + $ref: '#/components/schemas/_common___WaitForActiveShardOptions' + _common___WaitForEvents: type: string enum: - high @@ -32156,7 +33859,7 @@ components: - low - normal - urgent - _common:WarmerStats: + _common___WarmerStats: type: object properties: current: @@ -32164,40 +33867,40 @@ components: total: type: number total_time: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' total_time_in_millis: - $ref: '#/components/schemas/_common:DurationValueUnitMillis' + $ref: '#/components/schemas/_common___DurationValueUnitMillis' required: - current - total - total_time_in_millis - _common:WktGeoBounds: + _common___WktGeoBounds: type: object properties: wkt: type: string required: - wkt - _common:WriteResponseBase: + _common___WriteResponseBase: type: object properties: _type: - $ref: '#/components/schemas/_common:Type' + $ref: '#/components/schemas/_common___Type' _id: - $ref: '#/components/schemas/_common:Id' + $ref: '#/components/schemas/_common___Id' _index: - $ref: '#/components/schemas/_common:IndexName' + $ref: '#/components/schemas/_common___IndexName' _primary_term: type: integer format: int64 result: - $ref: '#/components/schemas/_common:Result' + $ref: '#/components/schemas/_common___Result' _seq_no: - $ref: '#/components/schemas/_common:SequenceNumber' + $ref: '#/components/schemas/_common___SequenceNumber' _shards: - $ref: '#/components/schemas/_common:ShardStatistics' + $ref: '#/components/schemas/_common___ShardStatistics' _version: - $ref: '#/components/schemas/_common:VersionNumber' + $ref: '#/components/schemas/_common___VersionNumber' forced_refresh: type: boolean required: @@ -32208,7 +33911,7 @@ components: - _shards - _version - result - _common:XyCartesianCoordinates: + _common___XyCartesianCoordinates: x-version-added: '2.4' type: object properties: @@ -32223,7 +33926,7 @@ components: required: - x - 'y' - _common:XyLocation: + _common___XyLocation: x-version-added: '2.4' description: |- A two-dimensional Cartesian point specified by x and y coordinates. It can be represented in the following ways: @@ -32232,7 +33935,7 @@ components: - As a string in `"x, y"` or WKT point format. oneOf: - title: cartesian - $ref: '#/components/schemas/_common:XyCartesianCoordinates' + $ref: '#/components/schemas/_common___XyCartesianCoordinates' - title: coords type: array items: @@ -32240,13 +33943,13 @@ components: format: double - title: text type: string - _common.aggregations:AdjacencyMatrixAggregate: + _common.aggregations___AdjacencyMatrixAggregate: allOf: - - $ref: '#/components/schemas/_common.aggregations:MultiBucketAggregateBaseAdjacencyMatrixBucket' + - $ref: '#/components/schemas/_common.aggregations___MultiBucketAggregateBaseAdjacencyMatrixBucket' - type: object - _common.aggregations:AdjacencyMatrixAggregation: + _common.aggregations___AdjacencyMatrixAggregation: allOf: - - $ref: '#/components/schemas/_common.aggregations:BucketAggregationBase' + - $ref: '#/components/schemas/_common.aggregations___BucketAggregationBase' - type: object properties: filters: @@ -32255,114 +33958,114 @@ components: At least one filter is required. type: object additionalProperties: - $ref: '#/components/schemas/_common.query_dsl:QueryContainer' - _common.aggregations:AdjacencyMatrixBucket: + $ref: '#/components/schemas/_common.query_dsl___QueryContainer' + _common.aggregations___AdjacencyMatrixBucket: allOf: - - $ref: '#/components/schemas/_common.aggregations:MultiBucketBase' + - $ref: '#/components/schemas/_common.aggregations___MultiBucketBase' - type: object properties: key: type: string required: - key - _common.aggregations:Aggregate: + _common.aggregations___Aggregate: anyOf: - - $ref: '#/components/schemas/_common.aggregations:CardinalityAggregate' - - $ref: '#/components/schemas/_common.aggregations:HdrPercentilesAggregate' - - $ref: '#/components/schemas/_common.aggregations:HdrPercentileRanksAggregate' - - $ref: '#/components/schemas/_common.aggregations:TDigestPercentilesAggregate' - - $ref: '#/components/schemas/_common.aggregations:TDigestPercentileRanksAggregate' - - $ref: '#/components/schemas/_common.aggregations:PercentilesBucketAggregate' - - $ref: '#/components/schemas/_common.aggregations:MedianAbsoluteDeviationAggregate' - - $ref: '#/components/schemas/_common.aggregations:MinAggregate' - - $ref: '#/components/schemas/_common.aggregations:MaxAggregate' - - $ref: '#/components/schemas/_common.aggregations:SumAggregate' - - $ref: '#/components/schemas/_common.aggregations:AvgAggregate' - - $ref: '#/components/schemas/_common.aggregations:WeightedAvgAggregate' - - $ref: '#/components/schemas/_common.aggregations:ValueCountAggregate' - - $ref: '#/components/schemas/_common.aggregations:SimpleValueAggregate' - - $ref: '#/components/schemas/_common.aggregations:DerivativeAggregate' - - $ref: '#/components/schemas/_common.aggregations:BucketMetricValueAggregate' - - $ref: '#/components/schemas/_common.aggregations:StatsAggregate' - - $ref: '#/components/schemas/_common.aggregations:StatsBucketAggregate' - - $ref: '#/components/schemas/_common.aggregations:ExtendedStatsAggregate' - - $ref: '#/components/schemas/_common.aggregations:ExtendedStatsBucketAggregate' - - $ref: '#/components/schemas/_common.aggregations:GeoBoundsAggregate' - - $ref: '#/components/schemas/_common.aggregations:GeoCentroidAggregate' - - $ref: '#/components/schemas/_common.aggregations:HistogramAggregate' - - $ref: '#/components/schemas/_common.aggregations:DateHistogramAggregate' - - $ref: '#/components/schemas/_common.aggregations:AutoDateHistogramAggregate' - - $ref: '#/components/schemas/_common.aggregations:VariableWidthHistogramAggregate' - - $ref: '#/components/schemas/_common.aggregations:StringTermsAggregate' - - $ref: '#/components/schemas/_common.aggregations:LongTermsAggregate' - - $ref: '#/components/schemas/_common.aggregations:DoubleTermsAggregate' - - $ref: '#/components/schemas/_common.aggregations:UnmappedTermsAggregate' - - $ref: '#/components/schemas/_common.aggregations:LongRareTermsAggregate' - - $ref: '#/components/schemas/_common.aggregations:StringRareTermsAggregate' - - $ref: '#/components/schemas/_common.aggregations:UnmappedRareTermsAggregate' - - $ref: '#/components/schemas/_common.aggregations:MultiTermsAggregate' - - $ref: '#/components/schemas/_common.aggregations:MissingAggregate' - - $ref: '#/components/schemas/_common.aggregations:NestedAggregate' - - $ref: '#/components/schemas/_common.aggregations:ReverseNestedAggregate' - - $ref: '#/components/schemas/_common.aggregations:GlobalAggregate' - - $ref: '#/components/schemas/_common.aggregations:FilterAggregate' - - $ref: '#/components/schemas/_common.aggregations:ChildrenAggregate' - - $ref: '#/components/schemas/_common.aggregations:ParentAggregate' - - $ref: '#/components/schemas/_common.aggregations:SamplerAggregate' - - $ref: '#/components/schemas/_common.aggregations:UnmappedSamplerAggregate' - - $ref: '#/components/schemas/_common.aggregations:GeoHashGridAggregate' - - $ref: '#/components/schemas/_common.aggregations:GeoTileGridAggregate' - - $ref: '#/components/schemas/_common.aggregations:GeoHexGridAggregate' - - $ref: '#/components/schemas/_common.aggregations:RangeAggregate' - - $ref: '#/components/schemas/_common.aggregations:DateRangeAggregate' - - $ref: '#/components/schemas/_common.aggregations:GeoDistanceAggregate' - - $ref: '#/components/schemas/_common.aggregations:IpRangeAggregate' - - $ref: '#/components/schemas/_common.aggregations:IpPrefixAggregate' - - $ref: '#/components/schemas/_common.aggregations:FiltersAggregate' - - $ref: '#/components/schemas/_common.aggregations:AdjacencyMatrixAggregate' - - $ref: '#/components/schemas/_common.aggregations:SignificantLongTermsAggregate' - - $ref: '#/components/schemas/_common.aggregations:SignificantStringTermsAggregate' - - $ref: '#/components/schemas/_common.aggregations:UnmappedSignificantTermsAggregate' - - $ref: '#/components/schemas/_common.aggregations:CompositeAggregate' - - $ref: '#/components/schemas/_common.aggregations:FrequentItemSetsAggregate' - - $ref: '#/components/schemas/_common.aggregations:ScriptedMetricAggregate' - - $ref: '#/components/schemas/_common.aggregations:TopHitsAggregate' - - $ref: '#/components/schemas/_common.aggregations:InferenceAggregate' - - $ref: '#/components/schemas/_common.aggregations:StringStatsAggregate' - - $ref: '#/components/schemas/_common.aggregations:BoxPlotAggregate' - - $ref: '#/components/schemas/_common.aggregations:TopMetricsAggregate' - - $ref: '#/components/schemas/_common.aggregations:TTestAggregate' - - $ref: '#/components/schemas/_common.aggregations:RateAggregate' - - $ref: '#/components/schemas/_common.aggregations:CumulativeCardinalityAggregate' - - $ref: '#/components/schemas/_common.aggregations:MatrixStatsAggregate' - - $ref: '#/components/schemas/_common.aggregations:GeoLineAggregate' - _common.aggregations:AggregateBase: + - $ref: '#/components/schemas/_common.aggregations___CardinalityAggregate' + - $ref: '#/components/schemas/_common.aggregations___HdrPercentilesAggregate' + - $ref: '#/components/schemas/_common.aggregations___HdrPercentileRanksAggregate' + - $ref: '#/components/schemas/_common.aggregations___TDigestPercentilesAggregate' + - $ref: '#/components/schemas/_common.aggregations___TDigestPercentileRanksAggregate' + - $ref: '#/components/schemas/_common.aggregations___PercentilesBucketAggregate' + - $ref: '#/components/schemas/_common.aggregations___MedianAbsoluteDeviationAggregate' + - $ref: '#/components/schemas/_common.aggregations___MinAggregate' + - $ref: '#/components/schemas/_common.aggregations___MaxAggregate' + - $ref: '#/components/schemas/_common.aggregations___SumAggregate' + - $ref: '#/components/schemas/_common.aggregations___AvgAggregate' + - $ref: '#/components/schemas/_common.aggregations___WeightedAvgAggregate' + - $ref: '#/components/schemas/_common.aggregations___ValueCountAggregate' + - $ref: '#/components/schemas/_common.aggregations___SimpleValueAggregate' + - $ref: '#/components/schemas/_common.aggregations___DerivativeAggregate' + - $ref: '#/components/schemas/_common.aggregations___BucketMetricValueAggregate' + - $ref: '#/components/schemas/_common.aggregations___StatsAggregate' + - $ref: '#/components/schemas/_common.aggregations___StatsBucketAggregate' + - $ref: '#/components/schemas/_common.aggregations___ExtendedStatsAggregate' + - $ref: '#/components/schemas/_common.aggregations___ExtendedStatsBucketAggregate' + - $ref: '#/components/schemas/_common.aggregations___GeoBoundsAggregate' + - $ref: '#/components/schemas/_common.aggregations___GeoCentroidAggregate' + - $ref: '#/components/schemas/_common.aggregations___HistogramAggregate' + - $ref: '#/components/schemas/_common.aggregations___DateHistogramAggregate' + - $ref: '#/components/schemas/_common.aggregations___AutoDateHistogramAggregate' + - $ref: '#/components/schemas/_common.aggregations___VariableWidthHistogramAggregate' + - $ref: '#/components/schemas/_common.aggregations___StringTermsAggregate' + - $ref: '#/components/schemas/_common.aggregations___LongTermsAggregate' + - $ref: '#/components/schemas/_common.aggregations___DoubleTermsAggregate' + - $ref: '#/components/schemas/_common.aggregations___UnmappedTermsAggregate' + - $ref: '#/components/schemas/_common.aggregations___LongRareTermsAggregate' + - $ref: '#/components/schemas/_common.aggregations___StringRareTermsAggregate' + - $ref: '#/components/schemas/_common.aggregations___UnmappedRareTermsAggregate' + - $ref: '#/components/schemas/_common.aggregations___MultiTermsAggregate' + - $ref: '#/components/schemas/_common.aggregations___MissingAggregate' + - $ref: '#/components/schemas/_common.aggregations___NestedAggregate' + - $ref: '#/components/schemas/_common.aggregations___ReverseNestedAggregate' + - $ref: '#/components/schemas/_common.aggregations___GlobalAggregate' + - $ref: '#/components/schemas/_common.aggregations___FilterAggregate' + - $ref: '#/components/schemas/_common.aggregations___ChildrenAggregate' + - $ref: '#/components/schemas/_common.aggregations___ParentAggregate' + - $ref: '#/components/schemas/_common.aggregations___SamplerAggregate' + - $ref: '#/components/schemas/_common.aggregations___UnmappedSamplerAggregate' + - $ref: '#/components/schemas/_common.aggregations___GeoHashGridAggregate' + - $ref: '#/components/schemas/_common.aggregations___GeoTileGridAggregate' + - $ref: '#/components/schemas/_common.aggregations___GeoHexGridAggregate' + - $ref: '#/components/schemas/_common.aggregations___RangeAggregate' + - $ref: '#/components/schemas/_common.aggregations___DateRangeAggregate' + - $ref: '#/components/schemas/_common.aggregations___GeoDistanceAggregate' + - $ref: '#/components/schemas/_common.aggregations___IpRangeAggregate' + - $ref: '#/components/schemas/_common.aggregations___IpPrefixAggregate' + - $ref: '#/components/schemas/_common.aggregations___FiltersAggregate' + - $ref: '#/components/schemas/_common.aggregations___AdjacencyMatrixAggregate' + - $ref: '#/components/schemas/_common.aggregations___SignificantLongTermsAggregate' + - $ref: '#/components/schemas/_common.aggregations___SignificantStringTermsAggregate' + - $ref: '#/components/schemas/_common.aggregations___UnmappedSignificantTermsAggregate' + - $ref: '#/components/schemas/_common.aggregations___CompositeAggregate' + - $ref: '#/components/schemas/_common.aggregations___FrequentItemSetsAggregate' + - $ref: '#/components/schemas/_common.aggregations___ScriptedMetricAggregate' + - $ref: '#/components/schemas/_common.aggregations___TopHitsAggregate' + - $ref: '#/components/schemas/_common.aggregations___InferenceAggregate' + - $ref: '#/components/schemas/_common.aggregations___StringStatsAggregate' + - $ref: '#/components/schemas/_common.aggregations___BoxPlotAggregate' + - $ref: '#/components/schemas/_common.aggregations___TopMetricsAggregate' + - $ref: '#/components/schemas/_common.aggregations___TTestAggregate' + - $ref: '#/components/schemas/_common.aggregations___RateAggregate' + - $ref: '#/components/schemas/_common.aggregations___CumulativeCardinalityAggregate' + - $ref: '#/components/schemas/_common.aggregations___MatrixStatsAggregate' + - $ref: '#/components/schemas/_common.aggregations___GeoLineAggregate' + _common.aggregations___AggregateBase: type: object properties: meta: - $ref: '#/components/schemas/_common:Metadata' - _common.aggregations:AggregateOrder: + $ref: '#/components/schemas/_common___Metadata' + _common.aggregations___AggregateOrder: oneOf: - type: object additionalProperties: - $ref: '#/components/schemas/_common:SortOrder' + $ref: '#/components/schemas/_common___SortOrder' minProperties: 1 maxProperties: 1 - type: array items: type: object additionalProperties: - $ref: '#/components/schemas/_common:SortOrder' + $ref: '#/components/schemas/_common___SortOrder' minProperties: 1 maxProperties: 1 - _common.aggregations:Aggregation: + _common.aggregations___Aggregation: type: object properties: meta: - $ref: '#/components/schemas/_common:Metadata' + $ref: '#/components/schemas/_common___Metadata' name: type: string - _common.aggregations:AggregationContainer: + _common.aggregations___AggregationContainer: allOf: - type: object properties: @@ -32372,166 +34075,166 @@ components: Only applies to bucket aggregations. type: object additionalProperties: - $ref: '#/components/schemas/_common.aggregations:AggregationContainer' + $ref: '#/components/schemas/_common.aggregations___AggregationContainer' meta: - $ref: '#/components/schemas/_common:Metadata' + $ref: '#/components/schemas/_common___Metadata' - type: object properties: adjacency_matrix: - $ref: '#/components/schemas/_common.aggregations:AdjacencyMatrixAggregation' + $ref: '#/components/schemas/_common.aggregations___AdjacencyMatrixAggregation' auto_date_histogram: - $ref: '#/components/schemas/_common.aggregations:AutoDateHistogramAggregation' + $ref: '#/components/schemas/_common.aggregations___AutoDateHistogramAggregation' avg: - $ref: '#/components/schemas/_common.aggregations:AverageAggregation' + $ref: '#/components/schemas/_common.aggregations___AverageAggregation' avg_bucket: - $ref: '#/components/schemas/_common.aggregations:AverageBucketAggregation' + $ref: '#/components/schemas/_common.aggregations___AverageBucketAggregation' boxplot: - $ref: '#/components/schemas/_common.aggregations:BoxplotAggregation' + $ref: '#/components/schemas/_common.aggregations___BoxplotAggregation' bucket_script: - $ref: '#/components/schemas/_common.aggregations:BucketScriptAggregation' + $ref: '#/components/schemas/_common.aggregations___BucketScriptAggregation' bucket_selector: - $ref: '#/components/schemas/_common.aggregations:BucketSelectorAggregation' + $ref: '#/components/schemas/_common.aggregations___BucketSelectorAggregation' bucket_sort: - $ref: '#/components/schemas/_common.aggregations:BucketSortAggregation' + $ref: '#/components/schemas/_common.aggregations___BucketSortAggregation' bucket_count_ks_test: - $ref: '#/components/schemas/_common.aggregations:BucketKsAggregation' + $ref: '#/components/schemas/_common.aggregations___BucketKsAggregation' bucket_correlation: - $ref: '#/components/schemas/_common.aggregations:BucketCorrelationAggregation' + $ref: '#/components/schemas/_common.aggregations___BucketCorrelationAggregation' cardinality: - $ref: '#/components/schemas/_common.aggregations:CardinalityAggregation' + $ref: '#/components/schemas/_common.aggregations___CardinalityAggregation' categorize_text: - $ref: '#/components/schemas/_common.aggregations:CategorizeTextAggregation' + $ref: '#/components/schemas/_common.aggregations___CategorizeTextAggregation' children: - $ref: '#/components/schemas/_common.aggregations:ChildrenAggregation' + $ref: '#/components/schemas/_common.aggregations___ChildrenAggregation' composite: - $ref: '#/components/schemas/_common.aggregations:CompositeAggregation' + $ref: '#/components/schemas/_common.aggregations___CompositeAggregation' cumulative_cardinality: - $ref: '#/components/schemas/_common.aggregations:CumulativeCardinalityAggregation' + $ref: '#/components/schemas/_common.aggregations___CumulativeCardinalityAggregation' cumulative_sum: - $ref: '#/components/schemas/_common.aggregations:CumulativeSumAggregation' + $ref: '#/components/schemas/_common.aggregations___CumulativeSumAggregation' date_histogram: - $ref: '#/components/schemas/_common.aggregations:DateHistogramAggregation' + $ref: '#/components/schemas/_common.aggregations___DateHistogramAggregation' date_range: - $ref: '#/components/schemas/_common.aggregations:DateRangeAggregation' + $ref: '#/components/schemas/_common.aggregations___DateRangeAggregation' derivative: - $ref: '#/components/schemas/_common.aggregations:DerivativeAggregation' + $ref: '#/components/schemas/_common.aggregations___DerivativeAggregation' diversified_sampler: - $ref: '#/components/schemas/_common.aggregations:DiversifiedSamplerAggregation' + $ref: '#/components/schemas/_common.aggregations___DiversifiedSamplerAggregation' extended_stats: - $ref: '#/components/schemas/_common.aggregations:ExtendedStatsAggregation' + $ref: '#/components/schemas/_common.aggregations___ExtendedStatsAggregation' extended_stats_bucket: - $ref: '#/components/schemas/_common.aggregations:ExtendedStatsBucketAggregation' + $ref: '#/components/schemas/_common.aggregations___ExtendedStatsBucketAggregation' frequent_item_sets: - $ref: '#/components/schemas/_common.aggregations:FrequentItemSetsAggregation' + $ref: '#/components/schemas/_common.aggregations___FrequentItemSetsAggregation' filter: - $ref: '#/components/schemas/_common.query_dsl:QueryContainer' + $ref: '#/components/schemas/_common.query_dsl___QueryContainer' filters: - $ref: '#/components/schemas/_common.aggregations:FiltersAggregation' + $ref: '#/components/schemas/_common.aggregations___FiltersAggregation' geo_bounds: - $ref: '#/components/schemas/_common.aggregations:GeoBoundsAggregation' + $ref: '#/components/schemas/_common.aggregations___GeoBoundsAggregation' geo_centroid: - $ref: '#/components/schemas/_common.aggregations:GeoCentroidAggregation' + $ref: '#/components/schemas/_common.aggregations___GeoCentroidAggregation' geo_distance: - $ref: '#/components/schemas/_common.aggregations:GeoDistanceAggregation' + $ref: '#/components/schemas/_common.aggregations___GeoDistanceAggregation' geohash_grid: - $ref: '#/components/schemas/_common.aggregations:GeoHashGridAggregation' + $ref: '#/components/schemas/_common.aggregations___GeoHashGridAggregation' geo_line: - $ref: '#/components/schemas/_common.aggregations:GeoLineAggregation' + $ref: '#/components/schemas/_common.aggregations___GeoLineAggregation' geotile_grid: - $ref: '#/components/schemas/_common.aggregations:GeoTileGridAggregation' + $ref: '#/components/schemas/_common.aggregations___GeoTileGridAggregation' geohex_grid: - $ref: '#/components/schemas/_common.aggregations:GeohexGridAggregation' + $ref: '#/components/schemas/_common.aggregations___GeohexGridAggregation' global: - $ref: '#/components/schemas/_common.aggregations:GlobalAggregation' + $ref: '#/components/schemas/_common.aggregations___GlobalAggregation' histogram: - $ref: '#/components/schemas/_common.aggregations:HistogramAggregation' + $ref: '#/components/schemas/_common.aggregations___HistogramAggregation' ip_range: - $ref: '#/components/schemas/_common.aggregations:IpRangeAggregation' + $ref: '#/components/schemas/_common.aggregations___IpRangeAggregation' ip_prefix: - $ref: '#/components/schemas/_common.aggregations:IpPrefixAggregation' + $ref: '#/components/schemas/_common.aggregations___IpPrefixAggregation' inference: - $ref: '#/components/schemas/_common.aggregations:InferenceAggregation' + $ref: '#/components/schemas/_common.aggregations___InferenceAggregation' line: - $ref: '#/components/schemas/_common.aggregations:GeoLineAggregation' + $ref: '#/components/schemas/_common.aggregations___GeoLineAggregation' matrix_stats: - $ref: '#/components/schemas/_common.aggregations:MatrixStatsAggregation' + $ref: '#/components/schemas/_common.aggregations___MatrixStatsAggregation' max: - $ref: '#/components/schemas/_common.aggregations:MaxAggregation' + $ref: '#/components/schemas/_common.aggregations___MaxAggregation' max_bucket: - $ref: '#/components/schemas/_common.aggregations:MaxBucketAggregation' + $ref: '#/components/schemas/_common.aggregations___MaxBucketAggregation' median_absolute_deviation: - $ref: '#/components/schemas/_common.aggregations:MedianAbsoluteDeviationAggregation' + $ref: '#/components/schemas/_common.aggregations___MedianAbsoluteDeviationAggregation' min: - $ref: '#/components/schemas/_common.aggregations:MinAggregation' + $ref: '#/components/schemas/_common.aggregations___MinAggregation' min_bucket: - $ref: '#/components/schemas/_common.aggregations:MinBucketAggregation' + $ref: '#/components/schemas/_common.aggregations___MinBucketAggregation' missing: - $ref: '#/components/schemas/_common.aggregations:MissingAggregation' + $ref: '#/components/schemas/_common.aggregations___MissingAggregation' moving_avg: - $ref: '#/components/schemas/_common.aggregations:MovingAverageAggregation' + $ref: '#/components/schemas/_common.aggregations___MovingAverageAggregation' moving_percentiles: - $ref: '#/components/schemas/_common.aggregations:MovingPercentilesAggregation' + $ref: '#/components/schemas/_common.aggregations___MovingPercentilesAggregation' moving_fn: - $ref: '#/components/schemas/_common.aggregations:MovingFunctionAggregation' + $ref: '#/components/schemas/_common.aggregations___MovingFunctionAggregation' multi_terms: - $ref: '#/components/schemas/_common.aggregations:MultiTermsAggregation' + $ref: '#/components/schemas/_common.aggregations___MultiTermsAggregation' nested: - $ref: '#/components/schemas/_common.aggregations:NestedAggregation' + $ref: '#/components/schemas/_common.aggregations___NestedAggregation' normalize: - $ref: '#/components/schemas/_common.aggregations:NormalizeAggregation' + $ref: '#/components/schemas/_common.aggregations___NormalizeAggregation' parent: - $ref: '#/components/schemas/_common.aggregations:ParentAggregation' + $ref: '#/components/schemas/_common.aggregations___ParentAggregation' percentile_ranks: - $ref: '#/components/schemas/_common.aggregations:PercentileRanksAggregation' + $ref: '#/components/schemas/_common.aggregations___PercentileRanksAggregation' percentiles: - $ref: '#/components/schemas/_common.aggregations:PercentilesAggregation' + $ref: '#/components/schemas/_common.aggregations___PercentilesAggregation' percentiles_bucket: - $ref: '#/components/schemas/_common.aggregations:PercentilesBucketAggregation' + $ref: '#/components/schemas/_common.aggregations___PercentilesBucketAggregation' range: - $ref: '#/components/schemas/_common.aggregations:RangeAggregation' + $ref: '#/components/schemas/_common.aggregations___RangeAggregation' rare_terms: - $ref: '#/components/schemas/_common.aggregations:RareTermsAggregation' + $ref: '#/components/schemas/_common.aggregations___RareTermsAggregation' rate: - $ref: '#/components/schemas/_common.aggregations:RateAggregation' + $ref: '#/components/schemas/_common.aggregations___RateAggregation' reverse_nested: - $ref: '#/components/schemas/_common.aggregations:ReverseNestedAggregation' + $ref: '#/components/schemas/_common.aggregations___ReverseNestedAggregation' sampler: - $ref: '#/components/schemas/_common.aggregations:SamplerAggregation' + $ref: '#/components/schemas/_common.aggregations___SamplerAggregation' scripted_metric: - $ref: '#/components/schemas/_common.aggregations:ScriptedMetricAggregation' + $ref: '#/components/schemas/_common.aggregations___ScriptedMetricAggregation' serial_diff: - $ref: '#/components/schemas/_common.aggregations:SerialDifferencingAggregation' + $ref: '#/components/schemas/_common.aggregations___SerialDifferencingAggregation' significant_terms: - $ref: '#/components/schemas/_common.aggregations:SignificantTermsAggregation' + $ref: '#/components/schemas/_common.aggregations___SignificantTermsAggregation' significant_text: - $ref: '#/components/schemas/_common.aggregations:SignificantTextAggregation' + $ref: '#/components/schemas/_common.aggregations___SignificantTextAggregation' stats: - $ref: '#/components/schemas/_common.aggregations:StatsAggregation' + $ref: '#/components/schemas/_common.aggregations___StatsAggregation' stats_bucket: - $ref: '#/components/schemas/_common.aggregations:StatsBucketAggregation' + $ref: '#/components/schemas/_common.aggregations___StatsBucketAggregation' string_stats: - $ref: '#/components/schemas/_common.aggregations:StringStatsAggregation' + $ref: '#/components/schemas/_common.aggregations___StringStatsAggregation' sum: - $ref: '#/components/schemas/_common.aggregations:SumAggregation' + $ref: '#/components/schemas/_common.aggregations___SumAggregation' sum_bucket: - $ref: '#/components/schemas/_common.aggregations:SumBucketAggregation' + $ref: '#/components/schemas/_common.aggregations___SumBucketAggregation' terms: - $ref: '#/components/schemas/_common.aggregations:TermsAggregation' + $ref: '#/components/schemas/_common.aggregations___TermsAggregation' top_hits: - $ref: '#/components/schemas/_common.aggregations:TopHitsAggregation' + $ref: '#/components/schemas/_common.aggregations___TopHitsAggregation' t_test: - $ref: '#/components/schemas/_common.aggregations:TTestAggregation' + $ref: '#/components/schemas/_common.aggregations___TTestAggregation' top_metrics: - $ref: '#/components/schemas/_common.aggregations:TopMetricsAggregation' + $ref: '#/components/schemas/_common.aggregations___TopMetricsAggregation' value_count: - $ref: '#/components/schemas/_common.aggregations:ValueCountAggregation' + $ref: '#/components/schemas/_common.aggregations___ValueCountAggregation' weighted_avg: - $ref: '#/components/schemas/_common.aggregations:WeightedAverageAggregation' + $ref: '#/components/schemas/_common.aggregations___WeightedAverageAggregation' variable_width_histogram: - $ref: '#/components/schemas/_common.aggregations:VariableWidthHistogramAggregation' + $ref: '#/components/schemas/_common.aggregations___VariableWidthHistogramAggregation' minProperties: 1 maxProperties: 1 - _common.aggregations:AggregationRange: + _common.aggregations___AggregationRange: type: object properties: from: @@ -32549,7 +34252,7 @@ components: - 'null' - number - string - _common.aggregations:ArrayPercentilesItem: + _common.aggregations___ArrayPercentilesItem: type: object properties: key: @@ -32564,34 +34267,34 @@ components: required: - key - value - _common.aggregations:AutoDateHistogramAggregate: + _common.aggregations___AutoDateHistogramAggregate: allOf: - - $ref: '#/components/schemas/_common.aggregations:MultiBucketAggregateBaseDateHistogramBucket' + - $ref: '#/components/schemas/_common.aggregations___MultiBucketAggregateBaseDateHistogramBucket' - type: object properties: interval: - $ref: '#/components/schemas/_common:DurationLarge' + $ref: '#/components/schemas/_common___DurationLarge' required: - interval - _common.aggregations:AutoDateHistogramAggregation: + _common.aggregations___AutoDateHistogramAggregation: allOf: - - $ref: '#/components/schemas/_common.aggregations:BucketAggregationBase' + - $ref: '#/components/schemas/_common.aggregations___BucketAggregationBase' - type: object properties: buckets: description: The target number of buckets. type: number field: - $ref: '#/components/schemas/_common:Field' + $ref: '#/components/schemas/_common___Field' format: description: |- The date format used to format `key_as_string` in the response. If no `format` is specified, the first date format specified in the field mapping is used. type: string minimum_interval: - $ref: '#/components/schemas/_common.aggregations:MinimumInterval' + $ref: '#/components/schemas/_common.aggregations___MinimumInterval' missing: - $ref: '#/components/schemas/_common:DateTime' + $ref: '#/components/schemas/_common___DateTime' offset: description: Time zone specified as a ISO 8601 UTC offset. type: string @@ -32600,24 +34303,24 @@ components: additionalProperties: type: object script: - $ref: '#/components/schemas/_common:Script' + $ref: '#/components/schemas/_common___Script' time_zone: - $ref: '#/components/schemas/_common:TimeZone' - _common.aggregations:AverageAggregation: + $ref: '#/components/schemas/_common___TimeZone' + _common.aggregations___AverageAggregation: allOf: - - $ref: '#/components/schemas/_common.aggregations:FormatMetricAggregationBase' + - $ref: '#/components/schemas/_common.aggregations___FormatMetricAggregationBase' - type: object - _common.aggregations:AverageBucketAggregation: + _common.aggregations___AverageBucketAggregation: allOf: - - $ref: '#/components/schemas/_common.aggregations:PipelineAggregationBase' + - $ref: '#/components/schemas/_common.aggregations___PipelineAggregationBase' - type: object - _common.aggregations:AvgAggregate: + _common.aggregations___AvgAggregate: allOf: - - $ref: '#/components/schemas/_common.aggregations:SingleMetricAggregateBase' + - $ref: '#/components/schemas/_common.aggregations___SingleMetricAggregateBase' - type: object - _common.aggregations:BoxPlotAggregate: + _common.aggregations___BoxPlotAggregate: allOf: - - $ref: '#/components/schemas/_common.aggregations:AggregateBase' + - $ref: '#/components/schemas/_common.aggregations___AggregateBase' - type: object properties: min: @@ -32656,48 +34359,48 @@ components: - q2 - q3 - upper - _common.aggregations:BoxplotAggregation: + _common.aggregations___BoxplotAggregation: allOf: - - $ref: '#/components/schemas/_common.aggregations:MetricAggregationBase' + - $ref: '#/components/schemas/_common.aggregations___MetricAggregationBase' - type: object properties: compression: description: Limits the maximum number of nodes used by the underlying TDigest algorithm to `20 * compression`, enabling control of memory usage and approximation error. type: number - _common.aggregations:BucketAggregationBase: + _common.aggregations___BucketAggregationBase: allOf: - - $ref: '#/components/schemas/_common.aggregations:Aggregation' + - $ref: '#/components/schemas/_common.aggregations___Aggregation' - type: object - _common.aggregations:BucketCorrelationAggregation: + _common.aggregations___BucketCorrelationAggregation: allOf: - - $ref: '#/components/schemas/_common.aggregations:BucketPathAggregation' + - $ref: '#/components/schemas/_common.aggregations___BucketPathAggregation' - type: object properties: function: - $ref: '#/components/schemas/_common.aggregations:BucketCorrelationFunction' + $ref: '#/components/schemas/_common.aggregations___BucketCorrelationFunction' required: - function - _common.aggregations:BucketCorrelationFunction: + _common.aggregations___BucketCorrelationFunction: type: object properties: count_correlation: - $ref: '#/components/schemas/_common.aggregations:BucketCorrelationFunctionCountCorrelation' + $ref: '#/components/schemas/_common.aggregations___BucketCorrelationFunctionCountCorrelation' required: - count_correlation - _common.aggregations:BucketCorrelationFunctionCountCorrelation: + _common.aggregations___BucketCorrelationFunctionCountCorrelation: type: object properties: indicator: - $ref: '#/components/schemas/_common.aggregations:BucketCorrelationFunctionCountCorrelationIndicator' + $ref: '#/components/schemas/_common.aggregations___BucketCorrelationFunctionCountCorrelationIndicator' required: - indicator - _common.aggregations:BucketCorrelationFunctionCountCorrelationIndicator: + _common.aggregations___BucketCorrelationFunctionCountCorrelationIndicator: type: object properties: doc_count: description: |- The total number of documents that initially created the expectations. It's required to be greater - than or equal to the sum of all values in the buckets_path as this is the originating superset of data + than or equal to the sum of all values in the `buckets_path` as this is the originating superset of data to which the term values are correlated. type: number expectations: @@ -32710,7 +34413,7 @@ components: fractions: description: |- An array of fractions to use when averaging and calculating variance. This should be used if - the pre-calculated data and the buckets_path have known gaps. The length of fractions, if provided, + the pre-calculated data and the `buckets_path` have known gaps. The length of fractions, if provided, must equal expectations. type: array items: @@ -32718,9 +34421,9 @@ components: required: - doc_count - expectations - _common.aggregations:BucketKsAggregation: + _common.aggregations___BucketKsAggregation: allOf: - - $ref: '#/components/schemas/_common.aggregations:BucketPathAggregation' + - $ref: '#/components/schemas/_common.aggregations___BucketPathAggregation' - type: object properties: alternative: @@ -32748,9 +34451,9 @@ components: `upper_tail`, which emphasizes the upper end of the CDF points. Valid options are: `upper_tail`, `uniform`, and `lower_tail`. type: string - _common.aggregations:BucketMetricValueAggregate: + _common.aggregations___BucketMetricValueAggregate: allOf: - - $ref: '#/components/schemas/_common.aggregations:SingleMetricAggregateBase' + - $ref: '#/components/schemas/_common.aggregations___SingleMetricAggregateBase' - type: object properties: keys: @@ -32759,213 +34462,213 @@ components: type: string required: - keys - _common.aggregations:BucketPathAggregation: + _common.aggregations___BucketPathAggregation: allOf: - - $ref: '#/components/schemas/_common.aggregations:Aggregation' + - $ref: '#/components/schemas/_common.aggregations___Aggregation' - type: object properties: buckets_path: - $ref: '#/components/schemas/_common.aggregations:BucketsPath' - _common.aggregations:BucketsAdjacencyMatrixBucket: + $ref: '#/components/schemas/_common.aggregations___BucketsPath' + _common.aggregations___BucketsAdjacencyMatrixBucket: description: |- Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for the different buckets, the result is a dictionary. oneOf: - type: object additionalProperties: - $ref: '#/components/schemas/_common.aggregations:AdjacencyMatrixBucket' + $ref: '#/components/schemas/_common.aggregations___AdjacencyMatrixBucket' - type: array items: - $ref: '#/components/schemas/_common.aggregations:AdjacencyMatrixBucket' - _common.aggregations:BucketsCompositeBucket: + $ref: '#/components/schemas/_common.aggregations___AdjacencyMatrixBucket' + _common.aggregations___BucketsCompositeBucket: description: |- Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for the different buckets, the result is a dictionary. oneOf: - type: object additionalProperties: - $ref: '#/components/schemas/_common.aggregations:CompositeBucket' + $ref: '#/components/schemas/_common.aggregations___CompositeBucket' - type: array items: - $ref: '#/components/schemas/_common.aggregations:CompositeBucket' - _common.aggregations:BucketScriptAggregation: + $ref: '#/components/schemas/_common.aggregations___CompositeBucket' + _common.aggregations___BucketScriptAggregation: allOf: - - $ref: '#/components/schemas/_common.aggregations:PipelineAggregationBase' + - $ref: '#/components/schemas/_common.aggregations___PipelineAggregationBase' - type: object properties: script: - $ref: '#/components/schemas/_common:Script' - _common.aggregations:BucketsDateHistogramBucket: + $ref: '#/components/schemas/_common___Script' + _common.aggregations___BucketsDateHistogramBucket: description: |- Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for the different buckets, the result is a dictionary. oneOf: - type: object additionalProperties: - $ref: '#/components/schemas/_common.aggregations:DateHistogramBucket' + $ref: '#/components/schemas/_common.aggregations___DateHistogramBucket' - type: array items: - $ref: '#/components/schemas/_common.aggregations:DateHistogramBucket' - _common.aggregations:BucketsDoubleTermsBucket: + $ref: '#/components/schemas/_common.aggregations___DateHistogramBucket' + _common.aggregations___BucketsDoubleTermsBucket: description: |- Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for the different buckets, the result is a dictionary. oneOf: - type: object additionalProperties: - $ref: '#/components/schemas/_common.aggregations:DoubleTermsBucket' + $ref: '#/components/schemas/_common.aggregations___DoubleTermsBucket' - type: array items: - $ref: '#/components/schemas/_common.aggregations:DoubleTermsBucket' - _common.aggregations:BucketSelectorAggregation: + $ref: '#/components/schemas/_common.aggregations___DoubleTermsBucket' + _common.aggregations___BucketSelectorAggregation: allOf: - - $ref: '#/components/schemas/_common.aggregations:PipelineAggregationBase' + - $ref: '#/components/schemas/_common.aggregations___PipelineAggregationBase' - type: object properties: script: - $ref: '#/components/schemas/_common:Script' - _common.aggregations:BucketsFiltersBucket: + $ref: '#/components/schemas/_common___Script' + _common.aggregations___BucketsFiltersBucket: description: |- Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for the different buckets, the result is a dictionary. oneOf: - type: object additionalProperties: - $ref: '#/components/schemas/_common.aggregations:FiltersBucket' + $ref: '#/components/schemas/_common.aggregations___FiltersBucket' - type: array items: - $ref: '#/components/schemas/_common.aggregations:FiltersBucket' - _common.aggregations:BucketsFrequentItemSetsBucket: + $ref: '#/components/schemas/_common.aggregations___FiltersBucket' + _common.aggregations___BucketsFrequentItemSetsBucket: description: |- Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for the different buckets, the result is a dictionary. oneOf: - type: object additionalProperties: - $ref: '#/components/schemas/_common.aggregations:FrequentItemSetsBucket' + $ref: '#/components/schemas/_common.aggregations___FrequentItemSetsBucket' - type: array items: - $ref: '#/components/schemas/_common.aggregations:FrequentItemSetsBucket' - _common.aggregations:BucketsGeoHashGridBucket: + $ref: '#/components/schemas/_common.aggregations___FrequentItemSetsBucket' + _common.aggregations___BucketsGeoHashGridBucket: description: |- Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for the different buckets, the result is a dictionary. oneOf: - type: object additionalProperties: - $ref: '#/components/schemas/_common.aggregations:GeoHashGridBucket' + $ref: '#/components/schemas/_common.aggregations___GeoHashGridBucket' - type: array items: - $ref: '#/components/schemas/_common.aggregations:GeoHashGridBucket' - _common.aggregations:BucketsGeoHexGridBucket: + $ref: '#/components/schemas/_common.aggregations___GeoHashGridBucket' + _common.aggregations___BucketsGeoHexGridBucket: description: |- Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for the different buckets, the result is a dictionary. oneOf: - type: object additionalProperties: - $ref: '#/components/schemas/_common.aggregations:GeoHexGridBucket' + $ref: '#/components/schemas/_common.aggregations___GeoHexGridBucket' - type: array items: - $ref: '#/components/schemas/_common.aggregations:GeoHexGridBucket' - _common.aggregations:BucketsGeoTileGridBucket: + $ref: '#/components/schemas/_common.aggregations___GeoHexGridBucket' + _common.aggregations___BucketsGeoTileGridBucket: description: |- Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for the different buckets, the result is a dictionary. oneOf: - type: object additionalProperties: - $ref: '#/components/schemas/_common.aggregations:GeoTileGridBucket' + $ref: '#/components/schemas/_common.aggregations___GeoTileGridBucket' - type: array items: - $ref: '#/components/schemas/_common.aggregations:GeoTileGridBucket' - _common.aggregations:BucketsHistogramBucket: + $ref: '#/components/schemas/_common.aggregations___GeoTileGridBucket' + _common.aggregations___BucketsHistogramBucket: description: |- Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for the different buckets, the result is a dictionary. oneOf: - type: object additionalProperties: - $ref: '#/components/schemas/_common.aggregations:HistogramBucket' + $ref: '#/components/schemas/_common.aggregations___HistogramBucket' - type: array items: - $ref: '#/components/schemas/_common.aggregations:HistogramBucket' - _common.aggregations:BucketsIpPrefixBucket: + $ref: '#/components/schemas/_common.aggregations___HistogramBucket' + _common.aggregations___BucketsIpPrefixBucket: description: |- Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for the different buckets, the result is a dictionary. oneOf: - type: object additionalProperties: - $ref: '#/components/schemas/_common.aggregations:IpPrefixBucket' + $ref: '#/components/schemas/_common.aggregations___IpPrefixBucket' - type: array items: - $ref: '#/components/schemas/_common.aggregations:IpPrefixBucket' - _common.aggregations:BucketsIpRangeBucket: + $ref: '#/components/schemas/_common.aggregations___IpPrefixBucket' + _common.aggregations___BucketsIpRangeBucket: description: |- Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for the different buckets, the result is a dictionary. oneOf: - type: object additionalProperties: - $ref: '#/components/schemas/_common.aggregations:IpRangeBucket' + $ref: '#/components/schemas/_common.aggregations___IpRangeBucket' - type: array items: - $ref: '#/components/schemas/_common.aggregations:IpRangeBucket' - _common.aggregations:BucketsLongRareTermsBucket: + $ref: '#/components/schemas/_common.aggregations___IpRangeBucket' + _common.aggregations___BucketsLongRareTermsBucket: description: |- Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for the different buckets, the result is a dictionary. oneOf: - type: object additionalProperties: - $ref: '#/components/schemas/_common.aggregations:LongRareTermsBucket' + $ref: '#/components/schemas/_common.aggregations___LongRareTermsBucket' - type: array items: - $ref: '#/components/schemas/_common.aggregations:LongRareTermsBucket' - _common.aggregations:BucketsLongTermsBucket: + $ref: '#/components/schemas/_common.aggregations___LongRareTermsBucket' + _common.aggregations___BucketsLongTermsBucket: description: |- Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for the different buckets, the result is a dictionary. oneOf: - type: object additionalProperties: - $ref: '#/components/schemas/_common.aggregations:LongTermsBucket' + $ref: '#/components/schemas/_common.aggregations___LongTermsBucket' - type: array items: - $ref: '#/components/schemas/_common.aggregations:LongTermsBucket' - _common.aggregations:BucketsMultiTermsBucket: + $ref: '#/components/schemas/_common.aggregations___LongTermsBucket' + _common.aggregations___BucketsMultiTermsBucket: description: |- Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for the different buckets, the result is a dictionary. oneOf: - type: object additionalProperties: - $ref: '#/components/schemas/_common.aggregations:MultiTermsBucket' + $ref: '#/components/schemas/_common.aggregations___MultiTermsBucket' - type: array items: - $ref: '#/components/schemas/_common.aggregations:MultiTermsBucket' - _common.aggregations:BucketSortAggregation: + $ref: '#/components/schemas/_common.aggregations___MultiTermsBucket' + _common.aggregations___BucketSortAggregation: allOf: - - $ref: '#/components/schemas/_common.aggregations:Aggregation' + - $ref: '#/components/schemas/_common.aggregations___Aggregation' - type: object properties: from: description: Buckets in positions prior to `from` will be truncated. type: number gap_policy: - $ref: '#/components/schemas/_common.aggregations:GapPolicy' + $ref: '#/components/schemas/_common.aggregations___GapPolicy' size: description: |- The number of buckets to return. Defaults to all buckets of the parent aggregation. type: number sort: - $ref: '#/components/schemas/_common:Sort' - _common.aggregations:BucketsPath: + $ref: '#/components/schemas/_common___Sort' + _common.aggregations___BucketsPath: description: |- Buckets path can be expressed in different ways, and an aggregation may accept some or all of these - forms depending on its type. Please refer to each aggregation's documentation to know what buckets + forms depending on its type. Refer to each aggregation's documentation to know what buckets path forms they accept. oneOf: - type: string @@ -32975,95 +34678,95 @@ components: - type: object additionalProperties: type: string - _common.aggregations:BucketsQueryContainer: + _common.aggregations___BucketsQueryContainer: description: |- Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for the different buckets, the result is a dictionary. oneOf: - type: object additionalProperties: - $ref: '#/components/schemas/_common.query_dsl:QueryContainer' + $ref: '#/components/schemas/_common.query_dsl___QueryContainer' - type: array items: - $ref: '#/components/schemas/_common.query_dsl:QueryContainer' - _common.aggregations:BucketsRangeBucket: + $ref: '#/components/schemas/_common.query_dsl___QueryContainer' + _common.aggregations___BucketsRangeBucket: description: |- Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for the different buckets, the result is a dictionary. oneOf: - type: object additionalProperties: - $ref: '#/components/schemas/_common.aggregations:RangeBucket' + $ref: '#/components/schemas/_common.aggregations___RangeBucket' - type: array items: - $ref: '#/components/schemas/_common.aggregations:RangeBucket' - _common.aggregations:BucketsSignificantLongTermsBucket: + $ref: '#/components/schemas/_common.aggregations___RangeBucket' + _common.aggregations___BucketsSignificantLongTermsBucket: description: |- Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for the different buckets, the result is a dictionary. oneOf: - type: object additionalProperties: - $ref: '#/components/schemas/_common.aggregations:SignificantLongTermsBucket' + $ref: '#/components/schemas/_common.aggregations___SignificantLongTermsBucket' - type: array items: - $ref: '#/components/schemas/_common.aggregations:SignificantLongTermsBucket' - _common.aggregations:BucketsSignificantStringTermsBucket: + $ref: '#/components/schemas/_common.aggregations___SignificantLongTermsBucket' + _common.aggregations___BucketsSignificantStringTermsBucket: description: |- Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for the different buckets, the result is a dictionary. oneOf: - type: object additionalProperties: - $ref: '#/components/schemas/_common.aggregations:SignificantStringTermsBucket' + $ref: '#/components/schemas/_common.aggregations___SignificantStringTermsBucket' - type: array items: - $ref: '#/components/schemas/_common.aggregations:SignificantStringTermsBucket' - _common.aggregations:BucketsStringRareTermsBucket: + $ref: '#/components/schemas/_common.aggregations___SignificantStringTermsBucket' + _common.aggregations___BucketsStringRareTermsBucket: description: |- Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for the different buckets, the result is a dictionary. oneOf: - type: object additionalProperties: - $ref: '#/components/schemas/_common.aggregations:StringRareTermsBucket' + $ref: '#/components/schemas/_common.aggregations___StringRareTermsBucket' - type: array items: - $ref: '#/components/schemas/_common.aggregations:StringRareTermsBucket' - _common.aggregations:BucketsStringTermsBucket: + $ref: '#/components/schemas/_common.aggregations___StringRareTermsBucket' + _common.aggregations___BucketsStringTermsBucket: description: |- Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for the different buckets, the result is a dictionary. oneOf: - type: object additionalProperties: - $ref: '#/components/schemas/_common.aggregations:StringTermsBucket' + $ref: '#/components/schemas/_common.aggregations___StringTermsBucket' - type: array items: - $ref: '#/components/schemas/_common.aggregations:StringTermsBucket' - _common.aggregations:BucketsVariableWidthHistogramBucket: + $ref: '#/components/schemas/_common.aggregations___StringTermsBucket' + _common.aggregations___BucketsVariableWidthHistogramBucket: description: |- Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for the different buckets, the result is a dictionary. oneOf: - type: object additionalProperties: - $ref: '#/components/schemas/_common.aggregations:VariableWidthHistogramBucket' + $ref: '#/components/schemas/_common.aggregations___VariableWidthHistogramBucket' - type: array items: - $ref: '#/components/schemas/_common.aggregations:VariableWidthHistogramBucket' - _common.aggregations:BucketsVoid: + $ref: '#/components/schemas/_common.aggregations___VariableWidthHistogramBucket' + _common.aggregations___BucketsVoid: description: |- Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for the different buckets, the result is a dictionary. oneOf: - type: object additionalProperties: - $ref: '#/components/schemas/_common:Void' + $ref: '#/components/schemas/_common___Void' - type: array items: - $ref: '#/components/schemas/_common:Void' - _common.aggregations:CalendarInterval: + $ref: '#/components/schemas/_common___Void' + _common.aggregations___CalendarInterval: type: string enum: - day @@ -33074,18 +34777,18 @@ components: - second - week - year - _common.aggregations:CardinalityAggregate: + _common.aggregations___CardinalityAggregate: allOf: - - $ref: '#/components/schemas/_common.aggregations:AggregateBase' + - $ref: '#/components/schemas/_common.aggregations___AggregateBase' - type: object properties: value: type: number required: - value - _common.aggregations:CardinalityAggregation: + _common.aggregations___CardinalityAggregation: allOf: - - $ref: '#/components/schemas/_common.aggregations:MetricAggregationBase' + - $ref: '#/components/schemas/_common.aggregations___MetricAggregationBase' - type: object properties: precision_threshold: @@ -33096,8 +34799,8 @@ components: rehash: type: boolean execution_hint: - $ref: '#/components/schemas/_common.aggregations:CardinalityExecutionMode' - _common.aggregations:CardinalityExecutionMode: + $ref: '#/components/schemas/_common.aggregations___CardinalityExecutionMode' + _common.aggregations___CardinalityExecutionMode: type: string enum: - direct @@ -33105,16 +34808,16 @@ components: - save_memory_heuristic - save_time_heuristic - segment_ordinals - _common.aggregations:CategorizeTextAggregation: + _common.aggregations___CategorizeTextAggregation: allOf: - - $ref: '#/components/schemas/_common.aggregations:Aggregation' + - $ref: '#/components/schemas/_common.aggregations___Aggregation' - type: object properties: field: - $ref: '#/components/schemas/_common:Field' + $ref: '#/components/schemas/_common___Field' max_unique_tokens: description: |- - The maximum number of unique tokens at any position up to max_matched_tokens. Must be larger than 1. + The maximum number of unique tokens at any position up to `max_matched_tokensg`. Must be larger than 1. Smaller values use less memory and create fewer categories. Larger values will use more memory and create narrower categories. Max allowed value is 100. type: number @@ -33134,15 +34837,15 @@ components: This property expects an array of regular expressions. The expressions are used to filter out matching sequences from the categorization field values. You can use this functionality to fine tune the categorization by excluding sequences from consideration when categories are defined. For example, you can exclude SQL - statements that appear in your log files. This property cannot be used at the same time as categorization_analyzer. + statements that appear in your log files. This property cannot be used at the same time as `categorization_analyzer`. If you only want to define simple regular expression filters that are applied prior to tokenization, setting this property is the easiest method. If you also want to customize the tokenizer or post-tokenization filtering, - use the categorization_analyzer property instead and include the filters as pattern_replace character filters. + use the `categorization_analyzer` property instead and include the filters as `pattern_replace` character filters. type: array items: type: string categorization_analyzer: - $ref: '#/components/schemas/_common.aggregations:CategorizeTextAnalyzer' + $ref: '#/components/schemas/_common.aggregations___CategorizeTextAnalyzer' shard_size: description: The number of categorization buckets to return from each shard before merging all the results. type: number @@ -33157,22 +34860,22 @@ components: type: number required: - field - _common.aggregations:CategorizeTextAnalyzer: + _common.aggregations___CategorizeTextAnalyzer: oneOf: - type: string - - $ref: '#/components/schemas/_common.aggregations:CustomCategorizeTextAnalyzer' - _common.aggregations:ChildrenAggregate: + - $ref: '#/components/schemas/_common.aggregations___CustomCategorizeTextAnalyzer' + _common.aggregations___ChildrenAggregate: allOf: - - $ref: '#/components/schemas/_common.aggregations:SingleBucketAggregateBase' + - $ref: '#/components/schemas/_common.aggregations___SingleBucketAggregateBase' - type: object - _common.aggregations:ChildrenAggregation: + _common.aggregations___ChildrenAggregation: allOf: - - $ref: '#/components/schemas/_common.aggregations:BucketAggregationBase' + - $ref: '#/components/schemas/_common.aggregations___BucketAggregationBase' - type: object properties: type: - $ref: '#/components/schemas/_common:RelationName' - _common.aggregations:ChiSquareHeuristic: + $ref: '#/components/schemas/_common___RelationName' + _common.aggregations___ChiSquareHeuristic: type: object properties: background_is_superset: @@ -33184,7 +34887,7 @@ components: required: - background_is_superset - include_negatives - _common.aggregations:ClassificationInferenceOptions: + _common.aggregations___ClassificationInferenceOptions: type: object properties: num_top_classes: @@ -33194,32 +34897,32 @@ components: description: Specifies the maximum number of feature importance values per document. type: number prediction_field_type: - description: 'Specifies the type of the predicted field to write. Acceptable values are: string, number, boolean. When boolean is provided 1.0 is transformed to true and 0.0 to false.' + description: 'Specifies the type of the predicted field to write. Acceptable values are: string, number, Boolean. When Boolean is provided 1.0 is transformed to true and 0.0 to false.' type: string results_field: - description: The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + description: The field that is added to incoming documents to contain the inference prediction. Defaults to `predicted_value`. type: string top_classes_results_field: - description: Specifies the field to which the top classes are written. Defaults to top_classes. + description: Specifies the field to which the top classes are written. Defaults to `top_classes`. type: string - _common.aggregations:CompositeAggregate: + _common.aggregations___CompositeAggregate: allOf: - - $ref: '#/components/schemas/_common.aggregations:MultiBucketAggregateBaseCompositeBucket' + - $ref: '#/components/schemas/_common.aggregations___MultiBucketAggregateBaseCompositeBucket' - type: object properties: after_key: - $ref: '#/components/schemas/_common.aggregations:CompositeAggregateKey' - _common.aggregations:CompositeAggregateKey: + $ref: '#/components/schemas/_common.aggregations___CompositeAggregateKey' + _common.aggregations___CompositeAggregateKey: type: object additionalProperties: - $ref: '#/components/schemas/_common:FieldValue' - _common.aggregations:CompositeAggregation: + $ref: '#/components/schemas/_common___FieldValue' + _common.aggregations___CompositeAggregation: allOf: - - $ref: '#/components/schemas/_common.aggregations:BucketAggregationBase' + - $ref: '#/components/schemas/_common.aggregations___BucketAggregationBase' - type: object properties: after: - $ref: '#/components/schemas/_common.aggregations:CompositeAggregateKey' + $ref: '#/components/schemas/_common.aggregations___CompositeAggregateKey' size: description: The number of composite buckets that should be returned. type: number @@ -33231,82 +34934,82 @@ components: items: type: object additionalProperties: - $ref: '#/components/schemas/_common.aggregations:CompositeAggregationSource' - _common.aggregations:CompositeAggregationBase: + $ref: '#/components/schemas/_common.aggregations___CompositeAggregationSource' + _common.aggregations___CompositeAggregationBase: type: object properties: field: - $ref: '#/components/schemas/_common:Field' + $ref: '#/components/schemas/_common___Field' missing_bucket: type: boolean missing_order: - $ref: '#/components/schemas/_common.aggregations:MissingOrder' + $ref: '#/components/schemas/_common.aggregations___MissingOrder' script: - $ref: '#/components/schemas/_common:Script' + $ref: '#/components/schemas/_common___Script' value_type: - $ref: '#/components/schemas/_common.aggregations:ValueType' + $ref: '#/components/schemas/_common.aggregations___ValueType' order: - $ref: '#/components/schemas/_common:SortOrder' - _common.aggregations:CompositeAggregationSource: + $ref: '#/components/schemas/_common___SortOrder' + _common.aggregations___CompositeAggregationSource: type: object properties: terms: - $ref: '#/components/schemas/_common.aggregations:CompositeTermsAggregation' + $ref: '#/components/schemas/_common.aggregations___CompositeTermsAggregation' histogram: - $ref: '#/components/schemas/_common.aggregations:CompositeHistogramAggregation' + $ref: '#/components/schemas/_common.aggregations___CompositeHistogramAggregation' date_histogram: - $ref: '#/components/schemas/_common.aggregations:CompositeDateHistogramAggregation' + $ref: '#/components/schemas/_common.aggregations___CompositeDateHistogramAggregation' geotile_grid: - $ref: '#/components/schemas/_common.aggregations:CompositeGeoTileGridAggregation' - _common.aggregations:CompositeBucket: + $ref: '#/components/schemas/_common.aggregations___CompositeGeoTileGridAggregation' + _common.aggregations___CompositeBucket: allOf: - - $ref: '#/components/schemas/_common.aggregations:MultiBucketBase' + - $ref: '#/components/schemas/_common.aggregations___MultiBucketBase' - type: object properties: key: - $ref: '#/components/schemas/_common.aggregations:CompositeAggregateKey' + $ref: '#/components/schemas/_common.aggregations___CompositeAggregateKey' required: - key - _common.aggregations:CompositeDateHistogramAggregation: + _common.aggregations___CompositeDateHistogramAggregation: allOf: - - $ref: '#/components/schemas/_common.aggregations:CompositeAggregationBase' + - $ref: '#/components/schemas/_common.aggregations___CompositeAggregationBase' - type: object properties: format: type: string calendar_interval: - $ref: '#/components/schemas/_common:DurationLarge' + $ref: '#/components/schemas/_common___DurationLarge' fixed_interval: - $ref: '#/components/schemas/_common:DurationLarge' + $ref: '#/components/schemas/_common___DurationLarge' offset: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' time_zone: - $ref: '#/components/schemas/_common:TimeZone' - _common.aggregations:CompositeGeoTileGridAggregation: + $ref: '#/components/schemas/_common___TimeZone' + _common.aggregations___CompositeGeoTileGridAggregation: allOf: - - $ref: '#/components/schemas/_common.aggregations:CompositeAggregationBase' + - $ref: '#/components/schemas/_common.aggregations___CompositeAggregationBase' - type: object properties: precision: type: number bounds: - $ref: '#/components/schemas/_common:GeoBounds' - _common.aggregations:CompositeHistogramAggregation: + $ref: '#/components/schemas/_common___GeoBounds' + _common.aggregations___CompositeHistogramAggregation: allOf: - - $ref: '#/components/schemas/_common.aggregations:CompositeAggregationBase' + - $ref: '#/components/schemas/_common.aggregations___CompositeAggregationBase' - type: object properties: interval: type: number required: - interval - _common.aggregations:CompositeTermsAggregation: + _common.aggregations___CompositeTermsAggregation: allOf: - - $ref: '#/components/schemas/_common.aggregations:CompositeAggregationBase' + - $ref: '#/components/schemas/_common.aggregations___CompositeAggregationBase' - type: object - _common.aggregations:CumulativeCardinalityAggregate: + _common.aggregations___CumulativeCardinalityAggregate: allOf: - - $ref: '#/components/schemas/_common.aggregations:AggregateBase' + - $ref: '#/components/schemas/_common.aggregations___AggregateBase' - type: object properties: value: @@ -33315,15 +35018,15 @@ components: type: string required: - value - _common.aggregations:CumulativeCardinalityAggregation: + _common.aggregations___CumulativeCardinalityAggregation: allOf: - - $ref: '#/components/schemas/_common.aggregations:PipelineAggregationBase' + - $ref: '#/components/schemas/_common.aggregations___PipelineAggregationBase' - type: object - _common.aggregations:CumulativeSumAggregation: + _common.aggregations___CumulativeSumAggregation: allOf: - - $ref: '#/components/schemas/_common.aggregations:PipelineAggregationBase' + - $ref: '#/components/schemas/_common.aggregations___PipelineAggregationBase' - type: object - _common.aggregations:CustomCategorizeTextAnalyzer: + _common.aggregations___CustomCategorizeTextAnalyzer: type: object properties: char_filter: @@ -33336,138 +35039,138 @@ components: type: array items: type: string - _common.aggregations:DateHistogramAggregate: + _common.aggregations___DateHistogramAggregate: allOf: - - $ref: '#/components/schemas/_common.aggregations:MultiBucketAggregateBaseDateHistogramBucket' + - $ref: '#/components/schemas/_common.aggregations___MultiBucketAggregateBaseDateHistogramBucket' - type: object - _common.aggregations:DateHistogramAggregation: + _common.aggregations___DateHistogramAggregation: allOf: - - $ref: '#/components/schemas/_common.aggregations:BucketAggregationBase' + - $ref: '#/components/schemas/_common.aggregations___BucketAggregationBase' - type: object properties: calendar_interval: - $ref: '#/components/schemas/_common.aggregations:CalendarInterval' + $ref: '#/components/schemas/_common.aggregations___CalendarInterval' extended_bounds: - $ref: '#/components/schemas/_common.aggregations:ExtendedBoundsFieldDateMath' + $ref: '#/components/schemas/_common.aggregations___ExtendedBoundsFieldDateMath' hard_bounds: - $ref: '#/components/schemas/_common.aggregations:ExtendedBoundsFieldDateMath' + $ref: '#/components/schemas/_common.aggregations___ExtendedBoundsFieldDateMath' field: - $ref: '#/components/schemas/_common:Field' + $ref: '#/components/schemas/_common___Field' fixed_interval: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' format: description: |- The date format used to format `key_as_string` in the response. If no `format` is specified, the first date format specified in the field mapping is used. type: string interval: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' min_doc_count: description: |- Only returns buckets that have `min_doc_count` number of documents. By default, all buckets between the first bucket that matches documents and the last one are returned. type: number missing: - $ref: '#/components/schemas/_common:DateTime' + $ref: '#/components/schemas/_common___DateTime' offset: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' order: - $ref: '#/components/schemas/_common.aggregations:AggregateOrder' + $ref: '#/components/schemas/_common.aggregations___AggregateOrder' params: type: object additionalProperties: type: object script: - $ref: '#/components/schemas/_common:Script' + $ref: '#/components/schemas/_common___Script' time_zone: - $ref: '#/components/schemas/_common:TimeZone' + $ref: '#/components/schemas/_common___TimeZone' keyed: description: Set to `true` to associate a unique string key with each bucket and return the ranges as a hash rather than an array. type: boolean - _common.aggregations:DateHistogramBucket: + _common.aggregations___DateHistogramBucket: allOf: - - $ref: '#/components/schemas/_common.aggregations:MultiBucketBase' + - $ref: '#/components/schemas/_common.aggregations___MultiBucketBase' - type: object properties: key_as_string: type: string key: - $ref: '#/components/schemas/_common:EpochTimeUnitMillis' + $ref: '#/components/schemas/_common___EpochTimeUnitMillis' required: - key - _common.aggregations:DateRangeAggregate: + _common.aggregations___DateRangeAggregate: allOf: - - $ref: '#/components/schemas/_common.aggregations:RangeAggregate' + - $ref: '#/components/schemas/_common.aggregations___RangeAggregate' - type: object - _common.aggregations:DateRangeAggregation: + _common.aggregations___DateRangeAggregation: allOf: - - $ref: '#/components/schemas/_common.aggregations:BucketAggregationBase' + - $ref: '#/components/schemas/_common.aggregations___BucketAggregationBase' - type: object properties: field: - $ref: '#/components/schemas/_common:Field' + $ref: '#/components/schemas/_common___Field' format: description: The date format used to format `from` and `to` in the response. type: string missing: - $ref: '#/components/schemas/_common.aggregations:Missing' + $ref: '#/components/schemas/_common.aggregations___Missing' ranges: description: Array of date ranges. type: array items: - $ref: '#/components/schemas/_common.aggregations:DateRangeExpression' + $ref: '#/components/schemas/_common.aggregations___DateRangeExpression' time_zone: - $ref: '#/components/schemas/_common:TimeZone' + $ref: '#/components/schemas/_common___TimeZone' keyed: description: Set to `true` to associate a unique string key with each bucket and returns the ranges as a hash rather than an array. type: boolean - _common.aggregations:DateRangeExpression: + _common.aggregations___DateRangeExpression: type: object properties: from: - $ref: '#/components/schemas/_common.aggregations:FieldDateMath' + $ref: '#/components/schemas/_common.aggregations___FieldDateMath' key: description: Custom key to return the range with. type: string to: - $ref: '#/components/schemas/_common.aggregations:FieldDateMath' - _common.aggregations:DerivativeAggregate: + $ref: '#/components/schemas/_common.aggregations___FieldDateMath' + _common.aggregations___DerivativeAggregate: allOf: - - $ref: '#/components/schemas/_common.aggregations:SingleMetricAggregateBase' + - $ref: '#/components/schemas/_common.aggregations___SingleMetricAggregateBase' - type: object properties: normalized_value: type: number normalized_value_as_string: type: string - _common.aggregations:DerivativeAggregation: + _common.aggregations___DerivativeAggregation: allOf: - - $ref: '#/components/schemas/_common.aggregations:PipelineAggregationBase' + - $ref: '#/components/schemas/_common.aggregations___PipelineAggregationBase' - type: object - _common.aggregations:DiversifiedSamplerAggregation: + _common.aggregations___DiversifiedSamplerAggregation: allOf: - - $ref: '#/components/schemas/_common.aggregations:BucketAggregationBase' + - $ref: '#/components/schemas/_common.aggregations___BucketAggregationBase' - type: object properties: execution_hint: - $ref: '#/components/schemas/_common.aggregations:SamplerAggregationExecutionHint' + $ref: '#/components/schemas/_common.aggregations___SamplerAggregationExecutionHint' max_docs_per_value: description: Limits how many documents are permitted per choice of de-duplicating value. type: number script: - $ref: '#/components/schemas/_common:Script' + $ref: '#/components/schemas/_common___Script' shard_size: description: Limits how many top-scoring documents are collected in the sample processed on each shard. type: number field: - $ref: '#/components/schemas/_common:Field' - _common.aggregations:DoubleTermsAggregate: + $ref: '#/components/schemas/_common___Field' + _common.aggregations___DoubleTermsAggregate: allOf: - - $ref: '#/components/schemas/_common.aggregations:TermsAggregateBaseDoubleTermsBucket' + - $ref: '#/components/schemas/_common.aggregations___TermsAggregateBaseDoubleTermsBucket' - type: object - _common.aggregations:DoubleTermsBucket: + _common.aggregations___DoubleTermsBucket: allOf: - - $ref: '#/components/schemas/_common.aggregations:TermsBucketBase' + - $ref: '#/components/schemas/_common.aggregations___TermsBucketBase' - type: object properties: key: @@ -33476,14 +35179,14 @@ components: type: string required: - key - _common.aggregations:EwmaModelSettings: + _common.aggregations___EwmaModelSettings: type: object properties: alpha: type: number - _common.aggregations:EwmaMovingAverageAggregation: + _common.aggregations___EwmaMovingAverageAggregation: allOf: - - $ref: '#/components/schemas/_common.aggregations:MovingAverageAggregationBase' + - $ref: '#/components/schemas/_common.aggregations___MovingAverageAggregationBase' - type: object properties: model: @@ -33491,11 +35194,11 @@ components: enum: - ewma settings: - $ref: '#/components/schemas/_common.aggregations:EwmaModelSettings' + $ref: '#/components/schemas/_common.aggregations___EwmaModelSettings' required: - model - settings - _common.aggregations:ExtendedBoundsdouble: + _common.aggregations___ExtendedBoundsdouble: type: object properties: max: @@ -33507,19 +35210,19 @@ components: required: - max - min - _common.aggregations:ExtendedBoundsFieldDateMath: + _common.aggregations___ExtendedBoundsFieldDateMath: type: object properties: max: - $ref: '#/components/schemas/_common.aggregations:FieldDateMath' + $ref: '#/components/schemas/_common.aggregations___FieldDateMath' min: - $ref: '#/components/schemas/_common.aggregations:FieldDateMath' + $ref: '#/components/schemas/_common.aggregations___FieldDateMath' required: - max - min - _common.aggregations:ExtendedStatsAggregate: + _common.aggregations___ExtendedStatsAggregate: allOf: - - $ref: '#/components/schemas/_common.aggregations:StatsAggregate' + - $ref: '#/components/schemas/_common.aggregations___StatsAggregate' - type: object properties: sum_of_squares: @@ -33558,7 +35261,7 @@ components: - number - string std_deviation_bounds: - $ref: '#/components/schemas/_common.aggregations:StandardDeviationBounds' + $ref: '#/components/schemas/_common.aggregations___StandardDeviationBounds' sum_of_squares_as_string: type: string variance_as_string: @@ -33570,7 +35273,7 @@ components: std_deviation_as_string: type: string std_deviation_bounds_as_string: - $ref: '#/components/schemas/_common.aggregations:StandardDeviationBoundsAsString' + $ref: '#/components/schemas/_common.aggregations___StandardDeviationBoundsAsString' required: - std_deviation - std_deviation_population @@ -33579,48 +35282,48 @@ components: - variance - variance_population - variance_sampling - _common.aggregations:ExtendedStatsAggregation: + _common.aggregations___ExtendedStatsAggregation: allOf: - - $ref: '#/components/schemas/_common.aggregations:FormatMetricAggregationBase' + - $ref: '#/components/schemas/_common.aggregations___FormatMetricAggregationBase' - type: object properties: sigma: description: The number of standard deviations above/below the mean to display. type: number - _common.aggregations:ExtendedStatsBucketAggregate: + _common.aggregations___ExtendedStatsBucketAggregate: allOf: - - $ref: '#/components/schemas/_common.aggregations:ExtendedStatsAggregate' + - $ref: '#/components/schemas/_common.aggregations___ExtendedStatsAggregate' - type: object - _common.aggregations:ExtendedStatsBucketAggregation: + _common.aggregations___ExtendedStatsBucketAggregation: allOf: - - $ref: '#/components/schemas/_common.aggregations:PipelineAggregationBase' + - $ref: '#/components/schemas/_common.aggregations___PipelineAggregationBase' - type: object properties: sigma: description: The number of standard deviations above/below the mean to display. type: number - _common.aggregations:FieldDateMath: + _common.aggregations___FieldDateMath: description: |- A date range limit, represented either as a DateMath expression or a number expressed according to the target field's precision. oneOf: - - $ref: '#/components/schemas/_common:DateMath' + - $ref: '#/components/schemas/_common___DateMath' - type: number - _common.aggregations:FilterAggregate: + _common.aggregations___FilterAggregate: allOf: - - $ref: '#/components/schemas/_common.aggregations:SingleBucketAggregateBase' + - $ref: '#/components/schemas/_common.aggregations___SingleBucketAggregateBase' - type: object - _common.aggregations:FiltersAggregate: + _common.aggregations___FiltersAggregate: allOf: - - $ref: '#/components/schemas/_common.aggregations:MultiBucketAggregateBaseFiltersBucket' + - $ref: '#/components/schemas/_common.aggregations___MultiBucketAggregateBaseFiltersBucket' - type: object - _common.aggregations:FiltersAggregation: + _common.aggregations___FiltersAggregation: allOf: - - $ref: '#/components/schemas/_common.aggregations:BucketAggregationBase' + - $ref: '#/components/schemas/_common.aggregations___BucketAggregationBase' - type: object properties: filters: - $ref: '#/components/schemas/_common.aggregations:BucketsQueryContainer' + $ref: '#/components/schemas/_common.aggregations___BucketsQueryContainer' other_bucket: description: Set to `true` to add a bucket to the response which will contain all documents that do not match any of the given filters. type: boolean @@ -33632,36 +35335,36 @@ components: By default, the named filters aggregation returns the buckets as an object. Set to `false` to return the buckets as an array of objects. type: boolean - _common.aggregations:FiltersBucket: + _common.aggregations___FiltersBucket: allOf: - - $ref: '#/components/schemas/_common.aggregations:MultiBucketBase' + - $ref: '#/components/schemas/_common.aggregations___MultiBucketBase' - type: object - _common.aggregations:FormatMetricAggregationBase: + _common.aggregations___FormatMetricAggregationBase: allOf: - - $ref: '#/components/schemas/_common.aggregations:MetricAggregationBase' + - $ref: '#/components/schemas/_common.aggregations___MetricAggregationBase' - type: object properties: format: type: string - _common.aggregations:FormattableMetricAggregation: + _common.aggregations___FormattableMetricAggregation: allOf: - - $ref: '#/components/schemas/_common.aggregations:MetricAggregationBase' + - $ref: '#/components/schemas/_common.aggregations___MetricAggregationBase' - type: object properties: format: type: string - _common.aggregations:FrequentItemSetsAggregate: + _common.aggregations___FrequentItemSetsAggregate: allOf: - - $ref: '#/components/schemas/_common.aggregations:MultiBucketAggregateBaseFrequentItemSetsBucket' + - $ref: '#/components/schemas/_common.aggregations___MultiBucketAggregateBaseFrequentItemSetsBucket' - type: object - _common.aggregations:FrequentItemSetsAggregation: + _common.aggregations___FrequentItemSetsAggregation: type: object properties: fields: description: Fields to analyze. type: array items: - $ref: '#/components/schemas/_common.aggregations:FrequentItemSetsField' + $ref: '#/components/schemas/_common.aggregations___FrequentItemSetsField' minimum_set_size: description: The minimum size of one item set. type: number @@ -33672,12 +35375,12 @@ components: description: The number of top item sets to return. type: number filter: - $ref: '#/components/schemas/_common.query_dsl:QueryContainer' + $ref: '#/components/schemas/_common.query_dsl___QueryContainer' required: - fields - _common.aggregations:FrequentItemSetsBucket: + _common.aggregations___FrequentItemSetsBucket: allOf: - - $ref: '#/components/schemas/_common.aggregations:MultiBucketBase' + - $ref: '#/components/schemas/_common.aggregations___MultiBucketBase' - type: object properties: key: @@ -33691,95 +35394,95 @@ components: required: - key - support - _common.aggregations:FrequentItemSetsField: + _common.aggregations___FrequentItemSetsField: type: object properties: field: - $ref: '#/components/schemas/_common:Field' + $ref: '#/components/schemas/_common___Field' exclude: - $ref: '#/components/schemas/_common.aggregations:TermsExclude' + $ref: '#/components/schemas/_common.aggregations___TermsExclude' include: - $ref: '#/components/schemas/_common.aggregations:TermsInclude' + $ref: '#/components/schemas/_common.aggregations___TermsInclude' required: - field - _common.aggregations:GapPolicy: + _common.aggregations___GapPolicy: type: string enum: - insert_zeros - keep_values - skip - _common.aggregations:GeoBoundsAggregate: + _common.aggregations___GeoBoundsAggregate: allOf: - - $ref: '#/components/schemas/_common.aggregations:AggregateBase' + - $ref: '#/components/schemas/_common.aggregations___AggregateBase' - type: object properties: bounds: - $ref: '#/components/schemas/_common:GeoBounds' - _common.aggregations:GeoBoundsAggregation: + $ref: '#/components/schemas/_common___GeoBounds' + _common.aggregations___GeoBoundsAggregation: allOf: - - $ref: '#/components/schemas/_common.aggregations:MetricAggregationBase' + - $ref: '#/components/schemas/_common.aggregations___MetricAggregationBase' - type: object properties: wrap_longitude: description: Specifies whether the bounding box should be allowed to overlap the international date line. type: boolean - _common.aggregations:GeoCentroidAggregate: + _common.aggregations___GeoCentroidAggregate: allOf: - - $ref: '#/components/schemas/_common.aggregations:AggregateBase' + - $ref: '#/components/schemas/_common.aggregations___AggregateBase' - type: object properties: count: type: number location: - $ref: '#/components/schemas/_common:GeoLocation' + $ref: '#/components/schemas/_common___GeoLocation' required: - count - _common.aggregations:GeoCentroidAggregation: + _common.aggregations___GeoCentroidAggregation: allOf: - - $ref: '#/components/schemas/_common.aggregations:MetricAggregationBase' + - $ref: '#/components/schemas/_common.aggregations___MetricAggregationBase' - type: object properties: count: type: number location: - $ref: '#/components/schemas/_common:GeoLocation' - _common.aggregations:GeoDistanceAggregate: + $ref: '#/components/schemas/_common___GeoLocation' + _common.aggregations___GeoDistanceAggregate: allOf: - - $ref: '#/components/schemas/_common.aggregations:RangeAggregate' + - $ref: '#/components/schemas/_common.aggregations___RangeAggregate' - type: object - _common.aggregations:GeoDistanceAggregation: + _common.aggregations___GeoDistanceAggregation: allOf: - - $ref: '#/components/schemas/_common.aggregations:BucketAggregationBase' + - $ref: '#/components/schemas/_common.aggregations___BucketAggregationBase' - type: object properties: distance_type: - $ref: '#/components/schemas/_common:GeoDistanceType' + $ref: '#/components/schemas/_common___GeoDistanceType' field: - $ref: '#/components/schemas/_common:Field' + $ref: '#/components/schemas/_common___Field' origin: - $ref: '#/components/schemas/_common:GeoLocation' + $ref: '#/components/schemas/_common___GeoLocation' ranges: description: An array of ranges used to bucket documents. type: array items: - $ref: '#/components/schemas/_common.aggregations:AggregationRange' + $ref: '#/components/schemas/_common.aggregations___AggregationRange' unit: - $ref: '#/components/schemas/_common:DistanceUnit' - _common.aggregations:GeoHashGridAggregate: + $ref: '#/components/schemas/_common___DistanceUnit' + _common.aggregations___GeoHashGridAggregate: allOf: - - $ref: '#/components/schemas/_common.aggregations:MultiBucketAggregateBaseGeoHashGridBucket' + - $ref: '#/components/schemas/_common.aggregations___MultiBucketAggregateBaseGeoHashGridBucket' - type: object - _common.aggregations:GeoHashGridAggregation: + _common.aggregations___GeoHashGridAggregation: allOf: - - $ref: '#/components/schemas/_common.aggregations:BucketAggregationBase' + - $ref: '#/components/schemas/_common.aggregations___BucketAggregationBase' - type: object properties: bounds: - $ref: '#/components/schemas/_common:GeoBounds' + $ref: '#/components/schemas/_common___GeoBounds' field: - $ref: '#/components/schemas/_common:Field' + $ref: '#/components/schemas/_common___Field' precision: - $ref: '#/components/schemas/_common:GeoHashPrecision' + $ref: '#/components/schemas/_common___GeoHashPrecision' shard_size: description: |- Allows for more accurate counting of the top cells returned in the final result the aggregation. @@ -33788,33 +35491,33 @@ components: size: description: The maximum number of geohash buckets to return. type: number - _common.aggregations:GeoHashGridBucket: + _common.aggregations___GeoHashGridBucket: allOf: - - $ref: '#/components/schemas/_common.aggregations:MultiBucketBase' + - $ref: '#/components/schemas/_common.aggregations___MultiBucketBase' - type: object properties: key: - $ref: '#/components/schemas/_common:GeoHash' + $ref: '#/components/schemas/_common___GeoHash' required: - key - _common.aggregations:GeoHexGridAggregate: + _common.aggregations___GeoHexGridAggregate: allOf: - - $ref: '#/components/schemas/_common.aggregations:MultiBucketAggregateBaseGeoHexGridBucket' + - $ref: '#/components/schemas/_common.aggregations___MultiBucketAggregateBaseGeoHexGridBucket' - type: object - _common.aggregations:GeohexGridAggregation: + _common.aggregations___GeohexGridAggregation: allOf: - - $ref: '#/components/schemas/_common.aggregations:BucketAggregationBase' + - $ref: '#/components/schemas/_common.aggregations___BucketAggregationBase' - type: object properties: field: - $ref: '#/components/schemas/_common:Field' + $ref: '#/components/schemas/_common___Field' precision: description: |- Integer zoom of the key used to defined cells or buckets - in the results. Value should be between 0-15. + in the results. Value should be between 0 and 15. type: number bounds: - $ref: '#/components/schemas/_common:GeoBounds' + $ref: '#/components/schemas/_common___GeoBounds' size: description: Maximum number of buckets to return. type: number @@ -33823,42 +35526,42 @@ components: type: number required: - field - _common.aggregations:GeoHexGridBucket: + _common.aggregations___GeoHexGridBucket: allOf: - - $ref: '#/components/schemas/_common.aggregations:MultiBucketBase' + - $ref: '#/components/schemas/_common.aggregations___MultiBucketBase' - type: object properties: key: - $ref: '#/components/schemas/_common:GeoHexCell' + $ref: '#/components/schemas/_common___GeoHexCell' required: - key - _common.aggregations:GeoLineAggregate: + _common.aggregations___GeoLineAggregate: allOf: - - $ref: '#/components/schemas/_common.aggregations:AggregateBase' + - $ref: '#/components/schemas/_common.aggregations___AggregateBase' - type: object properties: type: type: string geometry: - $ref: '#/components/schemas/_common:GeoLine' + $ref: '#/components/schemas/_common___GeoLine' properties: type: object required: - geometry - properties - type - _common.aggregations:GeoLineAggregation: + _common.aggregations___GeoLineAggregation: type: object properties: point: - $ref: '#/components/schemas/_common.aggregations:GeoLinePoint' + $ref: '#/components/schemas/_common.aggregations___GeoLinePoint' sort: - $ref: '#/components/schemas/_common.aggregations:GeoLineSort' + $ref: '#/components/schemas/_common.aggregations___GeoLineSort' include_sort: description: When `true`, returns an additional array of the sort values in the feature properties. type: boolean sort_order: - $ref: '#/components/schemas/_common:SortOrder' + $ref: '#/components/schemas/_common___SortOrder' size: description: |- The maximum length of the line represented in the aggregation. @@ -33867,33 +35570,33 @@ components: required: - point - sort - _common.aggregations:GeoLinePoint: + _common.aggregations___GeoLinePoint: type: object properties: field: - $ref: '#/components/schemas/_common:Field' + $ref: '#/components/schemas/_common___Field' required: - field - _common.aggregations:GeoLineSort: + _common.aggregations___GeoLineSort: type: object properties: field: - $ref: '#/components/schemas/_common:Field' + $ref: '#/components/schemas/_common___Field' required: - field - _common.aggregations:GeoTileGridAggregate: + _common.aggregations___GeoTileGridAggregate: allOf: - - $ref: '#/components/schemas/_common.aggregations:MultiBucketAggregateBaseGeoTileGridBucket' + - $ref: '#/components/schemas/_common.aggregations___MultiBucketAggregateBaseGeoTileGridBucket' - type: object - _common.aggregations:GeoTileGridAggregation: + _common.aggregations___GeoTileGridAggregation: allOf: - - $ref: '#/components/schemas/_common.aggregations:BucketAggregationBase' + - $ref: '#/components/schemas/_common.aggregations___BucketAggregationBase' - type: object properties: field: - $ref: '#/components/schemas/_common:Field' + $ref: '#/components/schemas/_common___Field' precision: - $ref: '#/components/schemas/_common:GeoTilePrecision' + $ref: '#/components/schemas/_common___GeoTilePrecision' shard_size: description: |- Allows for more accurate counting of the top cells returned in the final result the aggregation. @@ -33903,59 +35606,59 @@ components: description: The maximum number of buckets to return. type: number bounds: - $ref: '#/components/schemas/_common:GeoBounds' - _common.aggregations:GeoTileGridBucket: + $ref: '#/components/schemas/_common___GeoBounds' + _common.aggregations___GeoTileGridBucket: allOf: - - $ref: '#/components/schemas/_common.aggregations:MultiBucketBase' + - $ref: '#/components/schemas/_common.aggregations___MultiBucketBase' - type: object properties: key: - $ref: '#/components/schemas/_common:GeoTile' + $ref: '#/components/schemas/_common___GeoTile' required: - key - _common.aggregations:GlobalAggregate: + _common.aggregations___GlobalAggregate: allOf: - - $ref: '#/components/schemas/_common.aggregations:SingleBucketAggregateBase' + - $ref: '#/components/schemas/_common.aggregations___SingleBucketAggregateBase' - type: object - _common.aggregations:GlobalAggregation: + _common.aggregations___GlobalAggregation: allOf: - - $ref: '#/components/schemas/_common.aggregations:BucketAggregationBase' + - $ref: '#/components/schemas/_common.aggregations___BucketAggregationBase' - type: object - _common.aggregations:GoogleNormalizedDistanceHeuristic: + _common.aggregations___GoogleNormalizedDistanceHeuristic: type: object properties: background_is_superset: description: Set to `false` if you defined a custom background filter that represents a different set of documents that you want to compare to. type: boolean - _common.aggregations:HdrMethod: + _common.aggregations___HdrMethod: type: object properties: number_of_significant_value_digits: description: Specifies the resolution of values for the histogram in number of significant digits. type: number - _common.aggregations:HdrPercentileRanksAggregate: + _common.aggregations___HdrPercentileRanksAggregate: allOf: - - $ref: '#/components/schemas/_common.aggregations:PercentilesAggregateBase' + - $ref: '#/components/schemas/_common.aggregations___PercentilesAggregateBase' - type: object - _common.aggregations:HdrPercentilesAggregate: + _common.aggregations___HdrPercentilesAggregate: allOf: - - $ref: '#/components/schemas/_common.aggregations:PercentilesAggregateBase' + - $ref: '#/components/schemas/_common.aggregations___PercentilesAggregateBase' - type: object - _common.aggregations:HistogramAggregate: + _common.aggregations___HistogramAggregate: allOf: - - $ref: '#/components/schemas/_common.aggregations:MultiBucketAggregateBaseHistogramBucket' + - $ref: '#/components/schemas/_common.aggregations___MultiBucketAggregateBaseHistogramBucket' - type: object - _common.aggregations:HistogramAggregation: + _common.aggregations___HistogramAggregation: allOf: - - $ref: '#/components/schemas/_common.aggregations:BucketAggregationBase' + - $ref: '#/components/schemas/_common.aggregations___BucketAggregationBase' - type: object properties: extended_bounds: - $ref: '#/components/schemas/_common.aggregations:ExtendedBoundsdouble' + $ref: '#/components/schemas/_common.aggregations___ExtendedBoundsdouble' hard_bounds: - $ref: '#/components/schemas/_common.aggregations:ExtendedBoundsdouble' + $ref: '#/components/schemas/_common.aggregations___ExtendedBoundsdouble' field: - $ref: '#/components/schemas/_common:Field' + $ref: '#/components/schemas/_common___Field' interval: description: |- The interval for the buckets. @@ -33977,17 +35680,17 @@ components: The bucket boundaries can be shifted by using the `offset` option. type: number order: - $ref: '#/components/schemas/_common.aggregations:AggregateOrder' + $ref: '#/components/schemas/_common.aggregations___AggregateOrder' script: - $ref: '#/components/schemas/_common:Script' + $ref: '#/components/schemas/_common___Script' format: type: string keyed: description: If `true`, returns buckets as a hash instead of an array, keyed by the bucket keys. type: boolean - _common.aggregations:HistogramBucket: + _common.aggregations___HistogramBucket: allOf: - - $ref: '#/components/schemas/_common.aggregations:MultiBucketBase' + - $ref: '#/components/schemas/_common.aggregations___MultiBucketBase' - type: object properties: key_as_string: @@ -33996,16 +35699,16 @@ components: type: number required: - key - _common.aggregations:HoltLinearModelSettings: + _common.aggregations___HoltLinearModelSettings: type: object properties: alpha: type: number beta: type: number - _common.aggregations:HoltMovingAverageAggregation: + _common.aggregations___HoltMovingAverageAggregation: allOf: - - $ref: '#/components/schemas/_common.aggregations:MovingAverageAggregationBase' + - $ref: '#/components/schemas/_common.aggregations___MovingAverageAggregationBase' - type: object properties: model: @@ -34013,11 +35716,11 @@ components: enum: - holt settings: - $ref: '#/components/schemas/_common.aggregations:HoltLinearModelSettings' + $ref: '#/components/schemas/_common.aggregations___HoltLinearModelSettings' required: - model - settings - _common.aggregations:HoltWintersModelSettings: + _common.aggregations___HoltWintersModelSettings: type: object properties: alpha: @@ -34031,10 +35734,10 @@ components: period: type: number type: - $ref: '#/components/schemas/_common.aggregations:HoltWintersType' - _common.aggregations:HoltWintersMovingAverageAggregation: + $ref: '#/components/schemas/_common.aggregations___HoltWintersType' + _common.aggregations___HoltWintersMovingAverageAggregation: allOf: - - $ref: '#/components/schemas/_common.aggregations:MovingAverageAggregationBase' + - $ref: '#/components/schemas/_common.aggregations___MovingAverageAggregationBase' - type: object properties: model: @@ -34042,44 +35745,44 @@ components: enum: - holt_winters settings: - $ref: '#/components/schemas/_common.aggregations:HoltWintersModelSettings' + $ref: '#/components/schemas/_common.aggregations___HoltWintersModelSettings' required: - model - settings - _common.aggregations:HoltWintersType: + _common.aggregations___HoltWintersType: type: string enum: - add - mult - _common.aggregations:InferenceAggregate: + _common.aggregations___InferenceAggregate: allOf: - - $ref: '#/components/schemas/_common.aggregations:AggregateBase' + - $ref: '#/components/schemas/_common.aggregations___AggregateBase' - type: object properties: value: - $ref: '#/components/schemas/_common:FieldValue' + $ref: '#/components/schemas/_common___FieldValue' feature_importance: type: array items: - $ref: '#/components/schemas/_common.aggregations:InferenceFeatureImportance' + $ref: '#/components/schemas/_common.aggregations___InferenceFeatureImportance' top_classes: type: array items: - $ref: '#/components/schemas/_common.aggregations:InferenceTopClassEntry' + $ref: '#/components/schemas/_common.aggregations___InferenceTopClassEntry' warning: type: string - _common.aggregations:InferenceAggregation: + _common.aggregations___InferenceAggregation: allOf: - - $ref: '#/components/schemas/_common.aggregations:PipelineAggregationBase' + - $ref: '#/components/schemas/_common.aggregations___PipelineAggregationBase' - type: object properties: model_id: - $ref: '#/components/schemas/_common:Name' + $ref: '#/components/schemas/_common___Name' inference_config: - $ref: '#/components/schemas/_common.aggregations:InferenceConfigContainer' + $ref: '#/components/schemas/_common.aggregations___InferenceConfigContainer' required: - model_id - _common.aggregations:InferenceClassImportance: + _common.aggregations___InferenceClassImportance: type: object properties: class_name: @@ -34089,16 +35792,16 @@ components: required: - class_name - importance - _common.aggregations:InferenceConfigContainer: + _common.aggregations___InferenceConfigContainer: type: object properties: regression: - $ref: '#/components/schemas/_common.aggregations:RegressionInferenceOptions' + $ref: '#/components/schemas/_common.aggregations___RegressionInferenceOptions' classification: - $ref: '#/components/schemas/_common.aggregations:ClassificationInferenceOptions' + $ref: '#/components/schemas/_common.aggregations___ClassificationInferenceOptions' minProperties: 1 maxProperties: 1 - _common.aggregations:InferenceFeatureImportance: + _common.aggregations___InferenceFeatureImportance: type: object properties: feature_name: @@ -34108,14 +35811,14 @@ components: classes: type: array items: - $ref: '#/components/schemas/_common.aggregations:InferenceClassImportance' + $ref: '#/components/schemas/_common.aggregations___InferenceClassImportance' required: - feature_name - _common.aggregations:InferenceTopClassEntry: + _common.aggregations___InferenceTopClassEntry: type: object properties: class_name: - $ref: '#/components/schemas/_common:FieldValue' + $ref: '#/components/schemas/_common___FieldValue' class_probability: type: number class_score: @@ -34124,17 +35827,17 @@ components: - class_name - class_probability - class_score - _common.aggregations:IpPrefixAggregate: + _common.aggregations___IpPrefixAggregate: allOf: - - $ref: '#/components/schemas/_common.aggregations:MultiBucketAggregateBaseIpPrefixBucket' + - $ref: '#/components/schemas/_common.aggregations___MultiBucketAggregateBaseIpPrefixBucket' - type: object - _common.aggregations:IpPrefixAggregation: + _common.aggregations___IpPrefixAggregation: allOf: - - $ref: '#/components/schemas/_common.aggregations:BucketAggregationBase' + - $ref: '#/components/schemas/_common.aggregations___BucketAggregationBase' - type: object properties: field: - $ref: '#/components/schemas/_common:Field' + $ref: '#/components/schemas/_common___Field' prefix_length: description: |- Length of the network prefix. For IPv4 addresses the accepted range is [0, 32]. @@ -34155,9 +35858,9 @@ components: required: - field - prefix_length - _common.aggregations:IpPrefixBucket: + _common.aggregations___IpPrefixBucket: allOf: - - $ref: '#/components/schemas/_common.aggregations:MultiBucketBase' + - $ref: '#/components/schemas/_common.aggregations___MultiBucketBase' - type: object properties: is_ipv6: @@ -34172,23 +35875,23 @@ components: - is_ipv6 - key - prefix_length - _common.aggregations:IpRangeAggregate: + _common.aggregations___IpRangeAggregate: allOf: - - $ref: '#/components/schemas/_common.aggregations:MultiBucketAggregateBaseIpRangeBucket' + - $ref: '#/components/schemas/_common.aggregations___MultiBucketAggregateBaseIpRangeBucket' - type: object - _common.aggregations:IpRangeAggregation: + _common.aggregations___IpRangeAggregation: allOf: - - $ref: '#/components/schemas/_common.aggregations:BucketAggregationBase' + - $ref: '#/components/schemas/_common.aggregations___BucketAggregationBase' - type: object properties: field: - $ref: '#/components/schemas/_common:Field' + $ref: '#/components/schemas/_common___Field' ranges: description: Array of IP ranges. type: array items: - $ref: '#/components/schemas/_common.aggregations:IpRangeAggregationRange' - _common.aggregations:IpRangeAggregationRange: + $ref: '#/components/schemas/_common.aggregations___IpRangeAggregationRange' + _common.aggregations___IpRangeAggregationRange: type: object properties: from: @@ -34204,9 +35907,9 @@ components: type: - 'null' - string - _common.aggregations:IpRangeBucket: + _common.aggregations___IpRangeBucket: allOf: - - $ref: '#/components/schemas/_common.aggregations:MultiBucketBase' + - $ref: '#/components/schemas/_common.aggregations___MultiBucketBase' - type: object properties: key: @@ -34215,16 +35918,16 @@ components: type: string to: type: string - _common.aggregations:KeyedPercentiles: + _common.aggregations___KeyedPercentiles: type: object additionalProperties: type: - 'null' - number - string - _common.aggregations:LinearMovingAverageAggregation: + _common.aggregations___LinearMovingAverageAggregation: allOf: - - $ref: '#/components/schemas/_common.aggregations:MovingAverageAggregationBase' + - $ref: '#/components/schemas/_common.aggregations___MovingAverageAggregationBase' - type: object properties: model: @@ -34232,17 +35935,17 @@ components: enum: - linear settings: - $ref: '#/components/schemas/_common:EmptyObject' + $ref: '#/components/schemas/_common___EmptyObject' required: - model - settings - _common.aggregations:LongRareTermsAggregate: + _common.aggregations___LongRareTermsAggregate: allOf: - - $ref: '#/components/schemas/_common.aggregations:MultiBucketAggregateBaseLongRareTermsBucket' + - $ref: '#/components/schemas/_common.aggregations___MultiBucketAggregateBaseLongRareTermsBucket' - type: object - _common.aggregations:LongRareTermsBucket: + _common.aggregations___LongRareTermsBucket: allOf: - - $ref: '#/components/schemas/_common.aggregations:MultiBucketBase' + - $ref: '#/components/schemas/_common.aggregations___MultiBucketBase' - type: object properties: key: @@ -34251,13 +35954,13 @@ components: type: string required: - key - _common.aggregations:LongTermsAggregate: + _common.aggregations___LongTermsAggregate: allOf: - - $ref: '#/components/schemas/_common.aggregations:TermsAggregateBaseLongTermsBucket' + - $ref: '#/components/schemas/_common.aggregations___TermsAggregateBaseLongTermsBucket' - type: object - _common.aggregations:LongTermsBucket: + _common.aggregations___LongTermsBucket: allOf: - - $ref: '#/components/schemas/_common.aggregations:TermsBucketBase' + - $ref: '#/components/schemas/_common.aggregations___TermsBucketBase' - type: object properties: key: @@ -34266,13 +35969,13 @@ components: type: string required: - key - _common.aggregations:MatrixAggregation: + _common.aggregations___MatrixAggregation: allOf: - - $ref: '#/components/schemas/_common.aggregations:Aggregation' + - $ref: '#/components/schemas/_common.aggregations___Aggregation' - type: object properties: fields: - $ref: '#/components/schemas/_common:Fields' + $ref: '#/components/schemas/_common___Fields' missing: description: |- The value to apply to documents that do not have a value. @@ -34280,9 +35983,9 @@ components: type: object additionalProperties: type: number - _common.aggregations:MatrixStatsAggregate: + _common.aggregations___MatrixStatsAggregate: allOf: - - $ref: '#/components/schemas/_common.aggregations:AggregateBase' + - $ref: '#/components/schemas/_common.aggregations___AggregateBase' - type: object properties: doc_count: @@ -34290,21 +35993,21 @@ components: fields: type: array items: - $ref: '#/components/schemas/_common.aggregations:MatrixStatsFields' + $ref: '#/components/schemas/_common.aggregations___MatrixStatsFields' required: - doc_count - _common.aggregations:MatrixStatsAggregation: + _common.aggregations___MatrixStatsAggregation: allOf: - - $ref: '#/components/schemas/_common.aggregations:MatrixAggregation' + - $ref: '#/components/schemas/_common.aggregations___MatrixAggregation' - type: object properties: mode: - $ref: '#/components/schemas/_common:SortMode' - _common.aggregations:MatrixStatsFields: + $ref: '#/components/schemas/_common___SortMode' + _common.aggregations___MatrixStatsFields: type: object properties: name: - $ref: '#/components/schemas/_common:Field' + $ref: '#/components/schemas/_common___Field' count: type: number mean: @@ -34332,52 +36035,52 @@ components: - name - skewness - variance - _common.aggregations:MaxAggregate: + _common.aggregations___MaxAggregate: allOf: - - $ref: '#/components/schemas/_common.aggregations:SingleMetricAggregateBase' + - $ref: '#/components/schemas/_common.aggregations___SingleMetricAggregateBase' - type: object - _common.aggregations:MaxAggregation: + _common.aggregations___MaxAggregation: allOf: - - $ref: '#/components/schemas/_common.aggregations:FormatMetricAggregationBase' + - $ref: '#/components/schemas/_common.aggregations___FormatMetricAggregationBase' - type: object - _common.aggregations:MaxBucketAggregation: + _common.aggregations___MaxBucketAggregation: allOf: - - $ref: '#/components/schemas/_common.aggregations:PipelineAggregationBase' + - $ref: '#/components/schemas/_common.aggregations___PipelineAggregationBase' - type: object - _common.aggregations:MedianAbsoluteDeviationAggregate: + _common.aggregations___MedianAbsoluteDeviationAggregate: allOf: - - $ref: '#/components/schemas/_common.aggregations:SingleMetricAggregateBase' + - $ref: '#/components/schemas/_common.aggregations___SingleMetricAggregateBase' - type: object - _common.aggregations:MedianAbsoluteDeviationAggregation: + _common.aggregations___MedianAbsoluteDeviationAggregation: allOf: - - $ref: '#/components/schemas/_common.aggregations:FormatMetricAggregationBase' + - $ref: '#/components/schemas/_common.aggregations___FormatMetricAggregationBase' - type: object properties: compression: description: Limits the maximum number of nodes used by the underlying TDigest algorithm to `20 * compression`, enabling control of memory usage and approximation error. type: number - _common.aggregations:MetricAggregationBase: + _common.aggregations___MetricAggregationBase: type: object properties: field: - $ref: '#/components/schemas/_common:Field' + $ref: '#/components/schemas/_common___Field' missing: - $ref: '#/components/schemas/_common.aggregations:Missing' + $ref: '#/components/schemas/_common.aggregations___Missing' script: - $ref: '#/components/schemas/_common:Script' - _common.aggregations:MinAggregate: + $ref: '#/components/schemas/_common___Script' + _common.aggregations___MinAggregate: allOf: - - $ref: '#/components/schemas/_common.aggregations:SingleMetricAggregateBase' + - $ref: '#/components/schemas/_common.aggregations___SingleMetricAggregateBase' - type: object - _common.aggregations:MinAggregation: + _common.aggregations___MinAggregation: allOf: - - $ref: '#/components/schemas/_common.aggregations:FormatMetricAggregationBase' + - $ref: '#/components/schemas/_common.aggregations___FormatMetricAggregationBase' - type: object - _common.aggregations:MinBucketAggregation: + _common.aggregations___MinBucketAggregation: allOf: - - $ref: '#/components/schemas/_common.aggregations:PipelineAggregationBase' + - $ref: '#/components/schemas/_common.aggregations___PipelineAggregationBase' - type: object - _common.aggregations:MinimumInterval: + _common.aggregations___MinimumInterval: type: string enum: - day @@ -34386,44 +36089,44 @@ components: - month - second - year - _common.aggregations:Missing: + _common.aggregations___Missing: oneOf: - type: string - type: number - type: number - type: boolean - _common.aggregations:MissingAggregate: + _common.aggregations___MissingAggregate: allOf: - - $ref: '#/components/schemas/_common.aggregations:SingleBucketAggregateBase' + - $ref: '#/components/schemas/_common.aggregations___SingleBucketAggregateBase' - type: object - _common.aggregations:MissingAggregation: + _common.aggregations___MissingAggregation: allOf: - - $ref: '#/components/schemas/_common.aggregations:BucketAggregationBase' + - $ref: '#/components/schemas/_common.aggregations___BucketAggregationBase' - type: object properties: field: - $ref: '#/components/schemas/_common:Field' + $ref: '#/components/schemas/_common___Field' missing: - $ref: '#/components/schemas/_common.aggregations:Missing' - _common.aggregations:MissingOrder: + $ref: '#/components/schemas/_common.aggregations___Missing' + _common.aggregations___MissingOrder: type: string enum: - default - first - last - _common.aggregations:MovingAverageAggregation: + _common.aggregations___MovingAverageAggregation: type: object discriminator: propertyName: model oneOf: - - $ref: '#/components/schemas/_common.aggregations:LinearMovingAverageAggregation' - - $ref: '#/components/schemas/_common.aggregations:SimpleMovingAverageAggregation' - - $ref: '#/components/schemas/_common.aggregations:EwmaMovingAverageAggregation' - - $ref: '#/components/schemas/_common.aggregations:HoltMovingAverageAggregation' - - $ref: '#/components/schemas/_common.aggregations:HoltWintersMovingAverageAggregation' - _common.aggregations:MovingAverageAggregationBase: + - $ref: '#/components/schemas/_common.aggregations___LinearMovingAverageAggregation' + - $ref: '#/components/schemas/_common.aggregations___SimpleMovingAverageAggregation' + - $ref: '#/components/schemas/_common.aggregations___EwmaMovingAverageAggregation' + - $ref: '#/components/schemas/_common.aggregations___HoltMovingAverageAggregation' + - $ref: '#/components/schemas/_common.aggregations___HoltWintersMovingAverageAggregation' + _common.aggregations___MovingAverageAggregationBase: allOf: - - $ref: '#/components/schemas/_common.aggregations:PipelineAggregationBase' + - $ref: '#/components/schemas/_common.aggregations___PipelineAggregationBase' - type: object properties: minimize: @@ -34432,9 +36135,9 @@ components: type: number window: type: number - _common.aggregations:MovingFunctionAggregation: + _common.aggregations___MovingFunctionAggregation: allOf: - - $ref: '#/components/schemas/_common.aggregations:PipelineAggregationBase' + - $ref: '#/components/schemas/_common.aggregations___PipelineAggregationBase' - type: object properties: script: @@ -34448,9 +36151,9 @@ components: window: description: The size of window to "slide" across the histogram. type: number - _common.aggregations:MovingPercentilesAggregation: + _common.aggregations___MovingPercentilesAggregation: allOf: - - $ref: '#/components/schemas/_common.aggregations:PipelineAggregationBase' + - $ref: '#/components/schemas/_common.aggregations___PipelineAggregationBase' - type: object properties: window: @@ -34463,233 +36166,233 @@ components: type: number keyed: type: boolean - _common.aggregations:MultiBucketAggregateBaseAdjacencyMatrixBucket: + _common.aggregations___MultiBucketAggregateBaseAdjacencyMatrixBucket: allOf: - - $ref: '#/components/schemas/_common.aggregations:AggregateBase' + - $ref: '#/components/schemas/_common.aggregations___AggregateBase' - type: object properties: buckets: - $ref: '#/components/schemas/_common.aggregations:BucketsAdjacencyMatrixBucket' + $ref: '#/components/schemas/_common.aggregations___BucketsAdjacencyMatrixBucket' required: - buckets - _common.aggregations:MultiBucketAggregateBaseCompositeBucket: + _common.aggregations___MultiBucketAggregateBaseCompositeBucket: allOf: - - $ref: '#/components/schemas/_common.aggregations:AggregateBase' + - $ref: '#/components/schemas/_common.aggregations___AggregateBase' - type: object properties: buckets: - $ref: '#/components/schemas/_common.aggregations:BucketsCompositeBucket' + $ref: '#/components/schemas/_common.aggregations___BucketsCompositeBucket' required: - buckets - _common.aggregations:MultiBucketAggregateBaseDateHistogramBucket: + _common.aggregations___MultiBucketAggregateBaseDateHistogramBucket: allOf: - - $ref: '#/components/schemas/_common.aggregations:AggregateBase' + - $ref: '#/components/schemas/_common.aggregations___AggregateBase' - type: object properties: buckets: - $ref: '#/components/schemas/_common.aggregations:BucketsDateHistogramBucket' + $ref: '#/components/schemas/_common.aggregations___BucketsDateHistogramBucket' required: - buckets - _common.aggregations:MultiBucketAggregateBaseDoubleTermsBucket: + _common.aggregations___MultiBucketAggregateBaseDoubleTermsBucket: allOf: - - $ref: '#/components/schemas/_common.aggregations:AggregateBase' + - $ref: '#/components/schemas/_common.aggregations___AggregateBase' - type: object properties: buckets: - $ref: '#/components/schemas/_common.aggregations:BucketsDoubleTermsBucket' + $ref: '#/components/schemas/_common.aggregations___BucketsDoubleTermsBucket' required: - buckets - _common.aggregations:MultiBucketAggregateBaseFiltersBucket: + _common.aggregations___MultiBucketAggregateBaseFiltersBucket: allOf: - - $ref: '#/components/schemas/_common.aggregations:AggregateBase' + - $ref: '#/components/schemas/_common.aggregations___AggregateBase' - type: object properties: buckets: - $ref: '#/components/schemas/_common.aggregations:BucketsFiltersBucket' + $ref: '#/components/schemas/_common.aggregations___BucketsFiltersBucket' required: - buckets - _common.aggregations:MultiBucketAggregateBaseFrequentItemSetsBucket: + _common.aggregations___MultiBucketAggregateBaseFrequentItemSetsBucket: allOf: - - $ref: '#/components/schemas/_common.aggregations:AggregateBase' + - $ref: '#/components/schemas/_common.aggregations___AggregateBase' - type: object properties: buckets: - $ref: '#/components/schemas/_common.aggregations:BucketsFrequentItemSetsBucket' + $ref: '#/components/schemas/_common.aggregations___BucketsFrequentItemSetsBucket' required: - buckets - _common.aggregations:MultiBucketAggregateBaseGeoHashGridBucket: + _common.aggregations___MultiBucketAggregateBaseGeoHashGridBucket: allOf: - - $ref: '#/components/schemas/_common.aggregations:AggregateBase' + - $ref: '#/components/schemas/_common.aggregations___AggregateBase' - type: object properties: buckets: - $ref: '#/components/schemas/_common.aggregations:BucketsGeoHashGridBucket' + $ref: '#/components/schemas/_common.aggregations___BucketsGeoHashGridBucket' required: - buckets - _common.aggregations:MultiBucketAggregateBaseGeoHexGridBucket: + _common.aggregations___MultiBucketAggregateBaseGeoHexGridBucket: allOf: - - $ref: '#/components/schemas/_common.aggregations:AggregateBase' + - $ref: '#/components/schemas/_common.aggregations___AggregateBase' - type: object properties: buckets: - $ref: '#/components/schemas/_common.aggregations:BucketsGeoHexGridBucket' + $ref: '#/components/schemas/_common.aggregations___BucketsGeoHexGridBucket' required: - buckets - _common.aggregations:MultiBucketAggregateBaseGeoTileGridBucket: + _common.aggregations___MultiBucketAggregateBaseGeoTileGridBucket: allOf: - - $ref: '#/components/schemas/_common.aggregations:AggregateBase' + - $ref: '#/components/schemas/_common.aggregations___AggregateBase' - type: object properties: buckets: - $ref: '#/components/schemas/_common.aggregations:BucketsGeoTileGridBucket' + $ref: '#/components/schemas/_common.aggregations___BucketsGeoTileGridBucket' required: - buckets - _common.aggregations:MultiBucketAggregateBaseHistogramBucket: + _common.aggregations___MultiBucketAggregateBaseHistogramBucket: allOf: - - $ref: '#/components/schemas/_common.aggregations:AggregateBase' + - $ref: '#/components/schemas/_common.aggregations___AggregateBase' - type: object properties: buckets: - $ref: '#/components/schemas/_common.aggregations:BucketsHistogramBucket' + $ref: '#/components/schemas/_common.aggregations___BucketsHistogramBucket' required: - buckets - _common.aggregations:MultiBucketAggregateBaseIpPrefixBucket: + _common.aggregations___MultiBucketAggregateBaseIpPrefixBucket: allOf: - - $ref: '#/components/schemas/_common.aggregations:AggregateBase' + - $ref: '#/components/schemas/_common.aggregations___AggregateBase' - type: object properties: buckets: - $ref: '#/components/schemas/_common.aggregations:BucketsIpPrefixBucket' + $ref: '#/components/schemas/_common.aggregations___BucketsIpPrefixBucket' required: - buckets - _common.aggregations:MultiBucketAggregateBaseIpRangeBucket: + _common.aggregations___MultiBucketAggregateBaseIpRangeBucket: allOf: - - $ref: '#/components/schemas/_common.aggregations:AggregateBase' + - $ref: '#/components/schemas/_common.aggregations___AggregateBase' - type: object properties: buckets: - $ref: '#/components/schemas/_common.aggregations:BucketsIpRangeBucket' + $ref: '#/components/schemas/_common.aggregations___BucketsIpRangeBucket' required: - buckets - _common.aggregations:MultiBucketAggregateBaseLongRareTermsBucket: + _common.aggregations___MultiBucketAggregateBaseLongRareTermsBucket: allOf: - - $ref: '#/components/schemas/_common.aggregations:AggregateBase' + - $ref: '#/components/schemas/_common.aggregations___AggregateBase' - type: object properties: buckets: - $ref: '#/components/schemas/_common.aggregations:BucketsLongRareTermsBucket' + $ref: '#/components/schemas/_common.aggregations___BucketsLongRareTermsBucket' required: - buckets - _common.aggregations:MultiBucketAggregateBaseLongTermsBucket: + _common.aggregations___MultiBucketAggregateBaseLongTermsBucket: allOf: - - $ref: '#/components/schemas/_common.aggregations:AggregateBase' + - $ref: '#/components/schemas/_common.aggregations___AggregateBase' - type: object properties: buckets: - $ref: '#/components/schemas/_common.aggregations:BucketsLongTermsBucket' + $ref: '#/components/schemas/_common.aggregations___BucketsLongTermsBucket' required: - buckets - _common.aggregations:MultiBucketAggregateBaseMultiTermsBucket: + _common.aggregations___MultiBucketAggregateBaseMultiTermsBucket: allOf: - - $ref: '#/components/schemas/_common.aggregations:AggregateBase' + - $ref: '#/components/schemas/_common.aggregations___AggregateBase' - type: object properties: buckets: - $ref: '#/components/schemas/_common.aggregations:BucketsMultiTermsBucket' + $ref: '#/components/schemas/_common.aggregations___BucketsMultiTermsBucket' required: - buckets - _common.aggregations:MultiBucketAggregateBaseRangeBucket: + _common.aggregations___MultiBucketAggregateBaseRangeBucket: allOf: - - $ref: '#/components/schemas/_common.aggregations:AggregateBase' + - $ref: '#/components/schemas/_common.aggregations___AggregateBase' - type: object properties: buckets: - $ref: '#/components/schemas/_common.aggregations:BucketsRangeBucket' + $ref: '#/components/schemas/_common.aggregations___BucketsRangeBucket' required: - buckets - _common.aggregations:MultiBucketAggregateBaseSignificantLongTermsBucket: + _common.aggregations___MultiBucketAggregateBaseSignificantLongTermsBucket: allOf: - - $ref: '#/components/schemas/_common.aggregations:AggregateBase' + - $ref: '#/components/schemas/_common.aggregations___AggregateBase' - type: object properties: buckets: - $ref: '#/components/schemas/_common.aggregations:BucketsSignificantLongTermsBucket' + $ref: '#/components/schemas/_common.aggregations___BucketsSignificantLongTermsBucket' required: - buckets - _common.aggregations:MultiBucketAggregateBaseSignificantStringTermsBucket: + _common.aggregations___MultiBucketAggregateBaseSignificantStringTermsBucket: allOf: - - $ref: '#/components/schemas/_common.aggregations:AggregateBase' + - $ref: '#/components/schemas/_common.aggregations___AggregateBase' - type: object properties: buckets: - $ref: '#/components/schemas/_common.aggregations:BucketsSignificantStringTermsBucket' + $ref: '#/components/schemas/_common.aggregations___BucketsSignificantStringTermsBucket' required: - buckets - _common.aggregations:MultiBucketAggregateBaseStringRareTermsBucket: + _common.aggregations___MultiBucketAggregateBaseStringRareTermsBucket: allOf: - - $ref: '#/components/schemas/_common.aggregations:AggregateBase' + - $ref: '#/components/schemas/_common.aggregations___AggregateBase' - type: object properties: buckets: - $ref: '#/components/schemas/_common.aggregations:BucketsStringRareTermsBucket' + $ref: '#/components/schemas/_common.aggregations___BucketsStringRareTermsBucket' required: - buckets - _common.aggregations:MultiBucketAggregateBaseStringTermsBucket: + _common.aggregations___MultiBucketAggregateBaseStringTermsBucket: allOf: - - $ref: '#/components/schemas/_common.aggregations:AggregateBase' + - $ref: '#/components/schemas/_common.aggregations___AggregateBase' - type: object properties: buckets: - $ref: '#/components/schemas/_common.aggregations:BucketsStringTermsBucket' + $ref: '#/components/schemas/_common.aggregations___BucketsStringTermsBucket' required: - buckets - _common.aggregations:MultiBucketAggregateBaseVariableWidthHistogramBucket: + _common.aggregations___MultiBucketAggregateBaseVariableWidthHistogramBucket: allOf: - - $ref: '#/components/schemas/_common.aggregations:AggregateBase' + - $ref: '#/components/schemas/_common.aggregations___AggregateBase' - type: object properties: buckets: - $ref: '#/components/schemas/_common.aggregations:BucketsVariableWidthHistogramBucket' + $ref: '#/components/schemas/_common.aggregations___BucketsVariableWidthHistogramBucket' required: - buckets - _common.aggregations:MultiBucketAggregateBaseVoid: + _common.aggregations___MultiBucketAggregateBaseVoid: allOf: - - $ref: '#/components/schemas/_common.aggregations:AggregateBase' + - $ref: '#/components/schemas/_common.aggregations___AggregateBase' - type: object properties: buckets: - $ref: '#/components/schemas/_common.aggregations:BucketsVoid' + $ref: '#/components/schemas/_common.aggregations___BucketsVoid' required: - buckets - _common.aggregations:MultiBucketBase: + _common.aggregations___MultiBucketBase: type: object properties: doc_count: type: number required: - doc_count - _common.aggregations:MultiTermLookup: + _common.aggregations___MultiTermLookup: type: object properties: field: - $ref: '#/components/schemas/_common:Field' + $ref: '#/components/schemas/_common___Field' missing: - $ref: '#/components/schemas/_common.aggregations:Missing' + $ref: '#/components/schemas/_common.aggregations___Missing' required: - field - _common.aggregations:MultiTermsAggregate: + _common.aggregations___MultiTermsAggregate: allOf: - - $ref: '#/components/schemas/_common.aggregations:TermsAggregateBaseMultiTermsBucket' + - $ref: '#/components/schemas/_common.aggregations___TermsAggregateBaseMultiTermsBucket' - type: object - _common.aggregations:MultiTermsAggregation: + _common.aggregations___MultiTermsAggregation: allOf: - - $ref: '#/components/schemas/_common.aggregations:BucketAggregationBase' + - $ref: '#/components/schemas/_common.aggregations___BucketAggregationBase' - type: object properties: collect_mode: - $ref: '#/components/schemas/_common.aggregations:TermsAggregationCollectMode' + $ref: '#/components/schemas/_common.aggregations___TermsAggregationCollectMode' order: - $ref: '#/components/schemas/_common.aggregations:AggregateOrder' + $ref: '#/components/schemas/_common.aggregations___AggregateOrder' min_doc_count: description: The minimum number of documents in a bucket for it to be returned. type: number @@ -34711,25 +36414,25 @@ components: description: The field from which to generate sets of terms. type: array items: - $ref: '#/components/schemas/_common.aggregations:MultiTermLookup' + $ref: '#/components/schemas/_common.aggregations___MultiTermLookup' required: - terms - _common.aggregations:MultiTermsBucket: + _common.aggregations___MultiTermsBucket: allOf: - - $ref: '#/components/schemas/_common.aggregations:MultiBucketBase' + - $ref: '#/components/schemas/_common.aggregations___MultiBucketBase' - type: object properties: key: type: array items: - $ref: '#/components/schemas/_common:FieldValue' + $ref: '#/components/schemas/_common___FieldValue' key_as_string: type: string doc_count_error_upper_bound: type: number required: - key - _common.aggregations:MutualInformationHeuristic: + _common.aggregations___MutualInformationHeuristic: type: object properties: background_is_superset: @@ -34738,28 +36441,28 @@ components: include_negatives: description: Set to `false` to filter out the terms that appear less often in the subset than in documents outside the subset. type: boolean - _common.aggregations:NestedAggregate: + _common.aggregations___NestedAggregate: allOf: - - $ref: '#/components/schemas/_common.aggregations:SingleBucketAggregateBase' + - $ref: '#/components/schemas/_common.aggregations___AggregateBase' - type: object properties: doc_count: type: number - _common.aggregations:NestedAggregation: + _common.aggregations___NestedAggregation: allOf: - - $ref: '#/components/schemas/_common.aggregations:BucketAggregationBase' + - $ref: '#/components/schemas/_common.aggregations___BucketAggregationBase' - type: object properties: path: - $ref: '#/components/schemas/_common:Field' - _common.aggregations:NormalizeAggregation: + $ref: '#/components/schemas/_common___Field' + _common.aggregations___NormalizeAggregation: allOf: - - $ref: '#/components/schemas/_common.aggregations:PipelineAggregationBase' + - $ref: '#/components/schemas/_common.aggregations___PipelineAggregationBase' - type: object properties: method: - $ref: '#/components/schemas/_common.aggregations:NormalizeMethod' - _common.aggregations:NormalizeMethod: + $ref: '#/components/schemas/_common.aggregations___NormalizeMethod' + _common.aggregations___NormalizeMethod: type: string enum: - mean @@ -34768,22 +36471,22 @@ components: - rescale_0_100 - softmax - z-score - _common.aggregations:ParentAggregate: + _common.aggregations___ParentAggregate: allOf: - - $ref: '#/components/schemas/_common.aggregations:SingleBucketAggregateBase' + - $ref: '#/components/schemas/_common.aggregations___SingleBucketAggregateBase' - type: object - _common.aggregations:ParentAggregation: + _common.aggregations___ParentAggregation: allOf: - - $ref: '#/components/schemas/_common.aggregations:BucketAggregationBase' + - $ref: '#/components/schemas/_common.aggregations___BucketAggregationBase' - type: object properties: type: - $ref: '#/components/schemas/_common:RelationName' - _common.aggregations:PercentageScoreHeuristic: + $ref: '#/components/schemas/_common___RelationName' + _common.aggregations___PercentageScoreHeuristic: type: object - _common.aggregations:PercentileRanksAggregation: + _common.aggregations___PercentileRanksAggregation: allOf: - - $ref: '#/components/schemas/_common.aggregations:FormatMetricAggregationBase' + - $ref: '#/components/schemas/_common.aggregations___FormatMetricAggregationBase' - type: object properties: keyed: @@ -34800,27 +36503,27 @@ components: - type: 'null' - type: string hdr: - $ref: '#/components/schemas/_common.aggregations:HdrMethod' + $ref: '#/components/schemas/_common.aggregations___HdrMethod' tdigest: - $ref: '#/components/schemas/_common.aggregations:TDigest' - _common.aggregations:Percentiles: + $ref: '#/components/schemas/_common.aggregations___TDigest' + _common.aggregations___Percentiles: oneOf: - - $ref: '#/components/schemas/_common.aggregations:KeyedPercentiles' + - $ref: '#/components/schemas/_common.aggregations___KeyedPercentiles' - type: array items: - $ref: '#/components/schemas/_common.aggregations:ArrayPercentilesItem' - _common.aggregations:PercentilesAggregateBase: + $ref: '#/components/schemas/_common.aggregations___ArrayPercentilesItem' + _common.aggregations___PercentilesAggregateBase: allOf: - - $ref: '#/components/schemas/_common.aggregations:AggregateBase' + - $ref: '#/components/schemas/_common.aggregations___AggregateBase' - type: object properties: values: - $ref: '#/components/schemas/_common.aggregations:Percentiles' + $ref: '#/components/schemas/_common.aggregations___Percentiles' required: - values - _common.aggregations:PercentilesAggregation: + _common.aggregations___PercentilesAggregation: allOf: - - $ref: '#/components/schemas/_common.aggregations:FormatMetricAggregationBase' + - $ref: '#/components/schemas/_common.aggregations___FormatMetricAggregationBase' - type: object properties: keyed: @@ -34834,16 +36537,16 @@ components: items: type: number hdr: - $ref: '#/components/schemas/_common.aggregations:HdrMethod' + $ref: '#/components/schemas/_common.aggregations___HdrMethod' tdigest: - $ref: '#/components/schemas/_common.aggregations:TDigest' - _common.aggregations:PercentilesBucketAggregate: + $ref: '#/components/schemas/_common.aggregations___TDigest' + _common.aggregations___PercentilesBucketAggregate: allOf: - - $ref: '#/components/schemas/_common.aggregations:PercentilesAggregateBase' + - $ref: '#/components/schemas/_common.aggregations___PercentilesAggregateBase' - type: object - _common.aggregations:PercentilesBucketAggregation: + _common.aggregations___PercentilesBucketAggregation: allOf: - - $ref: '#/components/schemas/_common.aggregations:PipelineAggregationBase' + - $ref: '#/components/schemas/_common.aggregations___PipelineAggregationBase' - type: object properties: percents: @@ -34851,9 +36554,9 @@ components: type: array items: type: number - _common.aggregations:PipelineAggregationBase: + _common.aggregations___PipelineAggregationBase: allOf: - - $ref: '#/components/schemas/_common.aggregations:BucketPathAggregation' + - $ref: '#/components/schemas/_common.aggregations___BucketPathAggregation' - type: object properties: format: @@ -34862,18 +36565,18 @@ components: If specified, the formatted value is returned in the aggregation's `value_as_string` property. type: string gap_policy: - $ref: '#/components/schemas/_common.aggregations:GapPolicy' - _common.aggregations:RangeAggregate: + $ref: '#/components/schemas/_common.aggregations___GapPolicy' + _common.aggregations___RangeAggregate: allOf: - - $ref: '#/components/schemas/_common.aggregations:MultiBucketAggregateBaseRangeBucket' + - $ref: '#/components/schemas/_common.aggregations___MultiBucketAggregateBaseRangeBucket' - type: object - _common.aggregations:RangeAggregation: + _common.aggregations___RangeAggregation: allOf: - - $ref: '#/components/schemas/_common.aggregations:BucketAggregationBase' + - $ref: '#/components/schemas/_common.aggregations___BucketAggregationBase' - type: object properties: field: - $ref: '#/components/schemas/_common:Field' + $ref: '#/components/schemas/_common___Field' missing: description: |- The value to apply to documents that do not have a value. @@ -34883,17 +36586,17 @@ components: description: An array of ranges used to bucket documents. type: array items: - $ref: '#/components/schemas/_common.aggregations:AggregationRange' + $ref: '#/components/schemas/_common.aggregations___AggregationRange' script: - $ref: '#/components/schemas/_common:Script' + $ref: '#/components/schemas/_common___Script' keyed: description: Set to `true` to associate a unique string key with each bucket and return the ranges as a hash rather than an array. type: boolean format: type: string - _common.aggregations:RangeBucket: + _common.aggregations___RangeBucket: allOf: - - $ref: '#/components/schemas/_common.aggregations:MultiBucketBase' + - $ref: '#/components/schemas/_common.aggregations___MultiBucketBase' - type: object properties: from: @@ -34905,24 +36608,24 @@ components: to_as_string: type: string key: - description: The bucket key. Present if the aggregation is _not_ keyed + description: The bucket key. Present if the aggregation is not keyed. type: string - _common.aggregations:RareTermsAggregation: + _common.aggregations___RareTermsAggregation: allOf: - - $ref: '#/components/schemas/_common.aggregations:BucketAggregationBase' + - $ref: '#/components/schemas/_common.aggregations___BucketAggregationBase' - type: object properties: exclude: - $ref: '#/components/schemas/_common.aggregations:TermsExclude' + $ref: '#/components/schemas/_common.aggregations___TermsExclude' field: - $ref: '#/components/schemas/_common:Field' + $ref: '#/components/schemas/_common___Field' include: - $ref: '#/components/schemas/_common.aggregations:TermsInclude' + $ref: '#/components/schemas/_common.aggregations___TermsInclude' max_doc_count: description: The maximum number of documents a term should appear in. type: number missing: - $ref: '#/components/schemas/_common.aggregations:Missing' + $ref: '#/components/schemas/_common.aggregations___Missing' precision: description: |- The precision of the internal CuckooFilters. @@ -34930,9 +36633,9 @@ components: type: number value_type: type: string - _common.aggregations:RateAggregate: + _common.aggregations___RateAggregate: allOf: - - $ref: '#/components/schemas/_common.aggregations:AggregateBase' + - $ref: '#/components/schemas/_common.aggregations___AggregateBase' - type: object properties: value: @@ -34941,84 +36644,84 @@ components: type: string required: - value - _common.aggregations:RateAggregation: + _common.aggregations___RateAggregation: allOf: - - $ref: '#/components/schemas/_common.aggregations:FormatMetricAggregationBase' + - $ref: '#/components/schemas/_common.aggregations___FormatMetricAggregationBase' - type: object properties: unit: - $ref: '#/components/schemas/_common.aggregations:CalendarInterval' + $ref: '#/components/schemas/_common.aggregations___CalendarInterval' mode: - $ref: '#/components/schemas/_common.aggregations:RateMode' - _common.aggregations:RateMode: + $ref: '#/components/schemas/_common.aggregations___RateMode' + _common.aggregations___RateMode: type: string enum: - sum - value_count - _common.aggregations:RegressionInferenceOptions: + _common.aggregations___RegressionInferenceOptions: type: object properties: results_field: - $ref: '#/components/schemas/_common:Field' + $ref: '#/components/schemas/_common___Field' num_top_feature_importance_values: description: Specifies the maximum number of feature importance values per document. type: number - _common.aggregations:ReverseNestedAggregate: + _common.aggregations___ReverseNestedAggregate: allOf: - - $ref: '#/components/schemas/_common.aggregations:SingleBucketAggregateBase' + - $ref: '#/components/schemas/_common.aggregations___SingleBucketAggregateBase' - type: object - _common.aggregations:ReverseNestedAggregation: + _common.aggregations___ReverseNestedAggregation: allOf: - - $ref: '#/components/schemas/_common.aggregations:BucketAggregationBase' + - $ref: '#/components/schemas/_common.aggregations___BucketAggregationBase' - type: object properties: path: - $ref: '#/components/schemas/_common:Field' - _common.aggregations:SamplerAggregate: + $ref: '#/components/schemas/_common___Field' + _common.aggregations___SamplerAggregate: allOf: - - $ref: '#/components/schemas/_common.aggregations:SingleBucketAggregateBase' + - $ref: '#/components/schemas/_common.aggregations___SingleBucketAggregateBase' - type: object - _common.aggregations:SamplerAggregation: + _common.aggregations___SamplerAggregation: allOf: - - $ref: '#/components/schemas/_common.aggregations:BucketAggregationBase' + - $ref: '#/components/schemas/_common.aggregations___BucketAggregationBase' - type: object properties: shard_size: description: Limits how many top-scoring documents are collected in the sample processed on each shard. type: number - _common.aggregations:SamplerAggregationExecutionHint: + _common.aggregations___SamplerAggregationExecutionHint: type: string enum: - bytes_hash - global_ordinals - map - _common.aggregations:ScriptedHeuristic: + _common.aggregations___ScriptedHeuristic: type: object properties: script: - $ref: '#/components/schemas/_common:Script' + $ref: '#/components/schemas/_common___Script' required: - script - _common.aggregations:ScriptedMetricAggregate: + _common.aggregations___ScriptedMetricAggregate: allOf: - - $ref: '#/components/schemas/_common.aggregations:AggregateBase' + - $ref: '#/components/schemas/_common.aggregations___AggregateBase' - type: object properties: value: type: object required: - value - _common.aggregations:ScriptedMetricAggregation: + _common.aggregations___ScriptedMetricAggregation: allOf: - - $ref: '#/components/schemas/_common.aggregations:MetricAggregationBase' + - $ref: '#/components/schemas/_common.aggregations___MetricAggregationBase' - type: object properties: combine_script: - $ref: '#/components/schemas/_common:Script' + $ref: '#/components/schemas/_common___Script' init_script: - $ref: '#/components/schemas/_common:Script' + $ref: '#/components/schemas/_common___Script' map_script: - $ref: '#/components/schemas/_common:Script' + $ref: '#/components/schemas/_common___Script' params: description: |- A global object with script parameters for `init`, `map` and `combine` scripts. @@ -35027,10 +36730,10 @@ components: additionalProperties: type: object reduce_script: - $ref: '#/components/schemas/_common:Script' - _common.aggregations:SerialDifferencingAggregation: + $ref: '#/components/schemas/_common___Script' + _common.aggregations___SerialDifferencingAggregation: allOf: - - $ref: '#/components/schemas/_common.aggregations:PipelineAggregationBase' + - $ref: '#/components/schemas/_common.aggregations___PipelineAggregationBase' - type: object properties: lag: @@ -35038,13 +36741,13 @@ components: The historical bucket to subtract from the current value. Must be a positive, non-zero integer. type: number - _common.aggregations:SignificantLongTermsAggregate: + _common.aggregations___SignificantLongTermsAggregate: allOf: - - $ref: '#/components/schemas/_common.aggregations:SignificantTermsAggregateBaseSignificantLongTermsBucket' + - $ref: '#/components/schemas/_common.aggregations___SignificantTermsAggregateBaseSignificantLongTermsBucket' - type: object - _common.aggregations:SignificantLongTermsBucket: + _common.aggregations___SignificantLongTermsBucket: allOf: - - $ref: '#/components/schemas/_common.aggregations:SignificantTermsBucketBase' + - $ref: '#/components/schemas/_common.aggregations___SignificantTermsBucketBase' - type: object properties: key: @@ -35053,76 +36756,76 @@ components: type: string required: - key - _common.aggregations:SignificantStringTermsAggregate: + _common.aggregations___SignificantStringTermsAggregate: allOf: - - $ref: '#/components/schemas/_common.aggregations:SignificantTermsAggregateBaseSignificantStringTermsBucket' + - $ref: '#/components/schemas/_common.aggregations___SignificantTermsAggregateBaseSignificantStringTermsBucket' - type: object - _common.aggregations:SignificantStringTermsBucket: + _common.aggregations___SignificantStringTermsBucket: allOf: - - $ref: '#/components/schemas/_common.aggregations:SignificantTermsBucketBase' + - $ref: '#/components/schemas/_common.aggregations___SignificantTermsBucketBase' - type: object properties: key: type: string required: - key - _common.aggregations:SignificantTermsAggregateBaseSignificantLongTermsBucket: + _common.aggregations___SignificantTermsAggregateBaseSignificantLongTermsBucket: allOf: - - $ref: '#/components/schemas/_common.aggregations:MultiBucketAggregateBaseSignificantLongTermsBucket' + - $ref: '#/components/schemas/_common.aggregations___MultiBucketAggregateBaseSignificantLongTermsBucket' - type: object properties: bg_count: type: number doc_count: type: number - _common.aggregations:SignificantTermsAggregateBaseSignificantStringTermsBucket: + _common.aggregations___SignificantTermsAggregateBaseSignificantStringTermsBucket: allOf: - - $ref: '#/components/schemas/_common.aggregations:MultiBucketAggregateBaseSignificantStringTermsBucket' + - $ref: '#/components/schemas/_common.aggregations___MultiBucketAggregateBaseSignificantStringTermsBucket' - type: object properties: bg_count: type: number doc_count: type: number - _common.aggregations:SignificantTermsAggregateBaseVoid: + _common.aggregations___SignificantTermsAggregateBaseVoid: allOf: - - $ref: '#/components/schemas/_common.aggregations:MultiBucketAggregateBaseVoid' + - $ref: '#/components/schemas/_common.aggregations___MultiBucketAggregateBaseVoid' - type: object properties: bg_count: type: number doc_count: type: number - _common.aggregations:SignificantTermsAggregation: + _common.aggregations___SignificantTermsAggregation: allOf: - - $ref: '#/components/schemas/_common.aggregations:BucketAggregationBase' + - $ref: '#/components/schemas/_common.aggregations___BucketAggregationBase' - type: object properties: background_filter: - $ref: '#/components/schemas/_common.query_dsl:QueryContainer' + $ref: '#/components/schemas/_common.query_dsl___QueryContainer' chi_square: - $ref: '#/components/schemas/_common.aggregations:ChiSquareHeuristic' + $ref: '#/components/schemas/_common.aggregations___ChiSquareHeuristic' exclude: - $ref: '#/components/schemas/_common.aggregations:TermsExclude' + $ref: '#/components/schemas/_common.aggregations___TermsExclude' execution_hint: - $ref: '#/components/schemas/_common.aggregations:TermsAggregationExecutionHint' + $ref: '#/components/schemas/_common.aggregations___TermsAggregationExecutionHint' field: - $ref: '#/components/schemas/_common:Field' + $ref: '#/components/schemas/_common___Field' gnd: - $ref: '#/components/schemas/_common.aggregations:GoogleNormalizedDistanceHeuristic' + $ref: '#/components/schemas/_common.aggregations___GoogleNormalizedDistanceHeuristic' include: - $ref: '#/components/schemas/_common.aggregations:TermsInclude' + $ref: '#/components/schemas/_common.aggregations___TermsInclude' jlh: - $ref: '#/components/schemas/_common:EmptyObject' + $ref: '#/components/schemas/_common___EmptyObject' min_doc_count: description: Only return terms that are found in more than `min_doc_count` hits. type: number mutual_information: - $ref: '#/components/schemas/_common.aggregations:MutualInformationHeuristic' + $ref: '#/components/schemas/_common.aggregations___MutualInformationHeuristic' percentage: - $ref: '#/components/schemas/_common.aggregations:PercentageScoreHeuristic' + $ref: '#/components/schemas/_common.aggregations___PercentageScoreHeuristic' script_heuristic: - $ref: '#/components/schemas/_common.aggregations:ScriptedHeuristic' + $ref: '#/components/schemas/_common.aggregations___ScriptedHeuristic' shard_min_doc_count: description: |- Regulates the certainty a shard has if the term should actually be added to the candidate list or not with respect to the `min_doc_count`. @@ -35136,9 +36839,9 @@ components: size: description: The number of buckets returned out of the overall terms list. type: number - _common.aggregations:SignificantTermsBucketBase: + _common.aggregations___SignificantTermsBucketBase: allOf: - - $ref: '#/components/schemas/_common.aggregations:MultiBucketBase' + - $ref: '#/components/schemas/_common.aggregations___MultiBucketBase' - type: object properties: score: @@ -35148,42 +36851,42 @@ components: required: - bg_count - score - _common.aggregations:SignificantTextAggregation: + _common.aggregations___SignificantTextAggregation: allOf: - - $ref: '#/components/schemas/_common.aggregations:BucketAggregationBase' + - $ref: '#/components/schemas/_common.aggregations___BucketAggregationBase' - type: object properties: background_filter: - $ref: '#/components/schemas/_common.query_dsl:QueryContainer' + $ref: '#/components/schemas/_common.query_dsl___QueryContainer' chi_square: - $ref: '#/components/schemas/_common.aggregations:ChiSquareHeuristic' + $ref: '#/components/schemas/_common.aggregations___ChiSquareHeuristic' exclude: - $ref: '#/components/schemas/_common.aggregations:TermsExclude' + $ref: '#/components/schemas/_common.aggregations___TermsExclude' execution_hint: - $ref: '#/components/schemas/_common.aggregations:TermsAggregationExecutionHint' + $ref: '#/components/schemas/_common.aggregations___TermsAggregationExecutionHint' field: - $ref: '#/components/schemas/_common:Field' + $ref: '#/components/schemas/_common___Field' filter_duplicate_text: description: Whether to out duplicate text to deal with noisy data. type: boolean gnd: - $ref: '#/components/schemas/_common.aggregations:GoogleNormalizedDistanceHeuristic' + $ref: '#/components/schemas/_common.aggregations___GoogleNormalizedDistanceHeuristic' include: - $ref: '#/components/schemas/_common.aggregations:TermsInclude' + $ref: '#/components/schemas/_common.aggregations___TermsInclude' jlh: - $ref: '#/components/schemas/_common:EmptyObject' + $ref: '#/components/schemas/_common___EmptyObject' min_doc_count: description: Only return values that are found in more than `min_doc_count` hits. type: number mutual_information: - $ref: '#/components/schemas/_common.aggregations:MutualInformationHeuristic' + $ref: '#/components/schemas/_common.aggregations___MutualInformationHeuristic' percentage: - $ref: '#/components/schemas/_common.aggregations:PercentageScoreHeuristic' + $ref: '#/components/schemas/_common.aggregations___PercentageScoreHeuristic' script_heuristic: - $ref: '#/components/schemas/_common.aggregations:ScriptedHeuristic' + $ref: '#/components/schemas/_common.aggregations___ScriptedHeuristic' shard_min_doc_count: description: |- - Regulates the certainty a shard has if the values should actually be added to the candidate list or not with respect to the min_doc_count. + Regulates the certainty a shard has if the values should actually be added to the candidate list or not with respect to the `min_doc_count`. Values will only be considered if their local shard frequency within the set is higher than the `shard_min_doc_count`. type: number shard_size: @@ -35195,10 +36898,10 @@ components: description: The number of buckets returned out of the overall terms list. type: number source_fields: - $ref: '#/components/schemas/_common:Fields' - _common.aggregations:SimpleMovingAverageAggregation: + $ref: '#/components/schemas/_common___Fields' + _common.aggregations___SimpleMovingAverageAggregation: allOf: - - $ref: '#/components/schemas/_common.aggregations:MovingAverageAggregationBase' + - $ref: '#/components/schemas/_common.aggregations___MovingAverageAggregationBase' - type: object properties: model: @@ -35206,26 +36909,26 @@ components: enum: - simple settings: - $ref: '#/components/schemas/_common:EmptyObject' + $ref: '#/components/schemas/_common___EmptyObject' required: - model - settings - _common.aggregations:SimpleValueAggregate: + _common.aggregations___SimpleValueAggregate: allOf: - - $ref: '#/components/schemas/_common.aggregations:SingleMetricAggregateBase' + - $ref: '#/components/schemas/_common.aggregations___SingleMetricAggregateBase' - type: object - _common.aggregations:SingleBucketAggregateBase: + _common.aggregations___SingleBucketAggregateBase: allOf: - - $ref: '#/components/schemas/_common.aggregations:AggregateBase' + - $ref: '#/components/schemas/_common.aggregations___AggregateBase' - type: object properties: doc_count: type: number required: - doc_count - _common.aggregations:SingleMetricAggregateBase: + _common.aggregations___SingleMetricAggregateBase: allOf: - - $ref: '#/components/schemas/_common.aggregations:AggregateBase' + - $ref: '#/components/schemas/_common.aggregations___AggregateBase' - type: object properties: value: @@ -35240,7 +36943,7 @@ components: type: string required: - value - _common.aggregations:StandardDeviationBounds: + _common.aggregations___StandardDeviationBounds: type: object properties: upper: @@ -35280,7 +36983,7 @@ components: - upper - upper_population - upper_sampling - _common.aggregations:StandardDeviationBoundsAsString: + _common.aggregations___StandardDeviationBoundsAsString: type: object properties: upper: @@ -35302,9 +37005,9 @@ components: - upper - upper_population - upper_sampling - _common.aggregations:StatsAggregate: + _common.aggregations___StatsAggregate: allOf: - - $ref: '#/components/schemas/_common.aggregations:AggregateBase' + - $ref: '#/components/schemas/_common.aggregations___AggregateBase' - type: object properties: count: @@ -35340,34 +37043,34 @@ components: - max - min - sum - _common.aggregations:StatsAggregation: + _common.aggregations___StatsAggregation: allOf: - - $ref: '#/components/schemas/_common.aggregations:FormatMetricAggregationBase' + - $ref: '#/components/schemas/_common.aggregations___FormatMetricAggregationBase' - type: object - _common.aggregations:StatsBucketAggregate: + _common.aggregations___StatsBucketAggregate: allOf: - - $ref: '#/components/schemas/_common.aggregations:StatsAggregate' + - $ref: '#/components/schemas/_common.aggregations___StatsAggregate' - type: object - _common.aggregations:StatsBucketAggregation: + _common.aggregations___StatsBucketAggregation: allOf: - - $ref: '#/components/schemas/_common.aggregations:PipelineAggregationBase' + - $ref: '#/components/schemas/_common.aggregations___PipelineAggregationBase' - type: object - _common.aggregations:StringRareTermsAggregate: + _common.aggregations___StringRareTermsAggregate: allOf: - - $ref: '#/components/schemas/_common.aggregations:MultiBucketAggregateBaseStringRareTermsBucket' + - $ref: '#/components/schemas/_common.aggregations___MultiBucketAggregateBaseStringRareTermsBucket' - type: object - _common.aggregations:StringRareTermsBucket: + _common.aggregations___StringRareTermsBucket: allOf: - - $ref: '#/components/schemas/_common.aggregations:MultiBucketBase' + - $ref: '#/components/schemas/_common.aggregations___MultiBucketBase' - type: object properties: key: type: string required: - key - _common.aggregations:StringStatsAggregate: + _common.aggregations___StringStatsAggregate: allOf: - - $ref: '#/components/schemas/_common.aggregations:AggregateBase' + - $ref: '#/components/schemas/_common.aggregations___AggregateBase' - type: object properties: count: @@ -35411,129 +37114,129 @@ components: - entropy - max_length - min_length - _common.aggregations:StringStatsAggregation: + _common.aggregations___StringStatsAggregation: allOf: - - $ref: '#/components/schemas/_common.aggregations:MetricAggregationBase' + - $ref: '#/components/schemas/_common.aggregations___MetricAggregationBase' - type: object properties: show_distribution: description: Shows the probability distribution for all characters. type: boolean - _common.aggregations:StringTermsAggregate: + _common.aggregations___StringTermsAggregate: allOf: - - $ref: '#/components/schemas/_common.aggregations:TermsAggregateBaseStringTermsBucket' + - $ref: '#/components/schemas/_common.aggregations___TermsAggregateBaseStringTermsBucket' - type: object - _common.aggregations:StringTermsBucket: + _common.aggregations___StringTermsBucket: allOf: - - $ref: '#/components/schemas/_common.aggregations:TermsBucketBase' + - $ref: '#/components/schemas/_common.aggregations___TermsBucketBase' - type: object properties: key: - $ref: '#/components/schemas/_common:FieldValue' + $ref: '#/components/schemas/_common___FieldValue' required: - key - _common.aggregations:SumAggregate: + _common.aggregations___SumAggregate: allOf: - - $ref: '#/components/schemas/_common.aggregations:SingleMetricAggregateBase' + - $ref: '#/components/schemas/_common.aggregations___SingleMetricAggregateBase' - type: object - _common.aggregations:SumAggregation: + _common.aggregations___SumAggregation: allOf: - - $ref: '#/components/schemas/_common.aggregations:FormatMetricAggregationBase' + - $ref: '#/components/schemas/_common.aggregations___FormatMetricAggregationBase' - type: object - _common.aggregations:SumBucketAggregation: + _common.aggregations___SumBucketAggregation: allOf: - - $ref: '#/components/schemas/_common.aggregations:PipelineAggregationBase' + - $ref: '#/components/schemas/_common.aggregations___PipelineAggregationBase' - type: object - _common.aggregations:TDigest: + _common.aggregations___TDigest: type: object properties: compression: description: Limits the maximum number of nodes used by the underlying TDigest algorithm to `20 * compression`, enabling control of memory usage and approximation error. type: number - _common.aggregations:TDigestPercentileRanksAggregate: + _common.aggregations___TDigestPercentileRanksAggregate: allOf: - - $ref: '#/components/schemas/_common.aggregations:PercentilesAggregateBase' + - $ref: '#/components/schemas/_common.aggregations___PercentilesAggregateBase' - type: object - _common.aggregations:TDigestPercentilesAggregate: + _common.aggregations___TDigestPercentilesAggregate: allOf: - - $ref: '#/components/schemas/_common.aggregations:PercentilesAggregateBase' + - $ref: '#/components/schemas/_common.aggregations___PercentilesAggregateBase' - type: object - _common.aggregations:TermsAggregateBaseDoubleTermsBucket: + _common.aggregations___TermsAggregateBaseDoubleTermsBucket: allOf: - - $ref: '#/components/schemas/_common.aggregations:MultiBucketAggregateBaseDoubleTermsBucket' + - $ref: '#/components/schemas/_common.aggregations___MultiBucketAggregateBaseDoubleTermsBucket' - type: object properties: doc_count_error_upper_bound: type: number sum_other_doc_count: type: number - _common.aggregations:TermsAggregateBaseLongTermsBucket: + _common.aggregations___TermsAggregateBaseLongTermsBucket: allOf: - - $ref: '#/components/schemas/_common.aggregations:MultiBucketAggregateBaseLongTermsBucket' + - $ref: '#/components/schemas/_common.aggregations___MultiBucketAggregateBaseLongTermsBucket' - type: object properties: doc_count_error_upper_bound: type: number sum_other_doc_count: type: number - _common.aggregations:TermsAggregateBaseMultiTermsBucket: + _common.aggregations___TermsAggregateBaseMultiTermsBucket: allOf: - - $ref: '#/components/schemas/_common.aggregations:MultiBucketAggregateBaseMultiTermsBucket' + - $ref: '#/components/schemas/_common.aggregations___MultiBucketAggregateBaseMultiTermsBucket' - type: object properties: doc_count_error_upper_bound: type: number sum_other_doc_count: type: number - _common.aggregations:TermsAggregateBaseStringTermsBucket: + _common.aggregations___TermsAggregateBaseStringTermsBucket: allOf: - - $ref: '#/components/schemas/_common.aggregations:MultiBucketAggregateBaseStringTermsBucket' + - $ref: '#/components/schemas/_common.aggregations___MultiBucketAggregateBaseStringTermsBucket' - type: object properties: doc_count_error_upper_bound: type: number sum_other_doc_count: type: number - _common.aggregations:TermsAggregateBaseVoid: + _common.aggregations___TermsAggregateBaseVoid: allOf: - - $ref: '#/components/schemas/_common.aggregations:MultiBucketAggregateBaseVoid' + - $ref: '#/components/schemas/_common.aggregations___MultiBucketAggregateBaseVoid' - type: object properties: doc_count_error_upper_bound: type: number sum_other_doc_count: type: number - _common.aggregations:TermsAggregation: + _common.aggregations___TermsAggregation: allOf: - - $ref: '#/components/schemas/_common.aggregations:BucketAggregationBase' + - $ref: '#/components/schemas/_common.aggregations___BucketAggregationBase' - type: object properties: collect_mode: - $ref: '#/components/schemas/_common.aggregations:TermsAggregationCollectMode' + $ref: '#/components/schemas/_common.aggregations___TermsAggregationCollectMode' exclude: - $ref: '#/components/schemas/_common.aggregations:TermsExclude' + $ref: '#/components/schemas/_common.aggregations___TermsExclude' execution_hint: - $ref: '#/components/schemas/_common.aggregations:TermsAggregationExecutionHint' + $ref: '#/components/schemas/_common.aggregations___TermsAggregationExecutionHint' field: - $ref: '#/components/schemas/_common:Field' + $ref: '#/components/schemas/_common___Field' include: - $ref: '#/components/schemas/_common.aggregations:TermsInclude' + $ref: '#/components/schemas/_common.aggregations___TermsInclude' min_doc_count: description: Only return values that are found in more than `min_doc_count` hits. type: number missing: - $ref: '#/components/schemas/_common.aggregations:Missing' + $ref: '#/components/schemas/_common.aggregations___Missing' missing_order: - $ref: '#/components/schemas/_common.aggregations:MissingOrder' + $ref: '#/components/schemas/_common.aggregations___MissingOrder' missing_bucket: type: boolean value_type: description: Coerced unmapped fields into the specified type. type: string order: - $ref: '#/components/schemas/_common.aggregations:AggregateOrder' + $ref: '#/components/schemas/_common.aggregations___AggregateOrder' script: - $ref: '#/components/schemas/_common:Script' + $ref: '#/components/schemas/_common___Script' shard_size: description: |- The number of candidate terms produced by each shard. @@ -35547,39 +37250,39 @@ components: type: number format: type: string - _common.aggregations:TermsAggregationCollectMode: + _common.aggregations___TermsAggregationCollectMode: type: string enum: - breadth_first - depth_first - _common.aggregations:TermsAggregationExecutionHint: + _common.aggregations___TermsAggregationExecutionHint: type: string enum: - global_ordinals - global_ordinals_hash - global_ordinals_low_cardinality - map - _common.aggregations:TermsBucketBase: + _common.aggregations___TermsBucketBase: allOf: - - $ref: '#/components/schemas/_common.aggregations:MultiBucketBase' + - $ref: '#/components/schemas/_common.aggregations___MultiBucketBase' - type: object properties: doc_count_error: type: number - _common.aggregations:TermsExclude: + _common.aggregations___TermsExclude: oneOf: - type: string - type: array items: type: string - _common.aggregations:TermsInclude: + _common.aggregations___TermsInclude: oneOf: - type: string - type: array items: type: string - - $ref: '#/components/schemas/_common.aggregations:TermsPartition' - _common.aggregations:TermsPartition: + - $ref: '#/components/schemas/_common.aggregations___TermsPartition' + _common.aggregations___TermsPartition: type: object properties: num_partitions: @@ -35591,33 +37294,33 @@ components: required: - num_partitions - partition - _common.aggregations:TestPopulation: + _common.aggregations___TestPopulation: type: object properties: field: - $ref: '#/components/schemas/_common:Field' + $ref: '#/components/schemas/_common___Field' script: - $ref: '#/components/schemas/_common:Script' + $ref: '#/components/schemas/_common___Script' filter: - $ref: '#/components/schemas/_common.query_dsl:QueryContainer' + $ref: '#/components/schemas/_common.query_dsl___QueryContainer' required: - field - _common.aggregations:TopHitsAggregate: + _common.aggregations___TopHitsAggregate: allOf: - - $ref: '#/components/schemas/_common.aggregations:AggregateBase' + - $ref: '#/components/schemas/_common.aggregations___AggregateBase' - type: object properties: hits: - $ref: '#/components/schemas/_core.search:HitsMetadata' + $ref: '#/components/schemas/_core.search___HitsMetadata' required: - hits - _common.aggregations:TopHitsAggregation: + _common.aggregations___TopHitsAggregation: allOf: - - $ref: '#/components/schemas/_common.aggregations:MetricAggregationBase' + - $ref: '#/components/schemas/_common.aggregations___MetricAggregationBase' - type: object properties: docvalue_fields: - $ref: '#/components/schemas/_common:Fields' + $ref: '#/components/schemas/_common___Fields' explain: description: If `true`, returns detailed information about score computation as part of a hit. type: boolean @@ -35625,21 +37328,21 @@ components: description: Starting document offset. type: number highlight: - $ref: '#/components/schemas/_core.search:Highlight' + $ref: '#/components/schemas/_core.search___Highlight' script_fields: description: Returns the result of one or more script evaluations for each hit. type: object additionalProperties: - $ref: '#/components/schemas/_common:ScriptField' + $ref: '#/components/schemas/_common___ScriptField' size: description: The maximum number of top matching hits to return per bucket. type: number sort: - $ref: '#/components/schemas/_common:Sort' + $ref: '#/components/schemas/_common___Sort' _source: - $ref: '#/components/schemas/_core.search:SourceConfig' + $ref: '#/components/schemas/_core.search___SourceConfig' stored_fields: - $ref: '#/components/schemas/_common:Fields' + $ref: '#/components/schemas/_common___Fields' track_scores: description: If `true`, calculates and returns document scores, even if the scores are not used for sorting. type: boolean @@ -35649,58 +37352,58 @@ components: seq_no_primary_term: description: If `true`, returns sequence number and primary term of the last modification of each hit. type: boolean - _common.aggregations:TopMetrics: + _common.aggregations___TopMetrics: type: object properties: sort: type: array items: - $ref: '#/components/schemas/_common:FieldValue' + $ref: '#/components/schemas/_common___FieldValue' metrics: type: object additionalProperties: - $ref: '#/components/schemas/_common:FieldValue' + $ref: '#/components/schemas/_common___FieldValue' required: - metrics - sort - _common.aggregations:TopMetricsAggregate: + _common.aggregations___TopMetricsAggregate: allOf: - - $ref: '#/components/schemas/_common.aggregations:AggregateBase' + - $ref: '#/components/schemas/_common.aggregations___AggregateBase' - type: object properties: top: type: array items: - $ref: '#/components/schemas/_common.aggregations:TopMetrics' + $ref: '#/components/schemas/_common.aggregations___TopMetrics' required: - top - _common.aggregations:TopMetricsAggregation: + _common.aggregations___TopMetricsAggregation: allOf: - - $ref: '#/components/schemas/_common.aggregations:MetricAggregationBase' + - $ref: '#/components/schemas/_common.aggregations___MetricAggregationBase' - type: object properties: metrics: description: The fields of the top document to return. oneOf: - - $ref: '#/components/schemas/_common.aggregations:TopMetricsValue' + - $ref: '#/components/schemas/_common.aggregations___TopMetricsValue' - type: array items: - $ref: '#/components/schemas/_common.aggregations:TopMetricsValue' + $ref: '#/components/schemas/_common.aggregations___TopMetricsValue' size: description: The number of top documents from which to return metrics. type: number sort: - $ref: '#/components/schemas/_common:Sort' - _common.aggregations:TopMetricsValue: + $ref: '#/components/schemas/_common___Sort' + _common.aggregations___TopMetricsValue: type: object properties: field: - $ref: '#/components/schemas/_common:Field' + $ref: '#/components/schemas/_common___Field' required: - field - _common.aggregations:TTestAggregate: + _common.aggregations___TTestAggregate: allOf: - - $ref: '#/components/schemas/_common.aggregations:AggregateBase' + - $ref: '#/components/schemas/_common.aggregations___AggregateBase' - type: object properties: value: @@ -35712,48 +37415,48 @@ components: type: string required: - value - _common.aggregations:TTestAggregation: + _common.aggregations___TTestAggregation: allOf: - - $ref: '#/components/schemas/_common.aggregations:Aggregation' + - $ref: '#/components/schemas/_common.aggregations___Aggregation' - type: object properties: a: - $ref: '#/components/schemas/_common.aggregations:TestPopulation' + $ref: '#/components/schemas/_common.aggregations___TestPopulation' b: - $ref: '#/components/schemas/_common.aggregations:TestPopulation' + $ref: '#/components/schemas/_common.aggregations___TestPopulation' type: - $ref: '#/components/schemas/_common.aggregations:TTestType' - _common.aggregations:TTestType: + $ref: '#/components/schemas/_common.aggregations___TTestType' + _common.aggregations___TTestType: type: string enum: - heteroscedastic - homoscedastic - paired - _common.aggregations:UnmappedRareTermsAggregate: + _common.aggregations___UnmappedRareTermsAggregate: allOf: - - $ref: '#/components/schemas/_common.aggregations:MultiBucketAggregateBaseVoid' + - $ref: '#/components/schemas/_common.aggregations___MultiBucketAggregateBaseVoid' - type: object - _common.aggregations:UnmappedSamplerAggregate: + _common.aggregations___UnmappedSamplerAggregate: allOf: - - $ref: '#/components/schemas/_common.aggregations:SingleBucketAggregateBase' + - $ref: '#/components/schemas/_common.aggregations___SingleBucketAggregateBase' - type: object - _common.aggregations:UnmappedSignificantTermsAggregate: + _common.aggregations___UnmappedSignificantTermsAggregate: allOf: - - $ref: '#/components/schemas/_common.aggregations:SignificantTermsAggregateBaseVoid' + - $ref: '#/components/schemas/_common.aggregations___SignificantTermsAggregateBaseVoid' - type: object - _common.aggregations:UnmappedTermsAggregate: + _common.aggregations___UnmappedTermsAggregate: allOf: - - $ref: '#/components/schemas/_common.aggregations:TermsAggregateBaseVoid' + - $ref: '#/components/schemas/_common.aggregations___TermsAggregateBaseVoid' - type: object - _common.aggregations:ValueCountAggregate: + _common.aggregations___ValueCountAggregate: allOf: - - $ref: '#/components/schemas/_common.aggregations:SingleMetricAggregateBase' + - $ref: '#/components/schemas/_common.aggregations___SingleMetricAggregateBase' - type: object - _common.aggregations:ValueCountAggregation: + _common.aggregations___ValueCountAggregation: allOf: - - $ref: '#/components/schemas/_common.aggregations:FormattableMetricAggregation' + - $ref: '#/components/schemas/_common.aggregations___FormattableMetricAggregation' - type: object - _common.aggregations:ValueType: + _common.aggregations___ValueType: type: string enum: - boolean @@ -35766,15 +37469,15 @@ components: - number - numeric - string - _common.aggregations:VariableWidthHistogramAggregate: + _common.aggregations___VariableWidthHistogramAggregate: allOf: - - $ref: '#/components/schemas/_common.aggregations:MultiBucketAggregateBaseVariableWidthHistogramBucket' + - $ref: '#/components/schemas/_common.aggregations___MultiBucketAggregateBaseVariableWidthHistogramBucket' - type: object - _common.aggregations:VariableWidthHistogramAggregation: + _common.aggregations___VariableWidthHistogramAggregation: type: object properties: field: - $ref: '#/components/schemas/_common:Field' + $ref: '#/components/schemas/_common___Field' buckets: description: The target number of buckets. type: number @@ -35788,9 +37491,9 @@ components: Specifies the number of individual documents that will be stored in memory on a shard before the initial bucketing algorithm is run. Defaults to `min(10 * shard_size, 50000)`. type: number - _common.aggregations:VariableWidthHistogramBucket: + _common.aggregations___VariableWidthHistogramBucket: allOf: - - $ref: '#/components/schemas/_common.aggregations:MultiBucketBase' + - $ref: '#/components/schemas/_common.aggregations___MultiBucketBase' - type: object properties: min: @@ -35809,58 +37512,59 @@ components: - key - max - min - _common.aggregations:WeightedAverageAggregation: + _common.aggregations___WeightedAverageAggregation: allOf: - - $ref: '#/components/schemas/_common.aggregations:Aggregation' + - $ref: '#/components/schemas/_common.aggregations___Aggregation' - type: object properties: format: description: A numeric response formatter. type: string value: - $ref: '#/components/schemas/_common.aggregations:WeightedAverageValue' + $ref: '#/components/schemas/_common.aggregations___WeightedAverageValue' value_type: - $ref: '#/components/schemas/_common.aggregations:ValueType' + $ref: '#/components/schemas/_common.aggregations___ValueType' weight: - $ref: '#/components/schemas/_common.aggregations:WeightedAverageValue' - _common.aggregations:WeightedAverageValue: + $ref: '#/components/schemas/_common.aggregations___WeightedAverageValue' + _common.aggregations___WeightedAverageValue: type: object properties: field: - $ref: '#/components/schemas/_common:Field' + $ref: '#/components/schemas/_common___Field' missing: description: A value or weight to use if the field is missing. type: number script: - $ref: '#/components/schemas/_common:Script' - _common.aggregations:WeightedAvgAggregate: + $ref: '#/components/schemas/_common___Script' + _common.aggregations___WeightedAvgAggregate: allOf: - - $ref: '#/components/schemas/_common.aggregations:SingleMetricAggregateBase' + - $ref: '#/components/schemas/_common.aggregations___SingleMetricAggregateBase' - type: object - _common.analysis:Analyzer: + _common.analysis___Analyzer: type: object discriminator: propertyName: type oneOf: - - $ref: '#/components/schemas/_common.analysis:CustomAnalyzer' - - $ref: '#/components/schemas/_common.analysis:FingerprintAnalyzer' - - $ref: '#/components/schemas/_common.analysis:KeywordAnalyzer' - - $ref: '#/components/schemas/_common.analysis:LanguageAnalyzer' - - $ref: '#/components/schemas/_common.analysis:NoriAnalyzer' - - $ref: '#/components/schemas/_common.analysis:PatternAnalyzer' - - $ref: '#/components/schemas/_common.analysis:SimpleAnalyzer' - - $ref: '#/components/schemas/_common.analysis:StandardAnalyzer' - - $ref: '#/components/schemas/_common.analysis:StopAnalyzer' - - $ref: '#/components/schemas/_common.analysis:WhitespaceAnalyzer' - - $ref: '#/components/schemas/_common.analysis:IcuAnalyzer' - - $ref: '#/components/schemas/_common.analysis:KuromojiAnalyzer' - - $ref: '#/components/schemas/_common.analysis:SnowballAnalyzer' - - $ref: '#/components/schemas/_common.analysis:DutchAnalyzer' - - $ref: '#/components/schemas/_common.analysis:SmartcnAnalyzer' - - $ref: '#/components/schemas/_common.analysis:CjkAnalyzer' - _common.analysis:AsciiFoldingTokenFilter: - allOf: - - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' + - $ref: '#/components/schemas/_common.analysis___CustomAnalyzer' + - $ref: '#/components/schemas/_common.analysis___FingerprintAnalyzer' + - $ref: '#/components/schemas/_common.analysis___KeywordAnalyzer' + - $ref: '#/components/schemas/_common.analysis___LanguageAnalyzer' + - $ref: '#/components/schemas/_common.analysis___NoriAnalyzer' + - $ref: '#/components/schemas/_common.analysis___PatternAnalyzer' + - $ref: '#/components/schemas/_common.analysis___SimpleAnalyzer' + - $ref: '#/components/schemas/_common.analysis___StandardAnalyzer' + - $ref: '#/components/schemas/_common.analysis___StopAnalyzer' + - $ref: '#/components/schemas/_common.analysis___WhitespaceAnalyzer' + - $ref: '#/components/schemas/_common.analysis___IcuAnalyzer' + - $ref: '#/components/schemas/_common.analysis___KuromojiAnalyzer' + - $ref: '#/components/schemas/_common.analysis___SnowballAnalyzer' + - $ref: '#/components/schemas/_common.analysis___DutchAnalyzer' + - $ref: '#/components/schemas/_common.analysis___SmartcnAnalyzer' + - $ref: '#/components/schemas/_common.analysis___CjkAnalyzer' + - $ref: '#/components/schemas/_common.analysis___PhoneAnalyzer' + _common.analysis___AsciiFoldingTokenFilter: + allOf: + - $ref: '#/components/schemas/_common.analysis___TokenFilterBase' - type: object properties: type: @@ -35868,33 +37572,33 @@ components: enum: - asciifolding preserve_original: - $ref: '#/components/schemas/_common:Stringifiedboolean' + $ref: '#/components/schemas/_common___StringifiedBoolean' required: - type - _common.analysis:CharFilter: + _common.analysis___CharFilter: oneOf: - title: name type: string - title: definition - $ref: '#/components/schemas/_common.analysis:CharFilterDefinition' - _common.analysis:CharFilterBase: + $ref: '#/components/schemas/_common.analysis___CharFilterDefinition' + _common.analysis___CharFilterBase: type: object properties: version: - $ref: '#/components/schemas/_common:VersionString' - _common.analysis:CharFilterDefinition: + $ref: '#/components/schemas/_common___VersionString' + _common.analysis___CharFilterDefinition: type: object discriminator: propertyName: type oneOf: - - $ref: '#/components/schemas/_common.analysis:HtmlStripCharFilter' - - $ref: '#/components/schemas/_common.analysis:MappingCharFilter' - - $ref: '#/components/schemas/_common.analysis:PatternReplaceCharFilter' - - $ref: '#/components/schemas/_common.analysis:IcuNormalizationCharFilter' - - $ref: '#/components/schemas/_common.analysis:KuromojiIterationMarkCharFilter' - _common.analysis:CharGroupTokenizer: + - $ref: '#/components/schemas/_common.analysis___HtmlStripCharFilter' + - $ref: '#/components/schemas/_common.analysis___MappingCharFilter' + - $ref: '#/components/schemas/_common.analysis___PatternReplaceCharFilter' + - $ref: '#/components/schemas/_common.analysis___IcuNormalizationCharFilter' + - $ref: '#/components/schemas/_common.analysis___KuromojiIterationMarkCharFilter' + _common.analysis___CharGroupTokenizer: allOf: - - $ref: '#/components/schemas/_common.analysis:TokenizerBase' + - $ref: '#/components/schemas/_common.analysis___TokenizerBase' - type: object properties: type: @@ -35910,7 +37614,7 @@ components: required: - tokenize_on_chars - type - _common.analysis:CjkAnalyzer: + _common.analysis___CjkAnalyzer: type: object properties: type: @@ -35918,12 +37622,12 @@ components: enum: - cjk stopwords: - $ref: '#/components/schemas/_common.analysis:StopWords' + $ref: '#/components/schemas/_common.analysis___StopWords' stopwords_path: type: string - _common.analysis:CommonGramsTokenFilter: + _common.analysis___CommonGramsTokenFilter: allOf: - - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' + - $ref: '#/components/schemas/_common.analysis___TokenFilterBase' - type: object properties: type: @@ -35942,9 +37646,9 @@ components: type: boolean required: - type - _common.analysis:CompoundWordTokenFilterBase: + _common.analysis___CompoundWordTokenFilterBase: allOf: - - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' + - $ref: '#/components/schemas/_common.analysis___TokenFilterBase' - type: object properties: hyphenation_patterns_path: @@ -35963,9 +37667,9 @@ components: type: string word_list_path: type: string - _common.analysis:ConditionTokenFilter: + _common.analysis___ConditionTokenFilter: allOf: - - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' + - $ref: '#/components/schemas/_common.analysis___TokenFilterBase' - type: object properties: type: @@ -35977,12 +37681,12 @@ components: items: type: string script: - $ref: '#/components/schemas/_common:Script' + $ref: '#/components/schemas/_common___Script' required: - filter - script - type - _common.analysis:CustomAnalyzer: + _common.analysis___CustomAnalyzer: type: object properties: type: @@ -36006,7 +37710,7 @@ components: required: - tokenizer - type - _common.analysis:CustomNormalizer: + _common.analysis___CustomNormalizer: type: object properties: type: @@ -36023,15 +37727,15 @@ components: type: string required: - type - _common.analysis:DelimitedPayloadEncoding: + _common.analysis___DelimitedPayloadEncoding: type: string enum: - float - identity - int - _common.analysis:DelimitedPayloadTokenFilter: + _common.analysis___DelimitedPayloadTokenFilter: allOf: - - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' + - $ref: '#/components/schemas/_common.analysis___TokenFilterBase' - type: object properties: type: @@ -36041,12 +37745,12 @@ components: delimiter: type: string encoding: - $ref: '#/components/schemas/_common.analysis:DelimitedPayloadEncoding' + $ref: '#/components/schemas/_common.analysis___DelimitedPayloadEncoding' required: - type - _common.analysis:DictionaryDecompounderTokenFilter: + _common.analysis___DictionaryDecompounderTokenFilter: allOf: - - $ref: '#/components/schemas/_common.analysis:CompoundWordTokenFilterBase' + - $ref: '#/components/schemas/_common.analysis___CompoundWordTokenFilterBase' - type: object properties: type: @@ -36055,7 +37759,7 @@ components: - dictionary_decompounder required: - type - _common.analysis:DutchAnalyzer: + _common.analysis___DutchAnalyzer: type: object properties: type: @@ -36063,17 +37767,17 @@ components: enum: - dutch stopwords: - $ref: '#/components/schemas/_common.analysis:StopWords' + $ref: '#/components/schemas/_common.analysis___StopWords' required: - type - _common.analysis:EdgeNGramSide: + _common.analysis___EdgeNGramSide: type: string enum: - back - front - _common.analysis:EdgeNGramTokenFilter: + _common.analysis___EdgeNGramTokenFilter: allOf: - - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' + - $ref: '#/components/schemas/_common.analysis___TokenFilterBase' - type: object properties: type: @@ -36085,14 +37789,14 @@ components: min_gram: type: integer side: - $ref: '#/components/schemas/_common.analysis:EdgeNGramSide' + $ref: '#/components/schemas/_common.analysis___EdgeNGramSide' preserve_original: - $ref: '#/components/schemas/_common:Stringifiedboolean' + $ref: '#/components/schemas/_common___StringifiedBoolean' required: - type - _common.analysis:EdgeNGramTokenizer: + _common.analysis___EdgeNGramTokenizer: allOf: - - $ref: '#/components/schemas/_common.analysis:TokenizerBase' + - $ref: '#/components/schemas/_common.analysis___TokenizerBase' - type: object properties: type: @@ -36108,15 +37812,15 @@ components: token_chars: type: array items: - $ref: '#/components/schemas/_common.analysis:TokenChar' + $ref: '#/components/schemas/_common.analysis___TokenChar' required: - max_gram - min_gram - token_chars - type - _common.analysis:ElisionTokenFilter: + _common.analysis___ElisionTokenFilter: allOf: - - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' + - $ref: '#/components/schemas/_common.analysis___TokenFilterBase' - type: object properties: type: @@ -36130,10 +37834,10 @@ components: articles_path: type: string articles_case: - $ref: '#/components/schemas/_common:Stringifiedboolean' + $ref: '#/components/schemas/_common___StringifiedBoolean' required: - type - _common.analysis:FingerprintAnalyzer: + _common.analysis___FingerprintAnalyzer: type: object properties: type: @@ -36141,7 +37845,7 @@ components: enum: - fingerprint version: - $ref: '#/components/schemas/_common:VersionString' + $ref: '#/components/schemas/_common___VersionString' max_output_size: type: integer preserve_original: @@ -36149,7 +37853,7 @@ components: separator: type: string stopwords: - $ref: '#/components/schemas/_common.analysis:StopWords' + $ref: '#/components/schemas/_common.analysis___StopWords' stopwords_path: type: string required: @@ -36157,9 +37861,9 @@ components: - preserve_original - separator - type - _common.analysis:FingerprintTokenFilter: + _common.analysis___FingerprintTokenFilter: allOf: - - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' + - $ref: '#/components/schemas/_common.analysis___TokenFilterBase' - type: object properties: type: @@ -36172,9 +37876,9 @@ components: type: string required: - type - _common.analysis:HtmlStripCharFilter: + _common.analysis___HtmlStripCharFilter: allOf: - - $ref: '#/components/schemas/_common.analysis:CharFilterBase' + - $ref: '#/components/schemas/_common.analysis___CharFilterBase' - type: object properties: type: @@ -36183,9 +37887,9 @@ components: - html_strip required: - type - _common.analysis:HunspellTokenFilter: + _common.analysis___HunspellTokenFilter: allOf: - - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' + - $ref: '#/components/schemas/_common.analysis___TokenFilterBase' - type: object properties: type: @@ -36203,9 +37907,9 @@ components: required: - locale - type - _common.analysis:HyphenationDecompounderTokenFilter: + _common.analysis___HyphenationDecompounderTokenFilter: allOf: - - $ref: '#/components/schemas/_common.analysis:CompoundWordTokenFilterBase' + - $ref: '#/components/schemas/_common.analysis___CompoundWordTokenFilterBase' - type: object properties: type: @@ -36214,7 +37918,7 @@ components: - hyphenation_decompounder required: - type - _common.analysis:IcuAnalyzer: + _common.analysis___IcuAnalyzer: type: object properties: type: @@ -36222,29 +37926,29 @@ components: enum: - icu_analyzer method: - $ref: '#/components/schemas/_common.analysis:IcuNormalizationType' + $ref: '#/components/schemas/_common.analysis___IcuNormalizationType' mode: - $ref: '#/components/schemas/_common.analysis:IcuNormalizationMode' + $ref: '#/components/schemas/_common.analysis___IcuNormalizationMode' required: - method - mode - type - _common.analysis:IcuCollationAlternate: + _common.analysis___IcuCollationAlternate: type: string enum: - non-ignorable - shifted - _common.analysis:IcuCollationCaseFirst: + _common.analysis___IcuCollationCaseFirst: type: string enum: - lower - upper - _common.analysis:IcuCollationDecomposition: + _common.analysis___IcuCollationDecomposition: type: string enum: - canonical - 'no' - _common.analysis:IcuCollationStrength: + _common.analysis___IcuCollationStrength: type: string enum: - identical @@ -36252,9 +37956,9 @@ components: - quaternary - secondary - tertiary - _common.analysis:IcuCollationTokenFilter: + _common.analysis___IcuCollationTokenFilter: allOf: - - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' + - $ref: '#/components/schemas/_common.analysis___TokenFilterBase' - type: object properties: type: @@ -36262,15 +37966,15 @@ components: enum: - icu_collation alternate: - $ref: '#/components/schemas/_common.analysis:IcuCollationAlternate' + $ref: '#/components/schemas/_common.analysis___IcuCollationAlternate' caseFirst: - $ref: '#/components/schemas/_common.analysis:IcuCollationCaseFirst' + $ref: '#/components/schemas/_common.analysis___IcuCollationCaseFirst' caseLevel: type: boolean country: type: string decomposition: - $ref: '#/components/schemas/_common.analysis:IcuCollationDecomposition' + $ref: '#/components/schemas/_common.analysis___IcuCollationDecomposition' hiraganaQuaternaryMode: type: boolean language: @@ -36280,16 +37984,16 @@ components: rules: type: string strength: - $ref: '#/components/schemas/_common.analysis:IcuCollationStrength' + $ref: '#/components/schemas/_common.analysis___IcuCollationStrength' variableTop: type: string variant: type: string required: - type - _common.analysis:IcuFoldingTokenFilter: + _common.analysis___IcuFoldingTokenFilter: allOf: - - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' + - $ref: '#/components/schemas/_common.analysis___TokenFilterBase' - type: object properties: type: @@ -36301,9 +38005,9 @@ components: required: - type - unicode_set_filter - _common.analysis:IcuNormalizationCharFilter: + _common.analysis___IcuNormalizationCharFilter: allOf: - - $ref: '#/components/schemas/_common.analysis:CharFilterBase' + - $ref: '#/components/schemas/_common.analysis___CharFilterBase' - type: object properties: type: @@ -36311,19 +38015,19 @@ components: enum: - icu_normalizer mode: - $ref: '#/components/schemas/_common.analysis:IcuNormalizationMode' + $ref: '#/components/schemas/_common.analysis___IcuNormalizationMode' name: - $ref: '#/components/schemas/_common.analysis:IcuNormalizationType' + $ref: '#/components/schemas/_common.analysis___IcuNormalizationType' required: - type - _common.analysis:IcuNormalizationMode: + _common.analysis___IcuNormalizationMode: type: string enum: - compose - decompose - _common.analysis:IcuNormalizationTokenFilter: + _common.analysis___IcuNormalizationTokenFilter: allOf: - - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' + - $ref: '#/components/schemas/_common.analysis___TokenFilterBase' - type: object properties: type: @@ -36331,19 +38035,19 @@ components: enum: - icu_normalizer name: - $ref: '#/components/schemas/_common.analysis:IcuNormalizationType' + $ref: '#/components/schemas/_common.analysis___IcuNormalizationType' required: - name - type - _common.analysis:IcuNormalizationType: + _common.analysis___IcuNormalizationType: type: string enum: - nfc - nfkc - nfkc_cf - _common.analysis:IcuTokenizer: + _common.analysis___IcuTokenizer: allOf: - - $ref: '#/components/schemas/_common.analysis:TokenizerBase' + - $ref: '#/components/schemas/_common.analysis___TokenizerBase' - type: object properties: type: @@ -36355,14 +38059,14 @@ components: required: - rule_files - type - _common.analysis:IcuTransformDirection: + _common.analysis___IcuTransformDirection: type: string enum: - forward - reverse - _common.analysis:IcuTransformTokenFilter: + _common.analysis___IcuTransformTokenFilter: allOf: - - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' + - $ref: '#/components/schemas/_common.analysis___TokenFilterBase' - type: object properties: type: @@ -36370,20 +38074,20 @@ components: enum: - icu_transform dir: - $ref: '#/components/schemas/_common.analysis:IcuTransformDirection' + $ref: '#/components/schemas/_common.analysis___IcuTransformDirection' id: type: string required: - id - type - _common.analysis:KeepTypesMode: + _common.analysis___KeepTypesMode: type: string enum: - exclude - include - _common.analysis:KeepTypesTokenFilter: + _common.analysis___KeepTypesTokenFilter: allOf: - - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' + - $ref: '#/components/schemas/_common.analysis___TokenFilterBase' - type: object properties: type: @@ -36391,16 +38095,16 @@ components: enum: - keep_types mode: - $ref: '#/components/schemas/_common.analysis:KeepTypesMode' + $ref: '#/components/schemas/_common.analysis___KeepTypesMode' types: type: array items: type: string required: - type - _common.analysis:KeepWordsTokenFilter: + _common.analysis___KeepWordsTokenFilter: allOf: - - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' + - $ref: '#/components/schemas/_common.analysis___TokenFilterBase' - type: object properties: type: @@ -36417,7 +38121,7 @@ components: type: string required: - type - _common.analysis:KeywordAnalyzer: + _common.analysis___KeywordAnalyzer: type: object properties: type: @@ -36425,12 +38129,12 @@ components: enum: - keyword version: - $ref: '#/components/schemas/_common:VersionString' + $ref: '#/components/schemas/_common___VersionString' required: - type - _common.analysis:KeywordMarkerTokenFilter: + _common.analysis___KeywordMarkerTokenFilter: allOf: - - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' + - $ref: '#/components/schemas/_common.analysis___TokenFilterBase' - type: object properties: type: @@ -36449,9 +38153,9 @@ components: type: string required: - type - _common.analysis:KeywordTokenizer: + _common.analysis___KeywordTokenizer: allOf: - - $ref: '#/components/schemas/_common.analysis:TokenizerBase' + - $ref: '#/components/schemas/_common.analysis___TokenizerBase' - type: object properties: type: @@ -36463,9 +38167,9 @@ components: required: - buffer_size - type - _common.analysis:KStemTokenFilter: + _common.analysis___KStemTokenFilter: allOf: - - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' + - $ref: '#/components/schemas/_common.analysis___TokenFilterBase' - type: object properties: type: @@ -36474,7 +38178,7 @@ components: - kstem required: - type - _common.analysis:KuromojiAnalyzer: + _common.analysis___KuromojiAnalyzer: type: object properties: type: @@ -36482,15 +38186,15 @@ components: enum: - kuromoji mode: - $ref: '#/components/schemas/_common.analysis:KuromojiTokenizationMode' + $ref: '#/components/schemas/_common.analysis___KuromojiTokenizationMode' user_dictionary: type: string required: - mode - type - _common.analysis:KuromojiIterationMarkCharFilter: + _common.analysis___KuromojiIterationMarkCharFilter: allOf: - - $ref: '#/components/schemas/_common.analysis:CharFilterBase' + - $ref: '#/components/schemas/_common.analysis___CharFilterBase' - type: object properties: type: @@ -36505,9 +38209,9 @@ components: - normalize_kana - normalize_kanji - type - _common.analysis:KuromojiPartOfSpeechTokenFilter: + _common.analysis___KuromojiPartOfSpeechTokenFilter: allOf: - - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' + - $ref: '#/components/schemas/_common.analysis___TokenFilterBase' - type: object properties: type: @@ -36521,9 +38225,9 @@ components: required: - stoptags - type - _common.analysis:KuromojiReadingFormTokenFilter: + _common.analysis___KuromojiReadingFormTokenFilter: allOf: - - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' + - $ref: '#/components/schemas/_common.analysis___TokenFilterBase' - type: object properties: type: @@ -36535,9 +38239,9 @@ components: required: - type - use_romaji - _common.analysis:KuromojiStemmerTokenFilter: + _common.analysis___KuromojiStemmerTokenFilter: allOf: - - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' + - $ref: '#/components/schemas/_common.analysis___TokenFilterBase' - type: object properties: type: @@ -36549,15 +38253,15 @@ components: required: - minimum_length - type - _common.analysis:KuromojiTokenizationMode: + _common.analysis___KuromojiTokenizationMode: type: string enum: - extended - normal - search - _common.analysis:KuromojiTokenizer: + _common.analysis___KuromojiTokenizer: allOf: - - $ref: '#/components/schemas/_common.analysis:TokenizerBase' + - $ref: '#/components/schemas/_common.analysis___TokenizerBase' - type: object properties: type: @@ -36567,7 +38271,7 @@ components: discard_punctuation: type: boolean mode: - $ref: '#/components/schemas/_common.analysis:KuromojiTokenizationMode' + $ref: '#/components/schemas/_common.analysis___KuromojiTokenizationMode' nbest_cost: type: integer nbest_examples: @@ -36583,7 +38287,7 @@ components: required: - mode - type - _common.analysis:Language: + _common.analysis___Language: type: string enum: - Arabic @@ -36620,7 +38324,7 @@ components: - Swedish - Thai - Turkish - _common.analysis:LanguageAnalyzer: + _common.analysis___LanguageAnalyzer: type: object properties: type: @@ -36628,24 +38332,24 @@ components: enum: - language version: - $ref: '#/components/schemas/_common:VersionString' + $ref: '#/components/schemas/_common___VersionString' language: - $ref: '#/components/schemas/_common.analysis:Language' + $ref: '#/components/schemas/_common.analysis___Language' stem_exclusion: type: array items: type: string stopwords: - $ref: '#/components/schemas/_common.analysis:StopWords' + $ref: '#/components/schemas/_common.analysis___StopWords' stopwords_path: type: string required: - language - stem_exclusion - type - _common.analysis:LengthTokenFilter: + _common.analysis___LengthTokenFilter: allOf: - - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' + - $ref: '#/components/schemas/_common.analysis___TokenFilterBase' - type: object properties: type: @@ -36658,9 +38362,9 @@ components: type: integer required: - type - _common.analysis:LetterTokenizer: + _common.analysis___LetterTokenizer: allOf: - - $ref: '#/components/schemas/_common.analysis:TokenizerBase' + - $ref: '#/components/schemas/_common.analysis___TokenizerBase' - type: object properties: type: @@ -36669,9 +38373,9 @@ components: - letter required: - type - _common.analysis:LimitTokenCountTokenFilter: + _common.analysis___LimitTokenCountTokenFilter: allOf: - - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' + - $ref: '#/components/schemas/_common.analysis___TokenFilterBase' - type: object properties: type: @@ -36681,10 +38385,10 @@ components: consume_all_tokens: type: boolean max_token_count: - $ref: '#/components/schemas/_common:Stringifiedinteger' + $ref: '#/components/schemas/_common___StringifiedInteger' required: - type - _common.analysis:LowercaseNormalizer: + _common.analysis___LowercaseNormalizer: type: object properties: type: @@ -36693,9 +38397,9 @@ components: - lowercase required: - type - _common.analysis:LowercaseTokenFilter: + _common.analysis___LowercaseTokenFilter: allOf: - - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' + - $ref: '#/components/schemas/_common.analysis___TokenFilterBase' - type: object properties: type: @@ -36706,9 +38410,9 @@ components: type: string required: - type - _common.analysis:LowercaseTokenizer: + _common.analysis___LowercaseTokenizer: allOf: - - $ref: '#/components/schemas/_common.analysis:TokenizerBase' + - $ref: '#/components/schemas/_common.analysis___TokenizerBase' - type: object properties: type: @@ -36717,9 +38421,9 @@ components: - lowercase required: - type - _common.analysis:MappingCharFilter: + _common.analysis___MappingCharFilter: allOf: - - $ref: '#/components/schemas/_common.analysis:CharFilterBase' + - $ref: '#/components/schemas/_common.analysis___CharFilterBase' - type: object properties: type: @@ -36734,9 +38438,9 @@ components: type: string required: - type - _common.analysis:MultiplexerTokenFilter: + _common.analysis___MultiplexerTokenFilter: allOf: - - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' + - $ref: '#/components/schemas/_common.analysis___TokenFilterBase' - type: object properties: type: @@ -36748,13 +38452,13 @@ components: items: type: string preserve_original: - $ref: '#/components/schemas/_common:Stringifiedboolean' + $ref: '#/components/schemas/_common___StringifiedBoolean' required: - filters - type - _common.analysis:NGramTokenFilter: + _common.analysis___NGramTokenFilter: allOf: - - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' + - $ref: '#/components/schemas/_common.analysis___TokenFilterBase' - type: object properties: type: @@ -36766,12 +38470,12 @@ components: min_gram: type: integer preserve_original: - $ref: '#/components/schemas/_common:Stringifiedboolean' + $ref: '#/components/schemas/_common___StringifiedBoolean' required: - type - _common.analysis:NGramTokenizer: + _common.analysis___NGramTokenizer: allOf: - - $ref: '#/components/schemas/_common.analysis:TokenizerBase' + - $ref: '#/components/schemas/_common.analysis___TokenizerBase' - type: object properties: type: @@ -36787,13 +38491,13 @@ components: token_chars: type: array items: - $ref: '#/components/schemas/_common.analysis:TokenChar' + $ref: '#/components/schemas/_common.analysis___TokenChar' required: - max_gram - min_gram - token_chars - type - _common.analysis:NoriAnalyzer: + _common.analysis___NoriAnalyzer: type: object properties: type: @@ -36801,9 +38505,9 @@ components: enum: - nori version: - $ref: '#/components/schemas/_common:VersionString' + $ref: '#/components/schemas/_common___VersionString' decompound_mode: - $ref: '#/components/schemas/_common.analysis:NoriDecompoundMode' + $ref: '#/components/schemas/_common.analysis___NoriDecompoundMode' stoptags: type: array items: @@ -36812,15 +38516,15 @@ components: type: string required: - type - _common.analysis:NoriDecompoundMode: + _common.analysis___NoriDecompoundMode: type: string enum: - discard - mixed - none - _common.analysis:NoriPartOfSpeechTokenFilter: + _common.analysis___NoriPartOfSpeechTokenFilter: allOf: - - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' + - $ref: '#/components/schemas/_common.analysis___TokenFilterBase' - type: object properties: type: @@ -36833,9 +38537,9 @@ components: type: string required: - type - _common.analysis:NoriTokenizer: + _common.analysis___NoriTokenizer: allOf: - - $ref: '#/components/schemas/_common.analysis:TokenizerBase' + - $ref: '#/components/schemas/_common.analysis___TokenizerBase' - type: object properties: type: @@ -36843,7 +38547,7 @@ components: enum: - nori_tokenizer decompound_mode: - $ref: '#/components/schemas/_common.analysis:NoriDecompoundMode' + $ref: '#/components/schemas/_common.analysis___NoriDecompoundMode' discard_punctuation: type: boolean user_dictionary: @@ -36854,16 +38558,16 @@ components: type: string required: - type - _common.analysis:Normalizer: + _common.analysis___Normalizer: type: object discriminator: propertyName: type oneOf: - - $ref: '#/components/schemas/_common.analysis:LowercaseNormalizer' - - $ref: '#/components/schemas/_common.analysis:CustomNormalizer' - _common.analysis:PathHierarchyTokenizer: + - $ref: '#/components/schemas/_common.analysis___LowercaseNormalizer' + - $ref: '#/components/schemas/_common.analysis___CustomNormalizer' + _common.analysis___PathHierarchyTokenizer: allOf: - - $ref: '#/components/schemas/_common.analysis:TokenizerBase' + - $ref: '#/components/schemas/_common.analysis___TokenizerBase' - type: object properties: type: @@ -36871,22 +38575,22 @@ components: enum: - path_hierarchy buffer_size: - $ref: '#/components/schemas/_common:Stringifiedinteger' + $ref: '#/components/schemas/_common___StringifiedInteger' delimiter: type: string replacement: type: string reverse: - $ref: '#/components/schemas/_common:Stringifiedboolean' + $ref: '#/components/schemas/_common___StringifiedBoolean' skip: - $ref: '#/components/schemas/_common:Stringifiedinteger' + $ref: '#/components/schemas/_common___StringifiedInteger' required: - buffer_size - delimiter - reverse - skip - type - _common.analysis:PatternAnalyzer: + _common.analysis___PatternAnalyzer: type: object properties: type: @@ -36894,7 +38598,7 @@ components: enum: - pattern version: - $ref: '#/components/schemas/_common:VersionString' + $ref: '#/components/schemas/_common___VersionString' flags: type: string lowercase: @@ -36902,13 +38606,13 @@ components: pattern: type: string stopwords: - $ref: '#/components/schemas/_common.analysis:StopWords' + $ref: '#/components/schemas/_common.analysis___StopWords' required: - pattern - type - _common.analysis:PatternCaptureTokenFilter: + _common.analysis___PatternCaptureTokenFilter: allOf: - - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' + - $ref: '#/components/schemas/_common.analysis___TokenFilterBase' - type: object properties: type: @@ -36920,13 +38624,13 @@ components: items: type: string preserve_original: - $ref: '#/components/schemas/_common:Stringifiedboolean' + $ref: '#/components/schemas/_common___StringifiedBoolean' required: - patterns - type - _common.analysis:PatternReplaceCharFilter: + _common.analysis___PatternReplaceCharFilter: allOf: - - $ref: '#/components/schemas/_common.analysis:CharFilterBase' + - $ref: '#/components/schemas/_common.analysis___CharFilterBase' - type: object properties: type: @@ -36942,9 +38646,9 @@ components: required: - pattern - type - _common.analysis:PatternReplaceTokenFilter: + _common.analysis___PatternReplaceTokenFilter: allOf: - - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' + - $ref: '#/components/schemas/_common.analysis___TokenFilterBase' - type: object properties: type: @@ -36962,9 +38666,9 @@ components: required: - pattern - type - _common.analysis:PatternTokenizer: + _common.analysis___PatternTokenizer: allOf: - - $ref: '#/components/schemas/_common.analysis:TokenizerBase' + - $ref: '#/components/schemas/_common.analysis___TokenizerBase' - type: object properties: type: @@ -36979,9 +38683,9 @@ components: type: string required: - type - _common.analysis:PersianStemTokenFilter: + _common.analysis___PersianStemTokenFilter: allOf: - - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' + - $ref: '#/components/schemas/_common.analysis___TokenFilterBase' - type: object properties: type: @@ -36990,7 +38694,18 @@ components: - persian_stem required: - type - _common.analysis:PhoneticEncoder: + _common.analysis___PhoneAnalyzer: + type: object + properties: + type: + type: string + enum: + - phone + - phone-search + phone-region: + type: string + description: Optional ISO 3166 country code, defaults to "ZZ" (unknown region). + _common.analysis___PhoneticEncoder: type: string enum: - beider_morse @@ -37005,7 +38720,7 @@ components: - nysiis - refined_soundex - soundex - _common.analysis:PhoneticLanguage: + _common.analysis___PhoneticLanguage: type: string enum: - any @@ -37020,20 +38735,20 @@ components: - romanian - russian - spanish - _common.analysis:PhoneticNameType: + _common.analysis___PhoneticNameType: type: string enum: - ashkenazi - generic - sephardic - _common.analysis:PhoneticRuleType: + _common.analysis___PhoneticRuleType: type: string enum: - approx - exact - _common.analysis:PhoneticTokenFilter: + _common.analysis___PhoneticTokenFilter: allOf: - - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' + - $ref: '#/components/schemas/_common.analysis___TokenFilterBase' - type: object properties: type: @@ -37041,28 +38756,28 @@ components: enum: - phonetic encoder: - $ref: '#/components/schemas/_common.analysis:PhoneticEncoder' + $ref: '#/components/schemas/_common.analysis___PhoneticEncoder' languageset: type: array items: - $ref: '#/components/schemas/_common.analysis:PhoneticLanguage' + $ref: '#/components/schemas/_common.analysis___PhoneticLanguage' max_code_len: type: integer name_type: - $ref: '#/components/schemas/_common.analysis:PhoneticNameType' + $ref: '#/components/schemas/_common.analysis___PhoneticNameType' replace: type: boolean rule_type: - $ref: '#/components/schemas/_common.analysis:PhoneticRuleType' + $ref: '#/components/schemas/_common.analysis___PhoneticRuleType' required: - encoder - languageset - name_type - rule_type - type - _common.analysis:PorterStemTokenFilter: + _common.analysis___PorterStemTokenFilter: allOf: - - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' + - $ref: '#/components/schemas/_common.analysis___TokenFilterBase' - type: object properties: type: @@ -37071,9 +38786,9 @@ components: - porter_stem required: - type - _common.analysis:PredicateTokenFilter: + _common.analysis___PredicateTokenFilter: allOf: - - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' + - $ref: '#/components/schemas/_common.analysis___TokenFilterBase' - type: object properties: type: @@ -37081,13 +38796,13 @@ components: enum: - predicate_token_filter script: - $ref: '#/components/schemas/_common:Script' + $ref: '#/components/schemas/_common___Script' required: - script - type - _common.analysis:RemoveDuplicatesTokenFilter: + _common.analysis___RemoveDuplicatesTokenFilter: allOf: - - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' + - $ref: '#/components/schemas/_common.analysis___TokenFilterBase' - type: object properties: type: @@ -37096,9 +38811,9 @@ components: - remove_duplicates required: - type - _common.analysis:ReverseTokenFilter: + _common.analysis___ReverseTokenFilter: allOf: - - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' + - $ref: '#/components/schemas/_common.analysis___TokenFilterBase' - type: object properties: type: @@ -37107,9 +38822,9 @@ components: - reverse required: - type - _common.analysis:ShingleTokenFilter: + _common.analysis___ShingleTokenFilter: allOf: - - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' + - $ref: '#/components/schemas/_common.analysis___TokenFilterBase' - type: object properties: type: @@ -37134,7 +38849,7 @@ components: type: string required: - type - _common.analysis:SimpleAnalyzer: + _common.analysis___SimpleAnalyzer: type: object properties: type: @@ -37142,19 +38857,19 @@ components: enum: - simple version: - $ref: '#/components/schemas/_common:VersionString' + $ref: '#/components/schemas/_common___VersionString' required: - type - _common.analysis:SmartcnAnalyzer: + _common.analysis___SmartcnAnalyzer: type: object properties: type: type: string enum: - smartcn - _common.analysis:SmartcnStopTokenFilter: + _common.analysis___SmartcnStopTokenFilter: allOf: - - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' + - $ref: '#/components/schemas/_common.analysis___TokenFilterBase' - type: object properties: type: @@ -37163,9 +38878,9 @@ components: - smartcn_stop required: - type - _common.analysis:SmartcnTokenizer: + _common.analysis___SmartcnTokenizer: allOf: - - $ref: '#/components/schemas/_common.analysis:TokenizerBase' + - $ref: '#/components/schemas/_common.analysis___TokenizerBase' - type: object properties: type: @@ -37174,7 +38889,7 @@ components: - smartcn_tokenizer required: - type - _common.analysis:SnowballAnalyzer: + _common.analysis___SnowballAnalyzer: type: object properties: type: @@ -37182,15 +38897,15 @@ components: enum: - snowball version: - $ref: '#/components/schemas/_common:VersionString' + $ref: '#/components/schemas/_common___VersionString' language: - $ref: '#/components/schemas/_common.analysis:SnowballLanguage' + $ref: '#/components/schemas/_common.analysis___SnowballLanguage' stopwords: - $ref: '#/components/schemas/_common.analysis:StopWords' + $ref: '#/components/schemas/_common.analysis___StopWords' required: - language - type - _common.analysis:SnowballLanguage: + _common.analysis___SnowballLanguage: type: string enum: - Armenian @@ -37215,9 +38930,9 @@ components: - Spanish - Swedish - Turkish - _common.analysis:SnowballTokenFilter: + _common.analysis___SnowballTokenFilter: allOf: - - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' + - $ref: '#/components/schemas/_common.analysis___TokenFilterBase' - type: object properties: type: @@ -37225,11 +38940,11 @@ components: enum: - snowball language: - $ref: '#/components/schemas/_common.analysis:SnowballLanguage' + $ref: '#/components/schemas/_common.analysis___SnowballLanguage' required: - language - type - _common.analysis:StandardAnalyzer: + _common.analysis___StandardAnalyzer: type: object properties: type: @@ -37239,12 +38954,12 @@ components: max_token_length: type: integer stopwords: - $ref: '#/components/schemas/_common.analysis:StopWords' + $ref: '#/components/schemas/_common.analysis___StopWords' required: - type - _common.analysis:StandardTokenizer: + _common.analysis___StandardTokenizer: allOf: - - $ref: '#/components/schemas/_common.analysis:TokenizerBase' + - $ref: '#/components/schemas/_common.analysis___TokenizerBase' - type: object properties: type: @@ -37255,9 +38970,9 @@ components: type: integer required: - type - _common.analysis:StemmerOverrideTokenFilter: + _common.analysis___StemmerOverrideTokenFilter: allOf: - - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' + - $ref: '#/components/schemas/_common.analysis___TokenFilterBase' - type: object properties: type: @@ -37272,9 +38987,9 @@ components: type: string required: - type - _common.analysis:StemmerTokenFilter: + _common.analysis___StemmerTokenFilter: allOf: - - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' + - $ref: '#/components/schemas/_common.analysis___TokenFilterBase' - type: object properties: type: @@ -37285,7 +39000,7 @@ components: type: string required: - type - _common.analysis:StopAnalyzer: + _common.analysis___StopAnalyzer: type: object properties: type: @@ -37293,16 +39008,16 @@ components: enum: - stop version: - $ref: '#/components/schemas/_common:VersionString' + $ref: '#/components/schemas/_common___VersionString' stopwords: - $ref: '#/components/schemas/_common.analysis:StopWords' + $ref: '#/components/schemas/_common.analysis___StopWords' stopwords_path: type: string required: - type - _common.analysis:StopTokenFilter: + _common.analysis___StopTokenFilter: allOf: - - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' + - $ref: '#/components/schemas/_common.analysis___TokenFilterBase' - type: object properties: type: @@ -37314,14 +39029,14 @@ components: remove_trailing: type: boolean stopwords: - $ref: '#/components/schemas/_common.analysis:StopWords' + $ref: '#/components/schemas/_common.analysis___StopWords' stopwords_path: type: string required: - type - _common.analysis:StopWords: + _common.analysis___StopWords: description: |- - Language value, such as _arabic_ or _thai_. Defaults to _english_. + Language value, such as `arabic` or `thai`. Defaults to `english`. Each language value corresponds to a predefined list of stop words in Lucene. See Stop words by language for supported language values and their stop words. Also accepts an array of stop words. oneOf: @@ -37329,14 +39044,14 @@ components: - type: array items: type: string - _common.analysis:SynonymFormat: + _common.analysis___SynonymFormat: type: string enum: - solr - wordnet - _common.analysis:SynonymGraphTokenFilter: + _common.analysis___SynonymGraphTokenFilter: allOf: - - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' + - $ref: '#/components/schemas/_common.analysis___TokenFilterBase' - type: object properties: type: @@ -37346,7 +39061,7 @@ components: expand: type: boolean format: - $ref: '#/components/schemas/_common.analysis:SynonymFormat' + $ref: '#/components/schemas/_common.analysis___SynonymFormat' lenient: type: boolean synonyms: @@ -37361,9 +39076,9 @@ components: type: boolean required: - type - _common.analysis:SynonymTokenFilter: + _common.analysis___SynonymTokenFilter: allOf: - - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' + - $ref: '#/components/schemas/_common.analysis___TokenFilterBase' - type: object properties: type: @@ -37373,7 +39088,7 @@ components: expand: type: boolean format: - $ref: '#/components/schemas/_common.analysis:SynonymFormat' + $ref: '#/components/schemas/_common.analysis___SynonymFormat' lenient: type: boolean synonyms: @@ -37388,7 +39103,7 @@ components: type: boolean required: - type - _common.analysis:TokenChar: + _common.analysis___TokenChar: type: string enum: - custom @@ -37397,106 +39112,106 @@ components: - punctuation - symbol - whitespace - _common.analysis:TokenFilter: + _common.analysis___TokenFilter: oneOf: - title: name type: string - title: definition - $ref: '#/components/schemas/_common.analysis:TokenFilterDefinition' - _common.analysis:TokenFilterBase: + $ref: '#/components/schemas/_common.analysis___TokenFilterDefinition' + _common.analysis___TokenFilterBase: type: object properties: version: - $ref: '#/components/schemas/_common:VersionString' - _common.analysis:TokenFilterDefinition: + $ref: '#/components/schemas/_common___VersionString' + _common.analysis___TokenFilterDefinition: type: object discriminator: propertyName: type oneOf: - - $ref: '#/components/schemas/_common.analysis:AsciiFoldingTokenFilter' - - $ref: '#/components/schemas/_common.analysis:CommonGramsTokenFilter' - - $ref: '#/components/schemas/_common.analysis:ConditionTokenFilter' - - $ref: '#/components/schemas/_common.analysis:DelimitedPayloadTokenFilter' - - $ref: '#/components/schemas/_common.analysis:EdgeNGramTokenFilter' - - $ref: '#/components/schemas/_common.analysis:ElisionTokenFilter' - - $ref: '#/components/schemas/_common.analysis:FingerprintTokenFilter' - - $ref: '#/components/schemas/_common.analysis:HunspellTokenFilter' - - $ref: '#/components/schemas/_common.analysis:HyphenationDecompounderTokenFilter' - - $ref: '#/components/schemas/_common.analysis:KeepTypesTokenFilter' - - $ref: '#/components/schemas/_common.analysis:KeepWordsTokenFilter' - - $ref: '#/components/schemas/_common.analysis:KeywordMarkerTokenFilter' - - $ref: '#/components/schemas/_common.analysis:KStemTokenFilter' - - $ref: '#/components/schemas/_common.analysis:LengthTokenFilter' - - $ref: '#/components/schemas/_common.analysis:LimitTokenCountTokenFilter' - - $ref: '#/components/schemas/_common.analysis:LowercaseTokenFilter' - - $ref: '#/components/schemas/_common.analysis:MultiplexerTokenFilter' - - $ref: '#/components/schemas/_common.analysis:NGramTokenFilter' - - $ref: '#/components/schemas/_common.analysis:NoriPartOfSpeechTokenFilter' - - $ref: '#/components/schemas/_common.analysis:PatternCaptureTokenFilter' - - $ref: '#/components/schemas/_common.analysis:PatternReplaceTokenFilter' - - $ref: '#/components/schemas/_common.analysis:PersianStemTokenFilter' - - $ref: '#/components/schemas/_common.analysis:PorterStemTokenFilter' - - $ref: '#/components/schemas/_common.analysis:PredicateTokenFilter' - - $ref: '#/components/schemas/_common.analysis:RemoveDuplicatesTokenFilter' - - $ref: '#/components/schemas/_common.analysis:ReverseTokenFilter' - - $ref: '#/components/schemas/_common.analysis:ShingleTokenFilter' - - $ref: '#/components/schemas/_common.analysis:SnowballTokenFilter' - - $ref: '#/components/schemas/_common.analysis:StemmerOverrideTokenFilter' - - $ref: '#/components/schemas/_common.analysis:StemmerTokenFilter' - - $ref: '#/components/schemas/_common.analysis:StopTokenFilter' - - $ref: '#/components/schemas/_common.analysis:SynonymGraphTokenFilter' - - $ref: '#/components/schemas/_common.analysis:SynonymTokenFilter' - - $ref: '#/components/schemas/_common.analysis:TrimTokenFilter' - - $ref: '#/components/schemas/_common.analysis:TruncateTokenFilter' - - $ref: '#/components/schemas/_common.analysis:UniqueTokenFilter' - - $ref: '#/components/schemas/_common.analysis:UppercaseTokenFilter' - - $ref: '#/components/schemas/_common.analysis:WordDelimiterGraphTokenFilter' - - $ref: '#/components/schemas/_common.analysis:WordDelimiterTokenFilter' - - $ref: '#/components/schemas/_common.analysis:KuromojiStemmerTokenFilter' - - $ref: '#/components/schemas/_common.analysis:KuromojiReadingFormTokenFilter' - - $ref: '#/components/schemas/_common.analysis:KuromojiPartOfSpeechTokenFilter' - - $ref: '#/components/schemas/_common.analysis:IcuTokenizer' - - $ref: '#/components/schemas/_common.analysis:IcuCollationTokenFilter' - - $ref: '#/components/schemas/_common.analysis:IcuFoldingTokenFilter' - - $ref: '#/components/schemas/_common.analysis:IcuNormalizationTokenFilter' - - $ref: '#/components/schemas/_common.analysis:IcuTransformTokenFilter' - - $ref: '#/components/schemas/_common.analysis:PhoneticTokenFilter' - - $ref: '#/components/schemas/_common.analysis:DictionaryDecompounderTokenFilter' - - $ref: '#/components/schemas/_common.analysis:SmartcnStopTokenFilter' - _common.analysis:Tokenizer: + - $ref: '#/components/schemas/_common.analysis___AsciiFoldingTokenFilter' + - $ref: '#/components/schemas/_common.analysis___CommonGramsTokenFilter' + - $ref: '#/components/schemas/_common.analysis___ConditionTokenFilter' + - $ref: '#/components/schemas/_common.analysis___DelimitedPayloadTokenFilter' + - $ref: '#/components/schemas/_common.analysis___EdgeNGramTokenFilter' + - $ref: '#/components/schemas/_common.analysis___ElisionTokenFilter' + - $ref: '#/components/schemas/_common.analysis___FingerprintTokenFilter' + - $ref: '#/components/schemas/_common.analysis___HunspellTokenFilter' + - $ref: '#/components/schemas/_common.analysis___HyphenationDecompounderTokenFilter' + - $ref: '#/components/schemas/_common.analysis___KeepTypesTokenFilter' + - $ref: '#/components/schemas/_common.analysis___KeepWordsTokenFilter' + - $ref: '#/components/schemas/_common.analysis___KeywordMarkerTokenFilter' + - $ref: '#/components/schemas/_common.analysis___KStemTokenFilter' + - $ref: '#/components/schemas/_common.analysis___LengthTokenFilter' + - $ref: '#/components/schemas/_common.analysis___LimitTokenCountTokenFilter' + - $ref: '#/components/schemas/_common.analysis___LowercaseTokenFilter' + - $ref: '#/components/schemas/_common.analysis___MultiplexerTokenFilter' + - $ref: '#/components/schemas/_common.analysis___NGramTokenFilter' + - $ref: '#/components/schemas/_common.analysis___NoriPartOfSpeechTokenFilter' + - $ref: '#/components/schemas/_common.analysis___PatternCaptureTokenFilter' + - $ref: '#/components/schemas/_common.analysis___PatternReplaceTokenFilter' + - $ref: '#/components/schemas/_common.analysis___PersianStemTokenFilter' + - $ref: '#/components/schemas/_common.analysis___PorterStemTokenFilter' + - $ref: '#/components/schemas/_common.analysis___PredicateTokenFilter' + - $ref: '#/components/schemas/_common.analysis___RemoveDuplicatesTokenFilter' + - $ref: '#/components/schemas/_common.analysis___ReverseTokenFilter' + - $ref: '#/components/schemas/_common.analysis___ShingleTokenFilter' + - $ref: '#/components/schemas/_common.analysis___SnowballTokenFilter' + - $ref: '#/components/schemas/_common.analysis___StemmerOverrideTokenFilter' + - $ref: '#/components/schemas/_common.analysis___StemmerTokenFilter' + - $ref: '#/components/schemas/_common.analysis___StopTokenFilter' + - $ref: '#/components/schemas/_common.analysis___SynonymGraphTokenFilter' + - $ref: '#/components/schemas/_common.analysis___SynonymTokenFilter' + - $ref: '#/components/schemas/_common.analysis___TrimTokenFilter' + - $ref: '#/components/schemas/_common.analysis___TruncateTokenFilter' + - $ref: '#/components/schemas/_common.analysis___UniqueTokenFilter' + - $ref: '#/components/schemas/_common.analysis___UppercaseTokenFilter' + - $ref: '#/components/schemas/_common.analysis___WordDelimiterGraphTokenFilter' + - $ref: '#/components/schemas/_common.analysis___WordDelimiterTokenFilter' + - $ref: '#/components/schemas/_common.analysis___KuromojiStemmerTokenFilter' + - $ref: '#/components/schemas/_common.analysis___KuromojiReadingFormTokenFilter' + - $ref: '#/components/schemas/_common.analysis___KuromojiPartOfSpeechTokenFilter' + - $ref: '#/components/schemas/_common.analysis___IcuTokenizer' + - $ref: '#/components/schemas/_common.analysis___IcuCollationTokenFilter' + - $ref: '#/components/schemas/_common.analysis___IcuFoldingTokenFilter' + - $ref: '#/components/schemas/_common.analysis___IcuNormalizationTokenFilter' + - $ref: '#/components/schemas/_common.analysis___IcuTransformTokenFilter' + - $ref: '#/components/schemas/_common.analysis___PhoneticTokenFilter' + - $ref: '#/components/schemas/_common.analysis___DictionaryDecompounderTokenFilter' + - $ref: '#/components/schemas/_common.analysis___SmartcnStopTokenFilter' + _common.analysis___Tokenizer: oneOf: - title: name type: string - title: definition - $ref: '#/components/schemas/_common.analysis:TokenizerDefinition' - _common.analysis:TokenizerBase: + $ref: '#/components/schemas/_common.analysis___TokenizerDefinition' + _common.analysis___TokenizerBase: type: object properties: version: - $ref: '#/components/schemas/_common:VersionString' - _common.analysis:TokenizerDefinition: + $ref: '#/components/schemas/_common___VersionString' + _common.analysis___TokenizerDefinition: type: object discriminator: propertyName: type oneOf: - - $ref: '#/components/schemas/_common.analysis:CharGroupTokenizer' - - $ref: '#/components/schemas/_common.analysis:EdgeNGramTokenizer' - - $ref: '#/components/schemas/_common.analysis:KeywordTokenizer' - - $ref: '#/components/schemas/_common.analysis:LetterTokenizer' - - $ref: '#/components/schemas/_common.analysis:LowercaseTokenizer' - - $ref: '#/components/schemas/_common.analysis:NGramTokenizer' - - $ref: '#/components/schemas/_common.analysis:NoriTokenizer' - - $ref: '#/components/schemas/_common.analysis:PathHierarchyTokenizer' - - $ref: '#/components/schemas/_common.analysis:StandardTokenizer' - - $ref: '#/components/schemas/_common.analysis:UaxEmailUrlTokenizer' - - $ref: '#/components/schemas/_common.analysis:WhitespaceTokenizer' - - $ref: '#/components/schemas/_common.analysis:KuromojiTokenizer' - - $ref: '#/components/schemas/_common.analysis:PatternTokenizer' - - $ref: '#/components/schemas/_common.analysis:IcuTokenizer' - - $ref: '#/components/schemas/_common.analysis:SmartcnTokenizer' - _common.analysis:TrimTokenFilter: - allOf: - - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' + - $ref: '#/components/schemas/_common.analysis___CharGroupTokenizer' + - $ref: '#/components/schemas/_common.analysis___EdgeNGramTokenizer' + - $ref: '#/components/schemas/_common.analysis___KeywordTokenizer' + - $ref: '#/components/schemas/_common.analysis___LetterTokenizer' + - $ref: '#/components/schemas/_common.analysis___LowercaseTokenizer' + - $ref: '#/components/schemas/_common.analysis___NGramTokenizer' + - $ref: '#/components/schemas/_common.analysis___NoriTokenizer' + - $ref: '#/components/schemas/_common.analysis___PathHierarchyTokenizer' + - $ref: '#/components/schemas/_common.analysis___StandardTokenizer' + - $ref: '#/components/schemas/_common.analysis___UaxEmailUrlTokenizer' + - $ref: '#/components/schemas/_common.analysis___WhitespaceTokenizer' + - $ref: '#/components/schemas/_common.analysis___KuromojiTokenizer' + - $ref: '#/components/schemas/_common.analysis___PatternTokenizer' + - $ref: '#/components/schemas/_common.analysis___IcuTokenizer' + - $ref: '#/components/schemas/_common.analysis___SmartcnTokenizer' + _common.analysis___TrimTokenFilter: + allOf: + - $ref: '#/components/schemas/_common.analysis___TokenFilterBase' - type: object properties: type: @@ -37505,9 +39220,9 @@ components: - trim required: - type - _common.analysis:TruncateTokenFilter: + _common.analysis___TruncateTokenFilter: allOf: - - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' + - $ref: '#/components/schemas/_common.analysis___TokenFilterBase' - type: object properties: type: @@ -37518,9 +39233,9 @@ components: type: integer required: - type - _common.analysis:UaxEmailUrlTokenizer: + _common.analysis___UaxEmailUrlTokenizer: allOf: - - $ref: '#/components/schemas/_common.analysis:TokenizerBase' + - $ref: '#/components/schemas/_common.analysis___TokenizerBase' - type: object properties: type: @@ -37531,9 +39246,9 @@ components: type: integer required: - type - _common.analysis:UniqueTokenFilter: + _common.analysis___UniqueTokenFilter: allOf: - - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' + - $ref: '#/components/schemas/_common.analysis___TokenFilterBase' - type: object properties: type: @@ -37544,9 +39259,9 @@ components: type: boolean required: - type - _common.analysis:UppercaseTokenFilter: + _common.analysis___UppercaseTokenFilter: allOf: - - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' + - $ref: '#/components/schemas/_common.analysis___TokenFilterBase' - type: object properties: type: @@ -37555,7 +39270,7 @@ components: - uppercase required: - type - _common.analysis:WhitespaceAnalyzer: + _common.analysis___WhitespaceAnalyzer: type: object properties: type: @@ -37563,12 +39278,12 @@ components: enum: - whitespace version: - $ref: '#/components/schemas/_common:VersionString' + $ref: '#/components/schemas/_common___VersionString' required: - type - _common.analysis:WhitespaceTokenizer: + _common.analysis___WhitespaceTokenizer: allOf: - - $ref: '#/components/schemas/_common.analysis:TokenizerBase' + - $ref: '#/components/schemas/_common.analysis___TokenizerBase' - type: object properties: type: @@ -37579,9 +39294,9 @@ components: type: integer required: - type - _common.analysis:WordDelimiterGraphTokenFilter: + _common.analysis___WordDelimiterGraphTokenFilter: allOf: - - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' + - $ref: '#/components/schemas/_common.analysis___TokenFilterBase' - type: object properties: type: @@ -37603,7 +39318,7 @@ components: ignore_keywords: type: boolean preserve_original: - $ref: '#/components/schemas/_common:Stringifiedboolean' + $ref: '#/components/schemas/_common___StringifiedBoolean' protected_words: type: array items: @@ -37624,9 +39339,9 @@ components: type: string required: - type - _common.analysis:WordDelimiterTokenFilter: + _common.analysis___WordDelimiterTokenFilter: allOf: - - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' + - $ref: '#/components/schemas/_common.analysis___TokenFilterBase' - type: object properties: type: @@ -37644,7 +39359,7 @@ components: generate_word_parts: type: boolean preserve_original: - $ref: '#/components/schemas/_common:Stringifiedboolean' + $ref: '#/components/schemas/_common___StringifiedBoolean' protected_words: type: array items: @@ -37665,9 +39380,9 @@ components: type: string required: - type - _common.mapping:AggregateMetricDoubleProperty: + _common.mapping___AggregateMetricDoubleProperty: allOf: - - $ref: '#/components/schemas/_common.mapping:PropertyBase' + - $ref: '#/components/schemas/_common.mapping___PropertyBase' - type: object properties: type: @@ -37680,13 +39395,11 @@ components: type: array items: type: string - time_series_metric: - $ref: '#/components/schemas/_common.mapping:TimeSeriesMetricType' required: - default_metric - metrics - type - _common.mapping:AllField: + _common.mapping___AllField: type: object properties: analyzer: @@ -37720,9 +39433,9 @@ components: - store_term_vector_payloads - store_term_vector_positions - store_term_vectors - _common.mapping:BinaryProperty: + _common.mapping___BinaryProperty: allOf: - - $ref: '#/components/schemas/_common.mapping:DocValuesPropertyBase' + - $ref: '#/components/schemas/_common.mapping___DocValuesPropertyBase' - type: object properties: type: @@ -37731,16 +39444,16 @@ components: - binary required: - type - _common.mapping:BooleanProperty: + _common.mapping___BooleanProperty: allOf: - - $ref: '#/components/schemas/_common.mapping:DocValuesPropertyBase' + - $ref: '#/components/schemas/_common.mapping___DocValuesPropertyBase' - type: object properties: boost: type: number format: double fielddata: - $ref: '#/components/schemas/indices._common:NumericFielddata' + $ref: '#/components/schemas/indices._common___NumericFielddata' index: type: boolean null_value: @@ -37751,9 +39464,9 @@ components: - boolean required: - type - _common.mapping:ByteNumberProperty: + _common.mapping___ByteNumberProperty: allOf: - - $ref: '#/components/schemas/_common.mapping:NumberPropertyBase' + - $ref: '#/components/schemas/_common.mapping___NumberPropertyBase' - type: object properties: type: @@ -37761,12 +39474,12 @@ components: enum: - byte null_value: - $ref: '#/components/schemas/_common:byte' + $ref: '#/components/schemas/_common___byte' required: - type - _common.mapping:CompletionProperty: + _common.mapping___CompletionProperty: allOf: - - $ref: '#/components/schemas/_common.mapping:DocValuesPropertyBase' + - $ref: '#/components/schemas/_common.mapping___DocValuesPropertyBase' - type: object properties: analyzer: @@ -37774,7 +39487,7 @@ components: contexts: type: array items: - $ref: '#/components/schemas/_common.mapping:SuggestContext' + $ref: '#/components/schemas/_common.mapping___SuggestContext' max_input_length: type: integer preserve_position_increments: @@ -37789,9 +39502,9 @@ components: - completion required: - type - _common.mapping:ConstantKeywordProperty: + _common.mapping___ConstantKeywordProperty: allOf: - - $ref: '#/components/schemas/_common.mapping:PropertyBase' + - $ref: '#/components/schemas/_common.mapping___PropertyBase' - type: object properties: value: {} @@ -37801,27 +39514,27 @@ components: - constant_keyword required: - type - _common.mapping:CorePropertyBase: + _common.mapping___CorePropertyBase: allOf: - - $ref: '#/components/schemas/_common.mapping:PropertyBase' + - $ref: '#/components/schemas/_common.mapping___PropertyBase' - type: object properties: copy_to: - $ref: '#/components/schemas/_common:Fields' + $ref: '#/components/schemas/_common___Fields' similarity: type: string store: type: boolean - _common.mapping:DataStreamTimestamp: + _common.mapping___DataStreamTimestamp: type: object properties: enabled: type: boolean required: - enabled - _common.mapping:DateNanosProperty: + _common.mapping___DateNanosProperty: allOf: - - $ref: '#/components/schemas/_common.mapping:DocValuesPropertyBase' + - $ref: '#/components/schemas/_common.mapping___DocValuesPropertyBase' - type: object properties: boost: @@ -37834,7 +39547,7 @@ components: index: type: boolean null_value: - $ref: '#/components/schemas/_common:DateTime' + $ref: '#/components/schemas/_common___DateTime' precision_step: type: integer type: @@ -37843,16 +39556,16 @@ components: - date_nanos required: - type - _common.mapping:DateProperty: + _common.mapping___DateProperty: allOf: - - $ref: '#/components/schemas/_common.mapping:DocValuesPropertyBase' + - $ref: '#/components/schemas/_common.mapping___DocValuesPropertyBase' - type: object properties: boost: type: number format: double fielddata: - $ref: '#/components/schemas/indices._common:NumericFielddata' + $ref: '#/components/schemas/indices._common___NumericFielddata' format: type: string ignore_malformed: @@ -37860,7 +39573,7 @@ components: index: type: boolean null_value: - $ref: '#/components/schemas/_common:DateTime' + $ref: '#/components/schemas/_common___DateTime' precision_step: type: integer locale: @@ -37871,9 +39584,9 @@ components: - date required: - type - _common.mapping:DateRangeProperty: + _common.mapping___DateRangeProperty: allOf: - - $ref: '#/components/schemas/_common.mapping:RangePropertyBase' + - $ref: '#/components/schemas/_common.mapping___RangePropertyBase' - type: object properties: format: @@ -37884,49 +39597,16 @@ components: - date_range required: - type - _common.mapping:DenseVectorIndexOptions: - type: object - properties: - type: - type: string - m: - type: number - ef_construction: - type: number - required: - - ef_construction - - m - - type - _common.mapping:DenseVectorProperty: + _common.mapping___DocValuesPropertyBase: allOf: - - $ref: '#/components/schemas/_common.mapping:PropertyBase' - - type: object - properties: - type: - type: string - enum: - - dense_vector - dims: - type: number - similarity: - type: string - index: - type: boolean - index_options: - $ref: '#/components/schemas/_common.mapping:DenseVectorIndexOptions' - required: - - dims - - type - _common.mapping:DocValuesPropertyBase: - allOf: - - $ref: '#/components/schemas/_common.mapping:CorePropertyBase' + - $ref: '#/components/schemas/_common.mapping___CorePropertyBase' - type: object properties: doc_values: type: boolean - _common.mapping:DoubleNumberProperty: + _common.mapping___DoubleNumberProperty: allOf: - - $ref: '#/components/schemas/_common.mapping:NumberPropertyBase' + - $ref: '#/components/schemas/_common.mapping___NumberPropertyBase' - type: object properties: type: @@ -37938,9 +39618,9 @@ components: format: double required: - type - _common.mapping:DoubleRangeProperty: + _common.mapping___DoubleRangeProperty: allOf: - - $ref: '#/components/schemas/_common.mapping:RangePropertyBase' + - $ref: '#/components/schemas/_common.mapping___RangePropertyBase' - type: object properties: type: @@ -37949,44 +39629,44 @@ components: - double_range required: - type - _common.mapping:DynamicMapping: + _common.mapping___DynamicMapping: type: string enum: - 'false' - strict - strict_allow_templates - 'true' - _common.mapping:DynamicTemplate: + _common.mapping___DynamicTemplate: type: object properties: mapping: - $ref: '#/components/schemas/_common.mapping:Property' + $ref: '#/components/schemas/_common.mapping___Property' match: type: string match_mapping_type: type: string match_pattern: - $ref: '#/components/schemas/_common.mapping:MatchType' + $ref: '#/components/schemas/_common.mapping___MatchType' path_match: type: string path_unmatch: type: string unmatch: type: string - _common.mapping:FieldAliasProperty: + _common.mapping___FieldAliasProperty: allOf: - - $ref: '#/components/schemas/_common.mapping:PropertyBase' + - $ref: '#/components/schemas/_common.mapping___PropertyBase' - type: object properties: path: - $ref: '#/components/schemas/_common:Field' + $ref: '#/components/schemas/_common___Field' type: type: string enum: - alias required: - type - _common.mapping:FieldMapping: + _common.mapping___FieldMapping: type: object properties: full_name: @@ -37994,52 +39674,37 @@ components: mapping: type: object additionalProperties: - $ref: '#/components/schemas/_common.mapping:Property' + $ref: '#/components/schemas/_common.mapping___Property' minProperties: 1 maxProperties: 1 required: - full_name - mapping - _common.mapping:FieldNamesField: + _common.mapping___FieldNamesField: type: object properties: enabled: type: boolean required: - enabled - _common.mapping:FlattenedProperty: + _common.mapping___FlatObjectProperty: allOf: - - $ref: '#/components/schemas/_common.mapping:PropertyBase' + - $ref: '#/components/schemas/_common.mapping___PropertyBase' - type: object properties: - boost: - type: number - format: double - depth_limit: - type: number - doc_values: - type: boolean - eager_global_ordinals: - type: boolean - index: + searchable: type: boolean - index_options: - $ref: '#/components/schemas/_common.mapping:IndexOptions' - null_value: - type: string - similarity: - type: string - split_queries_on_whitespace: + aggregatable: type: boolean type: type: string enum: - - flattened + - flat_object required: - type - _common.mapping:FloatNumberProperty: + _common.mapping___FloatNumberProperty: allOf: - - $ref: '#/components/schemas/_common.mapping:NumberPropertyBase' + - $ref: '#/components/schemas/_common.mapping___NumberPropertyBase' - type: object properties: type: @@ -38051,9 +39716,9 @@ components: format: float required: - type - _common.mapping:FloatRangeProperty: + _common.mapping___FloatRangeProperty: allOf: - - $ref: '#/components/schemas/_common.mapping:RangePropertyBase' + - $ref: '#/components/schemas/_common.mapping___RangePropertyBase' - type: object properties: type: @@ -38062,25 +39727,25 @@ components: - float_range required: - type - _common.mapping:GeoOrientation: + _common.mapping___GeoOrientation: oneOf: - title: left type: string enum: + - left - LEFT - clockwise - cw - - left - title: right type: string enum: + - right - RIGHT - - ccw - counterclockwise - - right - _common.mapping:GeoPointProperty: + - ccw + _common.mapping___GeoPointProperty: allOf: - - $ref: '#/components/schemas/_common.mapping:DocValuesPropertyBase' + - $ref: '#/components/schemas/_common.mapping___DocValuesPropertyBase' - type: object properties: ignore_malformed: @@ -38088,16 +39753,16 @@ components: ignore_z_value: type: boolean null_value: - $ref: '#/components/schemas/_common:GeoLocation' + $ref: '#/components/schemas/_common___GeoLocation' type: type: string enum: - geo_point required: - type - _common.mapping:GeoShapeProperty: + _common.mapping___GeoShapeProperty: allOf: - - $ref: '#/components/schemas/_common.mapping:DocValuesPropertyBase' + - $ref: '#/components/schemas/_common.mapping___DocValuesPropertyBase' - type: object properties: coerce: @@ -38107,9 +39772,9 @@ components: ignore_z_value: type: boolean orientation: - $ref: '#/components/schemas/_common.mapping:GeoOrientation' + $ref: '#/components/schemas/_common.mapping___GeoOrientation' strategy: - $ref: '#/components/schemas/_common.mapping:GeoStrategy' + $ref: '#/components/schemas/_common.mapping___GeoStrategy' deprecated: true distance_error_pct: type: number @@ -38121,14 +39786,14 @@ components: - geo_shape required: - type - _common.mapping:GeoStrategy: + _common.mapping___GeoStrategy: type: string enum: - recursive - term - _common.mapping:HalfFloatNumberProperty: + _common.mapping___HalfFloatNumberProperty: allOf: - - $ref: '#/components/schemas/_common.mapping:NumberPropertyBase' + - $ref: '#/components/schemas/_common.mapping___NumberPropertyBase' - type: object properties: type: @@ -38140,9 +39805,9 @@ components: format: float required: - type - _common.mapping:HistogramProperty: + _common.mapping___HistogramProperty: allOf: - - $ref: '#/components/schemas/_common.mapping:PropertyBase' + - $ref: '#/components/schemas/_common.mapping___PropertyBase' - type: object properties: ignore_malformed: @@ -38153,23 +39818,60 @@ components: - histogram required: - type - _common.mapping:IndexField: + _common.mapping___IcuCollationKeywordProperty: + allOf: + - $ref: '#/components/schemas/_common.mapping___DocValuesPropertyBase' + - type: object + properties: + type: + type: string + enum: + - icu_collation_keyword + index: + type: boolean + null_value: + type: string + alternate: + $ref: '#/components/schemas/_common.analysis___IcuCollationAlternate' + case_level: + type: boolean + case_first: + $ref: '#/components/schemas/_common.analysis___IcuCollationCaseFirst' + decomposition: + $ref: '#/components/schemas/_common.analysis___IcuCollationDecomposition' + hiragana_quaternary_mode: + type: boolean + numeric: + type: boolean + strength: + $ref: '#/components/schemas/_common.analysis___IcuCollationStrength' + variable_top: + type: string + country: + type: string + language: + type: string + variant: + type: string + required: + - type + _common.mapping___IndexField: type: object properties: enabled: type: boolean required: - enabled - _common.mapping:IndexOptions: + _common.mapping___IndexOptions: type: string enum: - docs - freqs - offsets - positions - _common.mapping:IntegerNumberProperty: + _common.mapping___IntegerNumberProperty: allOf: - - $ref: '#/components/schemas/_common.mapping:NumberPropertyBase' + - $ref: '#/components/schemas/_common.mapping___NumberPropertyBase' - type: object properties: type: @@ -38180,9 +39882,9 @@ components: type: integer required: - type - _common.mapping:IntegerRangeProperty: + _common.mapping___IntegerRangeProperty: allOf: - - $ref: '#/components/schemas/_common.mapping:RangePropertyBase' + - $ref: '#/components/schemas/_common.mapping___RangePropertyBase' - type: object properties: type: @@ -38191,9 +39893,9 @@ components: - integer_range required: - type - _common.mapping:IpProperty: + _common.mapping___IpProperty: allOf: - - $ref: '#/components/schemas/_common.mapping:DocValuesPropertyBase' + - $ref: '#/components/schemas/_common.mapping___DocValuesPropertyBase' - type: object properties: boost: @@ -38205,22 +39907,15 @@ components: type: boolean null_value: type: string - on_script_error: - $ref: '#/components/schemas/_common.mapping:OnScriptError' - script: - $ref: '#/components/schemas/_common:Script' - time_series_dimension: - description: For internal use by OpenSearch only. Marks the field as a time series dimension. Defaults to false. - type: boolean type: type: string enum: - ip required: - type - _common.mapping:IpRangeProperty: + _common.mapping___IpRangeProperty: allOf: - - $ref: '#/components/schemas/_common.mapping:RangePropertyBase' + - $ref: '#/components/schemas/_common.mapping___RangePropertyBase' - type: object properties: type: @@ -38229,19 +39924,19 @@ components: - ip_range required: - type - _common.mapping:JoinProperty: + _common.mapping___JoinProperty: allOf: - - $ref: '#/components/schemas/_common.mapping:PropertyBase' + - $ref: '#/components/schemas/_common.mapping___PropertyBase' - type: object properties: relations: type: object additionalProperties: oneOf: - - $ref: '#/components/schemas/_common:RelationName' + - $ref: '#/components/schemas/_common___RelationName' - type: array items: - $ref: '#/components/schemas/_common:RelationName' + $ref: '#/components/schemas/_common___RelationName' eager_global_ordinals: type: boolean type: @@ -38250,9 +39945,9 @@ components: - join required: - type - _common.mapping:KeywordProperty: + _common.mapping___KeywordProperty: allOf: - - $ref: '#/components/schemas/_common.mapping:DocValuesPropertyBase' + - $ref: '#/components/schemas/_common.mapping___DocValuesPropertyBase' - type: object properties: boost: @@ -38263,7 +39958,7 @@ components: index: type: boolean index_options: - $ref: '#/components/schemas/_common.mapping:IndexOptions' + $ref: '#/components/schemas/_common.mapping___IndexOptions' normalizer: type: string norms: @@ -38272,16 +39967,13 @@ components: type: string split_queries_on_whitespace: type: boolean - time_series_dimension: - description: For internal use by OpenSearch only. Marks the field as a time series dimension. Defaults to false. - type: boolean type: type: string enum: - keyword required: - type - _common.mapping:KnnVectorMethod: + _common.mapping___KnnVectorMethod: type: object properties: name: @@ -38295,9 +39987,9 @@ components: additionalProperties: {} required: - name - _common.mapping:KnnVectorProperty: + _common.mapping___KnnVectorProperty: allOf: - - $ref: '#/components/schemas/_common.mapping:DocValuesPropertyBase' + - $ref: '#/components/schemas/_common.mapping___DocValuesPropertyBase' - type: object properties: type: @@ -38315,15 +40007,15 @@ components: compression_level: type: string method: - $ref: '#/components/schemas/_common.mapping:KnnVectorMethod' + $ref: '#/components/schemas/_common.mapping___KnnVectorMethod' model_id: type: string required: - dimension - type - _common.mapping:LongNumberProperty: + _common.mapping___LongNumberProperty: allOf: - - $ref: '#/components/schemas/_common.mapping:NumberPropertyBase' + - $ref: '#/components/schemas/_common.mapping___NumberPropertyBase' - type: object properties: type: @@ -38335,9 +40027,9 @@ components: format: int64 required: - type - _common.mapping:LongRangeProperty: + _common.mapping___LongRangeProperty: allOf: - - $ref: '#/components/schemas/_common.mapping:RangePropertyBase' + - $ref: '#/components/schemas/_common.mapping___RangePropertyBase' - type: object properties: type: @@ -38346,7 +40038,7 @@ components: - long_range required: - type - _common.mapping:MatchOnlyTextProperty: + _common.mapping___MatchOnlyTextProperty: type: object properties: type: @@ -38359,24 +40051,24 @@ components: field for search and a multi-field for sorting and aggregations, or the same string value analyzed by different analyzers. type: object additionalProperties: - $ref: '#/components/schemas/_common.mapping:Property' + $ref: '#/components/schemas/_common.mapping___Property' meta: description: Metadata about the field. type: object additionalProperties: type: string copy_to: - $ref: '#/components/schemas/_common:Fields' + $ref: '#/components/schemas/_common___Fields' required: - type - _common.mapping:MatchType: + _common.mapping___MatchType: type: string enum: - regex - simple - _common.mapping:Murmur3HashProperty: + _common.mapping___Murmur3HashProperty: allOf: - - $ref: '#/components/schemas/_common.mapping:DocValuesPropertyBase' + - $ref: '#/components/schemas/_common.mapping___DocValuesPropertyBase' - type: object properties: type: @@ -38385,9 +40077,9 @@ components: - murmur3 required: - type - _common.mapping:NestedProperty: + _common.mapping___NestedProperty: allOf: - - $ref: '#/components/schemas/_common.mapping:CorePropertyBase' + - $ref: '#/components/schemas/_common.mapping___CorePropertyBase' - type: object properties: enabled: @@ -38402,9 +40094,9 @@ components: - nested required: - type - _common.mapping:NumberPropertyBase: + _common.mapping___NumberPropertyBase: allOf: - - $ref: '#/components/schemas/_common.mapping:DocValuesPropertyBase' + - $ref: '#/components/schemas/_common.mapping___DocValuesPropertyBase' - type: object properties: boost: @@ -38416,18 +40108,9 @@ components: type: boolean index: type: boolean - on_script_error: - $ref: '#/components/schemas/_common.mapping:OnScriptError' - script: - $ref: '#/components/schemas/_common:Script' - time_series_metric: - $ref: '#/components/schemas/_common.mapping:TimeSeriesMetricType' - time_series_dimension: - description: For internal use by OpenSearch only. Marks the field as a time series dimension. Defaults to false. - type: boolean - _common.mapping:ObjectProperty: + _common.mapping___ObjectProperty: allOf: - - $ref: '#/components/schemas/_common.mapping:CorePropertyBase' + - $ref: '#/components/schemas/_common.mapping___CorePropertyBase' - type: object properties: enabled: @@ -38436,14 +40119,9 @@ components: type: string enum: - object - _common.mapping:OnScriptError: - type: string - enum: - - continue - - fail - _common.mapping:PercolatorProperty: + _common.mapping___PercolatorProperty: allOf: - - $ref: '#/components/schemas/_common.mapping:PropertyBase' + - $ref: '#/components/schemas/_common.mapping___PropertyBase' - type: object properties: type: @@ -38452,59 +40130,59 @@ components: - percolator required: - type - _common.mapping:Property: + _common.mapping___Property: type: object discriminator: propertyName: type + x-default: object oneOf: - - $ref: '#/components/schemas/_common.mapping:BinaryProperty' - - $ref: '#/components/schemas/_common.mapping:BooleanProperty' - - $ref: '#/components/schemas/_common.mapping:JoinProperty' - - $ref: '#/components/schemas/_common.mapping:KeywordProperty' - - $ref: '#/components/schemas/_common.mapping:MatchOnlyTextProperty' - - $ref: '#/components/schemas/_common.mapping:PercolatorProperty' - - $ref: '#/components/schemas/_common.mapping:RankFeatureProperty' - - $ref: '#/components/schemas/_common.mapping:RankFeaturesProperty' - - $ref: '#/components/schemas/_common.mapping:SearchAsYouTypeProperty' - - $ref: '#/components/schemas/_common.mapping:TextProperty' - - $ref: '#/components/schemas/_common.mapping:VersionProperty' - - $ref: '#/components/schemas/_common.mapping:WildcardProperty' - - $ref: '#/components/schemas/_common.mapping:DateNanosProperty' - - $ref: '#/components/schemas/_common.mapping:DateProperty' - - $ref: '#/components/schemas/_common.mapping:AggregateMetricDoubleProperty' - - $ref: '#/components/schemas/_common.mapping:DenseVectorProperty' - - $ref: '#/components/schemas/_common.mapping:SparseVectorProperty' - - $ref: '#/components/schemas/_common.mapping:FlattenedProperty' - - $ref: '#/components/schemas/_common.mapping:NestedProperty' - - $ref: '#/components/schemas/_common.mapping:ObjectProperty' - - $ref: '#/components/schemas/_common.mapping:CompletionProperty' - - $ref: '#/components/schemas/_common.mapping:ConstantKeywordProperty' - - $ref: '#/components/schemas/_common.mapping:FieldAliasProperty' - - $ref: '#/components/schemas/_common.mapping:HistogramProperty' - - $ref: '#/components/schemas/_common.mapping:IpProperty' - - $ref: '#/components/schemas/_common.mapping:Murmur3HashProperty' - - $ref: '#/components/schemas/_common.mapping:TokenCountProperty' - - $ref: '#/components/schemas/_common.mapping:GeoPointProperty' - - $ref: '#/components/schemas/_common.mapping:GeoShapeProperty' - - $ref: '#/components/schemas/_common.mapping:XyPointProperty' - - $ref: '#/components/schemas/_common.mapping:XyShapeProperty' - - $ref: '#/components/schemas/_common.mapping:ByteNumberProperty' - - $ref: '#/components/schemas/_common.mapping:DoubleNumberProperty' - - $ref: '#/components/schemas/_common.mapping:FloatNumberProperty' - - $ref: '#/components/schemas/_common.mapping:HalfFloatNumberProperty' - - $ref: '#/components/schemas/_common.mapping:IntegerNumberProperty' - - $ref: '#/components/schemas/_common.mapping:LongNumberProperty' - - $ref: '#/components/schemas/_common.mapping:ScaledFloatNumberProperty' - - $ref: '#/components/schemas/_common.mapping:ShortNumberProperty' - - $ref: '#/components/schemas/_common.mapping:UnsignedLongNumberProperty' - - $ref: '#/components/schemas/_common.mapping:DateRangeProperty' - - $ref: '#/components/schemas/_common.mapping:DoubleRangeProperty' - - $ref: '#/components/schemas/_common.mapping:FloatRangeProperty' - - $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: + - $ref: '#/components/schemas/_common.mapping___BinaryProperty' + - $ref: '#/components/schemas/_common.mapping___BooleanProperty' + - $ref: '#/components/schemas/_common.mapping___JoinProperty' + - $ref: '#/components/schemas/_common.mapping___KeywordProperty' + - $ref: '#/components/schemas/_common.mapping___MatchOnlyTextProperty' + - $ref: '#/components/schemas/_common.mapping___PercolatorProperty' + - $ref: '#/components/schemas/_common.mapping___RankFeatureProperty' + - $ref: '#/components/schemas/_common.mapping___RankFeaturesProperty' + - $ref: '#/components/schemas/_common.mapping___SearchAsYouTypeProperty' + - $ref: '#/components/schemas/_common.mapping___TextProperty' + - $ref: '#/components/schemas/_common.mapping___VersionProperty' + - $ref: '#/components/schemas/_common.mapping___WildcardProperty' + - $ref: '#/components/schemas/_common.mapping___DateNanosProperty' + - $ref: '#/components/schemas/_common.mapping___DateProperty' + - $ref: '#/components/schemas/_common.mapping___AggregateMetricDoubleProperty' + - $ref: '#/components/schemas/_common.mapping___FlatObjectProperty' + - $ref: '#/components/schemas/_common.mapping___NestedProperty' + - $ref: '#/components/schemas/_common.mapping___ObjectProperty' + - $ref: '#/components/schemas/_common.mapping___CompletionProperty' + - $ref: '#/components/schemas/_common.mapping___ConstantKeywordProperty' + - $ref: '#/components/schemas/_common.mapping___FieldAliasProperty' + - $ref: '#/components/schemas/_common.mapping___HistogramProperty' + - $ref: '#/components/schemas/_common.mapping___IpProperty' + - $ref: '#/components/schemas/_common.mapping___Murmur3HashProperty' + - $ref: '#/components/schemas/_common.mapping___TokenCountProperty' + - $ref: '#/components/schemas/_common.mapping___GeoPointProperty' + - $ref: '#/components/schemas/_common.mapping___GeoShapeProperty' + - $ref: '#/components/schemas/_common.mapping___XyPointProperty' + - $ref: '#/components/schemas/_common.mapping___XyShapeProperty' + - $ref: '#/components/schemas/_common.mapping___ByteNumberProperty' + - $ref: '#/components/schemas/_common.mapping___DoubleNumberProperty' + - $ref: '#/components/schemas/_common.mapping___FloatNumberProperty' + - $ref: '#/components/schemas/_common.mapping___HalfFloatNumberProperty' + - $ref: '#/components/schemas/_common.mapping___IntegerNumberProperty' + - $ref: '#/components/schemas/_common.mapping___LongNumberProperty' + - $ref: '#/components/schemas/_common.mapping___ScaledFloatNumberProperty' + - $ref: '#/components/schemas/_common.mapping___ShortNumberProperty' + - $ref: '#/components/schemas/_common.mapping___UnsignedLongNumberProperty' + - $ref: '#/components/schemas/_common.mapping___DateRangeProperty' + - $ref: '#/components/schemas/_common.mapping___DoubleRangeProperty' + - $ref: '#/components/schemas/_common.mapping___FloatRangeProperty' + - $ref: '#/components/schemas/_common.mapping___IntegerRangeProperty' + - $ref: '#/components/schemas/_common.mapping___IpRangeProperty' + - $ref: '#/components/schemas/_common.mapping___LongRangeProperty' + - $ref: '#/components/schemas/_common.mapping___KnnVectorProperty' + - $ref: '#/components/schemas/_common.mapping___IcuCollationKeywordProperty' + _common.mapping___PropertyBase: type: object properties: meta: @@ -38515,18 +40193,18 @@ components: properties: type: object additionalProperties: - $ref: '#/components/schemas/_common.mapping:Property' + $ref: '#/components/schemas/_common.mapping___Property' ignore_above: type: integer dynamic: - $ref: '#/components/schemas/_common.mapping:DynamicMapping' + $ref: '#/components/schemas/_common.mapping___DynamicMapping' fields: type: object additionalProperties: - $ref: '#/components/schemas/_common.mapping:Property' - _common.mapping:RangePropertyBase: + $ref: '#/components/schemas/_common.mapping___Property' + _common.mapping___RangePropertyBase: allOf: - - $ref: '#/components/schemas/_common.mapping:DocValuesPropertyBase' + - $ref: '#/components/schemas/_common.mapping___DocValuesPropertyBase' - type: object properties: boost: @@ -38536,9 +40214,9 @@ components: type: boolean index: type: boolean - _common.mapping:RankFeatureProperty: + _common.mapping___RankFeatureProperty: allOf: - - $ref: '#/components/schemas/_common.mapping:PropertyBase' + - $ref: '#/components/schemas/_common.mapping___PropertyBase' - type: object properties: positive_score_impact: @@ -38549,9 +40227,9 @@ components: - rank_feature required: - type - _common.mapping:RankFeaturesProperty: + _common.mapping___RankFeaturesProperty: allOf: - - $ref: '#/components/schemas/_common.mapping:PropertyBase' + - $ref: '#/components/schemas/_common.mapping___PropertyBase' - type: object properties: type: @@ -38560,63 +40238,16 @@ components: - rank_features required: - type - _common.mapping:RoutingField: + _common.mapping___RoutingField: type: object properties: required: type: boolean required: - required - _common.mapping:RuntimeField: - type: object - properties: - fetch_fields: - description: For type `lookup` - type: array - items: - $ref: '#/components/schemas/_common.mapping:RuntimeFieldFetchFields' - format: - description: A custom format for `date` type runtime fields. - type: string - input_field: - $ref: '#/components/schemas/_common:Field' - target_field: - $ref: '#/components/schemas/_common:Field' - target_index: - $ref: '#/components/schemas/_common:IndexName' - script: - $ref: '#/components/schemas/_common:Script' - type: - $ref: '#/components/schemas/_common.mapping:RuntimeFieldType' - required: - - type - _common.mapping:RuntimeFieldFetchFields: - type: object - properties: - field: - $ref: '#/components/schemas/_common:Field' - format: - type: string - required: - - field - _common.mapping:RuntimeFields: - type: object - additionalProperties: - $ref: '#/components/schemas/_common.mapping:RuntimeField' - _common.mapping:RuntimeFieldType: - type: string - enum: - - boolean - - date - - double - - geo_point - - ip - - keyword - - long - - lookup - _common.mapping:ScaledFloatNumberProperty: + _common.mapping___ScaledFloatNumberProperty: allOf: - - $ref: '#/components/schemas/_common.mapping:NumberPropertyBase' + - $ref: '#/components/schemas/_common.mapping___NumberPropertyBase' - type: object properties: type: @@ -38631,9 +40262,9 @@ components: format: double required: - type - _common.mapping:SearchAsYouTypeProperty: + _common.mapping___SearchAsYouTypeProperty: allOf: - - $ref: '#/components/schemas/_common.mapping:CorePropertyBase' + - $ref: '#/components/schemas/_common.mapping___CorePropertyBase' - type: object properties: analyzer: @@ -38641,7 +40272,7 @@ components: index: type: boolean index_options: - $ref: '#/components/schemas/_common.mapping:IndexOptions' + $ref: '#/components/schemas/_common.mapping___IndexOptions' max_shingle_size: type: integer norms: @@ -38651,16 +40282,16 @@ components: search_quote_analyzer: type: string term_vector: - $ref: '#/components/schemas/_common.mapping:TermVectorOption' + $ref: '#/components/schemas/_common.mapping___TermVectorOption' type: type: string enum: - search_as_you_type required: - type - _common.mapping:ShortNumberProperty: + _common.mapping___ShortNumberProperty: allOf: - - $ref: '#/components/schemas/_common.mapping:NumberPropertyBase' + - $ref: '#/components/schemas/_common.mapping___NumberPropertyBase' - type: object properties: type: @@ -38668,17 +40299,17 @@ components: enum: - short null_value: - $ref: '#/components/schemas/_common:short' + $ref: '#/components/schemas/_common___short' required: - type - _common.mapping:SizeField: + _common.mapping___SizeField: type: object properties: enabled: type: boolean required: - enabled - _common.mapping:SourceField: + _common.mapping___SourceField: type: object properties: compress: @@ -38695,32 +40326,13 @@ components: type: array items: type: string - mode: - $ref: '#/components/schemas/_common.mapping:SourceFieldMode' - _common.mapping:SourceFieldMode: - type: string - enum: - - disabled - - stored - - synthetic - _common.mapping:SparseVectorProperty: - allOf: - - $ref: '#/components/schemas/_common.mapping:PropertyBase' - - type: object - properties: - type: - type: string - enum: - - sparse_vector - required: - - type - _common.mapping:SuggestContext: + _common.mapping___SuggestContext: type: object properties: name: - $ref: '#/components/schemas/_common:Name' + $ref: '#/components/schemas/_common___Name' path: - $ref: '#/components/schemas/_common:Field' + $ref: '#/components/schemas/_common___Field' type: type: string precision: @@ -38730,7 +40342,7 @@ components: required: - name - type - _common.mapping:TermVectorOption: + _common.mapping___TermVectorOption: type: string enum: - 'no' @@ -38740,7 +40352,7 @@ components: - with_positions_offsets_payloads - with_positions_payloads - 'yes' - _common.mapping:TextIndexPrefixes: + _common.mapping___TextIndexPrefixes: type: object properties: max_chars: @@ -38750,9 +40362,9 @@ components: required: - max_chars - min_chars - _common.mapping:TextProperty: + _common.mapping___TextProperty: allOf: - - $ref: '#/components/schemas/_common.mapping:CorePropertyBase' + - $ref: '#/components/schemas/_common.mapping___CorePropertyBase' - type: object properties: analyzer: @@ -38765,15 +40377,15 @@ components: fielddata: type: boolean fielddata_frequency_filter: - $ref: '#/components/schemas/indices._common:FielddataFrequencyFilter' + $ref: '#/components/schemas/indices._common___FielddataFrequencyFilter' index: type: boolean index_options: - $ref: '#/components/schemas/_common.mapping:IndexOptions' + $ref: '#/components/schemas/_common.mapping___IndexOptions' index_phrases: type: boolean index_prefixes: - $ref: '#/components/schemas/_common.mapping:TextIndexPrefixes' + $ref: '#/components/schemas/_common.mapping___TextIndexPrefixes' norms: type: boolean position_increment_gap: @@ -38783,24 +40395,16 @@ components: search_quote_analyzer: type: string term_vector: - $ref: '#/components/schemas/_common.mapping:TermVectorOption' + $ref: '#/components/schemas/_common.mapping___TermVectorOption' type: type: string enum: - text required: - type - _common.mapping:TimeSeriesMetricType: - type: string - enum: - - counter - - gauge - - histogram - - position - - summary - _common.mapping:TokenCountProperty: + _common.mapping___TokenCountProperty: allOf: - - $ref: '#/components/schemas/_common.mapping:DocValuesPropertyBase' + - $ref: '#/components/schemas/_common.mapping___DocValuesPropertyBase' - type: object properties: analyzer: @@ -38821,15 +40425,15 @@ components: - token_count required: - type - _common.mapping:TypeMapping: + _common.mapping___TypeMapping: type: object properties: all_field: - $ref: '#/components/schemas/_common.mapping:AllField' + $ref: '#/components/schemas/_common.mapping___AllField' date_detection: type: boolean dynamic: - $ref: '#/components/schemas/_common.mapping:DynamicMapping' + $ref: '#/components/schemas/_common.mapping___DynamicMapping' dynamic_date_formats: type: array items: @@ -38839,36 +40443,32 @@ components: items: type: object additionalProperties: - $ref: '#/components/schemas/_common.mapping:DynamicTemplate' + $ref: '#/components/schemas/_common.mapping___DynamicTemplate' _field_names: - $ref: '#/components/schemas/_common.mapping:FieldNamesField' + $ref: '#/components/schemas/_common.mapping___FieldNamesField' index_field: - $ref: '#/components/schemas/_common.mapping:IndexField' + $ref: '#/components/schemas/_common.mapping___IndexField' _meta: - $ref: '#/components/schemas/_common:Metadata' + $ref: '#/components/schemas/_common___Metadata' numeric_detection: type: boolean properties: type: object additionalProperties: - $ref: '#/components/schemas/_common.mapping:Property' + $ref: '#/components/schemas/_common.mapping___Property' _routing: - $ref: '#/components/schemas/_common.mapping:RoutingField' + $ref: '#/components/schemas/_common.mapping___RoutingField' _size: - $ref: '#/components/schemas/_common.mapping:SizeField' + $ref: '#/components/schemas/_common.mapping___SizeField' _source: - $ref: '#/components/schemas/_common.mapping:SourceField' - runtime: - type: object - additionalProperties: - $ref: '#/components/schemas/_common.mapping:RuntimeField' + $ref: '#/components/schemas/_common.mapping___SourceField' enabled: type: boolean _data_stream_timestamp: - $ref: '#/components/schemas/_common.mapping:DataStreamTimestamp' - _common.mapping:UnsignedLongNumberProperty: + $ref: '#/components/schemas/_common.mapping___DataStreamTimestamp' + _common.mapping___UnsignedLongNumberProperty: allOf: - - $ref: '#/components/schemas/_common.mapping:NumberPropertyBase' + - $ref: '#/components/schemas/_common.mapping___NumberPropertyBase' - type: object properties: type: @@ -38876,12 +40476,12 @@ components: enum: - unsigned_long null_value: - $ref: '#/components/schemas/_common:ulong' + $ref: '#/components/schemas/_common___ulong' required: - type - _common.mapping:VersionProperty: + _common.mapping___VersionProperty: allOf: - - $ref: '#/components/schemas/_common.mapping:DocValuesPropertyBase' + - $ref: '#/components/schemas/_common.mapping___DocValuesPropertyBase' - type: object properties: type: @@ -38890,9 +40490,9 @@ components: - version required: - type - _common.mapping:WildcardProperty: + _common.mapping___WildcardProperty: allOf: - - $ref: '#/components/schemas/_common.mapping:DocValuesPropertyBase' + - $ref: '#/components/schemas/_common.mapping___DocValuesPropertyBase' - type: object properties: type: @@ -38903,10 +40503,10 @@ components: type: string required: - type - _common.mapping:XyPointProperty: + _common.mapping___XyPointProperty: x-version-added: '2.4' allOf: - - $ref: '#/components/schemas/_common.mapping:DocValuesPropertyBase' + - $ref: '#/components/schemas/_common.mapping___DocValuesPropertyBase' - type: object properties: ignore_malformed: @@ -38914,17 +40514,17 @@ components: ignore_z_value: type: boolean null_value: - $ref: '#/components/schemas/_common:XyLocation' + $ref: '#/components/schemas/_common___XyLocation' type: type: string enum: - xy_point required: - type - _common.mapping:XyShapeProperty: + _common.mapping___XyShapeProperty: x-version-added: '2.4' allOf: - - $ref: '#/components/schemas/_common.mapping:DocValuesPropertyBase' + - $ref: '#/components/schemas/_common.mapping___DocValuesPropertyBase' - type: object properties: coerce: @@ -38934,16 +40534,16 @@ components: ignore_z_value: type: boolean orientation: - $ref: '#/components/schemas/_common.mapping:GeoOrientation' + $ref: '#/components/schemas/_common.mapping___GeoOrientation' type: type: string enum: - xy_shape required: - type - _common.query_dsl:BoolQuery: + _common.query_dsl___BoolQuery: allOf: - - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - $ref: '#/components/schemas/_common.query_dsl___QueryBase' - type: object properties: filter: @@ -38951,38 +40551,45 @@ components: The clause (query) must appear in matching documents. However, unlike `must`, the score of the query will be ignored. oneOf: - - $ref: '#/components/schemas/_common.query_dsl:QueryContainer' + - $ref: '#/components/schemas/_common.query_dsl___QueryContainer' - type: array items: - $ref: '#/components/schemas/_common.query_dsl:QueryContainer' + $ref: '#/components/schemas/_common.query_dsl___QueryContainer' minimum_should_match: - $ref: '#/components/schemas/_common:MinimumShouldMatch' + $ref: '#/components/schemas/_common___MinimumShouldMatch' must: description: The clause (query) must appear in matching documents and will contribute to the score. oneOf: - - $ref: '#/components/schemas/_common.query_dsl:QueryContainer' + - $ref: '#/components/schemas/_common.query_dsl___QueryContainer' - type: array items: - $ref: '#/components/schemas/_common.query_dsl:QueryContainer' + $ref: '#/components/schemas/_common.query_dsl___QueryContainer' must_not: description: |- The clause (query) must not appear in the matching documents. Because scoring is ignored, a score of `0` is returned for all documents. oneOf: - - $ref: '#/components/schemas/_common.query_dsl:QueryContainer' + - $ref: '#/components/schemas/_common.query_dsl___QueryContainer' - type: array items: - $ref: '#/components/schemas/_common.query_dsl:QueryContainer' + $ref: '#/components/schemas/_common.query_dsl___QueryContainer' should: description: The clause (query) should appear in the matching document. oneOf: - - $ref: '#/components/schemas/_common.query_dsl:QueryContainer' + - $ref: '#/components/schemas/_common.query_dsl___QueryContainer' - type: array items: - $ref: '#/components/schemas/_common.query_dsl:QueryContainer' - _common.query_dsl:BoostingQuery: + $ref: '#/components/schemas/_common.query_dsl___QueryContainer' + adjust_pure_negative: + description: |- + Ensures correct behavior when a query contains only `must_not` clauses. + By default set to true, OpenSearch adds a match-all clause to ensure results are returned from Lucene, with the `must_not` conditions applied as filters. + If set to false, the query may return no results, as Lucene typically requires at least one positive condition. + type: boolean + default: true + _common.query_dsl___BoostingQuery: allOf: - - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - $ref: '#/components/schemas/_common.query_dsl___QueryBase' - type: object properties: negative_boost: @@ -38990,14 +40597,14 @@ components: type: number format: float negative: - $ref: '#/components/schemas/_common.query_dsl:QueryContainer' + $ref: '#/components/schemas/_common.query_dsl___QueryContainer' positive: - $ref: '#/components/schemas/_common.query_dsl:QueryContainer' + $ref: '#/components/schemas/_common.query_dsl___QueryContainer' required: - negative - negative_boost - positive - _common.query_dsl:ChildScoreMode: + _common.query_dsl___ChildScoreMode: type: string enum: - avg @@ -39005,46 +40612,46 @@ components: - min - none - sum - _common.query_dsl:CombinedFieldsOperator: + _common.query_dsl___CombinedFieldsOperator: type: string enum: - and - or - _common.query_dsl:CombinedFieldsQuery: + _common.query_dsl___CombinedFieldsQuery: allOf: - - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - $ref: '#/components/schemas/_common.query_dsl___QueryBase' - type: object properties: fields: description: List of fields to search. Field wildcard patterns are allowed. Only `text` fields are supported, and they must all have the same search `analyzer`. type: array items: - $ref: '#/components/schemas/_common:Field' + $ref: '#/components/schemas/_common___Field' query: description: |- Text to search for in the provided `fields`. The `combined_fields` query analyzes the provided text before performing a search. type: string auto_generate_synonyms_phrase_query: - description: If true, match phrase queries are automatically created for multi-term synonyms. + description: If `true`, match phrase queries are automatically created for multi-term synonyms. type: boolean operator: - $ref: '#/components/schemas/_common.query_dsl:CombinedFieldsOperator' + $ref: '#/components/schemas/_common.query_dsl___CombinedFieldsOperator' minimum_should_match: - $ref: '#/components/schemas/_common:MinimumShouldMatch' + $ref: '#/components/schemas/_common___MinimumShouldMatch' zero_terms_query: - $ref: '#/components/schemas/_common.query_dsl:CombinedFieldsZeroTerms' + $ref: '#/components/schemas/_common.query_dsl___CombinedFieldsZeroTerms' required: - fields - query - _common.query_dsl:CombinedFieldsZeroTerms: + _common.query_dsl___CombinedFieldsZeroTerms: type: string enum: - all - none - _common.query_dsl:CommonTermsQuery: + _common.query_dsl___CommonTermsQuery: allOf: - - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - $ref: '#/components/schemas/_common.query_dsl___QueryBase' - type: object properties: analyzer: @@ -39053,70 +40660,70 @@ components: type: number format: float high_freq_operator: - $ref: '#/components/schemas/_common.query_dsl:Operator' + $ref: '#/components/schemas/_common.query_dsl___Operator' low_freq_operator: - $ref: '#/components/schemas/_common.query_dsl:Operator' + $ref: '#/components/schemas/_common.query_dsl___Operator' minimum_should_match: - $ref: '#/components/schemas/_common:MinimumShouldMatch' + $ref: '#/components/schemas/_common___MinimumShouldMatch' query: type: string required: - query - _common.query_dsl:ConstantScoreQuery: + _common.query_dsl___ConstantScoreQuery: allOf: - - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - $ref: '#/components/schemas/_common.query_dsl___QueryBase' - type: object properties: filter: - $ref: '#/components/schemas/_common.query_dsl:QueryContainer' + $ref: '#/components/schemas/_common.query_dsl___QueryContainer' required: - filter - _common.query_dsl:DateDecayFunction: + _common.query_dsl___DateDecayFunction: allOf: - - $ref: '#/components/schemas/_common.query_dsl:DecayFunctionBase' + - $ref: '#/components/schemas/_common.query_dsl___DecayFunctionBase' - type: object - _common.query_dsl:DateDistanceFeatureQuery: + _common.query_dsl___DateDistanceFeatureQuery: allOf: - - $ref: '#/components/schemas/_common.query_dsl:DistanceFeatureQueryBaseDateMathDuration' + - $ref: '#/components/schemas/_common.query_dsl___DistanceFeatureQueryBaseDateMathDuration' - type: object - _common.query_dsl:DateRangeQuery: + _common.query_dsl___DateRangeQuery: allOf: - - $ref: '#/components/schemas/_common.query_dsl:RangeQueryBase' + - $ref: '#/components/schemas/_common.query_dsl___RangeQueryBase' - type: object properties: gt: - $ref: '#/components/schemas/_common:DateMath' + $ref: '#/components/schemas/_common___DateMath' gte: - $ref: '#/components/schemas/_common:DateMath' + $ref: '#/components/schemas/_common___DateMath' lt: - $ref: '#/components/schemas/_common:DateMath' + $ref: '#/components/schemas/_common___DateMath' lte: - $ref: '#/components/schemas/_common:DateMath' + $ref: '#/components/schemas/_common___DateMath' from: oneOf: - - $ref: '#/components/schemas/_common:DateMath' + - $ref: '#/components/schemas/_common___DateMath' - type: 'null' to: oneOf: - - $ref: '#/components/schemas/_common:DateMath' + - $ref: '#/components/schemas/_common___DateMath' - type: 'null' format: - $ref: '#/components/schemas/_common:DateFormat' + $ref: '#/components/schemas/_common___DateFormat' time_zone: - $ref: '#/components/schemas/_common:TimeZone' - _common.query_dsl:DecayFunction: + $ref: '#/components/schemas/_common___TimeZone' + _common.query_dsl___DecayFunction: oneOf: - - $ref: '#/components/schemas/_common.query_dsl:DateDecayFunction' - - $ref: '#/components/schemas/_common.query_dsl:NumericDecayFunction' - - $ref: '#/components/schemas/_common.query_dsl:GeoDecayFunction' - _common.query_dsl:DecayFunctionBase: + - $ref: '#/components/schemas/_common.query_dsl___DateDecayFunction' + - $ref: '#/components/schemas/_common.query_dsl___NumericDecayFunction' + - $ref: '#/components/schemas/_common.query_dsl___GeoDecayFunction' + _common.query_dsl___DecayFunctionBase: type: object properties: multi_value_mode: - $ref: '#/components/schemas/_common.query_dsl:MultiValueMode' - _common.query_dsl:DisMaxQuery: + $ref: '#/components/schemas/_common.query_dsl___MultiValueMode' + _common.query_dsl___DisMaxQuery: allOf: - - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - $ref: '#/components/schemas/_common.query_dsl___QueryBase' - type: object properties: queries: @@ -39126,61 +40733,61 @@ components: If a document matches multiple queries, OpenSearch uses the highest relevance score. type: array items: - $ref: '#/components/schemas/_common.query_dsl:QueryContainer' + $ref: '#/components/schemas/_common.query_dsl___QueryContainer' tie_breaker: description: Floating point number between 0 and 1.0 used to increase the relevance scores of documents matching multiple query clauses. type: number format: float required: - queries - _common.query_dsl:DistanceFeatureQuery: + _common.query_dsl___DistanceFeatureQuery: oneOf: - - $ref: '#/components/schemas/_common.query_dsl:GeoDistanceFeatureQuery' - - $ref: '#/components/schemas/_common.query_dsl:DateDistanceFeatureQuery' - _common.query_dsl:DistanceFeatureQueryBaseDateMathDuration: + - $ref: '#/components/schemas/_common.query_dsl___GeoDistanceFeatureQuery' + - $ref: '#/components/schemas/_common.query_dsl___DateDistanceFeatureQuery' + _common.query_dsl___DistanceFeatureQueryBaseDateMathDuration: allOf: - - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - $ref: '#/components/schemas/_common.query_dsl___QueryBase' - type: object properties: origin: - $ref: '#/components/schemas/_common:DateMath' + $ref: '#/components/schemas/_common___DateMath' pivot: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' field: - $ref: '#/components/schemas/_common:Field' + $ref: '#/components/schemas/_common___Field' required: - field - origin - pivot - _common.query_dsl:DistanceFeatureQueryBaseGeoLocationDistance: + _common.query_dsl___DistanceFeatureQueryBaseGeoLocationDistance: allOf: - - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - $ref: '#/components/schemas/_common.query_dsl___QueryBase' - type: object properties: origin: - $ref: '#/components/schemas/_common:GeoLocation' + $ref: '#/components/schemas/_common___GeoLocation' pivot: - $ref: '#/components/schemas/_common:Distance' + $ref: '#/components/schemas/_common___Distance' field: - $ref: '#/components/schemas/_common:Field' + $ref: '#/components/schemas/_common___Field' required: - field - origin - pivot - _common.query_dsl:ExistsQuery: + _common.query_dsl___ExistsQuery: allOf: - - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - $ref: '#/components/schemas/_common.query_dsl___QueryBase' - type: object properties: field: - $ref: '#/components/schemas/_common:Field' + $ref: '#/components/schemas/_common___Field' required: - field - _common.query_dsl:FieldAndFormat: + _common.query_dsl___FieldAndFormat: type: object properties: field: - $ref: '#/components/schemas/_common:Field' + $ref: '#/components/schemas/_common___Field' format: description: Format in which the values are returned. type: string @@ -39188,7 +40795,7 @@ components: type: boolean required: - field - _common.query_dsl:FieldValueFactorModifier: + _common.query_dsl___FieldValueFactorModifier: type: string enum: - ln @@ -39201,11 +40808,11 @@ components: - reciprocal - sqrt - square - _common.query_dsl:FieldValueFactorScoreFunction: + _common.query_dsl___FieldValueFactorScoreFunction: type: object properties: field: - $ref: '#/components/schemas/_common:Field' + $ref: '#/components/schemas/_common___Field' factor: description: Optional factor to multiply the field value with. type: number @@ -39217,10 +40824,10 @@ components: type: number format: double modifier: - $ref: '#/components/schemas/_common.query_dsl:FieldValueFactorModifier' + $ref: '#/components/schemas/_common.query_dsl___FieldValueFactorModifier' required: - field - _common.query_dsl:FunctionBoostMode: + _common.query_dsl___FunctionBoostMode: type: string enum: - avg @@ -39229,32 +40836,32 @@ components: - multiply - replace - sum - _common.query_dsl:FunctionScoreContainer: + _common.query_dsl___FunctionScoreContainer: allOf: - type: object properties: filter: - $ref: '#/components/schemas/_common.query_dsl:QueryContainer' + $ref: '#/components/schemas/_common.query_dsl___QueryContainer' weight: type: number format: float - type: object properties: exp: - $ref: '#/components/schemas/_common.query_dsl:DecayFunction' + $ref: '#/components/schemas/_common.query_dsl___DecayFunction' gauss: - $ref: '#/components/schemas/_common.query_dsl:DecayFunction' + $ref: '#/components/schemas/_common.query_dsl___DecayFunction' linear: - $ref: '#/components/schemas/_common.query_dsl:DecayFunction' + $ref: '#/components/schemas/_common.query_dsl___DecayFunction' field_value_factor: - $ref: '#/components/schemas/_common.query_dsl:FieldValueFactorScoreFunction' + $ref: '#/components/schemas/_common.query_dsl___FieldValueFactorScoreFunction' random_score: - $ref: '#/components/schemas/_common.query_dsl:RandomScoreFunction' + $ref: '#/components/schemas/_common.query_dsl___RandomScoreFunction' script_score: - $ref: '#/components/schemas/_common.query_dsl:ScriptScoreFunction' + $ref: '#/components/schemas/_common.query_dsl___ScriptScoreFunction' minProperties: 1 maxProperties: 1 - _common.query_dsl:FunctionScoreMode: + _common.query_dsl___FunctionScoreMode: type: string enum: - avg @@ -39263,18 +40870,18 @@ components: - min - multiply - sum - _common.query_dsl:FunctionScoreQuery: + _common.query_dsl___FunctionScoreQuery: allOf: - - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - $ref: '#/components/schemas/_common.query_dsl___QueryBase' - type: object properties: boost_mode: - $ref: '#/components/schemas/_common.query_dsl:FunctionBoostMode' + $ref: '#/components/schemas/_common.query_dsl___FunctionBoostMode' functions: description: One or more functions that compute a new score for each document returned by the query. type: array items: - $ref: '#/components/schemas/_common.query_dsl:FunctionScoreContainer' + $ref: '#/components/schemas/_common.query_dsl___FunctionScoreContainer' max_boost: description: Restricts the new score to not exceed the provided limit. type: number @@ -39284,12 +40891,12 @@ components: type: number format: float query: - $ref: '#/components/schemas/_common.query_dsl:QueryContainer' + $ref: '#/components/schemas/_common.query_dsl___QueryContainer' score_mode: - $ref: '#/components/schemas/_common.query_dsl:FunctionScoreMode' - _common.query_dsl:FuzzyQuery: + $ref: '#/components/schemas/_common.query_dsl___FunctionScoreMode' + _common.query_dsl___FuzzyQuery: allOf: - - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - $ref: '#/components/schemas/_common.query_dsl___QueryBase' - type: object properties: max_expansions: @@ -39301,12 +40908,12 @@ components: type: integer format: int32 rewrite: - $ref: '#/components/schemas/_common:MultiTermQueryRewrite' + $ref: '#/components/schemas/_common___MultiTermQueryRewrite' transpositions: - description: Indicates whether edits include transpositions of two adjacent characters (for example `ab` to `ba`). + description: Indicates whether edits include transpositions of two adjacent characters (for example, `ab` to `ba`). type: boolean fuzziness: - $ref: '#/components/schemas/_common:Fuzziness' + $ref: '#/components/schemas/_common___Fuzziness' value: description: Term you wish to find in the provided field. oneOf: @@ -39315,102 +40922,102 @@ components: - type: boolean required: - value - _common.query_dsl:GeoBoundingBoxQuery: + _common.query_dsl___GeoBoundingBoxQuery: allOf: - - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - $ref: '#/components/schemas/_common.query_dsl___QueryBase' - type: object properties: type: - $ref: '#/components/schemas/_common.query_dsl:GeoExecution' + $ref: '#/components/schemas/_common.query_dsl___GeoExecution' validation_method: - $ref: '#/components/schemas/_common.query_dsl:GeoValidationMethod' + $ref: '#/components/schemas/_common.query_dsl___GeoValidationMethod' ignore_unmapped: - $ref: '#/components/schemas/_common.query_dsl:IgnoreUnmapped' + $ref: '#/components/schemas/_common.query_dsl___IgnoreUnmapped' additionalProperties: - $ref: '#/components/schemas/_common:GeoBounds' + $ref: '#/components/schemas/_common___GeoBounds' minProperties: 1 - _common.query_dsl:GeoDecayFunction: + _common.query_dsl___GeoDecayFunction: allOf: - - $ref: '#/components/schemas/_common.query_dsl:DecayFunctionBase' + - $ref: '#/components/schemas/_common.query_dsl___DecayFunctionBase' - type: object - _common.query_dsl:GeoDistanceFeatureQuery: + _common.query_dsl___GeoDistanceFeatureQuery: allOf: - - $ref: '#/components/schemas/_common.query_dsl:DistanceFeatureQueryBaseGeoLocationDistance' + - $ref: '#/components/schemas/_common.query_dsl___DistanceFeatureQueryBaseGeoLocationDistance' - type: object - _common.query_dsl:GeoDistanceQuery: + _common.query_dsl___GeoDistanceQuery: allOf: - - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - $ref: '#/components/schemas/_common.query_dsl___QueryBase' - type: object properties: distance: - $ref: '#/components/schemas/_common:Distance' + $ref: '#/components/schemas/_common___Distance' distance_type: - $ref: '#/components/schemas/_common:GeoDistanceType' + $ref: '#/components/schemas/_common___GeoDistanceType' validation_method: - $ref: '#/components/schemas/_common.query_dsl:GeoValidationMethod' + $ref: '#/components/schemas/_common.query_dsl___GeoValidationMethod' ignore_unmapped: - $ref: '#/components/schemas/_common.query_dsl:IgnoreUnmapped' + $ref: '#/components/schemas/_common.query_dsl___IgnoreUnmapped' additionalProperties: - $ref: '#/components/schemas/_common:GeoLocation' + $ref: '#/components/schemas/_common___GeoLocation' minProperties: 2 required: - distance - _common.query_dsl:GeoExecution: + _common.query_dsl___GeoExecution: type: string enum: - indexed - memory - _common.query_dsl:GeoPolygonQuery: + _common.query_dsl___GeoPolygonQuery: allOf: - - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - $ref: '#/components/schemas/_common.query_dsl___QueryBase' - type: object properties: validation_method: - $ref: '#/components/schemas/_common.query_dsl:GeoValidationMethod' + $ref: '#/components/schemas/_common.query_dsl___GeoValidationMethod' ignore_unmapped: - $ref: '#/components/schemas/_common.query_dsl:IgnoreUnmapped' - _common.query_dsl:GeoShape: + $ref: '#/components/schemas/_common.query_dsl___IgnoreUnmapped' + _common.query_dsl___GeoShape: type: object properties: type: type: string coordinates: type: array - _common.query_dsl:GeoShapeField: + _common.query_dsl___GeoShapeField: type: object properties: shape: - $ref: '#/components/schemas/_common.query_dsl:GeoShape' + $ref: '#/components/schemas/_common.query_dsl___GeoShape' relation: - $ref: '#/components/schemas/_common:GeoShapeRelation' + $ref: '#/components/schemas/_common___GeoShapeRelation' required: - shape - _common.query_dsl:GeoShapeQuery: + _common.query_dsl___GeoShapeQuery: allOf: - - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - $ref: '#/components/schemas/_common.query_dsl___QueryBase' - type: object properties: ignore_unmapped: - $ref: '#/components/schemas/_common.query_dsl:IgnoreUnmapped' + $ref: '#/components/schemas/_common.query_dsl___IgnoreUnmapped' additionalProperties: - $ref: '#/components/schemas/_common.query_dsl:GeoShapeField' + $ref: '#/components/schemas/_common.query_dsl___GeoShapeField' minProperties: 1 - _common.query_dsl:GeoValidationMethod: + _common.query_dsl___GeoValidationMethod: type: string enum: - coerce - ignore_malformed - strict - _common.query_dsl:HasChildQuery: + _common.query_dsl___HasChildQuery: allOf: - - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - $ref: '#/components/schemas/_common.query_dsl___QueryBase' - type: object properties: ignore_unmapped: - $ref: '#/components/schemas/_common.query_dsl:IgnoreUnmapped' + $ref: '#/components/schemas/_common.query_dsl___IgnoreUnmapped' description: Indicates whether to ignore an unmapped `type` and not return any documents instead of an error. inner_hits: - $ref: '#/components/schemas/_core.search:InnerHits' + $ref: '#/components/schemas/_core.search___InnerHits' max_children: description: |- Maximum number of child documents that match the query allowed for a returned parent document. @@ -39424,57 +41031,57 @@ components: type: integer format: int32 query: - $ref: '#/components/schemas/_common.query_dsl:QueryContainer' + $ref: '#/components/schemas/_common.query_dsl___QueryContainer' score_mode: - $ref: '#/components/schemas/_common.query_dsl:ChildScoreMode' + $ref: '#/components/schemas/_common.query_dsl___ChildScoreMode' type: - $ref: '#/components/schemas/_common:RelationName' + $ref: '#/components/schemas/_common___RelationName' required: - query - type - _common.query_dsl:HasParentQuery: + _common.query_dsl___HasParentQuery: allOf: - - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - $ref: '#/components/schemas/_common.query_dsl___QueryBase' - type: object properties: ignore_unmapped: - $ref: '#/components/schemas/_common.query_dsl:IgnoreUnmapped' + $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`. + You can use this parameter to query multiple indexes that may not contain the `parent_type`. inner_hits: - $ref: '#/components/schemas/_core.search:InnerHits' + $ref: '#/components/schemas/_core.search___InnerHits' parent_type: - $ref: '#/components/schemas/_common:RelationName' + $ref: '#/components/schemas/_common___RelationName' query: - $ref: '#/components/schemas/_common.query_dsl:QueryContainer' + $ref: '#/components/schemas/_common.query_dsl___QueryContainer' score: description: Indicates whether the relevance score of a matching parent document is aggregated into its child documents. type: boolean required: - parent_type - query - _common.query_dsl:IdsQuery: + _common.query_dsl___IdsQuery: allOf: - - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - $ref: '#/components/schemas/_common.query_dsl___QueryBase' - type: object properties: values: - $ref: '#/components/schemas/_common:Ids' - _common.query_dsl:IgnoreUnmapped: + $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: + _common.query_dsl___IntervalsAllOf: type: object properties: intervals: description: An array of rules to combine. All rules must produce a match in a document for the overall source to match. type: array items: - $ref: '#/components/schemas/_common.query_dsl:IntervalsContainer' + $ref: '#/components/schemas/_common.query_dsl___IntervalsContainer' max_gaps: description: |- Maximum number of positions between the matching terms. @@ -39485,69 +41092,69 @@ components: description: If `true`, intervals produced by the rules should appear in the order in which they are specified. type: boolean filter: - $ref: '#/components/schemas/_common.query_dsl:IntervalsFilter' + $ref: '#/components/schemas/_common.query_dsl___IntervalsFilter' required: - intervals - _common.query_dsl:IntervalsAnyOf: + _common.query_dsl___IntervalsAnyOf: type: object properties: intervals: description: An array of rules to match. type: array items: - $ref: '#/components/schemas/_common.query_dsl:IntervalsContainer' + $ref: '#/components/schemas/_common.query_dsl___IntervalsContainer' filter: - $ref: '#/components/schemas/_common.query_dsl:IntervalsFilter' + $ref: '#/components/schemas/_common.query_dsl___IntervalsFilter' required: - intervals - _common.query_dsl:IntervalsContainer: + _common.query_dsl___IntervalsContainer: type: object properties: all_of: - $ref: '#/components/schemas/_common.query_dsl:IntervalsAllOf' + $ref: '#/components/schemas/_common.query_dsl___IntervalsAllOf' any_of: - $ref: '#/components/schemas/_common.query_dsl:IntervalsAnyOf' + $ref: '#/components/schemas/_common.query_dsl___IntervalsAnyOf' fuzzy: - $ref: '#/components/schemas/_common.query_dsl:IntervalsFuzzy' + $ref: '#/components/schemas/_common.query_dsl___IntervalsFuzzy' match: - $ref: '#/components/schemas/_common.query_dsl:IntervalsMatch' + $ref: '#/components/schemas/_common.query_dsl___IntervalsMatch' prefix: - $ref: '#/components/schemas/_common.query_dsl:IntervalsPrefix' + $ref: '#/components/schemas/_common.query_dsl___IntervalsPrefix' wildcard: - $ref: '#/components/schemas/_common.query_dsl:IntervalsWildcard' + $ref: '#/components/schemas/_common.query_dsl___IntervalsWildcard' minProperties: 1 maxProperties: 1 - _common.query_dsl:IntervalsFilter: + _common.query_dsl___IntervalsFilter: type: object properties: after: - $ref: '#/components/schemas/_common.query_dsl:IntervalsContainer' + $ref: '#/components/schemas/_common.query_dsl___IntervalsContainer' before: - $ref: '#/components/schemas/_common.query_dsl:IntervalsContainer' + $ref: '#/components/schemas/_common.query_dsl___IntervalsContainer' contained_by: - $ref: '#/components/schemas/_common.query_dsl:IntervalsContainer' + $ref: '#/components/schemas/_common.query_dsl___IntervalsContainer' containing: - $ref: '#/components/schemas/_common.query_dsl:IntervalsContainer' + $ref: '#/components/schemas/_common.query_dsl___IntervalsContainer' not_contained_by: - $ref: '#/components/schemas/_common.query_dsl:IntervalsContainer' + $ref: '#/components/schemas/_common.query_dsl___IntervalsContainer' not_containing: - $ref: '#/components/schemas/_common.query_dsl:IntervalsContainer' + $ref: '#/components/schemas/_common.query_dsl___IntervalsContainer' not_overlapping: - $ref: '#/components/schemas/_common.query_dsl:IntervalsContainer' + $ref: '#/components/schemas/_common.query_dsl___IntervalsContainer' overlapping: - $ref: '#/components/schemas/_common.query_dsl:IntervalsContainer' + $ref: '#/components/schemas/_common.query_dsl___IntervalsContainer' script: - $ref: '#/components/schemas/_common:Script' + $ref: '#/components/schemas/_common___Script' minProperties: 1 maxProperties: 1 - _common.query_dsl:IntervalsFuzzy: + _common.query_dsl___IntervalsFuzzy: type: object properties: analyzer: description: Analyzer used to normalize the term. type: string fuzziness: - $ref: '#/components/schemas/_common:Fuzziness' + $ref: '#/components/schemas/_common___Fuzziness' prefix_length: description: Number of beginning characters left unchanged when creating expansions. type: integer @@ -39559,10 +41166,10 @@ components: description: Indicates whether edits include transpositions of two adjacent characters (for example, `ab` to `ba`). type: boolean use_field: - $ref: '#/components/schemas/_common:Field' + $ref: '#/components/schemas/_common___Field' required: - term - _common.query_dsl:IntervalsMatch: + _common.query_dsl___IntervalsMatch: type: object properties: analyzer: @@ -39581,12 +41188,12 @@ components: description: Text you wish to find in the provided field. type: string use_field: - $ref: '#/components/schemas/_common:Field' + $ref: '#/components/schemas/_common___Field' filter: - $ref: '#/components/schemas/_common.query_dsl:IntervalsFilter' + $ref: '#/components/schemas/_common.query_dsl___IntervalsFilter' required: - query - _common.query_dsl:IntervalsPrefix: + _common.query_dsl___IntervalsPrefix: type: object properties: analyzer: @@ -39596,29 +41203,29 @@ components: description: Beginning characters of terms you wish to find in the top-level field. type: string use_field: - $ref: '#/components/schemas/_common:Field' + $ref: '#/components/schemas/_common___Field' required: - prefix - _common.query_dsl:IntervalsQuery: + _common.query_dsl___IntervalsQuery: allOf: - - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - $ref: '#/components/schemas/_common.query_dsl___QueryBase' - type: object properties: all_of: - $ref: '#/components/schemas/_common.query_dsl:IntervalsAllOf' + $ref: '#/components/schemas/_common.query_dsl___IntervalsAllOf' any_of: - $ref: '#/components/schemas/_common.query_dsl:IntervalsAnyOf' + $ref: '#/components/schemas/_common.query_dsl___IntervalsAnyOf' fuzzy: - $ref: '#/components/schemas/_common.query_dsl:IntervalsFuzzy' + $ref: '#/components/schemas/_common.query_dsl___IntervalsFuzzy' match: - $ref: '#/components/schemas/_common.query_dsl:IntervalsMatch' + $ref: '#/components/schemas/_common.query_dsl___IntervalsMatch' prefix: - $ref: '#/components/schemas/_common.query_dsl:IntervalsPrefix' + $ref: '#/components/schemas/_common.query_dsl___IntervalsPrefix' wildcard: - $ref: '#/components/schemas/_common.query_dsl:IntervalsWildcard' + $ref: '#/components/schemas/_common.query_dsl___IntervalsWildcard' minProperties: 1 maxProperties: 1 - _common.query_dsl:IntervalsWildcard: + _common.query_dsl___IntervalsWildcard: type: object properties: analyzer: @@ -39630,21 +41237,21 @@ components: description: Wildcard pattern used to find matching terms. type: string use_field: - $ref: '#/components/schemas/_common:Field' + $ref: '#/components/schemas/_common___Field' required: - pattern - _common.query_dsl:KnnQuery: + _common.query_dsl___KnnQuery: type: object additionalProperties: - $ref: '#/components/schemas/_common:KnnField' + $ref: '#/components/schemas/_common___KnnField' minProperties: 1 maxProperties: 1 - _common.query_dsl:Like: + _common.query_dsl___Like: description: Text that we want similar documents for or a lookup to a document's field for the text. oneOf: - type: string - - $ref: '#/components/schemas/_common.query_dsl:LikeDocument' - _common.query_dsl:LikeDocument: + - $ref: '#/components/schemas/_common.query_dsl___LikeDocument' + _common.query_dsl___LikeDocument: type: object properties: doc: @@ -39653,35 +41260,35 @@ components: fields: type: array items: - $ref: '#/components/schemas/_common:Field' + $ref: '#/components/schemas/_common___Field' _id: - $ref: '#/components/schemas/_common:Id' + $ref: '#/components/schemas/_common___Id' _index: - $ref: '#/components/schemas/_common:IndexName' + $ref: '#/components/schemas/_common___IndexName' per_field_analyzer: type: object additionalProperties: type: string routing: - $ref: '#/components/schemas/_common:Routing' + $ref: '#/components/schemas/_common___Routing' version: - $ref: '#/components/schemas/_common:VersionNumber' + $ref: '#/components/schemas/_common___VersionNumber' version_type: - $ref: '#/components/schemas/_common:VersionType' - _common.query_dsl:MatchAllQuery: - $ref: '#/components/schemas/_common.query_dsl:QueryBase' - _common.query_dsl:MatchBoolPrefixQuery: + $ref: '#/components/schemas/_common___VersionType' + _common.query_dsl___MatchAllQuery: + $ref: '#/components/schemas/_common.query_dsl___QueryBase' + _common.query_dsl___MatchBoolPrefixQuery: allOf: - - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - $ref: '#/components/schemas/_common.query_dsl___QueryBase' - type: object properties: analyzer: description: Analyzer used to convert the text in the query value into tokens. type: string fuzziness: - $ref: '#/components/schemas/_common:Fuzziness' + $ref: '#/components/schemas/_common___Fuzziness' fuzzy_rewrite: - $ref: '#/components/schemas/_common:MultiTermQueryRewrite' + $ref: '#/components/schemas/_common___MultiTermQueryRewrite' fuzzy_transpositions: description: |- If `true`, edits for fuzzy matching include transpositions of two adjacent characters (for example, `ab` to `ba`). @@ -39694,9 +41301,9 @@ components: type: integer format: int32 minimum_should_match: - $ref: '#/components/schemas/_common:MinimumShouldMatch' + $ref: '#/components/schemas/_common___MinimumShouldMatch' operator: - $ref: '#/components/schemas/_common.query_dsl:Operator' + $ref: '#/components/schemas/_common.query_dsl___Operator' prefix_length: description: |- Number of beginning characters left unchanged for fuzzy matching. @@ -39710,13 +41317,13 @@ components: type: string required: - query - _common.query_dsl:MatchNoneQuery: + _common.query_dsl___MatchNoneQuery: allOf: - - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - $ref: '#/components/schemas/_common.query_dsl___QueryBase' - type: object - _common.query_dsl:MatchPhrasePrefixQuery: + _common.query_dsl___MatchPhrasePrefixQuery: allOf: - - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - $ref: '#/components/schemas/_common.query_dsl___QueryBase' - type: object properties: analyzer: @@ -39734,12 +41341,12 @@ components: type: integer format: int32 zero_terms_query: - $ref: '#/components/schemas/_common.query_dsl:ZeroTermsQuery' + $ref: '#/components/schemas/_common.query_dsl___ZeroTermsQuery' required: - query - _common.query_dsl:MatchPhraseQuery: + _common.query_dsl___MatchPhraseQuery: allOf: - - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - $ref: '#/components/schemas/_common.query_dsl___QueryBase' - type: object properties: analyzer: @@ -39753,12 +41360,12 @@ components: type: integer format: int32 zero_terms_query: - $ref: '#/components/schemas/_common.query_dsl:ZeroTermsQuery' + $ref: '#/components/schemas/_common.query_dsl___ZeroTermsQuery' required: - query - _common.query_dsl:MatchQuery: + _common.query_dsl___MatchQuery: allOf: - - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - $ref: '#/components/schemas/_common.query_dsl___QueryBase' - type: object properties: analyzer: @@ -39772,9 +41379,9 @@ components: type: number format: float fuzziness: - $ref: '#/components/schemas/_common:Fuzziness' + $ref: '#/components/schemas/_common___Fuzziness' fuzzy_rewrite: - $ref: '#/components/schemas/_common:MultiTermQueryRewrite' + $ref: '#/components/schemas/_common___MultiTermQueryRewrite' fuzzy_transpositions: description: If `true`, edits for fuzzy matching include transpositions of two adjacent characters (for example, `ab` to `ba`). type: boolean @@ -39786,26 +41393,26 @@ components: type: integer format: int32 minimum_should_match: - $ref: '#/components/schemas/_common:MinimumShouldMatch' + $ref: '#/components/schemas/_common___MinimumShouldMatch' operator: - $ref: '#/components/schemas/_common.query_dsl:Operator' + $ref: '#/components/schemas/_common.query_dsl___Operator' prefix_length: description: Number of beginning characters left unchanged for fuzzy matching. type: integer format: int32 query: - description: Text, number, boolean value or date you wish to find in the provided field. + description: Text, number, Boolean value or date you wish to find in the provided field. oneOf: - type: string - type: number - type: boolean zero_terms_query: - $ref: '#/components/schemas/_common.query_dsl:ZeroTermsQuery' + $ref: '#/components/schemas/_common.query_dsl___ZeroTermsQuery' required: - query - _common.query_dsl:MoreLikeThisQuery: + _common.query_dsl___MoreLikeThisQuery: allOf: - - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - $ref: '#/components/schemas/_common.query_dsl___QueryBase' - type: object properties: analyzer: @@ -39829,17 +41436,17 @@ components: Defaults to the `index.query.default_field` index setting, which has a default value of `*`. type: array items: - $ref: '#/components/schemas/_common:Field' + $ref: '#/components/schemas/_common___Field' include: description: Specifies whether the input documents should also be included in the search results returned. type: boolean like: description: Specifies free form text and/or a single or multiple documents for which you want to find similar documents. oneOf: - - $ref: '#/components/schemas/_common.query_dsl:Like' + - $ref: '#/components/schemas/_common.query_dsl___Like' - type: array items: - $ref: '#/components/schemas/_common.query_dsl:Like' + $ref: '#/components/schemas/_common.query_dsl___Like' max_doc_freq: description: The maximum document frequency above which the terms are ignored from the input document. type: integer @@ -39859,7 +41466,7 @@ components: type: integer format: int32 minimum_should_match: - $ref: '#/components/schemas/_common:MinimumShouldMatch' + $ref: '#/components/schemas/_common___MinimumShouldMatch' min_term_freq: description: The minimum term frequency below which the terms are ignored from the input document. type: integer @@ -39874,25 +41481,25 @@ components: additionalProperties: type: string routing: - $ref: '#/components/schemas/_common:Routing' + $ref: '#/components/schemas/_common___Routing' stop_words: - $ref: '#/components/schemas/_common.analysis:StopWords' + $ref: '#/components/schemas/_common.analysis___StopWords' unlike: description: Used in combination with `like` to exclude documents that match a set of terms. oneOf: - - $ref: '#/components/schemas/_common.query_dsl:Like' + - $ref: '#/components/schemas/_common.query_dsl___Like' - type: array items: - $ref: '#/components/schemas/_common.query_dsl:Like' + $ref: '#/components/schemas/_common.query_dsl___Like' version: - $ref: '#/components/schemas/_common:VersionNumber' + $ref: '#/components/schemas/_common___VersionNumber' version_type: - $ref: '#/components/schemas/_common:VersionType' + $ref: '#/components/schemas/_common___VersionType' required: - like - _common.query_dsl:MultiMatchQuery: + _common.query_dsl___MultiMatchQuery: allOf: - - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - $ref: '#/components/schemas/_common.query_dsl___QueryBase' - type: object properties: analyzer: @@ -39906,11 +41513,11 @@ components: type: number format: float fields: - $ref: '#/components/schemas/_common:Fields' + $ref: '#/components/schemas/_common___Fields' fuzziness: - $ref: '#/components/schemas/_common:Fuzziness' + $ref: '#/components/schemas/_common___Fuzziness' fuzzy_rewrite: - $ref: '#/components/schemas/_common:MultiTermQueryRewrite' + $ref: '#/components/schemas/_common___MultiTermQueryRewrite' fuzzy_transpositions: description: |- If `true`, edits for fuzzy matching include transpositions of two adjacent characters (for example, `ab` to `ba`). @@ -39924,15 +41531,15 @@ components: type: integer format: int32 minimum_should_match: - $ref: '#/components/schemas/_common:MinimumShouldMatch' + $ref: '#/components/schemas/_common___MinimumShouldMatch' operator: - $ref: '#/components/schemas/_common.query_dsl:Operator' + $ref: '#/components/schemas/_common.query_dsl___Operator' prefix_length: description: Number of beginning characters left unchanged for fuzzy matching. type: integer format: int32 query: - description: Text, number, boolean value or date you wish to find in the provided field. + description: Text, number, Boolean value or date you wish to find in the provided field. type: string slop: description: Maximum number of positions allowed between matching tokens. @@ -39943,44 +41550,44 @@ components: type: number format: float type: - $ref: '#/components/schemas/_common.query_dsl:TextQueryType' + $ref: '#/components/schemas/_common.query_dsl___TextQueryType' zero_terms_query: - $ref: '#/components/schemas/_common.query_dsl:ZeroTermsQuery' + $ref: '#/components/schemas/_common.query_dsl___ZeroTermsQuery' required: - query - _common.query_dsl:MultiValueMode: + _common.query_dsl___MultiValueMode: type: string enum: - avg - max - min - sum - _common.query_dsl:NestedQuery: + _common.query_dsl___NestedQuery: allOf: - - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - $ref: '#/components/schemas/_common.query_dsl___QueryBase' - type: object properties: ignore_unmapped: - $ref: '#/components/schemas/_common.query_dsl:IgnoreUnmapped' + $ref: '#/components/schemas/_common.query_dsl___IgnoreUnmapped' description: Indicates whether to ignore an unmapped path and not return any documents instead of an error. inner_hits: - $ref: '#/components/schemas/_core.search:InnerHits' + $ref: '#/components/schemas/_core.search___InnerHits' path: - $ref: '#/components/schemas/_common:Field' + $ref: '#/components/schemas/_common___Field' query: - $ref: '#/components/schemas/_common.query_dsl:QueryContainer' + $ref: '#/components/schemas/_common.query_dsl___QueryContainer' score_mode: - $ref: '#/components/schemas/_common.query_dsl:ChildScoreMode' + $ref: '#/components/schemas/_common.query_dsl___ChildScoreMode' required: - path - query - _common.query_dsl:NeuralQuery: + _common.query_dsl___NeuralQuery: allOf: - - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - $ref: '#/components/schemas/_common.query_dsl___QueryBase' - type: object additionalProperties: - $ref: '#/components/schemas/_common.query_dsl:NeuralQueryVectorField' - _common.query_dsl:NeuralQueryVectorField: + $ref: '#/components/schemas/_common.query_dsl___NeuralQueryVectorField' + _common.query_dsl___NeuralQueryVectorField: type: object properties: query_text: @@ -39999,10 +41606,10 @@ components: type: number format: float filter: - $ref: '#/components/schemas/_common.query_dsl:QueryContainer' - _common.query_dsl:NumberRangeQuery: + $ref: '#/components/schemas/_common.query_dsl___QueryContainer' + _common.query_dsl___NumberRangeQuery: allOf: - - $ref: '#/components/schemas/_common.query_dsl:RangeQueryBase' + - $ref: '#/components/schemas/_common.query_dsl___RangeQueryBase' - type: object properties: gt: @@ -40027,30 +41634,30 @@ components: - 'null' - number - string - _common.query_dsl:NumericDecayFunction: + _common.query_dsl___NumericDecayFunction: allOf: - - $ref: '#/components/schemas/_common.query_dsl:DecayFunctionBase' + - $ref: '#/components/schemas/_common.query_dsl___DecayFunctionBase' - type: object - _common.query_dsl:Operator: + _common.query_dsl___Operator: type: string enum: - and - or - _common.query_dsl:ParentIdQuery: + _common.query_dsl___ParentIdQuery: allOf: - - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - $ref: '#/components/schemas/_common.query_dsl___QueryBase' - type: object properties: id: - $ref: '#/components/schemas/_common:Id' + $ref: '#/components/schemas/_common___Id' ignore_unmapped: - $ref: '#/components/schemas/_common.query_dsl:IgnoreUnmapped' + $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: - $ref: '#/components/schemas/_common:RelationName' - _common.query_dsl:PercolateQuery: + $ref: '#/components/schemas/_common___RelationName' + _common.query_dsl___PercolateQuery: allOf: - - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - $ref: '#/components/schemas/_common.query_dsl___QueryBase' - type: object properties: document: @@ -40062,11 +41669,11 @@ components: items: type: object field: - $ref: '#/components/schemas/_common:Field' + $ref: '#/components/schemas/_common___Field' id: - $ref: '#/components/schemas/_common:Id' + $ref: '#/components/schemas/_common___Id' index: - $ref: '#/components/schemas/_common:IndexName' + $ref: '#/components/schemas/_common___IndexName' name: description: The suffix used for the `_percolator_document_slot` field when multiple `percolate` queries are specified. type: string @@ -40074,29 +41681,29 @@ components: description: Preference used to fetch document to percolate. type: string routing: - $ref: '#/components/schemas/_common:Routing' + $ref: '#/components/schemas/_common___Routing' version: - $ref: '#/components/schemas/_common:VersionNumber' + $ref: '#/components/schemas/_common___VersionNumber' required: - field - _common.query_dsl:PinnedDoc: + _common.query_dsl___PinnedDoc: type: object properties: _id: - $ref: '#/components/schemas/_common:Id' + $ref: '#/components/schemas/_common___Id' _index: - $ref: '#/components/schemas/_common:IndexName' + $ref: '#/components/schemas/_common___IndexName' required: - _id - _index - _common.query_dsl:PinnedQuery: + _common.query_dsl___PinnedQuery: allOf: - - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - $ref: '#/components/schemas/_common.query_dsl___QueryBase' - allOf: - type: object properties: organic: - $ref: '#/components/schemas/_common.query_dsl:QueryContainer' + $ref: '#/components/schemas/_common.query_dsl___QueryContainer' required: - organic - type: object @@ -40107,23 +41714,23 @@ components: Required if `docs` is not specified. type: array items: - $ref: '#/components/schemas/_common:Id' + $ref: '#/components/schemas/_common___Id' docs: description: |- Documents listed in the order they are to appear in results. Required if `ids` is not specified. type: array items: - $ref: '#/components/schemas/_common.query_dsl:PinnedDoc' + $ref: '#/components/schemas/_common.query_dsl___PinnedDoc' minProperties: 1 maxProperties: 1 - _common.query_dsl:PrefixQuery: + _common.query_dsl___PrefixQuery: allOf: - - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - $ref: '#/components/schemas/_common.query_dsl___QueryBase' - type: object properties: rewrite: - $ref: '#/components/schemas/_common:MultiTermQueryRewrite' + $ref: '#/components/schemas/_common___MultiTermQueryRewrite' value: description: Beginning characters of terms you wish to find in the provided field. type: string @@ -40134,7 +41741,7 @@ components: type: boolean required: - value - _common.query_dsl:QueryBase: + _common.query_dsl___QueryBase: type: object properties: boost: @@ -40147,75 +41754,75 @@ components: format: float _name: type: string - _common.query_dsl:QueryContainer: + _common.query_dsl___QueryContainer: type: object properties: bool: - $ref: '#/components/schemas/_common.query_dsl:BoolQuery' + $ref: '#/components/schemas/_common.query_dsl___BoolQuery' boosting: - $ref: '#/components/schemas/_common.query_dsl:BoostingQuery' + $ref: '#/components/schemas/_common.query_dsl___BoostingQuery' common: deprecated: true type: object additionalProperties: - $ref: '#/components/schemas/_common.query_dsl:CommonTermsQuery' + $ref: '#/components/schemas/_common.query_dsl___CommonTermsQuery' minProperties: 1 maxProperties: 1 combined_fields: - $ref: '#/components/schemas/_common.query_dsl:CombinedFieldsQuery' + $ref: '#/components/schemas/_common.query_dsl___CombinedFieldsQuery' constant_score: - $ref: '#/components/schemas/_common.query_dsl:ConstantScoreQuery' + $ref: '#/components/schemas/_common.query_dsl___ConstantScoreQuery' dis_max: - $ref: '#/components/schemas/_common.query_dsl:DisMaxQuery' + $ref: '#/components/schemas/_common.query_dsl___DisMaxQuery' distance_feature: - $ref: '#/components/schemas/_common.query_dsl:DistanceFeatureQuery' + $ref: '#/components/schemas/_common.query_dsl___DistanceFeatureQuery' exists: - $ref: '#/components/schemas/_common.query_dsl:ExistsQuery' + $ref: '#/components/schemas/_common.query_dsl___ExistsQuery' function_score: - $ref: '#/components/schemas/_common.query_dsl:FunctionScoreQuery' + $ref: '#/components/schemas/_common.query_dsl___FunctionScoreQuery' fuzzy: description: Returns documents that contain terms similar to the search term, as measured by a Levenshtein edit distance. type: object additionalProperties: - $ref: '#/components/schemas/_common.query_dsl:FuzzyQuery' + $ref: '#/components/schemas/_common.query_dsl___FuzzyQuery' minProperties: 1 maxProperties: 1 geo_bounding_box: - $ref: '#/components/schemas/_common.query_dsl:GeoBoundingBoxQuery' + $ref: '#/components/schemas/_common.query_dsl___GeoBoundingBoxQuery' geo_distance: - $ref: '#/components/schemas/_common.query_dsl:GeoDistanceQuery' + $ref: '#/components/schemas/_common.query_dsl___GeoDistanceQuery' geo_polygon: - $ref: '#/components/schemas/_common.query_dsl:GeoPolygonQuery' + $ref: '#/components/schemas/_common.query_dsl___GeoPolygonQuery' geo_shape: - $ref: '#/components/schemas/_common.query_dsl:GeoShapeQuery' + $ref: '#/components/schemas/_common.query_dsl___GeoShapeQuery' has_child: - $ref: '#/components/schemas/_common.query_dsl:HasChildQuery' + $ref: '#/components/schemas/_common.query_dsl___HasChildQuery' has_parent: - $ref: '#/components/schemas/_common.query_dsl:HasParentQuery' + $ref: '#/components/schemas/_common.query_dsl___HasParentQuery' ids: - $ref: '#/components/schemas/_common.query_dsl:IdsQuery' + $ref: '#/components/schemas/_common.query_dsl___IdsQuery' intervals: description: Returns documents based on the order and proximity of matching terms. type: object additionalProperties: - $ref: '#/components/schemas/_common.query_dsl:IntervalsQuery' + $ref: '#/components/schemas/_common.query_dsl___IntervalsQuery' minProperties: 1 maxProperties: 1 knn: - $ref: '#/components/schemas/_common.query_dsl:KnnQuery' + $ref: '#/components/schemas/_common.query_dsl___KnnQuery' match: description: |- - Returns documents that match a provided text, number, date or boolean value. + Returns documents that match a provided text, number, date or Boolean value. The provided text is analyzed before matching. type: object additionalProperties: anyOf: - - $ref: '#/components/schemas/_common.query_dsl:MatchQuery' + - $ref: '#/components/schemas/_common.query_dsl___MatchQuery' - {} minProperties: 1 maxProperties: 1 match_all: - $ref: '#/components/schemas/_common.query_dsl:MatchAllQuery' + $ref: '#/components/schemas/_common.query_dsl___MatchAllQuery' match_bool_prefix: description: |- Analyzes its input and constructs a `bool` query from the terms. @@ -40223,16 +41830,16 @@ components: The last term is used in a prefix query. type: object additionalProperties: - $ref: '#/components/schemas/_common.query_dsl:MatchBoolPrefixQuery' + $ref: '#/components/schemas/_common.query_dsl___MatchBoolPrefixQuery' minProperties: 1 maxProperties: 1 match_none: - $ref: '#/components/schemas/_common.query_dsl:MatchNoneQuery' + $ref: '#/components/schemas/_common.query_dsl___MatchNoneQuery' match_phrase: description: Analyzes the text and creates a phrase query out of the analyzed text. type: object additionalProperties: - $ref: '#/components/schemas/_common.query_dsl:MatchPhraseQuery' + $ref: '#/components/schemas/_common.query_dsl___MatchPhraseQuery' minProperties: 1 maxProperties: 1 match_phrase_prefix: @@ -40241,134 +41848,134 @@ components: The last term of the provided text is treated as a prefix, matching any words that begin with that term. type: object additionalProperties: - $ref: '#/components/schemas/_common.query_dsl:MatchPhrasePrefixQuery' + $ref: '#/components/schemas/_common.query_dsl___MatchPhrasePrefixQuery' minProperties: 1 maxProperties: 1 more_like_this: - $ref: '#/components/schemas/_common.query_dsl:MoreLikeThisQuery' + $ref: '#/components/schemas/_common.query_dsl___MoreLikeThisQuery' multi_match: - $ref: '#/components/schemas/_common.query_dsl:MultiMatchQuery' + $ref: '#/components/schemas/_common.query_dsl___MultiMatchQuery' nested: - $ref: '#/components/schemas/_common.query_dsl:NestedQuery' + $ref: '#/components/schemas/_common.query_dsl___NestedQuery' neural: - $ref: '#/components/schemas/_common.query_dsl:NeuralQuery' + $ref: '#/components/schemas/_common.query_dsl___NeuralQuery' parent_id: - $ref: '#/components/schemas/_common.query_dsl:ParentIdQuery' + $ref: '#/components/schemas/_common.query_dsl___ParentIdQuery' percolate: - $ref: '#/components/schemas/_common.query_dsl:PercolateQuery' + $ref: '#/components/schemas/_common.query_dsl___PercolateQuery' pinned: - $ref: '#/components/schemas/_common.query_dsl:PinnedQuery' + $ref: '#/components/schemas/_common.query_dsl___PinnedQuery' prefix: description: Returns documents that contain a specific prefix in a provided field. type: object additionalProperties: - $ref: '#/components/schemas/_common.query_dsl:PrefixQuery' + $ref: '#/components/schemas/_common.query_dsl___PrefixQuery' minProperties: 1 maxProperties: 1 query_string: - $ref: '#/components/schemas/_common.query_dsl:QueryStringQuery' + $ref: '#/components/schemas/_common.query_dsl___QueryStringQuery' range: description: Returns documents that contain terms within a provided range. type: object additionalProperties: - $ref: '#/components/schemas/_common.query_dsl:RangeQuery' + $ref: '#/components/schemas/_common.query_dsl___RangeQuery' minProperties: 1 maxProperties: 1 rank_feature: - $ref: '#/components/schemas/_common.query_dsl:RankFeatureQuery' + $ref: '#/components/schemas/_common.query_dsl___RankFeatureQuery' regexp: description: Returns documents that contain terms matching a regular expression. type: object additionalProperties: - $ref: '#/components/schemas/_common.query_dsl:RegexpQuery' + $ref: '#/components/schemas/_common.query_dsl___RegexpQuery' minProperties: 1 maxProperties: 1 rule_query: - $ref: '#/components/schemas/_common.query_dsl:RuleQuery' + $ref: '#/components/schemas/_common.query_dsl___RuleQuery' script: - $ref: '#/components/schemas/_common.query_dsl:ScriptQuery' + $ref: '#/components/schemas/_common.query_dsl___ScriptQuery' script_score: - $ref: '#/components/schemas/_common.query_dsl:ScriptScoreQuery' + $ref: '#/components/schemas/_common.query_dsl___ScriptScoreQuery' simple_query_string: - $ref: '#/components/schemas/_common.query_dsl:SimpleQueryStringQuery' + $ref: '#/components/schemas/_common.query_dsl___SimpleQueryStringQuery' span_containing: - $ref: '#/components/schemas/_common.query_dsl:SpanContainingQuery' + $ref: '#/components/schemas/_common.query_dsl___SpanContainingQuery' field_masking_span: - $ref: '#/components/schemas/_common.query_dsl:SpanFieldMaskingQuery' + $ref: '#/components/schemas/_common.query_dsl___SpanFieldMaskingQuery' span_first: - $ref: '#/components/schemas/_common.query_dsl:SpanFirstQuery' + $ref: '#/components/schemas/_common.query_dsl___SpanFirstQuery' span_multi: - $ref: '#/components/schemas/_common.query_dsl:SpanMultiTermQuery' + $ref: '#/components/schemas/_common.query_dsl___SpanMultiTermQuery' span_near: - $ref: '#/components/schemas/_common.query_dsl:SpanNearQuery' + $ref: '#/components/schemas/_common.query_dsl___SpanNearQuery' span_not: - $ref: '#/components/schemas/_common.query_dsl:SpanNotQuery' + $ref: '#/components/schemas/_common.query_dsl___SpanNotQuery' span_or: - $ref: '#/components/schemas/_common.query_dsl:SpanOrQuery' + $ref: '#/components/schemas/_common.query_dsl___SpanOrQuery' span_term: description: Matches spans containing a term. type: object additionalProperties: - $ref: '#/components/schemas/_common.query_dsl:SpanTermQuery' + $ref: '#/components/schemas/_common.query_dsl___SpanTermQuery' minProperties: 1 maxProperties: 1 span_within: - $ref: '#/components/schemas/_common.query_dsl:SpanWithinQuery' + $ref: '#/components/schemas/_common.query_dsl___SpanWithinQuery' term: description: |- Returns documents that contain an exact term in a provided field. - To return a document, the query term must exactly match the queried field's value, including whitespace and capitalization. + To return a document, the query term must exactly match the queried field's value, including white space and capitalization. type: object additionalProperties: anyOf: - - $ref: '#/components/schemas/_common.query_dsl:TermQuery' - - $ref: '#/components/schemas/_common:FieldValue' + - $ref: '#/components/schemas/_common.query_dsl___TermQuery' + - $ref: '#/components/schemas/_common___FieldValue' minProperties: 1 maxProperties: 1 terms: description: Returns documents that contain one or more exact terms in a provided field. - $ref: '#/components/schemas/_common.query_dsl:TermsQueryField' + $ref: '#/components/schemas/_common.query_dsl___TermsQueryField' terms_set: description: |- Returns documents that contain a minimum number of exact terms in a provided field. - To return a document, a required number of terms must exactly match the field values, including whitespace and capitalization. + To return a document, a required number of terms must exactly match the field values, including white space and capitalization. type: object additionalProperties: - $ref: '#/components/schemas/_common.query_dsl:TermsSetQuery' + $ref: '#/components/schemas/_common.query_dsl___TermsSetQuery' minProperties: 1 maxProperties: 1 text_expansion: description: Uses a natural language processing model to convert the query text into a list of token-weight pairs which are then used in a query against a sparse vector or rank features field. type: object additionalProperties: - $ref: '#/components/schemas/_common.query_dsl:TextExpansionQuery' + $ref: '#/components/schemas/_common.query_dsl___TextExpansionQuery' minProperties: 1 maxProperties: 1 type: - $ref: '#/components/schemas/_common.query_dsl:TypeQuery' + $ref: '#/components/schemas/_common.query_dsl___TypeQuery' weighted_tokens: - description: Supports returning text_expansion query results by sending in precomputed tokens with the query. + description: Supports returning `text_expansion` query results by sending in precomputed tokens with the query. type: object additionalProperties: - $ref: '#/components/schemas/_common.query_dsl:WeightedTokensQuery' + $ref: '#/components/schemas/_common.query_dsl___WeightedTokensQuery' minProperties: 1 maxProperties: 1 wildcard: description: Returns documents that contain terms matching a wildcard pattern. type: object additionalProperties: - $ref: '#/components/schemas/_common.query_dsl:WildcardQuery' + $ref: '#/components/schemas/_common.query_dsl___WildcardQuery' minProperties: 1 maxProperties: 1 wrapper: - $ref: '#/components/schemas/_common.query_dsl:WrapperQuery' + $ref: '#/components/schemas/_common.query_dsl___WrapperQuery' xy_shape: - $ref: '#/components/schemas/_common.query_dsl:XyShapeQuery' + $ref: '#/components/schemas/_common.query_dsl___XyShapeQuery' minProperties: 1 maxProperties: 1 - _common.query_dsl:QueryStringQuery: + _common.query_dsl___QueryStringQuery: allOf: - - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - $ref: '#/components/schemas/_common.query_dsl___QueryBase' - type: object properties: allow_leading_wildcard: @@ -40384,9 +41991,9 @@ components: description: If `true`, match phrase queries are automatically created for multi-term synonyms. type: boolean default_field: - $ref: '#/components/schemas/_common:Field' + $ref: '#/components/schemas/_common___Field' default_operator: - $ref: '#/components/schemas/_common.query_dsl:Operator' + $ref: '#/components/schemas/_common.query_dsl___Operator' enable_position_increments: description: If `true`, enable position increments in queries constructed from a `query_string` search. type: boolean @@ -40396,9 +42003,9 @@ components: description: Array of fields to search. Supports wildcards (`*`). type: array items: - $ref: '#/components/schemas/_common:Field' + $ref: '#/components/schemas/_common___Field' fuzziness: - $ref: '#/components/schemas/_common:Fuzziness' + $ref: '#/components/schemas/_common___Fuzziness' fuzzy_max_expansions: description: Maximum number of terms to which the query expands for fuzzy matching. type: integer @@ -40408,7 +42015,7 @@ components: type: integer format: int32 fuzzy_rewrite: - $ref: '#/components/schemas/_common:MultiTermQueryRewrite' + $ref: '#/components/schemas/_common___MultiTermQueryRewrite' fuzzy_transpositions: description: If `true`, edits for fuzzy matching include transpositions of two adjacent characters (for example, `ab` to `ba`). type: boolean @@ -40420,7 +42027,7 @@ components: type: integer format: int32 minimum_should_match: - $ref: '#/components/schemas/_common:MinimumShouldMatch' + $ref: '#/components/schemas/_common___MinimumShouldMatch' phrase_slop: description: Maximum number of positions allowed between matching tokens for phrases. type: integer @@ -40439,53 +42046,53 @@ components: You can use this suffix to use a different analysis method for exact matches. type: string rewrite: - $ref: '#/components/schemas/_common:MultiTermQueryRewrite' + $ref: '#/components/schemas/_common___MultiTermQueryRewrite' tie_breaker: description: How to combine the queries generated from the individual search terms in the resulting `dis_max` query. type: number format: float time_zone: - $ref: '#/components/schemas/_common:TimeZone' + $ref: '#/components/schemas/_common___TimeZone' type: - $ref: '#/components/schemas/_common.query_dsl:TextQueryType' + $ref: '#/components/schemas/_common.query_dsl___TextQueryType' required: - query - _common.query_dsl:RandomScoreFunction: + _common.query_dsl___RandomScoreFunction: type: object properties: field: - $ref: '#/components/schemas/_common:Field' + $ref: '#/components/schemas/_common___Field' seed: oneOf: - type: integer format: int32 - type: string - _common.query_dsl:RangeQuery: + _common.query_dsl___RangeQuery: oneOf: - - $ref: '#/components/schemas/_common.query_dsl:DateRangeQuery' - - $ref: '#/components/schemas/_common.query_dsl:NumberRangeQuery' - _common.query_dsl:RangeQueryBase: + - $ref: '#/components/schemas/_common.query_dsl___DateRangeQuery' + - $ref: '#/components/schemas/_common.query_dsl___NumberRangeQuery' + _common.query_dsl___RangeQueryBase: allOf: - - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - $ref: '#/components/schemas/_common.query_dsl___QueryBase' - type: object properties: relation: - $ref: '#/components/schemas/_common.query_dsl:RangeRelation' - _common.query_dsl:RangeRelation: + $ref: '#/components/schemas/_common.query_dsl___RangeRelation' + _common.query_dsl___RangeRelation: type: string enum: - contains - intersects - within - _common.query_dsl:RankFeatureFunction: + _common.query_dsl___RankFeatureFunction: type: object - _common.query_dsl:RankFeatureFunctionLinear: + _common.query_dsl___RankFeatureFunctionLinear: allOf: - - $ref: '#/components/schemas/_common.query_dsl:RankFeatureFunction' + - $ref: '#/components/schemas/_common.query_dsl___RankFeatureFunction' - type: object - _common.query_dsl:RankFeatureFunctionLogarithm: + _common.query_dsl___RankFeatureFunctionLogarithm: allOf: - - $ref: '#/components/schemas/_common.query_dsl:RankFeatureFunction' + - $ref: '#/components/schemas/_common.query_dsl___RankFeatureFunction' - type: object properties: scaling_factor: @@ -40494,18 +42101,18 @@ components: format: float required: - scaling_factor - _common.query_dsl:RankFeatureFunctionSaturation: + _common.query_dsl___RankFeatureFunctionSaturation: allOf: - - $ref: '#/components/schemas/_common.query_dsl:RankFeatureFunction' + - $ref: '#/components/schemas/_common.query_dsl___RankFeatureFunction' - type: object properties: pivot: description: Configurable pivot value so that the result will be less than 0.5. type: number format: float - _common.query_dsl:RankFeatureFunctionSigmoid: + _common.query_dsl___RankFeatureFunctionSigmoid: allOf: - - $ref: '#/components/schemas/_common.query_dsl:RankFeatureFunction' + - $ref: '#/components/schemas/_common.query_dsl___RankFeatureFunction' - type: object properties: pivot: @@ -40519,26 +42126,26 @@ components: required: - exponent - pivot - _common.query_dsl:RankFeatureQuery: + _common.query_dsl___RankFeatureQuery: allOf: - - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - $ref: '#/components/schemas/_common.query_dsl___QueryBase' - type: object properties: field: - $ref: '#/components/schemas/_common:Field' + $ref: '#/components/schemas/_common___Field' saturation: - $ref: '#/components/schemas/_common.query_dsl:RankFeatureFunctionSaturation' + $ref: '#/components/schemas/_common.query_dsl___RankFeatureFunctionSaturation' log: - $ref: '#/components/schemas/_common.query_dsl:RankFeatureFunctionLogarithm' + $ref: '#/components/schemas/_common.query_dsl___RankFeatureFunctionLogarithm' linear: - $ref: '#/components/schemas/_common.query_dsl:RankFeatureFunctionLinear' + $ref: '#/components/schemas/_common.query_dsl___RankFeatureFunctionLinear' sigmoid: - $ref: '#/components/schemas/_common.query_dsl:RankFeatureFunctionSigmoid' + $ref: '#/components/schemas/_common.query_dsl___RankFeatureFunctionSigmoid' required: - field - _common.query_dsl:RegexpQuery: + _common.query_dsl___RegexpQuery: allOf: - - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - $ref: '#/components/schemas/_common.query_dsl___QueryBase' - type: object properties: case_insensitive: @@ -40554,46 +42161,46 @@ components: type: integer format: int32 rewrite: - $ref: '#/components/schemas/_common:MultiTermQueryRewrite' + $ref: '#/components/schemas/_common___MultiTermQueryRewrite' value: description: Regular expression for terms you wish to find in the provided field. type: string required: - value - _common.query_dsl:RuleQuery: + _common.query_dsl___RuleQuery: allOf: - - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - $ref: '#/components/schemas/_common.query_dsl___QueryBase' - type: object properties: organic: - $ref: '#/components/schemas/_common.query_dsl:QueryContainer' + $ref: '#/components/schemas/_common.query_dsl___QueryContainer' ruleset_id: - $ref: '#/components/schemas/_common:Id' + $ref: '#/components/schemas/_common___Id' match_criteria: type: object required: - match_criteria - organic - ruleset_id - _common.query_dsl:ScriptQuery: + _common.query_dsl___ScriptQuery: allOf: - - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - $ref: '#/components/schemas/_common.query_dsl___QueryBase' - type: object properties: script: - $ref: '#/components/schemas/_common:Script' + $ref: '#/components/schemas/_common___Script' required: - script - _common.query_dsl:ScriptScoreFunction: + _common.query_dsl___ScriptScoreFunction: type: object properties: script: - $ref: '#/components/schemas/_common:Script' + $ref: '#/components/schemas/_common___Script' required: - script - _common.query_dsl:ScriptScoreQuery: + _common.query_dsl___ScriptScoreQuery: allOf: - - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - $ref: '#/components/schemas/_common.query_dsl___QueryBase' - type: object properties: min_score: @@ -40601,13 +42208,13 @@ components: type: number format: float query: - $ref: '#/components/schemas/_common.query_dsl:QueryContainer' + $ref: '#/components/schemas/_common.query_dsl___QueryContainer' script: - $ref: '#/components/schemas/_common:Script' + $ref: '#/components/schemas/_common___Script' required: - query - script - _common.query_dsl:SimpleQueryStringFlag: + _common.query_dsl___SimpleQueryStringFlag: type: string enum: - ALL @@ -40623,13 +42230,13 @@ components: - PREFIX - 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`. + _common.query_dsl___SimpleQueryStringFlags: + 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: + - $ref: '#/components/schemas/_common___PipeSeparatedFlagsSimpleQueryStringFlag' + _common.query_dsl___SimpleQueryStringQuery: allOf: - - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - $ref: '#/components/schemas/_common.query_dsl___QueryBase' - type: object properties: analyzer: @@ -40639,10 +42246,10 @@ components: description: If `true`, the query attempts to analyze wildcard terms in the query string. type: boolean auto_generate_synonyms_phrase_query: - description: If `true`, the parser creates a match_phrase query for each multi-position token. + description: If `true`, the parser creates a `match_phrase` query for each multi-position token. type: boolean default_operator: - $ref: '#/components/schemas/_common.query_dsl:Operator' + $ref: '#/components/schemas/_common.query_dsl___Operator' fields: description: |- Array of fields you wish to search. @@ -40651,9 +42258,9 @@ components: Defaults to the `index.query.default_field index` setting, which has a default value of `*`. type: array items: - $ref: '#/components/schemas/_common:Field' + $ref: '#/components/schemas/_common___Field' flags: - $ref: '#/components/schemas/_common.query_dsl:SimpleQueryStringFlags' + $ref: '#/components/schemas/_common.query_dsl___SimpleQueryStringFlags' fuzzy_max_expansions: description: Maximum number of terms to which the query expands for fuzzy matching. type: integer @@ -40669,7 +42276,7 @@ components: description: If `true`, format-based errors, such as providing a text value for a numeric field, are ignored. type: boolean minimum_should_match: - $ref: '#/components/schemas/_common:MinimumShouldMatch' + $ref: '#/components/schemas/_common___MinimumShouldMatch' query: description: Query string in the simple query string syntax you wish to parse and use for search. type: string @@ -40678,33 +42285,33 @@ components: type: string required: - query - _common.query_dsl:SpanContainingQuery: + _common.query_dsl___SpanContainingQuery: allOf: - - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - $ref: '#/components/schemas/_common.query_dsl___QueryBase' - type: object properties: big: - $ref: '#/components/schemas/_common.query_dsl:SpanQuery' + $ref: '#/components/schemas/_common.query_dsl___SpanQuery' little: - $ref: '#/components/schemas/_common.query_dsl:SpanQuery' + $ref: '#/components/schemas/_common.query_dsl___SpanQuery' required: - big - little - _common.query_dsl:SpanFieldMaskingQuery: + _common.query_dsl___SpanFieldMaskingQuery: allOf: - - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - $ref: '#/components/schemas/_common.query_dsl___QueryBase' - type: object properties: field: - $ref: '#/components/schemas/_common:Field' + $ref: '#/components/schemas/_common___Field' query: - $ref: '#/components/schemas/_common.query_dsl:SpanQuery' + $ref: '#/components/schemas/_common.query_dsl___SpanQuery' required: - field - query - _common.query_dsl:SpanFirstQuery: + _common.query_dsl___SpanFirstQuery: allOf: - - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - $ref: '#/components/schemas/_common.query_dsl___QueryBase' - type: object properties: end: @@ -40712,37 +42319,37 @@ components: type: integer format: int32 match: - $ref: '#/components/schemas/_common.query_dsl:SpanQuery' + $ref: '#/components/schemas/_common.query_dsl___SpanQuery' required: - end - match - _common.query_dsl:SpanGapQuery: - description: Can only be used as a clause in a span_near query. + _common.query_dsl___SpanGapQuery: + description: Can only be used as a clause in a `span_near` query. type: object additionalProperties: type: integer format: int32 minProperties: 1 maxProperties: 1 - _common.query_dsl:SpanMultiTermQuery: + _common.query_dsl___SpanMultiTermQuery: allOf: - - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - $ref: '#/components/schemas/_common.query_dsl___QueryBase' - type: object properties: match: - $ref: '#/components/schemas/_common.query_dsl:QueryContainer' + $ref: '#/components/schemas/_common.query_dsl___QueryContainer' required: - match - _common.query_dsl:SpanNearQuery: + _common.query_dsl___SpanNearQuery: allOf: - - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - $ref: '#/components/schemas/_common.query_dsl___QueryBase' - type: object properties: clauses: description: Array of one or more other span type queries. type: array items: - $ref: '#/components/schemas/_common.query_dsl:SpanQuery' + $ref: '#/components/schemas/_common.query_dsl___SpanQuery' in_order: description: Controls whether matches are required to be in-order. type: boolean @@ -40752,9 +42359,9 @@ components: format: int32 required: - clauses - _common.query_dsl:SpanNotQuery: + _common.query_dsl___SpanNotQuery: allOf: - - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - $ref: '#/components/schemas/_common.query_dsl___QueryBase' - type: object properties: dist: @@ -40764,9 +42371,9 @@ components: type: integer format: int32 exclude: - $ref: '#/components/schemas/_common.query_dsl:SpanQuery' + $ref: '#/components/schemas/_common.query_dsl___SpanQuery' include: - $ref: '#/components/schemas/_common.query_dsl:SpanQuery' + $ref: '#/components/schemas/_common.query_dsl___SpanQuery' post: description: The number of tokens after the include span that can't have overlap with the exclude span. type: integer @@ -40778,76 +42385,76 @@ components: required: - exclude - include - _common.query_dsl:SpanOrQuery: + _common.query_dsl___SpanOrQuery: allOf: - - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - $ref: '#/components/schemas/_common.query_dsl___QueryBase' - type: object properties: clauses: description: Array of one or more other span type queries. type: array items: - $ref: '#/components/schemas/_common.query_dsl:SpanQuery' + $ref: '#/components/schemas/_common.query_dsl___SpanQuery' required: - clauses - _common.query_dsl:SpanQuery: + _common.query_dsl___SpanQuery: type: object properties: span_containing: - $ref: '#/components/schemas/_common.query_dsl:SpanContainingQuery' + $ref: '#/components/schemas/_common.query_dsl___SpanContainingQuery' field_masking_span: - $ref: '#/components/schemas/_common.query_dsl:SpanFieldMaskingQuery' + $ref: '#/components/schemas/_common.query_dsl___SpanFieldMaskingQuery' span_first: - $ref: '#/components/schemas/_common.query_dsl:SpanFirstQuery' + $ref: '#/components/schemas/_common.query_dsl___SpanFirstQuery' span_gap: - $ref: '#/components/schemas/_common.query_dsl:SpanGapQuery' + $ref: '#/components/schemas/_common.query_dsl___SpanGapQuery' span_multi: - $ref: '#/components/schemas/_common.query_dsl:SpanMultiTermQuery' + $ref: '#/components/schemas/_common.query_dsl___SpanMultiTermQuery' span_near: - $ref: '#/components/schemas/_common.query_dsl:SpanNearQuery' + $ref: '#/components/schemas/_common.query_dsl___SpanNearQuery' span_not: - $ref: '#/components/schemas/_common.query_dsl:SpanNotQuery' + $ref: '#/components/schemas/_common.query_dsl___SpanNotQuery' span_or: - $ref: '#/components/schemas/_common.query_dsl:SpanOrQuery' + $ref: '#/components/schemas/_common.query_dsl___SpanOrQuery' span_term: description: The equivalent of the `term` query but for use with other span queries. type: object additionalProperties: - $ref: '#/components/schemas/_common.query_dsl:SpanTermQuery' + $ref: '#/components/schemas/_common.query_dsl___SpanTermQuery' minProperties: 1 maxProperties: 1 span_within: - $ref: '#/components/schemas/_common.query_dsl:SpanWithinQuery' + $ref: '#/components/schemas/_common.query_dsl___SpanWithinQuery' minProperties: 1 maxProperties: 1 - _common.query_dsl:SpanTermQuery: + _common.query_dsl___SpanTermQuery: allOf: - - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - $ref: '#/components/schemas/_common.query_dsl___QueryBase' - type: object properties: value: type: string required: - value - _common.query_dsl:SpanWithinQuery: + _common.query_dsl___SpanWithinQuery: allOf: - - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - $ref: '#/components/schemas/_common.query_dsl___QueryBase' - type: object properties: big: - $ref: '#/components/schemas/_common.query_dsl:SpanQuery' + $ref: '#/components/schemas/_common.query_dsl___SpanQuery' little: - $ref: '#/components/schemas/_common.query_dsl:SpanQuery' + $ref: '#/components/schemas/_common.query_dsl___SpanQuery' required: - big - little - _common.query_dsl:TermQuery: + _common.query_dsl___TermQuery: allOf: - - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - $ref: '#/components/schemas/_common.query_dsl___QueryBase' - type: object properties: value: - $ref: '#/components/schemas/_common:FieldValue' + $ref: '#/components/schemas/_common___FieldValue' case_insensitive: description: |- Allows ASCII case insensitive matching of the value with the indexed field values when set to `true`. @@ -40855,18 +42462,18 @@ components: type: boolean required: - value - _common.query_dsl:TermsLookupField: + _common.query_dsl___TermsLookupField: type: object properties: index: - $ref: '#/components/schemas/_common:IndexName' + $ref: '#/components/schemas/_common___IndexName' id: - $ref: '#/components/schemas/_common:Id' + $ref: '#/components/schemas/_common___Id' path: - $ref: '#/components/schemas/_common:Field' + $ref: '#/components/schemas/_common___Field' routing: - $ref: '#/components/schemas/_common:Routing' - _common.query_dsl:TermsQueryField: + $ref: '#/components/schemas/_common___Routing' + _common.query_dsl___TermsQueryField: type: object properties: boost: @@ -40878,28 +42485,28 @@ components: format: float additionalProperties: oneOf: - - $ref: '#/components/schemas/_common.query_dsl:TermsLookupField' + - $ref: '#/components/schemas/_common.query_dsl___TermsLookupField' - type: array items: type: string - _common.query_dsl:TermsSetQuery: + _common.query_dsl___TermsSetQuery: allOf: - - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - $ref: '#/components/schemas/_common.query_dsl___QueryBase' - type: object properties: minimum_should_match_field: - $ref: '#/components/schemas/_common:Field' + $ref: '#/components/schemas/_common___Field' minimum_should_match_script: - $ref: '#/components/schemas/_common:Script' + $ref: '#/components/schemas/_common___Script' terms: type: array items: type: string required: - terms - _common.query_dsl:TextExpansionQuery: + _common.query_dsl___TextExpansionQuery: allOf: - - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - $ref: '#/components/schemas/_common.query_dsl___QueryBase' - type: object properties: model_id: @@ -40909,11 +42516,11 @@ components: description: The query text type: string pruning_config: - $ref: '#/components/schemas/_common.query_dsl:TokenPruningConfig' + $ref: '#/components/schemas/_common.query_dsl___TokenPruningConfig' required: - model_id - model_text - _common.query_dsl:TextQueryType: + _common.query_dsl___TextQueryType: type: string enum: - best_fields @@ -40922,7 +42529,7 @@ components: - most_fields - phrase - phrase_prefix - _common.query_dsl:TokenPruningConfig: + _common.query_dsl___TokenPruningConfig: type: object properties: tokens_freq_ratio_threshold: @@ -40934,18 +42541,18 @@ components: only_score_pruned_tokens: description: Whether to only score pruned tokens, vs only scoring kept tokens. type: boolean - _common.query_dsl:TypeQuery: + _common.query_dsl___TypeQuery: allOf: - - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - $ref: '#/components/schemas/_common.query_dsl___QueryBase' - type: object properties: value: type: string required: - value - _common.query_dsl:WeightedTokensQuery: + _common.query_dsl___WeightedTokensQuery: allOf: - - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - $ref: '#/components/schemas/_common.query_dsl___QueryBase' - type: object properties: tokens: @@ -40954,28 +42561,28 @@ components: additionalProperties: type: number pruning_config: - $ref: '#/components/schemas/_common.query_dsl:TokenPruningConfig' + $ref: '#/components/schemas/_common.query_dsl___TokenPruningConfig' required: - tokens - _common.query_dsl:WildcardQuery: + _common.query_dsl___WildcardQuery: allOf: - - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - $ref: '#/components/schemas/_common.query_dsl___QueryBase' - type: object properties: case_insensitive: description: Allows case insensitive matching of the pattern with the indexed field values when set to `true`. Default is `false` which means the case sensitivity of matching depends on the underlying field's mapping. type: boolean rewrite: - $ref: '#/components/schemas/_common:MultiTermQueryRewrite' + $ref: '#/components/schemas/_common___MultiTermQueryRewrite' value: description: Wildcard pattern for terms you wish to find in the provided field. Required, when wildcard is not set. type: string wildcard: description: Wildcard pattern for terms you wish to find in the provided field. Required, when value is not set. type: string - _common.query_dsl:WrapperQuery: + _common.query_dsl___WrapperQuery: allOf: - - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - $ref: '#/components/schemas/_common.query_dsl___QueryBase' - type: object properties: query: @@ -40985,44 +42592,44 @@ components: type: string required: - query - _common.query_dsl:XyShape: + _common.query_dsl___XyShape: type: object properties: type: type: string coordinates: type: array - _common.query_dsl:XyShapeField: + _common.query_dsl___XyShapeField: type: object properties: shape: - $ref: '#/components/schemas/_common.query_dsl:XyShape' + $ref: '#/components/schemas/_common.query_dsl___XyShape' relation: - $ref: '#/components/schemas/_common:GeoShapeRelation' + $ref: '#/components/schemas/_common___GeoShapeRelation' required: - shape - _common.query_dsl:XyShapeQuery: + _common.query_dsl___XyShapeQuery: x-version-added: '2.4' allOf: - - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - $ref: '#/components/schemas/_common.query_dsl___QueryBase' - type: object additionalProperties: - $ref: '#/components/schemas/_common.query_dsl:XyShapeField' + $ref: '#/components/schemas/_common.query_dsl___XyShapeField' minProperties: 1 maxProperties: 1 - _common.query_dsl:ZeroTermsQuery: + _common.query_dsl___ZeroTermsQuery: type: string enum: - all - none - _core._common:DeletedPit: + _core._common___DeletedPit: type: object properties: successful: type: boolean pit_id: type: string - _core._common:PitDetail: + _core._common___PitDetail: type: object properties: pit_id: @@ -41033,14 +42640,14 @@ components: keep_alive: type: integer format: int64 - _core._common:PitsDetailsDeleteAll: + _core._common___PitsDetailsDeleteAll: type: object properties: successful: type: boolean pit_id: type: string - _core._common:ShardStatistics: + _core._common___ShardStatistics: type: object properties: total: @@ -41055,44 +42662,44 @@ components: failed: type: integer format: int32 - _core.bulk:CreateOperation: - $ref: '#/components/schemas/_core.bulk:WriteOperation' - _core.bulk:DeleteOperation: - $ref: '#/components/schemas/_core.bulk:OperationBase' - _core.bulk:IndexOperation: - $ref: '#/components/schemas/_core.bulk:WriteOperation' - _core.bulk:OperationBase: + _core.bulk___CreateOperation: + $ref: '#/components/schemas/_core.bulk___WriteOperation' + _core.bulk___DeleteOperation: + $ref: '#/components/schemas/_core.bulk___OperationBase' + _core.bulk___IndexOperation: + $ref: '#/components/schemas/_core.bulk___WriteOperation' + _core.bulk___OperationBase: type: object properties: _id: - $ref: '#/components/schemas/_common:Id' + $ref: '#/components/schemas/_common___Id' _index: - $ref: '#/components/schemas/_common:IndexName' + $ref: '#/components/schemas/_common___IndexName' routing: - $ref: '#/components/schemas/_common:Routing' + $ref: '#/components/schemas/_common___Routing' if_primary_term: type: integer format: int64 if_seq_no: - $ref: '#/components/schemas/_common:SequenceNumber' + $ref: '#/components/schemas/_common___SequenceNumber' version: - $ref: '#/components/schemas/_common:VersionNumber' + $ref: '#/components/schemas/_common___VersionNumber' version_type: - $ref: '#/components/schemas/_common:VersionType' - _core.bulk:OperationContainer: + $ref: '#/components/schemas/_common___VersionType' + _core.bulk___OperationContainer: type: object properties: index: - $ref: '#/components/schemas/_core.bulk:IndexOperation' + $ref: '#/components/schemas/_core.bulk___IndexOperation' create: - $ref: '#/components/schemas/_core.bulk:CreateOperation' + $ref: '#/components/schemas/_core.bulk___CreateOperation' update: - $ref: '#/components/schemas/_core.bulk:UpdateOperation' + $ref: '#/components/schemas/_core.bulk___UpdateOperation' delete: - $ref: '#/components/schemas/_core.bulk:DeleteOperation' + $ref: '#/components/schemas/_core.bulk___DeleteOperation' minProperties: 1 maxProperties: 1 - _core.bulk:ResponseItem: + _core.bulk___ResponseItem: type: object properties: _type: @@ -41114,7 +42721,7 @@ components: type: integer format: int32 error: - $ref: '#/components/schemas/_common:ErrorCause' + $ref: '#/components/schemas/_common___ErrorCause' _primary_term: description: The primary term assigned to the document for the operation. type: integer @@ -41125,47 +42732,47 @@ components: Successful values are `created`, `deleted`, and `updated`. type: string _seq_no: - $ref: '#/components/schemas/_common:SequenceNumber' + $ref: '#/components/schemas/_common___SequenceNumber' _shards: - $ref: '#/components/schemas/_common:ShardStatistics' + $ref: '#/components/schemas/_common___ShardStatistics' _version: - $ref: '#/components/schemas/_common:VersionNumber' + $ref: '#/components/schemas/_common___VersionNumber' forced_refresh: type: boolean get: - $ref: '#/components/schemas/_common:InlineGetDictUserDefined' + $ref: '#/components/schemas/_common___InlineGetDictUserDefined' required: - _index - status - _core.bulk:UpdateAction: + _core.bulk___UpdateAction: type: object properties: detect_noop: description: |- - When `false` disables the setting 'result' in the response - to 'noop' if no change to the document occurred. + When `false` disables the setting `result` in the response + to `noop` if no change to the document occurred. type: boolean doc: description: A partial update to an existing document. type: object doc_as_upsert: - description: When `true`, uses the contents of 'doc' as the value of 'upsert'. + description: When `true`, uses the contents of `doc` as the value of `upsert`. type: boolean script: - $ref: '#/components/schemas/_common:Script' + $ref: '#/components/schemas/_common___Script' scripted_upsert: description: When `true`, executes the script whether or not the document exists. type: boolean _source: - $ref: '#/components/schemas/_core.search:SourceConfig' + $ref: '#/components/schemas/_core.search___SourceConfig' upsert: description: |- - If the document does not already exist, the contents of 'upsert' are inserted as a - new document. If the document exists, the 'script' is executed. + If the document does not already exist, the contents of `upsert` are inserted as a + new document. If the document exists, the `script` is executed. type: object - _core.bulk:UpdateOperation: + _core.bulk___UpdateOperation: allOf: - - $ref: '#/components/schemas/_core.bulk:OperationBase' + - $ref: '#/components/schemas/_core.bulk___OperationBase' - type: object properties: require_alias: @@ -41174,9 +42781,9 @@ components: retry_on_conflict: type: integer format: int32 - _core.bulk:WriteOperation: + _core.bulk___WriteOperation: allOf: - - $ref: '#/components/schemas/_core.bulk:OperationBase' + - $ref: '#/components/schemas/_core.bulk___OperationBase' - type: object properties: dynamic_templates: @@ -41196,7 +42803,7 @@ components: require_alias: description: When `true`, require that all actions target an index alias rather than an index. Default is `false`. type: boolean - _core.explain:Explanation: + _core.explain___Explanation: type: object properties: description: @@ -41204,7 +42811,7 @@ components: details: type: array items: - $ref: '#/components/schemas/_core.explain:ExplanationDetail' + $ref: '#/components/schemas/_core.explain___ExplanationDetail' value: oneOf: - type: integer @@ -41219,7 +42826,7 @@ components: - description - details - value - _core.explain:ExplanationDetail: + _core.explain___ExplanationDetail: type: object properties: description: @@ -41227,9 +42834,9 @@ components: details: type: array items: - $ref: '#/components/schemas/_core.explain:ExplanationDetail' + $ref: '#/components/schemas/_core.explain___ExplanationDetail' value: - oneOf: + anyOf: - type: integer format: int32 - type: integer @@ -41241,20 +42848,20 @@ components: required: - description - value - _core.field_caps:FieldCapability: + _core.field_caps___FieldCapability: type: object properties: aggregatable: description: Whether this field can be aggregated on all indexes. type: boolean indices: - $ref: '#/components/schemas/_common:Indices' + $ref: '#/components/schemas/_common___Indices' meta: - $ref: '#/components/schemas/_common:Metadata' + $ref: '#/components/schemas/_common___Metadata' non_aggregatable_indices: - $ref: '#/components/schemas/_common:Indices' + $ref: '#/components/schemas/_common___Indices' non_searchable_indices: - $ref: '#/components/schemas/_common:Indices' + $ref: '#/components/schemas/_common___Indices' searchable: description: Whether this field is indexed for search on all indexes. type: boolean @@ -41263,67 +42870,48 @@ components: metadata_field: description: Whether this field is registered as a metadata field. type: boolean - time_series_dimension: - description: Whether this field is used as a time series dimension. - type: boolean - time_series_metric: - $ref: '#/components/schemas/_common.mapping:TimeSeriesMetricType' - non_dimension_indices: - description: |- - If this list is present in the response, then indexes not contained in the list have the - field marked as a dimension. Any indexes contained in the list are not marked as a dimension. - type: array - items: - $ref: '#/components/schemas/_common:IndexName' - metric_conflicts_indices: - description: |- - The list of indexes in which this field is present if the indexes - don't have the same `time_series_metric` value for the field. - type: array - items: - $ref: '#/components/schemas/_common:IndexName' required: - aggregatable - searchable - type - _core.get_script_context:Context: + _core.get_script_context___Context: type: object properties: methods: type: array items: - $ref: '#/components/schemas/_core.get_script_context:ContextMethod' + $ref: '#/components/schemas/_core.get_script_context___ContextMethod' name: - $ref: '#/components/schemas/_common:Name' + $ref: '#/components/schemas/_common___Name' required: - methods - name - _core.get_script_context:ContextMethod: + _core.get_script_context___ContextMethod: type: object properties: name: - $ref: '#/components/schemas/_common:Name' + $ref: '#/components/schemas/_common___Name' return_type: type: string params: type: array items: - $ref: '#/components/schemas/_core.get_script_context:ContextMethodParam' + $ref: '#/components/schemas/_core.get_script_context___ContextMethodParam' required: - name - params - return_type - _core.get_script_context:ContextMethodParam: + _core.get_script_context___ContextMethodParam: type: object properties: name: - $ref: '#/components/schemas/_common:Name' + $ref: '#/components/schemas/_common___Name' type: type: string required: - name - type - _core.get_script_languages:LanguageContext: + _core.get_script_languages___LanguageContext: type: object properties: contexts: @@ -41331,17 +42919,17 @@ components: items: type: string language: - $ref: '#/components/schemas/_common:ScriptLanguage' + $ref: '#/components/schemas/_common___ScriptLanguage' required: - contexts - language - _core.get:GetResult: + _core.get___GetResult: type: object properties: _type: - $ref: '#/components/schemas/_common:Type' + $ref: '#/components/schemas/_common___Type' _index: - $ref: '#/components/schemas/_common:IndexName' + $ref: '#/components/schemas/_common___IndexName' fields: type: object additionalProperties: @@ -41349,69 +42937,69 @@ components: found: type: boolean _id: - $ref: '#/components/schemas/_common:Id' + $ref: '#/components/schemas/_common___Id' _primary_term: type: number _routing: type: string _seq_no: - $ref: '#/components/schemas/_common:SequenceNumber' + $ref: '#/components/schemas/_common___SequenceNumber' _source: type: object _version: - $ref: '#/components/schemas/_common:VersionNumber' + $ref: '#/components/schemas/_common___VersionNumber' required: - _id - _index - found - _core.mget:MultiGetError: + _core.mget___MultiGetError: type: object properties: error: - $ref: '#/components/schemas/_common:ErrorCause' + $ref: '#/components/schemas/_common___ErrorCause' _id: - $ref: '#/components/schemas/_common:Id' + $ref: '#/components/schemas/_common___Id' _index: - $ref: '#/components/schemas/_common:IndexName' + $ref: '#/components/schemas/_common___IndexName' required: - _id - _index - error - _core.mget:Operation: + _core.mget___Operation: type: object properties: _id: - $ref: '#/components/schemas/_common:Id' + $ref: '#/components/schemas/_common___Id' _index: - $ref: '#/components/schemas/_common:IndexName' + $ref: '#/components/schemas/_common___IndexName' routing: - $ref: '#/components/schemas/_common:Routing' + $ref: '#/components/schemas/_common___Routing' _source: - $ref: '#/components/schemas/_core.search:SourceConfig' + $ref: '#/components/schemas/_core.search___SourceConfig' stored_fields: - $ref: '#/components/schemas/_common:Fields' + $ref: '#/components/schemas/_common___Fields' version: - $ref: '#/components/schemas/_common:VersionNumber' + $ref: '#/components/schemas/_common___VersionNumber' version_type: - $ref: '#/components/schemas/_common:VersionType' + $ref: '#/components/schemas/_common___VersionType' required: - _id - _core.mget:ResponseItem: + _core.mget___ResponseItem: oneOf: - - $ref: '#/components/schemas/_core.get:GetResult' - - $ref: '#/components/schemas/_core.mget:MultiGetError' - _core.msearch_template:RequestItem: + - $ref: '#/components/schemas/_core.get___GetResult' + - $ref: '#/components/schemas/_core.mget___MultiGetError' + _core.msearch_template___RequestItem: oneOf: - - $ref: '#/components/schemas/_core.msearch:MultisearchHeader' - - $ref: '#/components/schemas/_core.msearch_template:TemplateConfig' - _core.msearch_template:TemplateConfig: + - $ref: '#/components/schemas/_core.msearch___MultisearchHeader' + - $ref: '#/components/schemas/_core.msearch_template___TemplateConfig' + _core.msearch_template___TemplateConfig: type: object properties: explain: description: When `true`, returns detailed information about score calculation as part of each hit. type: boolean id: - $ref: '#/components/schemas/_common:Id' + $ref: '#/components/schemas/_common___Id' params: description: |- The key-value pairs used to replace Mustache variables in the template. @@ -41425,21 +43013,21 @@ components: type: boolean source: description: |- - An inline search template that supports the same parameters as the Search API's + An inline search template that supports the same parameters as the Search API request body and Mustache variables. If no `id` is specified, this parameter is required. type: string - _core.msearch:MultisearchBody: + _core.msearch___MultisearchBody: type: object properties: aggregations: type: object additionalProperties: - $ref: '#/components/schemas/_common.aggregations:AggregationContainer' + $ref: '#/components/schemas/_common.aggregations___AggregationContainer' collapse: - $ref: '#/components/schemas/_core.search:FieldCollapse' + $ref: '#/components/schemas/_core.search___FieldCollapse' query: - $ref: '#/components/schemas/_common.query_dsl:QueryContainer' + $ref: '#/components/schemas/_common.query_dsl___QueryContainer' explain: description: When `true`, returns detailed information about score computation as part of a hit. type: boolean @@ -41449,21 +43037,21 @@ components: additionalProperties: type: object stored_fields: - $ref: '#/components/schemas/_common:Fields' + $ref: '#/components/schemas/_common___Fields' docvalue_fields: description: |- An array of wildcard (*) patterns. The request returns document 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' + $ref: '#/components/schemas/_common.query_dsl___FieldAndFormat' knn: - description: Defines the approximate kNN search to run. + description: Defines the approximate k-NN search to run. oneOf: - - $ref: '#/components/schemas/_common.query_dsl:KnnQuery' + - $ref: '#/components/schemas/_common.query_dsl___KnnQuery' - type: array items: - $ref: '#/components/schemas/_common.query_dsl:KnnQuery' + $ref: '#/components/schemas/_common.query_dsl___KnnQuery' from: description: |- The starting document offset. By default, you cannot page through more than 10,000 @@ -41471,7 +43059,7 @@ components: `search_after` parameter. type: number highlight: - $ref: '#/components/schemas/_core.search:Highlight' + $ref: '#/components/schemas/_core.search___Highlight' indices_boost: description: Boosts the `_score` of documents from the specified indexes. type: array @@ -41485,22 +43073,22 @@ components: are not included in the search results. type: number post_filter: - $ref: '#/components/schemas/_common.query_dsl:QueryContainer' + $ref: '#/components/schemas/_common.query_dsl___QueryContainer' profile: type: boolean rescore: oneOf: - - $ref: '#/components/schemas/_core.search:Rescore' + - $ref: '#/components/schemas/_core.search___Rescore' - type: array items: - $ref: '#/components/schemas/_core.search:Rescore' + $ref: '#/components/schemas/_core.search___Rescore' script_fields: description: Retrieves a script evaluation (based on different fields) for each hit. type: object additionalProperties: - $ref: '#/components/schemas/_common:ScriptField' + $ref: '#/components/schemas/_common___ScriptField' search_after: - $ref: '#/components/schemas/_common:SortResults' + $ref: '#/components/schemas/_common___SortResults' size: description: |- The number of hits to return. By default, you cannot page through more @@ -41508,16 +43096,16 @@ components: hits, use the `search_after` parameter. type: number sort: - $ref: '#/components/schemas/_common:Sort' + $ref: '#/components/schemas/_common___Sort' _source: - $ref: '#/components/schemas/_core.search:SourceConfig' + $ref: '#/components/schemas/_core.search___SourceConfig' fields: description: |- An 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' + $ref: '#/components/schemas/_common.query_dsl___FieldAndFormat' terminate_after: description: |- The maximum number of documents to collect for each shard. If a query reaches this @@ -41542,54 +43130,52 @@ components: description: When `true`, calculates and returns all document scores, even if the scores are not used for sorting. type: boolean track_total_hits: - $ref: '#/components/schemas/_core.search:TrackHits' + $ref: '#/components/schemas/_core.search___TrackHits' version: description: When `true`, returns the document version as part of the hit. type: boolean - runtime_mappings: - $ref: '#/components/schemas/_common.mapping:RuntimeFields' seq_no_primary_term: description: |- When `true`, returns the sequence number and primary term of the last modification. of each hit. See Optimistic concurrency control. type: boolean pit: - $ref: '#/components/schemas/_core.search:PointInTimeReference' + $ref: '#/components/schemas/_core.search___PointInTimeReference' suggest: - $ref: '#/components/schemas/_core.search:Suggester' - _core.msearch:MultisearchHeader: + $ref: '#/components/schemas/_core.search___Suggester' + _core.msearch___MultisearchHeader: type: object properties: allow_no_indices: type: boolean expand_wildcards: - $ref: '#/components/schemas/_common:ExpandWildcards' + $ref: '#/components/schemas/_common___ExpandWildcards' ignore_unavailable: type: boolean index: - $ref: '#/components/schemas/_common:Indices' + $ref: '#/components/schemas/_common___Indices' preference: type: string request_cache: type: boolean routing: - $ref: '#/components/schemas/_common:Routing' + $ref: '#/components/schemas/_common___Routing' search_type: - $ref: '#/components/schemas/_common:SearchType' + $ref: '#/components/schemas/_common___SearchType' ccs_minimize_roundtrips: type: boolean allow_partial_search_results: type: boolean ignore_throttled: type: boolean - _core.msearch:MultiSearchItem: + _core.msearch___MultiSearchItem: allOf: - - $ref: '#/components/schemas/_core.search:ResponseBody' + - $ref: '#/components/schemas/_core.search___ResponseBody' - type: object properties: status: type: number - _core.msearch:MultiSearchResult: + _core.msearch___MultiSearchResult: type: object properties: took: @@ -41597,35 +43183,35 @@ components: responses: type: array items: - $ref: '#/components/schemas/_core.msearch:ResponseItem' + $ref: '#/components/schemas/_core.msearch___ResponseItem' required: - responses - took - _core.msearch:RequestItem: + _core.msearch___RequestItem: oneOf: - - $ref: '#/components/schemas/_core.msearch:MultisearchHeader' - - $ref: '#/components/schemas/_core.msearch:MultisearchBody' - _core.msearch:ResponseItem: + - $ref: '#/components/schemas/_core.msearch___MultisearchHeader' + - $ref: '#/components/schemas/_core.msearch___MultisearchBody' + _core.msearch___ResponseItem: oneOf: - - $ref: '#/components/schemas/_core.msearch:MultiSearchItem' - - $ref: '#/components/schemas/_common:ErrorResponseBase' - _core.mtermvectors:Operation: + - $ref: '#/components/schemas/_core.msearch___MultiSearchItem' + - $ref: '#/components/schemas/_common___ErrorResponseBase' + _core.mtermvectors___Operation: type: object properties: _id: - $ref: '#/components/schemas/_common:Id' + $ref: '#/components/schemas/_common___Id' _index: - $ref: '#/components/schemas/_common:IndexName' + $ref: '#/components/schemas/_common___IndexName' doc: description: An artificial document for which you want to retrieve term vectors. type: object fields: - $ref: '#/components/schemas/_common:Fields' + $ref: '#/components/schemas/_common___Fields' field_statistics: description: When `true`, the response includes the document count, the sum of the document frequencies, and the sum of the term frequencies. type: boolean filter: - $ref: '#/components/schemas/_core.termvectors:Filter' + $ref: '#/components/schemas/_core.termvectors___Filter' offsets: description: When `true`, the response includes the term offsets. type: boolean @@ -41636,25 +43222,25 @@ components: description: When `true`, the response includes the term positions. type: boolean routing: - $ref: '#/components/schemas/_common:Routing' + $ref: '#/components/schemas/_common___Routing' term_statistics: description: When `true`, the response includes the term frequency and the document frequency. type: boolean version: - $ref: '#/components/schemas/_common:VersionNumber' + $ref: '#/components/schemas/_common___VersionNumber' version_type: - $ref: '#/components/schemas/_common:VersionType' + $ref: '#/components/schemas/_common___VersionType' required: - _id - _core.mtermvectors:TermVectorsResult: + _core.mtermvectors___TermVectorsResult: type: object properties: _id: - $ref: '#/components/schemas/_common:Id' + $ref: '#/components/schemas/_common___Id' _index: - $ref: '#/components/schemas/_common:IndexName' + $ref: '#/components/schemas/_common___IndexName' _version: - $ref: '#/components/schemas/_common:VersionNumber' + $ref: '#/components/schemas/_common___VersionNumber' took: type: number found: @@ -41662,19 +43248,19 @@ components: term_vectors: type: object additionalProperties: - $ref: '#/components/schemas/_core.termvectors:TermVector' + $ref: '#/components/schemas/_core.termvectors___TermVector' error: - $ref: '#/components/schemas/_common:ErrorCause' + $ref: '#/components/schemas/_common___ErrorCause' required: - _id - _index - _core.rank_eval:DocumentRating: + _core.rank_eval___DocumentRating: type: object properties: _id: - $ref: '#/components/schemas/_common:Id' + $ref: '#/components/schemas/_common___Id' _index: - $ref: '#/components/schemas/_common:IndexName' + $ref: '#/components/schemas/_common___IndexName' rating: description: The document's relevance with regard to the specified search request. type: number @@ -41682,24 +43268,24 @@ components: - _id - _index - rating - _core.rank_eval:RankEvalHit: + _core.rank_eval___RankEvalHit: type: object properties: _id: - $ref: '#/components/schemas/_common:Id' + $ref: '#/components/schemas/_common___Id' _index: - $ref: '#/components/schemas/_common:IndexName' + $ref: '#/components/schemas/_common___IndexName' _score: type: number required: - _id - _index - _score - _core.rank_eval:RankEvalHitItem: + _core.rank_eval___RankEvalHitItem: type: object properties: hit: - $ref: '#/components/schemas/_core.rank_eval:RankEvalHit' + $ref: '#/components/schemas/_core.rank_eval___RankEvalHit' rating: type: - 'null' @@ -41707,43 +43293,43 @@ components: - string required: - hit - _core.rank_eval:RankEvalMetric: + _core.rank_eval___RankEvalMetric: type: object properties: precision: - $ref: '#/components/schemas/_core.rank_eval:RankEvalMetricPrecision' + $ref: '#/components/schemas/_core.rank_eval___RankEvalMetricPrecision' recall: - $ref: '#/components/schemas/_core.rank_eval:RankEvalMetricRecall' + $ref: '#/components/schemas/_core.rank_eval___RankEvalMetricRecall' mean_reciprocal_rank: - $ref: '#/components/schemas/_core.rank_eval:RankEvalMetricMeanReciprocalRank' + $ref: '#/components/schemas/_core.rank_eval___RankEvalMetricMeanReciprocalRank' dcg: - $ref: '#/components/schemas/_core.rank_eval:RankEvalMetricDiscountedCumulativeGain' + $ref: '#/components/schemas/_core.rank_eval___RankEvalMetricDiscountedCumulativeGain' expected_reciprocal_rank: - $ref: '#/components/schemas/_core.rank_eval:RankEvalMetricExpectedReciprocalRank' - _core.rank_eval:RankEvalMetricBase: + $ref: '#/components/schemas/_core.rank_eval___RankEvalMetricExpectedReciprocalRank' + _core.rank_eval___RankEvalMetricBase: type: object properties: k: - description: Sets the maximum number of documents retrieved per query. This value replaces the usual `size` parameter in the query. + description: Sets the maximum number of documents retrieved per query. This value replaces the `size` parameter in the query. type: number - _core.rank_eval:RankEvalMetricDetail: + _core.rank_eval___RankEvalMetricDetail: type: object properties: metric_score: description: The `metric_score`, found in the `metric_details` section, shows the contribution of this query to the global quality metric score. type: number unrated_docs: - description: The `unrated_docs` section contains an `_index` and `_id` entry for each document that didn't have a ratings value. This can be used to ask the user to supply ratings for these documents. + description: The `unrated_docs` section contains an `_index` and `_id` entry for each document that didn't have a `ratings` value. This can be used to ask the user to supply ratings for these documents. type: array items: - $ref: '#/components/schemas/_core.rank_eval:UnratedDocument' + $ref: '#/components/schemas/_core.rank_eval___UnratedDocument' hits: - description: The `hits` section shows a grouping of the search results with their supplied ratings + description: The `hits` section provides a grouping of the search results with their supplied ratings. type: array items: - $ref: '#/components/schemas/_core.rank_eval:RankEvalHitItem' + $ref: '#/components/schemas/_core.rank_eval___RankEvalHitItem' metric_details: - description: The `metric_details` section gives additional information about the calculated quality metric, in other words, how many of the retrieved documents were relevant. The content varies for each metric but allows for better interpretation of the results. + description: The `metric_details` section provides additional information about the calculated quality metric indicating the number of relevant retrieved documents. The content varies for each metric but allows for better interpretation of the results. type: object additionalProperties: type: object @@ -41754,71 +43340,71 @@ components: - metric_details - metric_score - unrated_docs - _core.rank_eval:RankEvalMetricDiscountedCumulativeGain: + _core.rank_eval___RankEvalMetricDiscountedCumulativeGain: allOf: - - $ref: '#/components/schemas/_core.rank_eval:RankEvalMetricBase' + - $ref: '#/components/schemas/_core.rank_eval___RankEvalMetricBase' - type: object properties: normalize: - description: When `true`, this metric calculates the Normalized DCG (https://en.wikipedia.org/wiki/Discounted_cumulative_gain#Normalized_DCG). + description: When `true`, calculates the [normalized discounted cumulative gain (nDCG)](https://en.wikipedia.org/wiki/Discounted_cumulative_gain#Normalized_DCG). type: boolean - _core.rank_eval:RankEvalMetricExpectedReciprocalRank: + _core.rank_eval___RankEvalMetricExpectedReciprocalRank: allOf: - - $ref: '#/components/schemas/_core.rank_eval:RankEvalMetricBase' + - $ref: '#/components/schemas/_core.rank_eval___RankEvalMetricBase' - type: object properties: maximum_relevance: - description: The highest relevance grade used in the user-supplied relevance judgments. + description: The highest relevance grade used in user-supplied relevance judgments. type: number required: - maximum_relevance - _core.rank_eval:RankEvalMetricMeanReciprocalRank: + _core.rank_eval___RankEvalMetricMeanReciprocalRank: allOf: - - $ref: '#/components/schemas/_core.rank_eval:RankEvalMetricRatingThreshold' + - $ref: '#/components/schemas/_core.rank_eval___RankEvalMetricRatingThreshold' - type: object - _core.rank_eval:RankEvalMetricPrecision: + _core.rank_eval___RankEvalMetricPrecision: allOf: - - $ref: '#/components/schemas/_core.rank_eval:RankEvalMetricRatingThreshold' + - $ref: '#/components/schemas/_core.rank_eval___RankEvalMetricRatingThreshold' - type: object properties: ignore_unlabeled: - description: Controls how unlabeled documents in the search results are counted. When `true`, unlabeled documents are ignored and do not count as relevant or irrelevant. When `false`, unlabeled documents are treated as irrelevant. + description: Controls how unlabeled documents in the search results are counted. When `true`, unlabeled documents are ignored and are not treated as relevant or irrelevant. When `false`, unlabeled documents are treated as irrelevant. type: boolean - _core.rank_eval:RankEvalMetricRatingThreshold: + _core.rank_eval___RankEvalMetricRatingThreshold: allOf: - - $ref: '#/components/schemas/_core.rank_eval:RankEvalMetricBase' + - $ref: '#/components/schemas/_core.rank_eval___RankEvalMetricBase' - type: object properties: relevant_rating_threshold: description: Sets the rating threshold above which documents are considered to be relevant. type: number - _core.rank_eval:RankEvalMetricRecall: + _core.rank_eval___RankEvalMetricRecall: allOf: - - $ref: '#/components/schemas/_core.rank_eval:RankEvalMetricRatingThreshold' + - $ref: '#/components/schemas/_core.rank_eval___RankEvalMetricRatingThreshold' - type: object - _core.rank_eval:RankEvalQuery: + _core.rank_eval___RankEvalQuery: type: object properties: query: - $ref: '#/components/schemas/_common.query_dsl:QueryContainer' + $ref: '#/components/schemas/_common.query_dsl___QueryContainer' size: type: number required: - query - _core.rank_eval:RankEvalRequestItem: + _core.rank_eval___RankEvalRequestItem: type: object properties: id: - $ref: '#/components/schemas/_common:Id' + $ref: '#/components/schemas/_common___Id' request: - $ref: '#/components/schemas/_core.rank_eval:RankEvalQuery' + $ref: '#/components/schemas/_core.rank_eval___RankEvalQuery' ratings: description: A list of document ratings. type: array items: - $ref: '#/components/schemas/_core.rank_eval:DocumentRating' + $ref: '#/components/schemas/_core.rank_eval___DocumentRating' template_id: - $ref: '#/components/schemas/_common:Id' + $ref: '#/components/schemas/_common___Id' params: description: The search template parameters. type: object @@ -41827,32 +43413,32 @@ components: required: - id - ratings - _core.rank_eval:UnratedDocument: + _core.rank_eval___UnratedDocument: type: object properties: _id: - $ref: '#/components/schemas/_common:Id' + $ref: '#/components/schemas/_common___Id' _index: - $ref: '#/components/schemas/_common:IndexName' + $ref: '#/components/schemas/_common___IndexName' required: - _id - _index - _core.reindex_rethrottle:ReindexNode: + _core.reindex_rethrottle___ReindexNode: allOf: - - $ref: '#/components/schemas/_common:BaseNode' + - $ref: '#/components/schemas/_common___BaseNode' - type: object properties: tasks: type: object additionalProperties: - $ref: '#/components/schemas/_core.reindex_rethrottle:ReindexTask' + $ref: '#/components/schemas/_core.reindex_rethrottle___ReindexTask' required: - tasks - _core.reindex_rethrottle:ReindexStatus: + _core.reindex_rethrottle___ReindexStatus: type: object properties: batches: - description: The number of scroll responses pulled back by the reindex. + description: The number of scroll responses shown by the reindex. type: number created: description: The number of documents that were successfully created. @@ -41861,26 +43447,26 @@ components: description: The number of documents that were successfully deleted. type: number noops: - description: The number of documents that were ignored because the script used for the reindex returned a `noop` value for `ctx.op`. + description: The number of documents that were ignored because the script used for the reindex operation returned a `noop` value for `ctx.op`. type: number requests_per_second: - description: The number of requests per second effectively executed during the reindex. + description: The number of successful requests per second during the reindex operation. type: number retries: - $ref: '#/components/schemas/_common:Retries' + $ref: '#/components/schemas/_common___Retries' throttled: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' throttled_millis: - $ref: '#/components/schemas/_common:DurationValueUnitMillis' + $ref: '#/components/schemas/_common___DurationValueUnitMillis' throttled_until: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' throttled_until_millis: - $ref: '#/components/schemas/_common:DurationValueUnitMillis' + $ref: '#/components/schemas/_common___DurationValueUnitMillis' total: description: The number of documents that were successfully processed. type: number updated: - description: The number of documents that were successfully updated, for example, a document with same ID already existed prior to reindex updating it. + description: The number of documents that were successfully updated. type: number version_conflicts: description: The number of version conflicts that reindex hits. @@ -41897,7 +43483,7 @@ components: - total - updated - version_conflicts - _core.reindex_rethrottle:ReindexTask: + _core.reindex_rethrottle___ReindexTask: type: object properties: action: @@ -41909,17 +43495,17 @@ components: id: type: number node: - $ref: '#/components/schemas/_common:Name' + $ref: '#/components/schemas/_common___Name' running_time_in_nanos: - $ref: '#/components/schemas/_common:DurationValueUnitNanos' + $ref: '#/components/schemas/_common___DurationValueUnitNanos' start_time_in_millis: - $ref: '#/components/schemas/_common:EpochTimeUnitMillis' + $ref: '#/components/schemas/_common___EpochTimeUnitMillis' status: - $ref: '#/components/schemas/_core.reindex_rethrottle:ReindexStatus' + $ref: '#/components/schemas/_core.reindex_rethrottle___ReindexStatus' type: type: string headers: - $ref: '#/components/schemas/_common:HttpHeaders' + $ref: '#/components/schemas/_common___HttpHeaders' required: - action - cancellable @@ -41931,90 +43517,88 @@ components: - start_time_in_millis - status - type - _core.reindex:Destination: + _core.reindex___Destination: type: object properties: index: - $ref: '#/components/schemas/_common:IndexName' + $ref: '#/components/schemas/_common___IndexName' op_type: - $ref: '#/components/schemas/_common:OpType' + $ref: '#/components/schemas/_common___OpType' pipeline: description: The name of the pipeline to use. type: string routing: - $ref: '#/components/schemas/_common:Routing' + $ref: '#/components/schemas/_common___Routing' version_type: - $ref: '#/components/schemas/_common:VersionType' + $ref: '#/components/schemas/_common___VersionType' required: - index - _core.reindex:RemoteSource: + _core.reindex___RemoteSource: type: object properties: connect_timeout: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' headers: description: An object containing the headers of the request. type: object additionalProperties: type: string host: - $ref: '#/components/schemas/_common:Host' + $ref: '#/components/schemas/_common___Host' username: - $ref: '#/components/schemas/_common:Username' + $ref: '#/components/schemas/_common___Username' password: - $ref: '#/components/schemas/_common:Password' + $ref: '#/components/schemas/_common___Password' socket_timeout: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' required: - host - _core.reindex:Source: + _core.reindex___Source: type: object properties: index: - $ref: '#/components/schemas/_common:Indices' + $ref: '#/components/schemas/_common___Indices' query: - $ref: '#/components/schemas/_common.query_dsl:QueryContainer' + $ref: '#/components/schemas/_common.query_dsl___QueryContainer' remote: - $ref: '#/components/schemas/_core.reindex:RemoteSource' + $ref: '#/components/schemas/_core.reindex___RemoteSource' size: description: |- The number of documents to index per batch. - Use when indexing from remote to ensure that the batches fit within the on-heap buffer, which defaults to a maximum size of 100 MB. + Use the `size` setting when indexing from a remote cluster. This ensures that batches fit in the on-heap buffer. The buffer defaults to a maximum size of `100MB`. type: number slice: - $ref: '#/components/schemas/_common:SlicedScroll' + $ref: '#/components/schemas/_common___SlicedScroll' sort: - $ref: '#/components/schemas/_common:Sort' + $ref: '#/components/schemas/_common___Sort' _source: - $ref: '#/components/schemas/_common:Fields' - runtime_mappings: - $ref: '#/components/schemas/_common.mapping:RuntimeFields' + $ref: '#/components/schemas/_common___Fields' required: - index - _core.scripts_painless_execute:PainlessContextSetup: + _core.scripts_painless_execute___PainlessContextSetup: type: object properties: document: - description: Document that's temporarily indexed in-memory and accessible from the script. + description: A document temporarily indexed in-memory and accessible from the Painless script. type: object index: - $ref: '#/components/schemas/_common:IndexName' + $ref: '#/components/schemas/_common___IndexName' query: - $ref: '#/components/schemas/_common.query_dsl:QueryContainer' + $ref: '#/components/schemas/_common.query_dsl___QueryContainer' required: - document - index - query - _core.search_shards:ShardStoreIndex: + _core.search_shards___ShardStoreIndex: type: object properties: aliases: type: array items: - $ref: '#/components/schemas/_common:Name' + $ref: '#/components/schemas/_common___Name' filter: - $ref: '#/components/schemas/_common.query_dsl:QueryContainer' - _core.search:AggregationBreakdown: + $ref: '#/components/schemas/_common.query_dsl___QueryContainer' + _core.search___AggregationBreakdown: type: object properties: build_aggregation: @@ -42064,29 +43648,29 @@ components: - initialize_count - reduce - reduce_count - _core.search:AggregationProfile: + _core.search___AggregationProfile: type: object properties: breakdown: - $ref: '#/components/schemas/_core.search:AggregationBreakdown' + $ref: '#/components/schemas/_core.search___AggregationBreakdown' description: type: string time_in_nanos: - $ref: '#/components/schemas/_common:DurationValueUnitNanos' + $ref: '#/components/schemas/_common___DurationValueUnitNanos' type: type: string debug: - $ref: '#/components/schemas/_core.search:AggregationProfileDebug' + $ref: '#/components/schemas/_core.search___AggregationProfileDebug' children: type: array items: - $ref: '#/components/schemas/_core.search:AggregationProfile' + $ref: '#/components/schemas/_core.search___AggregationProfile' required: - breakdown - description - time_in_nanos - type - _core.search:AggregationProfileDebug: + _core.search___AggregationProfileDebug: type: object properties: segments_with_multi_valued_ords: @@ -42110,7 +43694,7 @@ components: delegate: type: string delegate_debug: - $ref: '#/components/schemas/_core.search:AggregationProfileDebug' + $ref: '#/components/schemas/_core.search___AggregationProfileDebug' chars_fetched: type: integer format: int32 @@ -42160,7 +43744,7 @@ components: filters: type: array items: - $ref: '#/components/schemas/_core.search:AggregationProfileDelegateDebugFilter' + $ref: '#/components/schemas/_core.search___AggregationProfileDelegateDebugFilter' segments_counted: type: integer format: int32 @@ -42169,7 +43753,7 @@ components: format: int32 map_reducer: type: string - _core.search:AggregationProfileDelegateDebugFilter: + _core.search___AggregationProfileDelegateDebugFilter: type: object properties: results_from_metadata: @@ -42182,19 +43766,19 @@ components: segments_counted_in_constant_time: type: integer format: int32 - _core.search:BoundaryScanner: + _core.search___BoundaryScanner: type: string enum: - chars - sentence - word - _core.search:BuiltinHighlighterType: + _core.search___BuiltinHighlighterType: type: string enum: - fvh - plain - unified - _core.search:Collector: + _core.search___Collector: type: object properties: name: @@ -42202,29 +43786,29 @@ components: reason: type: string time_in_nanos: - $ref: '#/components/schemas/_common:DurationValueUnitNanos' + $ref: '#/components/schemas/_common___DurationValueUnitNanos' children: type: array items: - $ref: '#/components/schemas/_core.search:Collector' + $ref: '#/components/schemas/_core.search___Collector' required: - name - reason - time_in_nanos - _core.search:CompletionSuggest: + _core.search___CompletionSuggest: allOf: - - $ref: '#/components/schemas/_core.search:SuggestBase' + - $ref: '#/components/schemas/_core.search___SuggestBase' - type: object properties: options: oneOf: - - $ref: '#/components/schemas/_core.search:CompletionSuggestOption' + - $ref: '#/components/schemas/_core.search___CompletionSuggestOption' - type: array items: - $ref: '#/components/schemas/_core.search:CompletionSuggestOption' + $ref: '#/components/schemas/_core.search___CompletionSuggestOption' required: - options - _core.search:CompletionSuggestOption: + _core.search___CompletionSuggestOption: type: object properties: collate_match: @@ -42234,7 +43818,7 @@ components: additionalProperties: type: array items: - $ref: '#/components/schemas/_core.search:Context' + $ref: '#/components/schemas/_core.search___Context' fields: type: object additionalProperties: @@ -42242,9 +43826,9 @@ components: _id: type: string _index: - $ref: '#/components/schemas/_common:IndexName' + $ref: '#/components/schemas/_common___IndexName' _routing: - $ref: '#/components/schemas/_common:Routing' + $ref: '#/components/schemas/_common___Routing' _score: type: number format: float @@ -42257,12 +43841,12 @@ components: format: float required: - text - _core.search:Context: + _core.search___Context: description: Text or location that we want similar documents for or a lookup to a document's field for the text. oneOf: - type: string - - $ref: '#/components/schemas/_common:GeoLocation' - _core.search:FetchProfile: + - $ref: '#/components/schemas/_common___GeoLocation' + _core.search___FetchProfile: type: object properties: type: @@ -42270,21 +43854,21 @@ components: description: type: string time_in_nanos: - $ref: '#/components/schemas/_common:DurationValueUnitNanos' + $ref: '#/components/schemas/_common___DurationValueUnitNanos' breakdown: - $ref: '#/components/schemas/_core.search:FetchProfileBreakdown' + $ref: '#/components/schemas/_core.search___FetchProfileBreakdown' debug: - $ref: '#/components/schemas/_core.search:FetchProfileDebug' + $ref: '#/components/schemas/_core.search___FetchProfileDebug' children: type: array items: - $ref: '#/components/schemas/_core.search:FetchProfile' + $ref: '#/components/schemas/_core.search___FetchProfile' required: - breakdown - description - time_in_nanos - type - _core.search:FetchProfileBreakdown: + _core.search___FetchProfileBreakdown: type: object properties: load_source: @@ -42309,7 +43893,7 @@ components: process: type: integer format: int32 - _core.search:FetchProfileDebug: + _core.search___FetchProfileDebug: type: object properties: stored_fields: @@ -42319,41 +43903,41 @@ components: fast_path: type: integer format: int32 - _core.search:FieldCollapse: + _core.search___FieldCollapse: type: object properties: field: - $ref: '#/components/schemas/_common:Field' + $ref: '#/components/schemas/_common___Field' inner_hits: - description: The number of inner hits and their sort order + description: The number of inner hits and their sort order. oneOf: - - $ref: '#/components/schemas/_core.search:InnerHits' + - $ref: '#/components/schemas/_core.search___InnerHits' - type: array items: - $ref: '#/components/schemas/_core.search:InnerHits' + $ref: '#/components/schemas/_core.search___InnerHits' max_concurrent_group_searches: - description: The number of concurrent requests allowed to retrieve the inner_hits per group + description: The number of concurrent requests that are allowed to be retrieved by the `inner_hits` parameter per group. type: integer required: - field - _core.search:Highlight: + _core.search___Highlight: allOf: - - $ref: '#/components/schemas/_core.search:HighlightBase' + - $ref: '#/components/schemas/_core.search___HighlightBase' - type: object properties: encoder: - $ref: '#/components/schemas/_core.search:HighlighterEncoder' + $ref: '#/components/schemas/_core.search___HighlighterEncoder' fields: type: object additionalProperties: - $ref: '#/components/schemas/_core.search:HighlightField' + $ref: '#/components/schemas/_core.search___HighlightField' required: - fields - _core.search:HighlightBase: + _core.search___HighlightBase: type: object properties: type: - $ref: '#/components/schemas/_core.search:HighlighterType' + $ref: '#/components/schemas/_core.search___HighlighterType' boundary_chars: description: A string that contains each boundary character. type: string @@ -42362,17 +43946,17 @@ components: type: integer format: int32 boundary_scanner: - $ref: '#/components/schemas/_core.search:BoundaryScanner' + $ref: '#/components/schemas/_core.search___BoundaryScanner' boundary_scanner_locale: description: |- Controls which locale is used to search for sentence and word boundaries. - This parameter takes a form of a language tag, for example: `"en-US"`, `"fr-FR"`, `"ja-JP"`. + This parameter takes the form of a language tag, for example, `"en-US"`, `"fr-FR"`, or `"ja-JP"`. type: string force_source: deprecated: true type: boolean fragmenter: - $ref: '#/components/schemas/_core.search:HighlighterFragmenter' + $ref: '#/components/schemas/_core.search___HighlighterFragmenter' fragment_size: description: The size of the highlighted fragment in characters. type: integer @@ -42380,15 +43964,15 @@ components: highlight_filter: type: boolean highlight_query: - $ref: '#/components/schemas/_common.query_dsl:QueryContainer' + $ref: '#/components/schemas/_common.query_dsl___QueryContainer' max_fragment_length: type: integer format: int32 max_analyzed_offset: description: |- If set to a non-negative value, highlighting stops at this defined maximum limit. - The rest of the text is not processed, thus not highlighted and no error is returned - The `max_analyzed_offset` query setting does not override the `index.highlight.max_analyzed_offset` setting, which prevails when it's set to lower value than the query setting. + The rest of the text is not processed or highlighted, and no error is returned. + The `max_analyzed_offset` query setting does not override the `index.highlight.max_analyzed_offset` setting, which takes precedence when it is set to a lower value than the query setting. type: integer format: int32 no_match_size: @@ -42398,10 +43982,10 @@ components: number_of_fragments: description: |- The maximum number of fragments to return. - If the number of fragments is set to `0`, no fragments are returned. - Instead, the entire field contents are highlighted and returned. - This can be handy when you need to highlight short texts such as a title or address, but fragmentation is not required. - If `number_of_fragments` is `0`, `fragment_size` is ignored. + When the number of fragments is set to `0`, no fragments are returned. + Instead, the entirety of a field's contents are highlighted and returned. + This is useful when you need to highlight short texts, such as a title or address, in which fragmentation is not required. + If `number_of_fragments` is set to `0`, the `fragment_size` is ignored. type: integer format: int32 options: @@ -42409,25 +43993,25 @@ components: additionalProperties: type: object order: - $ref: '#/components/schemas/_core.search:HighlighterOrder' + $ref: '#/components/schemas/_core.search___HighlighterOrder' phrase_limit: description: |- Controls the number of matching phrases in a document that are considered. - Prevents the `fvh` highlighter from analyzing too many phrases and consuming too much memory. - When using `matched_fields`, `phrase_limit` phrases per matched field are considered. Raising the limit increases query time and consumes more memory. - Only supported by the `fvh` highlighter. + This prevents the `fvh` highlighter from analyzing too many phrases and consuming too much memory. + When using `matched_fields`, phrase-limited phrases per matched field are considered. Raising the limit increases the query time and consumes more memory. + This setting is only supported by the `fvh` highlighter. type: integer format: int32 post_tags: description: |- - Use in conjunction with `pre_tags` to define the HTML tags to use for the highlighted text. + When used in conjunction with `pre_tags`, defines the HTML tags to use for the highlighted text. By default, highlighted text is wrapped in `` and `` tags. type: array items: type: string pre_tags: description: |- - Use in conjunction with `post_tags` to define the HTML tags to use for the highlighted text. + When used in conjunction with `post_tags`, defines the HTML tags to use for the highlighted text. By default, highlighted text is wrapped in `` and `` tags. type: array items: @@ -42438,59 +44022,59 @@ components: Set to `false` to highlight all fields. type: boolean tags_schema: - $ref: '#/components/schemas/_core.search:HighlighterTagsSchema' - _core.search:HighlighterEncoder: + $ref: '#/components/schemas/_core.search___HighlighterTagsSchema' + _core.search___HighlighterEncoder: type: string enum: - default - html - _core.search:HighlighterFragmenter: + _core.search___HighlighterFragmenter: type: string enum: - simple - span - _core.search:HighlighterOrder: + _core.search___HighlighterOrder: type: string enum: - score - _core.search:HighlighterTagsSchema: + _core.search___HighlighterTagsSchema: type: string enum: - styled - _core.search:HighlighterType: + _core.search___HighlighterType: oneOf: - title: builtin - $ref: '#/components/schemas/_core.search:BuiltinHighlighterType' + $ref: '#/components/schemas/_core.search___BuiltinHighlighterType' - title: custom type: string - _core.search:HighlightField: + _core.search___HighlightField: allOf: - - $ref: '#/components/schemas/_core.search:HighlightBase' + - $ref: '#/components/schemas/_core.search___HighlightBase' - type: object properties: fragment_offset: type: integer format: int32 matched_fields: - $ref: '#/components/schemas/_common:Fields' + $ref: '#/components/schemas/_common___Fields' analyzer: - $ref: '#/components/schemas/_common.analysis:Analyzer' - _core.search:Hit: + $ref: '#/components/schemas/_common.analysis___Analyzer' + _core.search___Hit: type: object properties: _type: - $ref: '#/components/schemas/_common:Type' + $ref: '#/components/schemas/_common___Type' _index: - $ref: '#/components/schemas/_common:IndexName' + $ref: '#/components/schemas/_common___IndexName' _id: - $ref: '#/components/schemas/_common:Id' + $ref: '#/components/schemas/_common___Id' _score: type: - 'null' - number - string _explanation: - $ref: '#/components/schemas/_core.explain:Explanation' + $ref: '#/components/schemas/_core.explain___Explanation' fields: type: object additionalProperties: @@ -42504,13 +44088,13 @@ components: inner_hits: type: object additionalProperties: - $ref: '#/components/schemas/_core.search:InnerHitsResult' + $ref: '#/components/schemas/_core.search___InnerHitsResult' matched_queries: type: array items: type: string _nested: - $ref: '#/components/schemas/_core.search:NestedIdentity' + $ref: '#/components/schemas/_core.search___NestedIdentity' _ignored: type: array items: @@ -42530,30 +44114,30 @@ components: _source: type: object _seq_no: - $ref: '#/components/schemas/_common:SequenceNumber' + $ref: '#/components/schemas/_common___SequenceNumber' _primary_term: type: integer format: int64 _version: - $ref: '#/components/schemas/_common:VersionNumber' + $ref: '#/components/schemas/_common___VersionNumber' sort: - $ref: '#/components/schemas/_common:SortResults' + $ref: '#/components/schemas/_common___SortResults' required: - _id - _index - _core.search:HitsMetadata: + _core.search___HitsMetadata: type: object properties: total: - description: Total hit count information, present only if `track_total_hits` wasn't `false` in the search request. + description: The total number of hits, present only if `track_total_hits` is not set to `false` in the search request. oneOf: - - $ref: '#/components/schemas/_core.search:TotalHits' + - $ref: '#/components/schemas/_core.search___TotalHits' - type: integer format: int64 hits: type: array items: - $ref: '#/components/schemas/_core.search:Hit' + $ref: '#/components/schemas/_core.search___Hit' max_score: type: - 'null' @@ -42561,83 +44145,83 @@ components: - string required: - hits - _core.search:InnerHits: + _core.search___InnerHits: type: object properties: name: - $ref: '#/components/schemas/_common:Name' + $ref: '#/components/schemas/_common___Name' size: description: The maximum number of hits to return per `inner_hits`. type: integer format: int32 from: - description: Inner hit starting document offset. + description: The inner hit that initiates document offset. type: integer format: int32 collapse: - $ref: '#/components/schemas/_core.search:FieldCollapse' + $ref: '#/components/schemas/_core.search___FieldCollapse' docvalue_fields: type: array items: - $ref: '#/components/schemas/_common.query_dsl:FieldAndFormat' + $ref: '#/components/schemas/_common.query_dsl___FieldAndFormat' explain: type: boolean highlight: - $ref: '#/components/schemas/_core.search:Highlight' + $ref: '#/components/schemas/_core.search___Highlight' ignore_unmapped: type: boolean script_fields: type: object additionalProperties: - $ref: '#/components/schemas/_common:ScriptField' + $ref: '#/components/schemas/_common___ScriptField' seq_no_primary_term: type: boolean fields: - $ref: '#/components/schemas/_common:Fields' + $ref: '#/components/schemas/_common___Fields' sort: - $ref: '#/components/schemas/_common:Sort' + $ref: '#/components/schemas/_common___Sort' _source: - $ref: '#/components/schemas/_core.search:SourceConfig' + $ref: '#/components/schemas/_core.search___SourceConfig' stored_field: - $ref: '#/components/schemas/_common:Fields' + $ref: '#/components/schemas/_common___Fields' track_scores: type: boolean version: type: boolean - _core.search:InnerHitsResult: + _core.search___InnerHitsResult: type: object properties: hits: - $ref: '#/components/schemas/_core.search:HitsMetadata' + $ref: '#/components/schemas/_core.search___HitsMetadata' required: - hits - _core.search:NestedIdentity: + _core.search___NestedIdentity: type: object properties: field: - $ref: '#/components/schemas/_common:Field' + $ref: '#/components/schemas/_common___Field' offset: type: integer format: int32 _nested: - $ref: '#/components/schemas/_core.search:NestedIdentity' + $ref: '#/components/schemas/_core.search___NestedIdentity' required: - field - offset - _core.search:PhraseSuggest: + _core.search___PhraseSuggest: allOf: - - $ref: '#/components/schemas/_core.search:SuggestBase' + - $ref: '#/components/schemas/_core.search___SuggestBase' - type: object properties: options: oneOf: - - $ref: '#/components/schemas/_core.search:PhraseSuggestOption' + - $ref: '#/components/schemas/_core.search___PhraseSuggestOption' - type: array items: - $ref: '#/components/schemas/_core.search:PhraseSuggestOption' + $ref: '#/components/schemas/_core.search___PhraseSuggestOption' required: - options - _core.search:PhraseSuggestOption: + _core.search___PhraseSuggestOption: type: object properties: text: @@ -42652,25 +44236,25 @@ components: required: - score - text - _core.search:PointInTimeReference: + _core.search___PointInTimeReference: type: object properties: id: - $ref: '#/components/schemas/_common:Id' + $ref: '#/components/schemas/_common___Id' keep_alive: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' required: - id - _core.search:Profile: + _core.search___Profile: type: object properties: shards: type: array items: - $ref: '#/components/schemas/_core.search:ShardProfile' + $ref: '#/components/schemas/_core.search___ShardProfile' required: - shards - _core.search:QueryBreakdown: + _core.search___QueryBreakdown: type: object properties: advance: @@ -42746,54 +44330,54 @@ components: - set_min_competitive_score_count - shallow_advance - shallow_advance_count - _core.search:QueryProfile: + _core.search___QueryProfile: type: object properties: breakdown: - $ref: '#/components/schemas/_core.search:QueryBreakdown' + $ref: '#/components/schemas/_core.search___QueryBreakdown' description: type: string time_in_nanos: - $ref: '#/components/schemas/_common:DurationValueUnitNanos' + $ref: '#/components/schemas/_common___DurationValueUnitNanos' type: type: string children: type: array items: - $ref: '#/components/schemas/_core.search:QueryProfile' + $ref: '#/components/schemas/_core.search___QueryProfile' required: - breakdown - description - time_in_nanos - type - _core.search:Rescore: + _core.search___Rescore: type: object properties: query: - $ref: '#/components/schemas/_core.search:RescoreQuery' + $ref: '#/components/schemas/_core.search___RescoreQuery' window_size: type: integer format: int32 required: - query - _core.search:RescoreQuery: + _core.search___RescoreQuery: type: object properties: rescore_query: - $ref: '#/components/schemas/_common.query_dsl:QueryContainer' + $ref: '#/components/schemas/_common.query_dsl___QueryContainer' query_weight: - description: Relative importance of the original query versus the rescore query. + description: The relative importance of the original query as compared to the rescore query. type: number format: float rescore_query_weight: - description: Relative importance of the rescore query versus the original query. + description: The relative importance of the rescore query as compared to the original query. type: number format: float score_mode: - $ref: '#/components/schemas/_core.search:ScoreMode' + $ref: '#/components/schemas/_core.search___ScoreMode' required: - rescore_query - _core.search:ResponseBody: + _core.search___ResponseBody: type: object properties: took: @@ -42802,18 +44386,18 @@ components: timed_out: type: boolean _shards: - $ref: '#/components/schemas/_common:ShardStatistics' + $ref: '#/components/schemas/_common___ShardStatistics' phase_took: x-version-added: '2.12' - $ref: '#/components/schemas/_common:PhaseTook' + $ref: '#/components/schemas/_common___PhaseTook' hits: - $ref: '#/components/schemas/_core.search:HitsMetadata' + $ref: '#/components/schemas/_core.search___HitsMetadata' aggregations: type: object additionalProperties: - $ref: '#/components/schemas/_common.aggregations:Aggregate' + $ref: '#/components/schemas/_common.aggregations___Aggregate' _clusters: - $ref: '#/components/schemas/_common:ClusterStatistics' + $ref: '#/components/schemas/_common___ClusterStatistics' fields: type: object additionalProperties: @@ -42825,17 +44409,17 @@ components: type: integer format: int32 profile: - $ref: '#/components/schemas/_core.search:Profile' + $ref: '#/components/schemas/_core.search___Profile' pit_id: - $ref: '#/components/schemas/_common:Id' + $ref: '#/components/schemas/_common___Id' _scroll_id: - $ref: '#/components/schemas/_common:ScrollId' + $ref: '#/components/schemas/_common___ScrollId' suggest: type: object additionalProperties: type: array items: - $ref: '#/components/schemas/_core.search:Suggest' + $ref: '#/components/schemas/_core.search___Suggest' terminated_early: type: boolean required: @@ -42843,7 +44427,7 @@ components: - hits - timed_out - took - _core.search:ScoreMode: + _core.search___ScoreMode: type: string enum: - avg @@ -42851,17 +44435,17 @@ components: - min - multiply - total - _core.search:SearchProfile: + _core.search___SearchProfile: type: object properties: collector: type: array items: - $ref: '#/components/schemas/_core.search:Collector' + $ref: '#/components/schemas/_core.search___Collector' query: type: array items: - $ref: '#/components/schemas/_core.search:QueryProfile' + $ref: '#/components/schemas/_core.search___QueryProfile' rewrite_time: type: integer format: int64 @@ -42869,26 +44453,26 @@ components: - collector - query - rewrite_time - _core.search:ShardProfile: + _core.search___ShardProfile: type: object properties: aggregations: type: array items: - $ref: '#/components/schemas/_core.search:AggregationProfile' + $ref: '#/components/schemas/_core.search___AggregationProfile' id: type: string searches: type: array items: - $ref: '#/components/schemas/_core.search:SearchProfile' + $ref: '#/components/schemas/_core.search___SearchProfile' fetch: - $ref: '#/components/schemas/_core.search:FetchProfile' + $ref: '#/components/schemas/_core.search___FetchProfile' required: - aggregations - id - searches - _core.search:SourceConfig: + _core.search___SourceConfig: description: Defines how to fetch a source. Fetching can be disabled entirely, or the source can be filtered. oneOf: - title: fetch @@ -42896,29 +44480,29 @@ components: - title: includes type: array items: - $ref: '#/components/schemas/_common:Field' + $ref: '#/components/schemas/_common___Field' - title: filter - $ref: '#/components/schemas/_core.search:SourceFilter' - _core.search:SourceConfigParam: + $ref: '#/components/schemas/_core.search___SourceFilter' + _core.search___SourceConfigParam: description: |- Defines how to fetch a source. Fetching can be disabled entirely, or the source can be filtered. - Used as a query parameter along with the `_source_includes` and `_source_excludes` parameters. + Use this setting with the `_source_includes` and `_source_excludes` parameters. oneOf: - type: boolean - - $ref: '#/components/schemas/_common:Fields' - _core.search:SourceFilter: + - $ref: '#/components/schemas/_common___Fields' + _core.search___SourceFilter: type: object properties: excludes: - $ref: '#/components/schemas/_common:Fields' + $ref: '#/components/schemas/_common___Fields' includes: - $ref: '#/components/schemas/_common:Fields' - _core.search:Suggest: + $ref: '#/components/schemas/_common___Fields' + _core.search___Suggest: oneOf: - - $ref: '#/components/schemas/_core.search:CompletionSuggest' - - $ref: '#/components/schemas/_core.search:PhraseSuggest' - - $ref: '#/components/schemas/_core.search:TermSuggest' - _core.search:SuggestBase: + - $ref: '#/components/schemas/_core.search___CompletionSuggest' + - $ref: '#/components/schemas/_core.search___PhraseSuggest' + - $ref: '#/components/schemas/_core.search___TermSuggest' + _core.search___SuggestBase: type: object properties: length: @@ -42933,26 +44517,26 @@ components: - length - offset - text - _core.search:Suggester: + _core.search___Suggester: type: object properties: text: - description: Global suggest text, to avoid repetition when the same text is used in several suggesters + description: The global suggest text, which avoids repetition when the same text is used in several suggesters. type: string - _core.search:TermSuggest: + _core.search___TermSuggest: allOf: - - $ref: '#/components/schemas/_core.search:SuggestBase' + - $ref: '#/components/schemas/_core.search___SuggestBase' - type: object properties: options: oneOf: - - $ref: '#/components/schemas/_core.search:TermSuggestOption' + - $ref: '#/components/schemas/_core.search___TermSuggestOption' - type: array items: - $ref: '#/components/schemas/_core.search:TermSuggestOption' + $ref: '#/components/schemas/_core.search___TermSuggestOption' required: - options - _core.search:TermSuggestOption: + _core.search___TermSuggestOption: type: object properties: text: @@ -42971,33 +44555,33 @@ components: - freq - score - text - _core.search:TotalHits: + _core.search___TotalHits: type: object properties: relation: - $ref: '#/components/schemas/_core.search:TotalHitsRelation' + $ref: '#/components/schemas/_core.search___TotalHitsRelation' value: type: integer format: int64 required: - relation - value - _core.search:TotalHitsRelation: + _core.search___TotalHitsRelation: type: string enum: - eq - gte - _core.search:TrackHits: + _core.search___TrackHits: description: |- - Number of hits matching the query to count accurately. If true, the exact - number of hits is returned at the cost of some performance. If false, the + The number of hits matching the query. When `true`, the exact + number of hits is returned at the cost of some performance. When `false`, the response does not include the total number of hits matching the query. - Defaults to 10,000 hits. + Default is `10,000` hits. oneOf: - type: boolean - type: integer format: int32 - _core.termvectors:FieldStatistics: + _core.termvectors___FieldStatistics: type: object properties: doc_count: @@ -43010,26 +44594,27 @@ components: - doc_count - sum_doc_freq - sum_ttf - _core.termvectors:Filter: + _core.termvectors___Filter: type: object properties: max_doc_freq: description: |- - Ignore words which occur in more than this many docs. - Defaults to unbounded. + Ignores words that appear in more than the specified number of documents. + Default is `unbounded`. type: number max_num_terms: - description: Maximum number of terms that must be returned per field. + description: The maximum number of terms that should be returned per field. type: number max_term_freq: description: |- Ignore words with more than this frequency in the source doc. - Defaults to unbounded. + Default is `unbounded`. type: number max_word_length: description: |- - The maximum word length above which words will be ignored. - Defaults to unbounded. + The maximum word length. + Words longer than this value will be ignored. + Default is `unbounded`. type: number min_doc_freq: description: Ignore terms which do not occur in at least this many docs. @@ -43038,9 +44623,12 @@ components: description: Ignore words with less than this frequency in the source doc. type: number min_word_length: - description: The minimum word length below which words will be ignored. + description: |- + The minimum word length. + Words shorter than this value will be ignored. + Default is 0. type: number - _core.termvectors:Term: + _core.termvectors___Term: type: object properties: doc_freq: @@ -43052,24 +44640,24 @@ components: tokens: type: array items: - $ref: '#/components/schemas/_core.termvectors:Token' + $ref: '#/components/schemas/_core.termvectors___Token' ttf: type: number required: - term_freq - _core.termvectors:TermVector: + _core.termvectors___TermVector: type: object properties: field_statistics: - $ref: '#/components/schemas/_core.termvectors:FieldStatistics' + $ref: '#/components/schemas/_core.termvectors___FieldStatistics' terms: type: object additionalProperties: - $ref: '#/components/schemas/_core.termvectors:Term' + $ref: '#/components/schemas/_core.termvectors___Term' required: - field_statistics - terms - _core.termvectors:Token: + _core.termvectors___Token: type: object properties: end_offset: @@ -43082,25 +44670,25 @@ components: type: number required: - position - _core.update_by_query_rethrottle:UpdateByQueryRethrottleNode: + _core.update_by_query_rethrottle___UpdateByQueryRethrottleNode: allOf: - - $ref: '#/components/schemas/_common:BaseNode' + - $ref: '#/components/schemas/_common___BaseNode' - type: object properties: tasks: type: object additionalProperties: - $ref: '#/components/schemas/tasks._common:TaskInfo' + $ref: '#/components/schemas/tasks._common___TaskInfo' required: - tasks - _core.update:UpdateWriteResponseBase: + _core.update___UpdateWriteResponseBase: allOf: - - $ref: '#/components/schemas/_common:WriteResponseBase' + - $ref: '#/components/schemas/_common___WriteResponseBase' - type: object properties: get: - $ref: '#/components/schemas/_common:InlineGet' - asynchronous_search._common:AsynchronousSearchStats: + $ref: '#/components/schemas/_common___InlineGet' + asynchronous_search._common___AsynchronousSearchStats: type: object properties: submitted: @@ -43121,12 +44709,12 @@ components: type: integer persisted: type: integer - asynchronous_search._common:NodesStats: + asynchronous_search._common___NodesStats: type: object properties: asynchronous_search_stats: - $ref: '#/components/schemas/asynchronous_search._common:AsynchronousSearchStats' - asynchronous_search._common:ResponseBody: + $ref: '#/components/schemas/asynchronous_search._common___AsynchronousSearchStats' + asynchronous_search._common___ResponseBody: type: object properties: id: @@ -43140,19 +44728,19 @@ components: took: type: number response: - $ref: '#/components/schemas/_core.search:ResponseBody' - asynchronous_search._common:Search: + $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' + $ref: '#/components/schemas/_common.aggregations___AggregationContainer' collapse: - $ref: '#/components/schemas/_core.search:FieldCollapse' + $ref: '#/components/schemas/_core.search___FieldCollapse' explain: - description: If true, returns detailed information about score computation as part of a hit. + 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. @@ -43167,11 +44755,11 @@ components: To page through more hits, use the `search_after` parameter. type: number highlight: - $ref: '#/components/schemas/_core.search:Highlight' + $ref: '#/components/schemas/_core.search___Highlight' track_total_hits: - $ref: '#/components/schemas/_core.search:TrackHits' + $ref: '#/components/schemas/_core.search___TrackHits' indices_boost: - description: Boosts the _score of documents from specified indices. + description: Boosts the `_score` of documents from specified indexes. type: array items: type: object @@ -43183,30 +44771,30 @@ components: 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' + $ref: '#/components/schemas/_common.query_dsl___FieldAndFormat' rank: - $ref: '#/components/schemas/_common:RankContainer' + $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' + $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' + $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' + $ref: '#/components/schemas/_common___ScriptField' search_after: - $ref: '#/components/schemas/_common:SortResults' + $ref: '#/components/schemas/_common___SortResults' size: description: |- The number of hits to return. @@ -43214,20 +44802,20 @@ components: To page through more hits, use the `search_after` parameter. type: number slice: - $ref: '#/components/schemas/_common:SlicedScroll' + $ref: '#/components/schemas/_common___SlicedScroll' sort: - $ref: '#/components/schemas/_common:Sort' + $ref: '#/components/schemas/_common___Sort' _source: - $ref: '#/components/schemas/_core.search:SourceConfig' + $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' + $ref: '#/components/schemas/_common.query_dsl___FieldAndFormat' suggest: - $ref: '#/components/schemas/_core.search:Suggester' + $ref: '#/components/schemas/_core.search___Suggester' terminate_after: description: |- Maximum number of documents to collect for each shard. @@ -43236,7 +44824,7 @@ components: 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. + Avoid specifying this parameter for requests that target data streams with backing indexes across multiple data tiers. If set to `0` (default), the query does not terminate early. type: integer format: int32 @@ -43247,41 +44835,39 @@ components: 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. + 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. + 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' + $ref: '#/components/schemas/_common___Fields' pit: - $ref: '#/components/schemas/_core.search:PointInTimeReference' - runtime_mappings: - $ref: '#/components/schemas/_common.mapping:RuntimeFields' + $ref: '#/components/schemas/_core.search___PointInTimeReference' 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. + You can retrieve these stats using the indexes stats API. type: array items: type: string description: The search definition using the Query DSL. - asynchronous_search._common:StatsResponse: + asynchronous_search._common___StatsResponse: type: object properties: _nodes: - $ref: '#/components/schemas/_common:NodeStatistics' + $ref: '#/components/schemas/_common___NodeStatistics' cluster_name: type: string nodes: type: object additionalProperties: - $ref: '#/components/schemas/asynchronous_search._common:NodesStats' - cat._common:CatPitSegmentsRecord: + $ref: '#/components/schemas/asynchronous_search._common___NodesStats' + cat._common___CatPitSegmentsRecord: type: object properties: index: @@ -43312,7 +44898,7 @@ components: type: string compound: type: string - cat._common:CatSegmentReplicationRecord: + cat._common___CatSegmentReplicationRecord: type: object properties: shardId: @@ -43338,11 +44924,11 @@ components: files_fetched: type: string files_percent: - $ref: '#/components/schemas/_common:PercentageString' + $ref: '#/components/schemas/_common___PercentageString' bytes_fetched: type: string bytes_percent: - $ref: '#/components/schemas/_common:PercentageString' + $ref: '#/components/schemas/_common___PercentageString' start_time: type: string stop_time: @@ -43365,14 +44951,14 @@ components: type: string finalize_replication_stage_time_taken: type: string - cat.aliases:AliasesRecord: + cat.aliases___AliasesRecord: type: object properties: alias: description: alias name type: string index: - $ref: '#/components/schemas/_common:IndexName' + $ref: '#/components/schemas/_common___IndexName' filter: description: filter type: string @@ -43385,7 +44971,7 @@ components: is_write_index: description: write index type: string - cat.allocation:AllocationRecord: + cat.allocation___AllocationRecord: type: object properties: shards: @@ -43423,57 +45009,57 @@ components: disk.percent: description: Total percentage of disk space in use. Calculated as `disk.used / disk.total`. oneOf: - - $ref: '#/components/schemas/_common:PercentageString' + - $ref: '#/components/schemas/_common___PercentageString' - type: 'null' host: description: Network host for the node. Set using the `network.host` setting. oneOf: - - $ref: '#/components/schemas/_common:Host' + - $ref: '#/components/schemas/_common___Host' - type: 'null' ip: description: IP address and port for the node. oneOf: - - $ref: '#/components/schemas/_common:Ip' + - $ref: '#/components/schemas/_common___Ip' - type: 'null' node: description: Name for the node. Set using the `node.name` setting. type: string - cat.cluster_manager:ClusterManagerRecord: + cat.cluster_manager___ClusterManagerRecord: type: object properties: id: description: node id type: string host: - description: host name + description: hostname type: string ip: - description: ip address + description: IP address type: string node: description: node name type: string - cat.count:CountRecord: + cat.count___CountRecord: type: object properties: epoch: - $ref: '#/components/schemas/_common:StringifiedEpochTimeUnitSeconds' + $ref: '#/components/schemas/_common___StringifiedEpochTimeUnitSeconds' timestamp: - $ref: '#/components/schemas/_common:TimeOfDay' + $ref: '#/components/schemas/_common___TimeOfDay' count: description: the document count type: string - cat.fielddata:FielddataRecord: + cat.fielddata___FielddataRecord: type: object properties: id: description: node id type: string host: - description: host name + description: hostname type: string ip: - description: ip address + description: IP address type: string node: description: node name @@ -43484,13 +45070,13 @@ components: size: description: field data usage type: string - cat.health:HealthRecord: + cat.health___HealthRecord: type: object properties: epoch: - $ref: '#/components/schemas/_common:StringifiedEpochTimeUnitSeconds' + $ref: '#/components/schemas/_common___StringifiedEpochTimeUnitSeconds' timestamp: - $ref: '#/components/schemas/_common:TimeOfDay' + $ref: '#/components/schemas/_common___TimeOfDay' cluster: description: cluster name type: string @@ -43526,7 +45112,7 @@ components: type: string active_shards_percent: description: active number of shards in percent - $ref: '#/components/schemas/_common:PercentageString' + $ref: '#/components/schemas/_common___PercentageString' discovered_cluster_manager: description: cluster manager is discovered or not type: string @@ -43534,7 +45120,7 @@ components: x-version-removed: '2.0' description: cluster manager is discovered or not type: string - cat.indices:IndicesRecord: + cat.indices___IndicesRecord: type: object properties: health: @@ -43547,7 +45133,7 @@ components: description: index name type: string uuid: - description: index uuid + description: index UUID type: string pri: description: number of primary shards @@ -43572,7 +45158,7 @@ components: description: index creation date (as string) type: string store.size: - description: store size of primaries & replicas + description: store size of primaries and replicas type: - 'null' - string @@ -43592,22 +45178,22 @@ components: - 'null' - string fielddata.memory_size: - description: used fielddata cache + description: used field data cache type: - 'null' - string pri.fielddata.memory_size: - description: used fielddata cache + description: used field data cache type: - 'null' - string fielddata.evictions: - description: fielddata evictions + description: field data evictions type: - 'null' - string pri.fielddata.evictions: - description: fielddata evictions + description: field data evictions type: - 'null' - string @@ -44148,12 +45734,12 @@ components: - 'null' - string segments.fixed_bitset_memory: - description: memory used by fixed bit sets for nested object field types and export type filters for types referred in _parent fields + description: memory used by fixed bit sets for nested object field types and export type filters for types referred in `_parent` fields type: - 'null' - string pri.segments.fixed_bitset_memory: - description: memory used by fixed bit sets for nested object field types and export type filters for types referred in _parent fields + description: memory used by fixed bit sets for nested object field types and export type filters for types referred in `_parent` fields type: - 'null' - string @@ -44226,22 +45812,22 @@ components: search.throttled: description: indicates if the index is search throttled type: string - cat.master:MasterRecord: + cat.master___MasterRecord: type: object properties: id: description: node id type: string host: - description: host name + description: hostname type: string ip: - description: ip address + description: IP address type: string node: description: node name type: string - cat.nodeattrs:NodeAttributesRecord: + cat.nodeattrs___NodeAttributesRecord: type: object properties: node: @@ -44254,7 +45840,7 @@ components: description: The process identifier. type: string host: - description: The host name. + description: The hostname. type: string ip: description: The IP address. @@ -44268,11 +45854,11 @@ components: value: description: The attribute value. type: string - cat.nodes:NodesRecord: + cat.nodes___NodesRecord: type: object properties: id: - $ref: '#/components/schemas/_common:Id' + $ref: '#/components/schemas/_common___Id' pid: description: The process identifier. type: string @@ -44286,7 +45872,7 @@ components: description: The bound HTTP address. type: string version: - $ref: '#/components/schemas/_common:VersionString' + $ref: '#/components/schemas/_common___VersionString' flavor: description: The OpenSearch distribution flavor. type: string @@ -44306,12 +45892,12 @@ components: disk.avail: type: string disk.used_percent: - $ref: '#/components/schemas/_common:PercentageString' + $ref: '#/components/schemas/_common___PercentageString' heap.current: description: The used heap. type: string heap.percent: - $ref: '#/components/schemas/_common:PercentageString' + $ref: '#/components/schemas/_common___PercentageString' heap.max: description: The maximum configured heap. type: string @@ -44319,7 +45905,7 @@ components: description: The used machine memory. type: string ram.percent: - $ref: '#/components/schemas/_common:PercentageString' + $ref: '#/components/schemas/_common___PercentageString' ram.max: description: The total machine memory. type: string @@ -44327,7 +45913,7 @@ components: description: The used file descriptors. type: string file_desc.percent: - $ref: '#/components/schemas/_common:PercentageString' + $ref: '#/components/schemas/_common___PercentageString' file_desc.max: description: The maximum number of file descriptors. type: string @@ -44363,21 +45949,21 @@ components: type: string master: description: |- - Indicates whether the node is the elected master node. - Returned values include `*`(elected master) and `-`(not elected master). + Indicates whether the node is the elected cluster-manager node. + Returned values include `*`(elected cluster manager) and `-`(not elected cluster manager). type: string x-version-deprecated: '2.0' - x-deprecation-message: To promote inclusive language, use 'cluster_manager' instead. + x-deprecation-message: To promote inclusive language, use `cluster_manager` instead. name: - $ref: '#/components/schemas/_common:Name' + $ref: '#/components/schemas/_common___Name' completion.size: description: The size of completion. type: string fielddata.memory_size: - description: The used fielddata cache. + description: The used field data cache. type: string fielddata.evictions: - description: The fielddata evictions. + description: The field data evictions. type: string query_cache.memory_size: description: The used query cache. @@ -44553,7 +46139,7 @@ components: description: The memory used by the version map. type: string segments.fixed_bitset_memory: - description: The memory used by fixed bit sets for nested object field types and export type filters for types referred in _parent fields. + description: The memory used by fixed bit sets for nested object field types and export type filters for types referred in `_parent` fields. type: string suggest.current: description: The number of current suggest operations. @@ -44579,7 +46165,7 @@ components: bulk.avg_size_in_bytes: description: The average size in bytes of shard bulk. type: string - cat.pending_tasks:PendingTasksRecord: + cat.pending_tasks___PendingTasksRecord: type: object properties: insertOrder: @@ -44594,42 +46180,42 @@ components: source: description: The task source. type: string - cat.plugins:PluginsRecord: + cat.plugins___PluginsRecord: type: object properties: id: - $ref: '#/components/schemas/_common:NodeId' + $ref: '#/components/schemas/_common___NodeId' name: - $ref: '#/components/schemas/_common:Name' + $ref: '#/components/schemas/_common___Name' component: description: The component name. type: string version: - $ref: '#/components/schemas/_common:VersionString' + $ref: '#/components/schemas/_common___VersionString' description: description: The plugin details. type: string type: description: The plugin type. type: string - cat.recovery:RecoveryRecord: + cat.recovery___RecoveryRecord: type: object properties: index: - $ref: '#/components/schemas/_common:IndexName' + $ref: '#/components/schemas/_common___IndexName' shard: description: The shard name. type: string start_time: - $ref: '#/components/schemas/_common:DateTime' + $ref: '#/components/schemas/_common___DateTime' start_time_millis: - $ref: '#/components/schemas/_common:StringifiedEpochTimeUnitMillis' + $ref: '#/components/schemas/_common___StringifiedEpochTimeUnitMillis' stop_time: - $ref: '#/components/schemas/_common:DateTime' + $ref: '#/components/schemas/_common___DateTime' stop_time_millis: - $ref: '#/components/schemas/_common:StringifiedEpochTimeUnitMillis' + $ref: '#/components/schemas/_common___StringifiedEpochTimeUnitMillis' time: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' type: description: The recovery type. type: string @@ -44661,7 +46247,7 @@ components: description: The files recovered. type: string files_percent: - $ref: '#/components/schemas/_common:PercentageString' + $ref: '#/components/schemas/_common___PercentageString' files_total: description: The total number of files. type: string @@ -44672,7 +46258,7 @@ components: description: The bytes recovered. type: string bytes_percent: - $ref: '#/components/schemas/_common:PercentageString' + $ref: '#/components/schemas/_common___PercentageString' bytes_total: description: The total number of bytes. type: string @@ -44683,8 +46269,8 @@ components: description: The translog operations recovered. type: string translog_ops_percent: - $ref: '#/components/schemas/_common:PercentageString' - cat.repositories:RepositoriesRecord: + $ref: '#/components/schemas/_common___PercentageString' + cat.repositories___RepositoriesRecord: type: object properties: id: @@ -44693,11 +46279,11 @@ components: type: description: The repository type. type: string - cat.segments:SegmentsRecord: + cat.segments___SegmentsRecord: type: object properties: index: - $ref: '#/components/schemas/_common:IndexName' + $ref: '#/components/schemas/_common___IndexName' shard: description: The shard name. type: string @@ -44708,7 +46294,7 @@ components: description: The IP address of the node where it lives. type: string id: - $ref: '#/components/schemas/_common:NodeId' + $ref: '#/components/schemas/_common___NodeId' segment: description: The segment name, which is derived from the segment generation and used internally to create file names in the directory of the shard. type: string @@ -44731,7 +46317,7 @@ components: Also, OpenSearch creates extra deleted documents to internally track the recent history of operations on a shard. type: string size: - $ref: '#/components/schemas/_common:HumanReadableByteCount' + $ref: '#/components/schemas/_common___HumanReadableByteCount' size.memory: type: string committed: @@ -44746,13 +46332,13 @@ components: If `false`, the segment has most likely been written to disk but needs a refresh to be searchable. type: string version: - $ref: '#/components/schemas/_common:VersionString' + $ref: '#/components/schemas/_common___VersionString' compound: description: |- If `true`, the segment is stored in a compound file. This means Lucene merged all files from the segment in a single file to save file descriptors. type: string - cat.shards:ShardsRecord: + cat.shards___ShardsRecord: type: object properties: index: @@ -44856,12 +46442,12 @@ components: - 'null' - string fielddata.memory_size: - description: The used fielddata cache memory. + description: The used field data cache memory. type: - 'null' - string fielddata.evictions: - description: The fielddata cache evictions. + description: The field data cache evictions. type: - 'null' - string @@ -45191,7 +46777,7 @@ components: type: - 'null' - string - cat.snapshots:SnapshotsRecord: + cat.snapshots___SnapshotsRecord: type: object properties: id: @@ -45211,17 +46797,17 @@ components: `SUCCESS`: The snapshot process completed with a full success. type: string start_epoch: - $ref: '#/components/schemas/_common:StringifiedEpochTimeUnitSeconds' + $ref: '#/components/schemas/_common___StringifiedEpochTimeUnitSeconds' start_time: - $ref: '#/components/schemas/_common:ScheduleTimeOfDay' + $ref: '#/components/schemas/_common___ScheduleTimeOfDay' end_epoch: - $ref: '#/components/schemas/_common:StringifiedEpochTimeUnitSeconds' + $ref: '#/components/schemas/_common___StringifiedEpochTimeUnitSeconds' end_time: - $ref: '#/components/schemas/_common:TimeOfDay' + $ref: '#/components/schemas/_common___TimeOfDay' duration: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' indices: - description: The number of indices in the snapshot. + description: The number of indexes in the snapshot. type: string successful_shards: description: The number of successful shards in the snapshot. @@ -45235,16 +46821,16 @@ components: reason: description: The reason for any snapshot failures. type: string - cat.tasks:TasksRecord: + cat.tasks___TasksRecord: type: object properties: id: - $ref: '#/components/schemas/_common:Id' + $ref: '#/components/schemas/_common___Id' action: description: The task action. type: string task_id: - $ref: '#/components/schemas/_common:Id' + $ref: '#/components/schemas/_common___Id' parent_task_id: description: The parent task identifier. type: string @@ -45264,7 +46850,7 @@ components: description: The running time. type: string node_id: - $ref: '#/components/schemas/_common:NodeId' + $ref: '#/components/schemas/_common___NodeId' ip: description: The IP address for the node. type: string @@ -45275,18 +46861,18 @@ components: description: The node name. type: string version: - $ref: '#/components/schemas/_common:VersionString' + $ref: '#/components/schemas/_common___VersionString' x_opaque_id: description: The X-Opaque-ID header. type: string description: description: The task action description. type: string - cat.templates:TemplatesRecord: + cat.templates___TemplatesRecord: type: object properties: name: - $ref: '#/components/schemas/_common:Name' + $ref: '#/components/schemas/_common___Name' index_patterns: description: The template index patterns. type: string @@ -45296,19 +46882,19 @@ components: version: description: The template version. anyOf: - - $ref: '#/components/schemas/_common:VersionString' + - $ref: '#/components/schemas/_common___VersionString' - type: 'null' composed_of: description: The component templates that comprise the index template. type: string - cat.thread_pool:ThreadPoolRecord: + cat.thread_pool___ThreadPoolRecord: type: object properties: node_name: description: The node name. type: string node_id: - $ref: '#/components/schemas/_common:NodeId' + $ref: '#/components/schemas/_common___NodeId' ephemeral_node_id: description: The ephemeral node identifier. type: string @@ -45316,7 +46902,7 @@ components: description: The process identifier. type: string host: - description: The host name for the current node. + description: The hostname for the current node. type: string ip: description: The IP address for the current node. @@ -45375,65 +46961,65 @@ components: type: - 'null' - string - cluster._common:ComponentTemplate: + cluster._common___ComponentTemplate: type: object properties: name: - $ref: '#/components/schemas/_common:Name' + $ref: '#/components/schemas/_common___Name' component_template: - $ref: '#/components/schemas/cluster._common:ComponentTemplateNode' + $ref: '#/components/schemas/cluster._common___ComponentTemplateNode' required: - component_template - name - cluster._common:ComponentTemplateNode: + cluster._common___ComponentTemplateNode: type: object properties: template: - $ref: '#/components/schemas/cluster._common:ComponentTemplateSummary' + $ref: '#/components/schemas/cluster._common___ComponentTemplateSummary' version: - $ref: '#/components/schemas/_common:VersionNumber' + $ref: '#/components/schemas/_common___VersionNumber' _meta: - $ref: '#/components/schemas/_common:Metadata' + $ref: '#/components/schemas/_common___Metadata' required: - template - cluster._common:ComponentTemplateSummary: + cluster._common___ComponentTemplateSummary: type: object properties: _meta: - $ref: '#/components/schemas/_common:Metadata' + $ref: '#/components/schemas/_common___Metadata' version: - $ref: '#/components/schemas/_common:VersionNumber' + $ref: '#/components/schemas/_common___VersionNumber' settings: type: object additionalProperties: - $ref: '#/components/schemas/indices._common:IndexSettings' + $ref: '#/components/schemas/indices._common___IndexSettings' mappings: - $ref: '#/components/schemas/_common.mapping:TypeMapping' + $ref: '#/components/schemas/_common.mapping___TypeMapping' aliases: type: object additionalProperties: - $ref: '#/components/schemas/indices._common:AliasDefinition' - cluster.allocation_explain:AllocationDecision: + $ref: '#/components/schemas/indices._common___AliasDefinition' + cluster.allocation_explain___AllocationDecision: type: object properties: decider: type: string decision: - $ref: '#/components/schemas/cluster.allocation_explain:AllocationExplainDecision' + $ref: '#/components/schemas/cluster.allocation_explain___AllocationExplainDecision' explanation: type: string required: - decider - decision - explanation - cluster.allocation_explain:AllocationExplainDecision: + cluster.allocation_explain___AllocationExplainDecision: type: string enum: - ALWAYS - 'NO' - THROTTLE - 'YES' - cluster.allocation_explain:AllocationStore: + cluster.allocation_explain___AllocationStore: type: object properties: allocation_id: @@ -45443,7 +47029,7 @@ components: in_sync: type: boolean matching_size_in_bytes: - $ref: '#/components/schemas/_common:ByteCount' + $ref: '#/components/schemas/_common___ByteCount' matching_sync_id: type: boolean store_exception: @@ -45455,19 +47041,19 @@ components: - matching_size_in_bytes - matching_sync_id - store_exception - cluster.allocation_explain:ClusterInfo: + cluster.allocation_explain___ClusterInfo: type: object properties: nodes: type: object additionalProperties: - $ref: '#/components/schemas/cluster.allocation_explain:NodeDiskUsage' + $ref: '#/components/schemas/cluster.allocation_explain___NodeDiskUsage' shard_sizes: type: object additionalProperties: oneOf: - - $ref: '#/components/schemas/_common:ByteCount' - - $ref: '#/components/schemas/_common:HumanReadableByteCount' + - $ref: '#/components/schemas/_common___ByteCount' + - $ref: '#/components/schemas/_common___HumanReadableByteCount' shard_data_set_sizes: type: object additionalProperties: @@ -45479,25 +47065,25 @@ components: reserved_sizes: type: array items: - $ref: '#/components/schemas/cluster.allocation_explain:ReservedSize' + $ref: '#/components/schemas/cluster.allocation_explain___ReservedSize' required: - nodes - reserved_sizes - shard_paths - shard_sizes - cluster.allocation_explain:CurrentNode: + cluster.allocation_explain___CurrentNode: type: object properties: id: - $ref: '#/components/schemas/_common:Id' + $ref: '#/components/schemas/_common___Id' name: - $ref: '#/components/schemas/_common:Name' + $ref: '#/components/schemas/_common___Name' attributes: type: object additionalProperties: type: string transport_address: - $ref: '#/components/schemas/_common:TransportAddress' + $ref: '#/components/schemas/_common___TransportAddress' weight_ranking: type: number required: @@ -45506,7 +47092,7 @@ components: - name - transport_address - weight_ranking - cluster.allocation_explain:Decision: + cluster.allocation_explain___Decision: type: string enum: - allocation_delayed @@ -45517,27 +47103,27 @@ components: - throttled - worse_balance - 'yes' - cluster.allocation_explain:DiskUsage: + cluster.allocation_explain___DiskUsage: type: object properties: path: type: string total: - $ref: '#/components/schemas/_common:HumanReadableByteCount' + $ref: '#/components/schemas/_common___HumanReadableByteCount' total_bytes: - $ref: '#/components/schemas/_common:ByteCount' + $ref: '#/components/schemas/_common___ByteCount' used: - $ref: '#/components/schemas/_common:HumanReadableByteCount' + $ref: '#/components/schemas/_common___HumanReadableByteCount' used_bytes: - $ref: '#/components/schemas/_common:ByteCount' + $ref: '#/components/schemas/_common___ByteCount' free: - $ref: '#/components/schemas/_common:HumanReadableByteCount' + $ref: '#/components/schemas/_common___HumanReadableByteCount' free_bytes: - $ref: '#/components/schemas/_common:ByteCount' + $ref: '#/components/schemas/_common___ByteCount' free_disk_percent: - $ref: '#/components/schemas/_common:PercentageNumber' + $ref: '#/components/schemas/_common___PercentageNumber' used_disk_percent: - $ref: '#/components/schemas/_common:PercentageNumber' + $ref: '#/components/schemas/_common___PercentageNumber' required: - free_bytes - free_disk_percent @@ -45545,27 +47131,27 @@ components: - total_bytes - used_bytes - used_disk_percent - cluster.allocation_explain:NodeAllocationExplanation: + cluster.allocation_explain___NodeAllocationExplanation: type: object properties: deciders: type: array items: - $ref: '#/components/schemas/cluster.allocation_explain:AllocationDecision' + $ref: '#/components/schemas/cluster.allocation_explain___AllocationDecision' node_attributes: type: object additionalProperties: type: string node_decision: - $ref: '#/components/schemas/cluster.allocation_explain:Decision' + $ref: '#/components/schemas/cluster.allocation_explain___Decision' node_id: - $ref: '#/components/schemas/_common:Id' + $ref: '#/components/schemas/_common___Id' node_name: - $ref: '#/components/schemas/_common:Name' + $ref: '#/components/schemas/_common___Name' store: - $ref: '#/components/schemas/cluster.allocation_explain:AllocationStore' + $ref: '#/components/schemas/cluster.allocation_explain___AllocationStore' transport_address: - $ref: '#/components/schemas/_common:TransportAddress' + $ref: '#/components/schemas/_common___TransportAddress' weight_ranking: type: number required: @@ -45575,25 +47161,24 @@ components: - node_id - node_name - transport_address - - weight_ranking - cluster.allocation_explain:NodeDiskUsage: + cluster.allocation_explain___NodeDiskUsage: type: object properties: node_name: - $ref: '#/components/schemas/_common:Name' + $ref: '#/components/schemas/_common___Name' least_available: - $ref: '#/components/schemas/cluster.allocation_explain:DiskUsage' + $ref: '#/components/schemas/cluster.allocation_explain___DiskUsage' most_available: - $ref: '#/components/schemas/cluster.allocation_explain:DiskUsage' + $ref: '#/components/schemas/cluster.allocation_explain___DiskUsage' required: - least_available - most_available - node_name - cluster.allocation_explain:ReservedSize: + cluster.allocation_explain___ReservedSize: type: object properties: node_id: - $ref: '#/components/schemas/_common:Id' + $ref: '#/components/schemas/_common___Id' path: type: string total: @@ -45607,15 +47192,15 @@ components: - path - shards - total - cluster.allocation_explain:UnassignedInformation: + cluster.allocation_explain___UnassignedInformation: type: object properties: at: - $ref: '#/components/schemas/_common:DateTime' + $ref: '#/components/schemas/_common___DateTime' last_allocation_status: type: string reason: - $ref: '#/components/schemas/cluster.allocation_explain:UnassignedInformationReason' + $ref: '#/components/schemas/cluster.allocation_explain___UnassignedInformationReason' details: type: string failed_allocation_attempts: @@ -45627,7 +47212,7 @@ components: required: - at - reason - cluster.allocation_explain:UnassignedInformationReason: + cluster.allocation_explain___UnassignedInformationReason: type: string enum: - ALLOCATION_FAILED @@ -45645,10 +47230,10 @@ components: - REINITIALIZED - REPLICA_ADDED - REROUTE_CANCELLED - cluster.decommission_awareness:DecommissionStatusResponse: + cluster.decommission_awareness___DecommissionStatusResponse: oneOf: - - $ref: '#/components/schemas/cluster.decommission_awareness:ZoneDecommissionStatusResponse' - cluster.decommission_awareness:ZoneDecommissionStatusResponse: + - $ref: '#/components/schemas/cluster.decommission_awareness___ZoneDecommissionStatusResponse' + cluster.decommission_awareness___ZoneDecommissionStatusResponse: type: object additionalProperties: type: string @@ -45658,7 +47243,7 @@ components: - INIT - IN_PROGRESS - SUCCESSFUL - cluster.health:AwarenessAttributeStats: + cluster.health___AwarenessAttributeStats: type: object x-version-added: '2.5' properties: @@ -45674,7 +47259,7 @@ components: type: number weight: type: number - cluster.health:HealthResponseBody: + cluster.health___HealthResponseBody: type: object properties: active_primary_shards: @@ -45684,32 +47269,32 @@ components: description: The total number of active primary and replica shards. type: number active_shards_percent: - $ref: '#/components/schemas/_common:PercentageString' + $ref: '#/components/schemas/_common___PercentageString' active_shards_percent_as_number: - $ref: '#/components/schemas/_common:PercentageNumber' + $ref: '#/components/schemas/_common___PercentageNumber' awareness_attributes: description: Cluster health information for each awareness attribute. type: object x-version-added: '2.5' additionalProperties: - $ref: '#/components/schemas/cluster.health:AwarenessAttributeStats' + $ref: '#/components/schemas/cluster.health___AwarenessAttributeStats' cluster_name: - $ref: '#/components/schemas/_common: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. + description: True if the cluster-manager node has been discovered. type: boolean x-version-deprecated: '2.0' discovered_cluster_manager: - description: True if the cluster manager node has been discovered. + description: True if the cluster-manager node has been discovered. type: boolean x-version-added: '2.0' indices: type: object additionalProperties: - $ref: '#/components/schemas/cluster.health:IndexHealthStats' + $ref: '#/components/schemas/cluster.health___IndexHealthStats' initializing_shards: description: The number of shards that are under initialization. type: number @@ -45729,13 +47314,13 @@ components: description: The number of shards that are under relocation. type: number status: - $ref: '#/components/schemas/_common:HealthStatus' + $ref: '#/components/schemas/_common___HealthStatus' task_max_waiting_in_queue: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' task_max_waiting_in_queue_millis: - $ref: '#/components/schemas/_common:DurationValueUnitMillis' + $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. @@ -45756,7 +47341,7 @@ components: - task_max_waiting_in_queue_millis - timed_out - unassigned_shards - cluster.health:IndexHealthStats: + cluster.health___IndexHealthStats: type: object properties: active_primary_shards: @@ -45774,9 +47359,9 @@ components: shards: type: object additionalProperties: - $ref: '#/components/schemas/cluster.health:ShardHealthStats' + $ref: '#/components/schemas/cluster.health___ShardHealthStats' status: - $ref: '#/components/schemas/_common:HealthStatus' + $ref: '#/components/schemas/_common___HealthStatus' unassigned_shards: type: number required: @@ -45788,14 +47373,14 @@ components: - relocating_shards - status - unassigned_shards - cluster.health:Level: + cluster.health___Level: type: string enum: - awareness_attributes - cluster - indices - shards - cluster.health:ShardHealthStats: + cluster.health___ShardHealthStats: type: object properties: active_shards: @@ -45807,7 +47392,7 @@ components: relocating_shards: type: number status: - $ref: '#/components/schemas/_common:HealthStatus' + $ref: '#/components/schemas/_common___HealthStatus' unassigned_shards: type: number required: @@ -45817,7 +47402,7 @@ components: - relocating_shards - status - unassigned_shards - cluster.pending_tasks:PendingTask: + cluster.pending_tasks___PendingTask: type: object properties: executing: @@ -45835,23 +47420,23 @@ components: description: A general description of the cluster task that may include a reason and origin. type: string time_in_queue: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' time_in_queue_millis: - $ref: '#/components/schemas/_common:DurationValueUnitMillis' + $ref: '#/components/schemas/_common___DurationValueUnitMillis' required: - executing - insert_order - priority - source - time_in_queue_millis - cluster.remote_info:ClusterRemoteInfo: + cluster.remote_info___ClusterRemoteInfo: type: object discriminator: propertyName: mode oneOf: - - $ref: '#/components/schemas/cluster.remote_info:ClusterRemoteSniffInfo' - - $ref: '#/components/schemas/cluster.remote_info:ClusterRemoteProxyInfo' - cluster.remote_info:ClusterRemoteProxyInfo: + - $ref: '#/components/schemas/cluster.remote_info___ClusterRemoteSniffInfo' + - $ref: '#/components/schemas/cluster.remote_info___ClusterRemoteProxyInfo' + cluster.remote_info___ClusterRemoteProxyInfo: type: object properties: mode: @@ -45861,7 +47446,7 @@ components: connected: type: boolean initial_connect_timeout: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' skip_unavailable: type: boolean proxy_address: @@ -45881,7 +47466,7 @@ components: - proxy_address - server_name - skip_unavailable - cluster.remote_info:ClusterRemoteSniffInfo: + cluster.remote_info___ClusterRemoteSniffInfo: type: object properties: mode: @@ -45895,7 +47480,7 @@ components: num_nodes_connected: type: number initial_connect_timeout: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' skip_unavailable: type: boolean seeds: @@ -45910,41 +47495,41 @@ components: - num_nodes_connected - seeds - skip_unavailable - cluster.reroute:Command: + cluster.reroute___Command: type: object properties: cancel: - $ref: '#/components/schemas/cluster.reroute:CommandCancelAction' + $ref: '#/components/schemas/cluster.reroute___CommandCancelAction' move: - $ref: '#/components/schemas/cluster.reroute:CommandMoveAction' + $ref: '#/components/schemas/cluster.reroute___CommandMoveAction' allocate_replica: - $ref: '#/components/schemas/cluster.reroute:CommandAllocateReplicaAction' + $ref: '#/components/schemas/cluster.reroute___CommandAllocateReplicaAction' allocate_stale_primary: - $ref: '#/components/schemas/cluster.reroute:CommandAllocatePrimaryAction' + $ref: '#/components/schemas/cluster.reroute___CommandAllocatePrimaryAction' allocate_empty_primary: - $ref: '#/components/schemas/cluster.reroute:CommandAllocatePrimaryAction' - cluster.reroute:CommandAllocatePrimaryAction: + $ref: '#/components/schemas/cluster.reroute___CommandAllocatePrimaryAction' + cluster.reroute___CommandAllocatePrimaryAction: type: object properties: index: - $ref: '#/components/schemas/_common:IndexName' + $ref: '#/components/schemas/_common___IndexName' shard: type: number node: type: string accept_data_loss: - description: If a node which has a copy of the data rejoins the cluster later on, that data will be deleted. To ensure that these implications are well-understood, this command requires the flag accept_data_loss to be explicitly set to true + description: If a node which has a copy of the data rejoins the cluster later on, that data will be deleted. To ensure that these implications are well-understood, this command requires the flag `accept_data_loss` to be explicitly set to `true`. type: boolean required: - accept_data_loss - index - node - shard - cluster.reroute:CommandAllocateReplicaAction: + cluster.reroute___CommandAllocateReplicaAction: type: object properties: index: - $ref: '#/components/schemas/_common:IndexName' + $ref: '#/components/schemas/_common___IndexName' shard: type: number node: @@ -45953,11 +47538,11 @@ components: - index - node - shard - cluster.reroute:CommandCancelAction: + cluster.reroute___CommandCancelAction: type: object properties: index: - $ref: '#/components/schemas/_common:IndexName' + $ref: '#/components/schemas/_common___IndexName' shard: type: number node: @@ -45968,11 +47553,11 @@ components: - index - node - shard - cluster.reroute:CommandMoveAction: + cluster.reroute___CommandMoveAction: type: object properties: index: - $ref: '#/components/schemas/_common:IndexName' + $ref: '#/components/schemas/_common___IndexName' shard: type: number from_node: @@ -45986,7 +47571,7 @@ components: - index - shard - to_node - cluster.reroute:Metric: + cluster.reroute___Metric: type: string enum: - _all @@ -45998,7 +47583,7 @@ components: - routing_nodes - routing_table - version - cluster.reroute:RerouteDecision: + cluster.reroute___RerouteDecision: type: object properties: decider: @@ -46011,7 +47596,7 @@ components: - decider - decision - explanation - cluster.reroute:RerouteExplanation: + cluster.reroute___RerouteExplanation: type: object properties: command: @@ -46019,34 +47604,34 @@ components: decisions: type: array items: - $ref: '#/components/schemas/cluster.reroute:RerouteDecision' + $ref: '#/components/schemas/cluster.reroute___RerouteDecision' parameters: - $ref: '#/components/schemas/cluster.reroute:RerouteParameters' + $ref: '#/components/schemas/cluster.reroute___RerouteParameters' required: - command - decisions - parameters - cluster.reroute:RerouteParameters: + cluster.reroute___RerouteParameters: type: object properties: allow_primary: type: boolean index: - $ref: '#/components/schemas/_common:IndexName' + $ref: '#/components/schemas/_common___IndexName' node: - $ref: '#/components/schemas/_common:NodeName' + $ref: '#/components/schemas/_common___NodeName' shard: type: number from_node: - $ref: '#/components/schemas/_common:NodeName' + $ref: '#/components/schemas/_common___NodeName' to_node: - $ref: '#/components/schemas/_common:NodeName' + $ref: '#/components/schemas/_common___NodeName' required: - allow_primary - index - node - shard - cluster.state:Metric: + cluster.state___Metric: type: string enum: - _all @@ -46058,49 +47643,49 @@ components: - routing_nodes - routing_table - version - cluster.stats:CharFilterTypes: + cluster.stats___CharFilterTypes: type: object properties: analyzer_types: description: Contains statistics about analyzer types used in selected nodes. type: array items: - $ref: '#/components/schemas/cluster.stats:FieldTypes' + $ref: '#/components/schemas/cluster.stats___FieldTypes' built_in_analyzers: description: Contains statistics about built-in analyzers used in selected nodes. type: array items: - $ref: '#/components/schemas/cluster.stats:FieldTypes' + $ref: '#/components/schemas/cluster.stats___FieldTypes' built_in_char_filters: description: Contains statistics about built-in character filters used in selected nodes. type: array items: - $ref: '#/components/schemas/cluster.stats:FieldTypes' + $ref: '#/components/schemas/cluster.stats___FieldTypes' built_in_filters: description: Contains statistics about built-in token filters used in selected nodes. type: array items: - $ref: '#/components/schemas/cluster.stats:FieldTypes' + $ref: '#/components/schemas/cluster.stats___FieldTypes' built_in_tokenizers: description: Contains statistics about built-in tokenizers used in selected nodes. type: array items: - $ref: '#/components/schemas/cluster.stats:FieldTypes' + $ref: '#/components/schemas/cluster.stats___FieldTypes' char_filter_types: description: Contains statistics about character filter types used in selected nodes. type: array items: - $ref: '#/components/schemas/cluster.stats:FieldTypes' + $ref: '#/components/schemas/cluster.stats___FieldTypes' filter_types: description: Contains statistics about token filter types used in selected nodes. type: array items: - $ref: '#/components/schemas/cluster.stats:FieldTypes' + $ref: '#/components/schemas/cluster.stats___FieldTypes' tokenizer_types: description: Contains statistics about tokenizer types used in selected nodes. type: array items: - $ref: '#/components/schemas/cluster.stats:FieldTypes' + $ref: '#/components/schemas/cluster.stats___FieldTypes' required: - analyzer_types - built_in_analyzers @@ -46110,7 +47695,7 @@ components: - char_filter_types - filter_types - tokenizer_types - cluster.stats:ClusterFileSystem: + cluster.stats___ClusterFileSystem: type: object properties: available: @@ -46118,82 +47703,71 @@ components: Total number of bytes available to JVM in file stores across all selected nodes. Depending on operating system or process-level restrictions, this number may be less than `nodes.fs.free_in_byes`. This is the actual amount of free disk space the selected OpenSearch nodes can use. - $ref: '#/components/schemas/_common:HumanReadableByteCount' + $ref: '#/components/schemas/_common___HumanReadableByteCount' available_in_bytes: description: |- Total number of bytes available to JVM in file stores across all selected nodes. Depending on operating system or process-level restrictions, this number may be less than `nodes.fs.free_in_byes`. This is the actual amount of free disk space the selected OpenSearch nodes can use. - $ref: '#/components/schemas/_common:ByteCount' + $ref: '#/components/schemas/_common___ByteCount' free: description: Total number of unallocated bytes in file stores across all selected nodes. - $ref: '#/components/schemas/_common:HumanReadableByteCount' + $ref: '#/components/schemas/_common___HumanReadableByteCount' free_in_bytes: description: Total number of unallocated bytes in file stores across all selected nodes. - $ref: '#/components/schemas/_common:ByteCount' + $ref: '#/components/schemas/_common___ByteCount' total: description: Total size, of all file stores across all selected nodes. - $ref: '#/components/schemas/_common:HumanReadableByteCount' + $ref: '#/components/schemas/_common___HumanReadableByteCount' total_in_bytes: description: Total size, in bytes, of all file stores across all selected nodes. - $ref: '#/components/schemas/_common:ByteCount' + $ref: '#/components/schemas/_common___ByteCount' cache_reserved: description: Total size, of all cache reserved across all selected nodes. - $ref: '#/components/schemas/_common:HumanReadableByteCount' + $ref: '#/components/schemas/_common___HumanReadableByteCount' x-version-added: '2.7' cache_reserved_in_bytes: description: Total size, in bytes, of all cache reserved across all selected nodes. - $ref: '#/components/schemas/_common:ByteCount' + $ref: '#/components/schemas/_common___ByteCount' x-version-added: '2.7' required: - available_in_bytes - free_in_bytes - total_in_bytes - cluster.stats:ClusterIndices: + cluster.stats___ClusterIndices: type: object properties: analysis: - $ref: '#/components/schemas/cluster.stats:CharFilterTypes' + $ref: '#/components/schemas/cluster.stats___CharFilterTypes' completion: - $ref: '#/components/schemas/_common:CompletionStats' + $ref: '#/components/schemas/_common___CompletionStats' count: - description: Total number of indices with shards assigned to selected nodes. + description: Total number of indexes with shards assigned to selected nodes. type: number docs: - $ref: '#/components/schemas/_common:DocStats' + $ref: '#/components/schemas/_common___DocStats' fielddata: - $ref: '#/components/schemas/_common:FielddataStats' + $ref: '#/components/schemas/_common___FielddataStats' query_cache: - $ref: '#/components/schemas/_common:QueryCacheStats' + $ref: '#/components/schemas/_common___QueryCacheStats' segments: - $ref: '#/components/schemas/_common:SegmentsStats' + $ref: '#/components/schemas/_common___SegmentsStats' shards: - $ref: '#/components/schemas/cluster.stats:ClusterIndicesShards' + $ref: '#/components/schemas/cluster.stats___ClusterIndicesShards' store: - $ref: '#/components/schemas/_common:StoreStats' + $ref: '#/components/schemas/_common___StoreStats' mappings: - $ref: '#/components/schemas/cluster.stats:FieldTypesMappings' + $ref: '#/components/schemas/cluster.stats___FieldTypesMappings' versions: description: Contains statistics about analyzers and analyzer components used in selected nodes. type: array items: - $ref: '#/components/schemas/cluster.stats:IndicesVersions' - required: - - analysis - - completion - - count - - docs - - fielddata - - mappings - - query_cache - - segments - - shards - - store - cluster.stats:ClusterIndicesShards: + $ref: '#/components/schemas/cluster.stats___IndicesVersions' + cluster.stats___ClusterIndicesShards: type: object properties: index: - $ref: '#/components/schemas/cluster.stats:ClusterIndicesShardsIndex' + $ref: '#/components/schemas/cluster.stats___ClusterIndicesShardsIndex' primaries: description: Number of primary shards assigned to selected nodes. type: number @@ -46203,20 +47777,20 @@ components: total: description: Total number of shards assigned to selected nodes. type: number - cluster.stats:ClusterIndicesShardsIndex: + cluster.stats___ClusterIndicesShardsIndex: type: object properties: primaries: - $ref: '#/components/schemas/cluster.stats:ClusterShardMetrics' + $ref: '#/components/schemas/cluster.stats___ClusterShardMetrics' replication: - $ref: '#/components/schemas/cluster.stats:ClusterShardMetrics' + $ref: '#/components/schemas/cluster.stats___ClusterShardMetrics' shards: - $ref: '#/components/schemas/cluster.stats:ClusterShardMetrics' + $ref: '#/components/schemas/cluster.stats___ClusterShardMetrics' required: - primaries - replication - shards - cluster.stats:ClusterIngest: + cluster.stats___ClusterIngest: type: object properties: number_of_pipelines: @@ -46224,19 +47798,19 @@ components: processor_stats: type: object additionalProperties: - $ref: '#/components/schemas/cluster.stats:ClusterProcessor' + $ref: '#/components/schemas/cluster.stats___ClusterProcessor' required: - number_of_pipelines - processor_stats - cluster.stats:ClusterJvm: + cluster.stats___ClusterJvm: type: object properties: max_uptime: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' max_uptime_in_millis: - $ref: '#/components/schemas/_common:DurationValueUnitMillis' + $ref: '#/components/schemas/_common___DurationValueUnitMillis' mem: - $ref: '#/components/schemas/cluster.stats:ClusterJvmMemory' + $ref: '#/components/schemas/cluster.stats___ClusterJvmMemory' threads: description: Number of active threads in use by JVM across all selected nodes. type: number @@ -46244,31 +47818,31 @@ components: description: Contains statistics about the JVM versions used by selected nodes. type: array items: - $ref: '#/components/schemas/cluster.stats:ClusterJvmVersion' + $ref: '#/components/schemas/cluster.stats___ClusterJvmVersion' required: - max_uptime_in_millis - mem - threads - versions - cluster.stats:ClusterJvmMemory: + cluster.stats___ClusterJvmMemory: type: object properties: heap_max: description: Maximum amount of memory available for use by the heap across all selected nodes. - $ref: '#/components/schemas/_common:HumanReadableByteCount' + $ref: '#/components/schemas/_common___HumanReadableByteCount' heap_max_in_bytes: description: Maximum amount of memory, in bytes, available for use by the heap across all selected nodes. - $ref: '#/components/schemas/_common:ByteCount' + $ref: '#/components/schemas/_common___ByteCount' heap_used: description: Memory currently in use by the heap across all selected nodes. - $ref: '#/components/schemas/_common:HumanReadableByteCount' + $ref: '#/components/schemas/_common___HumanReadableByteCount' heap_used_in_bytes: description: Memory, in bytes, currently in use by the heap across all selected nodes. - $ref: '#/components/schemas/_common:ByteCount' + $ref: '#/components/schemas/_common___ByteCount' required: - heap_max_in_bytes - heap_used_in_bytes - cluster.stats:ClusterJvmVersion: + cluster.stats___ClusterJvmVersion: type: object properties: bundled_jdk: @@ -46281,7 +47855,7 @@ components: description: If `true`, a bundled JDK is in use by JVM. type: boolean version: - $ref: '#/components/schemas/_common:VersionString' + $ref: '#/components/schemas/_common___VersionString' vm_name: description: Name of the JVM. type: string @@ -46289,7 +47863,7 @@ components: description: Vendor of the JVM. type: string vm_version: - $ref: '#/components/schemas/_common:VersionString' + $ref: '#/components/schemas/_common___VersionString' required: - bundled_jdk - count @@ -46298,7 +47872,7 @@ components: - vm_name - vm_vendor - vm_version - cluster.stats:ClusterNetworkTypes: + cluster.stats___ClusterNetworkTypes: type: object properties: http_types: @@ -46314,7 +47888,7 @@ components: required: - http_types - transport_types - cluster.stats:ClusterNodeCount: + cluster.stats___ClusterNodeCount: type: object properties: coordinating_only: @@ -46358,60 +47932,48 @@ components: - master - remote_cluster_client - total - cluster.stats:ClusterNodes: + cluster.stats___ClusterNodes: type: object properties: count: - $ref: '#/components/schemas/cluster.stats:ClusterNodeCount' + $ref: '#/components/schemas/cluster.stats___ClusterNodeCount' discovery_types: description: Contains statistics about the discovery types used by selected nodes. type: object additionalProperties: type: number fs: - $ref: '#/components/schemas/cluster.stats:ClusterFileSystem' + $ref: '#/components/schemas/cluster.stats___ClusterFileSystem' indexing_pressure: - $ref: '#/components/schemas/cluster.stats:IndexingPressure' + $ref: '#/components/schemas/cluster.stats___IndexingPressure' ingest: - $ref: '#/components/schemas/cluster.stats:ClusterIngest' + $ref: '#/components/schemas/cluster.stats___ClusterIngest' jvm: - $ref: '#/components/schemas/cluster.stats:ClusterJvm' + $ref: '#/components/schemas/cluster.stats___ClusterJvm' network_types: - $ref: '#/components/schemas/cluster.stats:ClusterNetworkTypes' + $ref: '#/components/schemas/cluster.stats___ClusterNetworkTypes' os: - $ref: '#/components/schemas/cluster.stats:ClusterOperatingSystem' + $ref: '#/components/schemas/cluster.stats___ClusterOperatingSystem' packaging_types: description: Contains statistics about OpenSearch distributions installed on selected nodes. type: array items: - $ref: '#/components/schemas/cluster.stats:NodePackagingType' + $ref: '#/components/schemas/cluster.stats___NodePackagingType' plugins: description: |- Contains statistics about installed plugins and modules by selected nodes. If no plugins or modules are installed, this array is empty. type: array items: - $ref: '#/components/schemas/_common:PluginStats' + $ref: '#/components/schemas/_common___PluginStats' process: - $ref: '#/components/schemas/cluster.stats:ClusterProcess' + $ref: '#/components/schemas/cluster.stats___ClusterProcess' versions: description: Array of OpenSearch versions used on selected nodes. type: array items: - $ref: '#/components/schemas/_common:VersionString' - required: - - count - - discovery_types - - fs - - ingest - - jvm - - network_types - - os - - packaging_types - - plugins - - process - - versions - cluster.stats:ClusterOperatingSystem: + $ref: '#/components/schemas/_common___VersionString' + cluster.stats___ClusterOperatingSystem: type: object properties: allocated_processors: @@ -46424,29 +47986,29 @@ components: description: Contains statistics about processor architectures (for example, x86_64 or aarch64) used by selected nodes. type: array items: - $ref: '#/components/schemas/cluster.stats:ClusterOperatingSystemArchitecture' + $ref: '#/components/schemas/cluster.stats___ClusterOperatingSystemArchitecture' available_processors: description: Number of processors available to JVM across all selected nodes. type: number mem: - $ref: '#/components/schemas/cluster.stats:OperatingSystemMemoryInfo' + $ref: '#/components/schemas/cluster.stats___OperatingSystemMemoryInfo' names: description: Contains statistics about operating systems used by selected nodes. type: array items: - $ref: '#/components/schemas/cluster.stats:ClusterOperatingSystemName' + $ref: '#/components/schemas/cluster.stats___ClusterOperatingSystemName' pretty_names: description: Contains statistics about operating systems used by selected nodes. type: array items: - $ref: '#/components/schemas/cluster.stats:ClusterOperatingSystemPrettyName' + $ref: '#/components/schemas/cluster.stats___ClusterOperatingSystemPrettyName' required: - allocated_processors - available_processors - mem - names - pretty_names - cluster.stats:ClusterOperatingSystemArchitecture: + cluster.stats___ClusterOperatingSystemArchitecture: type: object properties: arch: @@ -46458,49 +48020,49 @@ components: required: - arch - count - cluster.stats:ClusterOperatingSystemName: + cluster.stats___ClusterOperatingSystemName: type: object properties: count: description: Number of selected nodes using the operating system. type: number name: - $ref: '#/components/schemas/_common:Name' + $ref: '#/components/schemas/_common___Name' required: - count - name - cluster.stats:ClusterOperatingSystemPrettyName: + cluster.stats___ClusterOperatingSystemPrettyName: type: object properties: count: description: Number of selected nodes using the operating system. type: number pretty_name: - $ref: '#/components/schemas/_common:Name' + $ref: '#/components/schemas/_common___Name' required: - count - pretty_name - cluster.stats:ClusterProcess: + cluster.stats___ClusterProcess: type: object properties: cpu: - $ref: '#/components/schemas/cluster.stats:ClusterProcessCpu' + $ref: '#/components/schemas/cluster.stats___ClusterProcessCpu' open_file_descriptors: - $ref: '#/components/schemas/cluster.stats:ClusterProcessOpenFileDescriptors' + $ref: '#/components/schemas/cluster.stats___ClusterProcessOpenFileDescriptors' required: - cpu - open_file_descriptors - cluster.stats:ClusterProcessCpu: + cluster.stats___ClusterProcessCpu: type: object properties: percent: description: |- Percentage of CPU used across all selected nodes. Returns `-1` if not supported. - $ref: '#/components/schemas/_common:PercentageNumber' + $ref: '#/components/schemas/_common___PercentageNumber' required: - percent - cluster.stats:ClusterProcessOpenFileDescriptors: + cluster.stats___ClusterProcessOpenFileDescriptors: type: object properties: avg: @@ -46522,7 +48084,7 @@ components: - avg - max - min - cluster.stats:ClusterProcessor: + cluster.stats___ClusterProcessor: type: object properties: count: @@ -46532,15 +48094,15 @@ components: failed: type: number time: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' time_in_millis: - $ref: '#/components/schemas/_common:DurationValueUnitMillis' + $ref: '#/components/schemas/_common___DurationValueUnitMillis' required: - count - current - failed - time_in_millis - cluster.stats:ClusterShardMetrics: + cluster.stats___ClusterShardMetrics: type: object properties: avg: @@ -46556,25 +48118,25 @@ components: - avg - max - min - cluster.stats:FieldTypes: + cluster.stats___FieldTypes: type: object properties: name: - $ref: '#/components/schemas/_common:Name' + $ref: '#/components/schemas/_common___Name' count: description: The number of occurrences of the field type in selected nodes. type: number index_count: - description: The number of indices containing the field type in selected nodes. + description: The number of indexes containing the field type in selected nodes. type: number indexed_vector_count: - description: For dense_vector field types, number of indexed vector types in selected nodes. + description: For `dense_vector` field types, number of indexed vector types in selected nodes. type: number indexed_vector_dim_max: - description: For dense_vector field types, the maximum dimension of all indexed vector types in selected nodes. + description: For `dense_vector` field types, the maximum dimension of all indexed vector types in selected nodes. type: number indexed_vector_dim_min: - description: For dense_vector field types, the minimum dimension of all indexed vector types in selected nodes. + description: For `dense_vector` field types, the minimum dimension of all indexed vector types in selected nodes. type: number script_count: description: The number of fields that declare a script. @@ -46583,69 +48145,64 @@ components: - count - index_count - name - cluster.stats:FieldTypesMappings: + cluster.stats___FieldTypesMappings: type: object properties: field_types: description: Contains statistics about field data types used in selected nodes. type: array items: - $ref: '#/components/schemas/cluster.stats:FieldTypes' - runtime_field_types: - description: Contains statistics about runtime field data types used in selected nodes. - type: array - items: - $ref: '#/components/schemas/cluster.stats:RuntimeFieldTypes' + $ref: '#/components/schemas/cluster.stats___FieldTypes' total_field_count: - description: Total number of fields in all non-system indices. + description: Total number of fields in all non-system indexes. type: number total_deduplicated_field_count: - description: Total number of fields in all non-system indices, accounting for mapping deduplication. + description: Total number of fields in all non-system indexes, accounting for mapping deduplication. type: number total_deduplicated_mapping_size: - $ref: '#/components/schemas/_common:HumanReadableByteCount' + $ref: '#/components/schemas/_common___HumanReadableByteCount' total_deduplicated_mapping_size_in_bytes: description: Total size of all mappings, in bytes, after deduplication and compression. - $ref: '#/components/schemas/_common:ByteCount' + $ref: '#/components/schemas/_common___ByteCount' required: - field_types - cluster.stats:IndexingPressure: + cluster.stats___IndexingPressure: type: object properties: memory: - $ref: '#/components/schemas/cluster.stats:IndexingPressureMemory' + $ref: '#/components/schemas/cluster.stats___IndexingPressureMemory' required: - memory - cluster.stats:IndexingPressureMemory: + cluster.stats___IndexingPressureMemory: type: object properties: current: - $ref: '#/components/schemas/cluster.stats:IndexingPressureMemorySummary' + $ref: '#/components/schemas/cluster.stats___IndexingPressureMemorySummary' limit_in_bytes: - $ref: '#/components/schemas/_common:ByteCount' + $ref: '#/components/schemas/_common___ByteCount' total: - $ref: '#/components/schemas/cluster.stats:IndexingPressureMemorySummary' + $ref: '#/components/schemas/cluster.stats___IndexingPressureMemorySummary' required: - current - limit_in_bytes - total - cluster.stats:IndexingPressureMemorySummary: + cluster.stats___IndexingPressureMemorySummary: type: object properties: all_in_bytes: - $ref: '#/components/schemas/_common:ByteCount' + $ref: '#/components/schemas/_common___ByteCount' combined_coordinating_and_primary_in_bytes: - $ref: '#/components/schemas/_common:ByteCount' + $ref: '#/components/schemas/_common___ByteCount' coordinating_in_bytes: - $ref: '#/components/schemas/_common:ByteCount' + $ref: '#/components/schemas/_common___ByteCount' coordinating_rejections: type: number primary_in_bytes: - $ref: '#/components/schemas/_common:ByteCount' + $ref: '#/components/schemas/_common___ByteCount' primary_rejections: type: number replica_in_bytes: - $ref: '#/components/schemas/_common:ByteCount' + $ref: '#/components/schemas/_common___ByteCount' replica_rejections: type: number required: @@ -46654,7 +48211,20 @@ components: - coordinating_in_bytes - primary_in_bytes - replica_in_bytes - cluster.stats:IndicesVersions: + cluster.stats___IndexMetric: + type: string + enum: + - _all + - analysis + - completion + - docs + - fielddata + - mappings + - query_cache + - segments + - shards + - store + cluster.stats___IndicesVersions: type: object properties: index_count: @@ -46662,15 +48232,29 @@ components: primary_shard_count: type: number total_primary_bytes: - $ref: '#/components/schemas/_common:ByteCount' + $ref: '#/components/schemas/_common___ByteCount' version: - $ref: '#/components/schemas/_common:VersionString' + $ref: '#/components/schemas/_common___VersionString' required: - index_count - primary_shard_count - total_primary_bytes - version - cluster.stats:NodePackagingType: + cluster.stats___Metric: + type: string + enum: + - _all + - discovery_type + - fs + - indices + - ingest + - jvm + - network_types + - os + - packaging_types + - plugins + - process + cluster.stats___NodePackagingType: type: object properties: count: @@ -46685,148 +48269,85 @@ components: required: - count - type - cluster.stats:OperatingSystemMemoryInfo: + cluster.stats___OperatingSystemMemoryInfo: type: object properties: adjusted_total_in_bytes: description: Total amount, in bytes, of memory across all selected nodes, but using the value specified using the `es.total_memory_bytes` system property instead of measured total memory for those nodes where that system property was set. - $ref: '#/components/schemas/_common:ByteCount' + $ref: '#/components/schemas/_common___ByteCount' free: description: Amount, in bytes, of free physical memory across all selected nodes. - $ref: '#/components/schemas/_common:HumanReadableByteCount' + $ref: '#/components/schemas/_common___HumanReadableByteCount' free_in_bytes: description: Amount, in bytes, of free physical memory across all selected nodes. - $ref: '#/components/schemas/_common:ByteCount' + $ref: '#/components/schemas/_common___ByteCount' free_percent: description: Percentage of free physical memory across all selected nodes. - $ref: '#/components/schemas/_common:PercentageNumber' + $ref: '#/components/schemas/_common___PercentageNumber' total: description: Total amount of physical memory across all selected nodes. - $ref: '#/components/schemas/_common:HumanReadableByteCount' + $ref: '#/components/schemas/_common___HumanReadableByteCount' total_in_bytes: description: Total amount, in bytes, of physical memory across all selected nodes. - $ref: '#/components/schemas/_common:ByteCount' + $ref: '#/components/schemas/_common___ByteCount' used: description: Amount of physical memory in use across all selected nodes. - $ref: '#/components/schemas/_common:HumanReadableByteCount' + $ref: '#/components/schemas/_common___HumanReadableByteCount' used_in_bytes: description: Amount, in bytes, of physical memory in use across all selected nodes. - $ref: '#/components/schemas/_common:ByteCount' + $ref: '#/components/schemas/_common___ByteCount' used_percent: description: Percentage of physical memory in use across all selected nodes. - $ref: '#/components/schemas/_common:PercentageNumber' + $ref: '#/components/schemas/_common___PercentageNumber' required: - free_in_bytes - free_percent - total_in_bytes - used_in_bytes - used_percent - cluster.stats:RuntimeFieldTypes: - type: object - properties: - chars_max: - description: Maximum number of characters for a single runtime field script. - type: number - chars_total: - description: Total number of characters for the scripts that define the current runtime field data type. - type: number - count: - description: Number of runtime fields mapped to the field data type in selected nodes. - type: number - doc_max: - description: Maximum number of accesses to doc_values for a single runtime field script - type: number - doc_total: - description: Total number of accesses to doc_values for the scripts that define the current runtime field data type. - type: number - index_count: - description: Number of indices containing a mapping of the runtime field data type in selected nodes. - type: number - lang: - description: Script languages used for the runtime fields scripts. - type: array - items: - type: string - lines_max: - description: Maximum number of lines for a single runtime field script. - type: number - lines_total: - description: Total number of lines for the scripts that define the current runtime field data type. - type: number - name: - $ref: '#/components/schemas/_common:Name' - scriptless_count: - description: Number of runtime fields that don't declare a script. - type: number - shadowed_count: - description: Number of runtime fields that shadow an indexed field. - type: number - source_max: - description: Maximum number of accesses to _source for a single runtime field script. - type: number - source_total: - description: Total number of accesses to _source for the scripts that define the current runtime field data type. - type: number - required: - - chars_max - - chars_total - - count - - doc_max - - doc_total - - index_count - - lang - - lines_max - - lines_total - - name - - scriptless_count - - shadowed_count - - source_max - - source_total - cluster.stats:StatsResponseBase: + cluster.stats___StatsResponseBase: allOf: - - $ref: '#/components/schemas/nodes._common:NodesResponseBase' + - $ref: '#/components/schemas/nodes._common___NodesResponseBase' - type: object properties: cluster_name: - $ref: '#/components/schemas/_common:Name' + $ref: '#/components/schemas/_common___Name' cluster_uuid: - $ref: '#/components/schemas/_common:Uuid' + $ref: '#/components/schemas/_common___Uuid' indices: - $ref: '#/components/schemas/cluster.stats:ClusterIndices' + $ref: '#/components/schemas/cluster.stats___ClusterIndices' nodes: - $ref: '#/components/schemas/cluster.stats:ClusterNodes' + $ref: '#/components/schemas/cluster.stats___ClusterNodes' status: - $ref: '#/components/schemas/_common:HealthStatus' + $ref: '#/components/schemas/_common___HealthStatus' timestamp: description: Unix timestamp, in milliseconds, for the last time the cluster statistics were refreshed. type: number required: - cluster_name - cluster_uuid - - indices - - nodes - status - timestamp - cluster.weighted_routing:Weights: + cluster.weighted_routing___Weights: allOf: - - $ref: '#/components/schemas/cluster.weighted_routing:WeightsBase' + - $ref: '#/components/schemas/cluster.weighted_routing___WeightsBase' - type: object properties: weights: type: object - cluster.weighted_routing:WeightsBase: + cluster.weighted_routing___WeightsBase: type: object properties: _version: - $ref: '#/components/schemas/_common:VersionNumber' - cluster.weighted_routing:WeightsResponse: + $ref: '#/components/schemas/_common___VersionNumber' + cluster.weighted_routing___WeightsResponse: allOf: - - $ref: '#/components/schemas/cluster.weighted_routing:Weights' + - $ref: '#/components/schemas/cluster.weighted_routing___Weights' - type: object properties: discovered_cluster_manager: type: boolean - dangling_indices.list_dangling_indices:DanglingIndex: + dangling_indices.list_dangling_indices___DanglingIndex: type: object properties: index_name: @@ -46834,24 +48355,24 @@ components: index_uuid: type: string creation_date: - $ref: '#/components/schemas/_common:DateTime' + $ref: '#/components/schemas/_common___DateTime' creation_date_millis: - $ref: '#/components/schemas/_common:EpochTimeUnitMillis' + $ref: '#/components/schemas/_common___EpochTimeUnitMillis' node_ids: - $ref: '#/components/schemas/_common:Ids' + $ref: '#/components/schemas/_common___Ids' required: - creation_date_millis - index_name - index_uuid - node_ids - flow_framework.common:All: + flow_framework.common___All: description: The all parameter specifies whether the response should return all fields. type: boolean default: false - flow_framework.common:AllowDelete: + flow_framework.common___AllowDelete: description: Required when deleting resources involves a high potential for data loss. type: string - flow_framework.common:FlowFrameworkCreate: + flow_framework.common___FlowFrameworkCreate: type: object properties: name: @@ -46864,13 +48385,13 @@ components: type: string description: A use case, which can be used with the Search Workflow API to find related workflows. version: - $ref: '#/components/schemas/flow_framework.common:version' + $ref: '#/components/schemas/flow_framework.common___version' workflows: type: object - description: A map of workflows. Presently, only the provision key is supported. The value for the workflow key is a key-value map that includes fields for user_params and lists of nodes and edges. + description: A map of workflows. Presently, only the provision key is supported. The value for the workflow key is a key-value map that includes fields for `user_params` and lists of nodes and edges. required: - name - flow_framework.common:FlowFrameworkDeleteResponse: + flow_framework.common___FlowFrameworkDeleteResponse: type: object properties: _index: @@ -46889,18 +48410,20 @@ components: - deleted - not_found _shards: - $ref: '#/components/schemas/flow_framework.common:shards' + $ref: '#/components/schemas/flow_framework.common___shards' _seq_no: type: integer description: The sequence number assigned to the document after the deletion. _primary_term: type: integer description: The primary term assigned to the document after the deletion. - flow_framework.common:FlowFrameworkGetResponse: + flow_framework.common___FlowFrameworkGetResponse: type: object properties: name: type: string + version: + $ref: '#/components/schemas/flow_framework.common___version' description: type: string use_case: @@ -46908,12 +48431,14 @@ components: workflows: type: object user: - $ref: '#/components/schemas/flow_framework.common:user' + $ref: '#/components/schemas/flow_framework.common___user' created_time: type: integer last_updated_time: type: integer - flow_framework.common:FlowFrameworkUpdate: + last_provisioned_time: + type: number + flow_framework.common___FlowFrameworkUpdate: type: object properties: name: @@ -46928,22 +48453,24 @@ components: workflows: type: object version: - $ref: '#/components/schemas/flow_framework.common:version' + $ref: '#/components/schemas/flow_framework.common___version' minProperties: 1 - flow_framework.common:hits: + flow_framework.common___hits: type: object properties: total: - $ref: '#/components/schemas/flow_framework.common:total' + $ref: '#/components/schemas/flow_framework.common___total' max_score: - type: number - format: float - description: The maximum score of the search hits. + oneOf: + - type: 'null' + - type: number + format: float + description: The maximum score of the search hits. hits: type: array items: - $ref: '#/components/schemas/flow_framework.common:itemsObject' - flow_framework.common:itemsObject: + $ref: '#/components/schemas/flow_framework.common___itemsObject' + flow_framework.common___itemsObject: type: object properties: _index: @@ -46966,12 +48493,12 @@ components: format: float description: The score of the search hit. _source: - $ref: '#/components/schemas/flow_framework.common:FlowFrameworkGetResponse' - flow_framework.common:Provision: + $ref: '#/components/schemas/flow_framework.common___FlowFrameworkGetResponse' + flow_framework.common___Provision: description: Provision the workflow as part of the request. type: boolean default: false - flow_framework.common:query: + flow_framework.common___query: type: object description: The search query to match workflows. Use `match_all` to retrieve all workflows, or `match` to search by specific fields like `use_case`. properties: @@ -46979,10 +48506,10 @@ components: type: object match_all: type: object - flow_framework.common:Reprovision: + flow_framework.common___Reprovision: type: boolean default: false - flow_framework.common:SearchStateResponse: + flow_framework.common___SearchStateResponse: type: object properties: workflow_id: @@ -46992,13 +48519,13 @@ components: state: type: string user: - $ref: '#/components/schemas/flow_framework.common:user' - flow_framework.common:SearchWorkflowRequest: + $ref: '#/components/schemas/flow_framework.common___user' + flow_framework.common___SearchWorkflowRequest: type: object properties: query: - $ref: '#/components/schemas/flow_framework.common:query' - flow_framework.common:shards: + $ref: '#/components/schemas/flow_framework.common___query' + flow_framework.common___shards: type: object properties: total: @@ -47010,20 +48537,25 @@ components: failed: type: integer description: The number of shards where the deletion failed. - flow_framework.common:StateHits: + skipped: + type: integer + description: The number of shards where the deletion was skipped. + flow_framework.common___StateHits: type: object properties: total: - $ref: '#/components/schemas/flow_framework.common:total' + $ref: '#/components/schemas/flow_framework.common___total' max_score: - type: number - format: float - description: The maximum score of the search hits. + oneOf: + - type: 'null' + - type: number + format: float + description: The maximum score of the search hits. hits: type: array items: - $ref: '#/components/schemas/flow_framework.common:StateItems' - flow_framework.common:StateItems: + $ref: '#/components/schemas/flow_framework.common___StateItems' + flow_framework.common___StateItems: type: object properties: _index: @@ -47046,8 +48578,8 @@ components: format: float description: The score of the search hit. _source: - $ref: '#/components/schemas/flow_framework.common:SearchStateResponse' - flow_framework.common:total: + $ref: '#/components/schemas/flow_framework.common___SearchStateResponse' + flow_framework.common___total: type: object properties: value: @@ -47056,13 +48588,13 @@ components: relation: type: string description: The relation of the total hits. - flow_framework.common:UpdateFields: + flow_framework.common___UpdateFields: description: Update only the fields included in the request body. type: boolean default: false - flow_framework.common:UseCase: + flow_framework.common___UseCase: type: string - flow_framework.common:user: + flow_framework.common___user: type: object properties: name: @@ -47082,16 +48614,16 @@ components: user_requested_tenant: type: string nullable: true - flow_framework.common:UserProvidedSubstitutionExpressions: + flow_framework.common___UserProvidedSubstitutionExpressions: type: object additionalProperties: type: string description: The value for the user-provided key. Keys represent substitution expressions. - flow_framework.common:Validation: + flow_framework.common___Validation: description: Validate the workflow. Valid values are all (validate the template) and none (do not validate the template). Default is all. type: string default: all - flow_framework.common:version: + flow_framework.common___version: type: object description: A key-value map with two fields, template, which identifies the template version, and compatibility, which identifies a list of minimum required OpenSearch versions. properties: @@ -47103,9 +48635,15 @@ components: items: type: string description: A list of minimum required OpenSearch versions. - flow_framework.common:WorkflowID: + flow_framework.common___WorkflowID: type: string - flow_framework.common:WorkflowSearchResponse: + flow_framework.common___WorkflowIDResponse: + type: object + properties: + workflow_id: + type: string + description: The ID of the workflow + flow_framework.common___WorkflowSearchResponse: type: object properties: took: @@ -47115,10 +48653,10 @@ components: type: boolean description: Indicates if the request timed out. _shards: - $ref: '#/components/schemas/flow_framework.common:shards' + $ref: '#/components/schemas/flow_framework.common___shards' hits: - $ref: '#/components/schemas/flow_framework.common:hits' - flow_framework.common:WorkflowSearchStateResponse: + $ref: '#/components/schemas/flow_framework.common___hits' + flow_framework.common___WorkflowSearchStateResponse: type: object properties: took: @@ -47128,10 +48666,10 @@ components: type: boolean description: Indicates if the request timed out. _shards: - $ref: '#/components/schemas/flow_framework.common:shards' + $ref: '#/components/schemas/flow_framework.common___shards' hits: - $ref: '#/components/schemas/flow_framework.common:StateHits' - flow_framework.common:WorkFlowStatusDefaultResponse: + $ref: '#/components/schemas/flow_framework.common___StateHits' + flow_framework.common___WorkFlowStatusDefaultResponse: type: object properties: workflow_id: @@ -47149,7 +48687,7 @@ components: items: type: string description: A list of resources created by the workflow - flow_framework.common:WorkFlowStatusFullResponse: + flow_framework.common___WorkFlowStatusFullResponse: type: object properties: workflow_id: @@ -47185,13 +48723,13 @@ components: format: date-time description: The end time of the provisioning process user: - $ref: '#/components/schemas/flow_framework.common:user' + $ref: '#/components/schemas/flow_framework.common___user' user_outputs: type: array items: type: string description: Outputs generated by the user - flow_framework.common:WorkflowStep: + flow_framework.common___WorkflowStep: type: object properties: inputs: @@ -47209,48 +48747,47 @@ components: items: type: string description: The list of plugins required for the workflow step - flow_framework.common:WorkflowStepName: + timeout: + $ref: '#/components/schemas/_common___Duration' + flow_framework.common___WorkflowStepName: type: string - flow_framework.errors:BadRequestError: + flow_framework.common___WorkflowSteps: + type: object + additionalProperties: + $ref: '#/components/schemas/flow_framework.common___WorkflowStep' + flow_framework.errors___BadRequestError: type: object properties: error: type: string description: Error message when the request body or parameters are invalid. - example: Invalid request body or query parameters. status: type: integer description: HTTP status code for the error. - example: 400 - flow_framework.errors:ConflictError: - content: - application/json: - type: object - properties: - error: - type: string - example: You cannot use both the 'provision_workflow' and 'update_workflow_fields' parameters in the same request. - status: - type: integer - flow_framework.errors:DeprovisioningError: + flow_framework.errors___ConflictError: + type: object + properties: + error: + type: string + status: + type: integer + flow_framework.errors___DeprovisioningError: type: object properties: error: type: string description: Describes the deprovisioning error and identifies resources that were not deprovisioned - example: Failed to deprovision some resources [connector_id Lw7PX4wBfVtHp98y06wV]. required: - error - flow_framework.errors:DeprovisioningForbiddenError: + flow_framework.errors___DeprovisioningForbiddenError: type: object properties: error: type: string - description: Describes the resources that require the allow_delete parameter for deprovisioning - example: These resources require the allow_delete parameter to deprovision [index_name my-index]. + description: Describes the resources that require the `allow_delete` parameter for deprovisioning required: - error - flow_framework.errors:DuplicateKeyError: + flow_framework.errors___DuplicateKeyError: type: object properties: error: @@ -47259,28 +48796,21 @@ components: status: type: integer description: HTTP status code for the error. - example: 400 - flow_framework.errors:FlowFrameworkAPIDisabledError: - content: - application/json: - type: object - properties: - error: - type: string - example: This API is disabled. To enable it, set [flow_framework.enabled] to true. - status: - type: integer - flow_framework.errors:InvalidParameterError: - content: - application/json: - type: object - properties: - error: - type: string - example: Only the parameters [param1, param2] are permitted unless the provision parameter is set to true. - status: - type: integer - flow_framework.errors:InvalidRequestBodyFieldError: + flow_framework.errors___FlowFrameworkAPIDisabledError: + type: object + properties: + error: + type: string + status: + type: integer + flow_framework.errors___InvalidParameterError: + type: object + properties: + error: + type: string + status: + type: integer + flow_framework.errors___InvalidRequestBodyFieldError: type: object properties: error: @@ -47289,46 +48819,34 @@ components: status: type: integer description: HTTP status code for the error. - flow_framework.errors:InvalidTemplateVersionError: - content: - application/json: - type: object - properties: - error: - type: string - description: Error message when the template version is invalid or missing. - example: Unable to parse field [version] in a version object. - flow_framework.errors:MaxWorkflowsLimitError: - content: - application/json: - type: object - properties: - error: - type: string - example: Maximum workflows limit reached 50 - code: - type: integer - flow_framework.errors:MissingParameterError: - content: - application/json: - type: object - properties: - error: - type: string - example: You cannot use the 'reprovision_workflow' parameter to create a new template. - status: - type: integer - flow_framework.errors:ParameterConflictError: - content: - application/json: - type: object - properties: - error: - type: string - example: You cannot use the 'reprovision_workflow' and 'use_case' parameters in the same request. - status: - type: integer - flow_framework.errors:RequestBodyParsingFailedError: + flow_framework.errors___InvalidTemplateVersionError: + type: object + properties: + error: + type: string + description: Error message when the template version is invalid or missing. + flow_framework.errors___MaxWorkflowsLimitError: + type: object + properties: + error: + type: string + code: + type: integer + flow_framework.errors___MissingParameterError: + type: object + properties: + error: + type: string + status: + type: integer + flow_framework.errors___ParameterConflictError: + type: object + properties: + error: + type: string + status: + type: integer + flow_framework.errors___RequestBodyParsingFailedError: type: object properties: error: @@ -47337,8 +48855,7 @@ components: status: type: integer description: HTTP status code for the error. - example: 400 - flow_framework.errors:RequestTimeoutError: + flow_framework.errors___RequestTimeoutError: type: object properties: error: @@ -47347,95 +48864,76 @@ components: status: type: integer description: HTTP status code for the error. - example: 408 - flow_framework.errors:TemplateNameRequiredError: + flow_framework.errors___TemplateNameRequiredError: type: object properties: error: type: string description: Error message when the template name is missing. - flow_framework.errors:TemplateNotFoundError: - content: - application/json: - type: object - properties: - error: - type: string - example: Failed to retrieve template (12345) from global context. - code: - type: integer - flow_framework.errors:UnsupportedFieldUpdateError: - content: - application/json: - type: object - properties: - error: - type: string - description: Error message when trying to update an unsupported field in a template. - example: You can not update the field [fieldName] without updating the whole template. - flow_framework.errors:WorkFlowIdNullError: - content: - application/json: - type: object - properties: - error: - type: string - example: Workflow ID can not be null - status: - type: integer - flow_framework.errors:WorkflowParsingError: - content: - application/json: - type: object - properties: - error: - type: string - description: Error message when workflow parsing fails. - example: Unable to parse field [workflow] in a template object. - flow_framework.errors:WorkflowSaveError: - content: - application/json: - type: object - properties: - error: - type: string - example: Failed to save workflow state - status: - type: integer - flow_framework.errors:WorkflowStepsRetrieveError: - content: - application/json: - type: object - properties: - error: - type: string - example: Failed to retrieve workflow step json. - code: - type: integer - indices._common:Alias: + flow_framework.errors___TemplateNotFoundError: + type: object + properties: + error: + type: string + code: + type: integer + flow_framework.errors___UnsupportedFieldUpdateError: + type: object + properties: + error: + type: string + description: Error message when trying to update an unsupported field in a template. + flow_framework.errors___WorkFlowIdNullError: + type: object + properties: + error: + type: string + status: + type: integer + flow_framework.errors___WorkflowParsingError: + type: object + properties: + error: + type: string + description: Error message when workflow parsing fails. + flow_framework.errors___WorkflowSaveError: + type: object + properties: + error: + type: string + status: + type: integer + flow_framework.errors___WorkflowStepsRetrieveError: + type: object + properties: + error: + type: string + code: + type: integer + indices._common___Alias: type: object properties: filter: - $ref: '#/components/schemas/_common.query_dsl:QueryContainer' + $ref: '#/components/schemas/_common.query_dsl___QueryContainer' index_routing: - $ref: '#/components/schemas/_common:Routing' + $ref: '#/components/schemas/_common___Routing' is_hidden: description: |- If `true`, the alias is hidden. - All indices for the alias must have the same `is_hidden` value. + All indexes for the alias must have the same `is_hidden` value. type: boolean is_write_index: description: If `true`, the index is the write index for the alias. type: boolean routing: - $ref: '#/components/schemas/_common:Routing' + $ref: '#/components/schemas/_common___Routing' search_routing: - $ref: '#/components/schemas/_common:Routing' - indices._common:AliasDefinition: + $ref: '#/components/schemas/_common___Routing' + indices._common___AliasDefinition: type: object properties: filter: - $ref: '#/components/schemas/_common.query_dsl:QueryContainer' + $ref: '#/components/schemas/_common.query_dsl___QueryContainer' index_routing: description: |- Value used to route indexing operations to a specific shard. @@ -47455,13 +48953,13 @@ components: is_hidden: description: |- If `true`, the alias is hidden. - All indices for the alias must have the same `is_hidden` value. + All indexes for the alias must have the same `is_hidden` value. type: boolean - indices._common:DataStream: + indices._common___DataStream: type: object properties: _meta: - $ref: '#/components/schemas/_common:Metadata' + $ref: '#/components/schemas/_common___Metadata' allow_custom_routing: description: If `true`, the data stream allows custom routing on write request. type: boolean @@ -47472,33 +48970,33 @@ components: description: If `true`, the data stream is hidden. type: boolean ilm_policy: - $ref: '#/components/schemas/_common:Name' + $ref: '#/components/schemas/_common___Name' next_generation_managed_by: - $ref: '#/components/schemas/indices._common:ManagedBy' + $ref: '#/components/schemas/indices._common___ManagedBy' prefer_ilm: description: Indicates if ILM should take precedence over DSL in case both are configured to managed this data stream. type: boolean indices: description: |- - Array of objects containing information about the data stream's backing indices. + Array of objects containing information about the data stream's backing indexes. The last item in this array contains information about the stream's current write index. type: array items: - $ref: '#/components/schemas/indices._common:DataStreamIndex' + $ref: '#/components/schemas/indices._common___DataStreamIndex' name: - $ref: '#/components/schemas/_common:DataStreamName' + $ref: '#/components/schemas/_common___DataStreamName' replicated: description: If `true`, the data stream is created and managed by cross-cluster replication and the local cluster can not write into this data stream or change its mappings. type: boolean status: - $ref: '#/components/schemas/_common:HealthStatusCapitalized' + $ref: '#/components/schemas/_common___HealthStatusCapitalized' system: description: If `true`, the data stream is created and managed by an OpenSearch stack component and cannot be modified through normal user interaction. type: boolean template: - $ref: '#/components/schemas/_common:Name' + $ref: '#/components/schemas/_common___Name' timestamp_field: - $ref: '#/components/schemas/indices._common:DataStreamTimestampField' + $ref: '#/components/schemas/indices._common___DataStreamTimestampField' required: - generation - indices @@ -47506,31 +49004,31 @@ components: - status - template - timestamp_field - indices._common:DataStreamIndex: + indices._common___DataStreamIndex: type: object properties: index_name: - $ref: '#/components/schemas/_common:IndexName' + $ref: '#/components/schemas/_common___IndexName' index_uuid: - $ref: '#/components/schemas/_common:Uuid' + $ref: '#/components/schemas/_common___Uuid' ilm_policy: - $ref: '#/components/schemas/_common:Name' + $ref: '#/components/schemas/_common___Name' managed_by: - $ref: '#/components/schemas/indices._common:ManagedBy' + $ref: '#/components/schemas/indices._common___ManagedBy' prefer_ilm: description: Indicates if ILM should take precedence over DSL in case both are configured to manage this index. type: boolean required: - index_name - index_uuid - indices._common:DataStreamTimestampField: + indices._common___DataStreamTimestampField: type: object properties: name: - $ref: '#/components/schemas/_common:Field' + $ref: '#/components/schemas/_common___Field' required: - name - indices._common:FielddataFrequencyFilter: + indices._common___FielddataFrequencyFilter: type: object properties: max: @@ -47545,13 +49043,20 @@ components: - max - min - min_segment_size - indices._common:IndexCheckOnStartup: + indices._common___IndexCheckOnStartup: type: string enum: - checksum - 'false' - 'true' - indices._common:IndexErrorCause: + indices._common___IndexError: + type: object + properties: + error: + $ref: '#/components/schemas/indices._common___IndexErrorCause' + status: + type: number + indices._common___IndexErrorCause: type: object properties: type: @@ -47563,28 +49068,28 @@ components: root_cause: type: array items: - $ref: '#/components/schemas/indices._common:IndexErrorCause' + $ref: '#/components/schemas/indices._common___IndexErrorCause' index: - $ref: '#/components/schemas/_common:IndexName' + $ref: '#/components/schemas/_common___IndexName' index_uuid: - $ref: '#/components/schemas/_common:Uuid' + $ref: '#/components/schemas/_common___Uuid' resource.id: - $ref: '#/components/schemas/_common:IndexName' + $ref: '#/components/schemas/_common___IndexName' resource.type: - $ref: '#/components/schemas/_common:ResourceType' + $ref: '#/components/schemas/_common___ResourceType' required: - type additionalProperties: title: metadata description: Additional details about the error. - indices._common:IndexingPressure: + indices._common___IndexingPressure: type: object properties: memory: - $ref: '#/components/schemas/indices._common:IndexingPressureMemory' + $ref: '#/components/schemas/indices._common___IndexingPressureMemory' required: - memory - indices._common:IndexingPressureMemory: + indices._common___IndexingPressureMemory: type: object properties: limit: @@ -47596,120 +49101,122 @@ components: - type: string - type: integer format: int64 - indices._common:IndexingSlowlog: + indices._common___IndexingSlowlog: type: object properties: level: type: string source: - type: integer + $ref: '#/components/schemas/_common___StringifiedInteger' reformat: - type: boolean + $ref: '#/components/schemas/_common___StringifiedBoolean' threshold: - $ref: '#/components/schemas/indices._common:IndexingSlowlogThresholds' - indices._common:IndexingSlowlogThresholds: + $ref: '#/components/schemas/indices._common___IndexingSlowlogThresholds' + indices._common___IndexingSlowlogThresholds: type: object properties: index: - $ref: '#/components/schemas/indices._common:SlowlogThresholdLevels' - indices._common:IndexRouting: + $ref: '#/components/schemas/indices._common___SlowlogThresholdLevels' + indices._common___IndexRouting: type: object properties: allocation: - $ref: '#/components/schemas/indices._common:IndexRoutingAllocation' + $ref: '#/components/schemas/indices._common___IndexRoutingAllocation' rebalance: - $ref: '#/components/schemas/indices._common:IndexRoutingRebalance' - indices._common:IndexRoutingAllocation: + $ref: '#/components/schemas/indices._common___IndexRoutingRebalance' + indices._common___IndexRoutingAllocation: type: object properties: enable: - $ref: '#/components/schemas/indices._common:IndexRoutingAllocationOptions' + $ref: '#/components/schemas/indices._common___IndexRoutingAllocationOptions' include: - $ref: '#/components/schemas/indices._common:IndexRoutingAllocationInclude' + $ref: '#/components/schemas/indices._common___IndexRoutingAllocationInclude' initial_recovery: - $ref: '#/components/schemas/indices._common:IndexRoutingAllocationInitialRecovery' + $ref: '#/components/schemas/indices._common___IndexRoutingAllocationInitialRecovery' disk: - $ref: '#/components/schemas/indices._common:IndexRoutingAllocationDisk' - indices._common:IndexRoutingAllocationDisk: + $ref: '#/components/schemas/indices._common___IndexRoutingAllocationDisk' + total_shards_per_node: + $ref: '#/components/schemas/_common___StringifiedInteger' + indices._common___IndexRoutingAllocationDisk: type: object properties: threshold_enabled: - $ref: '#/components/schemas/_common:Stringifiedboolean' - indices._common:IndexRoutingAllocationInclude: + $ref: '#/components/schemas/_common___StringifiedBoolean' + indices._common___IndexRoutingAllocationInclude: type: object properties: _tier_preference: type: string _id: - $ref: '#/components/schemas/_common:Id' - indices._common:IndexRoutingAllocationInitialRecovery: + $ref: '#/components/schemas/_common___Id' + indices._common___IndexRoutingAllocationInitialRecovery: type: object properties: _id: - $ref: '#/components/schemas/_common:Id' - indices._common:IndexRoutingAllocationOptions: + $ref: '#/components/schemas/_common___Id' + indices._common___IndexRoutingAllocationOptions: type: string enum: - all - new_primaries - none - primaries - indices._common:IndexRoutingRebalance: + indices._common___IndexRoutingRebalance: type: object properties: enable: - $ref: '#/components/schemas/indices._common:IndexRoutingRebalanceOptions' + $ref: '#/components/schemas/indices._common___IndexRoutingRebalanceOptions' required: - enable - indices._common:IndexRoutingRebalanceOptions: + indices._common___IndexRoutingRebalanceOptions: type: string enum: - all - none - primaries - replicas - indices._common:IndexSegmentSort: + indices._common___IndexSegmentSort: type: object properties: field: - $ref: '#/components/schemas/_common:Fields' + $ref: '#/components/schemas/_common___Fields' order: oneOf: - - $ref: '#/components/schemas/indices._common:SegmentSortOrder' + - $ref: '#/components/schemas/indices._common___SegmentSortOrder' - type: array items: - $ref: '#/components/schemas/indices._common:SegmentSortOrder' + $ref: '#/components/schemas/indices._common___SegmentSortOrder' mode: oneOf: - - $ref: '#/components/schemas/indices._common:SegmentSortMode' + - $ref: '#/components/schemas/indices._common___SegmentSortMode' - type: array items: - $ref: '#/components/schemas/indices._common:SegmentSortMode' + $ref: '#/components/schemas/indices._common___SegmentSortMode' missing: oneOf: - - $ref: '#/components/schemas/indices._common:SegmentSortMissing' + - $ref: '#/components/schemas/indices._common___SegmentSortMissing' - type: array items: - $ref: '#/components/schemas/indices._common:SegmentSortMissing' - indices._common:IndexSettingBlocks: + $ref: '#/components/schemas/indices._common___SegmentSortMissing' + indices._common___IndexSettingBlocks: type: object properties: read_only: - $ref: '#/components/schemas/_common:Stringifiedboolean' + $ref: '#/components/schemas/_common___StringifiedBoolean' read_only_allow_delete: - $ref: '#/components/schemas/_common:Stringifiedboolean' + $ref: '#/components/schemas/_common___StringifiedBoolean' read: - $ref: '#/components/schemas/_common:Stringifiedboolean' + $ref: '#/components/schemas/_common___StringifiedBoolean' write: - $ref: '#/components/schemas/_common:Stringifiedboolean' + $ref: '#/components/schemas/_common___StringifiedBoolean' metadata: - $ref: '#/components/schemas/_common:Stringifiedboolean' - indices._common:IndexSettings: + $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' + $ref: '#/components/schemas/indices._common___IndexSettings' mode: type: string routing_path: @@ -47719,264 +49226,258 @@ components: items: type: string soft_deletes: - $ref: '#/components/schemas/indices._common:SoftDeletes' + $ref: '#/components/schemas/indices._common___SoftDeletes' soft_deletes.retention_lease.period: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' sort: - $ref: '#/components/schemas/indices._common:IndexSegmentSort' + $ref: '#/components/schemas/indices._common___IndexSegmentSort' number_of_shards: - oneOf: - - type: integer - - type: string + $ref: '#/components/schemas/_common___StringifiedInteger' number_of_replicas: - oneOf: - - type: integer - - type: string + $ref: '#/components/schemas/_common___StringifiedInteger' number_of_routing_shards: - type: integer + $ref: '#/components/schemas/_common___StringifiedInteger' check_on_startup: - $ref: '#/components/schemas/indices._common:IndexCheckOnStartup' + $ref: '#/components/schemas/indices._common___IndexCheckOnStartup' codec: type: string routing_partition_size: - $ref: '#/components/schemas/_common:Stringifiedinteger' + $ref: '#/components/schemas/_common___StringifiedInteger' load_fixed_bitset_filters_eagerly: - type: boolean + $ref: '#/components/schemas/_common___StringifiedBoolean' hidden: - $ref: '#/components/schemas/_common:Stringifiedboolean' + $ref: '#/components/schemas/_common___StringifiedBoolean' auto_expand_replicas: type: string merge: - $ref: '#/components/schemas/indices._common:IndexSettingsMerge' + $ref: '#/components/schemas/indices._common___IndexSettingsMerge' merge.scheduler.max_thread_count: - $ref: '#/components/schemas/_common:Stringifiedinteger' + $ref: '#/components/schemas/_common___StringifiedInteger' search: - $ref: '#/components/schemas/indices._common:IndexSettingsSearch' + $ref: '#/components/schemas/indices._common___IndexSettingsSearch' search.idle.after: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' refresh_interval: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' max_result_window: - type: integer + $ref: '#/components/schemas/_common___StringifiedInteger' max_inner_result_window: - type: integer + $ref: '#/components/schemas/_common___StringifiedInteger' max_rescore_window: - type: integer + $ref: '#/components/schemas/_common___StringifiedInteger' max_docvalue_fields_search: - type: integer + $ref: '#/components/schemas/_common___StringifiedInteger' max_script_fields: - type: integer + $ref: '#/components/schemas/_common___StringifiedInteger' max_ngram_diff: - type: integer + $ref: '#/components/schemas/_common___StringifiedInteger' max_shingle_diff: - type: integer + $ref: '#/components/schemas/_common___StringifiedInteger' blocks: - $ref: '#/components/schemas/indices._common:IndexSettingBlocks' + $ref: '#/components/schemas/indices._common___IndexSettingBlocks' blocks.read_only: - $ref: '#/components/schemas/_common:Stringifiedboolean' + $ref: '#/components/schemas/_common___StringifiedBoolean' blocks.read_only_allow_delete: - $ref: '#/components/schemas/_common:Stringifiedboolean' + $ref: '#/components/schemas/_common___StringifiedBoolean' blocks.read: - $ref: '#/components/schemas/_common:Stringifiedboolean' + $ref: '#/components/schemas/_common___StringifiedBoolean' blocks.write: - $ref: '#/components/schemas/_common:Stringifiedboolean' + $ref: '#/components/schemas/_common___StringifiedBoolean' blocks.metadata: - $ref: '#/components/schemas/_common:Stringifiedboolean' + $ref: '#/components/schemas/_common___StringifiedBoolean' max_refresh_listeners: - type: integer + $ref: '#/components/schemas/_common___StringifiedInteger' analyze: - $ref: '#/components/schemas/indices._common:IndexSettingsAnalyze' + $ref: '#/components/schemas/indices._common___IndexSettingsAnalyze' analyze.max_token_count: - $ref: '#/components/schemas/_common:Stringifiedinteger' + $ref: '#/components/schemas/_common___StringifiedInteger' highlight: - $ref: '#/components/schemas/indices._common:IndexSettingsHighlight' + $ref: '#/components/schemas/indices._common___IndexSettingsHighlight' highlight.max_analyzed_offset: - type: integer + $ref: '#/components/schemas/_common___StringifiedInteger' max_terms_count: - type: integer + $ref: '#/components/schemas/_common___StringifiedInteger' max_regex_length: - type: integer + $ref: '#/components/schemas/_common___StringifiedInteger' routing: - $ref: '#/components/schemas/indices._common:IndexRouting' + $ref: '#/components/schemas/indices._common___IndexRouting' gc_deletes: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' default_pipeline: - $ref: '#/components/schemas/_common:PipelineName' + $ref: '#/components/schemas/_common___PipelineName' final_pipeline: - $ref: '#/components/schemas/_common:PipelineName' + $ref: '#/components/schemas/_common___PipelineName' lifecycle: - $ref: '#/components/schemas/indices._common:IndexSettingsLifecycle' + $ref: '#/components/schemas/indices._common___IndexSettingsLifecycle' lifecycle.name: - $ref: '#/components/schemas/_common:Name' + $ref: '#/components/schemas/_common___Name' provided_name: - $ref: '#/components/schemas/_common:Name' + $ref: '#/components/schemas/_common___Name' creation_date: - $ref: '#/components/schemas/_common:StringifiedEpochTimeUnitMillis' + $ref: '#/components/schemas/_common___StringifiedEpochTimeUnitMillis' creation_date_string: - $ref: '#/components/schemas/_common:DateTime' + $ref: '#/components/schemas/_common___DateTime' uuid: - $ref: '#/components/schemas/_common:Uuid' + $ref: '#/components/schemas/_common___Uuid' version: - $ref: '#/components/schemas/indices._common:IndexVersioning' + $ref: '#/components/schemas/indices._common___IndexVersioning' verified_before_close: - $ref: '#/components/schemas/_common:Stringifiedboolean' + $ref: '#/components/schemas/_common___StringifiedBoolean' format: oneOf: - type: string - type: number max_slices_per_scroll: - type: integer + $ref: '#/components/schemas/_common___StringifiedInteger' translog: - $ref: '#/components/schemas/indices._common:Translog' + $ref: '#/components/schemas/indices._common___Translog' translog.durability: - $ref: '#/components/schemas/indices._common:TranslogDurability' + $ref: '#/components/schemas/indices._common___TranslogDurability' translog.flush_threshold_size: - $ref: '#/components/schemas/_common:HumanReadableByteCount' + $ref: '#/components/schemas/_common___HumanReadableByteCount' query_string: - $ref: '#/components/schemas/indices._common:IndexSettingsQueryString' + $ref: '#/components/schemas/indices._common___IndexSettingsQueryString' query_string.lenient: - $ref: '#/components/schemas/_common:Stringifiedboolean' + $ref: '#/components/schemas/_common___StringifiedBoolean' priority: oneOf: - type: number - type: string top_metrics_max_size: - type: integer + $ref: '#/components/schemas/_common___StringifiedInteger' analysis: - $ref: '#/components/schemas/indices._common:IndexSettingsAnalysis' + $ref: '#/components/schemas/indices._common___IndexSettingsAnalysis' settings: - $ref: '#/components/schemas/indices._common:IndexSettings' - time_series: - $ref: '#/components/schemas/indices._common:IndexSettingsTimeSeries' + $ref: '#/components/schemas/indices._common___IndexSettings' queries: - $ref: '#/components/schemas/indices._common:IndexSettingsQueries' + $ref: '#/components/schemas/indices._common___IndexSettingsQueries' similarity: - $ref: '#/components/schemas/indices._common:IndexSettingsSimilarity' + $ref: '#/components/schemas/indices._common___IndexSettingsSimilarity' mapping: - $ref: '#/components/schemas/indices._common:IndexSettingsMapping' + $ref: '#/components/schemas/indices._common___IndexSettingsMapping' indexing: - $ref: '#/components/schemas/indices._common:IndexSettingsIndexing' + $ref: '#/components/schemas/indices._common___IndexSettingsIndexing' indexing_pressure: - $ref: '#/components/schemas/indices._common:IndexingPressure' + $ref: '#/components/schemas/indices._common___IndexingPressure' store: - $ref: '#/components/schemas/indices._common:IndexSettingsStore' + $ref: '#/components/schemas/indices._common___IndexSettingsStore' knn: - type: boolean + $ref: '#/components/schemas/_common___StringifiedBoolean' knn.algo_param.ef_search: - type: integer + $ref: '#/components/schemas/_common___StringifiedInteger' + composite_index.star_tree: + $ref: '#/components/schemas/indices._common___IndexSettingsStarTree' additionalProperties: title: custom_settings - indices._common:IndexSettingsAnalysis: + indices._common___IndexSettingsAnalysis: type: object properties: analyzer: type: object additionalProperties: - $ref: '#/components/schemas/_common.analysis:Analyzer' + $ref: '#/components/schemas/_common.analysis___Analyzer' char_filter: type: object additionalProperties: - $ref: '#/components/schemas/_common.analysis:CharFilter' + $ref: '#/components/schemas/_common.analysis___CharFilter' filter: type: object additionalProperties: - $ref: '#/components/schemas/_common.analysis:TokenFilter' + $ref: '#/components/schemas/_common.analysis___TokenFilter' normalizer: type: object additionalProperties: - $ref: '#/components/schemas/_common.analysis:Normalizer' + $ref: '#/components/schemas/_common.analysis___Normalizer' tokenizer: type: object additionalProperties: - $ref: '#/components/schemas/_common.analysis:Tokenizer' - indices._common:IndexSettingsAnalyze: + $ref: '#/components/schemas/_common.analysis___Tokenizer' + indices._common___IndexSettingsAnalyze: type: object properties: max_token_count: - $ref: '#/components/schemas/_common:Stringifiedinteger' - indices._common:IndexSettingsHighlight: + $ref: '#/components/schemas/_common___StringifiedInteger' + indices._common___IndexSettingsHighlight: type: object properties: max_analyzed_offset: - type: integer - indices._common:IndexSettingsIndexing: + $ref: '#/components/schemas/_common___StringifiedInteger' + indices._common___IndexSettingsIndexing: type: object properties: slowlog: - $ref: '#/components/schemas/indices._common:IndexingSlowlog' - indices._common:IndexSettingsLifecycle: + $ref: '#/components/schemas/indices._common___IndexingSlowlog' + indices._common___IndexSettingsLifecycle: type: object properties: name: - $ref: '#/components/schemas/_common:Name' + $ref: '#/components/schemas/_common___Name' indexing_complete: - $ref: '#/components/schemas/_common:Stringifiedboolean' + $ref: '#/components/schemas/_common___StringifiedBoolean' origination_date: description: |- If specified, this is the timestamp used to calculate the index age for its phase transitions. Use this setting if you create a new index that contains old data and want to use the original creation date to calculate the index age. Specified as a Unix epoch value in milliseconds. - $ref: '#/components/schemas/_common:StringifiedEpochTimeUnitMillis' + $ref: '#/components/schemas/_common___StringifiedEpochTimeUnitMillis' parse_origination_date: description: |- - Set to true to parse the origination date from the index name. This origination date is used to calculate the index age - for its phase transitions. The index name must match the pattern ^.*-{date_format}-\\d+, where the date_format is - yyyy.MM.dd and the trailing digits are optional. An index that was rolled over would normally match the full format, - for example logs-2016.10.31-000002). If the index name doesn't match the pattern, index creation fails. + Set to `true` to parse the origination date from the index name. This origination date is used to calculate the index age + for its phase transitions. The index name must match the pattern `^.*-{date_format}-\\d+`, where the `date_format` is + `yyyy.MM.dd` and the trailing digits are optional. An index that was rolled over would normally match the full format, + for example `logs-2016.10.31-000002`). If the index name doesn't match the pattern, index creation fails. type: boolean step: - $ref: '#/components/schemas/indices._common:IndexSettingsLifecycleStep' + $ref: '#/components/schemas/indices._common___IndexSettingsLifecycleStep' rollover_alias: description: |- The index alias to update when the index rolls over. Specify when using a policy that contains a rollover action. When the index rolls over, the alias is updated to reflect that the index is no longer the write index. For more - information about rolling indices, see Rollover. + information about rolling indexes, see Rollover. type: string required: - name - indices._common:IndexSettingsLifecycleStep: + indices._common___IndexSettingsLifecycleStep: type: object properties: wait_time_threshold: - $ref: '#/components/schemas/_common:Duration' - indices._common:IndexSettingsMapping: + $ref: '#/components/schemas/_common___Duration' + indices._common___IndexSettingsMapping: type: object properties: coerce: - type: boolean + $ref: '#/components/schemas/_common___StringifiedBoolean' total_fields: - $ref: '#/components/schemas/indices._common:IndexSettingsMappingLimitTotalFields' + $ref: '#/components/schemas/indices._common___IndexSettingsMappingLimitTotalFields' depth: - $ref: '#/components/schemas/indices._common:IndexSettingsMappingLimitDepth' + $ref: '#/components/schemas/indices._common___IndexSettingsMappingLimitDepth' nested_fields: - $ref: '#/components/schemas/indices._common:IndexSettingsMappingLimitNestedFields' + $ref: '#/components/schemas/indices._common___IndexSettingsMappingLimitNestedFields' nested_objects: - $ref: '#/components/schemas/indices._common:IndexSettingsMappingLimitNestedObjects' + $ref: '#/components/schemas/indices._common___IndexSettingsMappingLimitNestedObjects' field_name_length: - $ref: '#/components/schemas/indices._common:IndexSettingsMappingLimitFieldNameLength' + $ref: '#/components/schemas/indices._common___IndexSettingsMappingLimitFieldNameLength' dimension_fields: - $ref: '#/components/schemas/indices._common:IndexSettingsMappingLimitDimensionFields' + $ref: '#/components/schemas/indices._common___IndexSettingsMappingLimitDimensionFields' ignore_malformed: - type: boolean - indices._common:IndexSettingsMappingLimitDepth: + $ref: '#/components/schemas/_common___StringifiedBoolean' + indices._common___IndexSettingsMappingLimitDepth: type: object properties: limit: description: |- The maximum depth for a field, which is measured as the number of inner objects. For instance, if all fields are defined - at the root object level, then the depth is 1. If there is one object mapping, then the depth is 2, etc. - type: integer - format: int64 - indices._common:IndexSettingsMappingLimitDimensionFields: + at the root object level, then the depth is `1`. If there is one object mapping, then the depth is `2`. + $ref: '#/components/schemas/_common___StringifiedLong' + indices._common___IndexSettingsMappingLimitDimensionFields: type: object properties: limit: description: |- [preview] This functionality is in technical preview and may be changed or removed in a future release. OpenSearch will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features. - type: integer - format: int64 - indices._common:IndexSettingsMappingLimitFieldNameLength: + $ref: '#/components/schemas/_common___StringifiedLong' + indices._common___IndexSettingsMappingLimitFieldNameLength: type: object properties: limit: @@ -47984,9 +49485,8 @@ components: Setting for the maximum length of a field name. This setting isn't really something that addresses mappings explosion but might still be useful if you want to limit the field length. It usually shouldn't be necessary to set this setting. The default is okay unless a user starts to add a huge number of fields with really long names. Default is `Long.MAX_VALUE` (no limit). - type: integer - format: int64 - indices._common:IndexSettingsMappingLimitNestedFields: + $ref: '#/components/schemas/_common___StringifiedLong' + indices._common___IndexSettingsMappingLimitNestedFields: type: object properties: limit: @@ -47994,18 +49494,16 @@ components: The maximum number of distinct nested mappings in an index. The nested type should only be used in special cases, when arrays of objects need to be queried independently of each other. To safeguard against poorly designed mappings, this setting limits the number of unique nested types per index. - type: integer - format: int64 - indices._common:IndexSettingsMappingLimitNestedObjects: + $ref: '#/components/schemas/_common___StringifiedLong' + indices._common___IndexSettingsMappingLimitNestedObjects: type: object properties: limit: description: |- The maximum number of nested JSON objects that a single document can contain across all nested types. This limit helps to prevent out of memory errors when a document contains too many nested objects. - type: integer - format: int64 - indices._common:IndexSettingsMappingLimitTotalFields: + $ref: '#/components/schemas/_common___StringifiedLong' + indices._common___IndexSettingsMappingLimitTotalFields: type: object properties: limit: @@ -48013,62 +49511,148 @@ components: The maximum number of fields in an index. Field and object mappings, as well as field aliases count towards this limit. The limit is in place to prevent mappings and searches from becoming too large. Higher values can lead to performance degradations and memory issues, especially in clusters with a high load or few resources. - type: integer - format: int64 - indices._common:IndexSettingsMerge: + $ref: '#/components/schemas/_common___StringifiedLong' + indices._common___IndexSettingsMerge: type: object properties: + log_byte_size_policy: + $ref: '#/components/schemas/indices._common___IndexSettingsMergeLogByteSizePolicy' + policy: + $ref: '#/components/schemas/indices._common___IndexSettingsMergePolicy' + policy.deletes_pct_allowed: + $ref: '#/components/schemas/_common___StringifiedDouble' + policy.expunge_deletes_allowed: + $ref: '#/components/schemas/_common___StringifiedDouble' + policy.floor_segment: + $ref: '#/components/schemas/_common___HumanReadableByteCount' + policy.max_merge_at_once: + $ref: '#/components/schemas/_common___StringifiedInteger' + policy.max_merged_segment: + $ref: '#/components/schemas/_common___HumanReadableByteCount' + policy.reclaim_deletes_weight: + $ref: '#/components/schemas/_common___StringifiedDouble' + policy.segments_per_tier: + $ref: '#/components/schemas/_common___StringifiedDouble' scheduler: - $ref: '#/components/schemas/indices._common:IndexSettingsMergeScheduler' - indices._common:IndexSettingsMergeScheduler: + $ref: '#/components/schemas/indices._common___IndexSettingsMergeScheduler' + indices._common___IndexSettingsMergeLogByteSizePolicy: + type: object + properties: + max_merge_segment: + $ref: '#/components/schemas/_common___HumanReadableByteCount' + max_merge_segment_forced_merge: + $ref: '#/components/schemas/_common___HumanReadableByteCount' + max_merged_docs: + $ref: '#/components/schemas/_common___StringifiedInteger' + merge_factor: + $ref: '#/components/schemas/_common___StringifiedInteger' + min_merge: + $ref: '#/components/schemas/_common___HumanReadableByteCount' + no_cfs_ratio: + $ref: '#/components/schemas/_common___StringifiedDouble' + indices._common___IndexSettingsMergePolicy: + oneOf: + - title: name + $ref: '#/components/schemas/indices._common___IndexSettingsMergePolicyName' + - title: tiered_policy_config + $ref: '#/components/schemas/indices._common___IndexSettingsMergeTieredPolicy' + indices._common___IndexSettingsMergePolicyName: + type: string + enum: + - default + - log_byte_size + - tiered + indices._common___IndexSettingsMergeScheduler: type: object properties: + auto_throttle: + $ref: '#/components/schemas/_common___StringifiedBoolean' max_thread_count: - $ref: '#/components/schemas/_common:Stringifiedinteger' + $ref: '#/components/schemas/_common___StringifiedInteger' max_merge_count: - $ref: '#/components/schemas/_common:Stringifiedinteger' - indices._common:IndexSettingsQueries: + $ref: '#/components/schemas/_common___StringifiedInteger' + indices._common___IndexSettingsMergeTieredPolicy: + type: object + properties: + deletes_pct_allowed: + $ref: '#/components/schemas/_common___StringifiedDouble' + expunge_deletes_allowed: + $ref: '#/components/schemas/_common___StringifiedDouble' + floor_segment: + $ref: '#/components/schemas/_common___HumanReadableByteCount' + max_merge_at_once: + $ref: '#/components/schemas/_common___StringifiedInteger' + max_merge_at_once_explicit: + $ref: '#/components/schemas/_common___StringifiedInteger' + x-version-removed: '2.0' + max_merged_segment: + $ref: '#/components/schemas/_common___HumanReadableByteCount' + reclaim_deletes_weight: + $ref: '#/components/schemas/_common___StringifiedDouble' + segments_per_tier: + $ref: '#/components/schemas/_common___StringifiedDouble' + indices._common___IndexSettingsQueries: type: object properties: cache: - $ref: '#/components/schemas/indices._common:IndexSettingsQueriesCache' - indices._common:IndexSettingsQueriesCache: + $ref: '#/components/schemas/indices._common___IndexSettingsQueriesCache' + indices._common___IndexSettingsQueriesCache: type: object properties: enabled: - type: boolean + $ref: '#/components/schemas/_common___StringifiedBoolean' required: - enabled - indices._common:IndexSettingsQueryString: + indices._common___IndexSettingsQueryString: type: object properties: lenient: - $ref: '#/components/schemas/_common:Stringifiedboolean' - indices._common:IndexSettingsSearch: + $ref: '#/components/schemas/_common___StringifiedBoolean' + indices._common___IndexSettingsSearch: type: object properties: + concurrent: + $ref: '#/components/schemas/indices._common___IndexSettingsSearchConcurrent' + concurrent_segment_search: + $ref: '#/components/schemas/indices._common___IndexSettingsSearchConcurrentSegmentSearch' + default_pipeline: + type: string idle: - $ref: '#/components/schemas/indices._common:SearchIdle' + $ref: '#/components/schemas/indices._common___SearchIdle' slowlog: - $ref: '#/components/schemas/indices._common:SearchSlowlog' - indices._common:IndexSettingsSimilarity: + $ref: '#/components/schemas/indices._common___SearchSlowlog' + throttled: + $ref: '#/components/schemas/_common___StringifiedBoolean' + indices._common___IndexSettingsSearchConcurrent: + type: object + properties: + max_slice_count: + $ref: '#/components/schemas/_common___StringifiedInteger' + indices._common___IndexSettingsSearchConcurrentSegmentSearch: + type: object + properties: + mode: + type: string + enabled: + $ref: '#/components/schemas/_common___StringifiedBoolean' + indices._common___IndexSettingsSimilarity: type: object properties: bm25: - $ref: '#/components/schemas/indices._common:IndexSettingsSimilarityBm25' + $ref: '#/components/schemas/indices._common___IndexSettingsSimilarityBm25' dfi: - $ref: '#/components/schemas/indices._common:IndexSettingsSimilarityDfi' + $ref: '#/components/schemas/indices._common___IndexSettingsSimilarityDfi' dfr: - $ref: '#/components/schemas/indices._common:IndexSettingsSimilarityDfr' + $ref: '#/components/schemas/indices._common___IndexSettingsSimilarityDfr' ib: - $ref: '#/components/schemas/indices._common:IndexSettingsSimilarityIb' + $ref: '#/components/schemas/indices._common___IndexSettingsSimilarityIb' lmd: - $ref: '#/components/schemas/indices._common:IndexSettingsSimilarityLmd' + $ref: '#/components/schemas/indices._common___IndexSettingsSimilarityLmd' lmj: - $ref: '#/components/schemas/indices._common:IndexSettingsSimilarityLmj' + $ref: '#/components/schemas/indices._common___IndexSettingsSimilarityLmj' scripted_tfidf: - $ref: '#/components/schemas/indices._common:IndexSettingsSimilarityScriptedTfidf' - indices._common:IndexSettingsSimilarityBm25: + $ref: '#/components/schemas/indices._common___IndexSettingsSimilarityScriptedTfidf' + indices._common___IndexSettingsSimilarityBm25: type: object properties: b: @@ -48088,11 +49672,11 @@ components: - discount_overlaps - k1 - type - indices._common:IndexSettingsSimilarityDfi: + indices._common___IndexSettingsSimilarityDfi: type: object properties: independence_measure: - $ref: '#/components/schemas/_common:DFIIndependenceMeasure' + $ref: '#/components/schemas/_common___DFIIndependenceMeasure' type: type: string enum: @@ -48100,15 +49684,15 @@ components: required: - independence_measure - type - indices._common:IndexSettingsSimilarityDfr: + indices._common___IndexSettingsSimilarityDfr: type: object properties: after_effect: - $ref: '#/components/schemas/_common:DFRAfterEffect' + $ref: '#/components/schemas/_common___DFRAfterEffect' basic_model: - $ref: '#/components/schemas/_common:DFRBasicModel' + $ref: '#/components/schemas/_common___DFRBasicModel' normalization: - $ref: '#/components/schemas/_common:TermFrequencyNormalization' + $ref: '#/components/schemas/_common___TermFrequencyNormalization' type: type: string enum: @@ -48118,15 +49702,15 @@ components: - basic_model - normalization - type - indices._common:IndexSettingsSimilarityIb: + indices._common___IndexSettingsSimilarityIb: type: object properties: distribution: - $ref: '#/components/schemas/_common:IBDistribution' + $ref: '#/components/schemas/_common___IBDistribution' lambda: - $ref: '#/components/schemas/_common:IBLambda' + $ref: '#/components/schemas/_common___IBLambda' normalization: - $ref: '#/components/schemas/_common:TermFrequencyNormalization' + $ref: '#/components/schemas/_common___TermFrequencyNormalization' type: type: string enum: @@ -48136,7 +49720,7 @@ components: - lambda - normalization - type - indices._common:IndexSettingsSimilarityLmd: + indices._common___IndexSettingsSimilarityLmd: type: object properties: mu: @@ -48149,7 +49733,7 @@ components: required: - mu - type - indices._common:IndexSettingsSimilarityLmj: + indices._common___IndexSettingsSimilarityLmj: type: object properties: lambda: @@ -48162,11 +49746,11 @@ components: required: - lambda - type - indices._common:IndexSettingsSimilarityScriptedTfidf: + indices._common___IndexSettingsSimilarityScriptedTfidf: type: object properties: script: - $ref: '#/components/schemas/_common:Script' + $ref: '#/components/schemas/_common___Script' type: type: string enum: @@ -48174,86 +49758,157 @@ components: required: - script - type - indices._common:IndexSettingsStore: + indices._common___IndexSettingsStarTree: + type: object + properties: + default: + $ref: '#/components/schemas/indices._common___IndexSettingsStarTreeDefault' + field: + $ref: '#/components/schemas/indices._common___IndexSettingsStarTreeField' + max_fields: + $ref: '#/components/schemas/_common___StringifiedInteger' + indices._common___IndexSettingsStarTreeDefault: + type: object + properties: + max_leaf_docs: + $ref: '#/components/schemas/_common___StringifiedInteger' + indices._common___IndexSettingsStarTreeField: + type: object + properties: + default: + $ref: '#/components/schemas/indices._common___IndexSettingsStarTreeFieldDefault' + max_base_metrics: + $ref: '#/components/schemas/_common___StringifiedInteger' + max_date_intervals: + $ref: '#/components/schemas/_common___StringifiedInteger' + max_dimensions: + $ref: '#/components/schemas/_common___StringifiedInteger' + indices._common___IndexSettingsStarTreeFieldDefault: + type: object + properties: + date_intervals: + type: array + items: + type: string + metrics: + type: array + items: + type: string + indices._common___IndexSettingsStore: type: object properties: type: - $ref: '#/components/schemas/indices._common:StorageType' + $ref: '#/components/schemas/indices._common___StorageType' allow_mmap: description: |- - You can restrict the use of the mmapfs and the related hybridfs store type via the setting node.store.allow_mmap. - This is a boolean setting indicating whether or not memory-mapping is allowed. The default is to allow it. This + You can restrict the use of the `mmapfs` and the related `hybridfs` store types with the setting `node.store.allow_mmap`. + This is a Boolean setting indicating whether or not memory-mapping is allowed. The default is to allow it. This setting is useful, for example, if you are in an environment where you can not control the ability to create a lot of memory maps so you need disable the ability to use memory-mapping. - type: boolean + $ref: '#/components/schemas/_common___StringifiedBoolean' + fs: + $ref: '#/components/schemas/indices._common___IndexSettingsStoreFs' + hybrid: + $ref: '#/components/schemas/indices._common___IndexSettingsStoreHybrid' + preload: + type: array + items: + type: string + stats_refresh_interval: + $ref: '#/components/schemas/_common___Duration' required: - type - indices._common:IndexSettingsTimeSeries: + indices._common___IndexSettingsStoreFs: type: object properties: - end_time: - $ref: '#/components/schemas/_common:DateTime' - start_time: - $ref: '#/components/schemas/_common:DateTime' - indices._common:IndexState: + fs_lock: + $ref: '#/components/schemas/indices._common___IndexSettingsStoreFsLock' + indices._common___IndexSettingsStoreFsLock: + type: string + enum: + - native + - simple + indices._common___IndexSettingsStoreHybrid: + type: object + properties: + mmap: + $ref: '#/components/schemas/indices._common___IndexSettingsStoreHybridMmap' + nio: + $ref: '#/components/schemas/indices._common___IndexSettingsStoreHybridNio' + indices._common___IndexSettingsStoreHybridMmap: + type: object + properties: + extensions: + type: array + items: + type: string + indices._common___IndexSettingsStoreHybridNio: + type: object + properties: + extensions: + type: array + items: + type: string + indices._common___IndexState: type: object properties: aliases: type: object additionalProperties: - $ref: '#/components/schemas/indices._common:Alias' + $ref: '#/components/schemas/indices._common___Alias' mappings: - $ref: '#/components/schemas/_common.mapping:TypeMapping' + $ref: '#/components/schemas/_common.mapping___TypeMapping' settings: - $ref: '#/components/schemas/indices._common:IndexSettings' + $ref: '#/components/schemas/indices._common___IndexSettings' defaults: - $ref: '#/components/schemas/indices._common:IndexSettings' + $ref: '#/components/schemas/indices._common___IndexSettings' data_stream: - $ref: '#/components/schemas/_common:DataStreamName' - indices._common:IndexTemplate: + $ref: '#/components/schemas/_common___DataStreamName' + indices._common___IndexTemplate: type: object properties: index_patterns: - $ref: '#/components/schemas/_common:Names' + $ref: '#/components/schemas/_common___Names' composed_of: description: |- An ordered list of component template names. Component templates are merged in the order specified, meaning that the last component template specified has the highest precedence. type: array items: - $ref: '#/components/schemas/_common:Name' + $ref: '#/components/schemas/_common___Name' template: - $ref: '#/components/schemas/indices._common:IndexTemplateSummary' + $ref: '#/components/schemas/indices._common___IndexTemplateSummary' version: - $ref: '#/components/schemas/_common:VersionNumber' + $ref: '#/components/schemas/_common___VersionNumber' priority: description: |- Priority to determine index template precedence when a new data stream or index is created. The index template with the highest priority is chosen. If no priority is specified the template is treated as though it is of priority 0 (lowest priority). This number is not automatically generated by OpenSearch. - type: number + type: integer + format: int64 _meta: - $ref: '#/components/schemas/_common:Metadata' + $ref: '#/components/schemas/_common___Metadata' allow_auto_create: type: boolean data_stream: - $ref: '#/components/schemas/indices._common:IndexTemplateDataStreamConfiguration' + $ref: '#/components/schemas/indices._common___IndexTemplateDataStreamConfiguration' required: - index_patterns description: New index template definition to be simulated, if no index template name is specified. - indices._common:IndexTemplateDataStreamConfiguration: + indices._common___IndexTemplateDataStreamConfiguration: type: object properties: hidden: - description: If true, the data stream is hidden. + description: If `true`, the data stream is hidden. type: boolean allow_custom_routing: - description: If true, the data stream supports custom routing. + description: If `true`, the data stream supports custom routing. type: boolean timestamp_field: - $ref: '#/components/schemas/indices._common:DataStreamTimestampField' - indices._common:IndexTemplateSummary: + $ref: '#/components/schemas/indices._common___DataStreamTimestampField' + indices._common___IndexTemplateSummary: type: object properties: aliases: @@ -48264,49 +49919,49 @@ components: Data stream aliases ignore the `index_routing`, `routing`, and `search_routing` options. type: object additionalProperties: - $ref: '#/components/schemas/indices._common:Alias' + $ref: '#/components/schemas/indices._common___Alias' mappings: - $ref: '#/components/schemas/_common.mapping:TypeMapping' + $ref: '#/components/schemas/_common.mapping___TypeMapping' settings: - $ref: '#/components/schemas/indices._common:IndexSettings' - indices._common:IndexVersioning: + $ref: '#/components/schemas/indices._common___IndexSettings' + indices._common___IndexVersioning: type: object properties: created: - $ref: '#/components/schemas/_common:VersionString' + $ref: '#/components/schemas/_common___VersionString' created_string: type: string - indices._common:ManagedBy: + indices._common___ManagedBy: type: string enum: - Data stream lifecycle - Index Lifecycle Management - Unmanaged - indices._common:NumericFielddata: + indices._common___NumericFielddata: type: object properties: format: - $ref: '#/components/schemas/indices._common:NumericFielddataFormat' + $ref: '#/components/schemas/indices._common___NumericFielddataFormat' required: - format - indices._common:NumericFielddataFormat: + indices._common___NumericFielddataFormat: type: string enum: - array - disabled - indices._common:RetentionLease: + indices._common___RetentionLease: type: object properties: period: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' required: - period - indices._common:SearchIdle: + indices._common___SearchIdle: type: object properties: after: - $ref: '#/components/schemas/_common:Duration' - indices._common:SearchSlowlog: + $ref: '#/components/schemas/_common___Duration' + indices._common___SearchSlowlog: type: object properties: level: @@ -48314,68 +49969,77 @@ components: reformat: type: boolean threshold: - $ref: '#/components/schemas/indices._common:SearchSlowlogThresholds' - indices._common:SearchSlowlogThresholds: + $ref: '#/components/schemas/indices._common___SearchSlowlogThresholds' + indices._common___SearchSlowlogThresholds: type: object properties: query: - $ref: '#/components/schemas/indices._common:SlowlogThresholdLevels' + $ref: '#/components/schemas/indices._common___SlowlogThresholdLevels' fetch: - $ref: '#/components/schemas/indices._common:SlowlogThresholdLevels' - indices._common:SegmentSortMissing: + $ref: '#/components/schemas/indices._common___SlowlogThresholdLevels' + indices._common___SegmentSortMissing: type: string enum: - _first - _last - indices._common:SegmentSortMode: + indices._common___SegmentSortMode: type: string enum: - max - min - indices._common:SegmentSortOrder: + indices._common___SegmentSortOrder: type: string enum: - asc - desc - indices._common:SlowlogThresholdLevels: + indices._common___SlowlogThresholdLevels: type: object properties: warn: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' info: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' debug: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' trace: - $ref: '#/components/schemas/_common:Duration' - indices._common:SoftDeletes: + $ref: '#/components/schemas/_common___Duration' + indices._common___SoftDeletes: type: object properties: enabled: description: Indicates whether soft deletes are enabled on the index. - type: boolean + $ref: '#/components/schemas/_common___StringifiedBoolean' + retention: + $ref: '#/components/schemas/indices._common___SoftDeletesRetention' retention_lease: - $ref: '#/components/schemas/indices._common:RetentionLease' - indices._common:StorageType: - type: string - enum: - - fs - - hybridfs - - mmapfs - - niofs - indices._common:TemplateMapping: + $ref: '#/components/schemas/indices._common___RetentionLease' + indices._common___SoftDeletesRetention: + type: object + properties: + operations: + $ref: '#/components/schemas/_common___StringifiedLong' + indices._common___StorageType: + anyOf: + - type: string + enum: + - fs + - hybridfs + - mmapfs + - niofs + - type: string + indices._common___TemplateMapping: type: object properties: aliases: type: object additionalProperties: - $ref: '#/components/schemas/indices._common:Alias' + $ref: '#/components/schemas/indices._common___Alias' index_patterns: type: array items: - $ref: '#/components/schemas/_common:Name' + $ref: '#/components/schemas/_common___Name' mappings: - $ref: '#/components/schemas/_common.mapping:TypeMapping' + $ref: '#/components/schemas/_common.mapping___TypeMapping' order: type: number settings: @@ -48383,75 +50047,77 @@ components: additionalProperties: type: object version: - $ref: '#/components/schemas/_common:VersionNumber' + $ref: '#/components/schemas/_common___VersionNumber' required: - aliases - index_patterns - mappings - order - settings - indices._common:Translog: + indices._common___Translog: type: object properties: sync_interval: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' durability: - $ref: '#/components/schemas/indices._common:TranslogDurability' + $ref: '#/components/schemas/indices._common___TranslogDurability' flush_threshold_size: - $ref: '#/components/schemas/_common:HumanReadableByteCount' + $ref: '#/components/schemas/_common___HumanReadableByteCount' + generation_threshold_size: + $ref: '#/components/schemas/_common___HumanReadableByteCount' retention: - $ref: '#/components/schemas/indices._common:TranslogRetention' - indices._common:TranslogDurability: + $ref: '#/components/schemas/indices._common___TranslogRetention' + indices._common___TranslogDurability: type: string enum: - ASYNC - REQUEST - async - request - indices._common:TranslogRetention: + indices._common___TranslogRetention: type: object properties: size: - $ref: '#/components/schemas/_common:HumanReadableByteCount' + $ref: '#/components/schemas/_common___HumanReadableByteCount' age: - $ref: '#/components/schemas/_common:Duration' - indices.add_block:IndicesBlockOptions: + $ref: '#/components/schemas/_common___Duration' + indices.add_block___IndicesBlockOptions: type: string enum: - metadata - read - read_only - write - indices.add_block:IndicesBlockStatus: + indices.add_block___IndicesBlockStatus: type: object properties: name: - $ref: '#/components/schemas/_common:IndexName' + $ref: '#/components/schemas/_common___IndexName' blocked: type: boolean required: - blocked - name - indices.analyze:AnalyzeDetail: + indices.analyze___AnalyzeDetail: type: object properties: analyzer: - $ref: '#/components/schemas/indices.analyze:AnalyzerDetail' + $ref: '#/components/schemas/indices.analyze___AnalyzerDetail' charfilters: type: array items: - $ref: '#/components/schemas/indices.analyze:CharFilterDetail' + $ref: '#/components/schemas/indices.analyze___CharFilterDetail' custom_analyzer: type: boolean tokenfilters: type: array items: - $ref: '#/components/schemas/indices.analyze:TokenDetail' + $ref: '#/components/schemas/indices.analyze___TokenDetail' tokenizer: - $ref: '#/components/schemas/indices.analyze:TokenDetail' + $ref: '#/components/schemas/indices.analyze___TokenDetail' required: - custom_analyzer - indices.analyze:AnalyzerDetail: + indices.analyze___AnalyzerDetail: type: object properties: name: @@ -48459,11 +50125,11 @@ components: tokens: type: array items: - $ref: '#/components/schemas/indices.analyze:ExplainAnalyzeToken' + $ref: '#/components/schemas/indices.analyze___ExplainAnalyzeToken' required: - name - tokens - indices.analyze:AnalyzeToken: + indices.analyze___AnalyzeToken: type: object properties: end_offset: @@ -48484,7 +50150,7 @@ components: - start_offset - token - type - indices.analyze:CharFilterDetail: + indices.analyze___CharFilterDetail: type: object properties: filtered_text: @@ -48496,7 +50162,7 @@ components: required: - filtered_text - name - indices.analyze:ExplainAnalyzeToken: + indices.analyze___ExplainAnalyzeToken: type: object properties: bytes: @@ -48526,13 +50192,13 @@ components: - termFrequency - token - type - indices.analyze:TextToAnalyze: + indices.analyze___TextToAnalyze: oneOf: - type: string - type: array items: type: string - indices.analyze:TokenDetail: + indices.analyze___TokenDetail: type: object properties: name: @@ -48540,11 +50206,11 @@ components: tokens: type: array items: - $ref: '#/components/schemas/indices.analyze:ExplainAnalyzeToken' + $ref: '#/components/schemas/indices.analyze___ExplainAnalyzeToken' required: - name - tokens - indices.close:CloseIndexResult: + indices.close___CloseIndexResult: type: object properties: closed: @@ -48552,76 +50218,76 @@ components: shards: type: object additionalProperties: - $ref: '#/components/schemas/indices.close:CloseShardResult' + $ref: '#/components/schemas/indices.close___CloseShardResult' required: - closed - indices.close:CloseShardResult: + indices.close___CloseShardResult: type: object properties: failures: type: array items: - $ref: '#/components/schemas/_common:ShardFailure' + $ref: '#/components/schemas/_common___ShardFailure' required: - failures - indices.data_streams_stats:DataStreamsStatsItem: + indices.data_streams_stats___DataStreamsStatsItem: type: object properties: backing_indices: - description: Current number of backing indices for the data stream. + description: Current number of backing indexes for the data stream. type: number data_stream: - $ref: '#/components/schemas/_common:Name' + $ref: '#/components/schemas/_common___Name' maximum_timestamp: - $ref: '#/components/schemas/_common:EpochTimeUnitMillis' + $ref: '#/components/schemas/_common___EpochTimeUnitMillis' store_size: - $ref: '#/components/schemas/_common:HumanReadableByteCount' + $ref: '#/components/schemas/_common___HumanReadableByteCount' store_size_bytes: - description: Total size, in bytes, of all shards for the data stream's backing indices. - $ref: '#/components/schemas/_common:ByteCount' + description: Total size, in bytes, of all shards for the data stream's backing indexes. + $ref: '#/components/schemas/_common___ByteCount' required: - backing_indices - data_stream - maximum_timestamp - store_size_bytes - indices.get_alias:IndexAliases: + indices.get_alias___IndexAliases: type: object properties: aliases: type: object additionalProperties: - $ref: '#/components/schemas/indices._common:AliasDefinition' + $ref: '#/components/schemas/indices._common___AliasDefinition' required: - aliases - indices.get_field_mapping:TypeFieldMappings: + indices.get_field_mapping___TypeFieldMappings: type: object properties: mappings: type: object additionalProperties: - $ref: '#/components/schemas/_common.mapping:FieldMapping' + $ref: '#/components/schemas/_common.mapping___FieldMapping' required: - mappings - indices.get_index_template:IndexTemplateItem: + indices.get_index_template___IndexTemplateItem: type: object properties: name: - $ref: '#/components/schemas/_common:Name' + $ref: '#/components/schemas/_common___Name' index_template: - $ref: '#/components/schemas/indices._common:IndexTemplate' + $ref: '#/components/schemas/indices._common___IndexTemplate' required: - index_template - name - indices.get_mapping:IndexMappingRecord: + indices.get_mapping___IndexMappingRecord: type: object properties: item: - $ref: '#/components/schemas/_common.mapping:TypeMapping' + $ref: '#/components/schemas/_common.mapping___TypeMapping' mappings: - $ref: '#/components/schemas/_common.mapping:TypeMapping' + $ref: '#/components/schemas/_common.mapping___TypeMapping' required: - mappings - indices.put_index_template:IndexTemplateMapping: + indices.put_index_template___IndexTemplateMapping: type: object properties: aliases: @@ -48632,12 +50298,12 @@ components: Data stream aliases ignore the `index_routing`, `routing`, and `search_routing` options. type: object additionalProperties: - $ref: '#/components/schemas/indices._common:Alias' + $ref: '#/components/schemas/indices._common___Alias' mappings: - $ref: '#/components/schemas/_common.mapping:TypeMapping' + $ref: '#/components/schemas/_common.mapping___TypeMapping' settings: - $ref: '#/components/schemas/indices._common:IndexSettings' - indices.recovery:FileDetails: + $ref: '#/components/schemas/indices._common___IndexSettings' + indices.recovery___FileDetails: type: object properties: length: @@ -48650,41 +50316,41 @@ components: - length - name - recovered - indices.recovery:RecoveryBytes: + indices.recovery___RecoveryBytes: type: object properties: percent: - $ref: '#/components/schemas/_common:PercentageString' + $ref: '#/components/schemas/_common___PercentageString' recovered: - $ref: '#/components/schemas/_common:HumanReadableByteCount' + $ref: '#/components/schemas/_common___HumanReadableByteCount' recovered_in_bytes: - $ref: '#/components/schemas/_common:ByteCount' + $ref: '#/components/schemas/_common___ByteCount' recovered_from_snapshot: - $ref: '#/components/schemas/_common:HumanReadableByteCount' + $ref: '#/components/schemas/_common___HumanReadableByteCount' recovered_from_snapshot_in_bytes: - $ref: '#/components/schemas/_common:ByteCount' + $ref: '#/components/schemas/_common___ByteCount' reused: - $ref: '#/components/schemas/_common:HumanReadableByteCount' + $ref: '#/components/schemas/_common___HumanReadableByteCount' reused_in_bytes: - $ref: '#/components/schemas/_common:ByteCount' + $ref: '#/components/schemas/_common___ByteCount' total: - $ref: '#/components/schemas/_common:HumanReadableByteCount' + $ref: '#/components/schemas/_common___HumanReadableByteCount' total_in_bytes: - $ref: '#/components/schemas/_common:ByteCount' + $ref: '#/components/schemas/_common___ByteCount' required: - percent - recovered_in_bytes - reused_in_bytes - total_in_bytes - indices.recovery:RecoveryFiles: + indices.recovery___RecoveryFiles: type: object properties: details: type: array items: - $ref: '#/components/schemas/indices.recovery:FileDetails' + $ref: '#/components/schemas/indices.recovery___FileDetails' percent: - $ref: '#/components/schemas/_common:PercentageString' + $ref: '#/components/schemas/_common___PercentageString' recovered: type: number reused: @@ -48696,60 +50362,60 @@ components: - recovered - reused - total - indices.recovery:RecoveryIndexStatus: + indices.recovery___RecoveryIndexStatus: type: object properties: bytes: - $ref: '#/components/schemas/indices.recovery:RecoveryBytes' + $ref: '#/components/schemas/indices.recovery___RecoveryBytes' files: - $ref: '#/components/schemas/indices.recovery:RecoveryFiles' + $ref: '#/components/schemas/indices.recovery___RecoveryFiles' size: - $ref: '#/components/schemas/indices.recovery:RecoveryBytes' + $ref: '#/components/schemas/indices.recovery___RecoveryBytes' source_throttle_time: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' source_throttle_time_in_millis: - $ref: '#/components/schemas/_common:DurationValueUnitMillis' + $ref: '#/components/schemas/_common___DurationValueUnitMillis' target_throttle_time: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' target_throttle_time_in_millis: - $ref: '#/components/schemas/_common:DurationValueUnitMillis' + $ref: '#/components/schemas/_common___DurationValueUnitMillis' total_time: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' total_time_in_millis: - $ref: '#/components/schemas/_common:DurationValueUnitMillis' + $ref: '#/components/schemas/_common___DurationValueUnitMillis' required: - files - size - source_throttle_time_in_millis - target_throttle_time_in_millis - total_time_in_millis - indices.recovery:RecoveryOrigin: + indices.recovery___RecoveryOrigin: type: object properties: hostname: type: string host: - $ref: '#/components/schemas/_common:Host' + $ref: '#/components/schemas/_common___Host' transport_address: - $ref: '#/components/schemas/_common:TransportAddress' + $ref: '#/components/schemas/_common___TransportAddress' id: - $ref: '#/components/schemas/_common:Id' + $ref: '#/components/schemas/_common___Id' ip: - $ref: '#/components/schemas/_common:Ip' + $ref: '#/components/schemas/_common___Ip' name: - $ref: '#/components/schemas/_common:Name' + $ref: '#/components/schemas/_common___Name' bootstrap_new_history_uuid: type: boolean repository: - $ref: '#/components/schemas/_common:Name' + $ref: '#/components/schemas/_common___Name' snapshot: - $ref: '#/components/schemas/_common:Name' + $ref: '#/components/schemas/_common___Name' version: - $ref: '#/components/schemas/_common:VersionString' + $ref: '#/components/schemas/_common___VersionString' restoreUUID: - $ref: '#/components/schemas/_common:Uuid' + $ref: '#/components/schemas/_common___Uuid' index: - $ref: '#/components/schemas/_common:IndexName' + $ref: '#/components/schemas/_common___IndexName' isSearchableSnapshot: type: boolean remoteStoreIndexShallowCopy: @@ -48762,64 +50428,64 @@ components: type: - 'null' - string - indices.recovery:RecoveryStartStatus: + indices.recovery___RecoveryStartStatus: type: object properties: check_index_time: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' check_index_time_in_millis: - $ref: '#/components/schemas/_common:DurationValueUnitMillis' + $ref: '#/components/schemas/_common___DurationValueUnitMillis' total_time: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' total_time_in_millis: - $ref: '#/components/schemas/_common:DurationValueUnitMillis' + $ref: '#/components/schemas/_common___DurationValueUnitMillis' required: - check_index_time_in_millis - total_time_in_millis - indices.recovery:RecoveryStatus: + indices.recovery___RecoveryStatus: type: object properties: shards: type: array items: - $ref: '#/components/schemas/indices.recovery:ShardRecovery' + $ref: '#/components/schemas/indices.recovery___ShardRecovery' required: - shards - indices.recovery:ShardRecovery: + indices.recovery___ShardRecovery: type: object properties: id: type: number index: - $ref: '#/components/schemas/indices.recovery:RecoveryIndexStatus' + $ref: '#/components/schemas/indices.recovery___RecoveryIndexStatus' primary: type: boolean source: - $ref: '#/components/schemas/indices.recovery:RecoveryOrigin' + $ref: '#/components/schemas/indices.recovery___RecoveryOrigin' stage: type: string start: - $ref: '#/components/schemas/indices.recovery:RecoveryStartStatus' + $ref: '#/components/schemas/indices.recovery___RecoveryStartStatus' start_time: - $ref: '#/components/schemas/_common:DateTime' + $ref: '#/components/schemas/_common___DateTime' start_time_in_millis: - $ref: '#/components/schemas/_common:EpochTimeUnitMillis' + $ref: '#/components/schemas/_common___EpochTimeUnitMillis' stop_time: - $ref: '#/components/schemas/_common:DateTime' + $ref: '#/components/schemas/_common___DateTime' stop_time_in_millis: - $ref: '#/components/schemas/_common:EpochTimeUnitMillis' + $ref: '#/components/schemas/_common___EpochTimeUnitMillis' target: - $ref: '#/components/schemas/indices.recovery:RecoveryOrigin' + $ref: '#/components/schemas/indices.recovery___RecoveryOrigin' total_time: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' total_time_in_millis: - $ref: '#/components/schemas/_common:DurationValueUnitMillis' + $ref: '#/components/schemas/_common___DurationValueUnitMillis' translog: - $ref: '#/components/schemas/indices.recovery:TranslogStatus' + $ref: '#/components/schemas/indices.recovery___TranslogStatus' type: type: string verify_index: - $ref: '#/components/schemas/indices.recovery:VerifyIndex' + $ref: '#/components/schemas/indices.recovery___VerifyIndex' required: - id - index @@ -48832,11 +50498,11 @@ components: - translog - type - verify_index - indices.recovery:TranslogStatus: + indices.recovery___TranslogStatus: type: object properties: percent: - $ref: '#/components/schemas/_common:PercentageString' + $ref: '#/components/schemas/_common___PercentageString' recovered: type: number total: @@ -48844,57 +50510,57 @@ components: total_on_start: type: number total_time: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' total_time_in_millis: - $ref: '#/components/schemas/_common:DurationValueUnitMillis' + $ref: '#/components/schemas/_common___DurationValueUnitMillis' required: - percent - recovered - total - total_on_start - total_time_in_millis - indices.recovery:VerifyIndex: + indices.recovery___VerifyIndex: type: object properties: check_index_time: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' check_index_time_in_millis: - $ref: '#/components/schemas/_common:DurationValueUnitMillis' + $ref: '#/components/schemas/_common___DurationValueUnitMillis' total_time: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' total_time_in_millis: - $ref: '#/components/schemas/_common:DurationValueUnitMillis' + $ref: '#/components/schemas/_common___DurationValueUnitMillis' required: - check_index_time_in_millis - total_time_in_millis - indices.resolve_index:ResolveIndexAliasItem: + indices.resolve_index___ResolveIndexAliasItem: type: object properties: name: - $ref: '#/components/schemas/_common:Name' + $ref: '#/components/schemas/_common___Name' indices: - $ref: '#/components/schemas/_common:Indices' + $ref: '#/components/schemas/_common___Indices' required: - indices - name - indices.resolve_index:ResolveIndexDataStreamsItem: + indices.resolve_index___ResolveIndexDataStreamsItem: type: object properties: name: - $ref: '#/components/schemas/_common:DataStreamName' + $ref: '#/components/schemas/_common___DataStreamName' timestamp_field: - $ref: '#/components/schemas/_common:Field' + $ref: '#/components/schemas/_common___Field' backing_indices: - $ref: '#/components/schemas/_common:Indices' + $ref: '#/components/schemas/_common___Indices' required: - backing_indices - name - timestamp_field - indices.resolve_index:ResolveIndexItem: + indices.resolve_index___ResolveIndexItem: type: object properties: name: - $ref: '#/components/schemas/_common:Name' + $ref: '#/components/schemas/_common___Name' aliases: type: array items: @@ -48904,44 +50570,44 @@ components: items: type: string data_stream: - $ref: '#/components/schemas/_common:DataStreamName' + $ref: '#/components/schemas/_common___DataStreamName' required: - attributes - name - indices.rollover:RolloverConditions: + indices.rollover___RolloverConditions: type: object properties: min_age: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' max_age: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' max_age_millis: - $ref: '#/components/schemas/_common:DurationValueUnitMillis' + $ref: '#/components/schemas/_common___DurationValueUnitMillis' min_docs: type: number max_docs: type: number max_size: - $ref: '#/components/schemas/_common:HumanReadableByteCount' + $ref: '#/components/schemas/_common___HumanReadableByteCount' max_size_bytes: - $ref: '#/components/schemas/_common:ByteCount' + $ref: '#/components/schemas/_common___ByteCount' min_size: - $ref: '#/components/schemas/_common:HumanReadableByteCount' + $ref: '#/components/schemas/_common___HumanReadableByteCount' min_size_bytes: - $ref: '#/components/schemas/_common:ByteCount' + $ref: '#/components/schemas/_common___ByteCount' max_primary_shard_size: - $ref: '#/components/schemas/_common:HumanReadableByteCount' + $ref: '#/components/schemas/_common___HumanReadableByteCount' max_primary_shard_size_bytes: - $ref: '#/components/schemas/_common:ByteCount' + $ref: '#/components/schemas/_common___ByteCount' min_primary_shard_size: - $ref: '#/components/schemas/_common:HumanReadableByteCount' + $ref: '#/components/schemas/_common___HumanReadableByteCount' min_primary_shard_size_bytes: - $ref: '#/components/schemas/_common:ByteCount' + $ref: '#/components/schemas/_common___ByteCount' max_primary_shard_docs: type: number min_primary_shard_docs: type: number - indices.segments:IndexSegment: + indices.segments___IndexSegment: type: object properties: shards: @@ -48950,11 +50616,11 @@ components: oneOf: - type: array items: - $ref: '#/components/schemas/indices.segments:ShardsSegment' - - $ref: '#/components/schemas/indices.segments:ShardsSegment' + $ref: '#/components/schemas/indices.segments___ShardsSegment' + - $ref: '#/components/schemas/indices.segments___ShardsSegment' required: - shards - indices.segments:Segment: + indices.segments___Segment: type: object properties: generation: @@ -48964,19 +50630,19 @@ components: deleted_docs: type: integer size: - $ref: '#/components/schemas/_common:HumanReadableByteCount' + $ref: '#/components/schemas/_common___HumanReadableByteCount' size_in_bytes: - $ref: '#/components/schemas/_common:ByteCount' + $ref: '#/components/schemas/_common___ByteCount' memory: - $ref: '#/components/schemas/_common:HumanReadableByteCount' + $ref: '#/components/schemas/_common___HumanReadableByteCount' memory_in_bytes: - $ref: '#/components/schemas/_common:ByteCount' + $ref: '#/components/schemas/_common___ByteCount' committed: type: boolean search: type: boolean version: - $ref: '#/components/schemas/_common:VersionString' + $ref: '#/components/schemas/_common___VersionString' compound: type: boolean attributes: @@ -48993,7 +50659,7 @@ components: - search - size_in_bytes - version - indices.segments:ShardSegmentRouting: + indices.segments___ShardSegmentRouting: type: object properties: node: @@ -49006,51 +50672,51 @@ components: - node - primary - state - indices.segments:ShardsSegment: + indices.segments___ShardsSegment: type: object properties: num_committed_segments: type: number routing: - $ref: '#/components/schemas/indices.segments:ShardSegmentRouting' + $ref: '#/components/schemas/indices.segments___ShardSegmentRouting' num_search_segments: type: number segments: type: object additionalProperties: - $ref: '#/components/schemas/indices.segments:Segment' + $ref: '#/components/schemas/indices.segments___Segment' required: - num_committed_segments - num_search_segments - routing - segments - indices.shard_stores:IndicesShardStores: + indices.shard_stores___IndicesShardStores: type: object properties: shards: type: object additionalProperties: - $ref: '#/components/schemas/indices.shard_stores:ShardStoreWrapper' + $ref: '#/components/schemas/indices.shard_stores___ShardStoreWrapper' required: - shards - indices.shard_stores:ShardStore: + indices.shard_stores___ShardStore: type: object properties: allocation: - $ref: '#/components/schemas/indices.shard_stores:ShardStoreAllocation' + $ref: '#/components/schemas/indices.shard_stores___ShardStoreAllocation' allocation_id: - $ref: '#/components/schemas/_common:Id' + $ref: '#/components/schemas/_common___Id' store_exception: - $ref: '#/components/schemas/indices.shard_stores:ShardStoreException' + $ref: '#/components/schemas/indices.shard_stores___ShardStoreException' required: - allocation - indices.shard_stores:ShardStoreAllocation: + indices.shard_stores___ShardStoreAllocation: type: string enum: - primary - replica - unused - indices.shard_stores:ShardStoreException: + indices.shard_stores___ShardStoreException: type: object properties: reason: @@ -49060,27 +50726,27 @@ components: required: - reason - type - indices.shard_stores:ShardStoreWrapper: + indices.shard_stores___ShardStoreWrapper: type: object properties: stores: type: array items: - $ref: '#/components/schemas/indices.shard_stores:ShardStore' + $ref: '#/components/schemas/indices.shard_stores___ShardStore' required: - stores - indices.shard_stores:Status: + indices.shard_stores___Status: type: string enum: - all - green - red - yellow - indices.simulate_template:Overlapping: + indices.simulate_template___Overlapping: type: object properties: name: - $ref: '#/components/schemas/_common:Name' + $ref: '#/components/schemas/_common___Name' index_patterns: type: array items: @@ -49088,105 +50754,105 @@ components: required: - index_patterns - name - indices.simulate_template:Template: + indices.simulate_template___Template: type: object properties: aliases: type: object additionalProperties: - $ref: '#/components/schemas/indices._common:Alias' + $ref: '#/components/schemas/indices._common___Alias' mappings: - $ref: '#/components/schemas/_common.mapping:TypeMapping' + $ref: '#/components/schemas/_common.mapping___TypeMapping' settings: - $ref: '#/components/schemas/indices._common:IndexSettings' + $ref: '#/components/schemas/indices._common___IndexSettings' required: - aliases - mappings - settings - indices.stats:AllIndicesStats: + indices.stats___AllIndicesStats: type: object properties: primaries: - $ref: '#/components/schemas/indices.stats:IndexStats' + $ref: '#/components/schemas/indices.stats___IndexStats' total: - $ref: '#/components/schemas/indices.stats:IndexStats' + $ref: '#/components/schemas/indices.stats___IndexStats' required: - primaries - total - indices.stats:IndexShardStats: + indices.stats___IndexShardStats: allOf: - - $ref: '#/components/schemas/indices.stats:IndexStatsBase' + - $ref: '#/components/schemas/indices.stats___IndexStatsBase' - type: object properties: routing: - $ref: '#/components/schemas/indices.stats:ShardRouting' + $ref: '#/components/schemas/indices.stats___ShardRouting' commit: - $ref: '#/components/schemas/indices.stats:ShardCommit' + $ref: '#/components/schemas/indices.stats___ShardCommit' seq_no: - $ref: '#/components/schemas/indices.stats:ShardSequenceNumber' + $ref: '#/components/schemas/indices.stats___ShardSequenceNumber' retention_leases: - $ref: '#/components/schemas/indices.stats:ShardRetentionLeases' + $ref: '#/components/schemas/indices.stats___ShardRetentionLeases' shard_path: - $ref: '#/components/schemas/indices.stats:ShardPath' - indices.stats:IndexStats: + $ref: '#/components/schemas/indices.stats___ShardPath' + indices.stats___IndexStats: allOf: - - $ref: '#/components/schemas/indices.stats:IndexStatsBase' + - $ref: '#/components/schemas/indices.stats___IndexStatsBase' - type: object - indices.stats:IndexStatsBase: + indices.stats___IndexStatsBase: type: object properties: docs: - $ref: '#/components/schemas/_common:DocStats' + $ref: '#/components/schemas/_common___DocStats' store: - $ref: '#/components/schemas/_common:StoreStats' + $ref: '#/components/schemas/_common___StoreStats' indexing: - $ref: '#/components/schemas/_common:IndexingStats' + $ref: '#/components/schemas/_common___IndexingStats' get: - $ref: '#/components/schemas/_common:GetStats' + $ref: '#/components/schemas/_common___GetStats' search: - $ref: '#/components/schemas/_common:SearchStats' + $ref: '#/components/schemas/_common___SearchStats' merges: - $ref: '#/components/schemas/_common:MergesStats' + $ref: '#/components/schemas/_common___MergesStats' refresh: - $ref: '#/components/schemas/_common:RefreshStats' + $ref: '#/components/schemas/_common___RefreshStats' flush: - $ref: '#/components/schemas/_common:FlushStats' + $ref: '#/components/schemas/_common___FlushStats' warmer: - $ref: '#/components/schemas/_common:WarmerStats' + $ref: '#/components/schemas/_common___WarmerStats' query_cache: - $ref: '#/components/schemas/_common:QueryCacheStats' + $ref: '#/components/schemas/_common___QueryCacheStats' fielddata: - $ref: '#/components/schemas/_common:FielddataStats' + $ref: '#/components/schemas/_common___FielddataStats' completion: - $ref: '#/components/schemas/_common:CompletionStats' + $ref: '#/components/schemas/_common___CompletionStats' segments: - $ref: '#/components/schemas/_common:SegmentsStats' + $ref: '#/components/schemas/_common___SegmentsStats' translog: - $ref: '#/components/schemas/_common:TranslogStats' + $ref: '#/components/schemas/_common___TranslogStats' request_cache: - $ref: '#/components/schemas/_common:RequestCacheStats' + $ref: '#/components/schemas/_common___RequestCacheStats' recovery: - $ref: '#/components/schemas/_common:RecoveryStats' - indices.stats:IndicesStats: + $ref: '#/components/schemas/_common___RecoveryStats' + indices.stats___IndicesStats: type: object properties: uuid: - $ref: '#/components/schemas/_common:Uuid' + $ref: '#/components/schemas/_common___Uuid' primaries: - $ref: '#/components/schemas/indices.stats:IndexStats' + $ref: '#/components/schemas/indices.stats___IndexStats' total: - $ref: '#/components/schemas/indices.stats:IndexStats' + $ref: '#/components/schemas/indices.stats___IndexStats' shards: type: object additionalProperties: type: array items: - $ref: '#/components/schemas/indices.stats:IndexShardStats' + $ref: '#/components/schemas/indices.stats___IndexShardStats' required: - primaries - total - uuid - indices.stats:Metric: + indices.stats___Metric: type: string enum: - _all @@ -49207,13 +50873,13 @@ components: - suggest - translog - warmer - indices.stats:ShardCommit: + indices.stats___ShardCommit: type: object properties: generation: type: number id: - $ref: '#/components/schemas/_common:Id' + $ref: '#/components/schemas/_common___Id' num_docs: type: number user_data: @@ -49225,33 +50891,33 @@ components: - id - num_docs - user_data - indices.stats:ShardFileSizeInfo: + indices.stats___ShardFileSizeInfo: type: object properties: description: type: string size: - $ref: '#/components/schemas/_common:HumanReadableByteCount' + $ref: '#/components/schemas/_common___HumanReadableByteCount' size_in_bytes: - $ref: '#/components/schemas/_common:ByteCount' + $ref: '#/components/schemas/_common___ByteCount' min_size_in_bytes: - $ref: '#/components/schemas/_common:ByteCount' + $ref: '#/components/schemas/_common___ByteCount' max_size_in_bytes: - $ref: '#/components/schemas/_common:ByteCount' + $ref: '#/components/schemas/_common___ByteCount' average_size_in_bytes: - $ref: '#/components/schemas/_common:ByteCount' + $ref: '#/components/schemas/_common___ByteCount' count: type: number required: - description - size_in_bytes - indices.stats:ShardLease: + indices.stats___ShardLease: type: object properties: id: - $ref: '#/components/schemas/_common:Id' + $ref: '#/components/schemas/_common___Id' retaining_seq_no: - $ref: '#/components/schemas/_common:SequenceNumber' + $ref: '#/components/schemas/_common___SequenceNumber' timestamp: type: number source: @@ -49261,7 +50927,7 @@ components: - retaining_seq_no - source - timestamp - indices.stats:ShardPath: + indices.stats___ShardPath: type: object properties: data_path: @@ -49274,22 +50940,22 @@ components: - data_path - is_custom_data_path - state_path - indices.stats:ShardRetentionLeases: + indices.stats___ShardRetentionLeases: type: object properties: primary_term: type: number version: - $ref: '#/components/schemas/_common:VersionNumber' + $ref: '#/components/schemas/_common___VersionNumber' leases: type: array items: - $ref: '#/components/schemas/indices.stats:ShardLease' + $ref: '#/components/schemas/indices.stats___ShardLease' required: - leases - primary_term - version - indices.stats:ShardRouting: + indices.stats___ShardRouting: type: object properties: node: @@ -49301,19 +50967,19 @@ components: - 'null' - string state: - $ref: '#/components/schemas/indices.stats:ShardRoutingState' + $ref: '#/components/schemas/indices.stats___ShardRoutingState' required: - node - primary - state - indices.stats:ShardRoutingState: + indices.stats___ShardRoutingState: type: string enum: - INITIALIZING - RELOCATING - STARTED - UNASSIGNED - indices.stats:ShardSequenceNumber: + indices.stats___ShardSequenceNumber: type: object properties: global_checkpoint: @@ -49321,44 +50987,44 @@ components: local_checkpoint: type: number max_seq_no: - $ref: '#/components/schemas/_common:SequenceNumber' + $ref: '#/components/schemas/_common___SequenceNumber' required: - global_checkpoint - local_checkpoint - max_seq_no - indices.update_aliases:Action: + indices.update_aliases___Action: type: object properties: add: - $ref: '#/components/schemas/indices.update_aliases:AddAction' + $ref: '#/components/schemas/indices.update_aliases___AddAction' remove: - $ref: '#/components/schemas/indices.update_aliases:RemoveAction' + $ref: '#/components/schemas/indices.update_aliases___RemoveAction' remove_index: - $ref: '#/components/schemas/indices.update_aliases:RemoveIndexAction' + $ref: '#/components/schemas/indices.update_aliases___RemoveIndexAction' minProperties: 1 maxProperties: 1 - indices.update_aliases:AddAction: + indices.update_aliases___AddAction: type: object properties: alias: - $ref: '#/components/schemas/_common:IndexAlias' + $ref: '#/components/schemas/_common___IndexAlias' aliases: description: |- Aliases for the action. Index alias names support date math. oneOf: - - $ref: '#/components/schemas/_common:IndexAlias' + - $ref: '#/components/schemas/_common___IndexAlias' - type: array items: - $ref: '#/components/schemas/_common:IndexAlias' + $ref: '#/components/schemas/_common___IndexAlias' filter: - $ref: '#/components/schemas/_common.query_dsl:QueryContainer' + $ref: '#/components/schemas/_common.query_dsl___QueryContainer' index: - $ref: '#/components/schemas/_common:IndexName' + $ref: '#/components/schemas/_common___IndexName' indices: - $ref: '#/components/schemas/_common:Indices' + $ref: '#/components/schemas/_common___Indices' index_routing: - $ref: '#/components/schemas/_common:Routing' + $ref: '#/components/schemas/_common___Routing' is_hidden: description: If `true`, the alias is hidden. type: boolean @@ -49366,44 +51032,44 @@ components: description: If `true`, sets the write index or data stream for the alias. type: boolean routing: - $ref: '#/components/schemas/_common:Routing' + $ref: '#/components/schemas/_common___Routing' search_routing: - $ref: '#/components/schemas/_common:Routing' + $ref: '#/components/schemas/_common___Routing' must_exist: description: If `true`, the alias must exist to perform the action. type: boolean - indices.update_aliases:RemoveAction: + indices.update_aliases___RemoveAction: type: object properties: alias: - $ref: '#/components/schemas/_common:IndexAlias' + $ref: '#/components/schemas/_common___IndexAlias' aliases: description: |- Aliases for the action. Index alias names support date math. oneOf: - - $ref: '#/components/schemas/_common:IndexAlias' + - $ref: '#/components/schemas/_common___IndexAlias' - type: array items: - $ref: '#/components/schemas/_common:IndexAlias' + $ref: '#/components/schemas/_common___IndexAlias' index: - $ref: '#/components/schemas/_common:IndexName' + $ref: '#/components/schemas/_common___IndexName' indices: - $ref: '#/components/schemas/_common:Indices' + $ref: '#/components/schemas/_common___Indices' must_exist: description: If `true`, the alias must exist to perform the action. type: boolean - indices.update_aliases:RemoveIndexAction: + indices.update_aliases___RemoveIndexAction: type: object properties: index: - $ref: '#/components/schemas/_common:IndexName' + $ref: '#/components/schemas/_common___IndexName' indices: - $ref: '#/components/schemas/_common:Indices' + $ref: '#/components/schemas/_common___Indices' must_exist: description: If `true`, the alias must exist to perform the action. type: boolean - indices.validate_query:IndicesValidationExplanation: + indices.validate_query___IndicesValidationExplanation: type: object properties: error: @@ -49411,19 +51077,19 @@ components: explanation: type: string index: - $ref: '#/components/schemas/_common:IndexName' + $ref: '#/components/schemas/_common___IndexName' valid: type: boolean required: - index - valid - ingest._common:AppendProcessor: + ingest._common___AppendProcessor: allOf: - - $ref: '#/components/schemas/ingest._common:ProcessorBase' + - $ref: '#/components/schemas/ingest._common___ProcessorBase' - type: object properties: field: - $ref: '#/components/schemas/_common:Field' + $ref: '#/components/schemas/_common___Field' value: description: The value to be appended. Supports template snippets. type: array @@ -49435,13 +51101,13 @@ components: required: - field - value - ingest._common:AttachmentProcessor: + ingest._common___AttachmentProcessor: allOf: - - $ref: '#/components/schemas/ingest._common:ProcessorBase' + - $ref: '#/components/schemas/ingest._common___ProcessorBase' - type: object properties: field: - $ref: '#/components/schemas/_common:Field' + $ref: '#/components/schemas/_common___Field' ignore_missing: description: If `true` and field does not exist, the processor quietly exits without modifying the document. type: boolean @@ -49451,7 +51117,7 @@ components: Use `-1` for no limit. type: number indexed_chars_field: - $ref: '#/components/schemas/_common:Field' + $ref: '#/components/schemas/_common___Field' properties: description: |- Array of properties to select to be stored. @@ -49460,7 +51126,7 @@ components: items: type: string target_field: - $ref: '#/components/schemas/_common:Field' + $ref: '#/components/schemas/_common___Field' resource_name: description: |- Field containing the name of the resource to decode. @@ -49468,59 +51134,59 @@ components: type: string required: - field - ingest._common:BytesProcessor: + ingest._common___BytesProcessor: allOf: - - $ref: '#/components/schemas/ingest._common:ProcessorBase' + - $ref: '#/components/schemas/ingest._common___ProcessorBase' - type: object properties: field: - $ref: '#/components/schemas/_common:Field' + $ref: '#/components/schemas/_common___Field' ignore_missing: description: If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. type: boolean target_field: - $ref: '#/components/schemas/_common:Field' + $ref: '#/components/schemas/_common___Field' required: - field - ingest._common:CircleProcessor: + ingest._common___CircleProcessor: allOf: - - $ref: '#/components/schemas/ingest._common:ProcessorBase' + - $ref: '#/components/schemas/ingest._common___ProcessorBase' - type: object properties: error_distance: description: The difference between the resulting inscribed distance from center to side and the circle's radius (measured in meters for `geo_shape`, unit-less for `shape`). type: number field: - $ref: '#/components/schemas/_common:Field' + $ref: '#/components/schemas/_common___Field' ignore_missing: description: If `true` and `field` does not exist, the processor quietly exits without modifying the document. type: boolean shape_type: - $ref: '#/components/schemas/ingest._common:ShapeType' + $ref: '#/components/schemas/ingest._common___ShapeType' target_field: - $ref: '#/components/schemas/_common:Field' + $ref: '#/components/schemas/_common___Field' required: - error_distance - field - shape_type - ingest._common:ConvertProcessor: + ingest._common___ConvertProcessor: allOf: - - $ref: '#/components/schemas/ingest._common:ProcessorBase' + - $ref: '#/components/schemas/ingest._common___ProcessorBase' - type: object properties: field: - $ref: '#/components/schemas/_common:Field' + $ref: '#/components/schemas/_common___Field' ignore_missing: description: If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. type: boolean target_field: - $ref: '#/components/schemas/_common:Field' + $ref: '#/components/schemas/_common___Field' type: - $ref: '#/components/schemas/ingest._common:ConvertType' + $ref: '#/components/schemas/ingest._common___ConvertType' required: - field - type - ingest._common:ConvertType: + ingest._common___ConvertType: type: string enum: - auto @@ -49530,9 +51196,9 @@ components: - integer - long - string - ingest._common:CsvProcessor: + ingest._common___CsvProcessor: allOf: - - $ref: '#/components/schemas/ingest._common:ProcessorBase' + - $ref: '#/components/schemas/ingest._common___ProcessorBase' - type: object properties: empty_value: @@ -49542,7 +51208,7 @@ components: An empty field is one with no value (2 consecutive separators) or empty quotes (`""`). type: object field: - $ref: '#/components/schemas/_common:Field' + $ref: '#/components/schemas/_common___Field' ignore_missing: description: If `true` and `field` does not exist, the processor quietly exits without modifying the document. type: boolean @@ -49553,22 +51219,22 @@ components: description: Separator used in CSV, has to be single character string. type: string target_fields: - $ref: '#/components/schemas/_common:Fields' + $ref: '#/components/schemas/_common___Fields' trim: - description: Trim whitespaces in unquoted fields. + description: Trim white spaces in unquoted fields. type: boolean required: - field - target_fields - ingest._common:DateIndexNameProcessor: + ingest._common___DateIndexNameProcessor: allOf: - - $ref: '#/components/schemas/ingest._common:ProcessorBase' + - $ref: '#/components/schemas/ingest._common___ProcessorBase' - type: object properties: date_formats: description: |- - An array of the expected date formats for parsing dates / timestamps in the document being preprocessed. - Can be a java time pattern or one of the following formats: ISO8601, UNIX, UNIX_MS, or TAI64N. + An array of the expected date formats for parsing dates/timestamps in the document being preprocessed. + Can be a java time pattern or one of the following formats: `ISO8601`, `UNIX`, `UNIX_MS`, or `TAI64N`. type: array items: type: string @@ -49579,7 +51245,7 @@ components: Supports template snippets. type: string field: - $ref: '#/components/schemas/_common:Field' + $ref: '#/components/schemas/_common___Field' index_name_format: description: |- The format to be used when printing the parsed date into the index name. @@ -49595,19 +51261,19 @@ components: description: The locale to use when parsing the date from the document being preprocessed, relevant when parsing month names or week days. type: string timezone: - description: The timezone to use when parsing the date and when date math index supports resolves expressions into concrete index names. + description: The time zone to use when parsing the date and when date math index supports resolves expressions into concrete index names. type: string required: - date_formats - date_rounding - field - ingest._common:DateProcessor: + ingest._common___DateProcessor: allOf: - - $ref: '#/components/schemas/ingest._common:ProcessorBase' + - $ref: '#/components/schemas/ingest._common___ProcessorBase' - type: object properties: field: - $ref: '#/components/schemas/_common:Field' + $ref: '#/components/schemas/_common___Field' formats: description: |- An array of the expected date formats. @@ -49621,25 +51287,25 @@ components: Supports template snippets. type: string target_field: - $ref: '#/components/schemas/_common:Field' + $ref: '#/components/schemas/_common___Field' timezone: description: |- - The timezone to use when parsing the date. + The time zone to use when parsing the date. Supports template snippets. type: string required: - field - formats - ingest._common:DissectProcessor: + ingest._common___DissectProcessor: allOf: - - $ref: '#/components/schemas/ingest._common:ProcessorBase' + - $ref: '#/components/schemas/ingest._common___ProcessorBase' - type: object properties: append_separator: description: The character(s) that separate the appended fields. type: string field: - $ref: '#/components/schemas/_common:Field' + $ref: '#/components/schemas/_common___Field' ignore_missing: description: If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. type: boolean @@ -49649,13 +51315,13 @@ components: required: - field - pattern - ingest._common:DotExpanderProcessor: + ingest._common___DotExpanderProcessor: allOf: - - $ref: '#/components/schemas/ingest._common:ProcessorBase' + - $ref: '#/components/schemas/ingest._common___ProcessorBase' - type: object properties: field: - $ref: '#/components/schemas/_common:Field' + $ref: '#/components/schemas/_common___Field' path: description: |- The field that contains the field to expand. @@ -49663,24 +51329,24 @@ components: type: string required: - field - ingest._common:DropProcessor: + ingest._common___DropProcessor: allOf: - - $ref: '#/components/schemas/ingest._common:ProcessorBase' + - $ref: '#/components/schemas/ingest._common___ProcessorBase' - type: object - ingest._common:EnrichProcessor: + ingest._common___EnrichProcessor: allOf: - - $ref: '#/components/schemas/ingest._common:ProcessorBase' + - $ref: '#/components/schemas/ingest._common___ProcessorBase' - type: object properties: field: - $ref: '#/components/schemas/_common:Field' + $ref: '#/components/schemas/_common___Field' ignore_missing: description: If `true` and `field` does not exist, the processor quietly exits without modifying the document. type: boolean max_matches: description: |- The maximum number of matched documents to include under the configured target field. - The `target_field` will be turned into a json array if `max_matches` is higher than 1, otherwise `target_field` will become a json object. + The `target_field` will be turned into a JSON array if `max_matches` is higher than 1, otherwise `target_field` will become a JSON object. In order to avoid documents getting too large, the maximum allowed value is 128. type: number override: @@ -49692,16 +51358,16 @@ components: description: The name of the enrich policy to use. type: string shape_relation: - $ref: '#/components/schemas/_common:GeoShapeRelation' + $ref: '#/components/schemas/_common___GeoShapeRelation' target_field: - $ref: '#/components/schemas/_common:Field' + $ref: '#/components/schemas/_common___Field' required: - field - policy_name - target_field - ingest._common:FailProcessor: + ingest._common___FailProcessor: allOf: - - $ref: '#/components/schemas/ingest._common:ProcessorBase' + - $ref: '#/components/schemas/ingest._common___ProcessorBase' - type: object properties: message: @@ -49711,31 +51377,31 @@ components: type: string required: - message - ingest._common:ForeachProcessor: + ingest._common___ForeachProcessor: allOf: - - $ref: '#/components/schemas/ingest._common:ProcessorBase' + - $ref: '#/components/schemas/ingest._common___ProcessorBase' - type: object properties: field: - $ref: '#/components/schemas/_common:Field' + $ref: '#/components/schemas/_common___Field' ignore_missing: description: If `true`, the processor silently exits without changing the document if the `field` is `null` or missing. type: boolean processor: - $ref: '#/components/schemas/ingest._common:ProcessorContainer' + $ref: '#/components/schemas/ingest._common___ProcessorContainer' required: - field - processor - ingest._common:GeoIpProcessor: + ingest._common___GeoIpProcessor: allOf: - - $ref: '#/components/schemas/ingest._common:ProcessorBase' + - $ref: '#/components/schemas/ingest._common___ProcessorBase' - type: object properties: database_file: - description: The database filename referring to a database the module ships with (GeoLite2-City.mmdb, GeoLite2-Country.mmdb, or GeoLite2-ASN.mmdb) or a custom database in the ingest-geoip config directory. + description: The database filename referring to a database the module ships with (`GeoLite2-City.mmdb`, `GeoLite2-Country.mmdb`, or `GeoLite2-ASN.mmdb`) or a custom database in the `ingest-geoip` config directory. type: string field: - $ref: '#/components/schemas/_common:Field' + $ref: '#/components/schemas/_common___Field' first_only: description: If `true`, only the first found geoip data will be returned, even if the field contains an array. type: boolean @@ -49748,16 +51414,16 @@ components: items: type: string target_field: - $ref: '#/components/schemas/_common:Field' + $ref: '#/components/schemas/_common___Field' required: - field - ingest._common:GrokProcessor: + ingest._common___GrokProcessor: allOf: - - $ref: '#/components/schemas/ingest._common:ProcessorBase' + - $ref: '#/components/schemas/ingest._common___ProcessorBase' - type: object properties: field: - $ref: '#/components/schemas/_common:Field' + $ref: '#/components/schemas/_common___Field' ignore_missing: description: If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. type: boolean @@ -49781,13 +51447,13 @@ components: required: - field - patterns - ingest._common:GsubProcessor: + ingest._common___GsubProcessor: allOf: - - $ref: '#/components/schemas/ingest._common:ProcessorBase' + - $ref: '#/components/schemas/ingest._common___ProcessorBase' - type: object properties: field: - $ref: '#/components/schemas/_common:Field' + $ref: '#/components/schemas/_common___Field' ignore_missing: description: If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. type: boolean @@ -49798,21 +51464,21 @@ components: description: The string to replace the matching patterns with. type: string target_field: - $ref: '#/components/schemas/_common:Field' + $ref: '#/components/schemas/_common___Field' required: - field - pattern - replacement - ingest._common:InferenceConfig: + ingest._common___InferenceConfig: type: object properties: regression: - $ref: '#/components/schemas/ingest._common:InferenceConfigRegression' + $ref: '#/components/schemas/ingest._common___InferenceConfigRegression' classification: - $ref: '#/components/schemas/ingest._common:InferenceConfigClassification' + $ref: '#/components/schemas/ingest._common___InferenceConfigClassification' minProperties: 1 maxProperties: 1 - ingest._common:InferenceConfigClassification: + ingest._common___InferenceConfigClassification: type: object properties: num_top_classes: @@ -49822,31 +51488,31 @@ components: description: Specifies the maximum number of feature importance values per document. type: number results_field: - $ref: '#/components/schemas/_common:Field' + $ref: '#/components/schemas/_common___Field' top_classes_results_field: - $ref: '#/components/schemas/_common:Field' + $ref: '#/components/schemas/_common___Field' prediction_field_type: description: |- Specifies the type of the predicted field to write. Valid values are: `string`, `number`, `boolean`. type: string - ingest._common:InferenceConfigRegression: + ingest._common___InferenceConfigRegression: type: object properties: results_field: - $ref: '#/components/schemas/_common:Field' + $ref: '#/components/schemas/_common___Field' num_top_feature_importance_values: description: Specifies the maximum number of feature importance values per document. type: number - ingest._common:InferenceProcessor: + ingest._common___InferenceProcessor: allOf: - - $ref: '#/components/schemas/ingest._common:ProcessorBase' + - $ref: '#/components/schemas/ingest._common___ProcessorBase' - type: object properties: model_id: - $ref: '#/components/schemas/_common:Id' + $ref: '#/components/schemas/_common___Id' target_field: - $ref: '#/components/schemas/_common:Field' + $ref: '#/components/schemas/_common___Field' field_map: description: |- Maps the document field names to the known field names of the model. @@ -49855,27 +51521,27 @@ components: additionalProperties: type: object inference_config: - $ref: '#/components/schemas/ingest._common:InferenceConfig' + $ref: '#/components/schemas/ingest._common___InferenceConfig' required: - model_id - ingest._common:JoinProcessor: + ingest._common___JoinProcessor: allOf: - - $ref: '#/components/schemas/ingest._common:ProcessorBase' + - $ref: '#/components/schemas/ingest._common___ProcessorBase' - type: object properties: field: - $ref: '#/components/schemas/_common:Field' + $ref: '#/components/schemas/_common___Field' separator: description: The separator character. type: string target_field: - $ref: '#/components/schemas/_common:Field' + $ref: '#/components/schemas/_common___Field' required: - field - separator - ingest._common:JsonProcessor: + ingest._common___JsonProcessor: allOf: - - $ref: '#/components/schemas/ingest._common:ProcessorBase' + - $ref: '#/components/schemas/ingest._common___ProcessorBase' - type: object properties: add_to_root: @@ -49884,26 +51550,26 @@ components: `target_field` must not be set when this option is chosen. type: boolean add_to_root_conflict_strategy: - $ref: '#/components/schemas/ingest._common:JsonProcessorConflictStrategy' + $ref: '#/components/schemas/ingest._common___JsonProcessorConflictStrategy' allow_duplicate_keys: description: |- When set to `true`, the JSON parser will not fail if the JSON contains duplicate keys. Instead, the last encountered value for any duplicate key wins. type: boolean field: - $ref: '#/components/schemas/_common:Field' + $ref: '#/components/schemas/_common___Field' target_field: - $ref: '#/components/schemas/_common:Field' + $ref: '#/components/schemas/_common___Field' required: - field - ingest._common:JsonProcessorConflictStrategy: + ingest._common___JsonProcessorConflictStrategy: type: string enum: - merge - replace - ingest._common:KeyValueProcessor: + ingest._common___KeyValueProcessor: allOf: - - $ref: '#/components/schemas/ingest._common:ProcessorBase' + - $ref: '#/components/schemas/ingest._common___ProcessorBase' - type: object properties: exclude_keys: @@ -49912,7 +51578,7 @@ components: items: type: string field: - $ref: '#/components/schemas/_common:Field' + $ref: '#/components/schemas/_common___Field' field_split: description: Regex pattern to use for splitting key-value pairs. type: string @@ -49933,7 +51599,7 @@ components: description: If `true`. strip brackets `()`, `<>`, `[]` as well as quotes `'` and `"` from extracted values. type: boolean target_field: - $ref: '#/components/schemas/_common:Field' + $ref: '#/components/schemas/_common___Field' trim_key: description: String of characters to trim from extracted keys. type: string @@ -49947,21 +51613,21 @@ components: - field - field_split - value_split - ingest._common:LowercaseProcessor: + ingest._common___LowercaseProcessor: allOf: - - $ref: '#/components/schemas/ingest._common:ProcessorBase' + - $ref: '#/components/schemas/ingest._common___ProcessorBase' - type: object properties: field: - $ref: '#/components/schemas/_common:Field' + $ref: '#/components/schemas/_common___Field' ignore_missing: description: If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. type: boolean target_field: - $ref: '#/components/schemas/_common:Field' + $ref: '#/components/schemas/_common___Field' required: - field - ingest._common:Pipeline: + ingest._common___Pipeline: type: object properties: description: @@ -49971,31 +51637,31 @@ components: description: Processors to run immediately after a processor failure. type: array items: - $ref: '#/components/schemas/ingest._common:ProcessorContainer' + $ref: '#/components/schemas/ingest._common___ProcessorContainer' processors: description: |- Processors used to perform transformations on documents before indexing. Processors run sequentially in the order specified. type: array items: - $ref: '#/components/schemas/ingest._common:ProcessorContainer' + $ref: '#/components/schemas/ingest._common___ProcessorContainer' version: - $ref: '#/components/schemas/_common:VersionNumber' + $ref: '#/components/schemas/_common___VersionNumber' _meta: - $ref: '#/components/schemas/_common:Metadata' - ingest._common:PipelineProcessor: + $ref: '#/components/schemas/_common___Metadata' + ingest._common___PipelineProcessor: allOf: - - $ref: '#/components/schemas/ingest._common:ProcessorBase' + - $ref: '#/components/schemas/ingest._common___ProcessorBase' - type: object properties: name: - $ref: '#/components/schemas/_common:Name' + $ref: '#/components/schemas/_common___Name' ignore_missing_pipeline: description: Whether to ignore missing pipelines instead of failing. type: boolean required: - name - ingest._common:ProcessorBase: + ingest._common___ProcessorBase: type: object properties: description: @@ -50013,123 +51679,123 @@ components: description: Handle failures for the processor. type: array items: - $ref: '#/components/schemas/ingest._common:ProcessorContainer' + $ref: '#/components/schemas/ingest._common___ProcessorContainer' tag: description: |- Identifier for the processor. Useful for debugging and metrics. type: string - ingest._common:ProcessorContainer: + ingest._common___ProcessorContainer: type: object properties: attachment: - $ref: '#/components/schemas/ingest._common:AttachmentProcessor' + $ref: '#/components/schemas/ingest._common___AttachmentProcessor' append: - $ref: '#/components/schemas/ingest._common:AppendProcessor' + $ref: '#/components/schemas/ingest._common___AppendProcessor' csv: - $ref: '#/components/schemas/ingest._common:CsvProcessor' + $ref: '#/components/schemas/ingest._common___CsvProcessor' convert: - $ref: '#/components/schemas/ingest._common:ConvertProcessor' + $ref: '#/components/schemas/ingest._common___ConvertProcessor' date: - $ref: '#/components/schemas/ingest._common:DateProcessor' + $ref: '#/components/schemas/ingest._common___DateProcessor' date_index_name: - $ref: '#/components/schemas/ingest._common:DateIndexNameProcessor' + $ref: '#/components/schemas/ingest._common___DateIndexNameProcessor' dot_expander: - $ref: '#/components/schemas/ingest._common:DotExpanderProcessor' + $ref: '#/components/schemas/ingest._common___DotExpanderProcessor' enrich: - $ref: '#/components/schemas/ingest._common:EnrichProcessor' + $ref: '#/components/schemas/ingest._common___EnrichProcessor' fail: - $ref: '#/components/schemas/ingest._common:FailProcessor' + $ref: '#/components/schemas/ingest._common___FailProcessor' foreach: - $ref: '#/components/schemas/ingest._common:ForeachProcessor' + $ref: '#/components/schemas/ingest._common___ForeachProcessor' json: - $ref: '#/components/schemas/ingest._common:JsonProcessor' + $ref: '#/components/schemas/ingest._common___JsonProcessor' user_agent: - $ref: '#/components/schemas/ingest._common:UserAgentProcessor' + $ref: '#/components/schemas/ingest._common___UserAgentProcessor' kv: - $ref: '#/components/schemas/ingest._common:KeyValueProcessor' + $ref: '#/components/schemas/ingest._common___KeyValueProcessor' geoip: - $ref: '#/components/schemas/ingest._common:GeoIpProcessor' + $ref: '#/components/schemas/ingest._common___GeoIpProcessor' grok: - $ref: '#/components/schemas/ingest._common:GrokProcessor' + $ref: '#/components/schemas/ingest._common___GrokProcessor' gsub: - $ref: '#/components/schemas/ingest._common:GsubProcessor' + $ref: '#/components/schemas/ingest._common___GsubProcessor' join: - $ref: '#/components/schemas/ingest._common:JoinProcessor' + $ref: '#/components/schemas/ingest._common___JoinProcessor' lowercase: - $ref: '#/components/schemas/ingest._common:LowercaseProcessor' + $ref: '#/components/schemas/ingest._common___LowercaseProcessor' remove: - $ref: '#/components/schemas/ingest._common:RemoveProcessor' + $ref: '#/components/schemas/ingest._common___RemoveProcessor' rename: - $ref: '#/components/schemas/ingest._common:RenameProcessor' + $ref: '#/components/schemas/ingest._common___RenameProcessor' script: - $ref: '#/components/schemas/_common:Script' + $ref: '#/components/schemas/_common___Script' set: - $ref: '#/components/schemas/ingest._common:SetProcessor' + $ref: '#/components/schemas/ingest._common___SetProcessor' sort: - $ref: '#/components/schemas/ingest._common:SortProcessor' + $ref: '#/components/schemas/ingest._common___SortProcessor' split: - $ref: '#/components/schemas/ingest._common:SplitProcessor' + $ref: '#/components/schemas/ingest._common___SplitProcessor' trim: - $ref: '#/components/schemas/ingest._common:TrimProcessor' + $ref: '#/components/schemas/ingest._common___TrimProcessor' uppercase: - $ref: '#/components/schemas/ingest._common:UppercaseProcessor' + $ref: '#/components/schemas/ingest._common___UppercaseProcessor' urldecode: - $ref: '#/components/schemas/ingest._common:UrlDecodeProcessor' + $ref: '#/components/schemas/ingest._common___UrlDecodeProcessor' bytes: - $ref: '#/components/schemas/ingest._common:BytesProcessor' + $ref: '#/components/schemas/ingest._common___BytesProcessor' dissect: - $ref: '#/components/schemas/ingest._common:DissectProcessor' + $ref: '#/components/schemas/ingest._common___DissectProcessor' set_security_user: - $ref: '#/components/schemas/ingest._common:SetSecurityUserProcessor' + $ref: '#/components/schemas/ingest._common___SetSecurityUserProcessor' pipeline: - $ref: '#/components/schemas/ingest._common:PipelineProcessor' + $ref: '#/components/schemas/ingest._common___PipelineProcessor' drop: - $ref: '#/components/schemas/ingest._common:DropProcessor' + $ref: '#/components/schemas/ingest._common___DropProcessor' circle: - $ref: '#/components/schemas/ingest._common:CircleProcessor' + $ref: '#/components/schemas/ingest._common___CircleProcessor' inference: - $ref: '#/components/schemas/ingest._common:InferenceProcessor' + $ref: '#/components/schemas/ingest._common___InferenceProcessor' text_embedding: - $ref: '#/components/schemas/ingest._common:TextEmbeddingProcessor' + $ref: '#/components/schemas/ingest._common___TextEmbeddingProcessor' minProperties: 1 maxProperties: 1 - ingest._common:RemoveProcessor: + ingest._common___RemoveProcessor: allOf: - - $ref: '#/components/schemas/ingest._common:ProcessorBase' + - $ref: '#/components/schemas/ingest._common___ProcessorBase' - type: object properties: field: - $ref: '#/components/schemas/_common:Fields' + $ref: '#/components/schemas/_common___Fields' ignore_missing: description: If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. type: boolean required: - field - ingest._common:RenameProcessor: + ingest._common___RenameProcessor: allOf: - - $ref: '#/components/schemas/ingest._common:ProcessorBase' + - $ref: '#/components/schemas/ingest._common___ProcessorBase' - type: object properties: field: - $ref: '#/components/schemas/_common:Field' + $ref: '#/components/schemas/_common___Field' ignore_missing: description: If `true` and `field` does not exist, the processor quietly exits without modifying the document. type: boolean target_field: - $ref: '#/components/schemas/_common:Field' + $ref: '#/components/schemas/_common___Field' required: - field - target_field - ingest._common:SetProcessor: + ingest._common___SetProcessor: allOf: - - $ref: '#/components/schemas/ingest._common:ProcessorBase' + - $ref: '#/components/schemas/ingest._common___ProcessorBase' - type: object properties: copy_from: - $ref: '#/components/schemas/_common:Field' + $ref: '#/components/schemas/_common___Field' field: - $ref: '#/components/schemas/_common:Field' + $ref: '#/components/schemas/_common___Field' ignore_empty_value: description: If `true` and `value` is a template snippet that evaluates to `null` or the empty string, the processor quietly exits without modifying the document. type: boolean @@ -50152,13 +51818,13 @@ components: type: object required: - field - ingest._common:SetSecurityUserProcessor: + ingest._common___SetSecurityUserProcessor: allOf: - - $ref: '#/components/schemas/ingest._common:ProcessorBase' + - $ref: '#/components/schemas/ingest._common___ProcessorBase' - type: object properties: field: - $ref: '#/components/schemas/_common:Field' + $ref: '#/components/schemas/_common___Field' properties: description: Controls what user related properties are added to the field. type: array @@ -50166,31 +51832,31 @@ components: type: string required: - field - ingest._common:ShapeType: + ingest._common___ShapeType: type: string enum: - geo_shape - shape - ingest._common:SortProcessor: + ingest._common___SortProcessor: allOf: - - $ref: '#/components/schemas/ingest._common:ProcessorBase' + - $ref: '#/components/schemas/ingest._common___ProcessorBase' - type: object properties: field: - $ref: '#/components/schemas/_common:Field' + $ref: '#/components/schemas/_common___Field' order: - $ref: '#/components/schemas/_common:SortOrder' + $ref: '#/components/schemas/_common___SortOrder' target_field: - $ref: '#/components/schemas/_common:Field' + $ref: '#/components/schemas/_common___Field' required: - field - ingest._common:SplitProcessor: + ingest._common___SplitProcessor: allOf: - - $ref: '#/components/schemas/ingest._common:ProcessorBase' + - $ref: '#/components/schemas/ingest._common___ProcessorBase' - type: object properties: field: - $ref: '#/components/schemas/_common:Field' + $ref: '#/components/schemas/_common___Field' ignore_missing: description: If `true` and `field` does not exist, the processor quietly exits without modifying the document. type: boolean @@ -50201,17 +51867,17 @@ components: description: A regex which matches the separator, for example, `,` or `\s+`. type: string target_field: - $ref: '#/components/schemas/_common:Field' + $ref: '#/components/schemas/_common___Field' required: - field - separator - ingest._common:TextEmbeddingProcessor: + ingest._common___TextEmbeddingProcessor: allOf: - - $ref: '#/components/schemas/ingest._common:ProcessorBase' + - $ref: '#/components/schemas/ingest._common___ProcessorBase' - type: object properties: model_id: - $ref: '#/components/schemas/_common:Id' + $ref: '#/components/schemas/_common___Id' field_map: description: Contains key-value pairs that specify the mapping of a text field to a vector field. type: object @@ -50223,70 +51889,70 @@ components: required: - field_map - model_id - ingest._common:TrimProcessor: + ingest._common___TrimProcessor: allOf: - - $ref: '#/components/schemas/ingest._common:ProcessorBase' + - $ref: '#/components/schemas/ingest._common___ProcessorBase' - type: object properties: field: - $ref: '#/components/schemas/_common:Field' + $ref: '#/components/schemas/_common___Field' ignore_missing: description: If `true` and `field` does not exist, the processor quietly exits without modifying the document. type: boolean target_field: - $ref: '#/components/schemas/_common:Field' + $ref: '#/components/schemas/_common___Field' required: - field - ingest._common:UppercaseProcessor: + ingest._common___UppercaseProcessor: allOf: - - $ref: '#/components/schemas/ingest._common:ProcessorBase' + - $ref: '#/components/schemas/ingest._common___ProcessorBase' - type: object properties: field: - $ref: '#/components/schemas/_common:Field' + $ref: '#/components/schemas/_common___Field' ignore_missing: description: If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. type: boolean target_field: - $ref: '#/components/schemas/_common:Field' + $ref: '#/components/schemas/_common___Field' required: - field - ingest._common:UrlDecodeProcessor: + ingest._common___UrlDecodeProcessor: allOf: - - $ref: '#/components/schemas/ingest._common:ProcessorBase' + - $ref: '#/components/schemas/ingest._common___ProcessorBase' - type: object properties: field: - $ref: '#/components/schemas/_common:Field' + $ref: '#/components/schemas/_common___Field' ignore_missing: description: If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. type: boolean target_field: - $ref: '#/components/schemas/_common:Field' + $ref: '#/components/schemas/_common___Field' required: - field - ingest._common:UserAgentProcessor: + ingest._common___UserAgentProcessor: allOf: - - $ref: '#/components/schemas/ingest._common:ProcessorBase' + - $ref: '#/components/schemas/ingest._common___ProcessorBase' - type: object properties: field: - $ref: '#/components/schemas/_common:Field' + $ref: '#/components/schemas/_common___Field' ignore_missing: description: If `true` and `field` does not exist, the processor quietly exits without modifying the document. type: boolean options: type: array items: - $ref: '#/components/schemas/ingest._common:UserAgentProperty' + $ref: '#/components/schemas/ingest._common___UserAgentProperty' regex_file: description: The name of the file in the `config/ingest-user-agent` directory containing the regular expressions for parsing the user agent string. Both the directory and the file have to be created before starting OpenSearch. If not specified, ingest-user-agent will use the `regexes.yaml` from uap-core it ships with. type: string target_field: - $ref: '#/components/schemas/_common:Field' + $ref: '#/components/schemas/_common___Field' required: - field - ingest._common:UserAgentProperty: + ingest._common___UserAgentProperty: type: string enum: - BUILD @@ -50299,117 +51965,335 @@ components: - OS_MINOR - OS_NAME - PATCH - ingest.simulate:Document: + ingest.simulate___Document: type: object properties: _id: - $ref: '#/components/schemas/_common:Id' + $ref: '#/components/schemas/_common___Id' _index: - $ref: '#/components/schemas/_common:IndexName' + $ref: '#/components/schemas/_common___IndexName' _source: description: JSON body for the document. type: object required: - _source - ingest.simulate:DocumentSimulation: + ingest.simulate___DocumentSimulation: type: object properties: _id: - $ref: '#/components/schemas/_common:Id' + $ref: '#/components/schemas/_common___Id' _index: - $ref: '#/components/schemas/_common:IndexName' + $ref: '#/components/schemas/_common___IndexName' _ingest: - $ref: '#/components/schemas/ingest.simulate:Ingest' + $ref: '#/components/schemas/ingest.simulate___Ingest' _routing: description: Value used to send the document to a specific primary shard. type: string _source: description: JSON body for the document. type: object - additionalProperties: - type: object + additionalProperties: true _version: - $ref: '#/components/schemas/_common:StringifiedVersionNumber' + $ref: '#/components/schemas/_common___StringifiedVersionNumber' _version_type: - $ref: '#/components/schemas/_common:VersionType' + $ref: '#/components/schemas/_common___VersionType' required: - _id - _index - _ingest - _source - ingest.simulate:Ingest: + ingest.simulate___Ingest: type: object properties: timestamp: - $ref: '#/components/schemas/_common:DateTime' + $ref: '#/components/schemas/_common___DateTime' pipeline: - $ref: '#/components/schemas/_common:Name' + $ref: '#/components/schemas/_common___Name' required: - timestamp - ingest.simulate:PipelineSimulation: + ingest.simulate___PipelineSimulation: type: object properties: doc: - $ref: '#/components/schemas/ingest.simulate:DocumentSimulation' + $ref: '#/components/schemas/ingest.simulate___DocumentSimulation' processor_results: type: array items: - $ref: '#/components/schemas/ingest.simulate:PipelineSimulation' + $ref: '#/components/schemas/ingest.simulate___PipelineSimulation' tag: type: string processor_type: type: string status: - $ref: '#/components/schemas/_common:ActionStatusOptions' - ism._common:Action: + $ref: '#/components/schemas/_common___ActionStatusOptions' + insights._common___Measurement: + type: object + properties: + number: + type: integer + count: + type: integer + aggregationType: + type: string + insights._common___Measurements: + type: object + properties: + latency: + type: object + $ref: '#/components/schemas/insights._common___Measurement' + cpu: + type: object + $ref: '#/components/schemas/insights._common___Measurement' + memory: + type: object + $ref: '#/components/schemas/insights._common___Measurement' + insights._common___Source: + type: object + properties: + aggregations: + description: Defines the aggregations that are run as part of the search request. + type: object + 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 indexes. + 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' + 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 indexes across multiple data tiers. + If set to `0` (default), the query does not terminate early. + type: integer + format: int32 + 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' + 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 indexes stats API. + type: array + items: + type: string + insights._common___TaskResourceUsage: + type: object + properties: + cpu_time_in_nanos: + type: integer + description: The CPU time used in nanoseconds. + memory_in_bytes: + type: integer + description: The memory usage in bytes. + insights._common___TaskResourceUsages: + type: object + properties: + action: + type: string + description: The action type of the task. + taskId: + type: integer + description: The task ID. + parentTaskId: + type: integer + description: The parent task ID. + nodeId: + type: string + description: The node ID where the task was executed. + taskResourceUsage: + type: object + $ref: '#/components/schemas/insights._common___TaskResourceUsage' + insights._common___TopQueriesResponse: + type: object + properties: + top_queries: + type: array + items: + type: object + $ref: '#/components/schemas/insights._common___TopQuery' + required: + - top_queries + insights._common___TopQuery: + type: object + properties: + timestamp: + type: integer + description: The timestamp of the query execution. + total_shards: + type: integer + description: The total number of shards involved in the query. + task_resource_usages: + type: array + items: + type: object + $ref: '#/components/schemas/insights._common___TaskResourceUsages' + query_hashcode: + type: string + description: The hash code of the query. + labels: + type: object + description: Additional labels for the query. + search_type: + type: string + description: The search query type (for example, `query_then_fetch`). + source: + type: object + $ref: '#/components/schemas/insights._common___Source' + node_id: + type: string + description: The node ID associated with the query. + indices: + type: array + items: + type: string + description: The indexes involved in the query. + phase_latency_map: + type: object + measurements: + type: object + $ref: '#/components/schemas/insights._common___Measurements' + ism._common___Action: type: object description: An action to perform. properties: timeout: - $ref: '#/components/schemas/ism._common:ActionTimeout' + $ref: '#/components/schemas/ism._common___ActionTimeout' retry: - $ref: '#/components/schemas/ism._common:ActionRetry' + $ref: '#/components/schemas/ism._common___ActionRetry' alias: - $ref: '#/components/schemas/ism._common:ActionAlias' + $ref: '#/components/schemas/ism._common___ActionAlias' delete: - $ref: '#/components/schemas/ism._common:ActionDelete' + $ref: '#/components/schemas/ism._common___ActionDelete' force_merge: - $ref: '#/components/schemas/ism._common:ActionForceMerge' + $ref: '#/components/schemas/ism._common___ActionForceMerge' read_only: - $ref: '#/components/schemas/ism._common:ActionReadOnly' + $ref: '#/components/schemas/ism._common___ActionReadOnly' read_write: - $ref: '#/components/schemas/ism._common:ActionReadWrite' + $ref: '#/components/schemas/ism._common___ActionReadWrite' replica_count: - $ref: '#/components/schemas/ism._common:ActionReplicaCount' + $ref: '#/components/schemas/ism._common___ActionReplicaCount' index_priority: - $ref: '#/components/schemas/ism._common:ActionIndexPriority' + $ref: '#/components/schemas/ism._common___ActionIndexPriority' close: - $ref: '#/components/schemas/ism._common:ActionClose' + $ref: '#/components/schemas/ism._common___ActionClose' open: - $ref: '#/components/schemas/ism._common:ActionOpen' + $ref: '#/components/schemas/ism._common___ActionOpen' snapshot: - $ref: '#/components/schemas/ism._common:ActionSnapshot' + $ref: '#/components/schemas/ism._common___ActionSnapshot' rollover: - $ref: '#/components/schemas/ism._common:ActionRollover' + $ref: '#/components/schemas/ism._common___ActionRollover' notification: - $ref: '#/components/schemas/ism._common:ActionNotification' + $ref: '#/components/schemas/ism._common___ActionNotification' allocation: - $ref: '#/components/schemas/ism._common:ActionAllocation' + $ref: '#/components/schemas/ism._common___ActionAllocation' rollup: - $ref: '#/components/schemas/ism._common:ActionRollup' + $ref: '#/components/schemas/ism._common___ActionRollup' transform: - $ref: '#/components/schemas/ism._common:ActionTransform' + $ref: '#/components/schemas/ism._common___ActionTransform' shrink: - $ref: '#/components/schemas/ism._common:ActionShrink' + $ref: '#/components/schemas/ism._common___ActionShrink' custom: - $ref: '#/components/schemas/ism._common:ActionCustom' - ism._common:ActionAlias: + $ref: '#/components/schemas/ism._common___ActionCustom' + ism._common___ActionAlias: type: object properties: actions: type: object additionalProperties: true - ism._common:ActionAllocation: + ism._common___ActionAllocation: type: object properties: require: @@ -50423,38 +52307,38 @@ components: additionalProperties: true wait_for: type: boolean - ism._common:ActionClose: + ism._common___ActionClose: type: object - ism._common:ActionCustom: + ism._common___ActionCustom: type: object additionalProperties: true - ism._common:ActionDelete: + ism._common___ActionDelete: type: object - ism._common:ActionForceMerge: + ism._common___ActionForceMerge: type: object properties: max_num_segments: type: integer - ism._common:ActionIndexPriority: + ism._common___ActionIndexPriority: type: object properties: priority: type: number - ism._common:ActionNotification: + ism._common___ActionNotification: type: object additionalProperties: true - ism._common:ActionOpen: + ism._common___ActionOpen: type: object - ism._common:ActionReadOnly: + ism._common___ActionReadOnly: type: object - ism._common:ActionReadWrite: + ism._common___ActionReadWrite: type: object - ism._common:ActionReplicaCount: + ism._common___ActionReplicaCount: type: object properties: number_of_replicas: type: number - ism._common:ActionRetry: + ism._common___ActionRetry: type: object properties: count: @@ -50463,7 +52347,7 @@ components: type: string delay: type: string - ism._common:ActionRollover: + ism._common___ActionRollover: type: object properties: min_size: @@ -50476,13 +52360,13 @@ components: type: number copy_alias: type: boolean - ism._common:ActionRollup: + ism._common___ActionRollup: type: object additionalProperties: true - ism._common:ActionShrink: + ism._common___ActionShrink: type: object additionalProperties: true - ism._common:ActionSnapshot: + ism._common___ActionSnapshot: type: object properties: repository: @@ -50491,24 +52375,24 @@ components: type: string include_global_state: type: boolean - ism._common:ActionTimeout: + ism._common___ActionTimeout: type: object properties: timeout: type: object - ism._common:ActionTransform: + ism._common___ActionTransform: type: object additionalProperties: true - ism._common:AddPolicyRequest: + ism._common___AddPolicyRequest: type: object properties: policy_id: type: string required: - policy_id - ism._common:AddPolicyResponse: - $ref: '#/components/schemas/ism._common:ChangePolicyResponse' - ism._common:ChangePolicyRequest: + ism._common___AddPolicyResponse: + $ref: '#/components/schemas/ism._common___ChangePolicyResponse' + ism._common___ChangePolicyRequest: type: object properties: policy_id: @@ -50518,12 +52402,12 @@ components: include: type: array items: - $ref: '#/components/schemas/ism._common:IncludeState' + $ref: '#/components/schemas/ism._common___IncludeState' required: - policy_id - ism._common:ChangePolicyResponse: - $ref: '#/components/schemas/ism._common:ChangeResponse' - ism._common:ChangeResponse: + ism._common___ChangePolicyResponse: + $ref: '#/components/schemas/ism._common___ChangeResponse' + ism._common___ChangeResponse: type: object properties: updated_indices: @@ -50533,30 +52417,30 @@ components: failed_indices: type: array items: - $ref: '#/components/schemas/ism._common:FailedIndex' - ism._common:Channel: + $ref: '#/components/schemas/ism._common___FailedIndex' + ism._common___Channel: type: object properties: id: type: string - ism._common:DeletePolicyResponse: - $ref: '#/components/schemas/_common:WriteResponseBase' - ism._common:ErrorNotification: + ism._common___DeletePolicyResponse: + $ref: '#/components/schemas/_common___WriteResponseBase' + ism._common___ErrorNotification: type: object properties: destination: - $ref: '#/components/schemas/ism._common:ErrorNotificationDestination' + $ref: '#/components/schemas/ism._common___ErrorNotificationDestination' channel: - $ref: '#/components/schemas/ism._common:Channel' + $ref: '#/components/schemas/ism._common___Channel' message_template: type: object additionalProperties: true - ism._common:ErrorNotificationChime: + ism._common___ErrorNotificationChime: type: object properties: url: type: string - ism._common:ErrorNotificationDestination: + ism._common___ErrorNotificationDestination: type: object properties: name: @@ -50565,23 +52449,23 @@ components: type: integer additionalProperties: anyOf: - - $ref: '#/components/schemas/ism._common:ErrorNotificationChime' - - $ref: '#/components/schemas/ism._common:ErrorNotificationSlack' - ism._common:ErrorNotificationSlack: + - $ref: '#/components/schemas/ism._common___ErrorNotificationChime' + - $ref: '#/components/schemas/ism._common___ErrorNotificationSlack' + ism._common___ErrorNotificationSlack: type: object properties: url: type: string custom_webhook: - $ref: '#/components/schemas/ism._common:SlackCustomWebhook' - ism._common:ExplainIndexResponse: + $ref: '#/components/schemas/ism._common___SlackCustomWebhook' + ism._common___ExplainIndexResponse: type: object properties: total_managed_indices: type: number additionalProperties: - $ref: '#/components/schemas/ism._common:ExplainPolicy' - ism._common:ExplainPolicy: + $ref: '#/components/schemas/ism._common___ExplainPolicy' + ism._common___ExplainPolicy: type: object properties: index.plugins.index_state_management.policy_id: @@ -50596,7 +52480,7 @@ components: type: - boolean - 'null' - ism._common:FailedIndex: + ism._common___FailedIndex: type: object properties: index_name: @@ -50605,7 +52489,7 @@ components: type: string reason: type: string - ism._common:GetPoliciesResponse: + ism._common___GetPoliciesResponse: type: object properties: total_policies: @@ -50613,15 +52497,15 @@ components: policies: type: array items: - $ref: '#/components/schemas/ism._common:PolicyWithMetadata' - ism._common:GetPolicyResponse: - $ref: '#/components/schemas/ism._common:PolicyWithMetadata' - ism._common:IncludeState: + $ref: '#/components/schemas/ism._common___PolicyWithMetadata' + ism._common___GetPolicyResponse: + $ref: '#/components/schemas/ism._common___PolicyWithMetadata' + ism._common___IncludeState: type: object properties: state: type: string - ism._common:IsmTemplate: + ism._common___IsmTemplate: type: object properties: index_patterns: @@ -50632,18 +52516,18 @@ components: type: number last_updated_time: type: integer - ism._common:Metadata: + ism._common___Metadata: type: object properties: _id: - $ref: '#/components/schemas/_common:Id' + $ref: '#/components/schemas/_common___Id' _primary_term: type: number _seq_no: - $ref: '#/components/schemas/_common:SequenceNumber' + $ref: '#/components/schemas/_common___SequenceNumber' _version: - $ref: '#/components/schemas/_common:VersionNumber' - ism._common:Policy: + $ref: '#/components/schemas/_common___VersionNumber' + ism._common___Policy: type: object description: A policy defines how an index is managed throughout its lifetime. properties: @@ -50657,7 +52541,7 @@ components: type: number error_notification: oneOf: - - $ref: '#/components/schemas/ism._common:ErrorNotification' + - $ref: '#/components/schemas/ism._common___ErrorNotification' - type: 'null' default_state: type: string @@ -50666,43 +52550,43 @@ components: type: array description: List of states for the index to transition between. items: - $ref: '#/components/schemas/ism._common:States' + $ref: '#/components/schemas/ism._common___States' ism_template: oneOf: - - $ref: '#/components/schemas/ism._common:IsmTemplate' + - $ref: '#/components/schemas/ism._common___IsmTemplate' - type: 'null' - type: array items: - $ref: '#/components/schemas/ism._common:IsmTemplate' - ism._common:PolicyEnvelope: + $ref: '#/components/schemas/ism._common___IsmTemplate' + ism._common___PolicyEnvelope: type: object properties: policy: - $ref: '#/components/schemas/ism._common:Policy' - ism._common:PolicyWithMetadata: + $ref: '#/components/schemas/ism._common___Policy' + ism._common___PolicyWithMetadata: type: object allOf: - - $ref: '#/components/schemas/ism._common:Metadata' - - $ref: '#/components/schemas/ism._common:PolicyEnvelope' - ism._common:PutPolicyRequest: - $ref: '#/components/schemas/ism._common:PolicyEnvelope' - ism._common:PutPolicyResponse: + - $ref: '#/components/schemas/ism._common___Metadata' + - $ref: '#/components/schemas/ism._common___PolicyEnvelope' + ism._common___PutPolicyRequest: + $ref: '#/components/schemas/ism._common___PolicyEnvelope' + ism._common___PutPolicyResponse: allOf: - - $ref: '#/components/schemas/ism._common:Metadata' + - $ref: '#/components/schemas/ism._common___Metadata' - type: object properties: policy: - $ref: '#/components/schemas/ism._common:PolicyEnvelope' - ism._common:RefreshSearchAnalyzersResponse: + $ref: '#/components/schemas/ism._common___PolicyEnvelope' + ism._common___RefreshSearchAnalyzersResponse: type: object properties: _shards: - $ref: '#/components/schemas/_common:ShardStatistics' + $ref: '#/components/schemas/_common___ShardStatistics' successful_refresh_details: type: array items: - $ref: '#/components/schemas/ism._common:RefreshSearchAnalyzersResponseDetails' - ism._common:RefreshSearchAnalyzersResponseDetails: + $ref: '#/components/schemas/ism._common___RefreshSearchAnalyzersResponseDetails' + ism._common___RefreshSearchAnalyzersResponseDetails: type: object properties: index: @@ -50711,18 +52595,18 @@ components: type: array items: type: string - ism._common:RemovePolicyResponse: - $ref: '#/components/schemas/ism._common:ChangePolicyResponse' - ism._common:RetryIndexRequest: + ism._common___RemovePolicyResponse: + $ref: '#/components/schemas/ism._common___ChangePolicyResponse' + ism._common___RetryIndexRequest: type: object properties: state: type: string required: - state - ism._common:RetryIndexResponse: - $ref: '#/components/schemas/ism._common:ChangeResponse' - ism._common:SlackCustomWebhook: + ism._common___RetryIndexResponse: + $ref: '#/components/schemas/ism._common___ChangeResponse' + ism._common___SlackCustomWebhook: type: object properties: url: @@ -50745,7 +52629,7 @@ components: type: string password: type: string - ism._common:States: + ism._common___States: type: object description: |- A list of actions to perform, and transitions to enter a new state. @@ -50760,13 +52644,13 @@ components: type: array description: A list of actions to perform. items: - $ref: '#/components/schemas/ism._common:Action' + $ref: '#/components/schemas/ism._common___Action' transitions: type: array description: A list of transitions to enter a new state. items: - $ref: '#/components/schemas/ism._common:Transition' - ism._common:Transition: + $ref: '#/components/schemas/ism._common___Transition' + ism._common___Transition: type: object description: A transition into a new state. properties: @@ -50775,26 +52659,26 @@ components: conditions: type: object additionalProperties: true - knn._common:DefaultOperator: + knn._common___DefaultOperator: type: string description: The default operator for query string query (AND or OR). enum: - AND - OR - knn._common:SearchType: + knn._common___SearchType: type: string description: Search operation type. enum: - dfs_query_then_fetch - query_then_fetch - knn._common:SuggestMode: + knn._common___SuggestMode: type: string description: Specify suggest mode. enum: - always - missing - popular - ml._common:Action: + ml._common___Action: type: object properties: action_type: @@ -50802,7 +52686,7 @@ components: method: type: string headers: - $ref: '#/components/schemas/ml._common:Headers' + $ref: '#/components/schemas/ml._common___Headers' url: type: string request_body: @@ -50811,7 +52695,7 @@ components: type: string post_process_function: type: string - ml._common:ClientConfig: + ml._common___ClientConfig: type: object properties: max_connection: @@ -50828,7 +52712,7 @@ components: type: integer retry_timeout_seconds: type: integer - ml._common:CreateConnectorRequest: + ml._common___CreateConnectorRequest: type: object properties: name: @@ -50840,15 +52724,15 @@ components: protocol: type: string credential: - $ref: '#/components/schemas/ml._common:Credential' + $ref: '#/components/schemas/ml._common___Credential' parameters: - $ref: '#/components/schemas/ml._common:Parameters' + $ref: '#/components/schemas/ml._common___Parameters' client_config: - $ref: '#/components/schemas/ml._common:ClientConfig' + $ref: '#/components/schemas/ml._common___ClientConfig' actions: type: array items: - $ref: '#/components/schemas/ml._common:Action' + $ref: '#/components/schemas/ml._common___Action' required: - actions - credential @@ -50857,7 +52741,7 @@ components: - parameters - protocol - version - ml._common:Credential: + ml._common___Credential: type: object properties: access_key: @@ -50867,17 +52751,18 @@ components: session_token: type: string additionalProperties: true - ml._common:Headers: + ml._common___Headers: type: object properties: content_type: type: string additionalProperties: true - ml._common:HitsTotal: + ml._common___HitsTotal: type: object properties: value: type: integer + format: int64 description: The total number of hits. relation: type: string @@ -50885,19 +52770,35 @@ components: required: - relation - value - ml._common:LLM: + ml._common___LLM: type: object properties: model_id: type: string parameters: - $ref: '#/components/schemas/ml._common:Parameters' - ml._common:Memory: + $ref: '#/components/schemas/ml._common___Parameters' + ml._common___Memory: type: object properties: type: type: string - ml._common:ModelGroup: + ml._common___ModelConfig: + type: object + properties: + all_config: + type: string + description: The all config. + model_type: + type: string + description: The model type. + embedding_dimension: + type: integer + format: int64 + description: The embedding dimension. + framework_type: + type: string + description: The framework type. + ml._common___ModelGroup: type: object properties: name: @@ -50923,7 +52824,7 @@ components: - description - latest_version - name - ml._common:ModelGroupRegistration: + ml._common___ModelGroupRegistration: type: object properties: model_group_id: @@ -50935,10 +52836,10 @@ components: required: - model_group_id - status - ml._common:Parameters: + ml._common___Parameters: type: object additionalProperties: true - ml._common:RegisterAgentsRequest: + ml._common___RegisterAgentsRequest: type: object properties: name: @@ -50950,46 +52851,59 @@ components: tools: type: array items: - $ref: '#/components/schemas/ml._common:ToolItems' + $ref: '#/components/schemas/ml._common___ToolItems' parameters: - $ref: '#/components/schemas/ml._common:Parameters' + $ref: '#/components/schemas/ml._common___Parameters' app_type: type: string memory: - $ref: '#/components/schemas/ml._common:Memory' + $ref: '#/components/schemas/ml._common___Memory' llm: - $ref: '#/components/schemas/ml._common:LLM' + $ref: '#/components/schemas/ml._common___LLM' required: - name - type - ml._common:SearchModelsHits: + ml._common___SearchModelsHits: type: object properties: total: - $ref: '#/components/schemas/ml._common:HitsTotal' + $ref: '#/components/schemas/ml._common___HitsTotal' hits: type: array items: - $ref: '#/components/schemas/ml._common:SearchModelsHitsHit' + $ref: '#/components/schemas/ml._common___SearchModelsHitsHit' + max_score: + type: number + format: float + description: The maximum score. required: - hits - total - ml._common:SearchModelsHitsHit: + ml._common___SearchModelsHitsHit: type: object properties: + _version: + $ref: '#/components/schemas/_common___VersionNumber' + _seq_no: + $ref: '#/components/schemas/_common___SequenceNumber' + _primary_term: + type: integer + description: The primary term. _index: - type: string - description: The index. + $ref: '#/components/schemas/_common___IndexName' _id: - type: string - description: The hit ID. + $ref: '#/components/schemas/_common___Id' + _score: + type: number + format: float + description: The score. + _source: + $ref: '#/components/schemas/ml._common___Source' model_id: - type: string - description: The model ID. + $ref: '#/components/schemas/_common___Name' required: - - _id - - model_id - ml._common:SearchModelsQuery: + - _score + ml._common___SearchModelsQuery: type: object properties: query: @@ -51001,14 +52915,119 @@ components: required: - query - size - ml._common:SearchModelsResponse: + ml._common___SearchModelsResponse: type: object properties: + took: + type: integer + description: The time taken to execute the search. + timed_out: + type: boolean + description: Whether the search timed out. + _shards: + $ref: '#/components/schemas/_common___ShardStatistics' hits: - $ref: '#/components/schemas/ml._common:SearchModelsHits' + $ref: '#/components/schemas/ml._common___SearchModelsHits' required: - hits - ml._common:Task: + ml._common___Source: + type: object + properties: + last_deployed_time: + type: integer + format: int64 + description: The last deployed time. + model_version: + type: string + description: The model version. + version: + $ref: '#/components/schemas/_common___VersionString' + created_time: + type: integer + format: int64 + description: The created time. + chunk_number: + type: integer + format: int64 + description: The chunk number. + deploy_to_all_nodes: + type: boolean + description: Whether to deploy to all nodes. + is_hidden: + type: boolean + description: Whether the model is hidden. + model_id: + $ref: '#/components/schemas/_common___Name' + description: + type: string + description: The model description. + model_state: + type: string + description: The model state. + enum: + - DEPLOYED + - DEPLOYING + - DEPLOY_FAILED + - PARTIALLY_DEPLOYED + - REGISTERED + - REGISTERING + model_content_size_in_bytes: + type: integer + format: int64 + description: The model content size in bytes. + model_content_hash_value: + type: string + description: The model content hash value. + planning_worker_node_count: + type: number + description: The planning worker node count. + model_config: + $ref: '#/components/schemas/ml._common___ModelConfig' + model_format: + type: string + description: The model format. + model_task_type: + type: string + description: The model task type. + last_updated_time: + type: integer + format: int64 + description: The last updated time. + last_registered_time: + type: integer + format: int64 + description: The last registered time. + auto_redeploy_retry_times: + type: integer + format: int64 + description: The auto redeploy retry times. + name: + type: string + description: The model name. + connector_id: + type: string + description: The connector ID. + current_worker_node_count: + type: number + description: The current worker node count. + model_group_id: + type: string + description: The model group ID. + planning_worker_nodes: + type: array + items: + $ref: '#/components/schemas/_common___NodeIds' + total_chunks: + type: integer + format: int64 + description: The total chunks. + algorithm: + type: string + description: The algorithm. + url: + type: string + description: The model URL. + ml._common___Task: type: object properties: model_id: @@ -51035,7 +53054,7 @@ components: worker_node: type: array items: - $ref: '#/components/schemas/_common:NodeIds' + $ref: '#/components/schemas/_common___NodeIds' create_time: type: integer format: int64 @@ -51048,7 +53067,7 @@ components: type: string required: - state - ml._common:ToolItems: + ml._common___ToolItems: type: object properties: name: @@ -51056,34 +53075,34 @@ components: type: type: string parameters: - $ref: '#/components/schemas/ml._common:Parameters' + $ref: '#/components/schemas/ml._common___Parameters' additionalProperties: true - ml._common:UndeployModelNode: + ml._common___UndeployModelNode: type: object properties: stats: - $ref: '#/components/schemas/ml._common:UndeployModelNodeStats' - ml._common:UndeployModelNodeStats: + $ref: '#/components/schemas/ml._common___UndeployModelNodeStats' + ml._common___UndeployModelNodeStats: type: object additionalProperties: true - ml._common:UndeployModelResponse: + ml._common___UndeployModelResponse: type: object additionalProperties: title: nodes - $ref: '#/components/schemas/ml._common:UndeployModelNode' - nodes._common:AdaptiveSelection: + $ref: '#/components/schemas/ml._common___UndeployModelNode' + nodes._common___AdaptiveSelection: type: object properties: avg_queue_size: description: The exponentially weighted moving average queue size of search requests on the keyed node. type: number avg_response_time: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' avg_response_time_ns: description: The exponentially weighted moving average response time, in nanoseconds, of search requests on the keyed node. type: number avg_service_time: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' avg_service_time_ns: description: The exponentially weighted moving average service time, in nanoseconds, of search requests on the keyed node. type: number @@ -51093,37 +53112,37 @@ components: rank: description: The rank of this node; used for shard selection when routing search requests. type: string - nodes._common:Breaker: + nodes._common___Breaker: type: object properties: estimated_size: description: Estimated memory used for the operation. - $ref: '#/components/schemas/_common:HumanReadableByteCount' + $ref: '#/components/schemas/_common___HumanReadableByteCount' estimated_size_in_bytes: description: Estimated memory used, in bytes, for the operation. - $ref: '#/components/schemas/_common:ByteCount' + $ref: '#/components/schemas/_common___ByteCount' limit_size: description: Memory limit for the circuit breaker. - $ref: '#/components/schemas/_common:HumanReadableByteCount' + $ref: '#/components/schemas/_common___HumanReadableByteCount' limit_size_in_bytes: description: Memory limit, in bytes, for the circuit breaker. - $ref: '#/components/schemas/_common:ByteCount' + $ref: '#/components/schemas/_common___ByteCount' overhead: description: A constant that all estimates for the circuit breaker are multiplied with to calculate a final estimate. type: number tripped: description: Total number of times the circuit breaker has been triggered and prevented an out of memory error. type: number - nodes._common:Cgroup: + nodes._common___Cgroup: type: object properties: cpuacct: - $ref: '#/components/schemas/nodes._common:CpuAcct' + $ref: '#/components/schemas/nodes._common___CpuAcct' cpu: - $ref: '#/components/schemas/nodes._common:CgroupCpu' + $ref: '#/components/schemas/nodes._common___CgroupCpu' memory: - $ref: '#/components/schemas/nodes._common:CgroupMemory' - nodes._common:CgroupCpu: + $ref: '#/components/schemas/nodes._common___CgroupMemory' + nodes._common___CgroupCpu: type: object properties: control_group: @@ -51136,8 +53155,8 @@ components: description: The total amount of time, in microseconds, for which all tasks in the same cgroup as the OpenSearch process can run during one period `cfs_period_micros`. type: number stat: - $ref: '#/components/schemas/nodes._common:CgroupCpuStat' - nodes._common:CgroupCpuStat: + $ref: '#/components/schemas/nodes._common___CgroupCpuStat' + nodes._common___CgroupCpuStat: type: object properties: number_of_elapsed_periods: @@ -51147,8 +53166,8 @@ components: description: The number of times all tasks in the same cgroup as the OpenSearch process have been throttled. type: number time_throttled_nanos: - $ref: '#/components/schemas/_common:DurationValueUnitNanos' - nodes._common:CgroupMemory: + $ref: '#/components/schemas/_common___DurationValueUnitNanos' + nodes._common___CgroupMemory: type: object properties: control_group: @@ -51165,7 +53184,7 @@ components: The total current memory usage by processes in the cgroup, in bytes, by all tasks in the same cgroup as the OpenSearch process. This value is stored as a string for consistency with `limit_in_bytes`. type: string - nodes._common:Client: + nodes._common___Client: type: object properties: id: @@ -51199,29 +53218,29 @@ components: type: number request_size_bytes: description: Cumulative size in bytes of all requests from this client. - $ref: '#/components/schemas/_common:ByteCount' + $ref: '#/components/schemas/_common___ByteCount' x_opaque_id: description: |- Value from the client's `x-opaque-id` HTTP header. If unavailable, this property is not included in the response. type: string - nodes._common:ClusterAppliedStats: + nodes._common___ClusterAppliedStats: type: object properties: recordings: type: array items: - $ref: '#/components/schemas/nodes._common:Recording' - nodes._common:ClusterStateOverallStats: + $ref: '#/components/schemas/nodes._common___Recording' + nodes._common___ClusterStateOverallStats: type: object properties: update_count: type: number total_time_in_millis: - $ref: '#/components/schemas/_common:DurationValueUnitMillis' + $ref: '#/components/schemas/_common___DurationValueUnitMillis' failed_count: type: number - nodes._common:ClusterStateQueue: + nodes._common___ClusterStateQueue: type: object properties: total: @@ -51233,48 +53252,48 @@ components: committed: description: Number of committed cluster states in queue. type: number - nodes._common:ClusterStateStats: + nodes._common___ClusterStateStats: type: object properties: overall: - $ref: '#/components/schemas/nodes._common:ClusterStateOverallStats' - nodes._common:ClusterStateUpdate: + $ref: '#/components/schemas/nodes._common___ClusterStateOverallStats' + nodes._common___ClusterStateUpdate: type: object properties: count: description: The number of cluster state update attempts that did not change the cluster state since the node started. type: number computation_time: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' computation_time_millis: - $ref: '#/components/schemas/_common:DurationValueUnitMillis' + $ref: '#/components/schemas/_common___DurationValueUnitMillis' publication_time: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' publication_time_millis: - $ref: '#/components/schemas/_common:DurationValueUnitMillis' + $ref: '#/components/schemas/_common___DurationValueUnitMillis' context_construction_time: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' context_construction_time_millis: - $ref: '#/components/schemas/_common:DurationValueUnitMillis' + $ref: '#/components/schemas/_common___DurationValueUnitMillis' commit_time: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' commit_time_millis: - $ref: '#/components/schemas/_common:DurationValueUnitMillis' + $ref: '#/components/schemas/_common___DurationValueUnitMillis' completion_time: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' completion_time_millis: - $ref: '#/components/schemas/_common:DurationValueUnitMillis' + $ref: '#/components/schemas/_common___DurationValueUnitMillis' master_apply_time: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' master_apply_time_millis: - $ref: '#/components/schemas/_common:DurationValueUnitMillis' + $ref: '#/components/schemas/_common___DurationValueUnitMillis' notification_time: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' notification_time_millis: - $ref: '#/components/schemas/_common:DurationValueUnitMillis' + $ref: '#/components/schemas/_common___DurationValueUnitMillis' required: - count - nodes._common:Context: + nodes._common___Context: type: object properties: context: @@ -51285,72 +53304,72 @@ components: type: number compilation_limit_triggered: type: number - nodes._common:Cpu: + nodes._common___Cpu: type: object properties: percent: - $ref: '#/components/schemas/_common:PercentageNumber' + $ref: '#/components/schemas/_common___PercentageNumber' sys: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' sys_in_millis: - $ref: '#/components/schemas/_common:DurationValueUnitMillis' + $ref: '#/components/schemas/_common___DurationValueUnitMillis' total: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' total_in_millis: - $ref: '#/components/schemas/_common:DurationValueUnitMillis' + $ref: '#/components/schemas/_common___DurationValueUnitMillis' user: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' user_in_millis: - $ref: '#/components/schemas/_common:DurationValueUnitMillis' + $ref: '#/components/schemas/_common___DurationValueUnitMillis' load_average: type: object additionalProperties: type: number - nodes._common:CpuAcct: + nodes._common___CpuAcct: type: object properties: control_group: description: The `cpuacct` control group to which the OpenSearch process belongs. type: string usage_nanos: - $ref: '#/components/schemas/_common:DurationValueUnitNanos' - nodes._common:DataPathStats: + $ref: '#/components/schemas/_common___DurationValueUnitNanos' + nodes._common___DataPathStats: type: object properties: available: description: Total amount of disk space available to this Java virtual machine on this file store. - $ref: '#/components/schemas/_common:HumanReadableByteCount' + $ref: '#/components/schemas/_common___HumanReadableByteCount' available_in_bytes: description: Total number of bytes available to this Java virtual machine on this file store. - $ref: '#/components/schemas/_common:ByteCount' + $ref: '#/components/schemas/_common___ByteCount' cache_reserved: x-version-added: '2.7' description: Total number of cache bytes reserved available to this Java virtual machine on this file store. - $ref: '#/components/schemas/_common:HumanReadableByteCount' + $ref: '#/components/schemas/_common___HumanReadableByteCount' cache_reserved_in_bytes: x-version-added: '2.7' description: Total number of cache bytes reserved available to this Java virtual machine on this file store. - $ref: '#/components/schemas/_common:ByteCount' + $ref: '#/components/schemas/_common___ByteCount' disk_queue: type: string disk_reads: type: number disk_read_size: - $ref: '#/components/schemas/_common:HumanReadableByteCount' + $ref: '#/components/schemas/_common___HumanReadableByteCount' disk_read_size_in_bytes: - $ref: '#/components/schemas/_common:ByteCount' + $ref: '#/components/schemas/_common___ByteCount' disk_writes: type: number disk_write_size: - $ref: '#/components/schemas/_common:HumanReadableByteCount' + $ref: '#/components/schemas/_common___HumanReadableByteCount' disk_write_size_in_bytes: - $ref: '#/components/schemas/_common:ByteCount' + $ref: '#/components/schemas/_common___ByteCount' free: description: Total amount of unallocated disk space in the file store. - $ref: '#/components/schemas/_common:HumanReadableByteCount' + $ref: '#/components/schemas/_common___HumanReadableByteCount' free_in_bytes: description: Total number of unallocated bytes in the file store. - $ref: '#/components/schemas/_common:ByteCount' + $ref: '#/components/schemas/_common___ByteCount' mount: description: 'Mount point of the file store (for example: `/dev/sda2`).' type: string @@ -51359,64 +53378,64 @@ components: type: string total: description: Total size of the file store. - $ref: '#/components/schemas/_common:HumanReadableByteCount' + $ref: '#/components/schemas/_common___HumanReadableByteCount' total_in_bytes: description: Total size of the file store in bytes. - $ref: '#/components/schemas/_common:ByteCount' + $ref: '#/components/schemas/_common___ByteCount' type: description: 'Type of the file store (ex: ext4).' type: string - nodes._common:Discovery: + nodes._common___Discovery: type: object properties: cluster_state_queue: - $ref: '#/components/schemas/nodes._common:ClusterStateQueue' + $ref: '#/components/schemas/nodes._common___ClusterStateQueue' cluster_state_stats: - $ref: '#/components/schemas/nodes._common:ClusterStateStats' + $ref: '#/components/schemas/nodes._common___ClusterStateStats' published_cluster_states: - $ref: '#/components/schemas/nodes._common:PublishedClusterStates' + $ref: '#/components/schemas/nodes._common___PublishedClusterStates' cluster_state_update: description: |- - Contains low-level statistics about how long various activities took during cluster state updates while the node was the elected master. - Omitted if the node is not master-eligible. + Contains low-level statistics about how long various activities took during cluster state updates while the node was the elected cluster manager. + Omitted if the node is not cluster-manager-eligible. Every field whose name ends in `_time` within this object is also represented as a raw number of milliseconds in a field whose name ends in `_time_millis`. The human-readable fields with a `_time` suffix are only returned if requested with the `?human=true` query parameter. type: object additionalProperties: - $ref: '#/components/schemas/nodes._common:ClusterStateUpdate' + $ref: '#/components/schemas/nodes._common___ClusterStateUpdate' serialized_cluster_states: - $ref: '#/components/schemas/nodes._common:SerializedClusterState' + $ref: '#/components/schemas/nodes._common___SerializedClusterState' cluster_applier_stats: - $ref: '#/components/schemas/nodes._common:ClusterAppliedStats' - nodes._common:ExtendedMemoryStats: + $ref: '#/components/schemas/nodes._common___ClusterAppliedStats' + nodes._common___ExtendedMemoryStats: allOf: - - $ref: '#/components/schemas/nodes._common:MemoryStats' + - $ref: '#/components/schemas/nodes._common___MemoryStats' - type: object properties: free_percent: description: Percentage of free memory. - $ref: '#/components/schemas/_common:PercentageNumber' + $ref: '#/components/schemas/_common___PercentageNumber' used_percent: description: Percentage of used memory. - $ref: '#/components/schemas/_common:PercentageNumber' - nodes._common:FileSystem: + $ref: '#/components/schemas/_common___PercentageNumber' + nodes._common___FileSystem: type: object properties: data: description: List of all file stores. type: array items: - $ref: '#/components/schemas/nodes._common:DataPathStats' + $ref: '#/components/schemas/nodes._common___DataPathStats' timestamp: description: |- Last time the file stores statistics were refreshed. Recorded in milliseconds since the Unix Epoch. type: number total: - $ref: '#/components/schemas/nodes._common:FileSystemTotal' + $ref: '#/components/schemas/nodes._common___FileSystemTotal' io_stats: - $ref: '#/components/schemas/nodes._common:IoStats' - nodes._common:FileSystemTotal: + $ref: '#/components/schemas/nodes._common___IoStats' + nodes._common___FileSystemTotal: type: object properties: available: @@ -51424,42 +53443,42 @@ components: Total disk space available to this Java virtual machine on all file stores. Depending on OS or process level restrictions, this might appear less than `free`. This is the actual amount of free disk space the OpenSearch node can utilize. - $ref: '#/components/schemas/_common:HumanReadableByteCount' + $ref: '#/components/schemas/_common___HumanReadableByteCount' available_in_bytes: description: |- Total number of bytes available to this Java virtual machine on all file stores. Depending on OS or process level restrictions, this might appear less than `free_in_bytes`. This is the actual amount of free disk space the OpenSearch node can utilize. - $ref: '#/components/schemas/_common:ByteCount' + $ref: '#/components/schemas/_common___ByteCount' free: description: Total unallocated disk space in all file stores. - $ref: '#/components/schemas/_common:HumanReadableByteCount' + $ref: '#/components/schemas/_common___HumanReadableByteCount' free_in_bytes: description: Total number of unallocated bytes in all file stores. - $ref: '#/components/schemas/_common:ByteCount' + $ref: '#/components/schemas/_common___ByteCount' total: description: Total size of all file stores. - $ref: '#/components/schemas/_common:HumanReadableByteCount' + $ref: '#/components/schemas/_common___HumanReadableByteCount' total_in_bytes: description: Total size of all file stores in bytes. - $ref: '#/components/schemas/_common:ByteCount' + $ref: '#/components/schemas/_common___ByteCount' cache_reserved: x-version-added: '2.7' description: Total size of cache bytes reserved in all file stores. - $ref: '#/components/schemas/_common:HumanReadableByteCount' + $ref: '#/components/schemas/_common___HumanReadableByteCount' cache_reserved_in_bytes: x-version-added: '2.7' description: Total size of cache bytes reserved in all file stores. - $ref: '#/components/schemas/_common:ByteCount' - nodes._common:GarbageCollector: + $ref: '#/components/schemas/_common___ByteCount' + nodes._common___GarbageCollector: type: object properties: collectors: description: Contains statistics about JVM garbage collectors for the node. type: object additionalProperties: - $ref: '#/components/schemas/nodes._common:GarbageCollectorTotal' - nodes._common:GarbageCollectorTotal: + $ref: '#/components/schemas/nodes._common___GarbageCollectorTotal' + nodes._common___GarbageCollectorTotal: type: object properties: collection_count: @@ -51471,7 +53490,7 @@ components: collection_time_in_millis: description: Total time, in milliseconds, spent by JVM collecting objects. type: number - nodes._common:Http: + nodes._common___Http: type: object properties: current_open: @@ -51486,37 +53505,37 @@ components: Clients that have been closed longer than the `http.client_stats.closed_channels.max_age` setting will not be represented here. type: array items: - $ref: '#/components/schemas/nodes._common:Client' - nodes._common:IndexingPressure: + $ref: '#/components/schemas/nodes._common___Client' + nodes._common___IndexingPressure: type: object properties: memory: - $ref: '#/components/schemas/nodes._common:IndexingPressureMemory' - nodes._common:IndexingPressureMemory: + $ref: '#/components/schemas/nodes._common___IndexingPressureMemory' + nodes._common___IndexingPressureMemory: type: object properties: limit: - $ref: '#/components/schemas/_common:HumanReadableByteCount' + $ref: '#/components/schemas/_common___HumanReadableByteCount' limit_in_bytes: description: |- Configured memory limit, in bytes, for the indexing requests. Replica requests have an automatic limit that is 1.5x this value. - $ref: '#/components/schemas/_common:ByteCount' + $ref: '#/components/schemas/_common___ByteCount' current: - $ref: '#/components/schemas/nodes._common:PressureMemory' + $ref: '#/components/schemas/nodes._common___PressureMemory' total: - $ref: '#/components/schemas/nodes._common:PressureMemory' - nodes._common:Ingest: + $ref: '#/components/schemas/nodes._common___PressureMemory' + nodes._common___Ingest: type: object properties: pipelines: description: Contains statistics about ingest pipelines for the node. type: object additionalProperties: - $ref: '#/components/schemas/nodes._common:IngestTotal' + $ref: '#/components/schemas/nodes._common___IngestTotal' total: - $ref: '#/components/schemas/nodes._common:IngestTotal' - nodes._common:IngestTotal: + $ref: '#/components/schemas/nodes._common___IngestTotal' + nodes._common___IngestTotal: type: object properties: count: @@ -51534,12 +53553,12 @@ components: items: type: object additionalProperties: - $ref: '#/components/schemas/nodes._common:KeyedProcessor' + $ref: '#/components/schemas/nodes._common___KeyedProcessor' time: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' time_in_millis: - $ref: '#/components/schemas/_common:DurationValueUnitMillis' - nodes._common:IoStatDevice: + $ref: '#/components/schemas/_common___DurationValueUnitMillis' + nodes._common___IoStatDevice: type: object properties: device_name: @@ -51567,8 +53586,8 @@ components: queue_size: type: number io_time_in_millis: - $ref: '#/components/schemas/_common:DurationValueUnitMillis' - nodes._common:IoStats: + $ref: '#/components/schemas/_common___DurationValueUnitMillis' + nodes._common___IoStats: type: object properties: devices: @@ -51577,25 +53596,25 @@ components: These disk metrics are probed periodically and averages between the last probe and the current probe are computed. type: array items: - $ref: '#/components/schemas/nodes._common:IoStatDevice' + $ref: '#/components/schemas/nodes._common___IoStatDevice' total: - $ref: '#/components/schemas/nodes._common:IoStatDevice' - nodes._common:Jvm: + $ref: '#/components/schemas/nodes._common___IoStatDevice' + nodes._common___Jvm: type: object properties: buffer_pools: description: Contains statistics about JVM buffer pools for the node. type: object additionalProperties: - $ref: '#/components/schemas/nodes._common:NodeBufferPool' + $ref: '#/components/schemas/nodes._common___NodeBufferPool' classes: - $ref: '#/components/schemas/nodes._common:JvmClasses' + $ref: '#/components/schemas/nodes._common___JvmClasses' gc: - $ref: '#/components/schemas/nodes._common:GarbageCollector' + $ref: '#/components/schemas/nodes._common___GarbageCollector' mem: - $ref: '#/components/schemas/nodes._common:JvmMemoryStats' + $ref: '#/components/schemas/nodes._common___JvmMemoryStats' threads: - $ref: '#/components/schemas/nodes._common:JvmThreads' + $ref: '#/components/schemas/nodes._common___JvmThreads' timestamp: description: Last time JVM statistics were refreshed. type: number @@ -51607,7 +53626,7 @@ components: uptime_in_millis: description: JVM uptime in milliseconds. type: number - nodes._common:JvmClasses: + nodes._common___JvmClasses: type: object properties: current_loaded_count: @@ -51619,48 +53638,48 @@ components: total_unloaded_count: description: Total number of classes unloaded since the JVM started. type: number - nodes._common:JvmMemoryStats: + nodes._common___JvmMemoryStats: type: object properties: heap_used: description: Memory currently in use by the heap. - $ref: '#/components/schemas/_common:HumanReadableByteCount' + $ref: '#/components/schemas/_common___HumanReadableByteCount' heap_used_in_bytes: description: Memory, in bytes, currently in use by the heap. - $ref: '#/components/schemas/_common:ByteCount' + $ref: '#/components/schemas/_common___ByteCount' heap_used_percent: description: Percentage of memory currently in use by the heap. - $ref: '#/components/schemas/_common:PercentageNumber' + $ref: '#/components/schemas/_common___PercentageNumber' heap_committed: description: Amount of memory available for use by the heap. - $ref: '#/components/schemas/_common:HumanReadableByteCount' + $ref: '#/components/schemas/_common___HumanReadableByteCount' heap_committed_in_bytes: description: Amount of memory, in bytes, available for use by the heap. - $ref: '#/components/schemas/_common:ByteCount' + $ref: '#/components/schemas/_common___ByteCount' heap_max: description: Maximum amount of memory available for use by the heap. - $ref: '#/components/schemas/_common:HumanReadableByteCount' + $ref: '#/components/schemas/_common___HumanReadableByteCount' heap_max_in_bytes: description: Maximum amount of memory, in bytes, available for use by the heap. - $ref: '#/components/schemas/_common:ByteCount' + $ref: '#/components/schemas/_common___ByteCount' non_heap_used: description: Non-heap memory used. - $ref: '#/components/schemas/_common:HumanReadableByteCount' + $ref: '#/components/schemas/_common___HumanReadableByteCount' non_heap_used_in_bytes: description: Non-heap memory used, in bytes. - $ref: '#/components/schemas/_common:ByteCount' + $ref: '#/components/schemas/_common___ByteCount' non_heap_committed: description: Amount of non-heap memory available. - $ref: '#/components/schemas/_common:HumanReadableByteCount' + $ref: '#/components/schemas/_common___HumanReadableByteCount' non_heap_committed_in_bytes: description: Amount of non-heap memory available, in bytes. - $ref: '#/components/schemas/_common:ByteCount' + $ref: '#/components/schemas/_common___ByteCount' pools: description: Contains statistics about heap memory usage for the node. type: object additionalProperties: - $ref: '#/components/schemas/nodes._common:Pool' - nodes._common:JvmThreads: + $ref: '#/components/schemas/nodes._common___Pool' + nodes._common___JvmThreads: type: object properties: count: @@ -51669,65 +53688,65 @@ components: peak_count: description: Highest number of threads used by JVM. type: number - nodes._common:KeyedProcessor: + nodes._common___KeyedProcessor: type: object properties: stats: - $ref: '#/components/schemas/nodes._common:Processor' + $ref: '#/components/schemas/nodes._common___Processor' type: type: string - nodes._common:LastGcStats: + nodes._common___LastGcStats: type: object properties: used: - $ref: '#/components/schemas/_common:HumanReadableByteCount' + $ref: '#/components/schemas/_common___HumanReadableByteCount' used_in_bytes: - $ref: '#/components/schemas/_common:ByteCount' + $ref: '#/components/schemas/_common___ByteCount' max: - $ref: '#/components/schemas/_common:HumanReadableByteCount' + $ref: '#/components/schemas/_common___HumanReadableByteCount' max_in_bytes: - $ref: '#/components/schemas/_common:ByteCount' + $ref: '#/components/schemas/_common___ByteCount' usage_percent: - $ref: '#/components/schemas/_common:PercentageNumber' - nodes._common:MemoryStats: + $ref: '#/components/schemas/_common___PercentageNumber' + nodes._common___MemoryStats: type: object properties: adjusted_total_in_bytes: description: |- If the amount of physical memory has been overridden using the `es`.`total_memory_bytes` system property then this reports the overridden value in bytes. Otherwise it reports the same value as `total_in_bytes`. - $ref: '#/components/schemas/_common:ByteCount' + $ref: '#/components/schemas/_common___ByteCount' resident: - $ref: '#/components/schemas/_common:HumanReadableByteCount' + $ref: '#/components/schemas/_common___HumanReadableByteCount' resident_in_bytes: - $ref: '#/components/schemas/_common:ByteCount' + $ref: '#/components/schemas/_common___ByteCount' share: - $ref: '#/components/schemas/_common:HumanReadableByteCount' + $ref: '#/components/schemas/_common___HumanReadableByteCount' share_in_bytes: - $ref: '#/components/schemas/_common:ByteCount' + $ref: '#/components/schemas/_common___ByteCount' total_virtual: - $ref: '#/components/schemas/_common:HumanReadableByteCount' + $ref: '#/components/schemas/_common___HumanReadableByteCount' total_virtual_in_bytes: - $ref: '#/components/schemas/_common:ByteCount' + $ref: '#/components/schemas/_common___ByteCount' total: description: Total amount of physical memory. - $ref: '#/components/schemas/_common:HumanReadableByteCount' + $ref: '#/components/schemas/_common___HumanReadableByteCount' total_in_bytes: description: Total amount of physical memory in bytes. - $ref: '#/components/schemas/_common:ByteCount' + $ref: '#/components/schemas/_common___ByteCount' free: description: Amount of free physical memory. - $ref: '#/components/schemas/_common:HumanReadableByteCount' + $ref: '#/components/schemas/_common___HumanReadableByteCount' free_in_bytes: description: Amount of free physical memory in bytes. - $ref: '#/components/schemas/_common:ByteCount' + $ref: '#/components/schemas/_common___ByteCount' used: description: Amount of used physical memory. - $ref: '#/components/schemas/_common:HumanReadableByteCount' + $ref: '#/components/schemas/_common___HumanReadableByteCount' used_in_bytes: description: Amount of used physical memory in bytes. - $ref: '#/components/schemas/_common:ByteCount' - nodes._common:NodeBufferPool: + $ref: '#/components/schemas/_common___ByteCount' + nodes._common___NodeBufferPool: type: object properties: count: @@ -51735,107 +53754,107 @@ components: type: number total_capacity: description: Total capacity of buffer pools. - $ref: '#/components/schemas/_common:HumanReadableByteCount' + $ref: '#/components/schemas/_common___HumanReadableByteCount' total_capacity_in_bytes: description: Total capacity of buffer pools in bytes. - $ref: '#/components/schemas/_common:ByteCount' + $ref: '#/components/schemas/_common___ByteCount' used: description: Size of buffer pools. - $ref: '#/components/schemas/_common:HumanReadableByteCount' + $ref: '#/components/schemas/_common___HumanReadableByteCount' used_in_bytes: description: Size of buffer pools in bytes. - $ref: '#/components/schemas/_common:ByteCount' - nodes._common:NodeReloadError: + $ref: '#/components/schemas/_common___ByteCount' + nodes._common___NodeReloadError: type: object properties: name: - $ref: '#/components/schemas/_common:Name' + $ref: '#/components/schemas/_common___Name' reload_exception: - $ref: '#/components/schemas/_common:ErrorCause' + $ref: '#/components/schemas/_common___ErrorCause' required: - name - nodes._common:NodeReloadResult: + nodes._common___NodeReloadResult: oneOf: - - $ref: '#/components/schemas/nodes._common:Stats' - - $ref: '#/components/schemas/nodes._common:NodeReloadError' - nodes._common:NodesResponseBase: + - $ref: '#/components/schemas/nodes._common___Stats' + - $ref: '#/components/schemas/nodes._common___NodeReloadError' + nodes._common___NodesResponseBase: type: object properties: _nodes: - $ref: '#/components/schemas/_common:NodeStatistics' - nodes._common:OperatingSystem: + $ref: '#/components/schemas/_common___NodeStatistics' + nodes._common___OperatingSystem: type: object properties: cpu: - $ref: '#/components/schemas/nodes._common:Cpu' + $ref: '#/components/schemas/nodes._common___Cpu' mem: - $ref: '#/components/schemas/nodes._common:ExtendedMemoryStats' + $ref: '#/components/schemas/nodes._common___ExtendedMemoryStats' swap: - $ref: '#/components/schemas/nodes._common:MemoryStats' + $ref: '#/components/schemas/nodes._common___MemoryStats' cgroup: - $ref: '#/components/schemas/nodes._common:Cgroup' + $ref: '#/components/schemas/nodes._common___Cgroup' timestamp: type: number - nodes._common:Pool: + nodes._common___Pool: type: object properties: used: description: Memory used by the heap. - $ref: '#/components/schemas/_common:HumanReadableByteCount' + $ref: '#/components/schemas/_common___HumanReadableByteCount' used_in_bytes: description: Memory, in bytes, used by the heap. - $ref: '#/components/schemas/_common:ByteCount' + $ref: '#/components/schemas/_common___ByteCount' max: description: Maximum amount of memory available for use by the heap. - $ref: '#/components/schemas/_common:HumanReadableByteCount' + $ref: '#/components/schemas/_common___HumanReadableByteCount' max_in_bytes: description: Maximum amount of memory, in bytes, available for use by the heap. - $ref: '#/components/schemas/_common:ByteCount' + $ref: '#/components/schemas/_common___ByteCount' peak_used: description: Largest amount of memory historically used by the heap. - $ref: '#/components/schemas/_common:HumanReadableByteCount' + $ref: '#/components/schemas/_common___HumanReadableByteCount' peak_used_in_bytes: description: Largest amount of memory, in bytes, historically used by the heap. - $ref: '#/components/schemas/_common:ByteCount' + $ref: '#/components/schemas/_common___ByteCount' peak_max: description: Largest amount of memory historically used by the heap. - $ref: '#/components/schemas/_common:HumanReadableByteCount' + $ref: '#/components/schemas/_common___HumanReadableByteCount' peak_max_in_bytes: description: Largest amount of memory, in bytes, historically used by the heap. - $ref: '#/components/schemas/_common:ByteCount' + $ref: '#/components/schemas/_common___ByteCount' last_gc_stats: description: Most recent GC cycle stats for a particular memory pool. - $ref: '#/components/schemas/nodes._common:LastGcStats' - nodes._common:PressureMemory: + $ref: '#/components/schemas/nodes._common___LastGcStats' + nodes._common___PressureMemory: type: object properties: all: - $ref: '#/components/schemas/_common:HumanReadableByteCount' + $ref: '#/components/schemas/_common___HumanReadableByteCount' all_in_bytes: description: Memory consumed, in bytes, by indexing requests in the coordinating, primary, or replica stage. - $ref: '#/components/schemas/_common:ByteCount' + $ref: '#/components/schemas/_common___ByteCount' combined_coordinating_and_primary: - $ref: '#/components/schemas/_common:HumanReadableByteCount' + $ref: '#/components/schemas/_common___HumanReadableByteCount' combined_coordinating_and_primary_in_bytes: description: |- Memory consumed, in bytes, by indexing requests in the coordinating or primary stage. This value is not the sum of coordinating and primary as a node can reuse the coordinating memory if the primary stage is executed locally. - $ref: '#/components/schemas/_common:ByteCount' + $ref: '#/components/schemas/_common___ByteCount' coordinating: - $ref: '#/components/schemas/_common:HumanReadableByteCount' + $ref: '#/components/schemas/_common___HumanReadableByteCount' coordinating_in_bytes: description: Memory consumed, in bytes, by indexing requests in the coordinating stage. - $ref: '#/components/schemas/_common:ByteCount' + $ref: '#/components/schemas/_common___ByteCount' primary: - $ref: '#/components/schemas/_common:HumanReadableByteCount' + $ref: '#/components/schemas/_common___HumanReadableByteCount' primary_in_bytes: description: Memory consumed, in bytes, by indexing requests in the primary stage. - $ref: '#/components/schemas/_common:ByteCount' + $ref: '#/components/schemas/_common___ByteCount' replica: - $ref: '#/components/schemas/_common:HumanReadableByteCount' + $ref: '#/components/schemas/_common___HumanReadableByteCount' replica_in_bytes: description: Memory consumed, in bytes, by indexing requests in the replica stage. - $ref: '#/components/schemas/_common:ByteCount' + $ref: '#/components/schemas/_common___ByteCount' coordinating_rejections: description: Number of indexing requests rejected in the coordinating stage. type: number @@ -51845,13 +53864,13 @@ components: replica_rejections: description: Number of indexing requests rejected in the replica stage. type: number - nodes._common:Process: + nodes._common___Process: type: object properties: cpu: - $ref: '#/components/schemas/nodes._common:Cpu' + $ref: '#/components/schemas/nodes._common___Cpu' mem: - $ref: '#/components/schemas/nodes._common:MemoryStats' + $ref: '#/components/schemas/nodes._common___MemoryStats' open_file_descriptors: description: Number of opened file descriptors associated with the current or `-1` if not supported. type: number @@ -51863,7 +53882,7 @@ components: Last time the statistics were refreshed. Recorded in milliseconds since the Unix Epoch. type: number - nodes._common:Processor: + nodes._common___Processor: type: object properties: count: @@ -51876,10 +53895,10 @@ components: description: Number of failed operations for the processor. type: number time: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' time_in_millis: - $ref: '#/components/schemas/_common:DurationValueUnitMillis' - nodes._common:PublishedClusterStates: + $ref: '#/components/schemas/_common___DurationValueUnitMillis' + nodes._common___PublishedClusterStates: type: object properties: full_states: @@ -51891,7 +53910,7 @@ components: compatible_diffs: description: Number of compatible differences between published cluster states. type: number - nodes._common:Recording: + nodes._common___Recording: type: object properties: name: @@ -51899,17 +53918,23 @@ components: cumulative_execution_count: type: number cumulative_execution_time: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' cumulative_execution_time_millis: - $ref: '#/components/schemas/_common:DurationValueUnitMillis' - nodes._common:SampleType: + $ref: '#/components/schemas/_common___DurationValueUnitMillis' + nodes._common___RemoteStoreStats: + type: object + properties: + last_successful_fetch_of_pinned_timestamps: + description: Timestamp for the last successful fetch of pinned timestamps. + $ref: '#/components/schemas/_common___StringifiedEpochTimeUnitSeconds' + nodes._common___SampleType: type: string description: The type to sample. enum: - block - cpu - wait - nodes._common:ScriptCache: + nodes._common___ScriptCache: type: object properties: cache_evictions: @@ -51923,7 +53948,7 @@ components: type: number context: type: string - nodes._common:Scripting: + nodes._common___Scripting: type: object properties: cache_evictions: @@ -51943,45 +53968,45 @@ components: contexts: type: array items: - $ref: '#/components/schemas/nodes._common:Context' - nodes._common:SerializedClusterState: + $ref: '#/components/schemas/nodes._common___Context' + nodes._common___SerializedClusterState: type: object properties: full_states: - $ref: '#/components/schemas/nodes._common:SerializedClusterStateDetail' + $ref: '#/components/schemas/nodes._common___SerializedClusterStateDetail' diffs: - $ref: '#/components/schemas/nodes._common:SerializedClusterStateDetail' - nodes._common:SerializedClusterStateDetail: + $ref: '#/components/schemas/nodes._common___SerializedClusterStateDetail' + nodes._common___SerializedClusterStateDetail: type: object properties: count: type: number uncompressed_size: - $ref: '#/components/schemas/_common:HumanReadableByteCount' + $ref: '#/components/schemas/_common___HumanReadableByteCount' uncompressed_size_in_bytes: - $ref: '#/components/schemas/_common:ByteCount' + $ref: '#/components/schemas/_common___ByteCount' compressed_size: - $ref: '#/components/schemas/_common:HumanReadableByteCount' + $ref: '#/components/schemas/_common___HumanReadableByteCount' compressed_size_in_bytes: - $ref: '#/components/schemas/_common:ByteCount' - nodes._common:ShardAdmissionControlStats: + $ref: '#/components/schemas/_common___ByteCount' + nodes._common___ShardAdmissionControlStats: type: object properties: global_io_usage: - $ref: '#/components/schemas/nodes._common:UsageStats' + $ref: '#/components/schemas/nodes._common___UsageStats' global_cpu_usage: - $ref: '#/components/schemas/nodes._common:UsageStats' - nodes._common:ShardCachesStats: + $ref: '#/components/schemas/nodes._common___UsageStats' + nodes._common___ShardCachesStats: type: object additionalProperties: - $ref: '#/components/schemas/nodes._common:ShardCacheStats' - nodes._common:ShardCacheStats: + $ref: '#/components/schemas/nodes._common___ShardCacheStats' + nodes._common___ShardCacheStats: type: object properties: size: - $ref: '#/components/schemas/_common:HumanReadableByteCount' + $ref: '#/components/schemas/_common___HumanReadableByteCount' size_in_bytes: - $ref: '#/components/schemas/_common:ByteCount' + $ref: '#/components/schemas/_common___ByteCount' evictions: type: number hit_count: @@ -51992,19 +54017,19 @@ components: type: number store_name: type: string - nodes._common:ShardClusterManagerThrottlingStats: + nodes._common___ShardClusterManagerThrottlingStats: type: object properties: stats: - $ref: '#/components/schemas/nodes._common:ShardClusterManagerThrottlingStatsDetail' - nodes._common:ShardClusterManagerThrottlingStatsDetail: + $ref: '#/components/schemas/nodes._common___ShardClusterManagerThrottlingStatsDetail' + nodes._common___ShardClusterManagerThrottlingStatsDetail: type: object properties: total_throttled_tasks: type: number throttled_tasks_per_task_type: type: object - nodes._common:ShardIndexingPressureStats: + nodes._common___ShardIndexingPressureStats: type: object properties: stats: @@ -52014,47 +54039,47 @@ components: enforced: type: boolean total_rejections_breakup: - $ref: '#/components/schemas/nodes._common:TotalRejectionsBreakup' + $ref: '#/components/schemas/nodes._common___TotalRejectionsBreakup' total_rejections_breakup_shadow_mode: - $ref: '#/components/schemas/nodes._common:TotalRejectionsBreakup' - nodes._common:ShardRepositoriesStats: + $ref: '#/components/schemas/nodes._common___TotalRejectionsBreakup' + nodes._common___ShardRepositoriesStats: type: array - nodes._common:ShardResourceUsageStats: + nodes._common___ShardResourceUsageStats: type: object additionalProperties: - $ref: '#/components/schemas/nodes._common:ShardResourceUsageStatsDetail' - nodes._common:ShardResourceUsageStatsDetail: + $ref: '#/components/schemas/nodes._common___ShardResourceUsageStatsDetail' + nodes._common___ShardResourceUsageStatsDetail: type: object properties: timestamp: type: number cpu_utilization_percent: - $ref: '#/components/schemas/_common:PercentageString' + $ref: '#/components/schemas/_common___PercentageString' memory_utilization_percent: - $ref: '#/components/schemas/_common:PercentageString' + $ref: '#/components/schemas/_common___PercentageString' io_usage_stats: - $ref: '#/components/schemas/nodes._common:ShardResourceUsageStatsIoUsageStats' - nodes._common:ShardResourceUsageStatsIoUsageStats: + $ref: '#/components/schemas/nodes._common___ShardResourceUsageStatsIoUsageStats' + nodes._common___ShardResourceUsageStatsIoUsageStats: type: object properties: max_io_utilization_percent: - $ref: '#/components/schemas/_common:PercentageString' - nodes._common:ShardSearchBackpressureMode: + $ref: '#/components/schemas/_common___PercentageString' + nodes._common___ShardSearchBackpressureMode: type: string enum: - disabled - enforced - monitor_only - nodes._common:ShardSearchBackpressureStats: + nodes._common___ShardSearchBackpressureStats: type: object properties: search_task: - $ref: '#/components/schemas/nodes._common:ShardSearchBackpressureTaskStats' + $ref: '#/components/schemas/nodes._common___ShardSearchBackpressureTaskStats' search_shard_task: - $ref: '#/components/schemas/nodes._common:ShardSearchBackpressureTaskStats' + $ref: '#/components/schemas/nodes._common___ShardSearchBackpressureTaskStats' mode: - $ref: '#/components/schemas/nodes._common:ShardSearchBackpressureMode' - nodes._common:ShardSearchBackpressureTaskCancellationStats: + $ref: '#/components/schemas/nodes._common___ShardSearchBackpressureMode' + nodes._common___ShardSearchBackpressureTaskCancellationStats: type: object properties: cancellation_count: @@ -52062,213 +54087,215 @@ components: cancellation_limit_reached_count: type: number cancelled_task_percentage: - $ref: '#/components/schemas/_common:PercentageNumber' + $ref: '#/components/schemas/_common___PercentageNumber' current_cancellation_eligible_tasks_count: type: number - nodes._common:ShardSearchBackpressureTaskResourceTrackerCpuUsageTrackerStats: + nodes._common___ShardSearchBackpressureTaskResourceTrackerCpuUsageTrackerStats: type: object properties: cancellation_count: type: number current_max: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' current_max_millis: - $ref: '#/components/schemas/_common:DurationValueUnitMillis' + $ref: '#/components/schemas/_common___DurationValueUnitMillis' current_avg: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' current_avg_millis: - $ref: '#/components/schemas/_common:DurationValueUnitMillis' - nodes._common:ShardSearchBackpressureTaskResourceTrackerElapsedTimeTrackerStats: + $ref: '#/components/schemas/_common___DurationValueUnitMillis' + nodes._common___ShardSearchBackpressureTaskResourceTrackerElapsedTimeTrackerStats: type: object properties: cancellation_count: type: number current_max: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' current_max_millis: - $ref: '#/components/schemas/_common:DurationValueUnitMillis' + $ref: '#/components/schemas/_common___DurationValueUnitMillis' current_avg: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' current_avg_millis: - $ref: '#/components/schemas/_common:DurationValueUnitMillis' - nodes._common:ShardSearchBackpressureTaskResourceTrackerHeapUsageTrackerStats: + $ref: '#/components/schemas/_common___DurationValueUnitMillis' + nodes._common___ShardSearchBackpressureTaskResourceTrackerHeapUsageTrackerStats: type: object properties: cancellation_count: type: number current_max: - $ref: '#/components/schemas/_common:HumanReadableByteCount' + $ref: '#/components/schemas/_common___HumanReadableByteCount' current_max_bytes: - $ref: '#/components/schemas/_common:ByteCount' + $ref: '#/components/schemas/_common___ByteCount' current_avg: - $ref: '#/components/schemas/_common:HumanReadableByteCount' + $ref: '#/components/schemas/_common___HumanReadableByteCount' current_avg_bytes: - $ref: '#/components/schemas/_common:ByteCount' + $ref: '#/components/schemas/_common___ByteCount' rolling_avg: - $ref: '#/components/schemas/_common:HumanReadableByteCount' + $ref: '#/components/schemas/_common___HumanReadableByteCount' rolling_avg_bytes: - $ref: '#/components/schemas/_common:ByteCount' - nodes._common:ShardSearchBackpressureTaskResourceTrackerStats: + $ref: '#/components/schemas/_common___ByteCount' + nodes._common___ShardSearchBackpressureTaskResourceTrackerStats: type: object properties: heap_usage_tracker: - $ref: '#/components/schemas/nodes._common:ShardSearchBackpressureTaskResourceTrackerHeapUsageTrackerStats' + $ref: '#/components/schemas/nodes._common___ShardSearchBackpressureTaskResourceTrackerHeapUsageTrackerStats' elapsed_time_tracker: - $ref: '#/components/schemas/nodes._common:ShardSearchBackpressureTaskResourceTrackerElapsedTimeTrackerStats' + $ref: '#/components/schemas/nodes._common___ShardSearchBackpressureTaskResourceTrackerElapsedTimeTrackerStats' cpu_usage_tracker: - $ref: '#/components/schemas/nodes._common:ShardSearchBackpressureTaskResourceTrackerCpuUsageTrackerStats' - nodes._common:ShardSearchBackpressureTaskStats: + $ref: '#/components/schemas/nodes._common___ShardSearchBackpressureTaskResourceTrackerCpuUsageTrackerStats' + nodes._common___ShardSearchBackpressureTaskStats: type: object properties: resource_tracker_stats: - $ref: '#/components/schemas/nodes._common:ShardSearchBackpressureTaskResourceTrackerStats' + $ref: '#/components/schemas/nodes._common___ShardSearchBackpressureTaskResourceTrackerStats' cancellation_stats: - $ref: '#/components/schemas/nodes._common:ShardSearchBackpressureTaskCancellationStats' + $ref: '#/components/schemas/nodes._common___ShardSearchBackpressureTaskCancellationStats' completion_count: x-version-added: '3.0' type: number - nodes._common:ShardSearchPipelineStats: + nodes._common___ShardSearchPipelineStats: type: object properties: total_request: - $ref: '#/components/schemas/nodes._common:ShardSearchPipelineTotalStats' + $ref: '#/components/schemas/nodes._common___ShardSearchPipelineTotalStats' total_response: - $ref: '#/components/schemas/nodes._common:ShardSearchPipelineTotalStats' + $ref: '#/components/schemas/nodes._common___ShardSearchPipelineTotalStats' pipelines: type: object - nodes._common:ShardSearchPipelineTotalStats: + nodes._common___ShardSearchPipelineTotalStats: type: object properties: count: type: number time: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' time_in_millis: - $ref: '#/components/schemas/_common:DurationValueUnitMillis' + $ref: '#/components/schemas/_common___DurationValueUnitMillis' current: type: number failed: type: number - nodes._common:ShardSegmentReplicationBackpressureStats: + nodes._common___ShardSegmentReplicationBackpressureStats: type: object properties: total_rejected_requests: type: number - nodes._common:ShardTaskCancellationStats: + nodes._common___ShardTaskCancellationStats: type: object properties: search_shard_task: - $ref: '#/components/schemas/nodes._common:ShardTaskCancellationStatsDetail' - nodes._common:ShardTaskCancellationStatsDetail: + $ref: '#/components/schemas/nodes._common___ShardTaskCancellationStatsDetail' + nodes._common___ShardTaskCancellationStatsDetail: type: object properties: current_count_post_cancel: type: number total_count_post_cancel: type: number - nodes._common:ShardWeightedRoutingStats: + nodes._common___ShardWeightedRoutingStats: type: object properties: stats: - $ref: '#/components/schemas/nodes._common:ShardWeightedRoutingStatsDetail' - nodes._common:ShardWeightedRoutingStatsDetail: + $ref: '#/components/schemas/nodes._common___ShardWeightedRoutingStatsDetail' + nodes._common___ShardWeightedRoutingStatsDetail: type: object properties: fail_open_count: type: number - nodes._common:Stats: + nodes._common___Stats: type: object properties: adaptive_selection: description: Statistics about adaptive replica selection. type: object additionalProperties: - $ref: '#/components/schemas/nodes._common:AdaptiveSelection' + $ref: '#/components/schemas/nodes._common___AdaptiveSelection' breakers: description: Statistics about the field data circuit breaker. type: object additionalProperties: - $ref: '#/components/schemas/nodes._common:Breaker' + $ref: '#/components/schemas/nodes._common___Breaker' fs: - $ref: '#/components/schemas/nodes._common:FileSystem' + $ref: '#/components/schemas/nodes._common___FileSystem' host: - $ref: '#/components/schemas/_common:Host' + $ref: '#/components/schemas/_common___Host' http: - $ref: '#/components/schemas/nodes._common:Http' + $ref: '#/components/schemas/nodes._common___Http' ingest: - $ref: '#/components/schemas/nodes._common:Ingest' + $ref: '#/components/schemas/nodes._common___Ingest' ip: description: IP address and port for the node. oneOf: - - $ref: '#/components/schemas/_common:Ip' + - $ref: '#/components/schemas/_common___Ip' - type: array items: - $ref: '#/components/schemas/_common:Ip' + $ref: '#/components/schemas/_common___Ip' jvm: - $ref: '#/components/schemas/nodes._common:Jvm' + $ref: '#/components/schemas/nodes._common___Jvm' name: - $ref: '#/components/schemas/_common:Name' + $ref: '#/components/schemas/_common___Name' os: - $ref: '#/components/schemas/nodes._common:OperatingSystem' + $ref: '#/components/schemas/nodes._common___OperatingSystem' process: - $ref: '#/components/schemas/nodes._common:Process' + $ref: '#/components/schemas/nodes._common___Process' roles: - $ref: '#/components/schemas/_common:NodeRoles' + $ref: '#/components/schemas/_common___NodeRoles' script: - $ref: '#/components/schemas/nodes._common:Scripting' + $ref: '#/components/schemas/nodes._common___Scripting' script_cache: type: object additionalProperties: oneOf: - - $ref: '#/components/schemas/nodes._common:ScriptCache' + - $ref: '#/components/schemas/nodes._common___ScriptCache' - type: array items: - $ref: '#/components/schemas/nodes._common:ScriptCache' + $ref: '#/components/schemas/nodes._common___ScriptCache' thread_pool: description: Statistics about each thread pool, including current size, queue and rejected tasks. type: object additionalProperties: - $ref: '#/components/schemas/nodes._common:ThreadCount' + $ref: '#/components/schemas/nodes._common___ThreadCount' timestamp: type: number transport: - $ref: '#/components/schemas/nodes._common:Transport' + $ref: '#/components/schemas/nodes._common___Transport' transport_address: - $ref: '#/components/schemas/_common:TransportAddress' + $ref: '#/components/schemas/_common___TransportAddress' attributes: description: Contains a list of attributes for the node. type: object additionalProperties: type: string discovery: - $ref: '#/components/schemas/nodes._common:Discovery' + $ref: '#/components/schemas/nodes._common___Discovery' indexing_pressure: - $ref: '#/components/schemas/nodes._common:IndexingPressure' + $ref: '#/components/schemas/nodes._common___IndexingPressure' indices: - $ref: '#/components/schemas/indices.stats:IndexShardStats' + $ref: '#/components/schemas/indices.stats___IndexShardStats' shard_indexing_pressure: - $ref: '#/components/schemas/nodes._common:ShardIndexingPressureStats' + $ref: '#/components/schemas/nodes._common___ShardIndexingPressureStats' search_backpressure: - $ref: '#/components/schemas/nodes._common:ShardSearchBackpressureStats' + $ref: '#/components/schemas/nodes._common___ShardSearchBackpressureStats' cluster_manager_throttling: - $ref: '#/components/schemas/nodes._common:ShardClusterManagerThrottlingStats' + $ref: '#/components/schemas/nodes._common___ShardClusterManagerThrottlingStats' weighted_routing: - $ref: '#/components/schemas/nodes._common:ShardWeightedRoutingStats' + $ref: '#/components/schemas/nodes._common___ShardWeightedRoutingStats' task_cancellation: - $ref: '#/components/schemas/nodes._common:ShardTaskCancellationStats' + $ref: '#/components/schemas/nodes._common___ShardTaskCancellationStats' resource_usage_stats: - $ref: '#/components/schemas/nodes._common:ShardResourceUsageStats' + $ref: '#/components/schemas/nodes._common___ShardResourceUsageStats' search_pipeline: - $ref: '#/components/schemas/nodes._common:ShardSearchPipelineStats' + $ref: '#/components/schemas/nodes._common___ShardSearchPipelineStats' segment_replication_backpressure: - $ref: '#/components/schemas/nodes._common:ShardSegmentReplicationBackpressureStats' + $ref: '#/components/schemas/nodes._common___ShardSegmentReplicationBackpressureStats' + remote_store: + $ref: '#/components/schemas/nodes._common___RemoteStoreStats' repositories: - $ref: '#/components/schemas/nodes._common:ShardRepositoriesStats' + $ref: '#/components/schemas/nodes._common___ShardRepositoriesStats' admission_control: - $ref: '#/components/schemas/nodes._common:ShardAdmissionControlStats' + $ref: '#/components/schemas/nodes._common___ShardAdmissionControlStats' caches: - $ref: '#/components/schemas/nodes._common:ShardCachesStats' - nodes._common:ThreadCount: + $ref: '#/components/schemas/nodes._common___ShardCachesStats' + nodes._common___ThreadCount: type: object properties: active: @@ -52293,13 +54320,13 @@ components: description: | 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. - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' total_wait_time_in_nanos: description: | 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:TotalRejectionsBreakup: + nodes._common___TotalRejectionsBreakup: type: object properties: node_limits: @@ -52308,28 +54335,28 @@ components: type: number throughput_degradation_limits: type: number - nodes._common:Transport: + nodes._common___Transport: type: object properties: inbound_handling_time_histogram: description: The distribution of the time spent handling each inbound message on a transport thread, represented as a histogram. type: array items: - $ref: '#/components/schemas/nodes._common:TransportHistogram' + $ref: '#/components/schemas/nodes._common___TransportHistogram' outbound_handling_time_histogram: description: The distribution of the time spent sending each outbound transport message on a transport thread, represented as a histogram. type: array items: - $ref: '#/components/schemas/nodes._common:TransportHistogram' + $ref: '#/components/schemas/nodes._common___TransportHistogram' rx_count: description: Total number of RX (receive) packets received by the node during internal cluster communication. type: number rx_size: description: Size of RX packets received by the node during internal cluster communication. - $ref: '#/components/schemas/_common:HumanReadableByteCount' + $ref: '#/components/schemas/_common___HumanReadableByteCount' rx_size_in_bytes: description: Size, in bytes, of RX packets received by the node during internal cluster communication. - $ref: '#/components/schemas/_common:ByteCount' + $ref: '#/components/schemas/_common___ByteCount' server_open: description: Current number of inbound TCP connections used for internal communication between nodes. type: number @@ -52338,17 +54365,17 @@ components: type: number tx_size: description: Size of TX packets sent by the node during internal cluster communication. - $ref: '#/components/schemas/_common:HumanReadableByteCount' + $ref: '#/components/schemas/_common___HumanReadableByteCount' tx_size_in_bytes: description: Size, in bytes, of TX packets sent by the node during internal cluster communication. - $ref: '#/components/schemas/_common:ByteCount' + $ref: '#/components/schemas/_common___ByteCount' total_outbound_connections: description: |- The cumulative number of outbound transport connections that this node has opened since it started. Each transport connection may comprise multiple TCP connections but is only counted once in this statistic. Transport connections are typically long-lived so this statistic should remain constant in a stable cluster. type: number - nodes._common:TransportHistogram: + nodes._common___TransportHistogram: type: object properties: count: @@ -52362,17 +54389,17 @@ components: ge_millis: description: The inclusive lower bound of the bucket in milliseconds. May be omitted on the first bucket if this bucket has no lower bound. type: number - nodes._common:TransportUsageStats: + nodes._common___TransportUsageStats: type: object properties: rejection_count: type: object - nodes._common:UsageStats: + nodes._common___UsageStats: type: object properties: transport: - $ref: '#/components/schemas/nodes._common:TransportUsageStats' - nodes.info:DeprecationIndexing: + $ref: '#/components/schemas/nodes._common___TransportUsageStats' + nodes.info___DeprecationIndexing: type: object properties: enabled: @@ -52381,7 +54408,7 @@ components: - type: string required: - enabled - nodes.info:Metric: + nodes.info___Metric: type: string enum: - _all @@ -52397,7 +54424,7 @@ components: - settings - thread_pool - transport - nodes.info:NodeInfo: + nodes.info___NodeInfo: type: object properties: attributes: @@ -52412,70 +54439,70 @@ components: build_type: type: string host: - $ref: '#/components/schemas/_common:Host' + $ref: '#/components/schemas/_common___Host' http: - $ref: '#/components/schemas/nodes.info:NodeInfoHttp' + $ref: '#/components/schemas/nodes.info___NodeInfoHttp' ip: - $ref: '#/components/schemas/_common:Ip' + $ref: '#/components/schemas/_common___Ip' jvm: - $ref: '#/components/schemas/nodes.info:NodeJvmInfo' + $ref: '#/components/schemas/nodes.info___NodeJvmInfo' name: - $ref: '#/components/schemas/_common:Name' + $ref: '#/components/schemas/_common___Name' network: - $ref: '#/components/schemas/nodes.info:NodeInfoNetwork' + $ref: '#/components/schemas/nodes.info___NodeInfoNetwork' os: - $ref: '#/components/schemas/nodes.info:NodeOperatingSystemInfo' + $ref: '#/components/schemas/nodes.info___NodeOperatingSystemInfo' plugins: type: array items: - $ref: '#/components/schemas/_common:PluginStats' + $ref: '#/components/schemas/_common___PluginStats' process: - $ref: '#/components/schemas/nodes.info:NodeProcessInfo' + $ref: '#/components/schemas/nodes.info___NodeProcessInfo' roles: - $ref: '#/components/schemas/_common:NodeRoles' + $ref: '#/components/schemas/_common___NodeRoles' settings: - $ref: '#/components/schemas/nodes.info:NodeInfoSettings' + $ref: '#/components/schemas/nodes.info___NodeInfoSettings' thread_pool: type: object additionalProperties: - $ref: '#/components/schemas/nodes.info:NodeThreadPoolInfo' + $ref: '#/components/schemas/nodes.info___NodeThreadPoolInfo' total_indexing_buffer: description: Total heap allowed to be used to hold recently indexed documents before they must be written to disk. This size is a shared pool across all shards on this node, and is controlled by Indexing Buffer settings. type: number total_indexing_buffer_in_bytes: - $ref: '#/components/schemas/_common:ByteCount' + $ref: '#/components/schemas/_common___ByteCount' transport: - $ref: '#/components/schemas/nodes.info:NodeInfoTransport' + $ref: '#/components/schemas/nodes.info___NodeInfoTransport' transport_address: - $ref: '#/components/schemas/_common:TransportAddress' + $ref: '#/components/schemas/_common___TransportAddress' version: - $ref: '#/components/schemas/_common:VersionString' + $ref: '#/components/schemas/_common___VersionString' modules: type: array items: - $ref: '#/components/schemas/_common:PluginStats' + $ref: '#/components/schemas/_common___PluginStats' ingest: - $ref: '#/components/schemas/nodes.info:NodeInfoIngest' + $ref: '#/components/schemas/nodes.info___NodeInfoIngest' aggregations: type: object additionalProperties: - $ref: '#/components/schemas/nodes.info:NodeInfoAggregation' + $ref: '#/components/schemas/nodes.info___NodeInfoAggregation' search_pipelines: - $ref: '#/components/schemas/nodes.info:NodeInfoSearchPipelines' + $ref: '#/components/schemas/nodes.info___NodeInfoSearchPipelines' required: - build_hash - build_type - name - roles - version - nodes.info:NodeInfoAction: + nodes.info___NodeInfoAction: type: object properties: destructive_requires_name: type: string required: - destructive_requires_name - nodes.info:NodeInfoAggregation: + nodes.info___NodeInfoAggregation: type: object properties: types: @@ -52484,28 +54511,28 @@ components: type: string required: - types - nodes.info:NodeInfoBootstrap: + nodes.info___NodeInfoBootstrap: type: object properties: memory_lock: type: string required: - memory_lock - nodes.info:NodeInfoClient: + nodes.info___NodeInfoClient: type: object properties: type: type: string required: - type - nodes.info:NodeInfoDiscovery: + nodes.info___NodeInfoDiscovery: type: object properties: type: type: string seed_hosts: type: string - nodes.info:NodeInfoHttp: + nodes.info___NodeInfoHttp: type: object properties: bound_address: @@ -52513,95 +54540,95 @@ components: items: type: string max_content_length: - $ref: '#/components/schemas/_common:HumanReadableByteCount' + $ref: '#/components/schemas/_common___HumanReadableByteCount' max_content_length_in_bytes: - $ref: '#/components/schemas/_common:ByteCount' + $ref: '#/components/schemas/_common___ByteCount' publish_address: type: string required: - bound_address - max_content_length_in_bytes - publish_address - nodes.info:NodeInfoIngest: + nodes.info___NodeInfoIngest: type: object properties: processors: type: array items: - $ref: '#/components/schemas/nodes.info:NodeInfoIngestProcessor' + $ref: '#/components/schemas/nodes.info___NodeInfoIngestProcessor' required: - processors - nodes.info:NodeInfoIngestDownloader: + nodes.info___NodeInfoIngestDownloader: type: object properties: enabled: type: string required: - enabled - nodes.info:NodeInfoIngestInfo: + nodes.info___NodeInfoIngestInfo: type: object properties: downloader: - $ref: '#/components/schemas/nodes.info:NodeInfoIngestDownloader' + $ref: '#/components/schemas/nodes.info___NodeInfoIngestDownloader' required: - downloader - nodes.info:NodeInfoIngestProcessor: + nodes.info___NodeInfoIngestProcessor: type: object properties: type: type: string required: - type - nodes.info:NodeInfoJvmMemory: + nodes.info___NodeInfoJvmMemory: type: object properties: direct_max: - $ref: '#/components/schemas/_common:HumanReadableByteCount' + $ref: '#/components/schemas/_common___HumanReadableByteCount' direct_max_in_bytes: - $ref: '#/components/schemas/_common:ByteCount' + $ref: '#/components/schemas/_common___ByteCount' heap_init: - $ref: '#/components/schemas/_common:HumanReadableByteCount' + $ref: '#/components/schemas/_common___HumanReadableByteCount' heap_init_in_bytes: - $ref: '#/components/schemas/_common:ByteCount' + $ref: '#/components/schemas/_common___ByteCount' heap_max: - $ref: '#/components/schemas/_common:HumanReadableByteCount' + $ref: '#/components/schemas/_common___HumanReadableByteCount' heap_max_in_bytes: - $ref: '#/components/schemas/_common:ByteCount' + $ref: '#/components/schemas/_common___ByteCount' non_heap_init: - $ref: '#/components/schemas/_common:HumanReadableByteCount' + $ref: '#/components/schemas/_common___HumanReadableByteCount' non_heap_init_in_bytes: - $ref: '#/components/schemas/_common:ByteCount' + $ref: '#/components/schemas/_common___ByteCount' non_heap_max: - $ref: '#/components/schemas/_common:HumanReadableByteCount' + $ref: '#/components/schemas/_common___HumanReadableByteCount' non_heap_max_in_bytes: - $ref: '#/components/schemas/_common:ByteCount' + $ref: '#/components/schemas/_common___ByteCount' required: - direct_max_in_bytes - heap_init_in_bytes - heap_max_in_bytes - non_heap_init_in_bytes - non_heap_max_in_bytes - nodes.info:NodeInfoMemory: + nodes.info___NodeInfoMemory: type: object properties: total: - $ref: '#/components/schemas/_common:HumanReadableByteCount' + $ref: '#/components/schemas/_common___HumanReadableByteCount' total_in_bytes: - $ref: '#/components/schemas/_common:ByteCount' + $ref: '#/components/schemas/_common___ByteCount' required: - total - total_in_bytes - nodes.info:NodeInfoNetwork: + nodes.info___NodeInfoNetwork: type: object properties: primary_interface: - $ref: '#/components/schemas/nodes.info:NodeInfoNetworkInterface' + $ref: '#/components/schemas/nodes.info___NodeInfoNetworkInterface' refresh_interval: type: number required: - primary_interface - refresh_interval - nodes.info:NodeInfoNetworkInterface: + nodes.info___NodeInfoNetworkInterface: type: object properties: address: @@ -52609,18 +54636,18 @@ components: mac_address: type: string name: - $ref: '#/components/schemas/_common:Name' + $ref: '#/components/schemas/_common___Name' required: - address - mac_address - name - nodes.info:NodeInfoOSCPU: + nodes.info___NodeInfoOSCPU: type: object properties: cache_size: - $ref: '#/components/schemas/_common:HumanReadableByteCount' + $ref: '#/components/schemas/_common___HumanReadableByteCount' cache_size_in_bytes: - $ref: '#/components/schemas/_common:ByteCount' + $ref: '#/components/schemas/_common___ByteCount' cores_per_socket: type: number mhz: @@ -52642,7 +54669,7 @@ components: - total_cores - total_sockets - vendor - nodes.info:NodeInfoPath: + nodes.info___NodeInfoPath: type: object properties: logs: @@ -52660,21 +54687,21 @@ components: required: - home - logs - nodes.info:NodeInfoRepositories: + nodes.info___NodeInfoRepositories: type: object properties: url: - $ref: '#/components/schemas/nodes.info:NodeInfoRepositoriesUrl' + $ref: '#/components/schemas/nodes.info___NodeInfoRepositoriesUrl' required: - url - nodes.info:NodeInfoRepositoriesUrl: + nodes.info___NodeInfoRepositoriesUrl: type: object properties: allowed_urls: type: string required: - allowed_urls - nodes.info:NodeInfoScript: + nodes.info___NodeInfoScript: type: object properties: allowed_types: @@ -52684,69 +54711,69 @@ components: required: - allowed_types - disable_max_compilations_rate - nodes.info:NodeInfoSearch: + nodes.info___NodeInfoSearch: type: object properties: remote: - $ref: '#/components/schemas/nodes.info:NodeInfoSearchRemote' + $ref: '#/components/schemas/nodes.info___NodeInfoSearchRemote' required: - remote - nodes.info:NodeInfoSearchPipelines: + nodes.info___NodeInfoSearchPipelines: type: object properties: response_processors: type: array items: - $ref: '#/components/schemas/nodes.info:NodeInfoIngestProcessor' + $ref: '#/components/schemas/nodes.info___NodeInfoIngestProcessor' request_processors: type: array items: - $ref: '#/components/schemas/nodes.info:NodeInfoIngestProcessor' + $ref: '#/components/schemas/nodes.info___NodeInfoIngestProcessor' required: - request_processors - response_processors - nodes.info:NodeInfoSearchRemote: + nodes.info___NodeInfoSearchRemote: type: object properties: connect: type: string required: - connect - nodes.info:NodeInfoSettings: + nodes.info___NodeInfoSettings: type: object properties: cluster: - $ref: '#/components/schemas/nodes.info:NodeInfoSettingsCluster' + $ref: '#/components/schemas/nodes.info___NodeInfoSettingsCluster' node: - $ref: '#/components/schemas/nodes.info:NodeInfoSettingsNode' + $ref: '#/components/schemas/nodes.info___NodeInfoSettingsNode' path: - $ref: '#/components/schemas/nodes.info:NodeInfoPath' + $ref: '#/components/schemas/nodes.info___NodeInfoPath' repositories: - $ref: '#/components/schemas/nodes.info:NodeInfoRepositories' + $ref: '#/components/schemas/nodes.info___NodeInfoRepositories' discovery: - $ref: '#/components/schemas/nodes.info:NodeInfoDiscovery' + $ref: '#/components/schemas/nodes.info___NodeInfoDiscovery' action: - $ref: '#/components/schemas/nodes.info:NodeInfoAction' + $ref: '#/components/schemas/nodes.info___NodeInfoAction' client: - $ref: '#/components/schemas/nodes.info:NodeInfoClient' + $ref: '#/components/schemas/nodes.info___NodeInfoClient' http: - $ref: '#/components/schemas/nodes.info:NodeInfoSettingsHttp' + $ref: '#/components/schemas/nodes.info___NodeInfoSettingsHttp' bootstrap: - $ref: '#/components/schemas/nodes.info:NodeInfoBootstrap' + $ref: '#/components/schemas/nodes.info___NodeInfoBootstrap' transport: - $ref: '#/components/schemas/nodes.info:NodeInfoSettingsTransport' + $ref: '#/components/schemas/nodes.info___NodeInfoSettingsTransport' network: - $ref: '#/components/schemas/nodes.info:NodeInfoSettingsNetwork' + $ref: '#/components/schemas/nodes.info___NodeInfoSettingsNetwork' script: - $ref: '#/components/schemas/nodes.info:NodeInfoScript' + $ref: '#/components/schemas/nodes.info___NodeInfoScript' search: - $ref: '#/components/schemas/nodes.info:NodeInfoSearch' + $ref: '#/components/schemas/nodes.info___NodeInfoSearch' ingest: - $ref: '#/components/schemas/nodes.info:NodeInfoSettingsIngest' + $ref: '#/components/schemas/nodes.info___NodeInfoSettingsIngest' index: - $ref: '#/components/schemas/nodes.info:NodeInfoSettingsIndex' + $ref: '#/components/schemas/nodes.info___NodeInfoSettingsIndex' plugins: - $ref: '#/components/schemas/nodes.info:NodeInfoSettingsPlugins' + $ref: '#/components/schemas/nodes.info___NodeInfoSettingsPlugins' required: - client - cluster @@ -52754,31 +54781,31 @@ components: - node - path - transport - nodes.info:NodeInfoSettingsCluster: + nodes.info___NodeInfoSettingsCluster: type: object properties: name: - $ref: '#/components/schemas/_common:Name' + $ref: '#/components/schemas/_common___Name' routing: - $ref: '#/components/schemas/indices._common:IndexRouting' + $ref: '#/components/schemas/indices._common___IndexRouting' election: - $ref: '#/components/schemas/nodes.info:NodeInfoSettingsClusterElection' + $ref: '#/components/schemas/nodes.info___NodeInfoSettingsClusterElection' initial_cluster_manager_nodes: type: string initial_master_nodes: type: string deprecation_indexing: - $ref: '#/components/schemas/nodes.info:DeprecationIndexing' + $ref: '#/components/schemas/nodes.info___DeprecationIndexing' required: - name - nodes.info:NodeInfoSettingsClusterElection: + nodes.info___NodeInfoSettingsClusterElection: type: object properties: strategy: - $ref: '#/components/schemas/_common:Name' + $ref: '#/components/schemas/_common___Name' required: - strategy - nodes.info:NodeInfoSettingsHttp: + nodes.info___NodeInfoSettingsHttp: type: object properties: type: @@ -52795,123 +54822,123 @@ components: - type: string required: - type - nodes.info:NodeInfoSettingsIndex: + nodes.info___NodeInfoSettingsIndex: type: object properties: store: - $ref: '#/components/schemas/nodes.info:NodeInfoSettingsIndexStore' - nodes.info:NodeInfoSettingsIndexHybrid: + $ref: '#/components/schemas/nodes.info___NodeInfoSettingsIndexStore' + nodes.info___NodeInfoSettingsIndexHybrid: type: object properties: mmap: - $ref: '#/components/schemas/nodes.info:NodeInfoSettingsIndexStoreMmap' - nodes.info:NodeInfoSettingsIndexStore: + $ref: '#/components/schemas/nodes.info___NodeInfoSettingsIndexStoreMmap' + nodes.info___NodeInfoSettingsIndexStore: type: object properties: hybrid: - $ref: '#/components/schemas/nodes.info:NodeInfoSettingsIndexHybrid' - nodes.info:NodeInfoSettingsIndexStoreMmap: + $ref: '#/components/schemas/nodes.info___NodeInfoSettingsIndexHybrid' + nodes.info___NodeInfoSettingsIndexStoreMmap: type: object properties: extensions: type: array items: type: string - nodes.info:NodeInfoSettingsIngest: + nodes.info___NodeInfoSettingsIngest: type: object properties: attachment: - $ref: '#/components/schemas/nodes.info:NodeInfoIngestInfo' + $ref: '#/components/schemas/nodes.info___NodeInfoIngestInfo' append: - $ref: '#/components/schemas/nodes.info:NodeInfoIngestInfo' + $ref: '#/components/schemas/nodes.info___NodeInfoIngestInfo' csv: - $ref: '#/components/schemas/nodes.info:NodeInfoIngestInfo' + $ref: '#/components/schemas/nodes.info___NodeInfoIngestInfo' convert: - $ref: '#/components/schemas/nodes.info:NodeInfoIngestInfo' + $ref: '#/components/schemas/nodes.info___NodeInfoIngestInfo' date: - $ref: '#/components/schemas/nodes.info:NodeInfoIngestInfo' + $ref: '#/components/schemas/nodes.info___NodeInfoIngestInfo' date_index_name: - $ref: '#/components/schemas/nodes.info:NodeInfoIngestInfo' + $ref: '#/components/schemas/nodes.info___NodeInfoIngestInfo' dot_expander: - $ref: '#/components/schemas/nodes.info:NodeInfoIngestInfo' + $ref: '#/components/schemas/nodes.info___NodeInfoIngestInfo' enrich: - $ref: '#/components/schemas/nodes.info:NodeInfoIngestInfo' + $ref: '#/components/schemas/nodes.info___NodeInfoIngestInfo' fail: - $ref: '#/components/schemas/nodes.info:NodeInfoIngestInfo' + $ref: '#/components/schemas/nodes.info___NodeInfoIngestInfo' foreach: - $ref: '#/components/schemas/nodes.info:NodeInfoIngestInfo' + $ref: '#/components/schemas/nodes.info___NodeInfoIngestInfo' json: - $ref: '#/components/schemas/nodes.info:NodeInfoIngestInfo' + $ref: '#/components/schemas/nodes.info___NodeInfoIngestInfo' user_agent: - $ref: '#/components/schemas/nodes.info:NodeInfoIngestInfo' + $ref: '#/components/schemas/nodes.info___NodeInfoIngestInfo' kv: - $ref: '#/components/schemas/nodes.info:NodeInfoIngestInfo' + $ref: '#/components/schemas/nodes.info___NodeInfoIngestInfo' geoip: - $ref: '#/components/schemas/nodes.info:NodeInfoIngestInfo' + $ref: '#/components/schemas/nodes.info___NodeInfoIngestInfo' grok: - $ref: '#/components/schemas/nodes.info:NodeInfoIngestInfo' + $ref: '#/components/schemas/nodes.info___NodeInfoIngestInfo' gsub: - $ref: '#/components/schemas/nodes.info:NodeInfoIngestInfo' + $ref: '#/components/schemas/nodes.info___NodeInfoIngestInfo' join: - $ref: '#/components/schemas/nodes.info:NodeInfoIngestInfo' + $ref: '#/components/schemas/nodes.info___NodeInfoIngestInfo' lowercase: - $ref: '#/components/schemas/nodes.info:NodeInfoIngestInfo' + $ref: '#/components/schemas/nodes.info___NodeInfoIngestInfo' remove: - $ref: '#/components/schemas/nodes.info:NodeInfoIngestInfo' + $ref: '#/components/schemas/nodes.info___NodeInfoIngestInfo' rename: - $ref: '#/components/schemas/nodes.info:NodeInfoIngestInfo' + $ref: '#/components/schemas/nodes.info___NodeInfoIngestInfo' script: - $ref: '#/components/schemas/nodes.info:NodeInfoIngestInfo' + $ref: '#/components/schemas/nodes.info___NodeInfoIngestInfo' set: - $ref: '#/components/schemas/nodes.info:NodeInfoIngestInfo' + $ref: '#/components/schemas/nodes.info___NodeInfoIngestInfo' sort: - $ref: '#/components/schemas/nodes.info:NodeInfoIngestInfo' + $ref: '#/components/schemas/nodes.info___NodeInfoIngestInfo' split: - $ref: '#/components/schemas/nodes.info:NodeInfoIngestInfo' + $ref: '#/components/schemas/nodes.info___NodeInfoIngestInfo' trim: - $ref: '#/components/schemas/nodes.info:NodeInfoIngestInfo' + $ref: '#/components/schemas/nodes.info___NodeInfoIngestInfo' uppercase: - $ref: '#/components/schemas/nodes.info:NodeInfoIngestInfo' + $ref: '#/components/schemas/nodes.info___NodeInfoIngestInfo' urldecode: - $ref: '#/components/schemas/nodes.info:NodeInfoIngestInfo' + $ref: '#/components/schemas/nodes.info___NodeInfoIngestInfo' bytes: - $ref: '#/components/schemas/nodes.info:NodeInfoIngestInfo' + $ref: '#/components/schemas/nodes.info___NodeInfoIngestInfo' dissect: - $ref: '#/components/schemas/nodes.info:NodeInfoIngestInfo' + $ref: '#/components/schemas/nodes.info___NodeInfoIngestInfo' set_security_user: - $ref: '#/components/schemas/nodes.info:NodeInfoIngestInfo' + $ref: '#/components/schemas/nodes.info___NodeInfoIngestInfo' pipeline: - $ref: '#/components/schemas/nodes.info:NodeInfoIngestInfo' + $ref: '#/components/schemas/nodes.info___NodeInfoIngestInfo' drop: - $ref: '#/components/schemas/nodes.info:NodeInfoIngestInfo' + $ref: '#/components/schemas/nodes.info___NodeInfoIngestInfo' circle: - $ref: '#/components/schemas/nodes.info:NodeInfoIngestInfo' + $ref: '#/components/schemas/nodes.info___NodeInfoIngestInfo' inference: - $ref: '#/components/schemas/nodes.info:NodeInfoIngestInfo' - nodes.info:NodeInfoSettingsNetwork: + $ref: '#/components/schemas/nodes.info___NodeInfoIngestInfo' + nodes.info___NodeInfoSettingsNetwork: type: object properties: host: - $ref: '#/components/schemas/_common:Host' + $ref: '#/components/schemas/_common___Host' required: - host - nodes.info:NodeInfoSettingsNode: + nodes.info___NodeInfoSettingsNode: type: object properties: name: - $ref: '#/components/schemas/_common:Name' + $ref: '#/components/schemas/_common___Name' attr: - $ref: '#/components/schemas/nodes.info:NodeInfoShardIndexingPressureEnabled' + $ref: '#/components/schemas/nodes.info___NodeInfoShardIndexingPressureEnabled' max_local_storage_nodes: type: string required: - attr - name - nodes.info:NodeInfoSettingsPlugins: + nodes.info___NodeInfoSettingsPlugins: type: object additionalProperties: - $ref: '#/components/schemas/_common:FieldValue' - nodes.info:NodeInfoSettingsTransport: + $ref: '#/components/schemas/_common___FieldValue' + nodes.info___NodeInfoSettingsTransport: type: object properties: type: @@ -52920,14 +54947,14 @@ components: type: string required: - type - nodes.info:NodeInfoShardIndexingPressureEnabled: + nodes.info___NodeInfoShardIndexingPressureEnabled: type: object properties: shard_indexing_pressure_enabled: type: string required: - shard_indexing_pressure_enabled - nodes.info:NodeInfoTransport: + nodes.info___NodeInfoTransport: type: object properties: bound_address: @@ -52944,7 +54971,7 @@ components: - bound_address - profiles - publish_address - nodes.info:NodeJvmInfo: + nodes.info___NodeJvmInfo: type: object properties: gc_collectors: @@ -52952,7 +54979,7 @@ components: items: type: string mem: - $ref: '#/components/schemas/nodes.info:NodeInfoJvmMemory' + $ref: '#/components/schemas/nodes.info___NodeInfoJvmMemory' memory_pools: type: array items: @@ -52960,15 +54987,15 @@ components: pid: type: number start_time_in_millis: - $ref: '#/components/schemas/_common:EpochTimeUnitMillis' + $ref: '#/components/schemas/_common___EpochTimeUnitMillis' version: - $ref: '#/components/schemas/_common:VersionString' + $ref: '#/components/schemas/_common___VersionString' vm_name: - $ref: '#/components/schemas/_common:Name' + $ref: '#/components/schemas/_common___Name' vm_vendor: type: string vm_version: - $ref: '#/components/schemas/_common:VersionString' + $ref: '#/components/schemas/_common___VersionString' bundled_jdk: type: boolean using_bundled_jdk: @@ -52988,7 +55015,7 @@ components: - mem - pid - start_time_in_millis - nodes.info:NodeOperatingSystemInfo: + nodes.info___NodeOperatingSystemInfo: type: object properties: arch: @@ -52998,26 +55025,26 @@ components: description: Number of processors available to the Java virtual machine type: number allocated_processors: - description: The number of processors actually used to calculate thread pool size. This number can be set with the node.processors setting of a node and defaults to the number of processors reported by the OS. + description: The number of processors actually used to calculate thread pool size. This number can be set with the `node.processors` setting of a node and defaults to the number of processors reported by the OS. type: number name: - $ref: '#/components/schemas/_common:Name' + $ref: '#/components/schemas/_common___Name' pretty_name: - $ref: '#/components/schemas/_common:Name' + $ref: '#/components/schemas/_common___Name' refresh_interval_in_millis: - $ref: '#/components/schemas/_common:DurationValueUnitMillis' + $ref: '#/components/schemas/_common___DurationValueUnitMillis' version: - $ref: '#/components/schemas/_common:VersionString' + $ref: '#/components/schemas/_common___VersionString' cpu: - $ref: '#/components/schemas/nodes.info:NodeInfoOSCPU' + $ref: '#/components/schemas/nodes.info___NodeInfoOSCPU' mem: - $ref: '#/components/schemas/nodes.info:NodeInfoMemory' + $ref: '#/components/schemas/nodes.info___NodeInfoMemory' swap: - $ref: '#/components/schemas/nodes.info:NodeInfoMemory' + $ref: '#/components/schemas/nodes.info___NodeInfoMemory' required: - available_processors - refresh_interval_in_millis - nodes.info:NodeProcessInfo: + nodes.info___NodeProcessInfo: type: object properties: id: @@ -53027,18 +55054,18 @@ components: description: Indicates if the process address space has been successfully locked in memory type: boolean refresh_interval_in_millis: - $ref: '#/components/schemas/_common:DurationValueUnitMillis' + $ref: '#/components/schemas/_common___DurationValueUnitMillis' required: - id - mlockall - refresh_interval_in_millis - nodes.info:NodeThreadPoolInfo: + nodes.info___NodeThreadPoolInfo: type: object properties: core: type: number keep_alive: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' max: type: number queue_size: @@ -53050,35 +55077,35 @@ components: required: - queue_size - type - nodes.info:ResponseBase: + nodes.info___ResponseBase: allOf: - - $ref: '#/components/schemas/nodes._common:NodesResponseBase' + - $ref: '#/components/schemas/nodes._common___NodesResponseBase' - type: object properties: cluster_name: - $ref: '#/components/schemas/_common:Name' + $ref: '#/components/schemas/_common___Name' nodes: type: object additionalProperties: - $ref: '#/components/schemas/nodes.info:NodeInfo' + $ref: '#/components/schemas/nodes.info___NodeInfo' required: - cluster_name - nodes - nodes.reload_secure_settings:ResponseBase: + nodes.reload_secure_settings___ResponseBase: allOf: - - $ref: '#/components/schemas/nodes._common:NodesResponseBase' + - $ref: '#/components/schemas/nodes._common___NodesResponseBase' - type: object properties: cluster_name: - $ref: '#/components/schemas/_common:Name' + $ref: '#/components/schemas/_common___Name' nodes: type: object additionalProperties: - $ref: '#/components/schemas/nodes._common:NodeReloadResult' + $ref: '#/components/schemas/nodes._common___NodeReloadResult' required: - cluster_name - nodes - nodes.stats:IndexMetric: + nodes.stats___IndexMetric: type: string enum: - _all @@ -53099,7 +55126,7 @@ components: - suggest - translog - warmer - nodes.stats:Metric: + nodes.stats___Metric: type: string enum: - _all @@ -53130,25 +55157,25 @@ components: - thread_pool - transport - weighted_routing - nodes.stats:ResponseBase: + nodes.stats___ResponseBase: allOf: - - $ref: '#/components/schemas/nodes._common:NodesResponseBase' + - $ref: '#/components/schemas/nodes._common___NodesResponseBase' - type: object properties: cluster_name: - $ref: '#/components/schemas/_common:Name' + $ref: '#/components/schemas/_common___Name' nodes: type: object additionalProperties: - $ref: '#/components/schemas/nodes._common:Stats' + $ref: '#/components/schemas/nodes._common___Stats' required: - nodes - nodes.usage:Metric: + nodes.usage___Metric: type: string enum: - _all - rest_actions - nodes.usage:NodeUsage: + nodes.usage___NodeUsage: type: object properties: rest_actions: @@ -53156,9 +55183,9 @@ components: additionalProperties: type: number since: - $ref: '#/components/schemas/_common:EpochTimeUnitMillis' + $ref: '#/components/schemas/_common___EpochTimeUnitMillis' timestamp: - $ref: '#/components/schemas/_common:EpochTimeUnitMillis' + $ref: '#/components/schemas/_common___EpochTimeUnitMillis' aggregations: type: object additionalProperties: @@ -53168,44 +55195,44 @@ components: - rest_actions - since - timestamp - nodes.usage:ResponseBase: + nodes.usage___ResponseBase: allOf: - - $ref: '#/components/schemas/nodes._common:NodesResponseBase' + - $ref: '#/components/schemas/nodes._common___NodesResponseBase' - type: object properties: cluster_name: - $ref: '#/components/schemas/_common:Name' + $ref: '#/components/schemas/_common___Name' nodes: type: object additionalProperties: - $ref: '#/components/schemas/nodes.usage:NodeUsage' + $ref: '#/components/schemas/nodes.usage___NodeUsage' required: - cluster_name - nodes - notifications._common:Chime: + notifications._common___Chime: type: object properties: url: type: string required: - url - notifications._common:DeleteConfigsResponse: + notifications._common___DeleteConfigsResponse: type: object properties: delete_response_list: - $ref: '#/components/schemas/notifications._common:DeleteResponseList' - notifications._common:DeleteResponseList: + $ref: '#/components/schemas/notifications._common___DeleteResponseList' + notifications._common___DeleteResponseList: type: object additionalProperties: - $ref: '#/components/schemas/notifications._common:RestStatus' - notifications._common:DeliveryStatus: + $ref: '#/components/schemas/notifications._common___RestStatus' + notifications._common___DeliveryStatus: type: object properties: status_code: type: string status_text: type: string - notifications._common:Email: + notifications._common___Email: type: object properties: email_account_id: @@ -53213,36 +55240,36 @@ components: recipient_list: type: array items: - $ref: '#/components/schemas/notifications._common:RecipientListItem' + $ref: '#/components/schemas/notifications._common___RecipientListItem' required: - email_account_id - notifications._common:EmailEncryptionMethod: + notifications._common___EmailEncryptionMethod: type: string enum: - none - ssl - start_tls - notifications._common:EmailGroup: + notifications._common___EmailGroup: type: object properties: recipient_list: type: array items: - $ref: '#/components/schemas/notifications._common:RecipientListItem' + $ref: '#/components/schemas/notifications._common___RecipientListItem' email_group_id_list: type: array items: type: string required: - recipient_list - notifications._common:EmailRecipientStatus: + notifications._common___EmailRecipientStatus: type: object properties: recipient: type: string delivery_status: - $ref: '#/components/schemas/notifications._common:DeliveryStatus' - notifications._common:EventSource: + $ref: '#/components/schemas/notifications._common___DeliveryStatus' + notifications._common___EventSource: type: object properties: title: @@ -53250,12 +55277,12 @@ components: reference_id: type: string severity: - $ref: '#/components/schemas/notifications._common:SeverityType' + $ref: '#/components/schemas/notifications._common___SeverityType' tags: type: array items: type: string - notifications._common:EventStatus: + notifications._common___EventStatus: type: object properties: config_id: @@ -53263,14 +55290,14 @@ components: config_name: type: string config_type: - $ref: '#/components/schemas/notifications._common:NotificationConfigType' + $ref: '#/components/schemas/notifications._common___NotificationConfigType' email_recipient_status: type: array items: - $ref: '#/components/schemas/notifications._common:EmailRecipientStatus' + $ref: '#/components/schemas/notifications._common___EmailRecipientStatus' delivery_status: - $ref: '#/components/schemas/notifications._common:DeliveryStatus' - notifications._common:GetConfigsResponse: + $ref: '#/components/schemas/notifications._common___DeliveryStatus' + notifications._common___GetConfigsResponse: type: object properties: start_index: @@ -53280,31 +55307,31 @@ components: type: integer format: int64 total_hit_relation: - $ref: '#/components/schemas/notifications._common:TotalHitRelation' + $ref: '#/components/schemas/notifications._common___TotalHitRelation' config_list: type: array maxItems: 1 items: - $ref: '#/components/schemas/notifications._common:NotificationsConfigsOutputItem' - notifications._common:HeaderParamsMap: + $ref: '#/components/schemas/notifications._common___NotificationsConfigsOutputItem' + notifications._common___HeaderParamsMap: type: object additionalProperties: type: integer format: int32 - notifications._common:HttpMethodType: + notifications._common___HttpMethodType: type: string enum: - PATCH - POST - PUT - notifications._common:MicrosoftTeamsItem: + notifications._common___MicrosoftTeamsItem: type: object properties: url: type: string required: - url - notifications._common:NotificationChannel: + notifications._common___NotificationChannel: type: object properties: config_id: @@ -53314,10 +55341,10 @@ components: description: type: string config_type: - $ref: '#/components/schemas/notifications._common:NotificationConfigType' + $ref: '#/components/schemas/notifications._common___NotificationConfigType' is_enabled: type: boolean - notifications._common:NotificationConfigType: + notifications._common___NotificationConfigType: type: string description: Type of notification configuration. enum: @@ -53330,16 +55357,16 @@ components: - smtp_account - sns - webhook - notifications._common:NotificationsConfig: + notifications._common___NotificationsConfig: type: object properties: config_id: type: string config: - $ref: '#/components/schemas/notifications._common:NotificationsConfigItem' + $ref: '#/components/schemas/notifications._common___NotificationsConfigItem' required: - config - notifications._common:NotificationsConfigItem: + notifications._common___NotificationsConfigItem: type: object properties: name: @@ -53347,31 +55374,31 @@ components: description: type: string config_type: - $ref: '#/components/schemas/notifications._common:NotificationConfigType' + $ref: '#/components/schemas/notifications._common___NotificationConfigType' is_enabled: type: boolean sns: - $ref: '#/components/schemas/notifications._common:SnsItem' + $ref: '#/components/schemas/notifications._common___SnsItem' slack: - $ref: '#/components/schemas/notifications._common:SlackItem' + $ref: '#/components/schemas/notifications._common___SlackItem' chime: - $ref: '#/components/schemas/notifications._common:Chime' + $ref: '#/components/schemas/notifications._common___Chime' webhook: - $ref: '#/components/schemas/notifications._common:Webhook' + $ref: '#/components/schemas/notifications._common___Webhook' smtp_account: - $ref: '#/components/schemas/notifications._common:SmtpAccount' + $ref: '#/components/schemas/notifications._common___SmtpAccount' ses_account: - $ref: '#/components/schemas/notifications._common:SesAccount' + $ref: '#/components/schemas/notifications._common___SesAccount' email_group: - $ref: '#/components/schemas/notifications._common:EmailGroup' + $ref: '#/components/schemas/notifications._common___EmailGroup' email: - $ref: '#/components/schemas/notifications._common:Email' + $ref: '#/components/schemas/notifications._common___Email' microsoft_teams: - $ref: '#/components/schemas/notifications._common:MicrosoftTeamsItem' + $ref: '#/components/schemas/notifications._common___MicrosoftTeamsItem' required: - config_type - name - notifications._common:NotificationsConfigsOutputItem: + notifications._common___NotificationsConfigsOutputItem: type: object properties: config_id: @@ -53383,17 +55410,17 @@ components: type: integer format: int64 config: - $ref: '#/components/schemas/notifications._common:NotificationsConfigItem' - notifications._common:NotificationsPluginFeaturesMap: + $ref: '#/components/schemas/notifications._common___NotificationsConfigItem' + notifications._common___NotificationsPluginFeaturesMap: type: object additionalProperties: type: string - notifications._common:RecipientListItem: + notifications._common___RecipientListItem: type: object properties: recipient: type: string - notifications._common:RestStatus: + notifications._common___RestStatus: type: string enum: - ACCEPTED @@ -53404,7 +55431,7 @@ components: - OK - PARTIAL_CONTENT - RESET_CONTENT - notifications._common:SesAccount: + notifications._common___SesAccount: type: object properties: region: @@ -53416,20 +55443,20 @@ components: required: - from_address - region - notifications._common:SeverityType: + notifications._common___SeverityType: type: string enum: - critical - high - info - notifications._common:SlackItem: + notifications._common___SlackItem: type: object properties: url: type: string required: - url - notifications._common:SmtpAccount: + notifications._common___SmtpAccount: type: object properties: host: @@ -53438,7 +55465,7 @@ components: type: integer format: int32 method: - $ref: '#/components/schemas/notifications._common:EmailEncryptionMethod' + $ref: '#/components/schemas/notifications._common___EmailEncryptionMethod' from_address: type: string required: @@ -53446,7 +55473,7 @@ components: - host - method - port - notifications._common:SnsItem: + notifications._common___SnsItem: type: object properties: topic_arn: @@ -53455,51 +55482,48 @@ components: type: string required: - topic_arn - notifications._common:TotalHitRelation: + notifications._common___TotalHitRelation: type: string enum: - eq - gte - notifications._common:Webhook: + notifications._common___Webhook: type: object properties: url: type: string method: - $ref: '#/components/schemas/notifications._common:HttpMethodType' + $ref: '#/components/schemas/notifications._common___HttpMethodType' header_params: - $ref: '#/components/schemas/notifications._common:HeaderParamsMap' + $ref: '#/components/schemas/notifications._common___HeaderParamsMap' required: - url - observability._common:ErrorResponse: + observability._common___ErrorResponse: type: object properties: root_cause: type: array items: - $ref: '#/components/schemas/observability._common:RootCause' + $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: + observability._common___NotFoundResponse: type: object properties: error: - $ref: '#/components/schemas/observability._common:ErrorResponse' + $ref: '#/components/schemas/observability._common___ErrorResponse' status: type: integer - example: 404 required: - error - status - observability._common:ObservabilityObject: + observability._common___ObservabilityObject: type: object properties: objectId: @@ -53511,15 +55535,15 @@ components: tenant: type: string operationalPanel: - $ref: '#/components/schemas/observability._common:OperationalPanel' + $ref: '#/components/schemas/observability._common___OperationalPanel' savedVisualization: - $ref: '#/components/schemas/observability._common:SavedVisualization' + $ref: '#/components/schemas/observability._common___SavedVisualization' savedQuery: - $ref: '#/components/schemas/observability._common:SavedQuery' + $ref: '#/components/schemas/observability._common___SavedQuery' required: - objectId - tenant - observability._common:ObservabilityObjectList: + observability._common___ObservabilityObjectList: type: object properties: startIndex: @@ -53531,13 +55555,13 @@ components: observabilityObjectList: type: array items: - $ref: '#/components/schemas/observability._common:ObservabilityObject' + $ref: '#/components/schemas/observability._common___ObservabilityObject' required: - observabilityObjectList - startIndex - totalHitRelation - totalHits - observability._common:OperationalPanel: + observability._common___OperationalPanel: type: object properties: name: @@ -53545,11 +55569,11 @@ components: visualizations: type: array items: - $ref: '#/components/schemas/observability._common:Visualization' + $ref: '#/components/schemas/observability._common___Visualization' timeRange: - $ref: '#/components/schemas/observability._common:TimeRange' + $ref: '#/components/schemas/observability._common___TimeRange' queryFilter: - $ref: '#/components/schemas/observability._common:QueryFilter' + $ref: '#/components/schemas/observability._common___QueryFilter' applicationId: type: string required: @@ -53558,7 +55582,7 @@ components: - queryFilter - timeRange - visualizations - observability._common:QueryFilter: + observability._common___QueryFilter: type: object properties: query: @@ -53568,19 +55592,17 @@ components: required: - language - query - observability._common:RootCause: + 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: + observability._common___SavedQuery: type: object properties: name: @@ -53590,11 +55612,11 @@ components: query: type: string selected_date_range: - $ref: '#/components/schemas/observability._common:SelectedDateRange' + $ref: '#/components/schemas/observability._common___SelectedDateRange' selected_timestamp: - $ref: '#/components/schemas/observability._common:SelectedTimestamp' + $ref: '#/components/schemas/observability._common___SelectedTimestamp' selected_fields: - $ref: '#/components/schemas/observability._common:SelectedFields' + $ref: '#/components/schemas/observability._common___SelectedFields' required: - description - name @@ -53602,7 +55624,7 @@ components: - selected_date_range - selected_fields - selected_timestamp - observability._common:SavedVisualization: + observability._common___SavedVisualization: type: object properties: name: @@ -53614,11 +55636,11 @@ components: type: type: string selected_date_range: - $ref: '#/components/schemas/observability._common:SelectedDateRange' + $ref: '#/components/schemas/observability._common___SelectedDateRange' selected_timestamp: - $ref: '#/components/schemas/observability._common:SelectedTimestamp' + $ref: '#/components/schemas/observability._common___SelectedTimestamp' selected_fields: - $ref: '#/components/schemas/observability._common:SelectedFields' + $ref: '#/components/schemas/observability._common___SelectedFields' required: - description - name @@ -53627,7 +55649,7 @@ components: - selected_fields - selected_timestamp - type - observability._common:SelectedDateRange: + observability._common___SelectedDateRange: type: object properties: start: @@ -53640,7 +55662,7 @@ components: - end - start - text - observability._common:SelectedFields: + observability._common___SelectedFields: type: object properties: text: @@ -53648,11 +55670,11 @@ components: tokens: type: array items: - $ref: '#/components/schemas/observability._common:Token' + $ref: '#/components/schemas/observability._common___Token' required: - text - tokens - observability._common:SelectedTimestamp: + observability._common___SelectedTimestamp: type: object properties: name: @@ -53662,7 +55684,7 @@ components: required: - name - type - observability._common:TimeRange: + observability._common___TimeRange: type: object properties: to: @@ -53672,7 +55694,7 @@ components: required: - from - to - observability._common:Token: + observability._common___Token: type: object properties: name: @@ -53682,7 +55704,7 @@ components: required: - name - type - observability._common:Visualization: + observability._common___Visualization: type: object properties: id: @@ -53704,7 +55726,7 @@ components: - w - x - 'y' - query._common:Credentials: + query._common___Credentials: type: object properties: username: @@ -53714,7 +55736,7 @@ components: required: - password - username - query._common:DataSource: + query._common___DataSource: type: object properties: name: @@ -53735,35 +55757,35 @@ components: status: type: string configuration: - $ref: '#/components/schemas/query._common:DataSourceConfiguration' + $ref: '#/components/schemas/query._common___DataSourceConfiguration' required: - connector - name - properties - resultIndex - status - query._common:DataSourceConfiguration: + query._common___DataSourceConfiguration: type: object properties: endpoint: type: string credentials: - $ref: '#/components/schemas/query._common:Credentials' + $ref: '#/components/schemas/query._common___Credentials' required: - credentials - endpoint - query._common:DataSourceList: + query._common___DataSourceList: type: array items: - $ref: '#/components/schemas/query._common:DataSource' - query._common:DataSourceNotFound: + $ref: '#/components/schemas/query._common___DataSource' + query._common___DataSourceNotFound: type: object properties: error: - $ref: '#/components/schemas/query._common:ErrorResponse' + $ref: '#/components/schemas/query._common___ErrorResponse' required: - error - query._common:DataSourceRetrieve: + query._common___DataSourceRetrieve: type: object properties: name: @@ -53784,20 +55806,20 @@ components: status: type: string configuration: - $ref: '#/components/schemas/query._common:DataSourceConfiguration' + $ref: '#/components/schemas/query._common___DataSourceConfiguration' required: - connector - name - properties - resultIndex - status - query._common:ErrorResponse: + query._common___Error: type: object properties: root_cause: type: array items: - $ref: '#/components/schemas/query._common:RootCause' + $ref: '#/components/schemas/query._common___RootCause' type: type: string reason: @@ -53806,7 +55828,14 @@ components: - reason - root_cause - type - query._common:RootCause: + query._common___ErrorResponse: + type: object + properties: + error: + $ref: '#/components/schemas/query._common___Error' + status: + type: number + query._common___RootCause: type: object properties: type: @@ -53816,7 +55845,7 @@ components: required: - reason - type - remote_store._common:RemoteStoreRestoreInfo: + remote_store._common___RemoteStoreRestoreInfo: type: object properties: snapshot: @@ -53826,8 +55855,8 @@ components: items: type: string shards: - $ref: '#/components/schemas/remote_store._common:RemoteStoreRestoreShardsInfo' - remote_store._common:RemoteStoreRestoreShardsInfo: + $ref: '#/components/schemas/remote_store._common___RemoteStoreRestoreShardsInfo' + remote_store._common___RemoteStoreRestoreShardsInfo: type: object properties: total: @@ -53839,7 +55868,229 @@ components: successful: type: integer format: int32 - rollups._common:Continuous: + replication._common___AutoFollowStats: + type: object + properties: + name: + type: string + pattern: + type: string + num_success_start_replication: + type: number + num_failed_start_replication: + type: number + num_failed_leader_calls: + type: number + failed_indices: + type: array + items: + type: string + last_execution_time: + type: number + replication._common___AutoFollowStatus: + type: object + properties: + num_success_start_replication: + type: number + num_failed_start_replication: + type: number + num_failed_leader_calls: + type: number + failed_indices: + type: array + items: + type: string + autofollow_stats: + type: array + items: + $ref: '#/components/schemas/replication._common___AutoFollowStats' + replication._common___CreateReplicationRule: + type: object + properties: + leader_alias: + $ref: '#/components/schemas/_common___IndexAlias' + name: + type: string + pattern: + type: string + use_roles: + $ref: '#/components/schemas/replication._common___UseRoles' + replication._common___DeleteReplicationRule: + type: object + properties: + leader_alias: + $ref: '#/components/schemas/_common___IndexAlias' + name: + type: string + replication._common___FollowerStatus: + type: object + properties: + num_syncing_indices: + type: number + num_bootstrapping_indices: + type: number + num_paused_indices: + type: number + num_failed_indices: + type: number + num_shard_tasks: + type: number + num_index_tasks: + type: number + operations_written: + type: number + operations_read: + type: number + failed_read_requests: + type: number + throttled_read_requests: + type: number + failed_write_requests: + type: number + throttled_write_requests: + type: number + follower_checkpoint: + type: number + leader_checkpoint: + type: number + total_write_time_millis: + $ref: '#/components/schemas/_common___StringifiedEpochTimeUnitMillis' + index_stats: + type: object + additionalProperties: + $ref: '#/components/schemas/replication._common___IndexFollowerStatus' + replication._common___IndexFollowerStatus: + type: object + properties: + operations_written: + type: number + operations_read: + type: number + failed_read_requests: + type: number + throttled_read_requests: + type: number + failed_write_requests: + type: number + throttled_write_requests: + type: number + follower_checkpoint: + type: number + leader_checkpoint: + type: number + total_write_time_millis: + $ref: '#/components/schemas/_common___StringifiedEpochTimeUnitMillis' + replication._common___IndexSchema: + type: object + properties: + number_of_shards: + type: integer + number_of_replicas: + type: integer + replication._common___IndexStatus: + type: object + properties: + operations_read: + type: number + translog_size_bytes: + $ref: '#/components/schemas/_common___ByteCount' + operations_read_lucene: + type: number + operations_read_translog: + type: number + total_read_time_lucene_millis: + $ref: '#/components/schemas/_common___StringifiedEpochTimeUnitMillis' + total_read_time_translog_millis: + $ref: '#/components/schemas/_common___StringifiedEpochTimeUnitMillis' + bytes_read: + $ref: '#/components/schemas/_common___ByteCount' + replication._common___LeaderStatus: + type: object + properties: + num_replicated_indices: + type: number + operations_read: + type: number + translog_size_bytes: + $ref: '#/components/schemas/_common___ByteCount' + operations_read_lucene: + type: number + operations_read_translog: + type: number + total_read_time_lucene_millis: + $ref: '#/components/schemas/_common___StringifiedEpochTimeUnitMillis' + total_read_time_translog_millis: + $ref: '#/components/schemas/_common___StringifiedEpochTimeUnitMillis' + bytes_read: + $ref: '#/components/schemas/_common___ByteCount' + index_stats: + type: object + additionalProperties: + $ref: '#/components/schemas/replication._common___IndexStatus' + replication._common___Replication: + type: object + properties: + leader_alias: + $ref: '#/components/schemas/_common___IndexAlias' + leader_index: + $ref: '#/components/schemas/_common___IndexName' + use_roles: + $ref: '#/components/schemas/replication._common___UseRoles' + replication._common___SettingsBody: + type: object + properties: + index: + $ref: '#/components/schemas/replication._common___IndexSchema' + replication._common___Status: + type: object + properties: + status: + type: string + enum: + - BOOTSTRAPPING + - PAUSED + - REPLICATION NOT IN PROGRESS + - RUNNING + - SYNCING + reason: + type: string + leader_alias: + $ref: '#/components/schemas/_common___IndexAlias' + leader_index: + $ref: '#/components/schemas/_common___IndexName' + follower_index: + $ref: '#/components/schemas/_common___IndexName' + syncing_details: + $ref: '#/components/schemas/replication._common___SyncingDetails' + replication._common___SyncingDetails: + type: object + properties: + leader_checkpoint: + type: integer + follower_checkpoint: + type: integer + seq_no: + $ref: '#/components/schemas/_common___SequenceNumber' + replication._common___UpdateSettings: + type: object + properties: + settings: + allOf: + - type: object + properties: + index.number_of_shards: + type: integer + index.number_of_replicas: + type: integer + - $ref: '#/components/schemas/replication._common___SettingsBody' + replication._common___UseRoles: + type: object + properties: + leader_cluster_role: + type: string + follower_cluster_role: + type: string + rollups._common___Continuous: type: object properties: next_window_start_time: @@ -53851,15 +56102,15 @@ components: failure_reason: type: string stats: - $ref: '#/components/schemas/rollups._common:Stats' - rollups._common:Cron: + $ref: '#/components/schemas/rollups._common___Stats' + rollups._common___Cron: type: object properties: expression: type: string timezone: type: string - rollups._common:DateHistogramDimension: + rollups._common___DateHistogramDimension: type: object properties: fixed_interval: @@ -53872,18 +56123,18 @@ components: type: string target_field: type: string - rollups._common:DimensionsConfigItem: + rollups._common___DimensionsConfigItem: type: object properties: histogram: - $ref: '#/components/schemas/rollups._common:HistogramDimension' + $ref: '#/components/schemas/rollups._common___HistogramDimension' date_histogram: - $ref: '#/components/schemas/rollups._common:DateHistogramDimension' + $ref: '#/components/schemas/rollups._common___DateHistogramDimension' terms: - $ref: '#/components/schemas/rollups._common:TermsDimension' + $ref: '#/components/schemas/rollups._common___TermsDimension' minProperties: 1 maxProperties: 1 - rollups._common:Explain: + rollups._common___Explain: type: object properties: rollup_id: @@ -53891,13 +56142,13 @@ components: last_updated_time: type: number continuous: - $ref: '#/components/schemas/rollups._common:Continuous' - rollups._common:ExplainEntities: + $ref: '#/components/schemas/rollups._common___Continuous' + rollups._common___ExplainEntities: type: object properties: item: - $ref: '#/components/schemas/rollups._common:Explain' - rollups._common:HistogramDimension: + $ref: '#/components/schemas/rollups._common___Explain' + rollups._common___HistogramDimension: type: object properties: source_field: @@ -53906,7 +56157,7 @@ components: type: string interval: type: string - rollups._common:Interval: + rollups._common___Interval: type: object properties: start_time: @@ -53919,11 +56170,11 @@ components: oneOf: - type: array items: - $ref: '#/components/schemas/rollups._common:Cron' - - $ref: '#/components/schemas/rollups._common:Cron' + $ref: '#/components/schemas/rollups._common___Cron' + - $ref: '#/components/schemas/rollups._common___Cron' schedule_delay: type: number - rollups._common:MetricsConfigItem: + rollups._common___MetricsConfigItem: type: object properties: source_field: @@ -53933,8 +56184,8 @@ components: metrics: type: array items: - $ref: '#/components/schemas/rollups._common:MetricsConfigMetrics' - rollups._common:MetricsConfigMetrics: + $ref: '#/components/schemas/rollups._common___MetricsConfigMetrics' + rollups._common___MetricsConfigMetrics: type: object properties: avg: @@ -53949,7 +56200,7 @@ components: type: object minProperties: 1 maxProperties: 1 - rollups._common:Rollup: + rollups._common___Rollup: type: object properties: rollup_id: @@ -53957,7 +56208,7 @@ components: enabled: type: boolean schedule: - $ref: '#/components/schemas/rollups._common:Schedule' + $ref: '#/components/schemas/rollups._common___Schedule' last_updated_time: type: number enabled_time: @@ -53981,15 +56232,15 @@ components: dimensions: type: array items: - $ref: '#/components/schemas/rollups._common:DimensionsConfigItem' + $ref: '#/components/schemas/rollups._common___DimensionsConfigItem' metrics: type: array items: - $ref: '#/components/schemas/rollups._common:MetricsConfigItem' + $ref: '#/components/schemas/rollups._common___MetricsConfigItem' error_notification: type: string description: Set up a Mustache message template for error notifications. For example, if an index rollup job fails, the system sends a message to a Slack channel. - rollups._common:RollupEntity: + rollups._common___RollupEntity: type: object properties: _id: @@ -53999,13 +56250,13 @@ components: _primaryTerm: type: number rollup: - $ref: '#/components/schemas/rollups._common:Rollup' - rollups._common:Schedule: + $ref: '#/components/schemas/rollups._common___Rollup' + rollups._common___Schedule: type: object properties: interval: - $ref: '#/components/schemas/rollups._common:Interval' - rollups._common:Stats: + $ref: '#/components/schemas/rollups._common___Interval' + rollups._common___Stats: type: object properties: pages_processed: @@ -54018,14 +56269,14 @@ components: type: number search_time_in_ms: type: number - rollups._common:TermsDimension: + rollups._common___TermsDimension: type: object properties: source_field: type: string target_field: type: string - search_pipeline._common:CollapseResponseProcessor: + search_pipeline._common___CollapseResponseProcessor: type: object properties: tag: @@ -54040,7 +56291,7 @@ components: type: string required: - field - search_pipeline._common:FilterQueryRequestProcessor: + search_pipeline._common___FilterQueryRequestProcessor: type: object properties: tag: @@ -54050,19 +56301,19 @@ components: ignore_failure: type: boolean query: - $ref: '#/components/schemas/search_pipeline._common:UserDefinedObjectStructure' - search_pipeline._common:MLOpenSearchReranker: + $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: + search_pipeline._common___NeuralFieldMap: type: object additionalProperties: type: string - search_pipeline._common:NeuralQueryEnricherRequestProcessor: + search_pipeline._common___NeuralQueryEnricherRequestProcessor: type: object properties: tag: @@ -54072,8 +56323,8 @@ components: default_model_id: type: string neural_field_default_id: - $ref: '#/components/schemas/search_pipeline._common:NeuralFieldMap' - search_pipeline._common:NormalizationPhaseResultsProcessor: + $ref: '#/components/schemas/search_pipeline._common___NeuralFieldMap' + search_pipeline._common___NormalizationPhaseResultsProcessor: type: object properties: tag: @@ -54083,10 +56334,10 @@ components: ignore_failure: type: boolean normalization: - $ref: '#/components/schemas/search_pipeline._common:ScoreNormalization' + $ref: '#/components/schemas/search_pipeline._common___ScoreNormalization' combination: - $ref: '#/components/schemas/search_pipeline._common:ScoreCombination' - search_pipeline._common:OversampleRequestProcessor: + $ref: '#/components/schemas/search_pipeline._common___ScoreCombination' + search_pipeline._common___OversampleRequestProcessor: type: object properties: tag: @@ -54102,7 +56353,7 @@ components: type: string required: - sample_factor - search_pipeline._common:PersonalizeSearchRankingResponseProcessor: + search_pipeline._common___PersonalizeSearchRankingResponseProcessor: type: object properties: tag: @@ -54126,16 +56377,16 @@ components: - campaign_arn - recipe - weight - search_pipeline._common:PhaseResultsProcessor: + search_pipeline._common___PhaseResultsProcessor: oneOf: - type: object title: normalization-processor properties: normalization-processor: - $ref: '#/components/schemas/search_pipeline._common:NormalizationPhaseResultsProcessor' + $ref: '#/components/schemas/search_pipeline._common___NormalizationPhaseResultsProcessor' required: - normalization-processor - search_pipeline._common:RenameFieldResponseProcessor: + search_pipeline._common___RenameFieldResponseProcessor: type: object properties: tag: @@ -54151,37 +56402,37 @@ components: required: - field - target_field - search_pipeline._common:RequestProcessor: + search_pipeline._common___RequestProcessor: oneOf: - type: object title: filter_query properties: filter_query: - $ref: '#/components/schemas/search_pipeline._common:FilterQueryRequestProcessor' + $ref: '#/components/schemas/search_pipeline._common___FilterQueryRequestProcessor' required: - filter_query - type: object title: neural_query_enricher properties: neural_query_enricher: - $ref: '#/components/schemas/search_pipeline._common:NeuralQueryEnricherRequestProcessor' + $ref: '#/components/schemas/search_pipeline._common___NeuralQueryEnricherRequestProcessor' required: - neural_query_enricher - type: object title: script properties: script: - $ref: '#/components/schemas/search_pipeline._common:SearchScriptRequestProcessor' + $ref: '#/components/schemas/search_pipeline._common___SearchScriptRequestProcessor' required: - script - type: object title: oversample properties: oversample: - $ref: '#/components/schemas/search_pipeline._common:OversampleRequestProcessor' + $ref: '#/components/schemas/search_pipeline._common___OversampleRequestProcessor' required: - oversample - search_pipeline._common:RerankContext: + search_pipeline._common___RerankContext: type: object properties: document_fields: @@ -54190,7 +56441,7 @@ components: type: string required: - document_fields - search_pipeline._common:RerankResponseProcessor: + search_pipeline._common___RerankResponseProcessor: type: object properties: tag: @@ -54200,68 +56451,68 @@ components: ignore_failure: type: boolean ml_opensearch: - $ref: '#/components/schemas/search_pipeline._common:MLOpenSearchReranker' + $ref: '#/components/schemas/search_pipeline._common___MLOpenSearchReranker' context: - $ref: '#/components/schemas/search_pipeline._common:RerankContext' - search_pipeline._common:ResponseProcessor: + $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' + $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' + $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' + $ref: '#/components/schemas/search_pipeline._common___RenameFieldResponseProcessor' required: - rename_field - type: object title: rerank properties: rerank: - $ref: '#/components/schemas/search_pipeline._common:RerankResponseProcessor' + $ref: '#/components/schemas/search_pipeline._common___RerankResponseProcessor' required: - rerank - type: object title: collapse properties: collapse: - $ref: '#/components/schemas/search_pipeline._common:CollapseResponseProcessor' + $ref: '#/components/schemas/search_pipeline._common___CollapseResponseProcessor' required: - collapse - type: object title: truncate_hits properties: truncate_hits: - $ref: '#/components/schemas/search_pipeline._common:TruncateHitsResponseProcessor' + $ref: '#/components/schemas/search_pipeline._common___TruncateHitsResponseProcessor' required: - truncate_hits - type: object title: sort properties: sort: - $ref: '#/components/schemas/search_pipeline._common:SortResponseProcessor' + $ref: '#/components/schemas/search_pipeline._common___SortResponseProcessor' required: - sort - type: object title: split properties: split: - $ref: '#/components/schemas/search_pipeline._common:SplitResponseProcessor' + $ref: '#/components/schemas/search_pipeline._common___SplitResponseProcessor' required: - split - search_pipeline._common:RetrievalAugmentedGenerationResponseProcessor: + search_pipeline._common___RetrievalAugmentedGenerationResponseProcessor: type: object properties: tag: @@ -54281,37 +56532,37 @@ components: required: - context_field_list - model_id - search_pipeline._common:ScoreCombination: + search_pipeline._common___ScoreCombination: type: object properties: technique: - $ref: '#/components/schemas/search_pipeline._common:ScoreCombinationTechnique' + $ref: '#/components/schemas/search_pipeline._common___ScoreCombinationTechnique' parameters: type: array items: type: number format: float - search_pipeline._common:ScoreCombinationTechnique: + search_pipeline._common___ScoreCombinationTechnique: type: string enum: - arithmetic_mean - geometric_mean - harmonic_mean - search_pipeline._common:ScoreNormalization: + search_pipeline._common___ScoreNormalization: type: object properties: technique: - $ref: '#/components/schemas/search_pipeline._common:ScoreNormalizationTechnique' - search_pipeline._common:ScoreNormalizationTechnique: + $ref: '#/components/schemas/search_pipeline._common___ScoreNormalizationTechnique' + search_pipeline._common___ScoreNormalizationTechnique: type: string enum: - l2 - min_max - search_pipeline._common:SearchPipelineMap: + search_pipeline._common___SearchPipelineMap: type: object additionalProperties: - $ref: '#/components/schemas/search_pipeline._common:SearchPipelineStructure' - search_pipeline._common:SearchPipelineStructure: + $ref: '#/components/schemas/search_pipeline._common___SearchPipelineStructure' + search_pipeline._common___SearchPipelineStructure: type: object properties: version: @@ -54320,16 +56571,16 @@ components: request_processors: type: array items: - $ref: '#/components/schemas/search_pipeline._common:RequestProcessor' + $ref: '#/components/schemas/search_pipeline._common___RequestProcessor' response_processors: type: array items: - $ref: '#/components/schemas/search_pipeline._common:ResponseProcessor' + $ref: '#/components/schemas/search_pipeline._common___ResponseProcessor' phase_results_processors: type: array items: - $ref: '#/components/schemas/search_pipeline._common:PhaseResultsProcessor' - search_pipeline._common:SearchScriptRequestProcessor: + $ref: '#/components/schemas/search_pipeline._common___PhaseResultsProcessor' + search_pipeline._common___SearchScriptRequestProcessor: type: object properties: tag: @@ -54344,7 +56595,7 @@ components: type: string required: - source - search_pipeline._common:SortResponseProcessor: + search_pipeline._common___SortResponseProcessor: type: object properties: tag: @@ -54361,7 +56612,7 @@ components: type: string required: - field - search_pipeline._common:SplitResponseProcessor: + search_pipeline._common___SplitResponseProcessor: type: object properties: tag: @@ -54381,7 +56632,7 @@ components: required: - field - separator - search_pipeline._common:TruncateHitsResponseProcessor: + search_pipeline._common___TruncateHitsResponseProcessor: type: object properties: tag: @@ -54395,7 +56646,7 @@ components: format: int32 context_prefix: type: string - search_pipeline._common:UserDefinedObjectStructure: + search_pipeline._common___UserDefinedObjectStructure: type: object properties: bool: {} @@ -54407,7 +56658,7 @@ components: exists: {} function_score: {} fuzzy: - $ref: '#/components/schemas/search_pipeline._common:UserDefinedValueMap' + $ref: '#/components/schemas/search_pipeline._common___UserDefinedValueMap' geo_bounding_box: {} geo_distance: {} geo_polygon: {} @@ -54416,18 +56667,18 @@ components: has_parent: {} ids: {} intervals: - $ref: '#/components/schemas/search_pipeline._common:UserDefinedValueMap' + $ref: '#/components/schemas/search_pipeline._common___UserDefinedValueMap' knn: {} match: - $ref: '#/components/schemas/search_pipeline._common:UserDefinedValueMap' + $ref: '#/components/schemas/search_pipeline._common___UserDefinedValueMap' match_all: {} match_bool_prefix: - $ref: '#/components/schemas/search_pipeline._common:UserDefinedValueMap' + $ref: '#/components/schemas/search_pipeline._common___UserDefinedValueMap' match_none: {} match_phrase: - $ref: '#/components/schemas/search_pipeline._common:UserDefinedValueMap' + $ref: '#/components/schemas/search_pipeline._common___UserDefinedValueMap' match_phrase_prefix: - $ref: '#/components/schemas/search_pipeline._common:UserDefinedValueMap' + $ref: '#/components/schemas/search_pipeline._common___UserDefinedValueMap' more_like_this: {} multi_match: {} nested: {} @@ -54435,13 +56686,13 @@ components: percolate: {} pinned: {} prefix: - $ref: '#/components/schemas/search_pipeline._common:UserDefinedValueMap' + $ref: '#/components/schemas/search_pipeline._common___UserDefinedValueMap' query_string: {} range: - $ref: '#/components/schemas/search_pipeline._common:UserDefinedValueMap' + $ref: '#/components/schemas/search_pipeline._common___UserDefinedValueMap' rank_feature: {} regexp: - $ref: '#/components/schemas/search_pipeline._common:UserDefinedValueMap' + $ref: '#/components/schemas/search_pipeline._common___UserDefinedValueMap' script: {} script_score: {} shape: {} @@ -54454,20 +56705,20 @@ components: span_not: {} span_or: {} span_term: - $ref: '#/components/schemas/search_pipeline._common:UserDefinedValueMap' + $ref: '#/components/schemas/search_pipeline._common___UserDefinedValueMap' span_within: {} term: - $ref: '#/components/schemas/search_pipeline._common:UserDefinedValueMap' + $ref: '#/components/schemas/search_pipeline._common___UserDefinedValueMap' terms: {} terms_set: - $ref: '#/components/schemas/search_pipeline._common:UserDefinedValueMap' + $ref: '#/components/schemas/search_pipeline._common___UserDefinedValueMap' wildcard: - $ref: '#/components/schemas/search_pipeline._common:UserDefinedValueMap' + $ref: '#/components/schemas/search_pipeline._common___UserDefinedValueMap' wrapper: {} - search_pipeline._common:UserDefinedValueMap: + search_pipeline._common___UserDefinedValueMap: type: object additionalProperties: {} - security._common:AccountDetails: + security._common___AccountDetails: type: object properties: user_name: @@ -54491,12 +56742,12 @@ components: items: type: string tenants: - $ref: '#/components/schemas/security._common:UserTenants' + $ref: '#/components/schemas/security._common___UserTenants' roles: type: array items: type: string - security._common:ActionGroup: + security._common___ActionGroup: type: object properties: reserved: @@ -54513,28 +56764,28 @@ components: type: string static: type: boolean - security._common:ActionGroupsMap: + security._common___ActionGroupsMap: type: object additionalProperties: - $ref: '#/components/schemas/security._common:ActionGroup' - security._common:AllowListConfig: + $ref: '#/components/schemas/security._common___ActionGroup' + security._common___AllowListConfig: type: object properties: enabled: type: boolean requests: type: object - description: An object with APIs as key and array of http methods as values. - security._common:AuditConfig: + description: An object with APIs as key and array of HTTP methods as values. + security._common___AuditConfig: type: object properties: compliance: - $ref: '#/components/schemas/security._common:ComplianceConfig' + $ref: '#/components/schemas/security._common___ComplianceConfig' enabled: type: boolean audit: - $ref: '#/components/schemas/security._common:AuditLogsConfig' - security._common:AuditConfigWithReadOnly: + $ref: '#/components/schemas/security._common___AuditLogsConfig' + security._common___AuditConfigWithReadOnly: type: object properties: _readonly: @@ -54542,8 +56793,8 @@ components: items: type: string config: - $ref: '#/components/schemas/security._common:AuditConfig' - security._common:AuditLogsConfig: + $ref: '#/components/schemas/security._common___AuditConfig' + security._common___AuditLogsConfig: type: object properties: ignore_users: @@ -54582,12 +56833,12 @@ components: type: boolean enable_rest: type: boolean - security._common:AuthInfo: + security._common___AuthInfo: type: object properties: user: type: string - description: Stringified User object. + description: A User object as a string. user_name: type: string description: User's name. @@ -54633,7 +56884,7 @@ components: type: - 'null' - string - description: Logout url. + description: Logout URL. size_of_user: type: string description: Size of user in memory. @@ -54643,7 +56894,7 @@ components: size_of_backendroles: type: string description: Size of backend roles in bytes. - security._common:CertificateCountPerNode: + security._common___CertificateCountPerNode: type: object properties: total: @@ -54655,7 +56906,7 @@ components: failed: type: number description: Number of nodes for which certificates could not be fetched. - security._common:CertificatesDetail: + security._common___CertificatesDetail: type: object properties: issuer_dn: @@ -54668,7 +56919,7 @@ components: type: string not_after: type: string - security._common:CertificatesPerNode: + security._common___CertificatesPerNode: type: object properties: name: @@ -54677,8 +56928,8 @@ components: certificates: type: object additionalProperties: - $ref: '#/components/schemas/security._common:CertificateTypes' - security._common:CertificateTypes: + $ref: '#/components/schemas/security._common___CertificateTypes' + security._common___CertificateTypes: type: object properties: http: @@ -54686,14 +56937,14 @@ components: items: type: object additionalProperties: - $ref: '#/components/schemas/security._common:CertificatesDetail' + $ref: '#/components/schemas/security._common___CertificatesDetail' transport: type: array items: type: object additionalProperties: - $ref: '#/components/schemas/security._common:CertificatesDetail' - security._common:ChangePasswordRequestContent: + $ref: '#/components/schemas/security._common___CertificatesDetail' + security._common___ChangePasswordRequestContent: type: object properties: current_password: @@ -54705,7 +56956,7 @@ components: required: - current_password - password - security._common:ComplianceConfig: + security._common___ComplianceConfig: type: object properties: enabled: @@ -54733,7 +56984,7 @@ components: type: boolean internal_config: type: boolean - security._common:ConfigUpgradePayload: + security._common___ConfigUpgradePayload: type: object properties: config: @@ -54741,7 +56992,7 @@ components: description: List of configs to be upgraded. items: type: string - security._common:Created: + security._common___Created: type: object properties: status: @@ -54751,12 +57002,12 @@ components: message: type: string description: Message returned as part of CREATED response. - security._common:CreateTenantParams: + security._common___CreateTenantParams: type: object properties: description: type: string - security._common:DashboardsInfo: + security._common___DashboardsInfo: type: object properties: user_name: @@ -54794,23 +57045,23 @@ components: password_validation_regex: type: string description: Reg-ex to be used to perform password validation. - security._common:DistinguishedNames: + security._common___DistinguishedNames: type: object properties: nodes_dn: type: array items: type: string - security._common:DistinguishedNamesMap: + security._common___DistinguishedNamesMap: type: object additionalProperties: - $ref: '#/components/schemas/security._common:DistinguishedNames' - security._common:DynamicConfig: + $ref: '#/components/schemas/security._common___DistinguishedNames' + security._common___DynamicConfig: type: object properties: dynamic: - $ref: '#/components/schemas/security._common:DynamicOptions' - security._common:DynamicOptions: + $ref: '#/components/schemas/security._common___DynamicOptions' + security._common___DynamicOptions: type: object properties: filtered_alias_mode: @@ -54843,7 +57094,22 @@ components: type: boolean on_behalf_of: type: object - security._common:GenerateOBOToken: + security._common___Error: + type: object + properties: + status: + type: string + enum: + - BAD_REQUEST + - CONFLICT + - FORBIDDEN + - INTERNAL_SERVER_ERROR + - NOT_FOUND + - NOT_IMPLEMENTED + - UNAUTHORIZED + message: + type: string + security._common___GenerateOBOToken: type: object properties: user: @@ -54854,33 +57120,33 @@ components: description: The generated OBO token. durationSeconds: type: string - description: The duration of the token, defaulted to 300s. - security._common:GetCertificates: + description: The duration of the token. Default is `300s`. + security._common___GetCertificates: type: object properties: http_certificates_list: type: array items: - $ref: '#/components/schemas/security._common:CertificatesDetail' + $ref: '#/components/schemas/security._common___CertificatesDetail' transport_certificates_list: type: array items: - $ref: '#/components/schemas/security._common:CertificatesDetail' - security._common:GetCertificatesNew: + $ref: '#/components/schemas/security._common___CertificatesDetail' + security._common___GetCertificatesNew: type: object properties: _nodes: type: object additionalProperties: - $ref: '#/components/schemas/security._common:CertificateCountPerNode' + $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: + $ref: '#/components/schemas/security._common___CertificatesPerNode' + security._common___HealthInfo: type: object properties: message: @@ -54891,7 +57157,7 @@ components: type: string status: type: string - security._common:IndexPermission: + security._common___IndexPermission: type: object properties: index_patterns: @@ -54912,13 +57178,13 @@ components: type: array items: type: string - security._common:InternalServerError: + security._common___InternalServerError: type: object properties: error: type: string description: Error message during request execution. - security._common:MultiTenancyConfig: + security._common___MultiTenancyConfig: type: object properties: default_tenant: @@ -54931,7 +57197,7 @@ components: type: array items: type: string - security._common:OBOToken: + security._common___OBOToken: type: object properties: description: @@ -54945,7 +57211,7 @@ components: description: Value in seconds. required: - description - security._common:Ok: + security._common___Ok: type: object properties: status: @@ -54955,7 +57221,7 @@ components: message: type: string description: Message returned as part of OK response. - security._common:PatchOperation: + security._common___PatchOperation: type: object properties: op: @@ -54969,7 +57235,7 @@ components: required: - op - path - security._common:PermissionsInfo: + security._common___PermissionsInfo: type: object properties: user: @@ -54980,8 +57246,8 @@ components: type: boolean disabled_endpoints: type: object - description: An object with disabled APIs as key and array of http methods as values. - security._common:Role: + description: An object with disabled APIs as key and array of HTTP methods as values. + security._common___Role: type: object properties: reserved: @@ -54997,14 +57263,14 @@ components: index_permissions: type: array items: - $ref: '#/components/schemas/security._common:IndexPermission' + $ref: '#/components/schemas/security._common___IndexPermission' tenant_permissions: type: array items: - $ref: '#/components/schemas/security._common:TenantPermission' + $ref: '#/components/schemas/security._common___TenantPermission' static: type: boolean - security._common:RoleMapping: + security._common___RoleMapping: type: object properties: hosts: @@ -55029,20 +57295,20 @@ components: type: string description: type: string - security._common:RoleMappings: + security._common___RoleMappings: type: object additionalProperties: - $ref: '#/components/schemas/security._common:RoleMapping' - security._common:RolesMap: + $ref: '#/components/schemas/security._common___RoleMapping' + security._common___RolesMap: type: object additionalProperties: - $ref: '#/components/schemas/security._common:Role' - security._common:SecurityConfig: + $ref: '#/components/schemas/security._common___Role' + security._common___SecurityConfig: type: object properties: config: - $ref: '#/components/schemas/security._common:DynamicConfig' - security._common:SSLInfo: + $ref: '#/components/schemas/security._common___DynamicConfig' + security._common___SSLInfo: type: object properties: principal: @@ -55071,30 +57337,30 @@ components: type: - 'null' - string - description: Protocol for this ssl setup. + description: Protocol for this SSL setup. ssl_cipher: type: - 'null' - string - description: Cipher for this ssl setup. + description: Cipher for this SSL setup. ssl_openssl_available: type: boolean - description: A boolean to indicate if OpenSSL is available. + description: A Boolean to indicate if OpenSSL is available. ssl_openssl_version: type: - number - string - description: Version of openssl. + description: Version of OpenSSL. ssl_openssl_version_string: type: - 'null' - string - description: Full version string for openssl version. + description: Full version string for OpenSSL version. ssl_openssl_non_available_cause: type: - 'null' - string - description: Reason for openssl unavailability. + description: Reason for OpenSSL unavailability. ssl_openssl_supports_key_manager_factory: type: boolean description: Indicates where KMF is supported. @@ -55105,7 +57371,7 @@ components: type: - 'null' - string - description: Returns http provider's name. + description: Returns HTTP provider's name. ssl_provider_transport_server: type: string description: Returns transport server's name. @@ -55126,7 +57392,7 @@ components: - ssl_provider_http - ssl_provider_transport_client - ssl_provider_transport_server - security._common:Tenant: + security._common___Tenant: type: object properties: reserved: @@ -55137,11 +57403,11 @@ components: type: string static: type: boolean - security._common:TenantInfo: + security._common___TenantInfo: type: object additionalProperties: type: string - security._common:TenantPermission: + security._common___TenantPermission: type: object properties: tenant_patterns: @@ -55152,11 +57418,11 @@ components: type: array items: type: string - security._common:TenantsMap: + security._common___TenantsMap: type: object additionalProperties: - $ref: '#/components/schemas/security._common:Tenant' - security._common:UpgradeCheck: + $ref: '#/components/schemas/security._common___Tenant' + security._common___UpgradeCheck: type: object properties: status: @@ -55165,14 +57431,14 @@ components: type: boolean upgradeActions: type: object - security._common:UpgradePerform: + security._common___UpgradePerform: type: object properties: status: type: string upgrades: type: object - security._common:User: + security._common___User: type: object properties: password: @@ -55188,7 +57454,7 @@ components: items: type: string attributes: - $ref: '#/components/schemas/security._common:UserAttributes' + $ref: '#/components/schemas/security._common___UserAttributes' description: type: string opendistro_security_roles: @@ -55197,15 +57463,15 @@ components: type: string static: type: boolean - security._common:UserAttributes: + security._common___UserAttributes: type: object additionalProperties: type: string - security._common:UsersMap: + security._common___UsersMap: type: object additionalProperties: - $ref: '#/components/schemas/security._common:User' - security._common:UserTenants: + $ref: '#/components/schemas/security._common___User' + security._common___UserTenants: type: object properties: global_tenant: @@ -55214,7 +57480,7 @@ components: type: boolean admin: type: boolean - security._common:WhoAmI: + security._common___WhoAmI: type: object properties: dn: @@ -55225,29 +57491,29 @@ components: type: boolean is_node_certificate_request: type: boolean - snapshot._common:FileCountSnapshotStats: + snapshot._common___FileCountSnapshotStats: type: object properties: file_count: type: number size_in_bytes: - $ref: '#/components/schemas/_common:ByteCount' + $ref: '#/components/schemas/_common___ByteCount' required: - file_count - size_in_bytes - snapshot._common:Repository: + snapshot._common___Repository: type: object properties: type: type: string uuid: - $ref: '#/components/schemas/_common:Uuid' + $ref: '#/components/schemas/_common___Uuid' settings: - $ref: '#/components/schemas/snapshot._common:RepositorySettings' + $ref: '#/components/schemas/snapshot._common___RepositorySettings' required: - settings - type - snapshot._common:RepositorySettings: + snapshot._common___RepositorySettings: type: object properties: chunk_size: @@ -55268,7 +57534,7 @@ components: - type: boolean required: - location - snapshot._common:ShardsStats: + snapshot._common___ShardsStats: type: object properties: done: @@ -55290,7 +57556,7 @@ components: - initializing - started - total - snapshot._common:ShardsStatsStage: + snapshot._common___ShardsStatsStage: type: string enum: - DONE @@ -55298,50 +57564,50 @@ components: - FINALIZE - INIT - STARTED - snapshot._common:ShardsStatsSummary: + snapshot._common___ShardsStatsSummary: type: object properties: incremental: - $ref: '#/components/schemas/snapshot._common:ShardsStatsSummaryItem' + $ref: '#/components/schemas/snapshot._common___ShardsStatsSummaryItem' total: - $ref: '#/components/schemas/snapshot._common:ShardsStatsSummaryItem' + $ref: '#/components/schemas/snapshot._common___ShardsStatsSummaryItem' start_time_in_millis: - $ref: '#/components/schemas/_common:EpochTimeUnitMillis' + $ref: '#/components/schemas/_common___EpochTimeUnitMillis' time: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' time_in_millis: - $ref: '#/components/schemas/_common:DurationValueUnitMillis' + $ref: '#/components/schemas/_common___DurationValueUnitMillis' required: - incremental - start_time_in_millis - time_in_millis - total - snapshot._common:ShardsStatsSummaryItem: + snapshot._common___ShardsStatsSummaryItem: type: object properties: file_count: type: number size_in_bytes: - $ref: '#/components/schemas/_common:ByteCount' + $ref: '#/components/schemas/_common___ByteCount' required: - file_count - size_in_bytes - snapshot._common:SnapshotIndexStats: + snapshot._common___SnapshotIndexStats: type: object properties: shards: type: object additionalProperties: - $ref: '#/components/schemas/snapshot._common:SnapshotShardsStatus' + $ref: '#/components/schemas/snapshot._common___SnapshotShardsStatus' shards_stats: - $ref: '#/components/schemas/snapshot._common:ShardsStats' + $ref: '#/components/schemas/snapshot._common___ShardsStats' stats: - $ref: '#/components/schemas/snapshot._common:SnapshotStats' + $ref: '#/components/schemas/snapshot._common___SnapshotStats' required: - shards - shards_stats - stats - snapshot._common:SnapshotInfo: + snapshot._common___SnapshotInfo: type: object properties: data_streams: @@ -55349,62 +57615,62 @@ components: items: type: string duration: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' duration_in_millis: - $ref: '#/components/schemas/_common:DurationValueUnitMillis' + $ref: '#/components/schemas/_common___DurationValueUnitMillis' end_time: - $ref: '#/components/schemas/_common:DateTime' + $ref: '#/components/schemas/_common___DateTime' end_time_in_millis: - $ref: '#/components/schemas/_common:EpochTimeUnitMillis' + $ref: '#/components/schemas/_common___EpochTimeUnitMillis' failures: type: array items: - $ref: '#/components/schemas/snapshot._common:SnapshotShardFailure' + $ref: '#/components/schemas/snapshot._common___SnapshotShardFailure' include_global_state: type: boolean indices: type: array items: - $ref: '#/components/schemas/_common:IndexName' + $ref: '#/components/schemas/_common___IndexName' metadata: - $ref: '#/components/schemas/_common:Metadata' + $ref: '#/components/schemas/_common___Metadata' pinned_timestamp: - $ref: '#/components/schemas/_common:EpochTimeUnitMillis' + $ref: '#/components/schemas/_common___EpochTimeUnitMillis' reason: type: string remote_store_index_shallow_copy: type: boolean snapshot: - $ref: '#/components/schemas/_common:Name' + $ref: '#/components/schemas/_common___Name' shards: - $ref: '#/components/schemas/_common:ShardStatistics' + $ref: '#/components/schemas/_common___ShardStatistics' start_time: - $ref: '#/components/schemas/_common:DateTime' + $ref: '#/components/schemas/_common___DateTime' start_time_in_millis: - $ref: '#/components/schemas/_common:EpochTimeUnitMillis' + $ref: '#/components/schemas/_common___EpochTimeUnitMillis' state: type: string uuid: - $ref: '#/components/schemas/_common:Uuid' + $ref: '#/components/schemas/_common___Uuid' version: - $ref: '#/components/schemas/_common:VersionString' + $ref: '#/components/schemas/_common___VersionString' version_id: - $ref: '#/components/schemas/_common:VersionNumber' + $ref: '#/components/schemas/_common___VersionNumber' required: - data_streams - snapshot - uuid - snapshot._common:SnapshotShardFailure: + snapshot._common___SnapshotShardFailure: type: object properties: index: - $ref: '#/components/schemas/_common:IndexName' + $ref: '#/components/schemas/_common___IndexName' node_id: - $ref: '#/components/schemas/_common:Id' + $ref: '#/components/schemas/_common___Id' reason: type: string shard_id: - $ref: '#/components/schemas/_common:Id' + $ref: '#/components/schemas/_common___Id' status: type: string required: @@ -55412,35 +57678,35 @@ components: - reason - shard_id - status - snapshot._common:SnapshotShardsStatus: + snapshot._common___SnapshotShardsStatus: type: object properties: stage: - $ref: '#/components/schemas/snapshot._common:ShardsStatsStage' + $ref: '#/components/schemas/snapshot._common___ShardsStatsStage' stats: - $ref: '#/components/schemas/snapshot._common:ShardsStatsSummary' + $ref: '#/components/schemas/snapshot._common___ShardsStatsSummary' required: - stage - stats - snapshot._common:SnapshotStats: + snapshot._common___SnapshotStats: type: object properties: incremental: - $ref: '#/components/schemas/snapshot._common:FileCountSnapshotStats' + $ref: '#/components/schemas/snapshot._common___FileCountSnapshotStats' start_time_in_millis: - $ref: '#/components/schemas/_common:EpochTimeUnitMillis' + $ref: '#/components/schemas/_common___EpochTimeUnitMillis' time: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' time_in_millis: - $ref: '#/components/schemas/_common:DurationValueUnitMillis' + $ref: '#/components/schemas/_common___DurationValueUnitMillis' total: - $ref: '#/components/schemas/snapshot._common:FileCountSnapshotStats' + $ref: '#/components/schemas/snapshot._common___FileCountSnapshotStats' required: - incremental - start_time_in_millis - time_in_millis - total - snapshot._common:Status: + snapshot._common___Status: type: object properties: include_global_state: @@ -55448,19 +57714,19 @@ components: indices: type: object additionalProperties: - $ref: '#/components/schemas/snapshot._common:SnapshotIndexStats' + $ref: '#/components/schemas/snapshot._common___SnapshotIndexStats' repository: type: string shards_stats: - $ref: '#/components/schemas/snapshot._common:ShardsStats' + $ref: '#/components/schemas/snapshot._common___ShardsStats' snapshot: type: string state: type: string stats: - $ref: '#/components/schemas/snapshot._common:SnapshotStats' + $ref: '#/components/schemas/snapshot._common___SnapshotStats' uuid: - $ref: '#/components/schemas/_common:Uuid' + $ref: '#/components/schemas/_common___Uuid' required: - include_global_state - indices @@ -55470,7 +57736,7 @@ components: - state - stats - uuid - snapshot.cleanup_repository:CleanupRepositoryResults: + snapshot.cleanup_repository___CleanupRepositoryResults: type: object properties: deleted_blobs: @@ -55484,34 +57750,34 @@ components: required: - deleted_blobs - deleted_bytes - snapshot.restore:SnapshotRestore: + snapshot.restore___SnapshotRestore: type: object properties: indices: type: array items: - $ref: '#/components/schemas/_common:IndexName' + $ref: '#/components/schemas/_common___IndexName' snapshot: type: string shards: - $ref: '#/components/schemas/_common:ShardStatistics' + $ref: '#/components/schemas/_common___ShardStatistics' required: - indices - shards - snapshot - snapshot.verify_repository:CompactNodeInfo: + snapshot.verify_repository___CompactNodeInfo: type: object properties: name: - $ref: '#/components/schemas/_common:Name' + $ref: '#/components/schemas/_common___Name' required: - name - sql._common:Cursor: + sql._common___Cursor: type: object properties: keep_alive: type: string - sql._common:Explain: + sql._common___Explain: type: object properties: query: @@ -55520,7 +57786,7 @@ components: type: object fetch_size: type: integer - sql._common:ExplainBody: + sql._common___ExplainBody: type: object properties: name: @@ -55530,22 +57796,22 @@ components: children: type: array items: - $ref: '#/components/schemas/sql._common:ExplainBody' - sql._common:ExplainResponse: + $ref: '#/components/schemas/sql._common___ExplainBody' + sql._common___ExplainResponse: type: object properties: root: - $ref: '#/components/schemas/sql._common:ExplainBody' - sql._common:Plugins: + $ref: '#/components/schemas/sql._common___ExplainBody' + sql._common___Plugins: type: object properties: ppl: - $ref: '#/components/schemas/sql._common:Ppl' + $ref: '#/components/schemas/sql._common___Ppl' query: - $ref: '#/components/schemas/sql._common:PluginsQuery' + $ref: '#/components/schemas/sql._common___PluginsQuery' sql: - $ref: '#/components/schemas/sql._common:Sql' - sql._common:PluginsQuery: + $ref: '#/components/schemas/sql._common___Sql' + sql._common___PluginsQuery: type: object properties: memory_limit: @@ -55554,14 +57820,14 @@ components: anyOf: - type: string - type: integer - sql._common:Ppl: + sql._common___Ppl: type: object properties: enabled: anyOf: - type: boolean - type: string - sql._common:Query: + sql._common___Query: type: object properties: query: @@ -55570,7 +57836,7 @@ components: type: object fetch_size: type: integer - sql._common:QueryResponse: + sql._common___QueryResponse: type: object properties: schema: @@ -55589,7 +57855,7 @@ components: type: integer status: type: integer - sql._common:Sql: + sql._common___Sql: type: object properties: enabled: @@ -55601,28 +57867,28 @@ components: - type: integer - type: string cursor: - $ref: '#/components/schemas/sql._common:Cursor' - sql._common:SqlClose: + $ref: '#/components/schemas/sql._common___Cursor' + sql._common___SqlClose: type: object properties: cursor: type: string - sql._common:SqlCloseResponse: + sql._common___SqlCloseResponse: type: object properties: succeeded: type: boolean - sql._common:SqlSettings: + sql._common___SqlSettings: type: object properties: transient: - $ref: '#/components/schemas/sql._common:Transient' - sql._common:SqlSettingsPlain: + $ref: '#/components/schemas/sql._common___Transient' + sql._common___SqlSettingsPlain: type: object properties: transient: - $ref: '#/components/schemas/sql._common:TransientPlain' - sql._common:SqlSettingsResponse: + $ref: '#/components/schemas/sql._common___TransientPlain' + sql._common___SqlSettingsResponse: type: object properties: acknowledged: @@ -55630,8 +57896,8 @@ components: persistent: type: object transient: - $ref: '#/components/schemas/sql._common:Transient' - sql._common:Stats: + $ref: '#/components/schemas/sql._common___Transient' + sql._common___Stats: type: object properties: start_time: @@ -55648,12 +57914,12 @@ components: type: object execution_time: type: object - sql._common:Transient: + sql._common___Transient: type: object properties: plugins: - $ref: '#/components/schemas/sql._common:Plugins' - sql._common:TransientPlain: + $ref: '#/components/schemas/sql._common___Plugins' + sql._common___TransientPlain: type: object properties: plugins.sql.enabled: @@ -55668,58 +57934,63 @@ components: type: string plugins.query.size_limit: type: integer - tasks._common:GroupBy: + tasks._common___GroupBy: type: string enum: - nodes - none - parents - tasks._common:PersistentTaskStatus: + tasks._common___PersistentTaskStatus: type: object properties: state: type: string required: - state - tasks._common:RawTaskStatus: + tasks._common___RawTaskStatus: type: object additionalProperties: title: metadata - tasks._common:ReplicationTaskStatus: + tasks._common___ReplicationTaskStatus: type: object properties: phase: type: string required: - phase - tasks._common:Status: + tasks._common___Status: description: Task status information can vary wildly from task to task. anyOf: - - $ref: '#/components/schemas/tasks._common:ReplicationTaskStatus' - - $ref: '#/components/schemas/_common:BulkByScrollTaskStatus' - - $ref: '#/components/schemas/tasks._common:PersistentTaskStatus' - - $ref: '#/components/schemas/tasks._common:RawTaskStatus' - tasks._common:TaskExecutingNode: + - $ref: '#/components/schemas/tasks._common___ReplicationTaskStatus' + - $ref: '#/components/schemas/_common___BulkByScrollTaskStatus' + - $ref: '#/components/schemas/tasks._common___PersistentTaskStatus' + - $ref: '#/components/schemas/tasks._common___RawTaskStatus' + tasks._common___TaskExecutingNode: allOf: - - $ref: '#/components/schemas/_common:BaseNode' + - $ref: '#/components/schemas/_common___BaseNode' - type: object properties: tasks: type: object additionalProperties: - $ref: '#/components/schemas/tasks._common:TaskInfo' + $ref: '#/components/schemas/tasks._common___TaskInfo' required: - tasks - tasks._common:TaskGroup: + tasks._common___TaskGroup: allOf: - - $ref: '#/components/schemas/tasks._common:TaskInfo' + - $ref: '#/components/schemas/tasks._common___TaskInfoBase' - type: object properties: children: type: array items: - $ref: '#/components/schemas/tasks._common:TaskGroup' - tasks._common:TaskInfo: + $ref: '#/components/schemas/tasks._common___TaskGroup' + tasks._common___TaskInfo: + allOf: + - $ref: '#/components/schemas/tasks._common___TaskInfoBase' + - type: object + properties: {} + tasks._common___TaskInfoBase: type: object properties: action: @@ -55738,19 +58009,19 @@ components: type: integer format: int64 node: - $ref: '#/components/schemas/_common:NodeId' + $ref: '#/components/schemas/_common___NodeId' running_time: - $ref: '#/components/schemas/_common:Duration' + $ref: '#/components/schemas/_common___Duration' running_time_in_nanos: - $ref: '#/components/schemas/_common:DurationValueUnitNanos' + $ref: '#/components/schemas/_common___DurationValueUnitNanos' start_time_in_millis: - $ref: '#/components/schemas/_common:EpochTimeUnitMillis' + $ref: '#/components/schemas/_common___EpochTimeUnitMillis' status: - $ref: '#/components/schemas/tasks._common:Status' + $ref: '#/components/schemas/tasks._common___Status' type: type: string parent_task_id: - $ref: '#/components/schemas/_common:TaskId' + $ref: '#/components/schemas/_common___TaskId' required: - action - cancellable @@ -55760,38 +58031,38 @@ components: - running_time_in_nanos - start_time_in_millis - type - tasks._common:TaskInfos: + tasks._common___TaskInfos: oneOf: - title: grouped_by_none type: array items: - $ref: '#/components/schemas/tasks._common:TaskInfo' + $ref: '#/components/schemas/tasks._common___TaskInfo' - title: grouped_by_parents type: object additionalProperties: - $ref: '#/components/schemas/tasks._common:TaskGroup' - tasks._common:TaskListResponseBase: + $ref: '#/components/schemas/tasks._common___TaskGroup' + tasks._common___TaskListResponseBase: type: object properties: node_failures: type: array items: - $ref: '#/components/schemas/_common:ErrorCause' + $ref: '#/components/schemas/_common___ErrorCause' task_failures: type: array items: - $ref: '#/components/schemas/_common:TaskFailure' + $ref: '#/components/schemas/_common___TaskFailure' nodes: description: Task information grouped by node, if `group_by` was set to `node` (the default). type: object additionalProperties: - $ref: '#/components/schemas/tasks._common:TaskExecutingNode' + $ref: '#/components/schemas/tasks._common___TaskExecutingNode' tasks: - $ref: '#/components/schemas/tasks._common:TaskInfos' - tasks._common:TaskResponse: + $ref: '#/components/schemas/tasks._common___TaskInfos' + tasks._common___TaskResponse: anyOf: - - $ref: '#/components/schemas/_common:BulkByScrollResponseBase' - transforms._common:ContinuousStats: + - $ref: '#/components/schemas/_common___BulkByScrollResponseBase' + transforms._common___ContinuousStats: type: object properties: last_timestamp: @@ -55800,7 +58071,7 @@ components: type: object additionalProperties: type: number - transforms._common:DateHistogramGroup: + transforms._common___DateHistogramGroup: type: object properties: fixed_interval: @@ -55813,18 +58084,18 @@ components: type: string target_field: type: string - transforms._common:Explain: + transforms._common___Explain: type: object properties: metadata_id: type: string transform_metadata: - $ref: '#/components/schemas/transforms._common:TransformMetadata' - transforms._common:ExplainResponse: + $ref: '#/components/schemas/transforms._common___TransformMetadata' + transforms._common___ExplainResponse: type: object additionalProperties: - $ref: '#/components/schemas/transforms._common:Explain' - transforms._common:ExplainStats: + $ref: '#/components/schemas/transforms._common___Explain' + transforms._common___ExplainStats: type: object properties: pages_processed: @@ -55837,18 +58108,18 @@ components: type: number search_time_in_millis: type: number - transforms._common:GroupsConfigItem: + transforms._common___GroupsConfigItem: type: object properties: histogram: - $ref: '#/components/schemas/transforms._common:HistogramGroup' + $ref: '#/components/schemas/transforms._common___HistogramGroup' date_histogram: - $ref: '#/components/schemas/transforms._common:DateHistogramGroup' + $ref: '#/components/schemas/transforms._common___DateHistogramGroup' terms: - $ref: '#/components/schemas/transforms._common:TermsGroup' + $ref: '#/components/schemas/transforms._common___TermsGroup' minProperties: 1 maxProperties: 1 - transforms._common:HistogramGroup: + transforms._common___HistogramGroup: type: object properties: source_field: @@ -55857,7 +58128,7 @@ components: type: string interval: type: string - transforms._common:MetricsConfigItem: + transforms._common___MetricsConfigItem: type: object properties: source_field: @@ -55867,8 +58138,8 @@ components: metrics: type: array items: - $ref: '#/components/schemas/transforms._common:MetricsConfigMetrics' - transforms._common:MetricsConfigMetrics: + $ref: '#/components/schemas/transforms._common___MetricsConfigMetrics' + transforms._common___MetricsConfigMetrics: type: object properties: avg: @@ -55883,21 +58154,21 @@ components: type: object minProperties: 1 maxProperties: 1 - transforms._common:Preview: + transforms._common___Preview: type: object properties: documents: type: array items: type: object - transforms._common:Schedule: + transforms._common___Schedule: type: object properties: interval: - $ref: '#/components/schemas/transforms._common:ScheduleInterval' + $ref: '#/components/schemas/transforms._common___ScheduleInterval' required: - interval - transforms._common:ScheduleInterval: + transforms._common___ScheduleInterval: type: object properties: start_time: @@ -55906,14 +58177,14 @@ components: type: number unit: type: string - transforms._common:TermsGroup: + transforms._common___TermsGroup: type: object properties: source_field: type: string target_field: type: string - transforms._common:Transform: + transforms._common___Transform: type: object properties: transform_id: @@ -55923,7 +58194,7 @@ components: continuous: type: boolean schedule: - $ref: '#/components/schemas/transforms._common:Schedule' + $ref: '#/components/schemas/transforms._common___Schedule' metadata_id: type: string updated_at: @@ -55937,7 +58208,7 @@ components: source_index: type: string data_selection_query: - $ref: '#/components/schemas/_common.query_dsl:QueryContainer' + $ref: '#/components/schemas/_common.query_dsl___QueryContainer' target_index: type: string roles: @@ -55949,12 +58220,12 @@ components: groups: type: array items: - $ref: '#/components/schemas/transforms._common:GroupsConfigItem' + $ref: '#/components/schemas/transforms._common___GroupsConfigItem' aggregations: type: array items: - $ref: '#/components/schemas/transforms._common:MetricsConfigItem' - transforms._common:TransformEntity: + $ref: '#/components/schemas/transforms._common___MetricsConfigItem' + transforms._common___TransformEntity: type: object properties: _id: @@ -55964,12 +58235,12 @@ components: _primaryTerm: type: number transform: - $ref: '#/components/schemas/transforms._common:Transform' - transforms._common:TransformMetadata: + $ref: '#/components/schemas/transforms._common___Transform' + transforms._common___TransformMetadata: type: object properties: continuous_stats: - $ref: '#/components/schemas/transforms._common:ContinuousStats' + $ref: '#/components/schemas/transforms._common___ContinuousStats' transform_id: type: string last_updated_at: @@ -55979,8 +58250,8 @@ components: failure_reason: type: string stats: - $ref: '#/components/schemas/transforms._common:ExplainStats' - transforms._common:TransformsResponse: + $ref: '#/components/schemas/transforms._common___ExplainStats' + transforms._common___TransformsResponse: type: object properties: total_transforms: @@ -55988,4 +58259,110 @@ components: transforms: type: array items: - $ref: '#/components/schemas/transforms._common:TransformEntity' + $ref: '#/components/schemas/transforms._common___TransformEntity' + wlm._common___QueryGroupCreate: + type: object + properties: + name: + type: string + resiliency_mode: + type: string + enum: + - enforced + - monitor + - soft + resource_limits: + anyOf: + - type: object + properties: + memory: + type: number + format: double + cpu: + type: number + format: double + required: + - memory + - type: object + properties: + memory: + type: number + format: double + cpu: + type: number + format: double + required: + - cpu + required: + - name + - resiliency_mode + - resource_limits + wlm._common___QueryGroupResponse: + type: object + properties: + _id: + description: The ID of the query group, which can be used to associate query requests with the group and enforce the group's resource limits. + type: string + name: + description: The name of the query group. + type: string + resiliency_mode: + description: The resiliency mode of the query group. + type: string + enum: + - enforced + - monitor + - soft + updated_at: + description: The time at which the query group was last updated. + type: integer + format: int64 + resource_limits: + description: The resource limits for query requests in the query group. + anyOf: + - type: object + properties: + memory: + type: number + format: double + cpu: + type: number + format: double + required: + - memory + - type: object + properties: + memory: + type: number + format: double + cpu: + type: number + format: double + required: + - cpu + required: + - _id + - name + - resiliency_mode + - resource_limits + - updated_at + wlm._common___QueryGroupUpdate: + type: object + properties: + resiliency_mode: + type: string + enum: + - enforced + - monitor + - soft + resource_limits: + $ref: '#/components/schemas/wlm._common___ResourceLimitsSchema' + wlm._common___ResourceLimitsSchema: + type: object + properties: + memory: + type: number + format: double + cpu: + type: number + format: double diff --git a/src/OpenSearch.Client/_Generated/ApiUrlsLookup.cs b/src/OpenSearch.Client/_Generated/ApiUrlsLookup.cs index 8aff6a18bb..23fce1bae3 100644 --- a/src/OpenSearch.Client/_Generated/ApiUrlsLookup.cs +++ b/src/OpenSearch.Client/_Generated/ApiUrlsLookup.cs @@ -143,7 +143,14 @@ internal static partial class ApiUrlsLookups new(["_cluster/state", "_cluster/state/{metric}", "_cluster/state/{metric}/{index}"]); internal static readonly ApiUrls ClusterStats = - new(["_cluster/stats", "_cluster/stats/nodes/{node_id}"]); + new( + [ + "_cluster/stats", + "_cluster/stats/{metric}/{index_metric}/nodes/{node_id}", + "_cluster/stats/{metric}/nodes/{node_id}", + "_cluster/stats/nodes/{node_id}", + ] + ); internal static readonly ApiUrls NoNamespaceCount = new(["_count", "{index}/_count"]); diff --git a/src/OpenSearch.Client/_Generated/Descriptors.Cat.cs b/src/OpenSearch.Client/_Generated/Descriptors.Cat.cs index 9b1f18dd16..6198e73b9c 100644 --- a/src/OpenSearch.Client/_Generated/Descriptors.Cat.cs +++ b/src/OpenSearch.Client/_Generated/Descriptors.Cat.cs @@ -85,11 +85,11 @@ public CatAliasesDescriptor Name(Names name) => Assign(name, (a, v) => a.RouteValues.Optional("name", v)); // Request parameters - /// Whether to expand wildcard expression to concrete indices that are open, closed or both. + /// Whether to expand wildcard expression to concrete indexes that are open, closed or both. public CatAliasesDescriptor ExpandWildcards(ExpandWildcards? expandwildcards) => Qs("expand_wildcards", expandwildcards); - /// A short version of the Accept header, e.g. json, yaml. + /// A short version of the Accept header (for example, `json`, `yaml`). public CatAliasesDescriptor Format(string format) => Qs("format", format); /// Comma-separated list of column names to display. @@ -125,7 +125,7 @@ public partial class CatAllPitSegmentsDescriptor /// The unit in which to display byte values. public CatAllPitSegmentsDescriptor Bytes(ByteUnit? bytes) => Qs("bytes", bytes); - /// A short version of the Accept header, e.g. json, yaml. + /// A short version of the Accept header (for example, `json`, `yaml`). public CatAllPitSegmentsDescriptor Format(string format) => Qs("format", format); /// Comma-separated list of column names to display. @@ -178,7 +178,7 @@ public CatAllocationDescriptor NodeId(NodeIds nodeId) => public CatAllocationDescriptor ClusterManagerTimeout(Time clustermanagertimeout) => Qs("cluster_manager_timeout", clustermanagertimeout); - /// A short version of the Accept header, e.g. json, yaml. + /// A short version of the Accept header (for example, `json`, `yaml`). public CatAllocationDescriptor Format(string format) => Qs("format", format); /// Comma-separated list of column names to display. @@ -190,9 +190,9 @@ public CatAllocationDescriptor ClusterManagerTimeout(Time clustermanagertimeout) /// Return local information, do not retrieve the state from cluster-manager node. public CatAllocationDescriptor Local(bool? local = true) => Qs("local", local); - /// Operation timeout for connection to master node. + /// Operation timeout for connection to cluster-manager node. [Obsolete( - "Deprecated as of: 2.0.0, reason: To promote inclusive language, use 'cluster_manager_timeout' instead." + "Deprecated as of: 2.0.0, reason: To promote inclusive language, use `cluster_manager_timeout` instead." )] public CatAllocationDescriptor MasterTimeout(Time mastertimeout) => Qs("master_timeout", mastertimeout); @@ -223,7 +223,7 @@ public partial class CatClusterManagerDescriptor public CatClusterManagerDescriptor ClusterManagerTimeout(Time clustermanagertimeout) => Qs("cluster_manager_timeout", clustermanagertimeout); - /// A short version of the Accept header, e.g. json, yaml. + /// A short version of the Accept header (for example, `json`, `yaml`). public CatClusterManagerDescriptor Format(string format) => Qs("format", format); /// Comma-separated list of column names to display. @@ -235,9 +235,9 @@ public CatClusterManagerDescriptor ClusterManagerTimeout(Time clustermanagertime /// Return local information, do not retrieve the state from cluster-manager node. public CatClusterManagerDescriptor Local(bool? local = true) => Qs("local", local); - /// Operation timeout for connection to master node. + /// Operation timeout for connection to cluster-manager node. [Obsolete( - "Deprecated as of: 2.0.0, reason: To promote inclusive language, use 'cluster_manager_timeout' instead." + "Deprecated as of: 2.0.0, reason: To promote inclusive language, use `cluster_manager_timeout` instead." )] public CatClusterManagerDescriptor MasterTimeout(Time mastertimeout) => Qs("master_timeout", mastertimeout); @@ -269,7 +269,7 @@ public CatCountDescriptor(Indices index) // values part of the url path Indices ICatCountRequest.Index => Self.RouteValues.Get("index"); - /// Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams and indices, omit this parameter or use `*` or `_all`. + /// Comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams and indexes, omit this parameter or use `*` or `_all`. public CatCountDescriptor Index(Indices index) => Assign(index, (a, v) => a.RouteValues.Optional("index", v)); @@ -282,7 +282,7 @@ public CatCountDescriptor Index() public CatCountDescriptor AllIndices() => Index(Indices.All); // Request parameters - /// A short version of the Accept header, e.g. json, yaml. + /// A short version of the Accept header (for example, `json`, `yaml`). public CatCountDescriptor Format(string format) => Qs("format", format); /// Comma-separated list of column names to display. @@ -334,7 +334,7 @@ public CatFielddataDescriptor Fields(params Expression>[] fie /// The unit used to display byte values. public CatFielddataDescriptor Bytes(ByteUnit? bytes) => Qs("bytes", bytes); - /// A short version of the Accept header, e.g. json, yaml. + /// A short version of the Accept header (for example, `json`, `yaml`). public CatFielddataDescriptor Format(string format) => Qs("format", format); /// Comma-separated list of column names to display. @@ -360,7 +360,7 @@ public partial class CatHealthDescriptor // values part of the url path // Request parameters - /// A short version of the Accept header, e.g. json, yaml. + /// A short version of the Accept header (for example, `json`, `yaml`). public CatHealthDescriptor Format(string format) => Qs("format", format); /// Comma-separated list of column names to display. @@ -369,7 +369,7 @@ public partial class CatHealthDescriptor /// Return help information. public CatHealthDescriptor Help(bool? help = true) => Qs("help", help); - /// If true, returns `HH:MM:SS` and Unix epoch timestamps. + /// If `true`, returns `HH:MM:SS` and Unix epoch timestamps. public CatHealthDescriptor IncludeTimestamp(bool? includetimestamp = true) => Qs("ts", includetimestamp); @@ -414,7 +414,7 @@ public CatIndicesDescriptor(Indices index) // values part of the url path Indices ICatIndicesRequest.Index => Self.RouteValues.Get("index"); - /// Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams and indices, omit this parameter or use `*` or `_all`. + /// Comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams and indexes, omit this parameter or use `*` or `_all`. public CatIndicesDescriptor Index(Indices index) => Assign(index, (a, v) => a.RouteValues.Optional("index", v)); @@ -439,33 +439,33 @@ public CatIndicesDescriptor ClusterManagerTimeout(Time clustermanagertimeout) => public CatIndicesDescriptor ExpandWildcards(ExpandWildcards? expandwildcards) => Qs("expand_wildcards", expandwildcards); - /// A short version of the Accept header, e.g. json, yaml. + /// A short version of the Accept header (for example, `json`, `yaml`). public CatIndicesDescriptor Format(string format) => Qs("format", format); /// Comma-separated list of column names to display. public CatIndicesDescriptor Headers(params string[] headers) => Qs("h", headers); - /// The health status used to limit returned indices. By default, the response includes indices of any health status. + /// The health status used to limit returned indexes. By default, the response includes indexes of any health status. public CatIndicesDescriptor Health(HealthStatus? health) => Qs("health", health); /// Return help information. public CatIndicesDescriptor Help(bool? help = true) => Qs("help", help); - /// If true, the response includes information from segments that are not loaded into memory. + /// If `true`, the response includes information from segments that are not loaded into memory. public CatIndicesDescriptor IncludeUnloadedSegments(bool? includeunloadedsegments = true) => Qs("include_unloaded_segments", includeunloadedsegments); /// Return local information, do not retrieve the state from cluster-manager node. public CatIndicesDescriptor Local(bool? local = true) => Qs("local", local); - /// Operation timeout for connection to master node. + /// Operation timeout for connection to cluster-manager node. [Obsolete( - "Deprecated as of: 2.0.0, reason: To promote inclusive language, use 'cluster_manager_timeout' instead." + "Deprecated as of: 2.0.0, reason: To promote inclusive language, use `cluster_manager_timeout` instead." )] public CatIndicesDescriptor MasterTimeout(Time mastertimeout) => Qs("master_timeout", mastertimeout); - /// If true, the response only includes information from primary shards. + /// If `true`, the response only includes information from primary shards. public CatIndicesDescriptor Pri(bool? pri = true) => Qs("pri", pri); /// Comma-separated list of column names or column aliases to sort by. @@ -490,7 +490,7 @@ public partial class CatMasterDescriptor public CatMasterDescriptor ClusterManagerTimeout(Time clustermanagertimeout) => Qs("cluster_manager_timeout", clustermanagertimeout); - /// A short version of the Accept header, e.g. json, yaml. + /// A short version of the Accept header (for example, `json`, `yaml`). public CatMasterDescriptor Format(string format) => Qs("format", format); /// Comma-separated list of column names to display. @@ -502,9 +502,9 @@ public CatMasterDescriptor ClusterManagerTimeout(Time clustermanagertimeout) => /// Return local information, do not retrieve the state from cluster-manager node. public CatMasterDescriptor Local(bool? local = true) => Qs("local", local); - /// Operation timeout for connection to master node. + /// Operation timeout for connection to cluster-manager node. [Obsolete( - "Deprecated as of: 2.0.0, reason: To promote inclusive language, use 'cluster_manager_timeout' instead." + "Deprecated as of: 2.0.0, reason: To promote inclusive language, use `cluster_manager_timeout` instead." )] public CatMasterDescriptor MasterTimeout(Time mastertimeout) => Qs("master_timeout", mastertimeout); @@ -535,7 +535,7 @@ public partial class CatNodeAttributesDescriptor public CatNodeAttributesDescriptor ClusterManagerTimeout(Time clustermanagertimeout) => Qs("cluster_manager_timeout", clustermanagertimeout); - /// A short version of the Accept header, e.g. json, yaml. + /// A short version of the Accept header (for example, `json`, `yaml`). public CatNodeAttributesDescriptor Format(string format) => Qs("format", format); /// Comma-separated list of column names to display. @@ -547,9 +547,9 @@ public CatNodeAttributesDescriptor ClusterManagerTimeout(Time clustermanagertime /// Return local information, do not retrieve the state from cluster-manager node. public CatNodeAttributesDescriptor Local(bool? local = true) => Qs("local", local); - /// Operation timeout for connection to master node. + /// Operation timeout for connection to cluster-manager node. [Obsolete( - "Deprecated as of: 2.0.0, reason: To promote inclusive language, use 'cluster_manager_timeout' instead." + "Deprecated as of: 2.0.0, reason: To promote inclusive language, use `cluster_manager_timeout` instead." )] public CatNodeAttributesDescriptor MasterTimeout(Time mastertimeout) => Qs("master_timeout", mastertimeout); @@ -579,7 +579,7 @@ public partial class CatNodesDescriptor public CatNodesDescriptor ClusterManagerTimeout(Time clustermanagertimeout) => Qs("cluster_manager_timeout", clustermanagertimeout); - /// A short version of the Accept header, e.g. json, yaml. + /// A short version of the Accept header (for example, `json`, `yaml`). public CatNodesDescriptor Format(string format) => Qs("format", format); /// If `true`, return the full node ID. If `false`, return the shortened node ID. @@ -597,9 +597,9 @@ public CatNodesDescriptor ClusterManagerTimeout(Time clustermanagertimeout) => )] public CatNodesDescriptor Local(bool? local = true) => Qs("local", local); - /// Operation timeout for connection to master node. + /// Operation timeout for connection to cluster-manager node. [Obsolete( - "Deprecated as of: 2.0.0, reason: To promote inclusive language, use 'cluster_manager_timeout' instead." + "Deprecated as of: 2.0.0, reason: To promote inclusive language, use `cluster_manager_timeout` instead." )] public CatNodesDescriptor MasterTimeout(Time mastertimeout) => Qs("master_timeout", mastertimeout); @@ -630,7 +630,7 @@ public partial class CatPendingTasksDescriptor public CatPendingTasksDescriptor ClusterManagerTimeout(Time clustermanagertimeout) => Qs("cluster_manager_timeout", clustermanagertimeout); - /// A short version of the Accept header, e.g. json, yaml. + /// A short version of the Accept header (for example, `json`, `yaml`). public CatPendingTasksDescriptor Format(string format) => Qs("format", format); /// Comma-separated list of column names to display. @@ -642,9 +642,9 @@ public CatPendingTasksDescriptor ClusterManagerTimeout(Time clustermanagertimeou /// Return local information, do not retrieve the state from cluster-manager node. public CatPendingTasksDescriptor Local(bool? local = true) => Qs("local", local); - /// Operation timeout for connection to master node. + /// Operation timeout for connection to cluster-manager node. [Obsolete( - "Deprecated as of: 2.0.0, reason: To promote inclusive language, use 'cluster_manager_timeout' instead." + "Deprecated as of: 2.0.0, reason: To promote inclusive language, use `cluster_manager_timeout` instead." )] public CatPendingTasksDescriptor MasterTimeout(Time mastertimeout) => Qs("master_timeout", mastertimeout); @@ -673,7 +673,7 @@ public partial class CatPitSegmentsDescriptor /// The unit in which to display byte values. public CatPitSegmentsDescriptor Bytes(ByteUnit? bytes) => Qs("bytes", bytes); - /// A short version of the Accept header, e.g. json, yaml. + /// A short version of the Accept header (for example, `json`, `yaml`). public CatPitSegmentsDescriptor Format(string format) => Qs("format", format); /// Comma-separated list of column names to display. @@ -708,7 +708,7 @@ public partial class CatPluginsDescriptor public CatPluginsDescriptor ClusterManagerTimeout(Time clustermanagertimeout) => Qs("cluster_manager_timeout", clustermanagertimeout); - /// A short version of the Accept header, e.g. json, yaml. + /// A short version of the Accept header (for example, `json`, `yaml`). public CatPluginsDescriptor Format(string format) => Qs("format", format); /// Comma-separated list of column names to display. @@ -720,9 +720,9 @@ public CatPluginsDescriptor ClusterManagerTimeout(Time clustermanagertimeout) => /// Return local information, do not retrieve the state from cluster-manager node. public CatPluginsDescriptor Local(bool? local = true) => Qs("local", local); - /// Operation timeout for connection to master node. + /// Operation timeout for connection to cluster-manager node. [Obsolete( - "Deprecated as of: 2.0.0, reason: To promote inclusive language, use 'cluster_manager_timeout' instead." + "Deprecated as of: 2.0.0, reason: To promote inclusive language, use `cluster_manager_timeout` instead." )] public CatPluginsDescriptor MasterTimeout(Time mastertimeout) => Qs("master_timeout", mastertimeout); @@ -758,7 +758,7 @@ public CatRecoveryDescriptor(Indices index) // values part of the url path Indices ICatRecoveryRequest.Index => Self.RouteValues.Get("index"); - /// A comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams and indices, omit this parameter or use `*` or `_all`. + /// A comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams and indexes, omit this parameter or use `*` or `_all`. public CatRecoveryDescriptor Index(Indices index) => Assign(index, (a, v) => a.RouteValues.Optional("index", v)); @@ -781,7 +781,7 @@ public CatRecoveryDescriptor ActiveOnly(bool? activeonly = true) => /// If `true`, the response includes detailed information about shard recoveries. public CatRecoveryDescriptor Detailed(bool? detailed = true) => Qs("detailed", detailed); - /// A short version of the Accept header, e.g. json, yaml. + /// A short version of the Accept header (for example, `json`, `yaml`). public CatRecoveryDescriptor Format(string format) => Qs("format", format); /// Comma-separated list of column names to display. @@ -816,7 +816,7 @@ public partial class CatRepositoriesDescriptor public CatRepositoriesDescriptor ClusterManagerTimeout(Time clustermanagertimeout) => Qs("cluster_manager_timeout", clustermanagertimeout); - /// A short version of the Accept header, e.g. json, yaml. + /// A short version of the Accept header (for example, `json`, `yaml`). public CatRepositoriesDescriptor Format(string format) => Qs("format", format); /// Comma-separated list of column names to display. @@ -828,9 +828,9 @@ public CatRepositoriesDescriptor ClusterManagerTimeout(Time clustermanagertimeou /// Return local information, do not retrieve the state from cluster-manager node. public CatRepositoriesDescriptor Local(bool? local = true) => Qs("local", local); - /// Operation timeout for connection to master node. + /// Operation timeout for connection to cluster-manager node. [Obsolete( - "Deprecated as of: 2.0.0, reason: To promote inclusive language, use 'cluster_manager_timeout' instead." + "Deprecated as of: 2.0.0, reason: To promote inclusive language, use `cluster_manager_timeout` instead." )] public CatRepositoriesDescriptor MasterTimeout(Time mastertimeout) => Qs("master_timeout", mastertimeout); @@ -883,7 +883,7 @@ public CatSegmentReplicationDescriptor Index() public CatSegmentReplicationDescriptor ActiveOnly(bool? activeonly = true) => Qs("active_only", activeonly); - /// Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified). + /// Whether to ignore if a wildcard indexes expression resolves into no concrete indexes. (This includes `_all` string or when no indexes have been specified). public CatSegmentReplicationDescriptor AllowNoIndices(bool? allownoindices = true) => Qs("allow_no_indices", allownoindices); @@ -898,11 +898,11 @@ public CatSegmentReplicationDescriptor CompletedOnly(bool? completedonly = true) public CatSegmentReplicationDescriptor Detailed(bool? detailed = true) => Qs("detailed", detailed); - /// Whether to expand wildcard expression to concrete indices that are open, closed or both. + /// Whether to expand wildcard expression to concrete indexes that are open, closed or both. public CatSegmentReplicationDescriptor ExpandWildcards(ExpandWildcards? expandwildcards) => Qs("expand_wildcards", expandwildcards); - /// A short version of the Accept header, e.g. json, yaml. + /// A short version of the Accept header (for example, `json`, `yaml`). public CatSegmentReplicationDescriptor Format(string format) => Qs("format", format); /// Comma-separated list of column names to display. @@ -911,11 +911,11 @@ public CatSegmentReplicationDescriptor ExpandWildcards(ExpandWildcards? expandwi /// Return help information. public CatSegmentReplicationDescriptor Help(bool? help = true) => Qs("help", help); - /// Whether specified concrete, expanded or aliased indices should be ignored when throttled. + /// Whether specified concrete, expanded or aliased indexes should be ignored when throttled. public CatSegmentReplicationDescriptor IgnoreThrottled(bool? ignorethrottled = true) => Qs("ignore_throttled", ignorethrottled); - /// Whether specified concrete indices should be ignored when unavailable (missing or closed). + /// Whether specified concrete indexes should be ignored when unavailable (missing or closed). public CatSegmentReplicationDescriptor IgnoreUnavailable(bool? ignoreunavailable = true) => Qs("ignore_unavailable", ignoreunavailable); @@ -957,7 +957,7 @@ public CatSegmentsDescriptor(Indices index) // values part of the url path Indices ICatSegmentsRequest.Index => Self.RouteValues.Get("index"); - /// A comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams and indices, omit this parameter or use `*` or `_all`. + /// A comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams and indexes, omit this parameter or use `*` or `_all`. public CatSegmentsDescriptor Index(Indices index) => Assign(index, (a, v) => a.RouteValues.Optional("index", v)); @@ -978,7 +978,7 @@ public CatSegmentsDescriptor Index() public CatSegmentsDescriptor ClusterManagerTimeout(Time clustermanagertimeout) => Qs("cluster_manager_timeout", clustermanagertimeout); - /// A short version of the Accept header, e.g. json, yaml. + /// A short version of the Accept header (for example, `json`, `yaml`). public CatSegmentsDescriptor Format(string format) => Qs("format", format); /// Comma-separated list of column names to display. @@ -987,9 +987,9 @@ public CatSegmentsDescriptor ClusterManagerTimeout(Time clustermanagertimeout) = /// Return help information. public CatSegmentsDescriptor Help(bool? help = true) => Qs("help", help); - /// Operation timeout for connection to master node. + /// Operation timeout for connection to cluster-manager node. [Obsolete( - "Deprecated as of: 2.0.0, reason: To promote inclusive language, use 'cluster_manager_timeout' instead." + "Deprecated as of: 2.0.0, reason: To promote inclusive language, use `cluster_manager_timeout` instead." )] public CatSegmentsDescriptor MasterTimeout(Time mastertimeout) => Qs("master_timeout", mastertimeout); @@ -1021,7 +1021,7 @@ public CatShardsDescriptor(Indices index) // values part of the url path Indices ICatShardsRequest.Index => Self.RouteValues.Get("index"); - /// A comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams and indices, omit this parameter or use `*` or `_all`. + /// A comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams and indexes, omit this parameter or use `*` or `_all`. public CatShardsDescriptor Index(Indices index) => Assign(index, (a, v) => a.RouteValues.Optional("index", v)); @@ -1042,7 +1042,7 @@ public CatShardsDescriptor Index() public CatShardsDescriptor ClusterManagerTimeout(Time clustermanagertimeout) => Qs("cluster_manager_timeout", clustermanagertimeout); - /// A short version of the Accept header, e.g. json, yaml. + /// A short version of the Accept header (for example, `json`, `yaml`). public CatShardsDescriptor Format(string format) => Qs("format", format); /// Comma-separated list of column names to display. @@ -1054,9 +1054,9 @@ public CatShardsDescriptor ClusterManagerTimeout(Time clustermanagertimeout) => /// Return local information, do not retrieve the state from cluster-manager node. public CatShardsDescriptor Local(bool? local = true) => Qs("local", local); - /// Operation timeout for connection to master node. + /// Operation timeout for connection to cluster-manager node. [Obsolete( - "Deprecated as of: 2.0.0, reason: To promote inclusive language, use 'cluster_manager_timeout' instead." + "Deprecated as of: 2.0.0, reason: To promote inclusive language, use `cluster_manager_timeout` instead." )] public CatShardsDescriptor MasterTimeout(Time mastertimeout) => Qs("master_timeout", mastertimeout); @@ -1102,7 +1102,7 @@ public CatSnapshotsDescriptor RepositoryName(Names repository) => public CatSnapshotsDescriptor ClusterManagerTimeout(Time clustermanagertimeout) => Qs("cluster_manager_timeout", clustermanagertimeout); - /// A short version of the Accept header, e.g. json, yaml. + /// A short version of the Accept header (for example, `json`, `yaml`). public CatSnapshotsDescriptor Format(string format) => Qs("format", format); /// Comma-separated list of column names to display. @@ -1115,9 +1115,9 @@ public CatSnapshotsDescriptor ClusterManagerTimeout(Time clustermanagertimeout) public CatSnapshotsDescriptor IgnoreUnavailable(bool? ignoreunavailable = true) => Qs("ignore_unavailable", ignoreunavailable); - /// Operation timeout for connection to master node. + /// Operation timeout for connection to cluster-manager node. [Obsolete( - "Deprecated as of: 2.0.0, reason: To promote inclusive language, use 'cluster_manager_timeout' instead." + "Deprecated as of: 2.0.0, reason: To promote inclusive language, use `cluster_manager_timeout` instead." )] public CatSnapshotsDescriptor MasterTimeout(Time mastertimeout) => Qs("master_timeout", mastertimeout); @@ -1145,7 +1145,7 @@ public partial class CatTasksDescriptor /// If `true`, the response includes detailed information about shard recoveries. public CatTasksDescriptor Detailed(bool? detailed = true) => Qs("detailed", detailed); - /// A short version of the Accept header, e.g. json, yaml. + /// A short version of the Accept header (for example, `json`, `yaml`). public CatTasksDescriptor Format(string format) => Qs("format", format); /// Comma-separated list of column names to display. @@ -1202,7 +1202,7 @@ public CatTemplatesDescriptor Name(Name name) => public CatTemplatesDescriptor ClusterManagerTimeout(Time clustermanagertimeout) => Qs("cluster_manager_timeout", clustermanagertimeout); - /// A short version of the Accept header, e.g. json, yaml. + /// A short version of the Accept header (for example, `json`, `yaml`). public CatTemplatesDescriptor Format(string format) => Qs("format", format); /// Comma-separated list of column names to display. @@ -1214,9 +1214,9 @@ public CatTemplatesDescriptor ClusterManagerTimeout(Time clustermanagertimeout) /// Return local information, do not retrieve the state from cluster-manager node. public CatTemplatesDescriptor Local(bool? local = true) => Qs("local", local); - /// Operation timeout for connection to master node. + /// Operation timeout for connection to cluster-manager node. [Obsolete( - "Deprecated as of: 2.0.0, reason: To promote inclusive language, use 'cluster_manager_timeout' instead." + "Deprecated as of: 2.0.0, reason: To promote inclusive language, use `cluster_manager_timeout` instead." )] public CatTemplatesDescriptor MasterTimeout(Time mastertimeout) => Qs("master_timeout", mastertimeout); @@ -1263,7 +1263,7 @@ public CatThreadPoolDescriptor ThreadPoolPatterns(Names threadPoolPatterns) => public CatThreadPoolDescriptor ClusterManagerTimeout(Time clustermanagertimeout) => Qs("cluster_manager_timeout", clustermanagertimeout); - /// A short version of the Accept header, e.g. json, yaml. + /// A short version of the Accept header (for example, `json`, `yaml`). public CatThreadPoolDescriptor Format(string format) => Qs("format", format); /// Comma-separated list of column names to display. @@ -1275,9 +1275,9 @@ public CatThreadPoolDescriptor ClusterManagerTimeout(Time clustermanagertimeout) /// Return local information, do not retrieve the state from cluster-manager node. public CatThreadPoolDescriptor Local(bool? local = true) => Qs("local", local); - /// Operation timeout for connection to master node. + /// Operation timeout for connection to cluster-manager node. [Obsolete( - "Deprecated as of: 2.0.0, reason: To promote inclusive language, use 'cluster_manager_timeout' instead." + "Deprecated as of: 2.0.0, reason: To promote inclusive language, use `cluster_manager_timeout` instead." )] public CatThreadPoolDescriptor MasterTimeout(Time mastertimeout) => Qs("master_timeout", mastertimeout); diff --git a/src/OpenSearch.Client/_Generated/Descriptors.Cluster.cs b/src/OpenSearch.Client/_Generated/Descriptors.Cluster.cs index 2e872046b7..037774c1e9 100644 --- a/src/OpenSearch.Client/_Generated/Descriptors.Cluster.cs +++ b/src/OpenSearch.Client/_Generated/Descriptors.Cluster.cs @@ -70,11 +70,11 @@ public partial class ClusterAllocationExplainDescriptor // values part of the url path // Request parameters - /// If true, returns information about disk usage and shard sizes. + /// If `true`, returns information about disk usage and shard sizes. public ClusterAllocationExplainDescriptor IncludeDiskInfo(bool? includediskinfo = true) => Qs("include_disk_info", includediskinfo); - /// If true, returns YES decisions in explanation. + /// If `true`, returns YES decisions in explanation. public ClusterAllocationExplainDescriptor IncludeYesDecisions( bool? includeyesdecisions = true ) => Qs("include_yes_decisions", includeyesdecisions); @@ -111,9 +111,9 @@ public DeleteComponentTemplateDescriptor ClusterManagerTimeout( Time clustermanagertimeout ) => Qs("cluster_manager_timeout", clustermanagertimeout); - /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error. [Obsolete( - "Deprecated as of: 2.0.0, reason: To promote inclusive language, use 'cluster_manager_timeout' instead." + "Deprecated as of: 2.0.0, reason: To promote inclusive language, use `cluster_manager_timeout` instead." )] public DeleteComponentTemplateDescriptor MasterTimeout(Time mastertimeout) => Qs("master_timeout", mastertimeout); @@ -135,7 +135,7 @@ public partial class DeleteVotingConfigExclusionsDescriptor // values part of the url path // Request parameters - /// Specifies whether to wait for all excluded nodes to be removed from the cluster before clearing the voting configuration exclusions list. Defaults to true, meaning that all excluded nodes must be removed from the cluster before this API takes any action. If set to false then the voting configuration exclusions list is cleared even if some excluded nodes are still in the cluster. + /// Specifies whether to wait for all excluded nodes to be removed from the cluster before clearing the voting configuration exclusions list. Defaults to true, meaning that all excluded nodes must be removed from the cluster before this API takes any action. If set to `false` then the voting configuration exclusions list is cleared even if some excluded nodes are still in the cluster. public DeleteVotingConfigExclusionsDescriptor WaitForRemoval(bool? waitforremoval = true) => Qs("wait_for_removal", waitforremoval); } @@ -171,12 +171,12 @@ public ComponentTemplateExistsDescriptor ClusterManagerTimeout( Time clustermanagertimeout ) => Qs("cluster_manager_timeout", clustermanagertimeout); - /// If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the master node. + /// If `true`, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the cluster-manager node. public ComponentTemplateExistsDescriptor Local(bool? local = true) => Qs("local", local); - /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error. [Obsolete( - "Deprecated as of: 2.0.0, reason: To promote inclusive language, use 'cluster_manager_timeout' instead." + "Deprecated as of: 2.0.0, reason: To promote inclusive language, use `cluster_manager_timeout` instead." )] public ComponentTemplateExistsDescriptor MasterTimeout(Time mastertimeout) => Qs("master_timeout", mastertimeout); @@ -215,12 +215,12 @@ public GetComponentTemplateDescriptor Name(Name name) => public GetComponentTemplateDescriptor ClusterManagerTimeout(Time clustermanagertimeout) => Qs("cluster_manager_timeout", clustermanagertimeout); - /// If `true`, the request retrieves information from the local node only. If `false`, information is retrieved from the master node. + /// If `true`, the request retrieves information from the local node only. If `false`, information is retrieved from the cluster-manager node. public GetComponentTemplateDescriptor Local(bool? local = true) => Qs("local", local); - /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error. [Obsolete( - "Deprecated as of: 2.0.0, reason: To promote inclusive language, use 'cluster_manager_timeout' instead." + "Deprecated as of: 2.0.0, reason: To promote inclusive language, use `cluster_manager_timeout` instead." )] public GetComponentTemplateDescriptor MasterTimeout(Time mastertimeout) => Qs("master_timeout", mastertimeout); @@ -252,9 +252,9 @@ public ClusterGetSettingsDescriptor FlatSettings(bool? flatsettings = true) => public ClusterGetSettingsDescriptor IncludeDefaults(bool? includedefaults = true) => Qs("include_defaults", includedefaults); - /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error. [Obsolete( - "Deprecated as of: 2.0.0, reason: To promote inclusive language, use 'cluster_manager_timeout' instead." + "Deprecated as of: 2.0.0, reason: To promote inclusive language, use `cluster_manager_timeout` instead." )] public ClusterGetSettingsDescriptor MasterTimeout(Time mastertimeout) => Qs("master_timeout", mastertimeout); @@ -286,7 +286,7 @@ public ClusterHealthDescriptor(Indices index) // values part of the url path Indices IClusterHealthRequest.Index => Self.RouteValues.Get("index"); - /// Comma-separated list of data streams, indices, and index aliases used to limit the request. Wildcard expressions (*) are supported. To target all data streams and indices in a cluster, omit this parameter or use `_all` or `*`. + /// Comma-separated list of data streams, indexes, and index aliases used to limit the request. Wildcard expressions (*) are supported. To target all data streams and indexes in a cluster, omit this parameter or use `_all` or `*`. public ClusterHealthDescriptor Index(Indices index) => Assign(index, (a, v) => a.RouteValues.Optional("index", v)); @@ -308,19 +308,19 @@ public ClusterHealthDescriptor AwarenessAttribute(string awarenessattribute) => public ClusterHealthDescriptor ClusterManagerTimeout(Time clustermanagertimeout) => Qs("cluster_manager_timeout", clustermanagertimeout); - /// Whether to expand wildcard expression to concrete indices that are open, closed or both. + /// Whether to expand wildcard expression to concrete indexes that are open, closed or both. public ClusterHealthDescriptor ExpandWildcards(ExpandWildcards? expandwildcards) => Qs("expand_wildcards", expandwildcards); - /// Can be one of cluster, indices or shards. Controls the details level of the health information returned. + /// Can be one of cluster, indexes or shards. Controls the details level of the health information returned. public ClusterHealthDescriptor Level(ClusterHealthLevel? level) => Qs("level", level); - /// If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the master node. + /// If `true`, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the cluster-manager node. public ClusterHealthDescriptor Local(bool? local = true) => Qs("local", local); - /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error. [Obsolete( - "Deprecated as of: 2.0.0, reason: To promote inclusive language, use 'cluster_manager_timeout' instead." + "Deprecated as of: 2.0.0, reason: To promote inclusive language, use `cluster_manager_timeout` instead." )] public ClusterHealthDescriptor MasterTimeout(Time mastertimeout) => Qs("master_timeout", mastertimeout); @@ -340,12 +340,12 @@ public ClusterHealthDescriptor WaitForEvents(WaitForEvents? waitforevents) => public ClusterHealthDescriptor WaitForNodes(string waitfornodes) => Qs("wait_for_nodes", waitfornodes); - /// A boolean value which controls whether to wait (until the timeout provided) for the cluster to have no shard initializations. Defaults to false, which means it will not wait for initializing shards. + /// A Boolean value which controls whether to wait (until the timeout provided) for the cluster to have no shard initializations. Defaults to false, which means it will not wait for initializing shards. public ClusterHealthDescriptor WaitForNoInitializingShards( bool? waitfornoinitializingshards = true ) => Qs("wait_for_no_initializing_shards", waitfornoinitializingshards); - /// A boolean value which controls whether to wait (until the timeout provided) for the cluster to have no shard relocations. Defaults to false, which means it will not wait for relocating shards. + /// A Boolean value which controls whether to wait (until the timeout provided) for the cluster to have no shard relocations. Defaults to false, which means it will not wait for relocating shards. public ClusterHealthDescriptor WaitForNoRelocatingShards( bool? waitfornorelocatingshards = true ) => Qs("wait_for_no_relocating_shards", waitfornorelocatingshards); @@ -373,12 +373,12 @@ public partial class ClusterPendingTasksDescriptor public ClusterPendingTasksDescriptor ClusterManagerTimeout(Time clustermanagertimeout) => Qs("cluster_manager_timeout", clustermanagertimeout); - /// If `true`, the request retrieves information from the local node only. If `false`, information is retrieved from the master node. + /// If `true`, the request retrieves information from the local node only. If `false`, information is retrieved from the cluster-manager node. public ClusterPendingTasksDescriptor Local(bool? local = true) => Qs("local", local); - /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error. [Obsolete( - "Deprecated as of: 2.0.0, reason: To promote inclusive language, use 'cluster_manager_timeout' instead." + "Deprecated as of: 2.0.0, reason: To promote inclusive language, use `cluster_manager_timeout` instead." )] public ClusterPendingTasksDescriptor MasterTimeout(Time mastertimeout) => Qs("master_timeout", mastertimeout); @@ -397,11 +397,11 @@ public partial class PostVotingConfigExclusionsDescriptor // values part of the url path // Request parameters - /// A comma-separated list of the persistent ids of the nodes to exclude from the voting configuration. If specified, you may not also specify node_names. + /// A comma-separated list of the persistent ids of the nodes to exclude from the voting configuration. If specified, you may not also specify `node_names`. public PostVotingConfigExclusionsDescriptor NodeIds(params string[] nodeids) => Qs("node_ids", nodeids); - /// A comma-separated list of the names of the nodes to exclude from the voting configuration. If specified, you may not also specify node_ids. + /// A comma-separated list of the names of the nodes to exclude from the voting configuration. If specified, you may not also specify `node_ids`. public PostVotingConfigExclusionsDescriptor NodeNames(params string[] nodenames) => Qs("node_names", nodenames); @@ -442,9 +442,9 @@ public PutComponentTemplateDescriptor ClusterManagerTimeout(Time clustermanagert /// If `true`, this request cannot replace or update existing component templates. public PutComponentTemplateDescriptor Create(bool? create = true) => Qs("create", create); - /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error. [Obsolete( - "Deprecated as of: 2.0.0, reason: To promote inclusive language, use 'cluster_manager_timeout' instead." + "Deprecated as of: 2.0.0, reason: To promote inclusive language, use `cluster_manager_timeout` instead." )] public PutComponentTemplateDescriptor MasterTimeout(Time mastertimeout) => Qs("master_timeout", mastertimeout); @@ -475,9 +475,9 @@ public ClusterPutSettingsDescriptor ClusterManagerTimeout(Time clustermanagertim public ClusterPutSettingsDescriptor FlatSettings(bool? flatsettings = true) => Qs("flat_settings", flatsettings); - /// Explicit operation timeout for connection to master node. + /// Explicit operation timeout for connection to cluster-manager node. [Obsolete( - "Deprecated as of: 2.0.0, reason: To promote inclusive language, use 'cluster_manager_timeout' instead." + "Deprecated as of: 2.0.0, reason: To promote inclusive language, use `cluster_manager_timeout` instead." )] public ClusterPutSettingsDescriptor MasterTimeout(Time mastertimeout) => Qs("master_timeout", mastertimeout); @@ -518,15 +518,15 @@ public partial class ClusterRerouteDescriptor public ClusterRerouteDescriptor ClusterManagerTimeout(Time clustermanagertimeout) => Qs("cluster_manager_timeout", clustermanagertimeout); - /// If true, then the request simulates the operation only and returns the resulting state. + /// If `true`, then the request simulates the operation only and returns the resulting state. public ClusterRerouteDescriptor DryRun(bool? dryrun = true) => Qs("dry_run", dryrun); - /// If true, then the response contains an explanation of why the commands can or cannot be executed. + /// If `true`, then the response contains an explanation of why the commands can or cannot be executed. public ClusterRerouteDescriptor Explain(bool? explain = true) => Qs("explain", explain); - /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error. [Obsolete( - "Deprecated as of: 2.0.0, reason: To promote inclusive language, use 'cluster_manager_timeout' instead." + "Deprecated as of: 2.0.0, reason: To promote inclusive language, use `cluster_manager_timeout` instead." )] public ClusterRerouteDescriptor MasterTimeout(Time mastertimeout) => Qs("master_timeout", mastertimeout); @@ -535,7 +535,7 @@ public ClusterRerouteDescriptor MasterTimeout(Time mastertimeout) => public ClusterRerouteDescriptor Metric(ClusterRerouteMetric? metric) => Qs("metric", metric); - /// If true, then retries allocation of shards that are blocked due to too many subsequent allocation failures. + /// If `true`, then retries allocation of shards that are blocked due to too many subsequent allocation failures. public ClusterRerouteDescriptor RetryFailed(bool? retryfailed = true) => Qs("retry_failed", retryfailed); @@ -573,7 +573,7 @@ public ClusterStateDescriptor(Metrics metric, Indices index) Indices IClusterStateRequest.Index => Self.RouteValues.Get("index"); Metrics IClusterStateRequest.Metric => Self.RouteValues.Get("metric"); - /// A comma-separated list of index names; use the special string `_all` or Indices.All to perform the operation on all indices. + /// A comma-separated list of index names; use the special string `_all` or Indices.All to perform the operation on all indexes. public ClusterStateDescriptor Index(Indices index) => Assign(index, (a, v) => a.RouteValues.Optional("index", v)); @@ -590,7 +590,7 @@ public ClusterStateDescriptor Metric(Metrics metric) => Assign(metric, (a, v) => a.RouteValues.Optional("metric", v)); // Request parameters - /// Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified). + /// Whether to ignore if a wildcard indexes expression resolves into no concrete indexes. (This includes `_all` string or when no indexes have been specified). public ClusterStateDescriptor AllowNoIndices(bool? allownoindices = true) => Qs("allow_no_indices", allownoindices); @@ -599,7 +599,7 @@ public ClusterStateDescriptor AllowNoIndices(bool? allownoindices = true) => public ClusterStateDescriptor ClusterManagerTimeout(Time clustermanagertimeout) => Qs("cluster_manager_timeout", clustermanagertimeout); - /// Whether to expand wildcard expression to concrete indices that are open, closed or both. + /// Whether to expand wildcard expression to concrete indexes that are open, closed or both. public ClusterStateDescriptor ExpandWildcards(ExpandWildcards? expandwildcards) => Qs("expand_wildcards", expandwildcards); @@ -607,16 +607,16 @@ public ClusterStateDescriptor ExpandWildcards(ExpandWildcards? expandwildcards) public ClusterStateDescriptor FlatSettings(bool? flatsettings = true) => Qs("flat_settings", flatsettings); - /// Whether specified concrete indices should be ignored when unavailable (missing or closed). + /// Whether specified concrete indexes should be ignored when unavailable (missing or closed). public ClusterStateDescriptor IgnoreUnavailable(bool? ignoreunavailable = true) => Qs("ignore_unavailable", ignoreunavailable); /// Return local information, do not retrieve the state from cluster-manager node. public ClusterStateDescriptor Local(bool? local = true) => Qs("local", local); - /// Specify timeout for connection to master. + /// Specify timeout for connection to cluster manager. [Obsolete( - "Deprecated as of: 2.0.0, reason: To promote inclusive language, use 'cluster_manager_timeout' instead." + "Deprecated as of: 2.0.0, reason: To promote inclusive language, use `cluster_manager_timeout` instead." )] public ClusterStateDescriptor MasterTimeout(Time mastertimeout) => Qs("master_timeout", mastertimeout); @@ -625,7 +625,7 @@ public ClusterStateDescriptor MasterTimeout(Time mastertimeout) => public ClusterStateDescriptor WaitForMetadataVersion(long? waitformetadataversion) => Qs("wait_for_metadata_version", waitformetadataversion); - /// The maximum time to wait for wait_for_metadata_version before timing out. + /// The maximum time to wait for `wait_for_metadata_version` before timing out. public ClusterStateDescriptor WaitForTimeout(Time waitfortimeout) => Qs("wait_for_timeout", waitfortimeout); } @@ -645,14 +645,42 @@ public partial class ClusterStatsDescriptor public ClusterStatsDescriptor() : base() { } + /// /_cluster/stats/{metric}/{index_metric}/nodes/{node_id} + /// Optional, accepts null + /// Optional, accepts null + /// Optional, accepts null + public ClusterStatsDescriptor(Metrics metric, IndexMetrics indexMetric, NodeIds nodeId) + : base(r => + r.Optional("metric", metric) + .Optional("index_metric", indexMetric) + .Optional("node_id", nodeId) + ) { } + + /// /_cluster/stats/{metric}/nodes/{node_id} + /// Optional, accepts null + /// Optional, accepts null + public ClusterStatsDescriptor(Metrics metric, NodeIds nodeId) + : base(r => r.Optional("metric", metric).Optional("node_id", nodeId)) { } + /// /_cluster/stats/nodes/{node_id} /// Optional, accepts null public ClusterStatsDescriptor(NodeIds nodeId) : base(r => r.Optional("node_id", nodeId)) { } // values part of the url path + IndexMetrics IClusterStatsRequest.IndexMetric => + Self.RouteValues.Get("index_metric"); + Metrics IClusterStatsRequest.Metric => Self.RouteValues.Get("metric"); NodeIds IClusterStatsRequest.NodeId => Self.RouteValues.Get("node_id"); + /// Limit the information returned for indexes metric to the specific index metrics. It can be used only if indexes (or all) metric is specified. + public ClusterStatsDescriptor IndexMetric(IndexMetrics indexMetric) => + Assign(indexMetric, (a, v) => a.RouteValues.Optional("index_metric", v)); + + /// Limit the information returned to the specified metrics. + public ClusterStatsDescriptor Metric(Metrics metric) => + Assign(metric, (a, v) => a.RouteValues.Optional("metric", v)); + /// Comma-separated list of node filters used to limit returned information. Defaults to all nodes in the cluster. public ClusterStatsDescriptor NodeId(NodeIds nodeId) => Assign(nodeId, (a, v) => a.RouteValues.Optional("node_id", v)); diff --git a/src/OpenSearch.Client/_Generated/Descriptors.DanglingIndices.cs b/src/OpenSearch.Client/_Generated/Descriptors.DanglingIndices.cs index b27f71aa69..c1e6a3c4b7 100644 --- a/src/OpenSearch.Client/_Generated/Descriptors.DanglingIndices.cs +++ b/src/OpenSearch.Client/_Generated/Descriptors.DanglingIndices.cs @@ -92,9 +92,9 @@ public DeleteDanglingIndexDescriptor AcceptDataLoss(bool? acceptdataloss = true) public DeleteDanglingIndexDescriptor ClusterManagerTimeout(Time clustermanagertimeout) => Qs("cluster_manager_timeout", clustermanagertimeout); - /// Specify timeout for connection to master. + /// Specify timeout for connection to cluster manager. [Obsolete( - "Deprecated as of: 2.0.0, reason: To promote inclusive language, use 'cluster_manager_timeout' instead." + "Deprecated as of: 2.0.0, reason: To promote inclusive language, use `cluster_manager_timeout` instead." )] public DeleteDanglingIndexDescriptor MasterTimeout(Time mastertimeout) => Qs("master_timeout", mastertimeout); @@ -138,9 +138,9 @@ public ImportDanglingIndexDescriptor AcceptDataLoss(bool? acceptdataloss = true) public ImportDanglingIndexDescriptor ClusterManagerTimeout(Time clustermanagertimeout) => Qs("cluster_manager_timeout", clustermanagertimeout); - /// Specify timeout for connection to master. + /// Specify timeout for connection to cluster manager. [Obsolete( - "Deprecated as of: 2.0.0, reason: To promote inclusive language, use 'cluster_manager_timeout' instead." + "Deprecated as of: 2.0.0, reason: To promote inclusive language, use `cluster_manager_timeout` instead." )] public ImportDanglingIndexDescriptor MasterTimeout(Time mastertimeout) => Qs("master_timeout", mastertimeout); diff --git a/src/OpenSearch.Client/_Generated/Descriptors.Indices.cs b/src/OpenSearch.Client/_Generated/Descriptors.Indices.cs index 782959c9af..61a9254fa4 100644 --- a/src/OpenSearch.Client/_Generated/Descriptors.Indices.cs +++ b/src/OpenSearch.Client/_Generated/Descriptors.Indices.cs @@ -83,7 +83,7 @@ protected AddIndexBlockDescriptor() IndexBlock IAddIndexBlockRequest.Block => Self.RouteValues.Get("block"); Indices IAddIndexBlockRequest.Index => Self.RouteValues.Get("index"); - /// A comma separated list of indices to add a block to. + /// A comma separated list of indexes to add a block to. public AddIndexBlockDescriptor Index(Indices index) => Assign(index, (a, v) => a.RouteValues.Required("index", v)); @@ -96,7 +96,7 @@ public AddIndexBlockDescriptor Index() public AddIndexBlockDescriptor AllIndices() => Index(Indices.All); // Request parameters - /// Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified). + /// Whether to ignore if a wildcard indexes expression resolves into no concrete indexes. (This includes `_all` string or when no indexes have been specified). public AddIndexBlockDescriptor AllowNoIndices(bool? allownoindices = true) => Qs("allow_no_indices", allownoindices); @@ -105,17 +105,17 @@ public AddIndexBlockDescriptor AllowNoIndices(bool? allownoindices = true) => public AddIndexBlockDescriptor ClusterManagerTimeout(Time clustermanagertimeout) => Qs("cluster_manager_timeout", clustermanagertimeout); - /// Whether to expand wildcard expression to concrete indices that are open, closed or both. + /// Whether to expand wildcard expression to concrete indexes that are open, closed or both. public AddIndexBlockDescriptor ExpandWildcards(ExpandWildcards? expandwildcards) => Qs("expand_wildcards", expandwildcards); - /// Whether specified concrete indices should be ignored when unavailable (missing or closed). + /// Whether specified concrete indexes should be ignored when unavailable (missing or closed). public AddIndexBlockDescriptor IgnoreUnavailable(bool? ignoreunavailable = true) => Qs("ignore_unavailable", ignoreunavailable); - /// Specify timeout for connection to master. + /// Specify timeout for connection to cluster manager. [Obsolete( - "Deprecated as of: 2.0.0, reason: To promote inclusive language, use 'cluster_manager_timeout' instead." + "Deprecated as of: 2.0.0, reason: To promote inclusive language, use `cluster_manager_timeout` instead." )] public AddIndexBlockDescriptor MasterTimeout(Time mastertimeout) => Qs("master_timeout", mastertimeout); @@ -177,7 +177,7 @@ public ClearCacheDescriptor(Indices index) // values part of the url path Indices IClearCacheRequest.Index => Self.RouteValues.Get("index"); - /// Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams and indices, omit this parameter or use `*` or `_all`. + /// Comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams and indexes, omit this parameter or use `*` or `_all`. public ClearCacheDescriptor Index(Indices index) => Assign(index, (a, v) => a.RouteValues.Optional("index", v)); @@ -190,7 +190,7 @@ public ClearCacheDescriptor Index() public ClearCacheDescriptor AllIndices() => Index(Indices.All); // Request parameters - /// If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. + /// If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indexes. This behavior applies even if the request targets other open indexes. public ClearCacheDescriptor AllowNoIndices(bool? allownoindices = true) => Qs("allow_no_indices", allownoindices); @@ -208,7 +208,7 @@ public ClearCacheDescriptor ExpandWildcards(ExpandWildcards? expandwildcards) => public ClearCacheDescriptor Fields(params Expression>[] fields) where T : class => Qs("fields", fields?.Select(e => (Field)e)); - /// If true, clears the unused entries from the file cache on nodes with the Search role. + /// If `true`, clears the unused entries from the file cache on nodes with the Search role. /// Supported by OpenSearch servers of version 2.8.0 or greater. public ClearCacheDescriptor File(bool? file = true) => Qs("file", file); @@ -264,14 +264,14 @@ public CloneIndexDescriptor Index() public CloneIndexDescriptor ClusterManagerTimeout(Time clustermanagertimeout) => Qs("cluster_manager_timeout", clustermanagertimeout); - /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error. [Obsolete( - "Deprecated as of: 2.0.0, reason: To promote inclusive language, use 'cluster_manager_timeout' instead." + "Deprecated as of: 2.0.0, reason: To promote inclusive language, use `cluster_manager_timeout` instead." )] public CloneIndexDescriptor MasterTimeout(Time mastertimeout) => Qs("master_timeout", mastertimeout); - /// Explicit task execution timeout, only useful when wait_for_completion is false, defaults to 1h. + /// Explicit task execution timeout, only useful when `wait_for_completion` is false, defaults to `1h`. public CloneIndexDescriptor TaskExecutionTimeout(Time taskexecutiontimeout) => Qs("task_execution_timeout", taskexecutiontimeout); @@ -325,7 +325,7 @@ public CloseIndexDescriptor Index() public CloseIndexDescriptor AllIndices() => Index(Indices.All); // Request parameters - /// If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. + /// If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indexes. This behavior applies even if the request targets other open indexes. public CloseIndexDescriptor AllowNoIndices(bool? allownoindices = true) => Qs("allow_no_indices", allownoindices); @@ -342,9 +342,9 @@ public CloseIndexDescriptor ExpandWildcards(ExpandWildcards? expandwildcards) => public CloseIndexDescriptor IgnoreUnavailable(bool? ignoreunavailable = true) => Qs("ignore_unavailable", ignoreunavailable); - /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error. [Obsolete( - "Deprecated as of: 2.0.0, reason: To promote inclusive language, use 'cluster_manager_timeout' instead." + "Deprecated as of: 2.0.0, reason: To promote inclusive language, use `cluster_manager_timeout` instead." )] public CloseIndexDescriptor MasterTimeout(Time mastertimeout) => Qs("master_timeout", mastertimeout); @@ -396,9 +396,9 @@ public CreateIndexDescriptor Index() public CreateIndexDescriptor ClusterManagerTimeout(Time clustermanagertimeout) => Qs("cluster_manager_timeout", clustermanagertimeout); - /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error. [Obsolete( - "Deprecated as of: 2.0.0, reason: To promote inclusive language, use 'cluster_manager_timeout' instead." + "Deprecated as of: 2.0.0, reason: To promote inclusive language, use `cluster_manager_timeout` instead." )] public CreateIndexDescriptor MasterTimeout(Time mastertimeout) => Qs("master_timeout", mastertimeout); @@ -435,7 +435,7 @@ protected DeleteIndexDescriptor() // values part of the url path Indices IDeleteIndexRequest.Index => Self.RouteValues.Get("index"); - /// Comma-separated list of indices to delete. You cannot specify index aliases. By default, this parameter does not support wildcards (`*`) or `_all`. To use wildcards or `_all`, set the `action.destructive_requires_name` cluster setting to `false`. + /// Comma-separated list of indexes to delete. You cannot specify index aliases. By default, this parameter does not support wildcards (`*`) or `_all`. To use wildcards or `_all`, set the `action.destructive_requires_name` cluster setting to `false`. public DeleteIndexDescriptor Index(Indices index) => Assign(index, (a, v) => a.RouteValues.Required("index", v)); @@ -448,7 +448,7 @@ public DeleteIndexDescriptor Index() public DeleteIndexDescriptor AllIndices() => Index(Indices.All); // Request parameters - /// If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. + /// If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indexes. This behavior applies even if the request targets other open indexes. public DeleteIndexDescriptor AllowNoIndices(bool? allownoindices = true) => Qs("allow_no_indices", allownoindices); @@ -465,9 +465,9 @@ public DeleteIndexDescriptor ExpandWildcards(ExpandWildcards? expandwildcards) = public DeleteIndexDescriptor IgnoreUnavailable(bool? ignoreunavailable = true) => Qs("ignore_unavailable", ignoreunavailable); - /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error. [Obsolete( - "Deprecated as of: 2.0.0, reason: To promote inclusive language, use 'cluster_manager_timeout' instead." + "Deprecated as of: 2.0.0, reason: To promote inclusive language, use `cluster_manager_timeout` instead." )] public DeleteIndexDescriptor MasterTimeout(Time mastertimeout) => Qs("master_timeout", mastertimeout); @@ -502,7 +502,7 @@ protected DeleteAliasDescriptor() Indices IDeleteAliasRequest.Index => Self.RouteValues.Get("index"); Names IDeleteAliasRequest.Name => Self.RouteValues.Get("name"); - /// Comma-separated list of data streams or indices used to limit the request. Supports wildcards (`*`). + /// Comma-separated list of data streams or indexes used to limit the request. Supports wildcards (`*`). public DeleteAliasDescriptor Index(Indices index) => Assign(index, (a, v) => a.RouteValues.Required("index", v)); @@ -520,9 +520,9 @@ public DeleteAliasDescriptor Index() public DeleteAliasDescriptor ClusterManagerTimeout(Time clustermanagertimeout) => Qs("cluster_manager_timeout", clustermanagertimeout); - /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error. [Obsolete( - "Deprecated as of: 2.0.0, reason: To promote inclusive language, use 'cluster_manager_timeout' instead." + "Deprecated as of: 2.0.0, reason: To promote inclusive language, use `cluster_manager_timeout` instead." )] public DeleteAliasDescriptor MasterTimeout(Time mastertimeout) => Qs("master_timeout", mastertimeout); @@ -562,9 +562,9 @@ public DeleteComposableIndexTemplateDescriptor ClusterManagerTimeout( Time clustermanagertimeout ) => Qs("cluster_manager_timeout", clustermanagertimeout); - /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error. [Obsolete( - "Deprecated as of: 2.0.0, reason: To promote inclusive language, use 'cluster_manager_timeout' instead." + "Deprecated as of: 2.0.0, reason: To promote inclusive language, use `cluster_manager_timeout` instead." )] public DeleteComposableIndexTemplateDescriptor MasterTimeout(Time mastertimeout) => Qs("master_timeout", mastertimeout); @@ -604,9 +604,9 @@ protected DeleteIndexTemplateDescriptor() public DeleteIndexTemplateDescriptor ClusterManagerTimeout(Time clustermanagertimeout) => Qs("cluster_manager_timeout", clustermanagertimeout); - /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error. [Obsolete( - "Deprecated as of: 2.0.0, reason: To promote inclusive language, use 'cluster_manager_timeout' instead." + "Deprecated as of: 2.0.0, reason: To promote inclusive language, use `cluster_manager_timeout` instead." )] public DeleteIndexTemplateDescriptor MasterTimeout(Time mastertimeout) => Qs("master_timeout", mastertimeout); @@ -639,7 +639,7 @@ protected IndexExistsDescriptor() // values part of the url path Indices IIndexExistsRequest.Index => Self.RouteValues.Get("index"); - /// Comma-separated list of data streams, indices, and aliases. Supports wildcards (`*`). + /// Comma-separated list of data streams, indexes, and aliases. Supports wildcards (`*`). public IndexExistsDescriptor Index(Indices index) => Assign(index, (a, v) => a.RouteValues.Required("index", v)); @@ -652,7 +652,7 @@ public IndexExistsDescriptor Index() public IndexExistsDescriptor AllIndices() => Index(Indices.All); // Request parameters - /// If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. + /// If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indexes. This behavior applies even if the request targets other open indexes. public IndexExistsDescriptor AllowNoIndices(bool? allownoindices = true) => Qs("allow_no_indices", allownoindices); @@ -712,7 +712,7 @@ protected AliasExistsDescriptor() Indices IAliasExistsRequest.Index => Self.RouteValues.Get("index"); Names IAliasExistsRequest.Name => Self.RouteValues.Get("name"); - /// Comma-separated list of data streams or indices used to limit the request. Supports wildcards (`*`). To target all data streams and indices, omit this parameter or use `*` or `_all`. + /// Comma-separated list of data streams or indexes used to limit the request. Supports wildcards (`*`). To target all data streams and indexes, omit this parameter or use `*` or `_all`. public AliasExistsDescriptor Index(Indices index) => Assign(index, (a, v) => a.RouteValues.Optional("index", v)); @@ -725,7 +725,7 @@ public AliasExistsDescriptor Index() public AliasExistsDescriptor AllIndices() => Index(Indices.All); // Request parameters - /// If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. + /// If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indexes. This behavior applies even if the request targets other open indexes. public AliasExistsDescriptor AllowNoIndices(bool? allownoindices = true) => Qs("allow_no_indices", allownoindices); @@ -733,7 +733,7 @@ public AliasExistsDescriptor AllowNoIndices(bool? allownoindices = true) => public AliasExistsDescriptor ExpandWildcards(ExpandWildcards? expandwildcards) => Qs("expand_wildcards", expandwildcards); - /// If `false`, requests that include a missing data stream or index in the target indices or data streams return an error. + /// If `false`, requests that include a missing data stream or index in the target indexes or data streams return an error. public AliasExistsDescriptor IgnoreUnavailable(bool? ignoreunavailable = true) => Qs("ignore_unavailable", ignoreunavailable); @@ -780,9 +780,9 @@ public ComposableIndexTemplateExistsDescriptor FlatSettings(bool? flatsettings = public ComposableIndexTemplateExistsDescriptor Local(bool? local = true) => Qs("local", local); - /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error. [Obsolete( - "Deprecated as of: 2.0.0, reason: To promote inclusive language, use 'cluster_manager_timeout' instead." + "Deprecated as of: 2.0.0, reason: To promote inclusive language, use `cluster_manager_timeout` instead." )] public ComposableIndexTemplateExistsDescriptor MasterTimeout(Time mastertimeout) => Qs("master_timeout", mastertimeout); @@ -825,9 +825,9 @@ public IndexTemplateExistsDescriptor FlatSettings(bool? flatsettings = true) => /// Return local information, do not retrieve the state from cluster-manager node. public IndexTemplateExistsDescriptor Local(bool? local = true) => Qs("local", local); - /// Explicit operation timeout for connection to master node. + /// Explicit operation timeout for connection to cluster-manager node. [Obsolete( - "Deprecated as of: 2.0.0, reason: To promote inclusive language, use 'cluster_manager_timeout' instead." + "Deprecated as of: 2.0.0, reason: To promote inclusive language, use `cluster_manager_timeout` instead." )] public IndexTemplateExistsDescriptor MasterTimeout(Time mastertimeout) => Qs("master_timeout", mastertimeout); @@ -852,7 +852,7 @@ public FlushDescriptor(Indices index) // values part of the url path Indices IFlushRequest.Index => Self.RouteValues.Get("index"); - /// Comma-separated list of data streams, indices, and aliases to flush. Supports wildcards (`*`). To flush all data streams and indices, omit this parameter or use `*` or `_all`. + /// Comma-separated list of data streams, indexes, and aliases to flush. Supports wildcards (`*`). To flush all data streams and indexes, omit this parameter or use `*` or `_all`. public FlushDescriptor Index(Indices index) => Assign(index, (a, v) => a.RouteValues.Optional("index", v)); @@ -865,7 +865,7 @@ public FlushDescriptor Index() public FlushDescriptor AllIndices() => Index(Indices.All); // Request parameters - /// If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. + /// If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indexes. This behavior applies even if the request targets other open indexes. public FlushDescriptor AllowNoIndices(bool? allownoindices = true) => Qs("allow_no_indices", allownoindices); @@ -908,7 +908,7 @@ public ForceMergeDescriptor(Indices index) // values part of the url path Indices IForceMergeRequest.Index => Self.RouteValues.Get("index"); - /// A comma-separated list of index names; use the special string `_all` or Indices.All to perform the operation on all indices. + /// A comma-separated list of index names; use the special string `_all` or Indices.All to perform the operation on all indexes. public ForceMergeDescriptor Index(Indices index) => Assign(index, (a, v) => a.RouteValues.Optional("index", v)); @@ -921,18 +921,18 @@ public ForceMergeDescriptor Index() public ForceMergeDescriptor AllIndices() => Index(Indices.All); // Request parameters - /// Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified). + /// Whether to ignore if a wildcard indexes expression resolves into no concrete indexes. (This includes `_all` string or when no indexes have been specified). public ForceMergeDescriptor AllowNoIndices(bool? allownoindices = true) => Qs("allow_no_indices", allownoindices); - /// Whether to expand wildcard expression to concrete indices that are open, closed or both. + /// Whether to expand wildcard expression to concrete indexes that are open, closed or both. public ForceMergeDescriptor ExpandWildcards(ExpandWildcards? expandwildcards) => Qs("expand_wildcards", expandwildcards); /// Specify whether the index should be flushed after performing the operation. public ForceMergeDescriptor Flush(bool? flush = true) => Qs("flush", flush); - /// Whether specified concrete indices should be ignored when unavailable (missing or closed). + /// Whether specified concrete indexes should be ignored when unavailable (missing or closed). public ForceMergeDescriptor IgnoreUnavailable(bool? ignoreunavailable = true) => Qs("ignore_unavailable", ignoreunavailable); @@ -975,7 +975,7 @@ protected GetIndexDescriptor() // values part of the url path Indices IGetIndexRequest.Index => Self.RouteValues.Get("index"); - /// Comma-separated list of data streams, indices, and index aliases used to limit the request. Wildcard expressions (*) are supported. + /// Comma-separated list of data streams, indexes, and index aliases used to limit the request. Wildcard expressions (*) are supported. public GetIndexDescriptor Index(Indices index) => Assign(index, (a, v) => a.RouteValues.Required("index", v)); @@ -988,7 +988,7 @@ public GetIndexDescriptor Index() public GetIndexDescriptor AllIndices() => Index(Indices.All); // Request parameters - /// If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar. + /// If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indexes. This behavior applies even if the request targets other open indexes. For example, a request targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar. public GetIndexDescriptor AllowNoIndices(bool? allownoindices = true) => Qs("allow_no_indices", allownoindices); @@ -997,28 +997,28 @@ public GetIndexDescriptor AllowNoIndices(bool? allownoindices = true) => public GetIndexDescriptor ClusterManagerTimeout(Time clustermanagertimeout) => Qs("cluster_manager_timeout", clustermanagertimeout); - /// Type of index that wildcard expressions can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as open,hidden. + /// Type of index that wildcard expressions can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`. public GetIndexDescriptor ExpandWildcards(ExpandWildcards? expandwildcards) => Qs("expand_wildcards", expandwildcards); - /// If true, returns settings in flat format. + /// If `true`, returns settings in flat format. public GetIndexDescriptor FlatSettings(bool? flatsettings = true) => Qs("flat_settings", flatsettings); - /// If false, requests that target a missing index return an error. + /// If `false`, requests that target a missing index return an error. public GetIndexDescriptor IgnoreUnavailable(bool? ignoreunavailable = true) => Qs("ignore_unavailable", ignoreunavailable); - /// If true, return all default settings in the response. + /// If `true`, return all default settings in the response. public GetIndexDescriptor IncludeDefaults(bool? includedefaults = true) => Qs("include_defaults", includedefaults); - /// If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the master node. + /// If `true`, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the cluster-manager node. public GetIndexDescriptor Local(bool? local = true) => Qs("local", local); - /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error. [Obsolete( - "Deprecated as of: 2.0.0, reason: To promote inclusive language, use 'cluster_manager_timeout' instead." + "Deprecated as of: 2.0.0, reason: To promote inclusive language, use `cluster_manager_timeout` instead." )] public GetIndexDescriptor MasterTimeout(Time mastertimeout) => Qs("master_timeout", mastertimeout); @@ -1055,7 +1055,7 @@ public GetAliasDescriptor(Names name) Indices IGetAliasRequest.Index => Self.RouteValues.Get("index"); Names IGetAliasRequest.Name => Self.RouteValues.Get("name"); - /// Comma-separated list of data streams or indices used to limit the request. Supports wildcards (`*`). To target all data streams and indices, omit this parameter or use `*` or `_all`. + /// Comma-separated list of data streams or indexes used to limit the request. Supports wildcards (`*`). To target all data streams and indexes, omit this parameter or use `*` or `_all`. public GetAliasDescriptor Index(Indices index) => Assign(index, (a, v) => a.RouteValues.Optional("index", v)); @@ -1072,7 +1072,7 @@ public GetAliasDescriptor Name(Names name) => Assign(name, (a, v) => a.RouteValues.Optional("name", v)); // Request parameters - /// If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. + /// If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indexes. This behavior applies even if the request targets other open indexes. public GetAliasDescriptor AllowNoIndices(bool? allownoindices = true) => Qs("allow_no_indices", allownoindices); @@ -1119,7 +1119,7 @@ protected GetFieldMappingDescriptor() Fields IGetFieldMappingRequest.Fields => Self.RouteValues.Get("fields"); Indices IGetFieldMappingRequest.Index => Self.RouteValues.Get("index"); - /// Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams and indices, omit this parameter or use `*` or `_all`. + /// Comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams and indexes, omit this parameter or use `*` or `_all`. public GetFieldMappingDescriptor Index(Indices index) => Assign(index, (a, v) => a.RouteValues.Optional("index", v)); @@ -1132,7 +1132,7 @@ public GetFieldMappingDescriptor Index() public GetFieldMappingDescriptor AllIndices() => Index(Indices.All); // Request parameters - /// If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. + /// If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indexes. This behavior applies even if the request targets other open indexes. public GetFieldMappingDescriptor AllowNoIndices(bool? allownoindices = true) => Qs("allow_no_indices", allownoindices); @@ -1188,16 +1188,16 @@ public GetComposableIndexTemplateDescriptor ClusterManagerTimeout( Time clustermanagertimeout ) => Qs("cluster_manager_timeout", clustermanagertimeout); - /// If true, returns settings in flat format. + /// If `true`, returns settings in flat format. public GetComposableIndexTemplateDescriptor FlatSettings(bool? flatsettings = true) => Qs("flat_settings", flatsettings); - /// If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the master node. + /// If `true`, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the cluster-manager node. public GetComposableIndexTemplateDescriptor Local(bool? local = true) => Qs("local", local); - /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error. [Obsolete( - "Deprecated as of: 2.0.0, reason: To promote inclusive language, use 'cluster_manager_timeout' instead." + "Deprecated as of: 2.0.0, reason: To promote inclusive language, use `cluster_manager_timeout` instead." )] public GetComposableIndexTemplateDescriptor MasterTimeout(Time mastertimeout) => Qs("master_timeout", mastertimeout); @@ -1226,7 +1226,7 @@ public GetMappingDescriptor(Indices index) // values part of the url path Indices IGetMappingRequest.Index => Self.RouteValues.Get("index"); - /// Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams and indices, omit this parameter or use `*` or `_all`. + /// Comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams and indexes, omit this parameter or use `*` or `_all`. public GetMappingDescriptor Index(Indices index) => Assign(index, (a, v) => a.RouteValues.Optional("index", v)); @@ -1239,7 +1239,7 @@ public GetMappingDescriptor Index() public GetMappingDescriptor AllIndices() => Index(Indices.All); // Request parameters - /// If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. + /// If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indexes. This behavior applies even if the request targets other open indexes. public GetMappingDescriptor AllowNoIndices(bool? allownoindices = true) => Qs("allow_no_indices", allownoindices); @@ -1259,9 +1259,9 @@ public GetMappingDescriptor IgnoreUnavailable(bool? ignoreunavailable /// If `true`, the request retrieves information from the local node only. public GetMappingDescriptor Local(bool? local = true) => Qs("local", local); - /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error. [Obsolete( - "Deprecated as of: 2.0.0, reason: To promote inclusive language, use 'cluster_manager_timeout' instead." + "Deprecated as of: 2.0.0, reason: To promote inclusive language, use `cluster_manager_timeout` instead." )] public GetMappingDescriptor MasterTimeout(Time mastertimeout) => Qs("master_timeout", mastertimeout); @@ -1302,7 +1302,7 @@ public GetIndexSettingsDescriptor(Names name) Indices IGetIndexSettingsRequest.Index => Self.RouteValues.Get("index"); Names IGetIndexSettingsRequest.Name => Self.RouteValues.Get("name"); - /// Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams and indices, omit this parameter or use `*` or `_all`. + /// Comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams and indexes, omit this parameter or use `*` or `_all`. public GetIndexSettingsDescriptor Index(Indices index) => Assign(index, (a, v) => a.RouteValues.Optional("index", v)); @@ -1319,7 +1319,7 @@ public GetIndexSettingsDescriptor Name(Names name) => Assign(name, (a, v) => a.RouteValues.Optional("name", v)); // Request parameters - /// If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targeting `foo*,bar*` returns an error if an index starts with foo but no index starts with `bar`. + /// If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indexes. This behavior applies even if the request targets other open indexes. For example, a request targeting `foo*,bar*` returns an error if an index starts with foo but no index starts with `bar`. public GetIndexSettingsDescriptor AllowNoIndices(bool? allownoindices = true) => Qs("allow_no_indices", allownoindices); @@ -1344,12 +1344,12 @@ public GetIndexSettingsDescriptor IgnoreUnavailable(bool? ignoreunavailable = tr public GetIndexSettingsDescriptor IncludeDefaults(bool? includedefaults = true) => Qs("include_defaults", includedefaults); - /// If `true`, the request retrieves information from the local node only. If `false`, information is retrieved from the master node. + /// If `true`, the request retrieves information from the local node only. If `false`, information is retrieved from the cluster-manager node. public GetIndexSettingsDescriptor Local(bool? local = true) => Qs("local", local); - /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error. [Obsolete( - "Deprecated as of: 2.0.0, reason: To promote inclusive language, use 'cluster_manager_timeout' instead." + "Deprecated as of: 2.0.0, reason: To promote inclusive language, use `cluster_manager_timeout` instead." )] public GetIndexSettingsDescriptor MasterTimeout(Time mastertimeout) => Qs("master_timeout", mastertimeout); @@ -1395,9 +1395,9 @@ public GetIndexTemplateDescriptor FlatSettings(bool? flatsettings = true) => /// If `true`, the request retrieves information from the local node only. public GetIndexTemplateDescriptor Local(bool? local = true) => Qs("local", local); - /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error. [Obsolete( - "Deprecated as of: 2.0.0, reason: To promote inclusive language, use 'cluster_manager_timeout' instead." + "Deprecated as of: 2.0.0, reason: To promote inclusive language, use `cluster_manager_timeout` instead." )] public GetIndexTemplateDescriptor MasterTimeout(Time mastertimeout) => Qs("master_timeout", mastertimeout); @@ -1423,7 +1423,7 @@ protected OpenIndexDescriptor() // values part of the url path Indices IOpenIndexRequest.Index => Self.RouteValues.Get("index"); - /// Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (`*`). By default, you must explicitly name the indices you using to limit the request. To limit a request using `_all`, `*`, or other wildcard expressions, change the `action.destructive_requires_name` setting to false. You can update this setting in the `opensearch.yml` file or using the cluster update settings API. + /// Comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (`*`). By default, you must explicitly name the indexes you using to limit the request. To limit a request using `_all`, `*`, or other wildcard expressions, change the `action.destructive_requires_name` setting to false. You can update this setting in the `opensearch.yml` file or using the cluster update settings API. public OpenIndexDescriptor Index(Indices index) => Assign(index, (a, v) => a.RouteValues.Required("index", v)); @@ -1436,7 +1436,7 @@ public OpenIndexDescriptor Index() public OpenIndexDescriptor AllIndices() => Index(Indices.All); // Request parameters - /// If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. + /// If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indexes. This behavior applies even if the request targets other open indexes. public OpenIndexDescriptor AllowNoIndices(bool? allownoindices = true) => Qs("allow_no_indices", allownoindices); @@ -1453,14 +1453,14 @@ public OpenIndexDescriptor ExpandWildcards(ExpandWildcards? expandwildcards) => public OpenIndexDescriptor IgnoreUnavailable(bool? ignoreunavailable = true) => Qs("ignore_unavailable", ignoreunavailable); - /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error. [Obsolete( - "Deprecated as of: 2.0.0, reason: To promote inclusive language, use 'cluster_manager_timeout' instead." + "Deprecated as of: 2.0.0, reason: To promote inclusive language, use `cluster_manager_timeout` instead." )] public OpenIndexDescriptor MasterTimeout(Time mastertimeout) => Qs("master_timeout", mastertimeout); - /// Explicit task execution timeout, only useful when wait_for_completion is false, defaults to 1h. + /// Explicit task execution timeout, only useful when `wait_for_completion` is false, defaults to `1h`. public OpenIndexDescriptor TaskExecutionTimeout(Time taskexecutiontimeout) => Qs("task_execution_timeout", taskexecutiontimeout); @@ -1508,7 +1508,7 @@ public PutAliasDescriptor(Name name) Indices IPutAliasRequest.Index => Self.RouteValues.Get("index"); Name IPutAliasRequest.Name => Self.RouteValues.Get("name"); - /// Comma-separated list of data streams or indices to add. Supports wildcards (`*`). Wildcard patterns that match both data streams and indices return an error. + /// Comma-separated list of data streams or indexes to add. Supports wildcards (`*`). Wildcard patterns that match both data streams and indexes return an error. public PutAliasDescriptor Index(Indices index) => Assign(index, (a, v) => a.RouteValues.Optional("index", v)); @@ -1530,9 +1530,9 @@ public PutAliasDescriptor Name(Name name) => public PutAliasDescriptor ClusterManagerTimeout(Time clustermanagertimeout) => Qs("cluster_manager_timeout", clustermanagertimeout); - /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error. [Obsolete( - "Deprecated as of: 2.0.0, reason: To promote inclusive language, use 'cluster_manager_timeout' instead." + "Deprecated as of: 2.0.0, reason: To promote inclusive language, use `cluster_manager_timeout` instead." )] public PutAliasDescriptor MasterTimeout(Time mastertimeout) => Qs("master_timeout", mastertimeout); @@ -1579,9 +1579,9 @@ Time clustermanagertimeout public PutComposableIndexTemplateDescriptor Create(bool? create = true) => Qs("create", create); - /// Operation timeout for connection to master node. + /// Operation timeout for connection to cluster-manager node. [Obsolete( - "Deprecated as of: 2.0.0, reason: To promote inclusive language, use 'cluster_manager_timeout' instead." + "Deprecated as of: 2.0.0, reason: To promote inclusive language, use `cluster_manager_timeout` instead." )] public PutComposableIndexTemplateDescriptor MasterTimeout(Time mastertimeout) => Qs("master_timeout", mastertimeout); @@ -1610,7 +1610,7 @@ public PutMappingDescriptor() // values part of the url path Indices IPutMappingRequest.Index => Self.RouteValues.Get("index"); - /// A comma-separated list of index names the mapping should be added to (supports wildcards); use `_all` or omit to add the mapping on all indices. + /// A comma-separated list of index names the mapping should be added to (supports wildcards); use `_all` or omit to add the mapping on all indexes. public PutMappingDescriptor Index(Indices index) => Assign(index, (a, v) => a.RouteValues.Required("index", v)); @@ -1623,7 +1623,7 @@ public PutMappingDescriptor Index() public PutMappingDescriptor AllIndices() => Index(Indices.All); // Request parameters - /// If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. + /// If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indexes. This behavior applies even if the request targets other open indexes. public PutMappingDescriptor AllowNoIndices(bool? allownoindices = true) => Qs("allow_no_indices", allownoindices); @@ -1640,9 +1640,9 @@ public PutMappingDescriptor ExpandWildcards(ExpandWildcards? expandwi public PutMappingDescriptor IgnoreUnavailable(bool? ignoreunavailable = true) => Qs("ignore_unavailable", ignoreunavailable); - /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error. [Obsolete( - "Deprecated as of: 2.0.0, reason: To promote inclusive language, use 'cluster_manager_timeout' instead." + "Deprecated as of: 2.0.0, reason: To promote inclusive language, use `cluster_manager_timeout` instead." )] public PutMappingDescriptor MasterTimeout(Time mastertimeout) => Qs("master_timeout", mastertimeout); @@ -1678,7 +1678,7 @@ public UpdateIndexSettingsDescriptor(Indices index) // values part of the url path Indices IUpdateIndexSettingsRequest.Index => Self.RouteValues.Get("index"); - /// Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams and indices, omit this parameter or use `*` or `_all`. + /// Comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams and indexes, omit this parameter or use `*` or `_all`. public UpdateIndexSettingsDescriptor Index(Indices index) => Assign(index, (a, v) => a.RouteValues.Optional("index", v)); @@ -1691,7 +1691,7 @@ public UpdateIndexSettingsDescriptor Index() public UpdateIndexSettingsDescriptor AllIndices() => Index(Indices.All); // Request parameters - /// If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. + /// If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indexes. This behavior applies even if the request targets other open indexes. For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. public UpdateIndexSettingsDescriptor AllowNoIndices(bool? allownoindices = true) => Qs("allow_no_indices", allownoindices); @@ -1708,13 +1708,13 @@ public UpdateIndexSettingsDescriptor ExpandWildcards(ExpandWildcards? expandwild public UpdateIndexSettingsDescriptor FlatSettings(bool? flatsettings = true) => Qs("flat_settings", flatsettings); - /// Whether specified concrete indices should be ignored when unavailable (missing or closed). + /// Whether specified concrete indexes should be ignored when unavailable (missing or closed). public UpdateIndexSettingsDescriptor IgnoreUnavailable(bool? ignoreunavailable = true) => Qs("ignore_unavailable", ignoreunavailable); - /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error. [Obsolete( - "Deprecated as of: 2.0.0, reason: To promote inclusive language, use 'cluster_manager_timeout' instead." + "Deprecated as of: 2.0.0, reason: To promote inclusive language, use `cluster_manager_timeout` instead." )] public UpdateIndexSettingsDescriptor MasterTimeout(Time mastertimeout) => Qs("master_timeout", mastertimeout); @@ -1757,12 +1757,12 @@ protected PutIndexTemplateDescriptor() public PutIndexTemplateDescriptor ClusterManagerTimeout(Time clustermanagertimeout) => Qs("cluster_manager_timeout", clustermanagertimeout); - /// If true, this request cannot replace or update existing index templates. + /// If `true`, this request cannot replace or update existing index templates. public PutIndexTemplateDescriptor Create(bool? create = true) => Qs("create", create); - /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error. [Obsolete( - "Deprecated as of: 2.0.0, reason: To promote inclusive language, use 'cluster_manager_timeout' instead." + "Deprecated as of: 2.0.0, reason: To promote inclusive language, use `cluster_manager_timeout` instead." )] public PutIndexTemplateDescriptor MasterTimeout(Time mastertimeout) => Qs("master_timeout", mastertimeout); @@ -1787,7 +1787,7 @@ public RefreshDescriptor(Indices index) // values part of the url path Indices IRefreshRequest.Index => Self.RouteValues.Get("index"); - /// Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams and indices, omit this parameter or use `*` or `_all`. + /// Comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams and indexes, omit this parameter or use `*` or `_all`. public RefreshDescriptor Index(Indices index) => Assign(index, (a, v) => a.RouteValues.Optional("index", v)); @@ -1800,7 +1800,7 @@ public RefreshDescriptor Index() public RefreshDescriptor AllIndices() => Index(Indices.All); // Request parameters - /// If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. + /// If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indexes. This behavior applies even if the request targets other open indexes. public RefreshDescriptor AllowNoIndices(bool? allownoindices = true) => Qs("allow_no_indices", allownoindices); @@ -1887,9 +1887,9 @@ public RolloverIndexDescriptor ClusterManagerTimeout(Time clustermanagertimeout) /// If `true`, checks whether the current index satisfies the specified conditions but does not perform a rollover. public RolloverIndexDescriptor DryRun(bool? dryrun = true) => Qs("dry_run", dryrun); - /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error. [Obsolete( - "Deprecated as of: 2.0.0, reason: To promote inclusive language, use 'cluster_manager_timeout' instead." + "Deprecated as of: 2.0.0, reason: To promote inclusive language, use `cluster_manager_timeout` instead." )] public RolloverIndexDescriptor MasterTimeout(Time mastertimeout) => Qs("master_timeout", mastertimeout); @@ -1943,14 +1943,14 @@ public ShrinkIndexDescriptor Index() public ShrinkIndexDescriptor ClusterManagerTimeout(Time clustermanagertimeout) => Qs("cluster_manager_timeout", clustermanagertimeout); - /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error. [Obsolete( - "Deprecated as of: 2.0.0, reason: To promote inclusive language, use 'cluster_manager_timeout' instead." + "Deprecated as of: 2.0.0, reason: To promote inclusive language, use `cluster_manager_timeout` instead." )] public ShrinkIndexDescriptor MasterTimeout(Time mastertimeout) => Qs("master_timeout", mastertimeout); - /// Explicit task execution timeout, only useful when wait_for_completion is false, defaults to 1h. + /// Explicit task execution timeout, only useful when `wait_for_completion` is false, defaults to `1h`. public ShrinkIndexDescriptor TaskExecutionTimeout(Time taskexecutiontimeout) => Qs("task_execution_timeout", taskexecutiontimeout); @@ -2008,14 +2008,14 @@ public SplitIndexDescriptor Index() public SplitIndexDescriptor ClusterManagerTimeout(Time clustermanagertimeout) => Qs("cluster_manager_timeout", clustermanagertimeout); - /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error. [Obsolete( - "Deprecated as of: 2.0.0, reason: To promote inclusive language, use 'cluster_manager_timeout' instead." + "Deprecated as of: 2.0.0, reason: To promote inclusive language, use `cluster_manager_timeout` instead." )] public SplitIndexDescriptor MasterTimeout(Time mastertimeout) => Qs("master_timeout", mastertimeout); - /// Explicit task execution timeout, only useful when wait_for_completion is false, defaults to 1h. + /// Explicit task execution timeout, only useful when `wait_for_completion` is false, defaults to `1h`. public SplitIndexDescriptor TaskExecutionTimeout(Time taskexecutiontimeout) => Qs("task_execution_timeout", taskexecutiontimeout); @@ -2067,7 +2067,7 @@ public IndicesStatsDescriptor(Metrics metric) Indices IIndicesStatsRequest.Index => Self.RouteValues.Get("index"); Metrics IIndicesStatsRequest.Metric => Self.RouteValues.Get("metric"); - /// A comma-separated list of index names; use the special string `_all` or Indices.All to perform the operation on all indices. + /// A comma-separated list of index names; use the special string `_all` or Indices.All to perform the operation on all indexes. public IndicesStatsDescriptor Index(Indices index) => Assign(index, (a, v) => a.RouteValues.Optional("index", v)); @@ -2084,11 +2084,11 @@ public IndicesStatsDescriptor Metric(Metrics metric) => Assign(metric, (a, v) => a.RouteValues.Optional("metric", v)); // Request parameters - /// Comma-separated list or wildcard expressions of fields to include in fielddata and suggest statistics. + /// Comma-separated list or wildcard expressions of fields to include in field data and suggest statistics. public IndicesStatsDescriptor CompletionFields(Fields completionfields) => Qs("completion_fields", completionfields); - /// Comma-separated list or wildcard expressions of fields to include in fielddata and suggest statistics. + /// Comma-separated list or wildcard expressions of fields to include in field data and suggest statistics. public IndicesStatsDescriptor CompletionFields( params Expression>[] fields ) @@ -2098,11 +2098,11 @@ params Expression>[] fields public IndicesStatsDescriptor ExpandWildcards(ExpandWildcards? expandwildcards) => Qs("expand_wildcards", expandwildcards); - /// Comma-separated list or wildcard expressions of fields to include in fielddata statistics. + /// Comma-separated list or wildcard expressions of fields to include in field data statistics. public IndicesStatsDescriptor FielddataFields(Fields fielddatafields) => Qs("fielddata_fields", fielddatafields); - /// Comma-separated list or wildcard expressions of fields to include in fielddata statistics. + /// Comma-separated list or wildcard expressions of fields to include in field data statistics. public IndicesStatsDescriptor FielddataFields( params Expression>[] fields ) @@ -2115,19 +2115,19 @@ params Expression>[] fields public IndicesStatsDescriptor Fields(params Expression>[] fields) where T : class => Qs("fields", fields?.Select(e => (Field)e)); - /// If true, statistics are not collected from closed indices. + /// If `true`, statistics are not collected from closed indexes. public IndicesStatsDescriptor ForbidClosedIndices(bool? forbidclosedindices = true) => Qs("forbid_closed_indices", forbidclosedindices); /// Comma-separated list of search groups to include in the search statistics. public IndicesStatsDescriptor Groups(params string[] groups) => Qs("groups", groups); - /// If true, the call reports the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested). + /// If `true`, the call reports the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested). public IndicesStatsDescriptor IncludeSegmentFileSizes( bool? includesegmentfilesizes = true ) => Qs("include_segment_file_sizes", includesegmentfilesizes); - /// If true, the response includes information from segments that are not loaded into memory. + /// If `true`, the response includes information from segments that are not loaded into memory. public IndicesStatsDescriptor IncludeUnloadedSegments( bool? includeunloadedsegments = true ) => Qs("include_unloaded_segments", includeunloadedsegments); @@ -2150,9 +2150,9 @@ public partial class BulkAliasDescriptor public BulkAliasDescriptor ClusterManagerTimeout(Time clustermanagertimeout) => Qs("cluster_manager_timeout", clustermanagertimeout); - /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error. [Obsolete( - "Deprecated as of: 2.0.0, reason: To promote inclusive language, use 'cluster_manager_timeout' instead." + "Deprecated as of: 2.0.0, reason: To promote inclusive language, use `cluster_manager_timeout` instead." )] public BulkAliasDescriptor MasterTimeout(Time mastertimeout) => Qs("master_timeout", mastertimeout); @@ -2184,7 +2184,7 @@ public ValidateQueryDescriptor(Indices index) // values part of the url path Indices IValidateQueryRequest.Index => Self.RouteValues.Get("index"); - /// Comma-separated list of data streams, indices, and aliases to search. Supports wildcards (`*`). To search all data streams or indices, omit this parameter or use `*` or `_all`. + /// Comma-separated list of data streams, indexes, and aliases to search. Supports wildcards (`*`). To search all data streams or indexes, omit this parameter or use `*` or `_all`. public ValidateQueryDescriptor Index(Indices index) => Assign(index, (a, v) => a.RouteValues.Optional("index", v)); @@ -2197,7 +2197,7 @@ public ValidateQueryDescriptor Index() public ValidateQueryDescriptor AllIndices() => Index(Indices.All); // Request parameters - /// If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. + /// If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indexes. This behavior applies even if the request targets other open indexes. public ValidateQueryDescriptor AllowNoIndices(bool? allownoindices = true) => Qs("allow_no_indices", allownoindices); diff --git a/src/OpenSearch.Client/_Generated/Descriptors.Ingest.cs b/src/OpenSearch.Client/_Generated/Descriptors.Ingest.cs index 9ade495896..333dbe1297 100644 --- a/src/OpenSearch.Client/_Generated/Descriptors.Ingest.cs +++ b/src/OpenSearch.Client/_Generated/Descriptors.Ingest.cs @@ -87,9 +87,9 @@ protected DeletePipelineDescriptor() public DeletePipelineDescriptor ClusterManagerTimeout(Time clustermanagertimeout) => Qs("cluster_manager_timeout", clustermanagertimeout); - /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error. [Obsolete( - "Deprecated as of: 2.0.0, reason: To promote inclusive language, use 'cluster_manager_timeout' instead." + "Deprecated as of: 2.0.0, reason: To promote inclusive language, use `cluster_manager_timeout` instead." )] public DeletePipelineDescriptor MasterTimeout(Time mastertimeout) => Qs("master_timeout", mastertimeout); @@ -131,9 +131,9 @@ public GetPipelineDescriptor Id(Id id) => public GetPipelineDescriptor ClusterManagerTimeout(Time clustermanagertimeout) => Qs("cluster_manager_timeout", clustermanagertimeout); - /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error. [Obsolete( - "Deprecated as of: 2.0.0, reason: To promote inclusive language, use 'cluster_manager_timeout' instead." + "Deprecated as of: 2.0.0, reason: To promote inclusive language, use `cluster_manager_timeout` instead." )] public GetPipelineDescriptor MasterTimeout(Time mastertimeout) => Qs("master_timeout", mastertimeout); @@ -149,8 +149,12 @@ public partial class GrokProcessorPatternsDescriptor IGrokProcessorPatternsRequest { internal override ApiUrls ApiUrls => ApiUrlsLookups.IngestGrokProcessorPatterns; + // values part of the url path // Request parameters + /// Sort returned patterns by key name. + public GrokProcessorPatternsDescriptor SortByColumns(bool? sortbycolumns = true) => + Qs("s", sortbycolumns); } /// Descriptor for PutPipeline https://opensearch.org/docs/latest/api-reference/ingest-apis/create-update-ingest/ @@ -183,9 +187,9 @@ protected PutPipelineDescriptor() public PutPipelineDescriptor ClusterManagerTimeout(Time clustermanagertimeout) => Qs("cluster_manager_timeout", clustermanagertimeout); - /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error. [Obsolete( - "Deprecated as of: 2.0.0, reason: To promote inclusive language, use 'cluster_manager_timeout' instead." + "Deprecated as of: 2.0.0, reason: To promote inclusive language, use `cluster_manager_timeout` instead." )] public PutPipelineDescriptor MasterTimeout(Time mastertimeout) => Qs("master_timeout", mastertimeout); diff --git a/src/OpenSearch.Client/_Generated/Descriptors.NoNamespace.cs b/src/OpenSearch.Client/_Generated/Descriptors.NoNamespace.cs index 62068d1e30..040206197b 100644 --- a/src/OpenSearch.Client/_Generated/Descriptors.NoNamespace.cs +++ b/src/OpenSearch.Client/_Generated/Descriptors.NoNamespace.cs @@ -172,7 +172,7 @@ public CountDescriptor(Indices index) // values part of the url path Indices ICountRequest.Index => Self.RouteValues.Get("index"); - /// Comma-separated list of data streams, indices, and aliases to search. Supports wildcards (`*`). To search all data streams and indices, omit this parameter or use `*` or `_all`. + /// Comma-separated list of data streams, indexes, and aliases to search. Supports wildcards (`*`). To search all data streams and indexes, omit this parameter or use `*` or `_all`. public CountDescriptor Index(Indices index) => Assign(index, (a, v) => a.RouteValues.Optional("index", v)); @@ -185,7 +185,7 @@ public CountDescriptor Index() public CountDescriptor AllIndices() => Index(Indices.All); // Request parameters - /// If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. + /// If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indexes. This behavior applies even if the request targets other open indexes. public CountDescriptor AllowNoIndices(bool? allownoindices = true) => Qs("allow_no_indices", allownoindices); @@ -207,7 +207,7 @@ public CountDescriptor DefaultOperator(DefaultOperator? defaultoperat public CountDescriptor ExpandWildcards(ExpandWildcards? expandwildcards) => Qs("expand_wildcards", expandwildcards); - /// If `true`, concrete, expanded or aliased indices are ignored when frozen. + /// If `true`, concrete, expanded or aliased indexes are ignored when frozen. public CountDescriptor IgnoreThrottled(bool? ignorethrottled = true) => Qs("ignore_throttled", ignorethrottled); @@ -342,7 +342,7 @@ protected CreatePitDescriptor() // values part of the url path Indices ICreatePitRequest.Index => Self.RouteValues.Get("index"); - /// Comma-separated list of indices; use the special string `_all` or Indices.All to perform the operation on all indices. + /// Comma-separated list of indexes; use the special string `_all` or Indices.All to perform the operation on all indexes. public CreatePitDescriptor Index(Indices index) => Assign(index, (a, v) => a.RouteValues.Required("index", v)); @@ -359,7 +359,7 @@ public CreatePitDescriptor Index() public CreatePitDescriptor AllowPartialPitCreation(bool? allowpartialpitcreation = true) => Qs("allow_partial_pit_creation", allowpartialpitcreation); - /// Whether to expand wildcard expression to concrete indices that are open, closed or both. + /// Whether to expand wildcard expression to concrete indexes that are open, closed or both. public CreatePitDescriptor ExpandWildcards(ExpandWildcards? expandwildcards) => Qs("expand_wildcards", expandwildcards); @@ -500,7 +500,7 @@ public DeleteByQueryDescriptor() // values part of the url path Indices IDeleteByQueryRequest.Index => Self.RouteValues.Get("index"); - /// Comma-separated list of data streams, indices, and aliases to search. Supports wildcards (`*`). To search all data streams or indices, omit this parameter or use `*` or `_all`. + /// Comma-separated list of data streams, indexes, and aliases to search. Supports wildcards (`*`). To search all data streams or indexes, omit this parameter or use `*` or `_all`. public DeleteByQueryDescriptor Index(Indices index) => Assign(index, (a, v) => a.RouteValues.Required("index", v)); @@ -513,7 +513,7 @@ public DeleteByQueryDescriptor Index() public DeleteByQueryDescriptor AllIndices() => Index(Indices.All); // Request parameters - /// If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. + /// If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indexes. This behavior applies even if the request targets other open indexes. For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. public DeleteByQueryDescriptor AllowNoIndices(bool? allownoindices = true) => Qs("allow_no_indices", allownoindices); @@ -563,7 +563,7 @@ public DeleteByQueryDescriptor QueryOnQueryString(string queryonquery Qs("q", queryonquerystring); /// If `true`, OpenSearch refreshes all shards involved in the delete by query after the request completes. - public DeleteByQueryDescriptor Refresh(bool? refresh = true) => + public DeleteByQueryDescriptor Refresh(Refresh? refresh) => Qs("refresh", refresh); /// If `true`, the request cache is used for this request. Defaults to the index-level setting. @@ -599,7 +599,7 @@ public DeleteByQueryDescriptor SearchTimeout(Time searchtimeout) => public DeleteByQueryDescriptor SearchType(SearchType? searchtype) => Qs("search_type", searchtype); - /// Deprecated, please use `max_docs` instead. + /// Deprecated, use `max_docs` instead. public DeleteByQueryDescriptor Size(long? size) => Qs("size", size); /// A comma-separated list of <field>:<direction> pairs. @@ -609,20 +609,20 @@ public DeleteByQueryDescriptor SearchType(SearchType? searchtype) => public DeleteByQueryDescriptor SourceEnabled(bool? sourceenabled = true) => Qs("_source", sourceenabled); - /// List of fields to exclude from the returned _source field. + /// List of fields to exclude from the returned `_source` field. public DeleteByQueryDescriptor SourceExcludes(Fields sourceexcludes) => Qs("_source_excludes", sourceexcludes); - /// List of fields to exclude from the returned _source field. + /// List of fields to exclude from the returned `_source` field. public DeleteByQueryDescriptor SourceExcludes( params Expression>[] fields ) => Qs("_source_excludes", fields?.Select(e => (Field)e)); - /// List of fields to extract and return from the _source field. + /// List of fields to extract and return from the `_source` field. public DeleteByQueryDescriptor SourceIncludes(Fields sourceincludes) => Qs("_source_includes", sourceincludes); - /// List of fields to extract and return from the _source field. + /// List of fields to extract and return from the `_source` field. public DeleteByQueryDescriptor SourceIncludes( params Expression>[] fields ) => Qs("_source_includes", fields?.Select(e => (Field)e)); @@ -631,7 +631,7 @@ params Expression>[] fields public DeleteByQueryDescriptor Stats(params string[] stats) => Qs("stats", stats); - /// 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. + /// 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 indexes across multiple data tiers. public DeleteByQueryDescriptor TerminateAfter(long? terminateafter) => Qs("terminate_after", terminateafter); @@ -722,9 +722,9 @@ protected DeleteScriptDescriptor() public DeleteScriptDescriptor ClusterManagerTimeout(Time clustermanagertimeout) => Qs("cluster_manager_timeout", clustermanagertimeout); - /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error. [Obsolete( - "Deprecated as of: 2.0.0, reason: To promote inclusive language, use 'cluster_manager_timeout' instead." + "Deprecated as of: 2.0.0, reason: To promote inclusive language, use `cluster_manager_timeout` instead." )] public DeleteScriptDescriptor MasterTimeout(Time mastertimeout) => Qs("master_timeout", mastertimeout); @@ -776,7 +776,7 @@ protected DocumentExistsDescriptor() Id IDocumentExistsRequest.Id => Self.RouteValues.Get("id"); IndexName IDocumentExistsRequest.Index => Self.RouteValues.Get("index"); - /// Comma-separated list of data streams, indices, and aliases. Supports wildcards (`*`). + /// Comma-separated list of data streams, indexes, and aliases. Supports wildcards (`*`). public DocumentExistsDescriptor Index(IndexName index) => Assign(index, (a, v) => a.RouteValues.Required("index", v)); @@ -795,7 +795,7 @@ public DocumentExistsDescriptor Realtime(bool? realtime = true) => Qs("realtime", realtime); /// If `true`, OpenSearch refreshes all shards involved in the delete by query after the request completes. - public DocumentExistsDescriptor Refresh(bool? refresh = true) => + public DocumentExistsDescriptor Refresh(Refresh? refresh) => Qs("refresh", refresh); /// @@ -890,7 +890,7 @@ protected SourceExistsDescriptor() Id ISourceExistsRequest.Id => Self.RouteValues.Get("id"); IndexName ISourceExistsRequest.Index => Self.RouteValues.Get("index"); - /// Comma-separated list of data streams, indices, and aliases. Supports wildcards (`*`). + /// Comma-separated list of data streams, indexes, and aliases. Supports wildcards (`*`). public SourceExistsDescriptor Index(IndexName index) => Assign(index, (a, v) => a.RouteValues.Required("index", v)); @@ -904,12 +904,12 @@ public SourceExistsDescriptor Index() public SourceExistsDescriptor Preference(string preference) => Qs("preference", preference); - /// If true, the request is real-time as opposed to near-real-time. + /// If `true`, the request is real-time as opposed to near-real-time. public SourceExistsDescriptor Realtime(bool? realtime = true) => Qs("realtime", realtime); /// If `true`, OpenSearch refreshes all shards involved in the delete by query after the request completes. - public SourceExistsDescriptor Refresh(bool? refresh = true) => + public SourceExistsDescriptor Refresh(Refresh? refresh) => Qs("refresh", refresh); /// @@ -1080,7 +1080,7 @@ public FieldCapabilitiesDescriptor(Indices index) // values part of the url path Indices IFieldCapabilitiesRequest.Index => Self.RouteValues.Get("index"); - /// Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (*). To target all data streams and indices, omit this parameter or use * or _all. + /// Comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (*). To target all data streams and indexes, omit this parameter or use * or `_all`. public FieldCapabilitiesDescriptor Index(Indices index) => Assign(index, (a, v) => a.RouteValues.Optional("index", v)); @@ -1093,7 +1093,7 @@ public FieldCapabilitiesDescriptor Index() public FieldCapabilitiesDescriptor AllIndices() => Index(Indices.All); // Request parameters - /// If false, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targeting `foo*,bar*` returns an error if an index starts with foo but no index starts with bar. + /// If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indexes. This behavior applies even if the request targets other open indexes. For example, a request targeting `foo*,bar*` returns an error if an index starts with foo but no index starts with bar. public FieldCapabilitiesDescriptor AllowNoIndices(bool? allownoindices = true) => Qs("allow_no_indices", allownoindices); @@ -1108,11 +1108,11 @@ public FieldCapabilitiesDescriptor ExpandWildcards(ExpandWildcards? expandwildca public FieldCapabilitiesDescriptor Fields(params Expression>[] fields) where T : class => Qs("fields", fields?.Select(e => (Field)e)); - /// If `true`, missing or closed indices are not included in the response. + /// If `true`, missing or closed indexes are not included in the response. public FieldCapabilitiesDescriptor IgnoreUnavailable(bool? ignoreunavailable = true) => Qs("ignore_unavailable", ignoreunavailable); - /// If true, unmapped fields are included in the response. + /// If `true`, unmapped fields are included in the response. public FieldCapabilitiesDescriptor IncludeUnmapped(bool? includeunmapped = true) => Qs("include_unmapped", includeunmapped); } @@ -1173,8 +1173,8 @@ public GetDescriptor Preference(string preference) => /// If `true`, the request is real-time as opposed to near-real-time. public GetDescriptor Realtime(bool? realtime = true) => Qs("realtime", realtime); - /// If true, OpenSearch refreshes the affected shards to make this operation visible to search. If false, do nothing with refreshes. - public GetDescriptor Refresh(bool? refresh = true) => Qs("refresh", refresh); + /// If `true`, OpenSearch refreshes the affected shards to make this operation visible to search. If `false`, do nothing with refreshes. + public GetDescriptor Refresh(Refresh? refresh) => Qs("refresh", refresh); /// /// A document is routed to a particular shard in an index using the following formula @@ -1219,7 +1219,7 @@ params Expression>[] fields /// Explicit version number for concurrency control. The specified version must match the current version of the document for the request to succeed. public GetDescriptor Version(long? version) => Qs("version", version); - /// Specific version type: internal, external, external_gte. + /// Specific version type: `internal`, `external`, `external_gte`. public GetDescriptor VersionType(VersionType? versiontype) => Qs("version_type", versiontype); } @@ -1266,7 +1266,7 @@ public GetScriptDescriptor ClusterManagerTimeout(Time clustermanagertimeout) => /// Specify timeout for connection to master. [Obsolete( - "Deprecated as of: 2.0.0, reason: To promote inclusive language, use 'cluster_manager_timeout' instead." + "Deprecated as of: 2.0.0, reason: To promote inclusive language, use `cluster_manager_timeout` instead." )] public GetScriptDescriptor MasterTimeout(Time mastertimeout) => Qs("master_timeout", mastertimeout); @@ -1325,12 +1325,12 @@ public SourceDescriptor Index() public SourceDescriptor Preference(string preference) => Qs("preference", preference); - /// Boolean) If true, the request is real-time as opposed to near-real-time. + /// Boolean) If `true`, the request is real-time as opposed to near-real-time. public SourceDescriptor Realtime(bool? realtime = true) => Qs("realtime", realtime); - /// If true, OpenSearch refreshes the affected shards to make this operation visible to search. If false, do nothing with refreshes. - public SourceDescriptor Refresh(bool? refresh = true) => Qs("refresh", refresh); + /// If `true`, OpenSearch refreshes the affected shards to make this operation visible to search. If `false`, do nothing with refreshes. + public SourceDescriptor Refresh(Refresh? refresh) => Qs("refresh", refresh); /// /// A document is routed to a particular shard in an index using the following formula @@ -1366,7 +1366,7 @@ params Expression>[] fields /// Explicit version number for concurrency control. The specified version must match the current version of the document for the request to succeed. public SourceDescriptor Version(long? version) => Qs("version", version); - /// Specific version type: internal, external, external_gte. + /// Specific version type. One of `internal`, `external`, `external_gte`. public SourceDescriptor VersionType(VersionType? versiontype) => Qs("version_type", versiontype); } @@ -1523,7 +1523,7 @@ public MultiGetDescriptor Index() public MultiGetDescriptor Realtime(bool? realtime = true) => Qs("realtime", realtime); /// If `true`, the request refreshes relevant shards before retrieving documents. - public MultiGetDescriptor Refresh(bool? refresh = true) => Qs("refresh", refresh); + public MultiGetDescriptor Refresh(Refresh? refresh) => Qs("refresh", refresh); /// /// A document is routed to a particular shard in an index using the following formula @@ -1578,7 +1578,7 @@ public MultiSearchDescriptor(Indices index) // values part of the url path Indices IMultiSearchRequest.Index => Self.RouteValues.Get("index"); - /// Comma-separated list of data streams, indices, and index aliases to search. + /// Comma-separated list of data streams, indexes, and index aliases to search. public MultiSearchDescriptor Index(Indices index) => Assign(index, (a, v) => a.RouteValues.Optional("index", v)); @@ -1591,7 +1591,7 @@ public MultiSearchDescriptor Index() public MultiSearchDescriptor AllIndices() => Index(Indices.All); // Request parameters - /// If true, network roundtrips between the coordinating node and remote clusters are minimized for cross-cluster search requests. + /// If `true`, network round-trips between the coordinating node and remote clusters are minimized for cross-cluster search requests. public MultiSearchDescriptor CcsMinimizeRoundtrips(bool? ccsminimizeroundtrips = true) => Qs("ccs_minimize_roundtrips", ccsminimizeroundtrips); @@ -1611,7 +1611,7 @@ public MultiSearchDescriptor PreFilterShardSize(long? prefiltershardsize) => public MultiSearchDescriptor SearchType(SearchType? searchtype) => Qs("search_type", searchtype); - /// If true, hits.total are returned as an integer in the response. Defaults to false, which returns an object. + /// If `true`, `hits.total` are returned as an integer in the response. Defaults to false, which returns an object. public MultiSearchDescriptor TotalHitsAsInteger(bool? totalhitsasinteger = true) => Qs("rest_total_hits_as_int", totalhitsasinteger); @@ -1643,7 +1643,7 @@ public MultiSearchTemplateDescriptor(Indices index) // values part of the url path Indices IMultiSearchTemplateRequest.Index => Self.RouteValues.Get("index"); - /// Comma-separated list of data streams, indices, and aliases to search. Supports wildcards (`*`). To search all data streams and indices, omit this parameter or use `*`. + /// Comma-separated list of data streams, indexes, and aliases to search. Supports wildcards (`*`). To search all data streams and indexes, omit this parameter or use `*`. public MultiSearchTemplateDescriptor Index(Indices index) => Assign(index, (a, v) => a.RouteValues.Optional("index", v)); @@ -1737,7 +1737,7 @@ public MultiTermVectorsDescriptor Positions(bool? positions = true) => public MultiTermVectorsDescriptor Preference(string preference) => Qs("preference", preference); - /// If true, the request is real-time as opposed to near-real-time. + /// If `true`, the request is real-time as opposed to near-real-time. public MultiTermVectorsDescriptor Realtime(bool? realtime = true) => Qs("realtime", realtime); @@ -1750,7 +1750,7 @@ public MultiTermVectorsDescriptor Realtime(bool? realtime = true) => /// public MultiTermVectorsDescriptor Routing(Routing routing) => Qs("routing", routing); - /// If true, the response includes term frequency and document frequency. + /// If `true`, the response includes term frequency and document frequency. public MultiTermVectorsDescriptor TermStatistics(bool? termstatistics = true) => Qs("term_statistics", termstatistics); @@ -1809,9 +1809,9 @@ public PutScriptDescriptor Context(Name context) => public PutScriptDescriptor ClusterManagerTimeout(Time clustermanagertimeout) => Qs("cluster_manager_timeout", clustermanagertimeout); - /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error. [Obsolete( - "Deprecated as of: 2.0.0, reason: To promote inclusive language, use 'cluster_manager_timeout' instead." + "Deprecated as of: 2.0.0, reason: To promote inclusive language, use `cluster_manager_timeout` instead." )] public PutScriptDescriptor MasterTimeout(Time mastertimeout) => Qs("master_timeout", mastertimeout); @@ -1834,7 +1834,7 @@ public partial class ReindexOnServerDescriptor // values part of the url path // Request parameters /// If `true`, the request refreshes affected shards to make this operation visible to search. - public ReindexOnServerDescriptor Refresh(bool? refresh = true) => Qs("refresh", refresh); + public ReindexOnServerDescriptor Refresh(Refresh? refresh) => Qs("refresh", refresh); /// The throttle for this request in sub-requests per second. Defaults to no throttle. public ReindexOnServerDescriptor RequestsPerSecond(long? requestspersecond) => @@ -1941,7 +1941,7 @@ public partial class ScrollDescriptor // values part of the url path // Request parameters - /// If true, the API response's hit.total property is returned as an integer. If false, the API response's hit.total property is returned as an object. + /// If `true`, the API response's `hit.total` property is returned as an integer. If `false`, the API response's `hit.total` property is returned as an object. public ScrollDescriptor TotalHitsAsInteger( bool? totalhitsasinteger = true ) => Qs("rest_total_hits_as_int", totalhitsasinteger); @@ -1970,7 +1970,7 @@ public SearchDescriptor(Indices index) // values part of the url path Indices ISearchRequest.Index => Self.RouteValues.Get("index"); - /// Comma-separated list of data streams, indices, and aliases to search. Supports wildcards (`*`). To search all data streams and indices, omit this parameter or use `*` or `_all`. + /// Comma-separated list of data streams, indexes, and aliases to search. Supports wildcards (`*`). To search all data streams and indexes, omit this parameter or use `*` or `_all`. public SearchDescriptor Index(Indices index) => Assign(index, (a, v) => a.RouteValues.Optional("index", v)); @@ -1983,11 +1983,11 @@ public SearchDescriptor Index() public SearchDescriptor AllIndices() => Index(Indices.All); // Request parameters - /// If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. + /// If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indexes. This behavior applies even if the request targets other open indexes. For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. public SearchDescriptor AllowNoIndices(bool? allownoindices = true) => Qs("allow_no_indices", allownoindices); - /// If true, returns partial results if there are shard request timeouts or shard failures. If false, returns an error with no partial results. + /// If `true`, returns partial results if there are shard request timeouts or shard failures. If `false`, returns an error with no partial results. public SearchDescriptor AllowPartialSearchResults( bool? allowpartialsearchresults = true ) => Qs("allow_partial_search_results", allowpartialsearchresults); @@ -1996,7 +1996,7 @@ public SearchDescriptor AllowPartialSearchResults( public SearchDescriptor Analyzer(string analyzer) => Qs("analyzer", analyzer); - /// If true, wildcard and prefix queries are analyzed. This parameter can only be used when the q query string parameter is specified. + /// If `true`, wildcard and prefix queries are analyzed. This parameter can only be used when the q query string parameter is specified. public SearchDescriptor AnalyzeWildcard(bool? analyzewildcard = true) => Qs("analyze_wildcard", analyzewildcard); @@ -2009,7 +2009,7 @@ public SearchDescriptor CancelAfterTimeInterval( Time cancelaftertimeinterval ) => Qs("cancel_after_time_interval", cancelaftertimeinterval); - /// If true, network round-trips between the coordinating node and the remote clusters are minimized when executing cross-cluster search (CCS) requests. + /// If `true`, network round-trips between the coordinating node and the remote clusters are minimized when executing cross-cluster search (CCS) requests. public SearchDescriptor CcsMinimizeRoundtrips( bool? ccsminimizeroundtrips = true ) => Qs("ccs_minimize_roundtrips", ccsminimizeroundtrips); @@ -2025,7 +2025,7 @@ public SearchDescriptor DefaultOperator(DefaultOperator? default public SearchDescriptor ExpandWildcards(ExpandWildcards? expandwildcards) => Qs("expand_wildcards", expandwildcards); - /// If `true`, concrete, expanded or aliased indices will be ignored when frozen. + /// If `true`, concrete, expanded or aliased indexes will be ignored when frozen. public SearchDescriptor IgnoreThrottled(bool? ignorethrottled = true) => Qs("ignore_throttled", ignorethrottled); @@ -2033,7 +2033,7 @@ public SearchDescriptor IgnoreThrottled(bool? ignorethrottled = public SearchDescriptor IgnoreUnavailable(bool? ignoreunavailable = true) => Qs("ignore_unavailable", ignoreunavailable); - /// Indicates whether hit.matched_queries should be rendered as a map that includes the name of the matched query associated with its score (true) or as an array containing the name of the matched queries (false). + /// Indicates whether `hit.matched_queries` should be rendered as a map that includes the name of the matched query associated with its score (true) or as an array containing the name of the matched queries (false). public SearchDescriptor IncludeNamedQueriesScore( bool? includenamedqueriesscore = true ) => Qs("include_named_queries_score", includenamedqueriesscore); @@ -2149,7 +2149,7 @@ public SearchShardsDescriptor(Indices index) // values part of the url path Indices ISearchShardsRequest.Index => Self.RouteValues.Get("index"); - /// Returns the indices and shards that a search request would be executed against. + /// Returns the indexes and shards that a search request would be executed against. public SearchShardsDescriptor Index(Indices index) => Assign(index, (a, v) => a.RouteValues.Optional("index", v)); @@ -2162,7 +2162,7 @@ public SearchShardsDescriptor Index() public SearchShardsDescriptor AllIndices() => Index(Indices.All); // Request parameters - /// If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. + /// If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indexes. This behavior applies even if the request targets other open indexes. For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. public SearchShardsDescriptor AllowNoIndices(bool? allownoindices = true) => Qs("allow_no_indices", allownoindices); @@ -2216,7 +2216,7 @@ public SearchTemplateDescriptor(Indices index) // values part of the url path Indices ISearchTemplateRequest.Index => Self.RouteValues.Get("index"); - /// Comma-separated list of data streams, indices, and aliases to search. Supports wildcards (*). + /// Comma-separated list of data streams, indexes, and aliases to search. Supports wildcards (*). public SearchTemplateDescriptor Index(Indices index) => Assign(index, (a, v) => a.RouteValues.Optional("index", v)); @@ -2229,7 +2229,7 @@ public SearchTemplateDescriptor Index() public SearchTemplateDescriptor AllIndices() => Index(Indices.All); // Request parameters - /// If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. + /// If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indexes. This behavior applies even if the request targets other open indexes. For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. public SearchTemplateDescriptor AllowNoIndices(bool? allownoindices = true) => Qs("allow_no_indices", allownoindices); @@ -2247,7 +2247,7 @@ public SearchTemplateDescriptor ExpandWildcards( public SearchTemplateDescriptor Explain(bool? explain = true) => Qs("explain", explain); - /// If `true`, specified concrete, expanded, or aliased indices are not included in the response when throttled. + /// If `true`, specified concrete, expanded, or aliased indexes are not included in the response when throttled. public SearchTemplateDescriptor IgnoreThrottled(bool? ignorethrottled = true) => Qs("ignore_throttled", ignorethrottled); @@ -2281,7 +2281,7 @@ public SearchTemplateDescriptor Routing(Routing routing) => public SearchTemplateDescriptor SearchType(SearchType? searchtype) => Qs("search_type", searchtype); - /// If true, hits.total are rendered as an integer in the response. + /// If `true`, `hits.total` are rendered as an integer in the response. public SearchTemplateDescriptor TotalHitsAsInteger( bool? totalhitsasinteger = true ) => Qs("rest_total_hits_as_int", totalhitsasinteger); @@ -2376,7 +2376,7 @@ public TermVectorsDescriptor Positions(bool? positions = true) => public TermVectorsDescriptor Preference(string preference) => Qs("preference", preference); - /// If true, the request is real-time as opposed to near-real-time. + /// If `true`, the request is real-time as opposed to near-real-time. public TermVectorsDescriptor Realtime(bool? realtime = true) => Qs("realtime", realtime); @@ -2463,11 +2463,11 @@ public UpdateDescriptor IfSequenceNumber( /// The script language. public UpdateDescriptor Lang(string lang) => Qs("lang", lang); - /// If 'true', OpenSearch refreshes the affected shards to make this operation visible to search, if 'wait_for' then wait for a refresh to make this operation visible to search, if 'false' do nothing with refreshes. + /// If 'true', OpenSearch refreshes the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` do nothing with refreshes. public UpdateDescriptor Refresh(Refresh? refresh) => Qs("refresh", refresh); - /// If true, the destination must be an index alias. + /// If `true`, the destination must be an index alias. public UpdateDescriptor RequireAlias( bool? requirealias = true ) => Qs("require_alias", requirealias); @@ -2525,7 +2525,7 @@ public UpdateByQueryDescriptor() // values part of the url path Indices IUpdateByQueryRequest.Index => Self.RouteValues.Get("index"); - /// Comma-separated list of data streams, indices, and aliases to search. Supports wildcards (`*`). To search all data streams or indices, omit this parameter or use `*` or `_all`. + /// Comma-separated list of data streams, indexes, and aliases to search. Supports wildcards (`*`). To search all data streams or indexes, omit this parameter or use `*` or `_all`. public UpdateByQueryDescriptor Index(Indices index) => Assign(index, (a, v) => a.RouteValues.Required("index", v)); @@ -2538,7 +2538,7 @@ public UpdateByQueryDescriptor Index() public UpdateByQueryDescriptor AllIndices() => Index(Indices.All); // Request parameters - /// If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. + /// If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indexes. This behavior applies even if the request targets other open indexes. For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. public UpdateByQueryDescriptor AllowNoIndices(bool? allownoindices = true) => Qs("allow_no_indices", allownoindices); @@ -2592,7 +2592,7 @@ public UpdateByQueryDescriptor QueryOnQueryString(string queryonquery Qs("q", queryonquerystring); /// If `true`, OpenSearch refreshes affected shards to make the operation visible to search. - public UpdateByQueryDescriptor Refresh(bool? refresh = true) => + public UpdateByQueryDescriptor Refresh(Refresh? refresh) => Qs("refresh", refresh); /// If `true`, the request cache is used for this request. @@ -2628,7 +2628,7 @@ public UpdateByQueryDescriptor SearchTimeout(Time searchtimeout) => public UpdateByQueryDescriptor SearchType(SearchType? searchtype) => Qs("search_type", searchtype); - /// Deprecated, please use `max_docs` instead. + /// Deprecated, use `max_docs` instead. public UpdateByQueryDescriptor Size(long? size) => Qs("size", size); /// A comma-separated list of <field>:<direction> pairs. @@ -2638,20 +2638,20 @@ public UpdateByQueryDescriptor SearchType(SearchType? searchtype) => public UpdateByQueryDescriptor SourceEnabled(bool? sourceenabled = true) => Qs("_source", sourceenabled); - /// List of fields to exclude from the returned _source field. + /// List of fields to exclude from the returned `_source` field. public UpdateByQueryDescriptor SourceExcludes(Fields sourceexcludes) => Qs("_source_excludes", sourceexcludes); - /// List of fields to exclude from the returned _source field. + /// List of fields to exclude from the returned `_source` field. public UpdateByQueryDescriptor SourceExcludes( params Expression>[] fields ) => Qs("_source_excludes", fields?.Select(e => (Field)e)); - /// List of fields to extract and return from the _source field. + /// List of fields to extract and return from the `_source` field. public UpdateByQueryDescriptor SourceIncludes(Fields sourceincludes) => Qs("_source_includes", sourceincludes); - /// List of fields to extract and return from the _source field. + /// List of fields to extract and return from the `_source` field. public UpdateByQueryDescriptor SourceIncludes( params Expression>[] fields ) => Qs("_source_includes", fields?.Select(e => (Field)e)); @@ -2660,7 +2660,7 @@ params Expression>[] fields public UpdateByQueryDescriptor Stats(params string[] stats) => Qs("stats", stats); - /// 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. + /// 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 indexes across multiple data tiers. public UpdateByQueryDescriptor TerminateAfter(long? terminateafter) => Qs("terminate_after", terminateafter); diff --git a/src/OpenSearch.Client/_Generated/Descriptors.Nodes.cs b/src/OpenSearch.Client/_Generated/Descriptors.Nodes.cs index 4caeb869f8..3d7e74a2da 100644 --- a/src/OpenSearch.Client/_Generated/Descriptors.Nodes.cs +++ b/src/OpenSearch.Client/_Generated/Descriptors.Nodes.cs @@ -92,7 +92,7 @@ public NodesHotThreadsDescriptor IgnoreIdleThreads(bool? ignoreidlethreads = tru /// The interval for the second sampling of threads. public NodesHotThreadsDescriptor Interval(Time interval) => Qs("interval", interval); - /// Number of samples of thread stacktrace. + /// Number of samples of thread stack trace. public NodesHotThreadsDescriptor Snapshots(long? snapshots) => Qs("snapshots", snapshots); /// Specify the number of threads to provide information for. @@ -136,7 +136,7 @@ public NodesInfoDescriptor(NodeIds nodeId, Metrics metric) Metrics INodesInfoRequest.Metric => Self.RouteValues.Get("metric"); NodeIds INodesInfoRequest.NodeId => Self.RouteValues.Get("node_id"); - /// Limits the information returned to the specific metrics. Supports a comma-separated list, such as http,ingest. + /// Limits the information returned to the specific metrics. Supports a comma-separated list, such as `http,ingest`. public NodesInfoDescriptor Metric(Metrics metric) => Assign(metric, (a, v) => a.RouteValues.Optional("metric", v)); @@ -145,7 +145,7 @@ public NodesInfoDescriptor NodeId(NodeIds nodeId) => Assign(nodeId, (a, v) => a.RouteValues.Optional("node_id", v)); // Request parameters - /// If true, returns settings in flat format. + /// If `true`, returns settings in flat format. public NodesInfoDescriptor FlatSettings(bool? flatsettings = true) => Qs("flat_settings", flatsettings); @@ -239,7 +239,7 @@ public NodesStatsDescriptor(NodeIds nodeId, Metrics metric, IndexMetrics indexMe Metrics INodesStatsRequest.Metric => Self.RouteValues.Get("metric"); NodeIds INodesStatsRequest.NodeId => Self.RouteValues.Get("node_id"); - /// Limit the information returned for indices metric to the specific index metrics. It can be used only if indices (or all) metric is specified. + /// Limit the information returned for indexes metric to the specific index metrics. It can be used only if indexes (or all) metric is specified. public NodesStatsDescriptor IndexMetric(IndexMetrics indexMetric) => Assign(indexMetric, (a, v) => a.RouteValues.Optional("index_metric", v)); @@ -252,19 +252,19 @@ public NodesStatsDescriptor NodeId(NodeIds nodeId) => Assign(nodeId, (a, v) => a.RouteValues.Optional("node_id", v)); // Request parameters - /// Comma-separated list or wildcard expressions of fields to include in fielddata and suggest statistics. + /// Comma-separated list or wildcard expressions of fields to include in field data and suggest statistics. public NodesStatsDescriptor CompletionFields(Fields completionfields) => Qs("completion_fields", completionfields); - /// Comma-separated list or wildcard expressions of fields to include in fielddata and suggest statistics. + /// Comma-separated list or wildcard expressions of fields to include in field data and suggest statistics. public NodesStatsDescriptor CompletionFields(params Expression>[] fields) where T : class => Qs("completion_fields", fields?.Select(e => (Field)e)); - /// Comma-separated list or wildcard expressions of fields to include in fielddata statistics. + /// Comma-separated list or wildcard expressions of fields to include in field data statistics. public NodesStatsDescriptor FielddataFields(Fields fielddatafields) => Qs("fielddata_fields", fielddatafields); - /// Comma-separated list or wildcard expressions of fields to include in fielddata statistics. + /// Comma-separated list or wildcard expressions of fields to include in field data statistics. public NodesStatsDescriptor FielddataFields(params Expression>[] fields) where T : class => Qs("fielddata_fields", fields?.Select(e => (Field)e)); @@ -278,7 +278,7 @@ public NodesStatsDescriptor Fields(params Expression>[] field /// Comma-separated list of search groups to include in the search statistics. public NodesStatsDescriptor Groups(params string[] groups) => Qs("groups", groups); - /// If true, the call reports the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested). + /// If `true`, the call reports the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested). public NodesStatsDescriptor IncludeSegmentFileSizes(bool? includesegmentfilesizes = true) => Qs("include_segment_file_sizes", includesegmentfilesizes); diff --git a/src/OpenSearch.Client/_Generated/Descriptors.Snapshot.cs b/src/OpenSearch.Client/_Generated/Descriptors.Snapshot.cs index f5fd45f6b1..45b35c9ddc 100644 --- a/src/OpenSearch.Client/_Generated/Descriptors.Snapshot.cs +++ b/src/OpenSearch.Client/_Generated/Descriptors.Snapshot.cs @@ -87,9 +87,9 @@ protected CleanupRepositoryDescriptor() public CleanupRepositoryDescriptor ClusterManagerTimeout(Time clustermanagertimeout) => Qs("cluster_manager_timeout", clustermanagertimeout); - /// Period to wait for a connection to the master node. + /// Period to wait for a connection to the cluster-manager node. [Obsolete( - "Deprecated as of: 2.0.0, reason: To promote inclusive language, use 'cluster_manager_timeout' instead." + "Deprecated as of: 2.0.0, reason: To promote inclusive language, use `cluster_manager_timeout` instead." )] public CleanupRepositoryDescriptor MasterTimeout(Time mastertimeout) => Qs("master_timeout", mastertimeout); @@ -136,9 +136,9 @@ protected CloneSnapshotDescriptor() public CloneSnapshotDescriptor ClusterManagerTimeout(Time clustermanagertimeout) => Qs("cluster_manager_timeout", clustermanagertimeout); - /// Explicit operation timeout for connection to master node. + /// Explicit operation timeout for connection to cluster-manager node. [Obsolete( - "Deprecated as of: 2.0.0, reason: To promote inclusive language, use 'cluster_manager_timeout' instead." + "Deprecated as of: 2.0.0, reason: To promote inclusive language, use `cluster_manager_timeout` instead." )] public CloneSnapshotDescriptor MasterTimeout(Time mastertimeout) => Qs("master_timeout", mastertimeout); @@ -172,9 +172,9 @@ protected SnapshotDescriptor() public SnapshotDescriptor ClusterManagerTimeout(Time clustermanagertimeout) => Qs("cluster_manager_timeout", clustermanagertimeout); - /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error. [Obsolete( - "Deprecated as of: 2.0.0, reason: To promote inclusive language, use 'cluster_manager_timeout' instead." + "Deprecated as of: 2.0.0, reason: To promote inclusive language, use `cluster_manager_timeout` instead." )] public SnapshotDescriptor MasterTimeout(Time mastertimeout) => Qs("master_timeout", mastertimeout); @@ -214,9 +214,9 @@ protected CreateRepositoryDescriptor() public CreateRepositoryDescriptor ClusterManagerTimeout(Time clustermanagertimeout) => Qs("cluster_manager_timeout", clustermanagertimeout); - /// Explicit operation timeout for connection to master node. + /// Explicit operation timeout for connection to cluster-manager node. [Obsolete( - "Deprecated as of: 2.0.0, reason: To promote inclusive language, use 'cluster_manager_timeout' instead." + "Deprecated as of: 2.0.0, reason: To promote inclusive language, use `cluster_manager_timeout` instead." )] public CreateRepositoryDescriptor MasterTimeout(Time mastertimeout) => Qs("master_timeout", mastertimeout); @@ -260,9 +260,9 @@ protected DeleteSnapshotDescriptor() public DeleteSnapshotDescriptor ClusterManagerTimeout(Time clustermanagertimeout) => Qs("cluster_manager_timeout", clustermanagertimeout); - /// Explicit operation timeout for connection to master node. + /// Explicit operation timeout for connection to cluster-manager node. [Obsolete( - "Deprecated as of: 2.0.0, reason: To promote inclusive language, use 'cluster_manager_timeout' instead." + "Deprecated as of: 2.0.0, reason: To promote inclusive language, use `cluster_manager_timeout` instead." )] public DeleteSnapshotDescriptor MasterTimeout(Time mastertimeout) => Qs("master_timeout", mastertimeout); @@ -298,9 +298,9 @@ protected DeleteRepositoryDescriptor() public DeleteRepositoryDescriptor ClusterManagerTimeout(Time clustermanagertimeout) => Qs("cluster_manager_timeout", clustermanagertimeout); - /// Explicit operation timeout for connection to master node. + /// Explicit operation timeout for connection to cluster-manager node. [Obsolete( - "Deprecated as of: 2.0.0, reason: To promote inclusive language, use 'cluster_manager_timeout' instead." + "Deprecated as of: 2.0.0, reason: To promote inclusive language, use `cluster_manager_timeout` instead." )] public DeleteRepositoryDescriptor MasterTimeout(Time mastertimeout) => Qs("master_timeout", mastertimeout); @@ -341,18 +341,18 @@ protected GetSnapshotDescriptor() public GetSnapshotDescriptor ClusterManagerTimeout(Time clustermanagertimeout) => Qs("cluster_manager_timeout", clustermanagertimeout); - /// If false, the request returns an error for any snapshots that are unavailable. + /// If `false`, the request returns an error for any snapshots that are unavailable. public GetSnapshotDescriptor IgnoreUnavailable(bool? ignoreunavailable = true) => Qs("ignore_unavailable", ignoreunavailable); - /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + /// Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error. [Obsolete( - "Deprecated as of: 2.0.0, reason: To promote inclusive language, use 'cluster_manager_timeout' instead." + "Deprecated as of: 2.0.0, reason: To promote inclusive language, use `cluster_manager_timeout` instead." )] public GetSnapshotDescriptor MasterTimeout(Time mastertimeout) => Qs("master_timeout", mastertimeout); - /// If true, returns additional information about each snapshot such as the version of OpenSearch which took the snapshot, the start and end times of the snapshot, and the number of shards snapshotted. + /// If `true`, returns additional information about each snapshot such as the version of OpenSearch which took the snapshot, the start and end times of the snapshot, and the number of shards snapshotted. public GetSnapshotDescriptor Verbose(bool? verbose = true) => Qs("verbose", verbose); } @@ -392,9 +392,9 @@ public GetRepositoryDescriptor ClusterManagerTimeout(Time clustermanagertimeout) /// Return local information, do not retrieve the state from cluster-manager node. public GetRepositoryDescriptor Local(bool? local = true) => Qs("local", local); - /// Explicit operation timeout for connection to master node. + /// Explicit operation timeout for connection to cluster-manager node. [Obsolete( - "Deprecated as of: 2.0.0, reason: To promote inclusive language, use 'cluster_manager_timeout' instead." + "Deprecated as of: 2.0.0, reason: To promote inclusive language, use `cluster_manager_timeout` instead." )] public GetRepositoryDescriptor MasterTimeout(Time mastertimeout) => Qs("master_timeout", mastertimeout); @@ -428,9 +428,9 @@ protected RestoreDescriptor() public RestoreDescriptor ClusterManagerTimeout(Time clustermanagertimeout) => Qs("cluster_manager_timeout", clustermanagertimeout); - /// Explicit operation timeout for connection to master node. + /// Explicit operation timeout for connection to cluster-manager node. [Obsolete( - "Deprecated as of: 2.0.0, reason: To promote inclusive language, use 'cluster_manager_timeout' instead." + "Deprecated as of: 2.0.0, reason: To promote inclusive language, use `cluster_manager_timeout` instead." )] public RestoreDescriptor MasterTimeout(Time mastertimeout) => Qs("master_timeout", mastertimeout); @@ -484,13 +484,13 @@ public SnapshotStatusDescriptor Snapshot(Names snapshot) => public SnapshotStatusDescriptor ClusterManagerTimeout(Time clustermanagertimeout) => Qs("cluster_manager_timeout", clustermanagertimeout); - /// Whether to ignore unavailable snapshots, defaults to false which means a SnapshotMissingException is thrown. + /// Whether to ignore unavailable snapshots, defaults to `false` which means a SnapshotMissingException is thrown. public SnapshotStatusDescriptor IgnoreUnavailable(bool? ignoreunavailable = true) => Qs("ignore_unavailable", ignoreunavailable); - /// Explicit operation timeout for connection to master node. + /// Explicit operation timeout for connection to cluster-manager node. [Obsolete( - "Deprecated as of: 2.0.0, reason: To promote inclusive language, use 'cluster_manager_timeout' instead." + "Deprecated as of: 2.0.0, reason: To promote inclusive language, use `cluster_manager_timeout` instead." )] public SnapshotStatusDescriptor MasterTimeout(Time mastertimeout) => Qs("master_timeout", mastertimeout); @@ -526,9 +526,9 @@ protected VerifyRepositoryDescriptor() public VerifyRepositoryDescriptor ClusterManagerTimeout(Time clustermanagertimeout) => Qs("cluster_manager_timeout", clustermanagertimeout); - /// Explicit operation timeout for connection to master node. + /// Explicit operation timeout for connection to cluster-manager node. [Obsolete( - "Deprecated as of: 2.0.0, reason: To promote inclusive language, use 'cluster_manager_timeout' instead." + "Deprecated as of: 2.0.0, reason: To promote inclusive language, use `cluster_manager_timeout` instead." )] public VerifyRepositoryDescriptor MasterTimeout(Time mastertimeout) => Qs("master_timeout", mastertimeout); diff --git a/src/OpenSearch.Client/_Generated/OpenSearchClient.Cat.cs b/src/OpenSearch.Client/_Generated/OpenSearchClient.Cat.cs index b810d6214b..119d08be56 100644 --- a/src/OpenSearch.Client/_Generated/OpenSearchClient.Cat.cs +++ b/src/OpenSearch.Client/_Generated/OpenSearchClient.Cat.cs @@ -393,7 +393,7 @@ Task> IndicesAsync( /// https://opensearch.org/docs/latest/api-reference/cat/cat-cluster_manager/ /// [Obsolete( - "Deprecated as of: 2.0.0, reason: To promote inclusive language, please use '/_cat/cluster_manager' instead." + "Deprecated as of: 2.0.0, reason: To promote inclusive language, use '/_cat/cluster_manager' instead." )] CatResponse Master( Func selector = null @@ -405,7 +405,7 @@ CatResponse Master( /// https://opensearch.org/docs/latest/api-reference/cat/cat-cluster_manager/ /// [Obsolete( - "Deprecated as of: 2.0.0, reason: To promote inclusive language, please use '/_cat/cluster_manager' instead." + "Deprecated as of: 2.0.0, reason: To promote inclusive language, use '/_cat/cluster_manager' instead." )] Task> MasterAsync( Func selector = null, @@ -418,7 +418,7 @@ Task> MasterAsync( /// https://opensearch.org/docs/latest/api-reference/cat/cat-cluster_manager/ /// [Obsolete( - "Deprecated as of: 2.0.0, reason: To promote inclusive language, please use '/_cat/cluster_manager' instead." + "Deprecated as of: 2.0.0, reason: To promote inclusive language, use '/_cat/cluster_manager' instead." )] CatResponse Master(ICatMasterRequest request); @@ -428,7 +428,7 @@ Task> MasterAsync( /// https://opensearch.org/docs/latest/api-reference/cat/cat-cluster_manager/ /// [Obsolete( - "Deprecated as of: 2.0.0, reason: To promote inclusive language, please use '/_cat/cluster_manager' instead." + "Deprecated as of: 2.0.0, reason: To promote inclusive language, use '/_cat/cluster_manager' instead." )] Task> MasterAsync( ICatMasterRequest request, @@ -1349,7 +1349,7 @@ public Task> IndicesAsync( /// https://opensearch.org/docs/latest/api-reference/cat/cat-cluster_manager/ /// [Obsolete( - "Deprecated as of: 2.0.0, reason: To promote inclusive language, please use '/_cat/cluster_manager' instead." + "Deprecated as of: 2.0.0, reason: To promote inclusive language, use '/_cat/cluster_manager' instead." )] public CatResponse Master( Func selector = null @@ -1361,7 +1361,7 @@ public CatResponse Master( /// https://opensearch.org/docs/latest/api-reference/cat/cat-cluster_manager/ /// [Obsolete( - "Deprecated as of: 2.0.0, reason: To promote inclusive language, please use '/_cat/cluster_manager' instead." + "Deprecated as of: 2.0.0, reason: To promote inclusive language, use '/_cat/cluster_manager' instead." )] public Task> MasterAsync( Func selector = null, @@ -1374,7 +1374,7 @@ public Task> MasterAsync( /// https://opensearch.org/docs/latest/api-reference/cat/cat-cluster_manager/ /// [Obsolete( - "Deprecated as of: 2.0.0, reason: To promote inclusive language, please use '/_cat/cluster_manager' instead." + "Deprecated as of: 2.0.0, reason: To promote inclusive language, use '/_cat/cluster_manager' instead." )] public CatResponse Master(ICatMasterRequest request) => DoCat(request); @@ -1385,7 +1385,7 @@ public CatResponse Master(ICatMasterRequest request) => /// https://opensearch.org/docs/latest/api-reference/cat/cat-cluster_manager/ /// [Obsolete( - "Deprecated as of: 2.0.0, reason: To promote inclusive language, please use '/_cat/cluster_manager' instead." + "Deprecated as of: 2.0.0, reason: To promote inclusive language, use '/_cat/cluster_manager' instead." )] public Task> MasterAsync( ICatMasterRequest request, diff --git a/src/OpenSearch.Client/_Generated/Requests.Cat.cs b/src/OpenSearch.Client/_Generated/Requests.Cat.cs index 77fe8b7dcb..31500a099d 100644 --- a/src/OpenSearch.Client/_Generated/Requests.Cat.cs +++ b/src/OpenSearch.Client/_Generated/Requests.Cat.cs @@ -87,14 +87,14 @@ public CatAliasesRequest(Names name) Names ICatAliasesRequest.Name => Self.RouteValues.Get("name"); // Request parameters - /// Whether to expand wildcard expression to concrete indices that are open, closed or both. + /// Whether to expand wildcard expression to concrete indexes that are open, closed or both. public ExpandWildcards? ExpandWildcards { get => Q("expand_wildcards"); set => Q("expand_wildcards", value); } - /// A short version of the Accept header, e.g. json, yaml. + /// A short version of the Accept header (for example, `json`, `yaml`). public string Format { get => Q("format"); @@ -163,7 +163,7 @@ public ByteUnit? Bytes set => Q("bytes", value); } - /// A short version of the Accept header, e.g. json, yaml. + /// A short version of the Accept header (for example, `json`, `yaml`). public string Format { get => Q("format"); @@ -247,7 +247,7 @@ public Time ClusterManagerTimeout set => Q("cluster_manager_timeout", value); } - /// A short version of the Accept header, e.g. json, yaml. + /// A short version of the Accept header (for example, `json`, `yaml`). public string Format { get => Q("format"); @@ -279,9 +279,9 @@ public bool? Local set => Q("local", value); } - /// Operation timeout for connection to master node. + /// Operation timeout for connection to cluster-manager node. [Obsolete( - "Deprecated as of: 2.0.0, reason: To promote inclusive language, use 'cluster_manager_timeout' instead." + "Deprecated as of: 2.0.0, reason: To promote inclusive language, use `cluster_manager_timeout` instead." )] public Time MasterTimeout { @@ -327,7 +327,7 @@ public Time ClusterManagerTimeout set => Q("cluster_manager_timeout", value); } - /// A short version of the Accept header, e.g. json, yaml. + /// A short version of the Accept header (for example, `json`, `yaml`). public string Format { get => Q("format"); @@ -359,9 +359,9 @@ public bool? Local set => Q("local", value); } - /// Operation timeout for connection to master node. + /// Operation timeout for connection to cluster-manager node. [Obsolete( - "Deprecated as of: 2.0.0, reason: To promote inclusive language, use 'cluster_manager_timeout' instead." + "Deprecated as of: 2.0.0, reason: To promote inclusive language, use `cluster_manager_timeout` instead." )] public Time MasterTimeout { @@ -413,7 +413,7 @@ public CatCountRequest(Indices index) Indices ICatCountRequest.Index => Self.RouteValues.Get("index"); // Request parameters - /// A short version of the Accept header, e.g. json, yaml. + /// A short version of the Accept header (for example, `json`, `yaml`). public string Format { get => Q("format"); @@ -489,7 +489,7 @@ public ByteUnit? Bytes set => Q("bytes", value); } - /// A short version of the Accept header, e.g. json, yaml. + /// A short version of the Accept header (for example, `json`, `yaml`). public string Format { get => Q("format"); @@ -543,7 +543,7 @@ public partial class CatHealthRequest // values part of the url path // Request parameters - /// A short version of the Accept header, e.g. json, yaml. + /// A short version of the Accept header (for example, `json`, `yaml`). public string Format { get => Q("format"); @@ -568,7 +568,7 @@ public bool? Help set => Q("help", value); } - /// If true, returns `HH:MM:SS` and Unix epoch timestamps. + /// If `true`, returns `HH:MM:SS` and Unix epoch timestamps. public bool? IncludeTimestamp { get => Q("ts"); @@ -656,7 +656,7 @@ public ExpandWildcards? ExpandWildcards set => Q("expand_wildcards", value); } - /// A short version of the Accept header, e.g. json, yaml. + /// A short version of the Accept header (for example, `json`, `yaml`). public string Format { get => Q("format"); @@ -674,7 +674,7 @@ public string[] Headers set => Q("h", value); } - /// The health status used to limit returned indices. By default, the response includes indices of any health status. + /// The health status used to limit returned indexes. By default, the response includes indexes of any health status. public HealthStatus? Health { get => Q("health"); @@ -688,7 +688,7 @@ public bool? Help set => Q("help", value); } - /// If true, the response includes information from segments that are not loaded into memory. + /// If `true`, the response includes information from segments that are not loaded into memory. public bool? IncludeUnloadedSegments { get => Q("include_unloaded_segments"); @@ -702,9 +702,9 @@ public bool? Local set => Q("local", value); } - /// Operation timeout for connection to master node. + /// Operation timeout for connection to cluster-manager node. [Obsolete( - "Deprecated as of: 2.0.0, reason: To promote inclusive language, use 'cluster_manager_timeout' instead." + "Deprecated as of: 2.0.0, reason: To promote inclusive language, use `cluster_manager_timeout` instead." )] public Time MasterTimeout { @@ -712,7 +712,7 @@ public Time MasterTimeout set => Q("master_timeout", value); } - /// If true, the response only includes information from primary shards. + /// If `true`, the response only includes information from primary shards. public bool? Pri { get => Q("pri"); @@ -756,7 +756,7 @@ public Time ClusterManagerTimeout set => Q("cluster_manager_timeout", value); } - /// A short version of the Accept header, e.g. json, yaml. + /// A short version of the Accept header (for example, `json`, `yaml`). public string Format { get => Q("format"); @@ -788,9 +788,9 @@ public bool? Local set => Q("local", value); } - /// Operation timeout for connection to master node. + /// Operation timeout for connection to cluster-manager node. [Obsolete( - "Deprecated as of: 2.0.0, reason: To promote inclusive language, use 'cluster_manager_timeout' instead." + "Deprecated as of: 2.0.0, reason: To promote inclusive language, use `cluster_manager_timeout` instead." )] public Time MasterTimeout { @@ -836,7 +836,7 @@ public Time ClusterManagerTimeout set => Q("cluster_manager_timeout", value); } - /// A short version of the Accept header, e.g. json, yaml. + /// A short version of the Accept header (for example, `json`, `yaml`). public string Format { get => Q("format"); @@ -868,9 +868,9 @@ public bool? Local set => Q("local", value); } - /// Operation timeout for connection to master node. + /// Operation timeout for connection to cluster-manager node. [Obsolete( - "Deprecated as of: 2.0.0, reason: To promote inclusive language, use 'cluster_manager_timeout' instead." + "Deprecated as of: 2.0.0, reason: To promote inclusive language, use `cluster_manager_timeout` instead." )] public Time MasterTimeout { @@ -922,7 +922,7 @@ public Time ClusterManagerTimeout set => Q("cluster_manager_timeout", value); } - /// A short version of the Accept header, e.g. json, yaml. + /// A short version of the Accept header (for example, `json`, `yaml`). public string Format { get => Q("format"); @@ -964,9 +964,9 @@ public bool? Local set => Q("local", value); } - /// Operation timeout for connection to master node. + /// Operation timeout for connection to cluster-manager node. [Obsolete( - "Deprecated as of: 2.0.0, reason: To promote inclusive language, use 'cluster_manager_timeout' instead." + "Deprecated as of: 2.0.0, reason: To promote inclusive language, use `cluster_manager_timeout` instead." )] public Time MasterTimeout { @@ -1012,7 +1012,7 @@ public Time ClusterManagerTimeout set => Q("cluster_manager_timeout", value); } - /// A short version of the Accept header, e.g. json, yaml. + /// A short version of the Accept header (for example, `json`, `yaml`). public string Format { get => Q("format"); @@ -1044,9 +1044,9 @@ public bool? Local set => Q("local", value); } - /// Operation timeout for connection to master node. + /// Operation timeout for connection to cluster-manager node. [Obsolete( - "Deprecated as of: 2.0.0, reason: To promote inclusive language, use 'cluster_manager_timeout' instead." + "Deprecated as of: 2.0.0, reason: To promote inclusive language, use `cluster_manager_timeout` instead." )] public Time MasterTimeout { @@ -1090,7 +1090,7 @@ public ByteUnit? Bytes set => Q("bytes", value); } - /// A short version of the Accept header, e.g. json, yaml. + /// A short version of the Accept header (for example, `json`, `yaml`). public string Format { get => Q("format"); @@ -1152,7 +1152,7 @@ public Time ClusterManagerTimeout set => Q("cluster_manager_timeout", value); } - /// A short version of the Accept header, e.g. json, yaml. + /// A short version of the Accept header (for example, `json`, `yaml`). public string Format { get => Q("format"); @@ -1184,9 +1184,9 @@ public bool? Local set => Q("local", value); } - /// Operation timeout for connection to master node. + /// Operation timeout for connection to cluster-manager node. [Obsolete( - "Deprecated as of: 2.0.0, reason: To promote inclusive language, use 'cluster_manager_timeout' instead." + "Deprecated as of: 2.0.0, reason: To promote inclusive language, use `cluster_manager_timeout` instead." )] public Time MasterTimeout { @@ -1259,7 +1259,7 @@ public bool? Detailed set => Q("detailed", value); } - /// A short version of the Accept header, e.g. json, yaml. + /// A short version of the Accept header (for example, `json`, `yaml`). public string Format { get => Q("format"); @@ -1322,7 +1322,7 @@ public Time ClusterManagerTimeout set => Q("cluster_manager_timeout", value); } - /// A short version of the Accept header, e.g. json, yaml. + /// A short version of the Accept header (for example, `json`, `yaml`). public string Format { get => Q("format"); @@ -1354,9 +1354,9 @@ public bool? Local set => Q("local", value); } - /// Operation timeout for connection to master node. + /// Operation timeout for connection to cluster-manager node. [Obsolete( - "Deprecated as of: 2.0.0, reason: To promote inclusive language, use 'cluster_manager_timeout' instead." + "Deprecated as of: 2.0.0, reason: To promote inclusive language, use `cluster_manager_timeout` instead." )] public Time MasterTimeout { @@ -1417,7 +1417,7 @@ public bool? ActiveOnly } /// - /// Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have + /// Whether to ignore if a wildcard indexes expression resolves into no concrete indexes. (This includes `_all` string or when no indexes have /// been specified). /// public bool? AllowNoIndices @@ -1447,14 +1447,14 @@ public bool? Detailed set => Q("detailed", value); } - /// Whether to expand wildcard expression to concrete indices that are open, closed or both. + /// Whether to expand wildcard expression to concrete indexes that are open, closed or both. public ExpandWildcards? ExpandWildcards { get => Q("expand_wildcards"); set => Q("expand_wildcards", value); } - /// A short version of the Accept header, e.g. json, yaml. + /// A short version of the Accept header (for example, `json`, `yaml`). public string Format { get => Q("format"); @@ -1479,14 +1479,14 @@ public bool? Help set => Q("help", value); } - /// Whether specified concrete, expanded or aliased indices should be ignored when throttled. + /// Whether specified concrete, expanded or aliased indexes should be ignored when throttled. public bool? IgnoreThrottled { get => Q("ignore_throttled"); set => Q("ignore_throttled", value); } - /// Whether specified concrete indices should be ignored when unavailable (missing or closed). + /// Whether specified concrete indexes should be ignored when unavailable (missing or closed). public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); @@ -1566,7 +1566,7 @@ public Time ClusterManagerTimeout set => Q("cluster_manager_timeout", value); } - /// A short version of the Accept header, e.g. json, yaml. + /// A short version of the Accept header (for example, `json`, `yaml`). public string Format { get => Q("format"); @@ -1591,9 +1591,9 @@ public bool? Help set => Q("help", value); } - /// Operation timeout for connection to master node. + /// Operation timeout for connection to cluster-manager node. [Obsolete( - "Deprecated as of: 2.0.0, reason: To promote inclusive language, use 'cluster_manager_timeout' instead." + "Deprecated as of: 2.0.0, reason: To promote inclusive language, use `cluster_manager_timeout` instead." )] public Time MasterTimeout { @@ -1660,7 +1660,7 @@ public Time ClusterManagerTimeout set => Q("cluster_manager_timeout", value); } - /// A short version of the Accept header, e.g. json, yaml. + /// A short version of the Accept header (for example, `json`, `yaml`). public string Format { get => Q("format"); @@ -1692,9 +1692,9 @@ public bool? Local set => Q("local", value); } - /// Operation timeout for connection to master node. + /// Operation timeout for connection to cluster-manager node. [Obsolete( - "Deprecated as of: 2.0.0, reason: To promote inclusive language, use 'cluster_manager_timeout' instead." + "Deprecated as of: 2.0.0, reason: To promote inclusive language, use `cluster_manager_timeout` instead." )] public Time MasterTimeout { @@ -1754,7 +1754,7 @@ public Time ClusterManagerTimeout set => Q("cluster_manager_timeout", value); } - /// A short version of the Accept header, e.g. json, yaml. + /// A short version of the Accept header (for example, `json`, `yaml`). public string Format { get => Q("format"); @@ -1786,9 +1786,9 @@ public bool? IgnoreUnavailable set => Q("ignore_unavailable", value); } - /// Operation timeout for connection to master node. + /// Operation timeout for connection to cluster-manager node. [Obsolete( - "Deprecated as of: 2.0.0, reason: To promote inclusive language, use 'cluster_manager_timeout' instead." + "Deprecated as of: 2.0.0, reason: To promote inclusive language, use `cluster_manager_timeout` instead." )] public Time MasterTimeout { @@ -1839,7 +1839,7 @@ public bool? Detailed set => Q("detailed", value); } - /// A short version of the Accept header, e.g. json, yaml. + /// A short version of the Accept header (for example, `json`, `yaml`). public string Format { get => Q("format"); @@ -1933,7 +1933,7 @@ public Time ClusterManagerTimeout set => Q("cluster_manager_timeout", value); } - /// A short version of the Accept header, e.g. json, yaml. + /// A short version of the Accept header (for example, `json`, `yaml`). public string Format { get => Q("format"); @@ -1965,9 +1965,9 @@ public bool? Local set => Q("local", value); } - /// Operation timeout for connection to master node. + /// Operation timeout for connection to cluster-manager node. [Obsolete( - "Deprecated as of: 2.0.0, reason: To promote inclusive language, use 'cluster_manager_timeout' instead." + "Deprecated as of: 2.0.0, reason: To promote inclusive language, use `cluster_manager_timeout` instead." )] public Time MasterTimeout { @@ -2028,7 +2028,7 @@ public Time ClusterManagerTimeout set => Q("cluster_manager_timeout", value); } - /// A short version of the Accept header, e.g. json, yaml. + /// A short version of the Accept header (for example, `json`, `yaml`). public string Format { get => Q("format"); @@ -2060,9 +2060,9 @@ public bool? Local set => Q("local", value); } - /// Operation timeout for connection to master node. + /// Operation timeout for connection to cluster-manager node. [Obsolete( - "Deprecated as of: 2.0.0, reason: To promote inclusive language, use 'cluster_manager_timeout' instead." + "Deprecated as of: 2.0.0, reason: To promote inclusive language, use `cluster_manager_timeout` instead." )] public Time MasterTimeout { diff --git a/src/OpenSearch.Client/_Generated/Requests.Cluster.cs b/src/OpenSearch.Client/_Generated/Requests.Cluster.cs index 0ae5e4fa99..8db1b2b378 100644 --- a/src/OpenSearch.Client/_Generated/Requests.Cluster.cs +++ b/src/OpenSearch.Client/_Generated/Requests.Cluster.cs @@ -73,14 +73,14 @@ public partial class ClusterAllocationExplainRequest // values part of the url path // Request parameters - /// If true, returns information about disk usage and shard sizes. + /// If `true`, returns information about disk usage and shard sizes. public bool? IncludeDiskInfo { get => Q("include_disk_info"); set => Q("include_disk_info", value); } - /// If true, returns YES decisions in explanation. + /// If `true`, returns YES decisions in explanation. public bool? IncludeYesDecisions { get => Q("include_yes_decisions"); @@ -128,11 +128,11 @@ public Time ClusterManagerTimeout } /// - /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns - /// an error. + /// Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and + /// returns an error. /// [Obsolete( - "Deprecated as of: 2.0.0, reason: To promote inclusive language, use 'cluster_manager_timeout' instead." + "Deprecated as of: 2.0.0, reason: To promote inclusive language, use `cluster_manager_timeout` instead." )] public Time MasterTimeout { @@ -165,8 +165,8 @@ public partial class DeleteVotingConfigExclusionsRequest // Request parameters /// /// Specifies whether to wait for all excluded nodes to be removed from the cluster before clearing the voting configuration exclusions list. - /// Defaults to true, meaning that all excluded nodes must be removed from the cluster before this API takes any action. If set to false then - /// the voting configuration exclusions list is cleared even if some excluded nodes are still in the cluster. + /// Defaults to true, meaning that all excluded nodes must be removed from the cluster before this API takes any action. If set to `false` + /// then the voting configuration exclusions list is cleared even if some excluded nodes are still in the cluster. /// public bool? WaitForRemoval { @@ -215,8 +215,8 @@ public Time ClusterManagerTimeout } /// - /// If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the - /// master node. + /// If `true`, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the + /// cluster-manager node. /// public bool? Local { @@ -225,11 +225,11 @@ public bool? Local } /// - /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns - /// an error. + /// Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and + /// returns an error. /// [Obsolete( - "Deprecated as of: 2.0.0, reason: To promote inclusive language, use 'cluster_manager_timeout' instead." + "Deprecated as of: 2.0.0, reason: To promote inclusive language, use `cluster_manager_timeout` instead." )] public Time MasterTimeout { @@ -276,7 +276,7 @@ public Time ClusterManagerTimeout set => Q("cluster_manager_timeout", value); } - /// If `true`, the request retrieves information from the local node only. If `false`, information is retrieved from the master node. + /// If `true`, the request retrieves information from the local node only. If `false`, information is retrieved from the cluster-manager node. public bool? Local { get => Q("local"); @@ -284,11 +284,11 @@ public bool? Local } /// - /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns - /// an error. + /// Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and + /// returns an error. /// [Obsolete( - "Deprecated as of: 2.0.0, reason: To promote inclusive language, use 'cluster_manager_timeout' instead." + "Deprecated as of: 2.0.0, reason: To promote inclusive language, use `cluster_manager_timeout` instead." )] public Time MasterTimeout { @@ -335,11 +335,11 @@ public bool? IncludeDefaults } /// - /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns - /// an error. + /// Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and + /// returns an error. /// [Obsolete( - "Deprecated as of: 2.0.0, reason: To promote inclusive language, use 'cluster_manager_timeout' instead." + "Deprecated as of: 2.0.0, reason: To promote inclusive language, use `cluster_manager_timeout` instead." )] public Time MasterTimeout { @@ -399,14 +399,14 @@ public Time ClusterManagerTimeout set => Q("cluster_manager_timeout", value); } - /// Whether to expand wildcard expression to concrete indices that are open, closed or both. + /// Whether to expand wildcard expression to concrete indexes that are open, closed or both. public ExpandWildcards? ExpandWildcards { get => Q("expand_wildcards"); set => Q("expand_wildcards", value); } - /// Can be one of cluster, indices or shards. Controls the details level of the health information returned. + /// Can be one of cluster, indexes or shards. Controls the details level of the health information returned. public ClusterHealthLevel? Level { get => Q("level"); @@ -414,8 +414,8 @@ public ClusterHealthLevel? Level } /// - /// If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the - /// master node. + /// If `true`, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the + /// cluster-manager node. /// public bool? Local { @@ -424,11 +424,11 @@ public bool? Local } /// - /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns - /// an error. + /// Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and + /// returns an error. /// [Obsolete( - "Deprecated as of: 2.0.0, reason: To promote inclusive language, use 'cluster_manager_timeout' instead." + "Deprecated as of: 2.0.0, reason: To promote inclusive language, use `cluster_manager_timeout` instead." )] public Time MasterTimeout { @@ -468,7 +468,7 @@ public string WaitForNodes } /// - /// A boolean value which controls whether to wait (until the timeout provided) for the cluster to have no shard initializations. Defaults to + /// A Boolean value which controls whether to wait (until the timeout provided) for the cluster to have no shard initializations. Defaults to /// false, which means it will not wait for initializing shards. /// public bool? WaitForNoInitializingShards @@ -478,7 +478,7 @@ public bool? WaitForNoInitializingShards } /// - /// A boolean value which controls whether to wait (until the timeout provided) for the cluster to have no shard relocations. Defaults to + /// A Boolean value which controls whether to wait (until the timeout provided) for the cluster to have no shard relocations. Defaults to /// false, which means it will not wait for relocating shards. /// public bool? WaitForNoRelocatingShards @@ -521,7 +521,7 @@ public Time ClusterManagerTimeout set => Q("cluster_manager_timeout", value); } - /// If `true`, the request retrieves information from the local node only. If `false`, information is retrieved from the master node. + /// If `true`, the request retrieves information from the local node only. If `false`, information is retrieved from the cluster-manager node. public bool? Local { get => Q("local"); @@ -529,11 +529,11 @@ public bool? Local } /// - /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns - /// an error. + /// Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and + /// returns an error. /// [Obsolete( - "Deprecated as of: 2.0.0, reason: To promote inclusive language, use 'cluster_manager_timeout' instead." + "Deprecated as of: 2.0.0, reason: To promote inclusive language, use `cluster_manager_timeout` instead." )] public Time MasterTimeout { @@ -559,7 +559,7 @@ public partial class PostVotingConfigExclusionsRequest // Request parameters /// /// A comma-separated list of the persistent ids of the nodes to exclude from the voting configuration. If specified, you may not also specify - /// node_names. + /// `node_names`. /// public string[] NodeIds { @@ -569,7 +569,7 @@ public string[] NodeIds /// /// A comma-separated list of the names of the nodes to exclude from the voting configuration. If specified, you may not also specify - /// node_ids. + /// `node_ids`. /// public string[] NodeNames { @@ -635,11 +635,11 @@ public bool? Create } /// - /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns - /// an error. + /// Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and + /// returns an error. /// [Obsolete( - "Deprecated as of: 2.0.0, reason: To promote inclusive language, use 'cluster_manager_timeout' instead." + "Deprecated as of: 2.0.0, reason: To promote inclusive language, use `cluster_manager_timeout` instead." )] public Time MasterTimeout { @@ -685,9 +685,9 @@ public bool? FlatSettings set => Q("flat_settings", value); } - /// Explicit operation timeout for connection to master node. + /// Explicit operation timeout for connection to cluster-manager node. [Obsolete( - "Deprecated as of: 2.0.0, reason: To promote inclusive language, use 'cluster_manager_timeout' instead." + "Deprecated as of: 2.0.0, reason: To promote inclusive language, use `cluster_manager_timeout` instead." )] public Time MasterTimeout { @@ -740,14 +740,14 @@ public Time ClusterManagerTimeout set => Q("cluster_manager_timeout", value); } - /// If true, then the request simulates the operation only and returns the resulting state. + /// If `true`, then the request simulates the operation only and returns the resulting state. public bool? DryRun { get => Q("dry_run"); set => Q("dry_run", value); } - /// If true, then the response contains an explanation of why the commands can or cannot be executed. + /// If `true`, then the response contains an explanation of why the commands can or cannot be executed. public bool? Explain { get => Q("explain"); @@ -755,11 +755,11 @@ public bool? Explain } /// - /// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns - /// an error. + /// Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and + /// returns an error. /// [Obsolete( - "Deprecated as of: 2.0.0, reason: To promote inclusive language, use 'cluster_manager_timeout' instead." + "Deprecated as of: 2.0.0, reason: To promote inclusive language, use `cluster_manager_timeout` instead." )] public Time MasterTimeout { @@ -774,7 +774,7 @@ public ClusterRerouteMetric? Metric set => Q("metric", value); } - /// If true, then retries allocation of shards that are blocked due to too many subsequent allocation failures. + /// If `true`, then retries allocation of shards that are blocked due to too many subsequent allocation failures. public bool? RetryFailed { get => Q("retry_failed"); @@ -831,7 +831,7 @@ public ClusterStateRequest(Metrics metric, Indices index) // Request parameters /// - /// Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have + /// Whether to ignore if a wildcard indexes expression resolves into no concrete indexes. (This includes `_all` string or when no indexes have /// been specified). /// public bool? AllowNoIndices @@ -848,7 +848,7 @@ public Time ClusterManagerTimeout set => Q("cluster_manager_timeout", value); } - /// Whether to expand wildcard expression to concrete indices that are open, closed or both. + /// Whether to expand wildcard expression to concrete indexes that are open, closed or both. public ExpandWildcards? ExpandWildcards { get => Q("expand_wildcards"); @@ -862,7 +862,7 @@ public bool? FlatSettings set => Q("flat_settings", value); } - /// Whether specified concrete indices should be ignored when unavailable (missing or closed). + /// Whether specified concrete indexes should be ignored when unavailable (missing or closed). public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); @@ -876,9 +876,9 @@ public bool? Local set => Q("local", value); } - /// Specify timeout for connection to master. + /// Specify timeout for connection to cluster manager. [Obsolete( - "Deprecated as of: 2.0.0, reason: To promote inclusive language, use 'cluster_manager_timeout' instead." + "Deprecated as of: 2.0.0, reason: To promote inclusive language, use `cluster_manager_timeout` instead." )] public Time MasterTimeout { @@ -893,7 +893,7 @@ public long? WaitForMetadataVersion set => Q("wait_for_metadata_version", value); } - /// The maximum time to wait for wait_for_metadata_version before timing out. + /// The maximum time to wait for `wait_for_metadata_version` before timing out. public Time WaitForTimeout { get => Q