From 275203b83e876f42001821c390cd24e517a04178 Mon Sep 17 00:00:00 2001 From: Thomas Farr Date: Wed, 17 Jul 2024 00:55:50 +1200 Subject: [PATCH] Re-generate against latest OpenAPI specification (#713) * Re-generate against latest OpenAPI specification Signed-off-by: Thomas Farr * Update tests Signed-off-by: Thomas Farr --------- Signed-off-by: Thomas Farr --- UPGRADING.md | 8 + .../Generator/ApiEndpointFactory.cs | 513 +- src/ApiGenerator/opensearch-openapi.yaml | 30626 ++++++++++------ .../_Generated/Descriptors.Cat.cs | 9 +- .../_Generated/Descriptors.Cluster.cs | 12 +- .../_Generated/Descriptors.Indices.cs | 2 +- .../_Generated/Descriptors.Ingest.cs | 2 +- .../_Generated/Descriptors.Snapshot.cs | 8 +- .../_Generated/OpenSearchClient.Cluster.cs | 16 +- .../_Generated/OpenSearchClient.Indices.cs | 16 +- .../_Generated/OpenSearchClient.Snapshot.cs | 32 +- .../_Generated/Requests.Cat.cs | 14 - .../_Generated/Requests.Cluster.cs | 10 +- .../_Generated/Requests.Indices.cs | 2 +- .../_Generated/Requests.Snapshot.cs | 8 +- src/OpenSearch.Net/_Generated/Api/Enums.cs | 483 +- .../RequestParameters.Cat.cs | 14 - .../RequestParameters.Cluster.cs | 10 +- .../RequestParameters.Indices.cs | 2 +- .../RequestParameters.Snapshot.cs | 8 +- .../OpenSearchLowLevelClient.Cat.cs | 4 +- .../OpenSearchLowLevelClient.Cluster.cs | 12 +- .../OpenSearchLowLevelClient.Indices.cs | 4 +- .../OpenSearchLowLevelClient.Ingest.cs | 4 +- .../OpenSearchLowLevelClient.Snapshot.cs | 8 +- .../ClusterState/ClusterStateUrlTests.cs | 3 +- .../Cluster/NodesInfo/NodesInfoUrlTests.cs | 4 +- .../Cluster/NodesStats/NodesStatsUrlTests.cs | 4 +- 28 files changed, 19531 insertions(+), 12307 deletions(-) diff --git a/UPGRADING.md b/UPGRADING.md index aa61ee7f0a..5f7677b935 100644 --- a/UPGRADING.md +++ b/UPGRADING.md @@ -3,6 +3,7 @@ * [1.x.y to 2.0.0](#1xy-to-200) * [OpenSearch.Net](#opensearchnet) * [General](#general) + * [Cat.Help Action](#cathelp-action) * [Cat.Indices Action](#catindices-action) * [Cat.Master Action](#catmaster-action) * [Cat.Plugins Action](#catplugins-action) @@ -21,6 +22,7 @@ * [Tasks.List Action](#taskslist-action) * [OpenSearch.Client](#opensearchclient) * [General](#general-1) + * [Cat.Help Action](#cathelp-action-1) * [Cat.Indices Action](#catindices-action-1) * [Cat.Master Action](#catmaster-action-1) * [Cat.Plugins Action](#catplugins-action-1) @@ -46,6 +48,9 @@ - The `MasterTimeout` parameters on all actions have been marked `[Obsolete]`, please migrate to using `ClusterManagerTimeout` if your OpenSearch cluster is at least version `2.0.0` as `MasterTimeout` may be removed in future major versions. - The `ExpandWildcards` enum is now attributed with `[Flags]` to allow combining of multiple values e.g. `ExpandWildcards.Open | ExpandWildcards.Closed` to match open and closed indexes but not hidden. +#### Cat.Help Action +- The `Help` and `SortByColumns` parameters have been removed as they are unsupported by OpenSearch. + #### Cat.Indices Action - The `Health` parameter now accepts a new `HealthStatus` enum instead of the `Health` enum. The values are identical and are now unified with other parts of the API that utilize the same enum. @@ -104,6 +109,9 @@ - The `ExpandWildcards` enum is now attributed with `[Flags]` to allow combining of multiple values e.g. `ExpandWildcards.Open | ExpandWildcards.Closed` to match open and closed indexes but not hidden. - The namespaced APIs exposed in `IOpenSearchClient` have each gained a corresponding interface and the types of the properties on `IOpenSearchClient` and `OpenSearchClient` have been changed from the concrete implementations to the matching interfaces. For example, `IOpenSearchClient.Cluster` was `ClusterNamespace` and now is `IClusterNamespace`. +#### Cat.Help Action +- The `Help` and `SortByColumns` parameters have been removed as they are unsupported by OpenSearch. + #### Cat.Indices Action - The `Health` parameter now accepts a new `HealthStatus` enum instead of the `Health` enum. The values are identical and are now unified with other parts of the API that utilize the same enum. diff --git a/src/ApiGenerator/Generator/ApiEndpointFactory.cs b/src/ApiGenerator/Generator/ApiEndpointFactory.cs index 76f7e1eed4..13d3b4887d 100644 --- a/src/ApiGenerator/Generator/ApiEndpointFactory.cs +++ b/src/ApiGenerator/Generator/ApiEndpointFactory.cs @@ -43,239 +43,282 @@ namespace ApiGenerator.Generator { - public static class ApiEndpointFactory - { - public static ApiEndpoint From( - string name, - List<(string HttpPath, OpenApiPathItem Path, string HttpMethod, OpenApiOperation Operation)> variants, - Action trackEnumToGenerate - ) - { - var tokens = name.Split("."); - var methodName = tokens[^1]; - var ns = tokens.Length > 1 ? tokens[0] : null; - var names = new CsharpNames(name, methodName, ns); - var overrides = LoadOverrides(name, names.MethodName); - - HashSet requiredPathParts = null; - var allParts = new Dictionary(); - var canonicalPaths = new Dictionary, UrlPath>(HashSet.CreateSetComparer()); - var deprecatedPaths = new Dictionary, UrlPath>(HashSet.CreateSetComparer()); - - foreach (var (httpPath, path, _, operation) in variants.DistinctBy(v => v.HttpPath)) - { - var parts = new List(); - var partNames = new HashSet(); - - foreach (var param in path.Parameters - .Concat(operation.Parameters) - .Select(p => p.ActualParameter) - .Where(p => p.Kind == OpenApiParameterKind.Path)) - { - var partName = param.Name; - if (!allParts.TryGetValue(partName, out var part)) - { - var type = GetOpenSearchType(param.Schema, trackEnumToGenerate); - part = allParts[partName] = new UrlPart - { - ClrTypeNameOverride = null, - Deprecated = param.IsDeprecated, - Description = param.Description?.SanitizeDescription(), - Name = partName, - Type = type - }; - } - partNames.Add(partName); - parts.Add(part); - } - - parts.SortBy(p => httpPath.IndexOf($"{{{p.Name}}}", StringComparison.Ordinal)); - - var urlPath = new UrlPath(httpPath, parts, GetDeprecation(operation), operation.XVersionAdded()); - (urlPath.Deprecation == null ? canonicalPaths : deprecatedPaths).TryAdd(partNames, urlPath); - - if (requiredPathParts != null) - requiredPathParts.IntersectWith(partNames); - else - requiredPathParts = partNames; - } - - //some deprecated paths describe aliases to the canonical using the same path e.g - // PUT /{index}/_mapping/{type} - // PUT /{index}/{type}/_mappings - // - //The following routine dedups these occasions and prefers either the canonical path - //or the first duplicate deprecated path - - var paths = canonicalPaths.Values - .Concat(deprecatedPaths - .Where(p => !canonicalPaths.ContainsKey(p.Key)) - .Select(p => p.Value)) - .ToList(); - - ApiRequestParametersPatcher.PatchUrlPaths(name, paths, overrides); - - paths.Sort((p1, p2) => p1.Parts - .Zip(p2.Parts) - .Select(t => string.Compare(t.First.Name, t.Second.Name, StringComparison.Ordinal)) - .SkipWhile(c => c == 0) - .FirstOrDefault()); - - foreach (var partName in requiredPathParts ?? Enumerable.Empty()) allParts[partName].Required = true; - - IDictionary queryParams = variants.SelectMany(v => v.Path.Parameters.Concat(v.Operation.Parameters)) - .Select(p => p.ActualParameter) - .Where(p => p.Kind == OpenApiParameterKind.Query) - .DistinctBy(p => p.Name) - .ToDictionary(p => p.Name, p => BuildQueryParam(p, trackEnumToGenerate)); - queryParams = ApiRequestParametersPatcher.PatchQueryParameters(name, queryParams, overrides); - - Body body = null; - if (variants.Select(v => v.Operation.RequestBody).FirstOrDefault() is {} requestBody) - { - body = new Body - { - Description = GetDescription(requestBody)?.SanitizeDescription(), - Required = requestBody.IsRequired - }; - } - - return new ApiEndpoint - { - Name = name, - Namespace = ns, - MethodName = methodName, - CsharpNames = names, - Overrides = overrides, - Stability = Stability.Stable, // TODO: for realsies - OfficialDocumentationLink = new Documentation - { - Description = variants[0].Operation.Description?.SanitizeDescription(), - Url = variants[0].Operation.ExternalDocumentation?.Url - }, - Url = new UrlInformation { AllPaths = paths, Params = queryParams }, - Body = body, - HttpMethods = variants.Select(v => v.HttpMethod.ToString().ToUpper()).Distinct().ToList(), - }; - } - - private static IEndpointOverrides LoadOverrides(string endpointName, string methodName) - { - if (CodeConfiguration.ApiNameMapping.TryGetValue(endpointName, out var mapsApiMethodName)) - methodName = mapsApiMethodName; - - var namespacePrefix = $"{typeof(GlobalOverrides).Namespace}.Endpoints."; - var typeName = $"{namespacePrefix}{methodName}Overrides"; - var type = GeneratorLocations.Assembly.GetType(typeName); - - return type != null && Activator.CreateInstance(type) is IEndpointOverrides overrides ? overrides : null; - } - - private static QueryParameters BuildQueryParam(OpenApiParameter p, Action trackEnumToGenerate) => - new() - { - Type = GetOpenSearchType(p.Schema, trackEnumToGenerate), - Description = p.Description?.SanitizeDescription(), - Deprecated = GetDeprecation(p) ?? GetDeprecation(p.ActualSchema), - VersionAdded = p.XVersionAdded(), - }; - - private static string GetOpenSearchType(JsonSchema schema, Action trackEnumToGenerate, bool isListContext = false) - { - var schemaKey = ((IJsonReference)schema).ReferencePath?.Split('/').Last(); - schema = schema.ActualSchema; - - if (schema.OneOf is { Count: > 0 }) - { - var oneOf = schema.OneOf.ToArray(); - - if (oneOf.Length == 2) - { - var first = GetOpenSearchType(oneOf[0], trackEnumToGenerate); - var second = GetOpenSearchType(oneOf[1], trackEnumToGenerate); - if (first.EndsWith("?")) return first; - if (first == second) return first; - - switch (first, second) - { - case ("string", "list"): return second; - case ("boolean", "string"): return first; - case ("string", "number"): return first; - case ("number", _): return "string"; - } - } - } - - if (schema.XDataType() is { } dataType) - return dataType == "array" ? "list" : dataType; - - var enumOptions = schema.Enumeration.Where(e => e != null).Select(e => e.ToString()).ToList(); - - if (schemaKey != null && schema.Type == JsonObjectType.String && enumOptions.Count > 0) - { - trackEnumToGenerate(schemaKey, isListContext); - return CsharpNames.GetEnumName(schemaKey) + "?"; - } - - if (schema.Type == JsonObjectType.Array && (schema.Item?.HasReference ?? false)) - _ = GetOpenSearchType(schema.Item, trackEnumToGenerate, true); - - return schema.Type switch - { - JsonObjectType.Integer => "number", - JsonObjectType.Array => "list", - var t => t.ToString().ToLowerInvariant() - }; - } - - private static Deprecation GetDeprecation(IJsonExtensionObject schema) => - (schema.XDeprecationMessage(), schema.XVersionDeprecated()) switch - { - (null, null) => null, - var (m, v) => new Deprecation { Description = m?.SanitizeDescription(), Version = v } - }; - - private static string GetDescription(OpenApiRequestBody requestBody) - { - if (!string.IsNullOrWhiteSpace(requestBody.Description)) - return requestBody.Description; - - return requestBody.Content.TryGetValue(MediaTypeNames.Application.Json, out var content) - ? content.Schema?.ActualSchema.Description - : null; - } - - private static string SanitizeDescription(this string description) - { - if (string.IsNullOrWhiteSpace(description)) return null; - - description = Regex.Replace(description, @"\s+", " "); - - if (!description.EndsWith('.')) description += '.'; - - return description; - } - - private static string XDeprecationMessage(this IJsonExtensionObject schema) => - schema.GetExtension("x-deprecation-message") as string; - - private static string XVersionDeprecated(this IJsonExtensionObject schema) => - schema.GetExtension("x-version-deprecated") as string; - - private static Version XVersionAdded(this IJsonExtensionObject schema) => - schema.GetExtension("x-version-added") is string s - ? s.Split('.').Length switch - { - 1 => new Version($"{s}.0.0"), - 2 => new Version($"{s}.0"), - _ => new Version(s), - } - : null; - - private static string XDataType(this IJsonExtensionObject schema) => - schema.GetExtension("x-data-type") as string; - - private static object GetExtension(this IJsonExtensionObject schema, string key) => - schema.ExtensionData?.TryGetValue(key, out var value) ?? false ? value : null; - } + public static class ApiEndpointFactory + { + public static ApiEndpoint From( + string name, + List<(string HttpPath, OpenApiPathItem Path, string HttpMethod, OpenApiOperation Operation)> variants, + Action trackEnumToGenerate + ) + { + var tokens = name.Split("."); + var methodName = tokens[^1]; + var ns = tokens.Length > 1 ? tokens[0] : null; + var names = new CsharpNames(name, methodName, ns); + var overrides = LoadOverrides(name, names.MethodName); + + HashSet requiredPathParts = null; + var allParts = new Dictionary(); + var canonicalPaths = new Dictionary, UrlPath>(HashSet.CreateSetComparer()); + var deprecatedPaths = new Dictionary, UrlPath>(HashSet.CreateSetComparer()); + + var httpPathVariants = variants + .DistinctBy(v => v.HttpPath) + .Select(v => + ( + v.HttpPath, v.Operation, + PathParams: v.Path.Parameters + .Concat(v.Operation.Parameters) + .Select(p => p.ActualParameter) + .Where(p => p.Kind == OpenApiParameterKind.Path) + .ToList() + ) + ) + .OrderBy(v => v.PathParams.Count(p => p.IsOverloaded())) + .SelectMany(v => GetOverloadedPathVariants(v.HttpPath, v.PathParams).Select(p => (p.HttpPath, v.Operation, p.PathParameters))); + + foreach (var (httpPath, operation, pathParams) in httpPathVariants) + { + var parts = new List(); + var partNames = new HashSet(); + + foreach (var (paramName, schema, description, isDeprecated) in pathParams) + { + if (!allParts.TryGetValue(paramName, out var part)) + { + var type = GetOpenSearchType(schema, trackEnumToGenerate); + part = allParts[paramName] = new UrlPart + { + ClrTypeNameOverride = null, + Deprecated = isDeprecated, + Description = description?.SanitizeDescription(), + Name = paramName, + Type = type + }; + } + partNames.Add(paramName); + parts.Add(part); + } + + parts.SortBy(p => httpPath.IndexOf($"{{{p.Name}}}", StringComparison.Ordinal)); + + var urlPath = new UrlPath(httpPath, parts, GetDeprecation(operation), operation.XVersionAdded()); + (urlPath.Deprecation == null ? canonicalPaths : deprecatedPaths).TryAdd(partNames, urlPath); + + if (requiredPathParts != null) + requiredPathParts.IntersectWith(partNames); + else + requiredPathParts = partNames; + } + + //some deprecated paths describe aliases to the canonical using the same path e.g + // PUT /{index}/_mapping/{type} + // PUT /{index}/{type}/_mappings + // + //The following routine dedups these occasions and prefers either the canonical path + //or the first duplicate deprecated path + + var paths = canonicalPaths.Values + .Concat(deprecatedPaths + .Where(p => !canonicalPaths.ContainsKey(p.Key)) + .Select(p => p.Value)) + .ToList(); + + ApiRequestParametersPatcher.PatchUrlPaths(name, paths, overrides); + + paths.SortBy(p => string.Join(",", p.Parts.Select(part => part.Name))); + + foreach (var partName in requiredPathParts ?? Enumerable.Empty()) allParts[partName].Required = true; + + IDictionary queryParams = variants.SelectMany(v => v.Path.Parameters.Concat(v.Operation.Parameters)) + .Select(p => p.ActualParameter) + .Where(p => p.Kind == OpenApiParameterKind.Query && !p.XGlobal()) + .DistinctBy(p => p.Name) + .ToDictionary(p => p.Name, p => BuildQueryParam(p, trackEnumToGenerate)); + queryParams = ApiRequestParametersPatcher.PatchQueryParameters(name, queryParams, overrides); + + Body body = null; + if (variants.Select(v => v.Operation.RequestBody).FirstOrDefault() is { } requestBody) + { + body = new Body { Description = GetDescription(requestBody)?.SanitizeDescription(), Required = requestBody.IsRequired }; + } + + return new ApiEndpoint + { + Name = name, + Namespace = ns, + MethodName = methodName, + CsharpNames = names, + Overrides = overrides, + Stability = Stability.Stable, // TODO: for realsies + OfficialDocumentationLink = + new Documentation + { + Description = variants[0].Operation.Description?.SanitizeDescription(), + Url = variants[0].Operation.ExternalDocumentation?.Url + }, + Url = new UrlInformation { AllPaths = paths, Params = queryParams }, + Body = body, + HttpMethods = variants.Select(v => v.HttpMethod.ToString().ToUpper()).Distinct().ToList(), + }; + } + + private static IEnumerable<(string HttpPath, List PathParameters)> GetOverloadedPathVariants( + string originalHttpPath, List pathParams + ) + { + var paramCount = pathParams.Count; + + return GenerateVariants(originalHttpPath, 0, new List()); + + IEnumerable<(string HttpPath, List PathParameters)> GenerateVariants(string variantHttpPath, int i, + List paramCombo + ) + { + if (i == paramCount) return new[] { (variantHttpPath, paramCombo) }; + + var originalParameter = pathParams[i]; + var overloads = !originalParameter.IsOverloaded() + ? new[] { (variantHttpPath, new PathParameter(originalParameter)) } + : originalParameter.Schema.AnyOf + .Select(overload => + ( + HttpPath: variantHttpPath.Replace($"{{{originalParameter.Name}}}", $"{{{overload.Title}}}"), + PathParameter: new PathParameter(overload.Title, originalParameter, overload) + ) + ); + + return overloads.SelectMany(o => GenerateVariants(o.HttpPath, i + 1, new List(paramCombo) { o.PathParameter })); + } + } + + private record PathParameter(string Name, JsonSchema Schema, string Description, bool IsDeprecated) + { + public PathParameter(OpenApiParameter parameter) : + this(parameter.Name, parameter.Schema, parameter.Description, parameter.IsDeprecated) { } + + public PathParameter(string name, OpenApiParameter parameter, JsonSchema schema) : this(name, schema, parameter.Description, + parameter.IsDeprecated) { } + } + + private static IEndpointOverrides LoadOverrides(string endpointName, string methodName) + { + if (CodeConfiguration.ApiNameMapping.TryGetValue(endpointName, out var mapsApiMethodName)) + methodName = mapsApiMethodName; + + var namespacePrefix = $"{typeof(GlobalOverrides).Namespace}.Endpoints."; + var typeName = $"{namespacePrefix}{methodName}Overrides"; + var type = GeneratorLocations.Assembly.GetType(typeName); + + return type != null && Activator.CreateInstance(type) is IEndpointOverrides overrides ? overrides : null; + } + + private static QueryParameters BuildQueryParam(OpenApiParameter p, Action trackEnumToGenerate) => + new() + { + Type = GetOpenSearchType(p.Schema, trackEnumToGenerate), + Description = p.Description?.SanitizeDescription(), + Deprecated = GetDeprecation(p) ?? GetDeprecation(p.ActualSchema), + VersionAdded = p.XVersionAdded(), + }; + + private static string GetOpenSearchType(JsonSchema schema, Action trackEnumToGenerate, bool isListContext = false) + { + var schemaKey = ((IJsonReference)schema).ReferencePath?.Split('/').Last(); + schema = schema.ActualSchema; + + if (schema.OneOf.Count > 0 || schema.AnyOf.Count > 0) + { + var oneOf = (schema.OneOf.Count > 0 ? schema.OneOf : schema.AnyOf).ToArray(); + + if (oneOf.Length == 2) + { + var first = GetOpenSearchType(oneOf[0], trackEnumToGenerate); + var second = GetOpenSearchType(oneOf[1], trackEnumToGenerate); + if (first.EndsWith("?")) return first; + if (first == second) return first; + + switch (first, second) + { + case ("string", "list"): return second; + case ("boolean", "string"): return first; + case ("string", "number"): return first; + case ("number", _): return "string"; + } + } + } + + var enumOptions = schema.Enumeration.Where(e => e != null).Select(e => e.ToString()).ToList(); + + if (schemaKey != null && schema.Type == JsonObjectType.String && enumOptions.Count > 0) + { + trackEnumToGenerate(schemaKey, isListContext); + return CsharpNames.GetEnumName(schemaKey) + "?"; + } + + if (schema.Type == JsonObjectType.Array && (schema.Item?.HasReference ?? false)) + _ = GetOpenSearchType(schema.Item, trackEnumToGenerate, true); + + return schema.Type switch + { + JsonObjectType.Integer => "number", + JsonObjectType.Array => "list", + JsonObjectType.String when schema.Pattern == "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$" => "time", + var t => t.ToString().ToLowerInvariant() + }; + } + + private static Deprecation GetDeprecation(IJsonExtensionObject schema) => + (schema.XDeprecationMessage(), schema.XVersionDeprecated()) switch + { + (null, null) => null, + var (m, v) => new Deprecation { Description = m?.SanitizeDescription(), Version = v } + }; + + private static string GetDescription(OpenApiRequestBody requestBody) + { + if (!string.IsNullOrWhiteSpace(requestBody.Description)) + return requestBody.Description; + + return requestBody.Content.TryGetValue(MediaTypeNames.Application.Json, out var content) + ? content.Schema?.ActualSchema.Description + : null; + } + + private static string SanitizeDescription(this string description) + { + if (string.IsNullOrWhiteSpace(description)) return null; + + description = Regex.Replace(description, @"\s+", " "); + + if (!description.EndsWith('.')) description += '.'; + + return description; + } + + private static bool IsOverloaded(this OpenApiParameter parameter) => + parameter.Schema.AnyOf.Count > 0 && parameter.Schema.AnyOf.All(s => !s.Title.IsNullOrEmpty()); + + private static bool XGlobal(this OpenApiParameter parameter) => + parameter.GetExtension("x-global") is string s && bool.Parse(s); + + private static string XDeprecationMessage(this IJsonExtensionObject schema) => + schema.GetExtension("x-deprecation-message") as string; + + private static string XVersionDeprecated(this IJsonExtensionObject schema) => + schema.GetExtension("x-version-deprecated") as string; + + private static Version XVersionAdded(this IJsonExtensionObject schema) => + schema.GetExtension("x-version-added") is string s + ? s.Split('.').Length switch + { + 1 => new Version($"{s}.0.0"), + 2 => new Version($"{s}.0"), + _ => new Version(s), + } + : null; + + private static object GetExtension(this IJsonExtensionObject schema, string key) => + schema.ExtensionData?.TryGetValue(key, out var value) ?? false ? value : null; + } } diff --git a/src/ApiGenerator/opensearch-openapi.yaml b/src/ApiGenerator/opensearch-openapi.yaml index d0613dffca..3292a96509 100644 --- a/src/ApiGenerator/opensearch-openapi.yaml +++ b/src/ApiGenerator/opensearch-openapi.yaml @@ -1,8 +1,8 @@ openapi: 3.1.0 info: - title: OpenSearch API - description: OpenSearch API + title: OpenSearch API Specification version: 1.0.0 + x-api-version: 2.15.0 paths: /: get: @@ -12,7 +12,12 @@ paths: description: Returns basic information about the cluster. externalDocs: url: https://opensearch.org/docs/latest - parameters: [] + 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/info@200' @@ -23,7 +28,12 @@ paths: description: Returns whether the cluster is running. externalDocs: url: https://opensearch.org/docs/latest - parameters: [] + 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/ping@200' @@ -36,10 +46,15 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/im-plugin/index-alias/ parameters: - - $ref: '#/components/parameters/indices.get_alias::query.ignore_unavailable' - $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' @@ -49,12 +64,19 @@ paths: x-operation-group: indices.get_alias x-version-added: '1.0' description: Returns an alias. + 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.ignore_unavailable' - $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' @@ -67,10 +89,15 @@ paths: url: https://opensearch.org/docs/latest parameters: - $ref: '#/components/parameters/indices.exists_alias::path.name' - - $ref: '#/components/parameters/indices.exists_alias::query.ignore_unavailable' - $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' @@ -83,9 +110,14 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/alias/ parameters: - - $ref: '#/components/parameters/indices.update_aliases::query.timeout' - - $ref: '#/components/parameters/indices.update_aliases::query.master_timeout' - $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: @@ -101,6 +133,11 @@ paths: 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' requestBody: $ref: '#/components/requestBodies/indices.analyze' responses: @@ -111,8 +148,15 @@ paths: x-operation-group: indices.analyze x-version-added: '1.0' description: Performs the analysis process on a text and return the tokens breakdown of the text. + 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' requestBody: $ref: '#/components/requestBodies/indices.analyze' responses: @@ -127,16 +171,21 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/document-apis/bulk/ parameters: - - $ref: '#/components/parameters/bulk::query.wait_for_active_shards' - - $ref: '#/components/parameters/bulk::query.refresh' - - $ref: '#/components/parameters/bulk::query.routing' - - $ref: '#/components/parameters/bulk::query.timeout' - - $ref: '#/components/parameters/bulk::query.type' - $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: @@ -147,17 +196,24 @@ paths: x-operation-group: bulk x-version-added: '1.0' description: Allows to perform multiple index/update/delete operations in a single request. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/document-apis/bulk/ parameters: - - $ref: '#/components/parameters/bulk::query.wait_for_active_shards' - - $ref: '#/components/parameters/bulk::query.refresh' - - $ref: '#/components/parameters/bulk::query.routing' - - $ref: '#/components/parameters/bulk::query.timeout' - - $ref: '#/components/parameters/bulk::query.type' - $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: @@ -172,14 +228,20 @@ paths: 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.query' + - $ref: '#/components/parameters/indices.clear_cache::query.file' - $ref: '#/components/parameters/indices.clear_cache::query.ignore_unavailable' - - $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.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' @@ -191,12 +253,15 @@ paths: description: Returns help for the Cat APIs. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/index/ - parameters: - - $ref: '#/components/parameters/cat.help::query.help' - - $ref: '#/components/parameters/cat.help::query.s' responses: '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' /_cat/aliases: get: operationId: cat.aliases.0 @@ -206,13 +271,18 @@ paths: 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.local' - $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/cat.aliases::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/cat.aliases@200' @@ -222,15 +292,22 @@ paths: x-operation-group: cat.aliases x-version-added: '1.0' description: Shows information about currently configured aliases to indices including filter and routing infos. + 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.local' - $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/cat.aliases::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/cat.aliases@200' @@ -243,15 +320,20 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-allocation/ parameters: - - $ref: '#/components/parameters/cat.allocation::query.format' - $ref: '#/components/parameters/cat.allocation::query.bytes' - - $ref: '#/components/parameters/cat.allocation::query.local' - - $ref: '#/components/parameters/cat.allocation::query.master_timeout' - $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' @@ -261,17 +343,24 @@ paths: x-operation-group: cat.allocation x-version-added: '1.0' description: Provides a snapshot of how many shards are allocated to each data node and how much disk space they are using. + 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.format' - $ref: '#/components/parameters/cat.allocation::query.bytes' - - $ref: '#/components/parameters/cat.allocation::query.local' - - $ref: '#/components/parameters/cat.allocation::query.master_timeout' - $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' @@ -284,14 +373,19 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-cluster_manager/ parameters: - - $ref: '#/components/parameters/cat.cluster_manager::query.format' - - $ref: '#/components/parameters/cat.cluster_manager::query.local' - - $ref: '#/components/parameters/cat.cluster_manager::query.master_timeout' - $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' @@ -309,6 +403,11 @@ paths: - $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' @@ -318,6 +417,8 @@ paths: 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. + 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' @@ -325,6 +426,11 @@ paths: - $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' @@ -337,13 +443,18 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-field-data/ parameters: - - $ref: '#/components/parameters/cat.fielddata::query.format' - $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/cat.fielddata::query.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' responses: '200': $ref: '#/components/responses/cat.fielddata@200' @@ -353,15 +464,22 @@ paths: 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. + 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.format' - $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/cat.fielddata::query.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' responses: '200': $ref: '#/components/responses/cat.fielddata@200' @@ -381,6 +499,11 @@ paths: - $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' @@ -393,20 +516,25 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-indices/ parameters: - - $ref: '#/components/parameters/cat.indices::query.format' - $ref: '#/components/parameters/cat.indices::query.bytes' - - $ref: '#/components/parameters/cat.indices::query.local' - - $ref: '#/components/parameters/cat.indices::query.master_timeout' - $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/cat.indices::query.include_unloaded_segments' - - $ref: '#/components/parameters/cat.indices::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/cat.indices@200' @@ -416,22 +544,29 @@ paths: x-operation-group: cat.indices x-version-added: '1.0' description: 'Returns information about indices: 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.format' - $ref: '#/components/parameters/cat.indices::query.bytes' - - $ref: '#/components/parameters/cat.indices::query.local' - - $ref: '#/components/parameters/cat.indices::query.master_timeout' - $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/cat.indices::query.include_unloaded_segments' - - $ref: '#/components/parameters/cat.indices::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/cat.indices@200' @@ -447,14 +582,19 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-cluster_manager/ parameters: - - $ref: '#/components/parameters/cat.master::query.format' - - $ref: '#/components/parameters/cat.master::query.local' - - $ref: '#/components/parameters/cat.master::query.master_timeout' - $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' @@ -467,14 +607,19 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-nodeattrs/ parameters: - - $ref: '#/components/parameters/cat.nodeattrs::query.format' - - $ref: '#/components/parameters/cat.nodeattrs::query.local' - - $ref: '#/components/parameters/cat.nodeattrs::query.master_timeout' - $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' @@ -488,16 +633,21 @@ paths: 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.local' - - $ref: '#/components/parameters/cat.nodes::query.master_timeout' - - $ref: '#/components/parameters/cat.nodes::query.cluster_manager_timeout' - $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' @@ -510,15 +660,20 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-pending-tasks/ parameters: - - $ref: '#/components/parameters/cat.pending_tasks::query.format' - - $ref: '#/components/parameters/cat.pending_tasks::query.local' - - $ref: '#/components/parameters/cat.pending_tasks::query.master_timeout' - $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' @@ -531,12 +686,17 @@ 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/cat.pit_segments::query.bytes' + - $ref: '#/components/parameters/_global::query.pretty' + - $ref: '#/components/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: @@ -551,12 +711,17 @@ 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/cat.all_pit_segments::query.bytes' + - $ref: '#/components/parameters/_global::query.pretty' + - $ref: '#/components/parameters/_global::query.human' + - $ref: '#/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' @@ -569,14 +734,19 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-plugins/ parameters: - - $ref: '#/components/parameters/cat.plugins::query.format' - - $ref: '#/components/parameters/cat.plugins::query.local' - - $ref: '#/components/parameters/cat.plugins::query.master_timeout' - $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' @@ -589,16 +759,21 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-plugins/ parameters: - - $ref: '#/components/parameters/cat.recovery::query.format' - $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' @@ -608,18 +783,25 @@ paths: x-operation-group: cat.recovery x-version-added: '1.0' description: Returns information about index shard recoveries, both on-going completed. + 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.format' - $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' @@ -632,14 +814,19 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-repositories/ parameters: - - $ref: '#/components/parameters/cat.repositories::query.format' - - $ref: '#/components/parameters/cat.repositories::query.local' - - $ref: '#/components/parameters/cat.repositories::query.master_timeout' - $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' @@ -647,28 +834,33 @@ paths: get: operationId: cat.segment_replication.0 x-operation-group: cat.segment_replication - x-version-added: 2.6.0 + x-version-added: '2.6' description: Returns information about both on-going and latest completed Segment Replication events. 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.s' - - $ref: '#/components/parameters/cat.segment_replication::query.v' - - $ref: '#/components/parameters/cat.segment_replication::query.allow_no_indices' - - $ref: '#/components/parameters/cat.segment_replication::query.expand_wildcards' - $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.active_only' - - $ref: '#/components/parameters/cat.segment_replication::query.completed_only' - - $ref: '#/components/parameters/cat.segment_replication::query.bytes' - - $ref: '#/components/parameters/cat.segment_replication::query.detailed' - - $ref: '#/components/parameters/cat.segment_replication::query.shards' - $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' @@ -676,27 +868,34 @@ paths: get: operationId: cat.segment_replication.1 x-operation-group: cat.segment_replication - x-version-added: 2.6.0 + x-version-added: '2.6' description: Returns information about both on-going and latest completed Segment Replication events. + 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.s' - - $ref: '#/components/parameters/cat.segment_replication::query.v' - - $ref: '#/components/parameters/cat.segment_replication::query.allow_no_indices' - - $ref: '#/components/parameters/cat.segment_replication::query.expand_wildcards' - $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.active_only' - - $ref: '#/components/parameters/cat.segment_replication::query.completed_only' - - $ref: '#/components/parameters/cat.segment_replication::query.bytes' - - $ref: '#/components/parameters/cat.segment_replication::query.detailed' - - $ref: '#/components/parameters/cat.segment_replication::query.shards' - $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' @@ -709,14 +908,19 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-segments/ parameters: - - $ref: '#/components/parameters/cat.segments::query.format' - $ref: '#/components/parameters/cat.segments::query.bytes' - - $ref: '#/components/parameters/cat.segments::query.master_timeout' - $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' @@ -726,16 +930,23 @@ paths: x-operation-group: cat.segments x-version-added: '1.0' description: Provides low-level information about the segments in the shards of an index. + 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.format' - $ref: '#/components/parameters/cat.segments::query.bytes' - - $ref: '#/components/parameters/cat.segments::query.master_timeout' - $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' @@ -748,16 +959,21 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-shards/ parameters: - - $ref: '#/components/parameters/cat.shards::query.format' - $ref: '#/components/parameters/cat.shards::query.bytes' - - $ref: '#/components/parameters/cat.shards::query.local' - - $ref: '#/components/parameters/cat.shards::query.master_timeout' - $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' @@ -767,18 +983,25 @@ paths: x-operation-group: cat.shards x-version-added: '1.0' description: Provides a detailed view of shard allocation on nodes. + 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.format' - $ref: '#/components/parameters/cat.shards::query.bytes' - - $ref: '#/components/parameters/cat.shards::query.local' - - $ref: '#/components/parameters/cat.shards::query.master_timeout' - $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' @@ -791,15 +1014,20 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-snapshots/ parameters: - - $ref: '#/components/parameters/cat.snapshots::query.format' - - $ref: '#/components/parameters/cat.snapshots::query.ignore_unavailable' - - $ref: '#/components/parameters/cat.snapshots::query.master_timeout' - $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' @@ -809,17 +1037,24 @@ paths: x-operation-group: cat.snapshots x-version-added: '1.0' description: Returns all snapshots in a specific repository. + 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.format' - - $ref: '#/components/parameters/cat.snapshots::query.ignore_unavailable' - - $ref: '#/components/parameters/cat.snapshots::query.master_timeout' - $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' @@ -832,16 +1067,21 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-tasks/ parameters: - - $ref: '#/components/parameters/cat.tasks::query.format' - - $ref: '#/components/parameters/cat.tasks::query.nodes' - $ref: '#/components/parameters/cat.tasks::query.actions' - $ref: '#/components/parameters/cat.tasks::query.detailed' - - $ref: '#/components/parameters/cat.tasks::query.parent_task_id' + - $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' @@ -854,14 +1094,19 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-templates/ parameters: - - $ref: '#/components/parameters/cat.templates::query.format' - - $ref: '#/components/parameters/cat.templates::query.local' - - $ref: '#/components/parameters/cat.templates::query.master_timeout' - $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' @@ -871,16 +1116,23 @@ paths: x-operation-group: cat.templates x-version-added: '1.0' description: Returns information about existing templates. + 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.format' - - $ref: '#/components/parameters/cat.templates::query.local' - - $ref: '#/components/parameters/cat.templates::query.master_timeout' - $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' @@ -895,15 +1147,20 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-thread-pool/ parameters: - - $ref: '#/components/parameters/cat.thread_pool::query.format' - - $ref: '#/components/parameters/cat.thread_pool::query.size' - - $ref: '#/components/parameters/cat.thread_pool::query.local' - - $ref: '#/components/parameters/cat.thread_pool::query.master_timeout' - $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' @@ -915,17 +1172,24 @@ paths: description: |- Returns cluster-wide thread pool statistics per node. By default the active, queue and rejected statistics are returned for all thread pools. + 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.format' - - $ref: '#/components/parameters/cat.thread_pool::query.size' - - $ref: '#/components/parameters/cat.thread_pool::query.local' - - $ref: '#/components/parameters/cat.thread_pool::query.master_timeout' - $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' @@ -938,8 +1202,13 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-allocation/ parameters: - - $ref: '#/components/parameters/cluster.allocation_explain::query.include_yes_decisions' - $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: @@ -950,9 +1219,16 @@ paths: x-operation-group: cluster.allocation_explain x-version-added: '1.0' description: Provides explanations for shard allocations in the cluster. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-allocation/ parameters: - - $ref: '#/components/parameters/cluster.allocation_explain::query.include_yes_decisions' - $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: @@ -969,6 +1245,12 @@ paths: responses: '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' /_cluster/decommission/awareness/{awareness_attribute_name}/_status: get: operationId: cluster.get_decommission_awareness.0 @@ -979,6 +1261,11 @@ paths: 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' responses: '200': $ref: '#/components/responses/cluster.get_decommission_awareness@200' @@ -993,6 +1280,11 @@ paths: 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' responses: '200': $ref: '#/components/responses/cluster.put_decommission_awareness@200' @@ -1005,19 +1297,24 @@ 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.cluster_manager_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_nodes' - $ref: '#/components/parameters/cluster.health::query.wait_for_events' - - $ref: '#/components/parameters/cluster.health::query.wait_for_no_relocating_shards' - $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/cluster.health::query.awareness_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.health@200' @@ -1027,27 +1324,34 @@ paths: x-operation-group: cluster.health x-version-added: '1.0' description: Returns basic information about the health of the cluster. + 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.cluster_manager_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_nodes' - $ref: '#/components/parameters/cluster.health::query.wait_for_events' - - $ref: '#/components/parameters/cluster.health::query.wait_for_no_relocating_shards' - $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/cluster.health::query.awareness_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.health@200' - /_cluster/nodes/hot_threads: + /_cluster/nodes/{node_id}/hot_threads: get: - operationId: nodes.hot_threads.0 + operationId: nodes.hot_threads.2 x-operation-group: nodes.hot_threads x-ignorable: true deprecated: true @@ -1058,18 +1362,24 @@ 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.ignore_idle_threads' - - $ref: '#/components/parameters/nodes.hot_threads::query.type' - $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/hotthreads: + /_cluster/nodes/{node_id}/hotthreads: get: - operationId: nodes.hot_threads.1 + operationId: nodes.hot_threads.3 x-operation-group: nodes.hot_threads x-ignorable: true deprecated: true @@ -1077,19 +1387,27 @@ paths: x-version-added: '1.0' x-version-deprecated: '1.0' description: Returns information about hot threads on each node in the cluster. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/nodes-apis/nodes-hot-threads/ parameters: + - $ref: '#/components/parameters/nodes.hot_threads::path.node_id' + - $ref: '#/components/parameters/nodes.hot_threads::query.ignore_idle_threads' - $ref: '#/components/parameters/nodes.hot_threads::query.interval' - $ref: '#/components/parameters/nodes.hot_threads::query.snapshots' - $ref: '#/components/parameters/nodes.hot_threads::query.threads' - - $ref: '#/components/parameters/nodes.hot_threads::query.ignore_idle_threads' - - $ref: '#/components/parameters/nodes.hot_threads::query.type' - $ref: '#/components/parameters/nodes.hot_threads::query.timeout' + - $ref: '#/components/parameters/nodes.hot_threads::query.type' + - $ref: '#/components/parameters/_global::query.pretty' + - $ref: '#/components/parameters/_global::query.human' + - $ref: '#/components/parameters/_global::query.error_trace' + - $ref: '#/components/parameters/_global::query.source' + - $ref: '#/components/parameters/_global::query.filter_path' responses: '200': $ref: '#/components/responses/nodes.hot_threads@200' - /_cluster/nodes/{node_id}/hot_threads: + /_cluster/nodes/hot_threads: get: - operationId: nodes.hot_threads.2 + operationId: nodes.hot_threads.0 x-operation-group: nodes.hot_threads x-ignorable: true deprecated: true @@ -1097,20 +1415,26 @@ paths: x-version-added: '1.0' x-version-deprecated: '1.0' description: Returns information about hot threads on each node in the cluster. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/nodes-apis/nodes-hot-threads/ parameters: - - $ref: '#/components/parameters/nodes.hot_threads::path.node_id' + - $ref: '#/components/parameters/nodes.hot_threads::query.ignore_idle_threads' - $ref: '#/components/parameters/nodes.hot_threads::query.interval' - $ref: '#/components/parameters/nodes.hot_threads::query.snapshots' - $ref: '#/components/parameters/nodes.hot_threads::query.threads' - - $ref: '#/components/parameters/nodes.hot_threads::query.ignore_idle_threads' - - $ref: '#/components/parameters/nodes.hot_threads::query.type' - $ref: '#/components/parameters/nodes.hot_threads::query.timeout' + - $ref: '#/components/parameters/nodes.hot_threads::query.type' + - $ref: '#/components/parameters/_global::query.pretty' + - $ref: '#/components/parameters/_global::query.human' + - $ref: '#/components/parameters/_global::query.error_trace' + - $ref: '#/components/parameters/_global::query.source' + - $ref: '#/components/parameters/_global::query.filter_path' responses: '200': $ref: '#/components/responses/nodes.hot_threads@200' - /_cluster/nodes/{node_id}/hotthreads: + /_cluster/nodes/hotthreads: get: - operationId: nodes.hot_threads.3 + operationId: nodes.hot_threads.1 x-operation-group: nodes.hot_threads x-ignorable: true deprecated: true @@ -1118,14 +1442,20 @@ paths: x-version-added: '1.0' x-version-deprecated: '1.0' description: Returns information about hot threads on each node in the cluster. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/nodes-apis/nodes-hot-threads/ parameters: - - $ref: '#/components/parameters/nodes.hot_threads::path.node_id' + - $ref: '#/components/parameters/nodes.hot_threads::query.ignore_idle_threads' - $ref: '#/components/parameters/nodes.hot_threads::query.interval' - $ref: '#/components/parameters/nodes.hot_threads::query.snapshots' - $ref: '#/components/parameters/nodes.hot_threads::query.threads' - - $ref: '#/components/parameters/nodes.hot_threads::query.ignore_idle_threads' - - $ref: '#/components/parameters/nodes.hot_threads::query.type' - $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' @@ -1140,9 +1470,14 @@ 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/cluster.pending_tasks::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/cluster.pending_tasks@200' @@ -1155,29 +1490,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.retry_failed' - - $ref: '#/components/parameters/cluster.reroute::query.metric' - $ref: '#/components/parameters/cluster.reroute::query.master_timeout' - - $ref: '#/components/parameters/cluster.reroute::query.cluster_manager_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' - /_cluster/routing/awareness/weights: - delete: - operationId: cluster.delete_weighted_routing.0 - x-operation-group: cluster.delete_weighted_routing - x-version-added: '1.0' - description: Delete weighted shard routing weights. - externalDocs: - url: https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-awareness/#example-deleting-weights - responses: - '200': - $ref: '#/components/responses/cluster.delete_weighted_routing@200' /_cluster/routing/awareness/{attribute}/weights: get: operationId: cluster.get_weighted_routing.0 @@ -1188,6 +1517,11 @@ paths: 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' responses: '200': $ref: '#/components/responses/cluster.get_weighted_routing@200' @@ -1200,9 +1534,31 @@ paths: 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' responses: '200': $ref: '#/components/responses/cluster.put_weighted_routing@200' + /_cluster/routing/awareness/weights: + delete: + operationId: cluster.delete_weighted_routing.0 + x-operation-group: cluster.delete_weighted_routing + x-version-added: '1.0' + description: Delete weighted shard routing weights. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-awareness/#example-deleting-weights + responses: + '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' /_cluster/settings: get: operationId: cluster.get_settings.0 @@ -1212,11 +1568,16 @@ 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.cluster_manager_timeout' - $ref: '#/components/parameters/cluster.get_settings::query.timeout' - - $ref: '#/components/parameters/cluster.get_settings::query.include_defaults' + - $ref: '#/components/parameters/_global::query.pretty' + - $ref: '#/components/parameters/_global::query.human' + - $ref: '#/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' @@ -1228,10 +1589,15 @@ 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.cluster_manager_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: @@ -1246,15 +1612,20 @@ paths: externalDocs: url: https://opensearch.org/docs/latest parameters: - - $ref: '#/components/parameters/cluster.state::query.local' - - $ref: '#/components/parameters/cluster.state::query.master_timeout' + - $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/cluster.state::query.ignore_unavailable' - - $ref: '#/components/parameters/cluster.state::query.allow_no_indices' - - $ref: '#/components/parameters/cluster.state::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/cluster.state@200' @@ -1264,17 +1635,24 @@ paths: x-operation-group: cluster.state x-version-added: '1.0' description: Returns a comprehensive information about the state of the cluster. + externalDocs: + url: https://opensearch.org/docs/latest parameters: - $ref: '#/components/parameters/cluster.state::path.metric' - - $ref: '#/components/parameters/cluster.state::query.local' - - $ref: '#/components/parameters/cluster.state::query.master_timeout' + - $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/cluster.state::query.ignore_unavailable' - - $ref: '#/components/parameters/cluster.state::query.allow_no_indices' - - $ref: '#/components/parameters/cluster.state::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/cluster.state@200' @@ -1284,18 +1662,25 @@ paths: x-operation-group: cluster.state x-version-added: '1.0' description: Returns a comprehensive information about the state of the cluster. + 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.local' - - $ref: '#/components/parameters/cluster.state::query.master_timeout' + - $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/cluster.state::query.ignore_unavailable' - - $ref: '#/components/parameters/cluster.state::query.allow_no_indices' - - $ref: '#/components/parameters/cluster.state::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/cluster.state@200' @@ -1310,6 +1695,11 @@ paths: 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' responses: '200': $ref: '#/components/responses/cluster.stats@200' @@ -1319,10 +1709,17 @@ paths: x-operation-group: cluster.stats x-version-added: '1.0' 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.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' @@ -1336,6 +1733,11 @@ paths: 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' responses: '200': $ref: '#/components/responses/cluster.delete_voting_config_exclusions@200' @@ -1350,6 +1752,11 @@ paths: - $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' @@ -1362,9 +1769,14 @@ paths: externalDocs: url: https://opensearch.org/docs/latest parameters: - - $ref: '#/components/parameters/cluster.get_component_template::query.master_timeout' - $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' @@ -1378,9 +1790,14 @@ paths: url: https://opensearch.org/docs/latest parameters: - $ref: '#/components/parameters/cluster.delete_component_template::path.name' - - $ref: '#/components/parameters/cluster.delete_component_template::query.timeout' - - $ref: '#/components/parameters/cluster.delete_component_template::query.master_timeout' - $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' @@ -1389,11 +1806,18 @@ paths: x-operation-group: cluster.get_component_template x-version-added: '1.0' description: Returns one or more component templates. + 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.master_timeout' - $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' @@ -1406,9 +1830,14 @@ paths: url: https://opensearch.org/docs/latest parameters: - $ref: '#/components/parameters/cluster.exists_component_template::path.name' - - $ref: '#/components/parameters/cluster.exists_component_template::query.master_timeout' - $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' @@ -1417,12 +1846,19 @@ paths: x-operation-group: cluster.put_component_template x-version-added: '1.0' description: Creates or updates a component template. + 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.timeout' - $ref: '#/components/parameters/cluster.put_component_template::query.master_timeout' - - $ref: '#/components/parameters/cluster.put_component_template::query.cluster_manager_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: @@ -1437,10 +1873,15 @@ paths: 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.timeout' - $ref: '#/components/parameters/cluster.put_component_template::query.master_timeout' - - $ref: '#/components/parameters/cluster.put_component_template::query.cluster_manager_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: @@ -1452,21 +1893,28 @@ paths: x-operation-group: count x-version-added: '1.0' description: Returns number of documents matching a query. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/count/ parameters: - - $ref: '#/components/parameters/count::query.ignore_unavailable' - - $ref: '#/components/parameters/count::query.ignore_throttled' - $ref: '#/components/parameters/count::query.allow_no_indices' - - $ref: '#/components/parameters/count::query.expand_wildcards' - - $ref: '#/components/parameters/count::query.min_score' - - $ref: '#/components/parameters/count::query.preference' - - $ref: '#/components/parameters/count::query.routing' - - $ref: '#/components/parameters/count::query.q' - - $ref: '#/components/parameters/count::query.analyzer' - $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: @@ -1480,20 +1928,25 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/count/ parameters: - - $ref: '#/components/parameters/count::query.ignore_unavailable' - - $ref: '#/components/parameters/count::query.ignore_throttled' - $ref: '#/components/parameters/count::query.allow_no_indices' - - $ref: '#/components/parameters/count::query.expand_wildcards' - - $ref: '#/components/parameters/count::query.min_score' - - $ref: '#/components/parameters/count::query.preference' - - $ref: '#/components/parameters/count::query.routing' - - $ref: '#/components/parameters/count::query.q' - - $ref: '#/components/parameters/count::query.analyzer' - $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: @@ -1507,7 +1960,12 @@ paths: description: Returns all dangling indices. externalDocs: url: https://opensearch.org/docs/latest/api-reference/index-apis/dangling-index/ - parameters: [] + 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/dangling_indices.list_dangling_indices@200' @@ -1522,9 +1980,14 @@ paths: 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.timeout' - - $ref: '#/components/parameters/dangling_indices.delete_dangling_index::query.master_timeout' - $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' @@ -1538,9 +2001,14 @@ paths: 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.timeout' - - $ref: '#/components/parameters/dangling_indices.import_dangling_index::query.master_timeout' - $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' @@ -1552,7 +2020,12 @@ paths: description: Returns data streams. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/data-streams/ - parameters: [] + 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/indices.get_data_stream@200' @@ -1564,7 +2037,12 @@ paths: description: Provides statistics on operations happening in a data stream. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/data-streams/ - parameters: [] + 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/indices.data_streams_stats@200' @@ -1578,6 +2056,11 @@ paths: 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' responses: '200': $ref: '#/components/responses/indices.delete_data_stream@200' @@ -1586,8 +2069,15 @@ paths: x-operation-group: indices.get_data_stream x-version-added: '1.0' description: Returns data streams. + 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' responses: '200': $ref: '#/components/responses/indices.get_data_stream@200' @@ -1600,6 +2090,11 @@ paths: 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' requestBody: $ref: '#/components/requestBodies/indices.create_data_stream' responses: @@ -1611,8 +2106,15 @@ paths: x-operation-group: indices.data_streams_stats x-version-added: '1.0' description: Provides statistics on operations happening in a data stream. + 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' responses: '200': $ref: '#/components/responses/indices.data_streams_stats@200' @@ -1627,6 +2129,11 @@ paths: 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' responses: '200': $ref: '#/components/responses/delete_by_query_rethrottle@200' @@ -1639,11 +2146,16 @@ paths: 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.fields' - - $ref: '#/components/parameters/field_caps::query.ignore_unavailable' - $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: @@ -1654,12 +2166,19 @@ paths: x-operation-group: field_caps x-version-added: '1.0' description: Returns the information about the capabilities of fields among multiple indices. + 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.fields' - - $ref: '#/components/parameters/field_caps::query.ignore_unavailable' - $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: @@ -1671,12 +2190,19 @@ paths: x-operation-group: indices.flush x-version-added: '1.0' description: Performs the flush operation on one or more indices. + externalDocs: + url: https://opensearch.org/docs/latest parameters: - - $ref: '#/components/parameters/indices.flush::query.force' - - $ref: '#/components/parameters/indices.flush::query.wait_if_ongoing' - - $ref: '#/components/parameters/indices.flush::query.ignore_unavailable' - $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' @@ -1688,11 +2214,16 @@ paths: externalDocs: url: https://opensearch.org/docs/latest parameters: - - $ref: '#/components/parameters/indices.flush::query.force' - - $ref: '#/components/parameters/indices.flush::query.wait_if_ongoing' - - $ref: '#/components/parameters/indices.flush::query.ignore_unavailable' - $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' @@ -1705,14 +2236,19 @@ paths: externalDocs: url: https://opensearch.org/docs/latest parameters: - - $ref: '#/components/parameters/indices.forcemerge::query.flush' - - $ref: '#/components/parameters/indices.forcemerge::query.primary_only' - - $ref: '#/components/parameters/indices.forcemerge::query.ignore_unavailable' - $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' @@ -1725,10 +2261,15 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/im-plugin/index-templates/ parameters: - - $ref: '#/components/parameters/indices.get_index_template::query.flat_settings' - - $ref: '#/components/parameters/indices.get_index_template::query.master_timeout' - $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' @@ -1741,27 +2282,15 @@ paths: externalDocs: url: https://opensearch.org/docs/latest parameters: - - $ref: '#/components/parameters/indices.simulate_template::query.create' - $ref: '#/components/parameters/indices.simulate_template::query.cause' - - $ref: '#/components/parameters/indices.simulate_template::query.master_timeout' - $ref: '#/components/parameters/indices.simulate_template::query.cluster_manager_timeout' - requestBody: - $ref: '#/components/requestBodies/indices.simulate_template' - responses: - '200': - $ref: '#/components/responses/indices.simulate_template@200' - /_index_template/_simulate/{name}: - post: - operationId: indices.simulate_template.1 - x-operation-group: indices.simulate_template - x-version-added: '1.0' - description: Simulate resolving the given template name or body. - parameters: - - $ref: '#/components/parameters/indices.simulate_template::path.name' - $ref: '#/components/parameters/indices.simulate_template::query.create' - - $ref: '#/components/parameters/indices.simulate_template::query.cause' - $ref: '#/components/parameters/indices.simulate_template::query.master_timeout' - - $ref: '#/components/parameters/indices.simulate_template::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' requestBody: $ref: '#/components/requestBodies/indices.simulate_template' responses: @@ -1777,15 +2306,44 @@ paths: url: https://opensearch.org/docs/latest parameters: - $ref: '#/components/parameters/indices.simulate_index_template::path.name' - - $ref: '#/components/parameters/indices.simulate_index_template::query.create' - $ref: '#/components/parameters/indices.simulate_index_template::query.cause' - - $ref: '#/components/parameters/indices.simulate_index_template::query.master_timeout' - $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' + /_index_template/_simulate/{name}: + post: + operationId: indices.simulate_template.1 + x-operation-group: indices.simulate_template + x-version-added: '1.0' + description: Simulate resolving the given template name or body. + 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' + requestBody: + $ref: '#/components/requestBodies/indices.simulate_template' + responses: + '200': + $ref: '#/components/responses/indices.simulate_template@200' /_index_template/{name}: delete: operationId: indices.delete_index_template.0 @@ -1796,9 +2354,14 @@ paths: 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.timeout' - - $ref: '#/components/parameters/indices.delete_index_template::query.master_timeout' - $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' @@ -1807,12 +2370,19 @@ paths: x-operation-group: indices.get_index_template x-version-added: '1.0' description: Returns an index template. + 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.flat_settings' - - $ref: '#/components/parameters/indices.get_index_template::query.master_timeout' - $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' @@ -1825,10 +2395,15 @@ paths: 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.flat_settings' - - $ref: '#/components/parameters/indices.exists_index_template::query.master_timeout' - $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' @@ -1837,12 +2412,19 @@ paths: x-operation-group: indices.put_index_template x-version-added: '1.0' description: Creates or updates an index template. + 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.create' - $ref: '#/components/parameters/indices.put_index_template::query.cause' - - $ref: '#/components/parameters/indices.put_index_template::query.master_timeout' - $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: @@ -1857,10 +2439,15 @@ paths: 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.create' - $ref: '#/components/parameters/indices.put_index_template::query.cause' - - $ref: '#/components/parameters/indices.put_index_template::query.master_timeout' - $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: @@ -1875,8 +2462,13 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/ingest-apis/get-ingest/ parameters: - - $ref: '#/components/parameters/ingest.get_pipeline::query.master_timeout' - $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' @@ -1890,6 +2482,11 @@ paths: 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' requestBody: $ref: '#/components/requestBodies/ingest.simulate' responses: @@ -1900,8 +2497,15 @@ paths: x-operation-group: ingest.simulate x-version-added: '1.0' description: Allows to simulate a pipeline with example documents. + 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' requestBody: $ref: '#/components/requestBodies/ingest.simulate' responses: @@ -1917,9 +2521,14 @@ paths: 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.master_timeout' - $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' @@ -1928,10 +2537,17 @@ paths: x-operation-group: ingest.get_pipeline x-version-added: '1.0' description: Returns a pipeline. + 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.master_timeout' - $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' @@ -1944,9 +2560,14 @@ paths: 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.master_timeout' - $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: @@ -1958,9 +2579,16 @@ paths: x-operation-group: ingest.simulate x-version-added: '1.0' description: Allows to simulate a pipeline with example documents. + 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' requestBody: $ref: '#/components/requestBodies/ingest.simulate' responses: @@ -1971,9 +2599,16 @@ paths: x-operation-group: ingest.simulate x-version-added: '1.0' description: Allows to simulate a pipeline with example documents. + 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' requestBody: $ref: '#/components/requestBodies/ingest.simulate' responses: @@ -1987,7 +2622,12 @@ paths: description: Returns a list of the built-in patterns. externalDocs: url: https://opensearch.org/docs/latest - parameters: [] + 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' @@ -2000,12 +2640,18 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/field-types/index/#get-a-mapping parameters: - - $ref: '#/components/parameters/indices.get_mapping::query.ignore_unavailable' - $ref: '#/components/parameters/indices.get_mapping::query.allow_no_indices' - - $ref: '#/components/parameters/indices.get_mapping::query.expand_wildcards' - - $ref: '#/components/parameters/indices.get_mapping::query.master_timeout' - $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' @@ -2019,11 +2665,16 @@ paths: 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.include_defaults' - - $ref: '#/components/parameters/indices.get_field_mapping::query.ignore_unavailable' - $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' @@ -2036,14 +2687,19 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/document-apis/multi-get/ parameters: - - $ref: '#/components/parameters/mget::query.stored_fields' + - $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._source' - - $ref: '#/components/parameters/mget::query._source_excludes' - - $ref: '#/components/parameters/mget::query._source_includes' + - $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: @@ -2054,15 +2710,22 @@ paths: x-operation-group: mget x-version-added: '1.0' description: Allows to get multiple documents in one request. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/document-apis/multi-get/ parameters: - - $ref: '#/components/parameters/mget::query.stored_fields' + - $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._source' - - $ref: '#/components/parameters/mget::query._source_excludes' - - $ref: '#/components/parameters/mget::query._source_includes' + - $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: @@ -2077,13 +2740,18 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/multi-search/ parameters: - - $ref: '#/components/parameters/msearch::query.search_type' + - $ref: '#/components/parameters/msearch::query.ccs_minimize_roundtrips' - $ref: '#/components/parameters/msearch::query.max_concurrent_searches' - - $ref: '#/components/parameters/msearch::query.typed_keys' - - $ref: '#/components/parameters/msearch::query.pre_filter_shard_size' - $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.ccs_minimize_roundtrips' + - $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: @@ -2094,14 +2762,21 @@ paths: x-operation-group: msearch x-version-added: '1.0' description: Allows to execute several search operations in one request. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/multi-search/ parameters: - - $ref: '#/components/parameters/msearch::query.search_type' + - $ref: '#/components/parameters/msearch::query.ccs_minimize_roundtrips' - $ref: '#/components/parameters/msearch::query.max_concurrent_searches' - - $ref: '#/components/parameters/msearch::query.typed_keys' - - $ref: '#/components/parameters/msearch::query.pre_filter_shard_size' - $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.ccs_minimize_roundtrips' + - $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: @@ -2116,11 +2791,16 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/search-plugins/search-template/ parameters: - - $ref: '#/components/parameters/msearch_template::query.search_type' - - $ref: '#/components/parameters/msearch_template::query.typed_keys' + - $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.ccs_minimize_roundtrips' + - $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: @@ -2131,12 +2811,19 @@ paths: x-operation-group: msearch_template x-version-added: '1.0' description: Allows to execute several search template operations in one request. + externalDocs: + url: https://opensearch.org/docs/latest/search-plugins/search-template/ parameters: - - $ref: '#/components/parameters/msearch_template::query.search_type' - - $ref: '#/components/parameters/msearch_template::query.typed_keys' + - $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.ccs_minimize_roundtrips' + - $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: @@ -2151,18 +2838,23 @@ paths: externalDocs: url: https://opensearch.org/docs/latest parameters: - - $ref: '#/components/parameters/mtermvectors::query.ids' - - $ref: '#/components/parameters/mtermvectors::query.term_statistics' - $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.positions' - $ref: '#/components/parameters/mtermvectors::query.payloads' + - $ref: '#/components/parameters/mtermvectors::query.positions' - $ref: '#/components/parameters/mtermvectors::query.preference' - - $ref: '#/components/parameters/mtermvectors::query.routing' - $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: @@ -2173,19 +2865,26 @@ paths: x-operation-group: mtermvectors x-version-added: '1.0' description: Returns multiple termvectors in one request. + externalDocs: + url: https://opensearch.org/docs/latest parameters: - - $ref: '#/components/parameters/mtermvectors::query.ids' - - $ref: '#/components/parameters/mtermvectors::query.term_statistics' - $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.positions' - $ref: '#/components/parameters/mtermvectors::query.payloads' + - $ref: '#/components/parameters/mtermvectors::query.positions' - $ref: '#/components/parameters/mtermvectors::query.preference' - - $ref: '#/components/parameters/mtermvectors::query.routing' - $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: @@ -2202,28 +2901,82 @@ paths: 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' responses: '200': $ref: '#/components/responses/nodes.info@200' - /_nodes/hot_threads: + /_nodes/{node_id_or_metric}: get: - operationId: nodes.hot_threads.4 + operationId: nodes.info.1 + x-operation-group: nodes.info + x-version-added: '1.0' + description: Returns information about nodes in the cluster. + 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' + responses: + '200': + $ref: '#/components/responses/nodes.info@200' + /_nodes/{node_id}/{metric}: + get: + operationId: nodes.info.3 + x-operation-group: nodes.info + x-version-added: '1.0' + description: Returns information about nodes in the cluster. + 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' + responses: + '200': + $ref: '#/components/responses/nodes.info@200' + /_nodes/{node_id}/hot_threads: + get: + operationId: nodes.hot_threads.6 x-operation-group: nodes.hot_threads x-version-added: '1.0' description: Returns information about hot threads on each node in the cluster. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/nodes-apis/nodes-hot-threads/ parameters: + - $ref: '#/components/parameters/nodes.hot_threads::path.node_id' + - $ref: '#/components/parameters/nodes.hot_threads::query.ignore_idle_threads' - $ref: '#/components/parameters/nodes.hot_threads::query.interval' - $ref: '#/components/parameters/nodes.hot_threads::query.snapshots' - $ref: '#/components/parameters/nodes.hot_threads::query.threads' - - $ref: '#/components/parameters/nodes.hot_threads::query.ignore_idle_threads' - - $ref: '#/components/parameters/nodes.hot_threads::query.type' - $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/hotthreads: + /_nodes/{node_id}/hotthreads: get: - operationId: nodes.hot_threads.5 + operationId: nodes.hot_threads.7 x-operation-group: nodes.hot_threads x-ignorable: true deprecated: true @@ -2231,161 +2984,191 @@ paths: x-version-added: '1.0' x-version-deprecated: '1.0' description: Returns information about hot threads on each node in the cluster. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/nodes-apis/nodes-hot-threads/ parameters: + - $ref: '#/components/parameters/nodes.hot_threads::path.node_id' + - $ref: '#/components/parameters/nodes.hot_threads::query.ignore_idle_threads' - $ref: '#/components/parameters/nodes.hot_threads::query.interval' - $ref: '#/components/parameters/nodes.hot_threads::query.snapshots' - $ref: '#/components/parameters/nodes.hot_threads::query.threads' - - $ref: '#/components/parameters/nodes.hot_threads::query.ignore_idle_threads' - - $ref: '#/components/parameters/nodes.hot_threads::query.type' - $ref: '#/components/parameters/nodes.hot_threads::query.timeout' + - $ref: '#/components/parameters/nodes.hot_threads::query.type' + - $ref: '#/components/parameters/_global::query.pretty' + - $ref: '#/components/parameters/_global::query.human' + - $ref: '#/components/parameters/_global::query.error_trace' + - $ref: '#/components/parameters/_global::query.source' + - $ref: '#/components/parameters/_global::query.filter_path' responses: '200': $ref: '#/components/responses/nodes.hot_threads@200' - /_nodes/reload_secure_settings: + /_nodes/{node_id}/reload_secure_settings: post: - operationId: nodes.reload_secure_settings.0 + operationId: nodes.reload_secure_settings.1 x-operation-group: nodes.reload_secure_settings x-version-added: '1.0' description: Reloads secure settings. 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' requestBody: $ref: '#/components/requestBodies/nodes.reload_secure_settings' responses: '200': $ref: '#/components/responses/nodes.reload_secure_settings@200' - /_nodes/stats: + /_nodes/{node_id}/stats: get: - operationId: nodes.stats.0 + operationId: nodes.stats.3 x-operation-group: nodes.stats x-version-added: '1.0' description: Returns statistical information about nodes in the cluster. 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.types' - $ref: '#/components/parameters/nodes.stats::query.timeout' - - $ref: '#/components/parameters/nodes.stats::query.include_segment_file_sizes' + - $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}: + /_nodes/{node_id}/stats/{metric}: get: - operationId: nodes.stats.1 + operationId: nodes.stats.4 x-operation-group: nodes.stats x-version-added: '1.0' description: Returns statistical information about nodes in the cluster. + 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.types' - $ref: '#/components/parameters/nodes.stats::query.timeout' - - $ref: '#/components/parameters/nodes.stats::query.include_segment_file_sizes' + - $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}: + /_nodes/{node_id}/stats/{metric}/{index_metric}: get: - operationId: nodes.stats.2 + operationId: nodes.stats.5 x-operation-group: nodes.stats x-version-added: '1.0' description: Returns statistical information about nodes in the cluster. + 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.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.types' - $ref: '#/components/parameters/nodes.stats::query.timeout' - - $ref: '#/components/parameters/nodes.stats::query.include_segment_file_sizes' + - $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: + /_nodes/{node_id}/usage: get: - operationId: nodes.usage.0 + operationId: nodes.usage.2 x-operation-group: nodes.usage x-version-added: '1.0' description: Returns low-level information about REST actions usage on nodes. 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' responses: '200': $ref: '#/components/responses/nodes.usage@200' - /_nodes/usage/{metric}: + /_nodes/{node_id}/usage/{metric}: get: - operationId: nodes.usage.1 + operationId: nodes.usage.3 x-operation-group: nodes.usage x-version-added: '1.0' description: Returns low-level information about REST actions usage on nodes. + 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' responses: '200': $ref: '#/components/responses/nodes.usage@200' - /_nodes/{metric}: - get: - operationId: nodes.info.1 - x-operation-group: nodes.info - x-version-added: '1.0' - description: Returns information about nodes in the cluster. - parameters: - - $ref: '#/components/parameters/nodes.info::path.metric' - - $ref: '#/components/parameters/nodes.info::query.flat_settings' - - $ref: '#/components/parameters/nodes.info::query.timeout' - responses: - '200': - $ref: '#/components/responses/nodes.info@200' - /_nodes/{node_id}: - get: - operationId: nodes.info.2 - x-operation-group: nodes.info - x-version-added: '1.0' - description: Returns information about nodes in the cluster. - parameters: - - $ref: '#/components/parameters/nodes.info::path.node_id' - - $ref: '#/components/parameters/nodes.info::query.flat_settings' - - $ref: '#/components/parameters/nodes.info::query.timeout' - responses: - '200': - $ref: '#/components/responses/nodes.info@200' - /_nodes/{node_id}/hot_threads: + /_nodes/hot_threads: get: - operationId: nodes.hot_threads.6 + operationId: nodes.hot_threads.4 x-operation-group: nodes.hot_threads x-version-added: '1.0' description: Returns information about hot threads on each node in the cluster. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/nodes-apis/nodes-hot-threads/ parameters: - - $ref: '#/components/parameters/nodes.hot_threads::path.node_id' + - $ref: '#/components/parameters/nodes.hot_threads::query.ignore_idle_threads' - $ref: '#/components/parameters/nodes.hot_threads::query.interval' - $ref: '#/components/parameters/nodes.hot_threads::query.snapshots' - $ref: '#/components/parameters/nodes.hot_threads::query.threads' - - $ref: '#/components/parameters/nodes.hot_threads::query.ignore_idle_threads' - - $ref: '#/components/parameters/nodes.hot_threads::query.type' - $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: + /_nodes/hotthreads: get: - operationId: nodes.hot_threads.7 + operationId: nodes.hot_threads.5 x-operation-group: nodes.hot_threads x-ignorable: true deprecated: true @@ -2393,130 +3176,215 @@ paths: x-version-added: '1.0' x-version-deprecated: '1.0' description: Returns information about hot threads on each node in the cluster. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/nodes-apis/nodes-hot-threads/ parameters: - - $ref: '#/components/parameters/nodes.hot_threads::path.node_id' + - $ref: '#/components/parameters/nodes.hot_threads::query.ignore_idle_threads' - $ref: '#/components/parameters/nodes.hot_threads::query.interval' - $ref: '#/components/parameters/nodes.hot_threads::query.snapshots' - $ref: '#/components/parameters/nodes.hot_threads::query.threads' - - $ref: '#/components/parameters/nodes.hot_threads::query.ignore_idle_threads' - - $ref: '#/components/parameters/nodes.hot_threads::query.type' - $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: + /_nodes/reload_secure_settings: post: - operationId: nodes.reload_secure_settings.1 + operationId: nodes.reload_secure_settings.0 x-operation-group: nodes.reload_secure_settings x-version-added: '1.0' description: Reloads secure settings. + 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' requestBody: $ref: '#/components/requestBodies/nodes.reload_secure_settings' responses: '200': $ref: '#/components/responses/nodes.reload_secure_settings@200' - /_nodes/{node_id}/stats: + /_nodes/stats: get: - operationId: nodes.stats.3 + operationId: nodes.stats.0 x-operation-group: nodes.stats x-version-added: '1.0' description: Returns statistical information about nodes in the cluster. + 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.types' - $ref: '#/components/parameters/nodes.stats::query.timeout' - - $ref: '#/components/parameters/nodes.stats::query.include_segment_file_sizes' + - $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}: + /_nodes/stats/{metric}: get: - operationId: nodes.stats.4 + operationId: nodes.stats.1 x-operation-group: nodes.stats x-version-added: '1.0' description: Returns statistical information about nodes in the cluster. + 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.types' - $ref: '#/components/parameters/nodes.stats::query.timeout' - - $ref: '#/components/parameters/nodes.stats::query.include_segment_file_sizes' + - $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}: + /_nodes/stats/{metric}/{index_metric}: get: - operationId: nodes.stats.5 + operationId: nodes.stats.2 x-operation-group: nodes.stats x-version-added: '1.0' description: Returns statistical information about nodes in the cluster. + 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.index_metric' - - $ref: '#/components/parameters/nodes.stats::path.node_id' + - $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.types' - $ref: '#/components/parameters/nodes.stats::query.timeout' - - $ref: '#/components/parameters/nodes.stats::query.include_segment_file_sizes' + - $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: + /_nodes/usage: get: - operationId: nodes.usage.2 + operationId: nodes.usage.0 x-operation-group: nodes.usage x-version-added: '1.0' description: Returns low-level information about REST actions usage on nodes. + 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' responses: '200': $ref: '#/components/responses/nodes.usage@200' - /_nodes/{node_id}/usage/{metric}: + /_nodes/usage/{metric}: get: - operationId: nodes.usage.3 + operationId: nodes.usage.1 x-operation-group: nodes.usage x-version-added: '1.0' description: Returns low-level information about REST actions usage on nodes. + 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' responses: '200': $ref: '#/components/responses/nodes.usage@200' - /_nodes/{node_id}/{metric}: + /_opendistro/_security/sslinfo: get: - operationId: nodes.info.3 - x-operation-group: nodes.info + operationId: security.get_sslinfo.0 + x-operation-group: security.get_sslinfo x-version-added: '1.0' - description: Returns information about nodes in the cluster. + description: Retrieves the SSL configuration information. parameters: - - $ref: '#/components/parameters/nodes.info::path.node_id' - - $ref: '#/components/parameters/nodes.info::path.metric' - - $ref: '#/components/parameters/nodes.info::query.flat_settings' - - $ref: '#/components/parameters/nodes.info::query.timeout' + - $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/nodes.info@200' + $ref: '#/components/responses/security.get_sslinfo@200' + '500': + $ref: '#/components/responses/security.get_sslinfo@500' + /_plugins/_knn/{node_id}/stats: + get: + operationId: knn.stats.2 + x-operation-group: knn.stats + x-version-added: '1.0' + description: Provides information about the current status of the k-NN plugin. + 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' + responses: + '200': + $ref: '#/components/responses/knn.stats@200' + /_plugins/_knn/{node_id}/stats/{stat}: + get: + operationId: knn.stats.3 + x-operation-group: knn.stats + x-version-added: '1.0' + description: Provides information about the current status of the k-NN plugin. + 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' + responses: + '200': + $ref: '#/components/responses/knn.stats@200' /_plugins/_knn/models/_search: get: operationId: knn.search_models.0 @@ -2526,48 +3394,55 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/search-plugins/knn/api/#search-model parameters: - - $ref: '#/components/parameters/knn.search_models::query.analyzer' + - $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.explain' - - $ref: '#/components/parameters/knn.search_models::query.stored_fields' - $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_unavailable' - $ref: '#/components/parameters/knn.search_models::query.ignore_throttled' - - $ref: '#/components/parameters/knn.search_models::query.allow_no_indices' - - $ref: '#/components/parameters/knn.search_models::query.expand_wildcards' + - $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._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.terminate_after' - $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.allow_partial_search_results' - $ref: '#/components/parameters/knn.search_models::query.typed_keys' - $ref: '#/components/parameters/knn.search_models::query.version' - - $ref: '#/components/parameters/knn.search_models::query.seq_no_primary_term' - - $ref: '#/components/parameters/knn.search_models::query.request_cache' - - $ref: '#/components/parameters/knn.search_models::query.batched_reduce_size' - - $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.rest_total_hits_as_int' + - $ref: '#/components/parameters/_global::query.pretty' + - $ref: '#/components/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' @@ -2576,49 +3451,56 @@ paths: x-operation-group: knn.search_models x-version-added: '1.0' description: Use an OpenSearch query to search for models in the index. + externalDocs: + url: https://opensearch.org/docs/latest/search-plugins/knn/api/#search-model parameters: - - $ref: '#/components/parameters/knn.search_models::query.analyzer' + - $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.explain' - - $ref: '#/components/parameters/knn.search_models::query.stored_fields' - $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_unavailable' - $ref: '#/components/parameters/knn.search_models::query.ignore_throttled' - - $ref: '#/components/parameters/knn.search_models::query.allow_no_indices' - - $ref: '#/components/parameters/knn.search_models::query.expand_wildcards' + - $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._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.terminate_after' - $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.allow_partial_search_results' - $ref: '#/components/parameters/knn.search_models::query.typed_keys' - $ref: '#/components/parameters/knn.search_models::query.version' - - $ref: '#/components/parameters/knn.search_models::query.seq_no_primary_term' - - $ref: '#/components/parameters/knn.search_models::query.request_cache' - - $ref: '#/components/parameters/knn.search_models::query.batched_reduce_size' - - $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.rest_total_hits_as_int' + - $ref: '#/components/parameters/_global::query.pretty' + - $ref: '#/components/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: @@ -2634,6 +3516,11 @@ paths: 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' requestBody: $ref: '#/components/requestBodies/knn.train_model' responses: @@ -2649,6 +3536,11 @@ paths: 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' responses: '200': $ref: '#/components/responses/knn.delete_model@200' @@ -2661,6 +3553,11 @@ paths: 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' responses: '200': $ref: '#/components/responses/knn.get_model@200' @@ -2670,9 +3567,16 @@ paths: x-operation-group: knn.train_model x-version-added: '1.0' description: Create and train a model that can be used for initializing k-NN native library indexes during indexing. + 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' requestBody: $ref: '#/components/requestBodies/knn.train_model' responses: @@ -2688,6 +3592,11 @@ paths: 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' responses: '200': $ref: '#/components/responses/knn.stats@200' @@ -2697,9 +3606,16 @@ paths: x-operation-group: knn.stats x-version-added: '1.0' description: Provides information about the current status of the k-NN plugin. + 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' responses: '200': $ref: '#/components/responses/knn.stats@200' @@ -2708,39 +3624,143 @@ paths: operationId: knn.warmup.0 x-operation-group: knn.warmup x-version-added: '1.0' - description: Preloads native library files into memory, reducing initial search latency for specified indexes + description: Preloads native library files into memory, reducing initial search latency for specified indexes. 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' responses: '200': $ref: '#/components/responses/knn.warmup@200' - /_plugins/_knn/{node_id}/stats: + /_plugins/_ml/model_groups/_register: + post: + operationId: ml.register_model_group.0 + x-operation-group: ml.register_model_group + description: Registers a model group. + requestBody: + $ref: '#/components/requestBodies/ml.register_model_group' + responses: + '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' + /_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' + responses: + '200': + $ref: '#/components/responses/ml.delete_model_group@200' get: - operationId: knn.stats.2 - x-operation-group: knn.stats - x-version-added: '1.0' - description: Provides information about the current status of the k-NN plugin. + operationId: ml.get_model_group.0 + x-operation-group: ml.get_model_group + description: Retrieves a model group. parameters: - - $ref: '#/components/parameters/knn.stats::path.node_id' - - $ref: '#/components/parameters/knn.stats::query.timeout' + - $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/knn.stats@200' - /_plugins/_knn/{node_id}/stats/{stat}: + $ref: '#/components/responses/ml.get_model_group@200' + /_plugins/_ml/models/_register: + post: + operationId: ml.register_model.0 + x-operation-group: ml.register_model + description: Registers a model. + requestBody: + $ref: '#/components/requestBodies/ml.register_model' + responses: + '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' + /_plugins/_ml/models/_search: get: - operationId: knn.stats.3 - x-operation-group: knn.stats - x-version-added: '1.0' - description: Provides information about the current status of the k-NN plugin. + operationId: ml.search_models.0 + x-operation-group: ml.search_models + description: Searches for models. + requestBody: + $ref: '#/components/requestBodies/ml.search_models' + responses: + '200': + $ref: '#/components/responses/ml.search_models@200' 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' + /_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' responses: '200': - $ref: '#/components/responses/knn.stats@200' + $ref: '#/components/responses/ml.delete_model@200' + /_plugins/_ml/tasks/{task_id}: + 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' + responses: + '200': + $ref: '#/components/responses/ml.get_task@200' + /_plugins/_notifications/channels: + get: + operationId: notifications.list_channels.0 + x-operation-group: notifications.list_channels + x-version-added: '2.0' + description: List created notification channels. + externalDocs: + url: https://opensearch.org/docs/latest/observing-your-data/notifications/api/#list-all-notification-channels + responses: + '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' /_plugins/_notifications/configs: delete: operationId: notifications.delete_configs.0 @@ -2752,6 +3772,11 @@ paths: 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' responses: '200': $ref: '#/components/responses/notifications.delete_configs@200' @@ -2763,44 +3788,49 @@ 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.last_updated_time_ms' - - $ref: '#/components/parameters/notifications.get_configs::query.created_time_ms' + - $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_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.smtp_account.method' - - $ref: '#/components/parameters/notifications.get_configs::query.ses_account.region' + - $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.description' - - $ref: '#/components/parameters/notifications.get_configs::query.description.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.chime.url' - - $ref: '#/components/parameters/notifications.get_configs::query.chime.url.keyword' - - $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.webhook.url' - - $ref: '#/components/parameters/notifications.get_configs::query.webhook.url.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.from_address' - $ref: '#/components/parameters/notifications.get_configs::query.smtp_account.from_address.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.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.ses_account.role_arn' - - $ref: '#/components/parameters/notifications.get_configs::query.ses_account.role_arn.keyword' - - $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.is_enabled' - - $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.query' + - $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: @@ -2818,6 +3848,12 @@ paths: responses: '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' /_plugins/_notifications/configs/{config_id}: delete: operationId: notifications.delete_config.0 @@ -2828,6 +3864,11 @@ paths: 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' responses: '200': $ref: '#/components/responses/notifications.delete_config@200' @@ -2838,6 +3879,11 @@ paths: 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' responses: '200': $ref: '#/components/responses/notifications.get_config@200' @@ -2850,6 +3896,11 @@ paths: 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' requestBody: $ref: '#/components/requestBodies/notifications.update_config' responses: @@ -2868,6 +3919,11 @@ paths: 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' responses: '200': $ref: '#/components/responses/notifications.send_test@200' @@ -2880,6 +3936,11 @@ paths: 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' responses: '200': $ref: '#/components/responses/notifications.send_test@200' @@ -2894,10 +3955,162 @@ paths: responses: '200': $ref: '#/components/responses/notifications.list_features@200' - /_plugins/_security/api/account: - get: - operationId: security.get_account_details.0 - x-operation-group: security.get_account_details + 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 + x-operation-group: rollups.delete + x-version-added: '1.0' + description: Delete index rollup. + externalDocs: + 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' + 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' + get: + operationId: rollups.get.0 + x-operation-group: rollups.get + x-version-added: '1.0' + description: Get an index rollup. + 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' + responses: + '200': + $ref: '#/components/responses/rollups.get@200' + put: + operationId: rollups.put.0 + x-operation-group: rollups.put + x-version-added: '1.0' + description: Create or update index rollup. + externalDocs: + 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' + 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' + requestBody: + $ref: '#/components/requestBodies/rollups.put' + /_plugins/_rollup/jobs/{id}/_explain: + get: + operationId: rollups.explain.0 + x-operation-group: rollups.explain + x-version-added: '1.0' + description: Get a rollup's current status. + 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' + responses: + '200': + $ref: '#/components/responses/rollups.explain@200' + /_plugins/_rollup/jobs/{id}/_start: + post: + operationId: rollups.start.0 + x-operation-group: rollups.start + x-version-added: '1.0' + description: Start rollup. + 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' + responses: + '200': + $ref: '#/components/responses/rollups.start@200' + /_plugins/_rollup/jobs/{id}/_stop: + post: + operationId: rollups.stop.0 + x-operation-group: rollups.stop + x-version-added: '1.0' + description: Stop rollup. + 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' + responses: + '200': + $ref: '#/components/responses/rollups.stop@200' + /_plugins/_security/_upgrade_check: + get: + operationId: security.config_upgrade_check.0 + x-operation-group: security.config_upgrade_check + x-version-added: '2.14' + description: Check whether or not an upgrade can be performed and what resources can be updated. + externalDocs: + url: https://opensearch.org/docs/latest/security/access-control/api/#configuration-upgrade-check + responses: + '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' + /_plugins/_security/_upgrade_perform: + post: + operationId: security.config_upgrade_perform.0 + x-operation-group: security.config_upgrade_perform + x-version-added: '2.14' + description: Helps cluster operator upgrade missing defaults and stale default definitions. + externalDocs: + url: https://opensearch.org/docs/latest/security/access-control/api/#configuration-upgrade + requestBody: + $ref: '#/components/requestBodies/security.config_upgrade_perform' + responses: + '200': + $ref: '#/components/responses/security.config_upgrade_perform@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/_security/api/account: + get: + operationId: security.get_account_details.0 + x-operation-group: security.get_account_details x-version-added: '1.0' description: Returns account details for the current user. externalDocs: @@ -2905,6 +4118,12 @@ paths: responses: '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' put: operationId: security.change_password.0 x-operation-group: security.change_password @@ -2917,6 +4136,12 @@ paths: responses: '200': $ref: '#/components/responses/security.change_password@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/_security/api/actiongroups: get: operationId: security.get_action_groups.0 @@ -2928,8 +4153,14 @@ paths: responses: '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' patch: - operationId: security.patch_action_groups.0 + operationId: security.patch_action_groups.1 x-operation-group: security.patch_action_groups x-version-added: '1.0' description: Creates, updates, or deletes multiple action groups in a single call. @@ -2940,6 +4171,12 @@ paths: responses: '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' /_plugins/_security/api/actiongroups/{action_group}: delete: operationId: security.delete_action_group.0 @@ -2950,6 +4187,11 @@ paths: 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' responses: '200': $ref: '#/components/responses/security.delete_action_group@200' @@ -2962,6 +4204,11 @@ paths: 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' responses: '200': $ref: '#/components/responses/security.get_action_group@200' @@ -2974,6 +4221,11 @@ paths: 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' requestBody: $ref: '#/components/requestBodies/security.patch_action_group' responses: @@ -2988,11 +4240,69 @@ paths: 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' requestBody: $ref: '#/components/requestBodies/security.create_action_group' responses: '200': $ref: '#/components/responses/security.create_action_group@200' + /_plugins/_security/api/allowlist: + get: + operationId: security.get_allowlist.0 + x-operation-group: security.get_allowlist + x-version-added: '1.0' + description: Retrieves the current list of allowed API accessible to normal user. + externalDocs: + url: https://opensearch.org/docs/latest/security/access-control/api/#access-control-for-the-api + responses: + '200': + $ref: '#/components/responses/security.get_allowlist@200' + 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' + patch: + operationId: security.patch_allowlist.0 + x-operation-group: security.patch_allowlist + x-version-added: '1.0' + description: Updates the current list of allowed API accessible to normal user. + externalDocs: + url: https://opensearch.org/docs/latest/security/access-control/api/#access-control-for-the-api + requestBody: + $ref: '#/components/requestBodies/security.patch_allowlist' + responses: + '200': + $ref: '#/components/responses/security.patch_allowlist@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: security.create_allowlist.0 + x-operation-group: security.create_allowlist + x-version-added: '1.0' + description: Creates or replaces the allowlisted APIs. Accessible via Super Admin certificate or REST API permission. + externalDocs: + url: https://opensearch.org/docs/latest/security/access-control/api/#access-control-for-the-api + requestBody: + $ref: '#/components/requestBodies/security.create_allowlist' + responses: + '200': + $ref: '#/components/responses/security.create_allowlist@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/_security/api/audit: get: operationId: security.get_audit_configuration.0 @@ -3004,6 +4314,12 @@ paths: responses: '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' patch: operationId: security.patch_audit_configuration.0 x-operation-group: security.patch_audit_configuration @@ -3016,6 +4332,12 @@ paths: responses: '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' /_plugins/_security/api/audit/config: put: operationId: security.update_audit_configuration.0 @@ -3029,6 +4351,27 @@ paths: responses: '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' + /_plugins/_security/api/authtoken: + post: + operationId: security.authtoken.0 + x-operation-group: security.authtoken + x-version-added: '1.0' + description: Returns the authorization token. + responses: + '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' /_plugins/_security/api/cache: delete: operationId: security.flush_cache.0 @@ -3036,10 +4379,82 @@ paths: x-version-added: '1.0' description: Flushes the Security plugin user, authentication, and authorization cache. externalDocs: - url: https://opensearch.org/docs/2.7/security/access-control/api/#flush-cache + url: https://opensearch.org/docs/latest/security/access-control/api/#flush-cache responses: '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' + get: + operationId: security.cache.1 + x-operation-group: security.cache + x-ignorable: true + x-version-added: '1.0' + description: Not supported for cache API. + responses: + '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' + post: + operationId: security.cache.2 + x-operation-group: security.cache + x-version-added: '1.0' + x-ignorable: true + description: Not supported for cache API. + responses: + '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' + put: + operationId: security.cache.3 + x-operation-group: security.cache + x-version-added: '1.0' + x-ignorable: true + description: Not supported for cache API. + responses: + '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' + /_plugins/_security/api/generateonbehalfoftoken: + post: + operationId: security.generate_obo_token.0 + x-operation-group: security.generate_obo_token + x-version-added: '2.12' + description: Generates On-Behalf-Of token for the current user. + externalDocs: + url: https://opensearch.org/docs/latest/security/access-control/authentication-tokens/#api-endpoint + requestBody: + $ref: '#/components/requestBodies/security.generate_obo_token' + responses: + '200': + $ref: '#/components/responses/security.generate_obo_token@200' + '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' /_plugins/_security/api/internalusers: get: operationId: security.get_users.0 @@ -3051,6 +4466,12 @@ paths: responses: '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' patch: operationId: security.patch_users.0 x-operation-group: security.patch_users @@ -3063,6 +4484,12 @@ paths: responses: '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' /_plugins/_security/api/internalusers/{username}: delete: operationId: security.delete_user.0 @@ -3073,6 +4500,11 @@ paths: 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' responses: '200': $ref: '#/components/responses/security.delete_user@200' @@ -3085,6 +4517,11 @@ paths: 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' responses: '200': $ref: '#/components/responses/security.get_user@200' @@ -3097,6 +4534,11 @@ paths: 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' requestBody: $ref: '#/components/requestBodies/security.patch_user' responses: @@ -3111,27 +4553,76 @@ paths: 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' requestBody: $ref: '#/components/requestBodies/security.create_user' responses: '200': $ref: '#/components/responses/security.create_user@200' + /_plugins/_security/api/internalusers/{username}/authtoken: + post: + operationId: security.generate_user_token.0 + x-operation-group: security.generate_user_token + x-version-added: '1.0' + 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' + responses: + '200': + $ref: '#/components/responses/security.generate_user_token@200' + '400': + $ref: '#/components/responses/security.generate_user_token@400' + /_plugins/_security/api/migrate: + post: + operationId: security.migrate.0 + x-operation-group: security.migrate + x-version-added: '1.0' + description: Migrates security configuration from v6 to v7. + responses: + '200': + $ref: '#/components/responses/security.migrate@200' + '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' /_plugins/_security/api/nodesdn: get: operationId: security.get_distinguished_names.0 x-operation-group: security.get_distinguished_names x-version-added: '1.0' - description: Retrieves all distinguished names in the allow list. + description: Retrieves distinguished names. Only accessible to super-admins and with rest-api permissions when enabled. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#get-distinguished-names + 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' responses: '200': $ref: '#/components/responses/security.get_distinguished_names@200' + '403': + $ref: '#/components/responses/security.get_distinguished_names@403' patch: operationId: security.patch_distinguished_names.0 x-operation-group: security.patch_distinguished_names x-version-added: '1.0' - description: Bulk update of distinguished names. + description: Bulk update of distinguished names. Only accessible to super-admins and with rest-api permissions when enabled. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#update-all-distinguished-names requestBody: @@ -3139,57 +4630,112 @@ paths: responses: '200': $ref: '#/components/responses/security.patch_distinguished_names@200' + '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' /_plugins/_security/api/nodesdn/{cluster_name}: delete: - operationId: security.delete_distinguished_names.0 - x-operation-group: security.delete_distinguished_names + operationId: security.delete_distinguished_name.0 + x-operation-group: security.delete_distinguished_name x-version-added: '1.0' - description: Deletes all distinguished names in the specified cluster’s or node’s allow list. + description: Deletes all distinguished names in the specified cluster or node allow list. Only accessible to super-admins and with rest-api permissions when enabled. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#delete-distinguished-names parameters: - - $ref: '#/components/parameters/security.delete_distinguished_names::path.cluster_name' + - $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_names@200' + $ref: '#/components/responses/security.delete_distinguished_name@200' + '403': + $ref: '#/components/responses/security.delete_distinguished_name@403' get: - operationId: security.get_distinguished_names.1 - x-operation-group: security.get_distinguished_names + operationId: security.get_distinguished_name.0 + x-operation-group: security.get_distinguished_name x-version-added: '1.0' - description: Retrieve distinguished names of a specified cluster. + description: Retrieves distinguished names. Only accessible to super-admins and with rest-api permissions when enabled. + externalDocs: + url: https://opensearch.org/docs/latest/security/access-control/api/#get-distinguished-names parameters: - - $ref: '#/components/parameters/security.get_distinguished_names::path.cluster_name' + - $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_names@200' + $ref: '#/components/responses/security.get_distinguished_name@200' + '403': + $ref: '#/components/responses/security.get_distinguished_name@403' + patch: + operationId: security.patch_distinguished_name.0 + x-operation-group: security.patch_distinguished_name + x-version-added: '1.0' + 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' + requestBody: + $ref: '#/components/requestBodies/security.patch_distinguished_name' + responses: + '200': + $ref: '#/components/responses/security.patch_distinguished_name@200' + '403': + $ref: '#/components/responses/security.patch_distinguished_name@403' put: - operationId: security.update_distinguished_names.0 - x-operation-group: security.update_distinguished_names + operationId: security.update_distinguished_name.0 + x-operation-group: security.update_distinguished_name x-version-added: '1.0' - description: Adds or updates the specified distinguished names in the cluster’s or node’s allow list. + description: Adds or updates the specified distinguished names in the cluster or node allow list. Only accessible to super-admins and with rest-api permissions when enabled. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#update-distinguished-names parameters: - - $ref: '#/components/parameters/security.update_distinguished_names::path.cluster_name' + - $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_names' + $ref: '#/components/requestBodies/security.update_distinguished_name' responses: '200': - $ref: '#/components/responses/security.update_distinguished_names@200' - /_plugins/_security/api/roles: - patch: - operationId: security.patch_roles.0 - x-operation-group: security.patch_roles + $ref: '#/components/responses/security.update_distinguished_name@200' + '403': + $ref: '#/components/responses/security.update_distinguished_name@403' + /_plugins/_security/api/permissionsinfo: + get: + operationId: security.get_permissions_info.0 + x-operation-group: security.get_permissions_info x-version-added: '1.0' - description: Creates, updates, or deletes multiple roles in a single call. - externalDocs: - url: https://opensearch.org/docs/latest/security/access-control/api/#patch-roles - requestBody: - $ref: '#/components/requestBodies/security.patch_roles' + description: Gets the evaluated REST API permissions for the currently logged in user. responses: '200': - $ref: '#/components/responses/security.patch_roles@200' - /_plugins/_security/api/roles/: + $ref: '#/components/responses/security.get_permissions_info@200' + '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' + /_plugins/_security/api/roles: get: operationId: security.get_roles.0 x-operation-group: security.get_roles @@ -3200,6 +4746,32 @@ paths: responses: '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' + patch: + operationId: security.patch_roles.0 + x-operation-group: security.patch_roles + x-version-added: '1.0' + description: Creates, updates, or deletes multiple roles in a single call. + externalDocs: + url: https://opensearch.org/docs/latest/security/access-control/api/#patch-roles + requestBody: + $ref: '#/components/requestBodies/security.patch_roles' + responses: + '200': + $ref: '#/components/responses/security.patch_roles@200' + '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' /_plugins/_security/api/roles/{role}: delete: operationId: security.delete_role.0 @@ -3210,6 +4782,11 @@ paths: 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' responses: '200': $ref: '#/components/responses/security.delete_role@200' @@ -3222,6 +4799,11 @@ paths: 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' responses: '200': $ref: '#/components/responses/security.get_role@200' @@ -3234,11 +4816,18 @@ paths: 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' requestBody: $ref: '#/components/requestBodies/security.patch_role' responses: '200': $ref: '#/components/responses/security.patch_role@200' + '400': + $ref: '#/components/responses/security.patch_role@400' put: operationId: security.create_role.0 x-operation-group: security.create_role @@ -3248,6 +4837,11 @@ paths: 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' requestBody: $ref: '#/components/requestBodies/security.create_role' responses: @@ -3264,6 +4858,12 @@ paths: responses: '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' patch: operationId: security.patch_role_mappings.0 x-operation-group: security.patch_role_mappings @@ -3276,6 +4876,14 @@ paths: responses: '200': $ref: '#/components/responses/security.patch_role_mappings@200' + '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' /_plugins/_security/api/rolesmapping/{role}: delete: operationId: security.delete_role_mapping.0 @@ -3286,6 +4894,11 @@ paths: 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' responses: '200': $ref: '#/components/responses/security.delete_role_mapping@200' @@ -3298,6 +4911,11 @@ paths: 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' responses: '200': $ref: '#/components/responses/security.get_role_mapping@200' @@ -3310,11 +4928,18 @@ paths: 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' requestBody: $ref: '#/components/requestBodies/security.patch_role_mapping' responses: '200': $ref: '#/components/responses/security.patch_role_mapping@200' + '400': + $ref: '#/components/responses/security.patch_role_mapping@400' put: operationId: security.create_role_mapping.0 x-operation-group: security.create_role_mapping @@ -3324,6 +4949,11 @@ paths: 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' requestBody: $ref: '#/components/requestBodies/security.create_role_mapping' responses: @@ -3336,46 +4966,72 @@ paths: x-version-added: '1.0' description: Returns the current Security plugin configuration in JSON format. externalDocs: - url: https://opensearch.org/docs/2.7/security/access-control/api/#get-configuration + url: https://opensearch.org/docs/latest/security/access-control/api/#get-configuration responses: '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' patch: operationId: security.patch_configuration.0 x-operation-group: security.patch_configuration x-version-added: '1.0' - description: A PATCH call is used to update the existing configuration using the REST API. + 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/2.7/security/access-control/api/#patch-configuration + 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' + 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/_security/api/securityconfig/config: put: operationId: security.update_configuration.0 x-operation-group: security.update_configuration x-version-added: '1.0' - description: Adds or updates the existing configuration using the REST API. + 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/2.7/security/access-control/api/#update-configuration + 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' + 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/_security/api/ssl/certs: get: operationId: security.get_certificates.0 x-operation-group: security.get_certificates x-version-added: '1.0' - description: Retrieves the cluster’s security certificates. + description: Retrieves the cluster security certificates. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#get-certificates responses: '200': $ref: '#/components/responses/security.get_certificates@200' + '400': + $ref: '#/components/responses/security.get_certificates@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' /_plugins/_security/api/ssl/http/reloadcerts: put: operationId: security.reload_http_certificates.0 @@ -3387,40 +5043,111 @@ paths: responses: '200': $ref: '#/components/responses/security.reload_http_certificates@200' + '400': + $ref: '#/components/responses/security.reload_http_certificates@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' /_plugins/_security/api/ssl/transport/reloadcerts: put: operationId: security.reload_transport_certificates.0 x-operation-group: security.reload_transport_certificates x-version-added: '1.0' - description: Reload transport layer communication certificates. + description: Reload Transport layer communication certificates. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#reload-transport-certificates responses: '200': $ref: '#/components/responses/security.reload_transport_certificates@200' - /_plugins/_security/api/tenants/: + '400': + $ref: '#/components/responses/security.reload_transport_certificates@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' + /_plugins/_security/api/tenancy/config: + get: + operationId: security.get_tenancy_config.0 + x-operation-group: security.get_tenancy_config + x-version-added: '2.7' + description: Retrieves multi-tenancy configuration. Only accessible to admins and users with REST API permissions. + externalDocs: + url: https://opensearch.org/docs/latest/security/multi-tenancy/dynamic-config/#configuring-multi-tenancy-with-the-rest-api + responses: + '200': + $ref: '#/components/responses/security.get_tenancy_config@200' + '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' + put: + operationId: security.create_update_tenancy_config.0 + x-operation-group: security.create_update_tenancy_config + x-version-added: '2.7' + description: Creates or replaces the multi-tenancy configuration. Only accessible to admins and users with REST API permissions. + externalDocs: + url: https://opensearch.org/docs/latest/security/multi-tenancy/dynamic-config/#configuring-multi-tenancy-with-the-rest-api + requestBody: + $ref: '#/components/requestBodies/security.create_update_tenancy_config' + responses: + '200': + $ref: '#/components/responses/security.create_update_tenancy_config@200' + '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' + /_plugins/_security/api/tenants: get: operationId: security.get_tenants.0 x-operation-group: security.get_tenants x-version-added: '1.0' description: Retrieves all tenants. externalDocs: - url: https://opensearch.org/docs/2.7/security/access-control/api/#get-tenants + url: https://opensearch.org/docs/latest/security/access-control/api/#get-tenants responses: '200': $ref: '#/components/responses/security.get_tenants@200' + '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' patch: operationId: security.patch_tenants.0 x-operation-group: security.patch_tenants x-version-added: '1.0' description: Add, delete, or modify multiple tenants in a single call. externalDocs: - url: https://opensearch.org/docs/2.7/security/access-control/api/#patch-tenants + url: https://opensearch.org/docs/latest/security/access-control/api/#patch-tenants requestBody: $ref: '#/components/requestBodies/security.patch_tenants' responses: '200': $ref: '#/components/responses/security.patch_tenants@200' + '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' /_plugins/_security/api/tenants/{tenant}: delete: operationId: security.delete_tenant.0 @@ -3431,18 +5158,30 @@ paths: 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' responses: '200': $ref: '#/components/responses/security.delete_tenant@200' + '400': + $ref: '#/components/responses/security.delete_tenant@400' get: operationId: security.get_tenant.0 x-operation-group: security.get_tenant x-version-added: '1.0' description: Retrieves one tenant. externalDocs: - url: https://opensearch.org/docs/2.7/security/access-control/api/#get-tenant + 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' responses: '200': $ref: '#/components/responses/security.get_tenant@200' @@ -3452,39 +5191,480 @@ paths: x-version-added: '1.0' description: Add, delete, or modify a single tenant. externalDocs: - url: https://opensearch.org/docs/2.7/security/access-control/api/#patch-tenant + 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' requestBody: $ref: '#/components/requestBodies/security.patch_tenant' responses: '200': $ref: '#/components/responses/security.patch_tenant@200' + '400': + $ref: '#/components/responses/security.patch_tenant@400' put: operationId: security.create_tenant.0 x-operation-group: security.create_tenant x-version-added: '1.0' description: Creates or replaces the specified tenant. externalDocs: - url: https://opensearch.org/docs/2.7/security/access-control/api/#create-tenant + 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' requestBody: $ref: '#/components/requestBodies/security.create_tenant' responses: '200': $ref: '#/components/responses/security.create_tenant@200' + '400': + $ref: '#/components/responses/security.create_tenant@400' + /_plugins/_security/api/user: + get: + operationId: security.get_users_legacy.0 + x-operation-group: security.get_users_legacy + x-version-added: '1.0' + description: Retrieve all internal users. Legacy API. + responses: + '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' + /_plugins/_security/api/user/{username}: + delete: + operationId: security.delete_user_legacy.0 + x-operation-group: security.delete_user_legacy + x-version-added: '1.0' + 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' + responses: + '200': + $ref: '#/components/responses/security.delete_user_legacy@200' + get: + operationId: security.get_user_legacy.0 + x-operation-group: security.get_user_legacy + x-version-added: '1.0' + 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' + responses: + '200': + $ref: '#/components/responses/security.get_user_legacy@200' + put: + operationId: security.create_user_legacy.0 + x-operation-group: security.create_user_legacy + x-version-added: '1.0' + 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' + requestBody: + $ref: '#/components/requestBodies/security.create_user_legacy' + responses: + '200': + $ref: '#/components/responses/security.create_user_legacy@200' + /_plugins/_security/api/user/{username}/authtoken: + post: + operationId: security.generate_user_token_legacy.0 + x-operation-group: security.generate_user_token_legacy + x-version-added: '1.0' + description: Generates authorization token for the given user. Legacy API. + 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' + responses: + '200': + $ref: '#/components/responses/security.generate_user_token_legacy@200' + '400': + $ref: '#/components/responses/security.generate_user_token_legacy@400' + /_plugins/_security/api/validate: + get: + operationId: security.validate.0 + x-operation-group: security.validate + x-version-added: '1.0' + 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' + responses: + '200': + $ref: '#/components/responses/security.validate@200' + '400': + $ref: '#/components/responses/security.validate@400' + /_plugins/_security/authinfo: + get: + operationId: security.authinfo.0 + x-operation-group: security.authinfo + x-version-added: '1.0' + 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' + responses: + '200': + $ref: '#/components/responses/security.authinfo@200' + '500': + $ref: '#/components/responses/security.authinfo@500' + post: + operationId: security.authinfo.1 + x-operation-group: security.authinfo + x-version-added: '1.0' + 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' + responses: + '200': + $ref: '#/components/responses/security.authinfo@200' + '500': + $ref: '#/components/responses/security.authinfo@500' + /_plugins/_security/dashboardsinfo: + get: + operationId: security.get_dashboards_info.0 + x-operation-group: security.get_dashboards_info + x-version-added: '1.0' + description: Retrieves the current security-dashboards plugin configuration. + responses: + '200': + $ref: '#/components/responses/security.get_dashboards_info@200' + '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' + post: + operationId: security.post_dashboards_info.1 + x-operation-group: security.post_dashboards_info + x-version-added: '1.0' + description: Updates the current security-dashboards plugin configuration. + requestBody: + $ref: '#/components/requestBodies/security.post_dashboards_info' + responses: + '200': + $ref: '#/components/responses/security.post_dashboards_info@200' + '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' /_plugins/_security/health: get: operationId: security.health.0 x-operation-group: security.health x-version-added: '1.0' 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' + externalDocs: + url: https://opensearch.org/docs/latest/security/access-control/api/#health-check + responses: + '200': + $ref: '#/components/responses/security.health@200' + post: + operationId: security.health.1 + x-operation-group: security.health + x-version-added: '1.0' + 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' externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#health-check responses: '200': $ref: '#/components/responses/security.health@200' + /_plugins/_security/tenantinfo: + get: + operationId: security.tenant_info.0 + x-operation-group: security.tenant_info + x-version-added: '1.0' + 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' + '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' + post: + operationId: security.tenant_info.1 + x-operation-group: security.tenant_info + x-version-added: '1.0' + 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' + '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' + /_plugins/_security/whoami: + get: + operationId: security.who_am_i.0 + x-operation-group: security.who_am_i + x-version-added: '1.0' + description: Gets the user identity related information for currently logged in user. + responses: + '200': + $ref: '#/components/responses/security.who_am_i@200' + '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' + post: + operationId: security.who_am_i.1 + x-operation-group: security.who_am_i + x-version-added: '1.0' + description: Gets the user identity related information for currently logged in user. + responses: + '200': + $ref: '#/components/responses/security.who_am_i@200' + '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' + /_plugins/_security/whoamiprotected: + get: + operationId: security.who_am_i_protected.0 + x-operation-group: security.who_am_i_protected + x-version-added: '2.11' + 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' + '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' + /_plugins/_transform: + get: + operationId: transforms.search.0 + x-operation-group: transforms.search + x-version-added: '1.0' + description: Returns the details of all transform jobs. + 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' + responses: + '200': + $ref: '#/components/responses/transforms.search@200' + /_plugins/_transform/_preview: + get: + operationId: transforms.preview.0 + x-operation-group: transforms.preview + x-version-added: '1.0' + description: Returns a preview of what a transformed index would look like. + externalDocs: + url: https://opensearch.org/docs/latest/im-plugin/index-transforms/transforms-apis/#preview-a-transform-jobs-results + responses: + '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' + /_plugins/_transform/{id}: + delete: + operationId: transforms.delete.0 + x-operation-group: transforms.delete + x-version-added: '1.0' + description: Delete an index transform. + 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' + responses: + '200': + $ref: '#/components/responses/transforms.delete@200' + get: + operationId: transforms.get.0 + x-operation-group: transforms.get + x-version-added: '1.0' + description: Returns the status and metadata of a transform job. + 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' + responses: + '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. + 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' + requestBody: + $ref: '#/components/requestBodies/transforms.put' + responses: + '200': + $ref: '#/components/responses/transforms.put@200' + /_plugins/_transform/{id}/_explain: + get: + operationId: transforms.explain.0 + x-operation-group: transforms.explain + x-version-added: '1.0' + description: Returns the status and metadata of a transform job. + 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' + responses: + '200': + $ref: '#/components/responses/transforms.explain@200' + /_plugins/_transform/{id}/_start: + post: + operationId: transforms.start.0 + x-operation-group: transforms.start + x-version-added: '1.0' + description: Start transform. + 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' + responses: + '200': + $ref: '#/components/responses/transforms.start@200' + /_plugins/_transform/{id}/_stop: + post: + operationId: transforms.stop.0 + x-operation-group: transforms.stop + x-version-added: '1.0' + description: stop transform. + 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' + responses: + '200': + $ref: '#/components/responses/transforms.stop@200' /_rank_eval: get: operationId: rank_eval.0 @@ -3494,10 +5674,15 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/rank-eval/ parameters: - - $ref: '#/components/parameters/rank_eval::query.ignore_unavailable' - $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: @@ -3508,11 +5693,18 @@ paths: x-operation-group: rank_eval x-version-added: '1.0' description: Allows to evaluate the quality of ranked search results over a set of typical search queries. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/rank-eval/ parameters: - - $ref: '#/components/parameters/rank_eval::query.ignore_unavailable' - $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: @@ -3527,8 +5719,13 @@ paths: externalDocs: url: https://opensearch.org/docs/latest parameters: - - $ref: '#/components/parameters/indices.recovery::query.detailed' - $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' @@ -3538,10 +5735,17 @@ paths: x-operation-group: indices.refresh x-version-added: '1.0' description: Performs the refresh operation in one or more indices. + 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.ignore_unavailable' - $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' @@ -3553,9 +5757,14 @@ paths: 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.ignore_unavailable' - $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' @@ -3571,14 +5780,19 @@ 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.timeout' - - $ref: '#/components/parameters/reindex::query.wait_for_active_shards' - - $ref: '#/components/parameters/reindex::query.wait_for_completion' - $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.max_docs' + - $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: @@ -3595,6 +5809,11 @@ paths: 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' responses: '200': $ref: '#/components/responses/reindex_rethrottle@200' @@ -3606,7 +5825,12 @@ paths: description: Returns the information about configured remote clusters. externalDocs: url: https://opensearch.org/docs/latest/api-reference/remote-info/ - parameters: [] + 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/cluster.remote_info@200' @@ -3621,6 +5845,11 @@ paths: 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' requestBody: $ref: '#/components/requestBodies/remote_store.restore' responses: @@ -3634,7 +5863,12 @@ paths: description: Allows to use the Mustache language to pre-render a search definition. externalDocs: url: https://opensearch.org/docs/latest/search-plugins/search-template/ - parameters: [] + 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' requestBody: $ref: '#/components/requestBodies/render_search_template' responses: @@ -3645,7 +5879,14 @@ paths: x-operation-group: render_search_template x-version-added: '1.0' description: Allows to use the Mustache language to pre-render a search definition. - parameters: [] + 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' requestBody: $ref: '#/components/requestBodies/render_search_template' responses: @@ -3657,8 +5898,15 @@ paths: x-operation-group: render_search_template x-version-added: '1.0' description: Allows to use the Mustache language to pre-render a search definition. + 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' requestBody: $ref: '#/components/requestBodies/render_search_template' responses: @@ -3669,8 +5917,15 @@ paths: x-operation-group: render_search_template x-version-added: '1.0' description: Allows to use the Mustache language to pre-render a search definition. + 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' requestBody: $ref: '#/components/requestBodies/render_search_template' responses: @@ -3687,6 +5942,11 @@ paths: 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' responses: '200': $ref: '#/components/responses/indices.resolve_index@200' @@ -3698,7 +5958,12 @@ paths: description: Returns all script contexts. externalDocs: url: https://opensearch.org/docs/latest/api-reference/script-apis/get-script-contexts/ - parameters: [] + 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/get_script_context@200' @@ -3710,35 +5975,15 @@ paths: description: Returns available script types, languages and contexts. externalDocs: url: https://opensearch.org/docs/latest/api-reference/script-apis/get-script-language/ - parameters: [] + 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/get_script_languages@200' - /_scripts/painless/_execute: - get: - operationId: scripts_painless_execute.0 - x-operation-group: scripts_painless_execute - x-version-added: '1.0' - description: Allows an arbitrary script to be executed and a result to be returned. - externalDocs: - url: https://opensearch.org/docs/latest/api-reference/script-apis/exec-script/ - parameters: [] - requestBody: - $ref: '#/components/requestBodies/scripts_painless_execute' - responses: - '200': - $ref: '#/components/responses/scripts_painless_execute@200' - post: - operationId: scripts_painless_execute.1 - x-operation-group: scripts_painless_execute - x-version-added: '1.0' - description: Allows an arbitrary script to be executed and a result to be returned. - parameters: [] - requestBody: - $ref: '#/components/requestBodies/scripts_painless_execute' - responses: - '200': - $ref: '#/components/responses/scripts_painless_execute@200' /_scripts/{id}: delete: operationId: delete_script.0 @@ -3749,9 +5994,14 @@ paths: 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.timeout' - - $ref: '#/components/parameters/delete_script::query.master_timeout' - $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' @@ -3764,8 +6014,13 @@ paths: 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.master_timeout' - $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' @@ -3774,11 +6029,18 @@ paths: x-operation-group: put_script x-version-added: '1.0' description: Creates or updates a script. + 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.timeout' - - $ref: '#/components/parameters/put_script::query.master_timeout' - $ref: '#/components/parameters/put_script::query.cluster_manager_timeout' + - $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: @@ -3793,9 +6055,14 @@ paths: 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.timeout' - - $ref: '#/components/parameters/put_script::query.master_timeout' - $ref: '#/components/parameters/put_script::query.cluster_manager_timeout' + - $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: @@ -3807,12 +6074,19 @@ paths: x-operation-group: put_script x-version-added: '1.0' description: Creates or updates a script. + 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::path.context' - - $ref: '#/components/parameters/put_script::query.timeout' - - $ref: '#/components/parameters/put_script::query.master_timeout' + - $ref: '#/components/parameters/put_script::path.id' - $ref: '#/components/parameters/put_script::query.cluster_manager_timeout' + - $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: @@ -3823,17 +6097,61 @@ paths: x-operation-group: put_script x-version-added: '1.0' description: Creates or updates a script. + 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::path.context' - - $ref: '#/components/parameters/put_script::query.timeout' - - $ref: '#/components/parameters/put_script::query.master_timeout' + - $ref: '#/components/parameters/put_script::path.id' - $ref: '#/components/parameters/put_script::query.cluster_manager_timeout' + - $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' + /_scripts/painless/_execute: + get: + operationId: scripts_painless_execute.0 + x-operation-group: scripts_painless_execute + x-version-added: '1.0' + description: Allows an arbitrary script to be executed and a result to be returned. + 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' + requestBody: + $ref: '#/components/requestBodies/scripts_painless_execute' + responses: + '200': + $ref: '#/components/responses/scripts_painless_execute@200' + post: + operationId: scripts_painless_execute.1 + x-operation-group: scripts_painless_execute + x-version-added: '1.0' + description: Allows an arbitrary script to be executed and a result to be returned. + 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' + requestBody: + $ref: '#/components/requestBodies/scripts_painless_execute' + responses: + '200': + $ref: '#/components/responses/scripts_painless_execute@200' /_search: get: operationId: search.0 @@ -3843,50 +6161,57 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/search/ parameters: - - $ref: '#/components/parameters/search::query.analyzer' + - $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.explain' - - $ref: '#/components/parameters/search::query.stored_fields' - $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_unavailable' - $ref: '#/components/parameters/search::query.ignore_throttled' - - $ref: '#/components/parameters/search::query.allow_no_indices' - - $ref: '#/components/parameters/search::query.expand_wildcards' + - $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._source' - - $ref: '#/components/parameters/search::query._source_excludes' - - $ref: '#/components/parameters/search::query._source_includes' - - $ref: '#/components/parameters/search::query.terminate_after' - $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.allow_partial_search_results' - $ref: '#/components/parameters/search::query.typed_keys' - $ref: '#/components/parameters/search::query.version' - - $ref: '#/components/parameters/search::query.seq_no_primary_term' - - $ref: '#/components/parameters/search::query.request_cache' - - $ref: '#/components/parameters/search::query.batched_reduce_size' - - $ref: '#/components/parameters/search::query.max_concurrent_shard_requests' - - $ref: '#/components/parameters/search::query.pre_filter_shard_size' - - $ref: '#/components/parameters/search::query.rest_total_hits_as_int' - - $ref: '#/components/parameters/search::query.search_pipeline' - - $ref: '#/components/parameters/search::query.include_named_queries_score' + - $ref: '#/components/parameters/_global::query.pretty' + - $ref: '#/components/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: @@ -3897,81 +6222,181 @@ paths: x-operation-group: search x-version-added: '1.0' description: Returns results matching a query. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/search/ parameters: - - $ref: '#/components/parameters/search::query.analyzer' + - $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.explain' - - $ref: '#/components/parameters/search::query.stored_fields' - $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_unavailable' - $ref: '#/components/parameters/search::query.ignore_throttled' - - $ref: '#/components/parameters/search::query.allow_no_indices' - - $ref: '#/components/parameters/search::query.expand_wildcards' + - $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._source' - - $ref: '#/components/parameters/search::query._source_excludes' - - $ref: '#/components/parameters/search::query._source_includes' - - $ref: '#/components/parameters/search::query.terminate_after' - $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.allow_partial_search_results' - $ref: '#/components/parameters/search::query.typed_keys' - $ref: '#/components/parameters/search::query.version' - - $ref: '#/components/parameters/search::query.seq_no_primary_term' - - $ref: '#/components/parameters/search::query.request_cache' - - $ref: '#/components/parameters/search::query.batched_reduce_size' - - $ref: '#/components/parameters/search::query.max_concurrent_shard_requests' - - $ref: '#/components/parameters/search::query.pre_filter_shard_size' - - $ref: '#/components/parameters/search::query.rest_total_hits_as_int' - - $ref: '#/components/parameters/search::query.search_pipeline' - - $ref: '#/components/parameters/search::query.include_named_queries_score' + - $ref: '#/components/parameters/_global::query.pretty' + - $ref: '#/components/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' - /_search/pipeline/{pipeline}: + /_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. + 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' + responses: + '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. + 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' + responses: + '200': + $ref: '#/components/responses/search_shards@200' + /_search/pipeline: get: operationId: search_pipeline.get.0 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.pipeline' + - $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' + /_search/pipeline/{id}: + delete: + operationId: search_pipeline.delete.0 + x-operation-group: search_pipeline.delete + 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' + responses: + '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' responses: '200': $ref: '#/components/responses/search_pipeline.get@200' put: - operationId: search_pipeline.create.0 - x-operation-group: search_pipeline.create + operationId: search_pipeline.put.0 + x-operation-group: search_pipeline.put x-version-added: '2.9' description: Creates or replaces the specified search pipeline. externalDocs: url: https://opensearch.org/docs/latest/search-plugins/search-pipelines/creating-search-pipeline/ parameters: - - $ref: '#/components/parameters/search_pipeline.create::path.pipeline' + - $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.create' + $ref: '#/components/requestBodies/search_pipeline.put' responses: '200': - $ref: '#/components/responses/search_pipeline.create@200' + $ref: '#/components/responses/search_pipeline.put@200' /_search/point_in_time: delete: operationId: delete_pit.0 @@ -3985,6 +6410,12 @@ paths: responses: '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' /_search/point_in_time/_all: delete: operationId: delete_all_pits.0 @@ -3996,6 +6427,12 @@ paths: responses: '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' get: operationId: get_all_pits.0 x-operation-group: get_all_pits @@ -4006,6 +6443,12 @@ paths: responses: '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' /_search/scroll: delete: operationId: clear_scroll.0 @@ -4014,7 +6457,12 @@ paths: description: Explicitly clears the search context for a scroll. externalDocs: url: https://opensearch.org/docs/latest/api-reference/scroll/ - parameters: [] + 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' requestBody: $ref: '#/components/requestBodies/clear_scroll' responses: @@ -4028,9 +6476,14 @@ 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/scroll::query.rest_total_hits_as_int' + - $ref: '#/components/parameters/_global::query.pretty' + - $ref: '#/components/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: @@ -4041,10 +6494,17 @@ paths: x-operation-group: scroll x-version-added: '1.0' description: Allows to retrieve a large numbers of results from a single search request. + 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/scroll::query.rest_total_hits_as_int' + - $ref: '#/components/parameters/_global::query.pretty' + - $ref: '#/components/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: @@ -4059,8 +6519,15 @@ paths: x-version-added: '1.0' x-version-deprecated: '1.0' description: Explicitly clears the search context for a scroll. + 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' requestBody: $ref: '#/components/requestBodies/clear_scroll' responses: @@ -4074,11 +6541,18 @@ paths: x-version-added: '1.0' x-version-deprecated: '1.0' description: Allows to retrieve a large numbers of results from a single search request. + 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/scroll::query.rest_total_hits_as_int' + - $ref: '#/components/parameters/_global::query.pretty' + - $ref: '#/components/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: @@ -4092,11 +6566,18 @@ paths: x-version-added: '1.0' x-version-deprecated: '1.0' description: Allows to retrieve a large numbers of results from a single search request. + 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/scroll::query.rest_total_hits_as_int' + - $ref: '#/components/parameters/_global::query.pretty' + - $ref: '#/components/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: @@ -4111,19 +6592,24 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/search-plugins/search-template/ parameters: - - $ref: '#/components/parameters/search_template::query.ignore_unavailable' - - $ref: '#/components/parameters/search_template::query.ignore_throttled' - $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.explain' - - $ref: '#/components/parameters/search_template::query.profile' - $ref: '#/components/parameters/search_template::query.typed_keys' - - $ref: '#/components/parameters/search_template::query.rest_total_hits_as_int' - - $ref: '#/components/parameters/search_template::query.ccs_minimize_roundtrips' + - $ref: '#/components/parameters/_global::query.pretty' + - $ref: '#/components/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: @@ -4134,58 +6620,32 @@ paths: x-operation-group: search_template x-version-added: '1.0' description: Allows to use the Mustache language to pre-render a search definition. + externalDocs: + url: https://opensearch.org/docs/latest/search-plugins/search-template/ parameters: - - $ref: '#/components/parameters/search_template::query.ignore_unavailable' - - $ref: '#/components/parameters/search_template::query.ignore_throttled' - $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.explain' - - $ref: '#/components/parameters/search_template::query.profile' - $ref: '#/components/parameters/search_template::query.typed_keys' - - $ref: '#/components/parameters/search_template::query.rest_total_hits_as_int' - - $ref: '#/components/parameters/search_template::query.ccs_minimize_roundtrips' + - $ref: '#/components/parameters/_global::query.pretty' + - $ref: '#/components/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' - /_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. - externalDocs: - url: https://opensearch.org/docs/latest - parameters: - - $ref: '#/components/parameters/search_shards::query.preference' - - $ref: '#/components/parameters/search_shards::query.routing' - - $ref: '#/components/parameters/search_shards::query.local' - - $ref: '#/components/parameters/search_shards::query.ignore_unavailable' - - $ref: '#/components/parameters/search_shards::query.allow_no_indices' - - $ref: '#/components/parameters/search_shards::query.expand_wildcards' - responses: - '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. - parameters: - - $ref: '#/components/parameters/search_shards::query.preference' - - $ref: '#/components/parameters/search_shards::query.routing' - - $ref: '#/components/parameters/search_shards::query.local' - - $ref: '#/components/parameters/search_shards::query.ignore_unavailable' - - $ref: '#/components/parameters/search_shards::query.allow_no_indices' - - $ref: '#/components/parameters/search_shards::query.expand_wildcards' - responses: - '200': - $ref: '#/components/responses/search_shards@200' /_segments: get: operationId: indices.segments.0 @@ -4195,10 +6655,15 @@ paths: externalDocs: url: https://opensearch.org/docs/latest parameters: - - $ref: '#/components/parameters/indices.segments::query.ignore_unavailable' - $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' @@ -4211,14 +6676,19 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/index-apis/get-settings/ parameters: - - $ref: '#/components/parameters/indices.get_settings::query.master_timeout' - - $ref: '#/components/parameters/indices.get_settings::query.cluster_manager_timeout' - - $ref: '#/components/parameters/indices.get_settings::query.ignore_unavailable' - $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.local' + - $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' @@ -4230,14 +6700,19 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/index-apis/update-settings/ parameters: - - $ref: '#/components/parameters/indices.put_settings::query.master_timeout' - - $ref: '#/components/parameters/indices.put_settings::query.cluster_manager_timeout' - - $ref: '#/components/parameters/indices.put_settings::query.timeout' - - $ref: '#/components/parameters/indices.put_settings::query.preserve_existing' - - $ref: '#/components/parameters/indices.put_settings::query.ignore_unavailable' - $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: @@ -4249,16 +6724,23 @@ paths: x-operation-group: indices.get_settings x-version-added: '1.0' description: Returns settings for one or more indices. + 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.master_timeout' - - $ref: '#/components/parameters/indices.get_settings::query.cluster_manager_timeout' - - $ref: '#/components/parameters/indices.get_settings::query.ignore_unavailable' - $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.local' + - $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' @@ -4271,10 +6753,15 @@ paths: externalDocs: url: https://opensearch.org/docs/latest parameters: - - $ref: '#/components/parameters/indices.shard_stores::query.status' - - $ref: '#/components/parameters/indices.shard_stores::query.ignore_unavailable' - $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' @@ -4287,9 +6774,14 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/snapshots/get-snapshot-repository/ parameters: - - $ref: '#/components/parameters/snapshot.get_repository::query.master_timeout' - $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' @@ -4302,9 +6794,14 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/snapshots/get-snapshot-status/ parameters: - - $ref: '#/components/parameters/snapshot.status::query.master_timeout' - $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' @@ -4318,9 +6815,14 @@ paths: 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.master_timeout' - $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' @@ -4329,11 +6831,18 @@ paths: x-operation-group: snapshot.get_repository x-version-added: '1.0' description: Returns information about a repository. + 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.master_timeout' - $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' @@ -4342,12 +6851,19 @@ paths: x-operation-group: snapshot.create_repository x-version-added: '1.0' description: Creates a repository. + 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.master_timeout' - $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: @@ -4362,10 +6878,15 @@ paths: 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.master_timeout' - $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: @@ -4381,9 +6902,14 @@ paths: url: https://opensearch.org/docs/latest parameters: - $ref: '#/components/parameters/snapshot.cleanup_repository::path.repository' - - $ref: '#/components/parameters/snapshot.cleanup_repository::query.master_timeout' - $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' @@ -4393,11 +6919,18 @@ paths: x-operation-group: snapshot.status x-version-added: '1.0' description: Returns information about the status of a snapshot. + 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.master_timeout' - $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' @@ -4411,9 +6944,14 @@ paths: 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.master_timeout' - $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' @@ -4428,8 +6966,13 @@ paths: parameters: - $ref: '#/components/parameters/snapshot.delete::path.repository' - $ref: '#/components/parameters/snapshot.delete::path.snapshot' - - $ref: '#/components/parameters/snapshot.delete::query.master_timeout' - $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' @@ -4443,10 +6986,15 @@ paths: parameters: - $ref: '#/components/parameters/snapshot.get::path.repository' - $ref: '#/components/parameters/snapshot.get::path.snapshot' - - $ref: '#/components/parameters/snapshot.get::query.master_timeout' - $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' @@ -4455,12 +7003,19 @@ paths: x-operation-group: snapshot.create x-version-added: '1.0' description: Creates a snapshot in a repository. + 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.master_timeout' - $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: @@ -4476,9 +7031,14 @@ paths: parameters: - $ref: '#/components/parameters/snapshot.create::path.repository' - $ref: '#/components/parameters/snapshot.create::path.snapshot' - - $ref: '#/components/parameters/snapshot.create::query.master_timeout' - $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: @@ -4496,8 +7056,13 @@ paths: - $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.master_timeout' - $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: @@ -4514,9 +7079,14 @@ paths: parameters: - $ref: '#/components/parameters/snapshot.restore::path.repository' - $ref: '#/components/parameters/snapshot.restore::path.snapshot' - - $ref: '#/components/parameters/snapshot.restore::query.master_timeout' - $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: @@ -4528,12 +7098,19 @@ paths: x-operation-group: snapshot.status x-version-added: '1.0' description: Returns information about the status of a snapshot. + 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.master_timeout' - $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' @@ -4547,14 +7124,19 @@ paths: 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.level' - $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.expand_wildcards' - - $ref: '#/components/parameters/indices.stats::query.forbid_closed_indices' + - $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' @@ -4564,17 +7146,24 @@ paths: x-operation-group: indices.stats x-version-added: '1.0' description: Provides statistics on operations happening in an index. + 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.level' - $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.expand_wildcards' - - $ref: '#/components/parameters/indices.stats::query.forbid_closed_indices' + - $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' @@ -4587,13 +7176,18 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/tasks/ parameters: - - $ref: '#/components/parameters/tasks.list::query.nodes' - $ref: '#/components/parameters/tasks.list::query.actions' - $ref: '#/components/parameters/tasks.list::query.detailed' - - $ref: '#/components/parameters/tasks.list::query.parent_task_id' - - $ref: '#/components/parameters/tasks.list::query.wait_for_completion' - $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' @@ -4606,10 +7200,15 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/tasks/#task-canceling parameters: - - $ref: '#/components/parameters/tasks.cancel::query.nodes' - $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' @@ -4623,8 +7222,13 @@ paths: url: https://opensearch.org/docs/latest/api-reference/tasks/ parameters: - $ref: '#/components/parameters/tasks.get::path.task_id' - - $ref: '#/components/parameters/tasks.get::query.wait_for_completion' - $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' @@ -4634,12 +7238,19 @@ paths: x-operation-group: tasks.cancel x-version-added: '1.0' description: Cancels a task, if it can be cancelled through an API. + 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.nodes' - $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' @@ -4652,10 +7263,15 @@ paths: externalDocs: url: https://opensearch.org/docs/latest parameters: - - $ref: '#/components/parameters/indices.get_template::query.flat_settings' - - $ref: '#/components/parameters/indices.get_template::query.master_timeout' - $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' @@ -4669,9 +7285,14 @@ paths: url: https://opensearch.org/docs/latest parameters: - $ref: '#/components/parameters/indices.delete_template::path.name' - - $ref: '#/components/parameters/indices.delete_template::query.timeout' - - $ref: '#/components/parameters/indices.delete_template::query.master_timeout' - $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' @@ -4680,12 +7301,19 @@ paths: x-operation-group: indices.get_template x-version-added: '1.0' description: Returns an index template. + externalDocs: + url: https://opensearch.org/docs/latest parameters: - $ref: '#/components/parameters/indices.get_template::path.name' - - $ref: '#/components/parameters/indices.get_template::query.flat_settings' - - $ref: '#/components/parameters/indices.get_template::query.master_timeout' - $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' @@ -4698,10 +7326,15 @@ paths: url: https://opensearch.org/docs/latest parameters: - $ref: '#/components/parameters/indices.exists_template::path.name' - - $ref: '#/components/parameters/indices.exists_template::query.flat_settings' - - $ref: '#/components/parameters/indices.exists_template::query.master_timeout' - $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' @@ -4710,12 +7343,19 @@ paths: x-operation-group: indices.put_template x-version-added: '1.0' description: Creates or updates an index template. + 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.order' + - $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.cluster_manager_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: @@ -4730,10 +7370,15 @@ paths: 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.order' + - $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.cluster_manager_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: @@ -4750,6 +7395,11 @@ paths: 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' responses: '200': $ref: '#/components/responses/update_by_query_rethrottle@200' @@ -4762,9 +7412,14 @@ paths: externalDocs: url: https://opensearch.org/docs/latest parameters: - - $ref: '#/components/parameters/indices.get_upgrade::query.ignore_unavailable' - $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' @@ -4779,8 +7434,13 @@ paths: - $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.wait_for_completion' - $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' @@ -4793,18 +7453,23 @@ paths: externalDocs: url: https://opensearch.org/docs/latest parameters: - - $ref: '#/components/parameters/indices.validate_query::query.explain' - - $ref: '#/components/parameters/indices.validate_query::query.ignore_unavailable' + - $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.expand_wildcards' - - $ref: '#/components/parameters/indices.validate_query::query.q' - - $ref: '#/components/parameters/indices.validate_query::query.analyzer' - $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/indices.validate_query::query.all_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.validate_query' responses: @@ -4815,19 +7480,26 @@ paths: x-operation-group: indices.validate_query x-version-added: '1.0' description: Allows a user to validate a potentially expensive query without executing it. + externalDocs: + url: https://opensearch.org/docs/latest parameters: - - $ref: '#/components/parameters/indices.validate_query::query.explain' - - $ref: '#/components/parameters/indices.validate_query::query.ignore_unavailable' + - $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.expand_wildcards' - - $ref: '#/components/parameters/indices.validate_query::query.q' - - $ref: '#/components/parameters/indices.validate_query::query.analyzer' - $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/indices.validate_query::query.all_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.validate_query' responses: @@ -4845,11 +7517,16 @@ paths: url: https://opensearch.org/docs/latest/dashboards/im-dashboards/rollover/ parameters: - $ref: '#/components/parameters/indices.rollover::path.alias' - - $ref: '#/components/parameters/indices.rollover::query.timeout' + - $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.cluster_manager_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: @@ -4863,14 +7540,21 @@ paths: description: |- Updates an alias to point to a new index when the existing index is considered to be too large or too old. + 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.timeout' + - $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.cluster_manager_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: @@ -4886,12 +7570,17 @@ paths: 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.timeout' - - $ref: '#/components/parameters/indices.delete::query.master_timeout' - - $ref: '#/components/parameters/indices.delete::query.ignore_unavailable' - $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' @@ -4904,14 +7593,19 @@ paths: 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.local' - - $ref: '#/components/parameters/indices.get::query.ignore_unavailable' - $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/indices.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/indices.get@200' @@ -4924,15 +7618,23 @@ paths: 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.local' - - $ref: '#/components/parameters/indices.exists::query.ignore_unavailable' - $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' put: operationId: indices.create.0 x-operation-group: indices.create @@ -4942,10 +7644,15 @@ paths: 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.wait_for_active_shards' - - $ref: '#/components/parameters/indices.create::query.timeout' - - $ref: '#/components/parameters/indices.create::query.master_timeout' - $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: @@ -4957,12 +7664,19 @@ paths: x-operation-group: indices.get_alias x-version-added: '1.0' description: Returns an alias. + 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.ignore_unavailable' - $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' @@ -4977,9 +7691,14 @@ paths: parameters: - $ref: '#/components/parameters/indices.delete_alias::path.index' - $ref: '#/components/parameters/indices.delete_alias::path.name' - - $ref: '#/components/parameters/indices.delete_alias::query.timeout' - - $ref: '#/components/parameters/indices.delete_alias::query.master_timeout' - $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' @@ -4988,13 +7707,20 @@ paths: x-operation-group: indices.get_alias x-version-added: '1.0' description: Returns an alias. + 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.ignore_unavailable' - $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' @@ -5003,13 +7729,20 @@ paths: x-operation-group: indices.exists_alias x-version-added: '1.0' description: Returns information about whether a particular alias exists. + 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.ignore_unavailable' - $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' @@ -5018,12 +7751,19 @@ paths: x-operation-group: indices.put_alias x-version-added: '1.0' description: Creates or updates an alias. + externalDocs: + url: https://opensearch.org/docs/latest/im-plugin/index-alias/#create-aliases parameters: - $ref: '#/components/parameters/indices.put_alias::path.index' - $ref: '#/components/parameters/indices.put_alias::path.name' - - $ref: '#/components/parameters/indices.put_alias::query.timeout' - - $ref: '#/components/parameters/indices.put_alias::query.master_timeout' - $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: @@ -5039,9 +7779,14 @@ paths: parameters: - $ref: '#/components/parameters/indices.put_alias::path.index' - $ref: '#/components/parameters/indices.put_alias::path.name' - - $ref: '#/components/parameters/indices.put_alias::query.timeout' - - $ref: '#/components/parameters/indices.put_alias::query.master_timeout' - $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: @@ -5053,12 +7798,19 @@ paths: x-operation-group: indices.delete_alias x-version-added: '1.0' description: Deletes an alias. + 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.timeout' - - $ref: '#/components/parameters/indices.delete_alias::query.master_timeout' - $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' @@ -5067,12 +7819,19 @@ paths: x-operation-group: indices.put_alias x-version-added: '1.0' description: Creates or updates an alias. + externalDocs: + url: https://opensearch.org/docs/latest/im-plugin/index-alias/#create-aliases parameters: - $ref: '#/components/parameters/indices.put_alias::path.index' - $ref: '#/components/parameters/indices.put_alias::path.name' - - $ref: '#/components/parameters/indices.put_alias::query.timeout' - - $ref: '#/components/parameters/indices.put_alias::query.master_timeout' - $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: @@ -5083,12 +7842,19 @@ paths: x-operation-group: indices.put_alias x-version-added: '1.0' description: Creates or updates an alias. + externalDocs: + url: https://opensearch.org/docs/latest/im-plugin/index-alias/#create-aliases parameters: - $ref: '#/components/parameters/indices.put_alias::path.index' - $ref: '#/components/parameters/indices.put_alias::path.name' - - $ref: '#/components/parameters/indices.put_alias::query.timeout' - - $ref: '#/components/parameters/indices.put_alias::query.master_timeout' - $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: @@ -5100,9 +7866,16 @@ paths: x-operation-group: indices.analyze x-version-added: '1.0' description: Performs the analysis process on a text and return the tokens breakdown of the text. + 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' requestBody: $ref: '#/components/requestBodies/indices.analyze' responses: @@ -5113,9 +7886,16 @@ paths: x-operation-group: indices.analyze x-version-added: '1.0' description: Performs the analysis process on a text and return the tokens breakdown of the text. + 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' requestBody: $ref: '#/components/requestBodies/indices.analyze' responses: @@ -5130,14 +7910,19 @@ paths: externalDocs: url: https://opensearch.org/docs/latest parameters: - - $ref: '#/components/parameters/indices.add_block::path.index' - $ref: '#/components/parameters/indices.add_block::path.block' - - $ref: '#/components/parameters/indices.add_block::query.timeout' - - $ref: '#/components/parameters/indices.add_block::query.master_timeout' - - $ref: '#/components/parameters/indices.add_block::query.cluster_manager_timeout' - - $ref: '#/components/parameters/indices.add_block::query.ignore_unavailable' + - $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' @@ -5147,18 +7932,25 @@ paths: x-operation-group: bulk x-version-added: '1.0' description: Allows to perform multiple index/update/delete operations in a single request. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/document-apis/bulk/ parameters: - $ref: '#/components/parameters/bulk::path.index' - - $ref: '#/components/parameters/bulk::query.wait_for_active_shards' - - $ref: '#/components/parameters/bulk::query.refresh' - - $ref: '#/components/parameters/bulk::query.routing' - - $ref: '#/components/parameters/bulk::query.timeout' - - $ref: '#/components/parameters/bulk::query.type' - $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: @@ -5169,18 +7961,25 @@ paths: x-operation-group: bulk x-version-added: '1.0' description: Allows to perform multiple index/update/delete operations in a single request. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/document-apis/bulk/ parameters: - $ref: '#/components/parameters/bulk::path.index' - - $ref: '#/components/parameters/bulk::query.wait_for_active_shards' - - $ref: '#/components/parameters/bulk::query.refresh' - - $ref: '#/components/parameters/bulk::query.routing' - - $ref: '#/components/parameters/bulk::query.timeout' - - $ref: '#/components/parameters/bulk::query.type' - $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: @@ -5192,16 +7991,24 @@ paths: x-operation-group: indices.clear_cache x-version-added: '1.0' description: Clears all or specific caches for one or more indices. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/index-apis/clear-index-cache/ 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.query' + - $ref: '#/components/parameters/indices.clear_cache::query.file' - $ref: '#/components/parameters/indices.clear_cache::query.ignore_unavailable' - - $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.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' @@ -5211,15 +8018,22 @@ paths: x-operation-group: indices.clone x-version-added: '1.0' description: Clones an index. + 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.timeout' - - $ref: '#/components/parameters/indices.clone::query.master_timeout' - $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/indices.clone::query.task_execution_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.clone' responses: @@ -5235,12 +8049,17 @@ paths: parameters: - $ref: '#/components/parameters/indices.clone::path.index' - $ref: '#/components/parameters/indices.clone::path.target' - - $ref: '#/components/parameters/indices.clone::query.timeout' - - $ref: '#/components/parameters/indices.clone::query.master_timeout' - $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/indices.clone::query.task_execution_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.clone' responses: @@ -5256,13 +8075,18 @@ paths: 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.timeout' - - $ref: '#/components/parameters/indices.close::query.master_timeout' - - $ref: '#/components/parameters/indices.close::query.cluster_manager_timeout' - - $ref: '#/components/parameters/indices.close::query.ignore_unavailable' - $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' @@ -5272,22 +8096,29 @@ paths: x-operation-group: count x-version-added: '1.0' description: Returns number of documents matching a query. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/count/ parameters: - $ref: '#/components/parameters/count::path.index' - - $ref: '#/components/parameters/count::query.ignore_unavailable' - - $ref: '#/components/parameters/count::query.ignore_throttled' - $ref: '#/components/parameters/count::query.allow_no_indices' - - $ref: '#/components/parameters/count::query.expand_wildcards' - - $ref: '#/components/parameters/count::query.min_score' - - $ref: '#/components/parameters/count::query.preference' - - $ref: '#/components/parameters/count::query.routing' - - $ref: '#/components/parameters/count::query.q' - - $ref: '#/components/parameters/count::query.analyzer' - $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: @@ -5298,22 +8129,29 @@ paths: x-operation-group: count x-version-added: '1.0' description: Returns number of documents matching a query. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/count/ parameters: - $ref: '#/components/parameters/count::path.index' - - $ref: '#/components/parameters/count::query.ignore_unavailable' - - $ref: '#/components/parameters/count::query.ignore_throttled' - $ref: '#/components/parameters/count::query.allow_no_indices' - - $ref: '#/components/parameters/count::query.expand_wildcards' - - $ref: '#/components/parameters/count::query.min_score' - - $ref: '#/components/parameters/count::query.preference' - - $ref: '#/components/parameters/count::query.routing' - - $ref: '#/components/parameters/count::query.q' - - $ref: '#/components/parameters/count::query.analyzer' - $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: @@ -5328,16 +8166,23 @@ paths: Creates a new document in the index. Returns a 409 response when a document with a same ID already exists in the index. + 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.wait_for_active_shards' + - $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.pipeline' + - $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: @@ -5356,13 +8201,18 @@ paths: parameters: - $ref: '#/components/parameters/create::path.id' - $ref: '#/components/parameters/create::path.index' - - $ref: '#/components/parameters/create::query.wait_for_active_shards' + - $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.pipeline' + - $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: @@ -5378,39 +8228,44 @@ paths: 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.analyzer' + - $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.allow_no_indices' - - $ref: '#/components/parameters/delete_by_query::query.conflicts' - - $ref: '#/components/parameters/delete_by_query::query.expand_wildcards' - $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.search_type' + - $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.max_docs' + - $ref: '#/components/parameters/delete_by_query::query.slices' - $ref: '#/components/parameters/delete_by_query::query.sort' - - $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.terminate_after' - $ref: '#/components/parameters/delete_by_query::query.stats' - - $ref: '#/components/parameters/delete_by_query::query.version' - - $ref: '#/components/parameters/delete_by_query::query.request_cache' - - $ref: '#/components/parameters/delete_by_query::query.refresh' + - $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.scroll_size' - $ref: '#/components/parameters/delete_by_query::query.wait_for_completion' - - $ref: '#/components/parameters/delete_by_query::query.requests_per_second' - - $ref: '#/components/parameters/delete_by_query::query.slices' + - $ref: '#/components/parameters/_global::query.pretty' + - $ref: '#/components/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: @@ -5426,22 +8281,29 @@ paths: url: https://opensearch.org/docs/latest/api-reference/document-apis/index-document/ parameters: - $ref: '#/components/parameters/index::path.index' - - $ref: '#/components/parameters/index::query.wait_for_active_shards' + - $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.if_seq_no' - - $ref: '#/components/parameters/index::query.if_primary_term' - - $ref: '#/components/parameters/index::query.pipeline' - - $ref: '#/components/parameters/index::query.require_alias' + - $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' + '201': + $ref: '#/components/responses/index@201' /{index}/_doc/{id}: delete: operationId: delete.0 @@ -5453,14 +8315,19 @@ paths: parameters: - $ref: '#/components/parameters/delete::path.id' - $ref: '#/components/parameters/delete::path.index' - - $ref: '#/components/parameters/delete::query.wait_for_active_shards' + - $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.if_seq_no' - - $ref: '#/components/parameters/delete::query.if_primary_term' - $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' @@ -5474,16 +8341,21 @@ paths: parameters: - $ref: '#/components/parameters/get::path.id' - $ref: '#/components/parameters/get::path.index' - - $ref: '#/components/parameters/get::query.stored_fields' + - $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._source' - - $ref: '#/components/parameters/get::query._source_excludes' - - $ref: '#/components/parameters/get::query._source_includes' + - $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' @@ -5497,16 +8369,21 @@ paths: parameters: - $ref: '#/components/parameters/exists::path.id' - $ref: '#/components/parameters/exists::path.index' - - $ref: '#/components/parameters/exists::query.stored_fields' + - $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._source' - - $ref: '#/components/parameters/exists::query._source_excludes' - - $ref: '#/components/parameters/exists::query._source_includes' + - $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' @@ -5515,49 +8392,67 @@ paths: x-operation-group: index x-version-added: '1.0' description: Creates or updates a document in an index. + 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.wait_for_active_shards' + - $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.if_seq_no' - - $ref: '#/components/parameters/index::query.if_primary_term' - - $ref: '#/components/parameters/index::query.pipeline' - - $ref: '#/components/parameters/index::query.require_alias' + - $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' + '201': + $ref: '#/components/responses/index@201' put: operationId: index.2 x-operation-group: index x-version-added: '1.0' description: Creates or updates a document in an index. + 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.wait_for_active_shards' + - $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.if_seq_no' - - $ref: '#/components/parameters/index::query.if_primary_term' - - $ref: '#/components/parameters/index::query.pipeline' - - $ref: '#/components/parameters/index::query.require_alias' + - $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' + '201': + $ref: '#/components/responses/index@201' /{index}/_explain/{id}: get: operationId: explain.0 @@ -5569,18 +8464,23 @@ paths: 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.stored_fields' - $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._source' - - $ref: '#/components/parameters/explain::query._source_excludes' - - $ref: '#/components/parameters/explain::query._source_includes' + - $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: @@ -5591,21 +8491,28 @@ paths: x-operation-group: explain x-version-added: '1.0' description: Returns information about why a specific matches (or doesn't match) a query. + 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.stored_fields' - $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._source' - - $ref: '#/components/parameters/explain::query._source_excludes' - - $ref: '#/components/parameters/explain::query._source_includes' + - $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: @@ -5617,13 +8524,20 @@ paths: x-operation-group: field_caps x-version-added: '1.0' description: Returns the information about the capabilities of fields among multiple indices. + 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.fields' - - $ref: '#/components/parameters/field_caps::query.ignore_unavailable' - $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: @@ -5634,13 +8548,20 @@ paths: x-operation-group: field_caps x-version-added: '1.0' description: Returns the information about the capabilities of fields among multiple indices. + 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.fields' - - $ref: '#/components/parameters/field_caps::query.ignore_unavailable' - $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: @@ -5652,13 +8573,20 @@ paths: x-operation-group: indices.flush x-version-added: '1.0' description: Performs the flush operation on one or more indices. + externalDocs: + url: https://opensearch.org/docs/latest parameters: - $ref: '#/components/parameters/indices.flush::path.index' - - $ref: '#/components/parameters/indices.flush::query.force' - - $ref: '#/components/parameters/indices.flush::query.wait_if_ongoing' - - $ref: '#/components/parameters/indices.flush::query.ignore_unavailable' - $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' @@ -5667,13 +8595,20 @@ paths: x-operation-group: indices.flush x-version-added: '1.0' description: Performs the flush operation on one or more indices. + externalDocs: + url: https://opensearch.org/docs/latest parameters: - $ref: '#/components/parameters/indices.flush::path.index' - - $ref: '#/components/parameters/indices.flush::query.force' - - $ref: '#/components/parameters/indices.flush::query.wait_if_ongoing' - - $ref: '#/components/parameters/indices.flush::query.ignore_unavailable' - $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' @@ -5683,16 +8618,23 @@ paths: x-operation-group: indices.forcemerge x-version-added: '1.0' description: Performs the force merge operation on one or more indices. + externalDocs: + url: https://opensearch.org/docs/latest parameters: - $ref: '#/components/parameters/indices.forcemerge::path.index' - - $ref: '#/components/parameters/indices.forcemerge::query.flush' - - $ref: '#/components/parameters/indices.forcemerge::query.primary_only' - - $ref: '#/components/parameters/indices.forcemerge::query.ignore_unavailable' - $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' @@ -5702,14 +8644,22 @@ paths: x-operation-group: indices.get_mapping x-version-added: '1.0' description: Returns mappings for one or more indices. + 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.ignore_unavailable' - $ref: '#/components/parameters/indices.get_mapping::query.allow_no_indices' - - $ref: '#/components/parameters/indices.get_mapping::query.expand_wildcards' - - $ref: '#/components/parameters/indices.get_mapping::query.master_timeout' - $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' @@ -5718,15 +8668,22 @@ paths: x-operation-group: indices.put_mapping x-version-added: '1.0' description: Updates the index mappings. + 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.timeout' - - $ref: '#/components/parameters/indices.put_mapping::query.master_timeout' - - $ref: '#/components/parameters/indices.put_mapping::query.cluster_manager_timeout' - - $ref: '#/components/parameters/indices.put_mapping::query.ignore_unavailable' - $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: @@ -5741,13 +8698,18 @@ paths: 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.timeout' - - $ref: '#/components/parameters/indices.put_mapping::query.master_timeout' - - $ref: '#/components/parameters/indices.put_mapping::query.cluster_manager_timeout' - - $ref: '#/components/parameters/indices.put_mapping::query.ignore_unavailable' - $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: @@ -5759,14 +8721,21 @@ paths: x-operation-group: indices.get_field_mapping x-version-added: '1.0' description: Returns mapping for one or more fields. + externalDocs: + url: https://opensearch.org/docs/latest/field-types/index/ parameters: - - $ref: '#/components/parameters/indices.get_field_mapping::path.index' - $ref: '#/components/parameters/indices.get_field_mapping::path.fields' - - $ref: '#/components/parameters/indices.get_field_mapping::query.include_defaults' - - $ref: '#/components/parameters/indices.get_field_mapping::query.ignore_unavailable' + - $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' @@ -5776,16 +8745,23 @@ paths: x-operation-group: mget x-version-added: '1.0' description: Allows to get multiple documents in one request. + 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.stored_fields' + - $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._source' - - $ref: '#/components/parameters/mget::query._source_excludes' - - $ref: '#/components/parameters/mget::query._source_includes' + - $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: @@ -5796,16 +8772,23 @@ paths: x-operation-group: mget x-version-added: '1.0' description: Allows to get multiple documents in one request. + 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.stored_fields' + - $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._source' - - $ref: '#/components/parameters/mget::query._source_excludes' - - $ref: '#/components/parameters/mget::query._source_includes' + - $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: @@ -5817,15 +8800,22 @@ paths: x-operation-group: msearch x-version-added: '1.0' description: Allows to execute several search operations in one request. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/multi-search/ parameters: - $ref: '#/components/parameters/msearch::path.index' - - $ref: '#/components/parameters/msearch::query.search_type' + - $ref: '#/components/parameters/msearch::query.ccs_minimize_roundtrips' - $ref: '#/components/parameters/msearch::query.max_concurrent_searches' - - $ref: '#/components/parameters/msearch::query.typed_keys' - - $ref: '#/components/parameters/msearch::query.pre_filter_shard_size' - $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.ccs_minimize_roundtrips' + - $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: @@ -5836,15 +8826,22 @@ paths: x-operation-group: msearch x-version-added: '1.0' description: Allows to execute several search operations in one request. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/multi-search/ parameters: - $ref: '#/components/parameters/msearch::path.index' - - $ref: '#/components/parameters/msearch::query.search_type' + - $ref: '#/components/parameters/msearch::query.ccs_minimize_roundtrips' - $ref: '#/components/parameters/msearch::query.max_concurrent_searches' - - $ref: '#/components/parameters/msearch::query.typed_keys' - - $ref: '#/components/parameters/msearch::query.pre_filter_shard_size' - $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.ccs_minimize_roundtrips' + - $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: @@ -5856,13 +8853,20 @@ paths: x-operation-group: msearch_template x-version-added: '1.0' description: Allows to execute several search template operations in one request. + 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.search_type' - - $ref: '#/components/parameters/msearch_template::query.typed_keys' + - $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.ccs_minimize_roundtrips' + - $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: @@ -5873,13 +8877,20 @@ paths: x-operation-group: msearch_template x-version-added: '1.0' description: Allows to execute several search template operations in one request. + 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.search_type' - - $ref: '#/components/parameters/msearch_template::query.typed_keys' + - $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.ccs_minimize_roundtrips' + - $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: @@ -5891,20 +8902,27 @@ paths: x-operation-group: mtermvectors x-version-added: '1.0' description: Returns multiple termvectors in one request. + externalDocs: + url: https://opensearch.org/docs/latest parameters: - $ref: '#/components/parameters/mtermvectors::path.index' - - $ref: '#/components/parameters/mtermvectors::query.ids' - - $ref: '#/components/parameters/mtermvectors::query.term_statistics' - $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.positions' - $ref: '#/components/parameters/mtermvectors::query.payloads' + - $ref: '#/components/parameters/mtermvectors::query.positions' - $ref: '#/components/parameters/mtermvectors::query.preference' - - $ref: '#/components/parameters/mtermvectors::query.routing' - $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: @@ -5915,20 +8933,27 @@ paths: x-operation-group: mtermvectors x-version-added: '1.0' description: Returns multiple termvectors in one request. + externalDocs: + url: https://opensearch.org/docs/latest parameters: - $ref: '#/components/parameters/mtermvectors::path.index' - - $ref: '#/components/parameters/mtermvectors::query.ids' - - $ref: '#/components/parameters/mtermvectors::query.term_statistics' - $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.positions' - $ref: '#/components/parameters/mtermvectors::query.payloads' + - $ref: '#/components/parameters/mtermvectors::query.positions' - $ref: '#/components/parameters/mtermvectors::query.preference' - - $ref: '#/components/parameters/mtermvectors::query.routing' - $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: @@ -5944,15 +8969,20 @@ paths: 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.timeout' - - $ref: '#/components/parameters/indices.open::query.master_timeout' - - $ref: '#/components/parameters/indices.open::query.ignore_unavailable' - $ref: '#/components/parameters/indices.open::query.allow_no_indices' - - $ref: '#/components/parameters/indices.open::query.expand_wildcards' - $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/indices.open::query.task_execution_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.open@200' @@ -5962,12 +8992,19 @@ paths: x-operation-group: rank_eval x-version-added: '1.0' description: Allows to evaluate the quality of ranked search results over a set of typical search queries. + 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.ignore_unavailable' - $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: @@ -5978,12 +9015,19 @@ paths: x-operation-group: rank_eval x-version-added: '1.0' description: Allows to evaluate the quality of ranked search results over a set of typical search queries. + 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.ignore_unavailable' - $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: @@ -5995,10 +9039,17 @@ paths: x-operation-group: indices.recovery x-version-added: '1.0' description: Returns information about ongoing index shard recoveries. + externalDocs: + url: https://opensearch.org/docs/latest parameters: - $ref: '#/components/parameters/indices.recovery::path.index' - - $ref: '#/components/parameters/indices.recovery::query.detailed' - $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' @@ -6008,11 +9059,18 @@ paths: x-operation-group: indices.refresh x-version-added: '1.0' description: Performs the refresh operation in one or more indices. + 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.ignore_unavailable' - $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' @@ -6021,11 +9079,18 @@ paths: x-operation-group: indices.refresh x-version-added: '1.0' description: Performs the refresh operation in one or more indices. + 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.ignore_unavailable' - $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' @@ -6035,52 +9100,61 @@ paths: x-operation-group: search x-version-added: '1.0' description: Returns results matching a query. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/search/ parameters: - $ref: '#/components/parameters/search::path.index' - - $ref: '#/components/parameters/search::query.analyzer' + - $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.explain' - - $ref: '#/components/parameters/search::query.stored_fields' - $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_unavailable' - $ref: '#/components/parameters/search::query.ignore_throttled' - - $ref: '#/components/parameters/search::query.allow_no_indices' - - $ref: '#/components/parameters/search::query.expand_wildcards' + - $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._source' - - $ref: '#/components/parameters/search::query._source_excludes' - - $ref: '#/components/parameters/search::query._source_includes' - - $ref: '#/components/parameters/search::query.terminate_after' - $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.allow_partial_search_results' - $ref: '#/components/parameters/search::query.typed_keys' - $ref: '#/components/parameters/search::query.version' - - $ref: '#/components/parameters/search::query.seq_no_primary_term' - - $ref: '#/components/parameters/search::query.request_cache' - - $ref: '#/components/parameters/search::query.batched_reduce_size' - - $ref: '#/components/parameters/search::query.max_concurrent_shard_requests' - - $ref: '#/components/parameters/search::query.pre_filter_shard_size' - - $ref: '#/components/parameters/search::query.rest_total_hits_as_int' - - $ref: '#/components/parameters/search::query.search_pipeline' - - $ref: '#/components/parameters/search::query.include_named_queries_score' + - $ref: '#/components/parameters/_global::query.pretty' + - $ref: '#/components/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: @@ -6091,57 +9165,113 @@ paths: x-operation-group: search x-version-added: '1.0' description: Returns results matching a query. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/search/ parameters: - $ref: '#/components/parameters/search::path.index' - - $ref: '#/components/parameters/search::query.analyzer' + - $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.explain' - - $ref: '#/components/parameters/search::query.stored_fields' - $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_unavailable' - $ref: '#/components/parameters/search::query.ignore_throttled' - - $ref: '#/components/parameters/search::query.allow_no_indices' - - $ref: '#/components/parameters/search::query.expand_wildcards' + - $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._source' - - $ref: '#/components/parameters/search::query._source_excludes' - - $ref: '#/components/parameters/search::query._source_includes' - - $ref: '#/components/parameters/search::query.terminate_after' - $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.allow_partial_search_results' - $ref: '#/components/parameters/search::query.typed_keys' - $ref: '#/components/parameters/search::query.version' - - $ref: '#/components/parameters/search::query.seq_no_primary_term' - - $ref: '#/components/parameters/search::query.request_cache' - - $ref: '#/components/parameters/search::query.batched_reduce_size' - - $ref: '#/components/parameters/search::query.max_concurrent_shard_requests' - - $ref: '#/components/parameters/search::query.pre_filter_shard_size' - - $ref: '#/components/parameters/search::query.rest_total_hits_as_int' - - $ref: '#/components/parameters/search::query.search_pipeline' - - $ref: '#/components/parameters/search::query.include_named_queries_score' + - $ref: '#/components/parameters/_global::query.pretty' + - $ref: '#/components/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' + /{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. + 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' + 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. + 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' /{index}/_search/point_in_time: post: operationId: create_pit.0 @@ -6153,10 +9283,15 @@ paths: 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/create_pit::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/create_pit@200' @@ -6166,21 +9301,28 @@ paths: x-operation-group: search_template x-version-added: '1.0' description: Allows to use the Mustache language to pre-render a search definition. + 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.ignore_unavailable' - - $ref: '#/components/parameters/search_template::query.ignore_throttled' - $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.explain' - - $ref: '#/components/parameters/search_template::query.profile' - $ref: '#/components/parameters/search_template::query.typed_keys' - - $ref: '#/components/parameters/search_template::query.rest_total_hits_as_int' - - $ref: '#/components/parameters/search_template::query.ccs_minimize_roundtrips' + - $ref: '#/components/parameters/_global::query.pretty' + - $ref: '#/components/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: @@ -6191,71 +9333,52 @@ paths: x-operation-group: search_template x-version-added: '1.0' description: Allows to use the Mustache language to pre-render a search definition. + 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.ignore_unavailable' - - $ref: '#/components/parameters/search_template::query.ignore_throttled' - $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.explain' - - $ref: '#/components/parameters/search_template::query.profile' - $ref: '#/components/parameters/search_template::query.typed_keys' - - $ref: '#/components/parameters/search_template::query.rest_total_hits_as_int' - - $ref: '#/components/parameters/search_template::query.ccs_minimize_roundtrips' + - $ref: '#/components/parameters/_global::query.pretty' + - $ref: '#/components/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' - /{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. - parameters: - - $ref: '#/components/parameters/search_shards::path.index' - - $ref: '#/components/parameters/search_shards::query.preference' - - $ref: '#/components/parameters/search_shards::query.routing' - - $ref: '#/components/parameters/search_shards::query.local' - - $ref: '#/components/parameters/search_shards::query.ignore_unavailable' - - $ref: '#/components/parameters/search_shards::query.allow_no_indices' - - $ref: '#/components/parameters/search_shards::query.expand_wildcards' - 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. - parameters: - - $ref: '#/components/parameters/search_shards::path.index' - - $ref: '#/components/parameters/search_shards::query.preference' - - $ref: '#/components/parameters/search_shards::query.routing' - - $ref: '#/components/parameters/search_shards::query.local' - - $ref: '#/components/parameters/search_shards::query.ignore_unavailable' - - $ref: '#/components/parameters/search_shards::query.allow_no_indices' - - $ref: '#/components/parameters/search_shards::query.expand_wildcards' - responses: - '200': - $ref: '#/components/responses/search_shards@200' /{index}/_segments: get: operationId: indices.segments.1 x-operation-group: indices.segments x-version-added: '1.0' description: Provides low-level information about segments in a Lucene index. + externalDocs: + url: https://opensearch.org/docs/latest parameters: - $ref: '#/components/parameters/indices.segments::path.index' - - $ref: '#/components/parameters/indices.segments::query.ignore_unavailable' - $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' @@ -6265,16 +9388,23 @@ paths: x-operation-group: indices.get_settings x-version-added: '1.0' description: Returns settings for one or more indices. + 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.master_timeout' - - $ref: '#/components/parameters/indices.get_settings::query.cluster_manager_timeout' - - $ref: '#/components/parameters/indices.get_settings::query.ignore_unavailable' - $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.local' + - $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' @@ -6283,16 +9413,23 @@ paths: x-operation-group: indices.put_settings x-version-added: '1.0' description: Updates the index settings. + 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.master_timeout' - - $ref: '#/components/parameters/indices.put_settings::query.cluster_manager_timeout' - - $ref: '#/components/parameters/indices.put_settings::query.timeout' - - $ref: '#/components/parameters/indices.put_settings::query.preserve_existing' - - $ref: '#/components/parameters/indices.put_settings::query.ignore_unavailable' - $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: @@ -6304,17 +9441,24 @@ paths: x-operation-group: indices.get_settings x-version-added: '1.0' description: Returns settings for one or more indices. + 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.master_timeout' - - $ref: '#/components/parameters/indices.get_settings::query.cluster_manager_timeout' - - $ref: '#/components/parameters/indices.get_settings::query.ignore_unavailable' - $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.local' + - $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' @@ -6324,12 +9468,19 @@ paths: x-operation-group: indices.shard_stores x-version-added: '1.0' description: Provides store information for shard copies of indices. + externalDocs: + url: https://opensearch.org/docs/latest parameters: - $ref: '#/components/parameters/indices.shard_stores::path.index' - - $ref: '#/components/parameters/indices.shard_stores::query.status' - - $ref: '#/components/parameters/indices.shard_stores::query.ignore_unavailable' - $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' @@ -6339,16 +9490,23 @@ paths: x-operation-group: indices.shrink x-version-added: '1.0' description: Allow to shrink an existing index into a new index with fewer primary shards. + 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.timeout' - $ref: '#/components/parameters/indices.shrink::query.master_timeout' - - $ref: '#/components/parameters/indices.shrink::query.cluster_manager_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/indices.shrink::query.task_execution_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.shrink' responses: @@ -6364,13 +9522,18 @@ paths: 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.timeout' - $ref: '#/components/parameters/indices.shrink::query.master_timeout' - - $ref: '#/components/parameters/indices.shrink::query.cluster_manager_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/indices.shrink::query.task_execution_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.shrink' responses: @@ -6387,15 +9550,20 @@ paths: 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._source' - - $ref: '#/components/parameters/get_source::query._source_excludes' - - $ref: '#/components/parameters/get_source::query._source_includes' - $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' @@ -6409,15 +9577,20 @@ paths: 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._source' - - $ref: '#/components/parameters/exists_source::query._source_excludes' - - $ref: '#/components/parameters/exists_source::query._source_includes' - $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' @@ -6427,16 +9600,23 @@ paths: x-operation-group: indices.split x-version-added: '1.0' description: Allows you to split an existing index into a new index with more primary shards. + 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.timeout' - $ref: '#/components/parameters/indices.split::query.master_timeout' - - $ref: '#/components/parameters/indices.split::query.cluster_manager_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/indices.split::query.task_execution_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.split' responses: @@ -6452,13 +9632,18 @@ paths: 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.timeout' - $ref: '#/components/parameters/indices.split::query.master_timeout' - - $ref: '#/components/parameters/indices.split::query.cluster_manager_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/indices.split::query.task_execution_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.split' responses: @@ -6470,17 +9655,24 @@ paths: x-operation-group: indices.stats x-version-added: '1.0' description: Provides statistics on operations happening in an index. + 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.level' - $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.expand_wildcards' - - $ref: '#/components/parameters/indices.stats::query.forbid_closed_indices' + - $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' @@ -6490,18 +9682,25 @@ paths: x-operation-group: indices.stats x-version-added: '1.0' description: Provides statistics on operations happening in an index. + 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.level' - $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.expand_wildcards' - - $ref: '#/components/parameters/indices.stats::query.forbid_closed_indices' + - $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' @@ -6515,17 +9714,22 @@ paths: url: https://opensearch.org/docs/latest parameters: - $ref: '#/components/parameters/termvectors::path.index' - - $ref: '#/components/parameters/termvectors::query.term_statistics' - $ref: '#/components/parameters/termvectors::query.field_statistics' - $ref: '#/components/parameters/termvectors::query.fields' - $ref: '#/components/parameters/termvectors::query.offsets' - - $ref: '#/components/parameters/termvectors::query.positions' - $ref: '#/components/parameters/termvectors::query.payloads' + - $ref: '#/components/parameters/termvectors::query.positions' - $ref: '#/components/parameters/termvectors::query.preference' - - $ref: '#/components/parameters/termvectors::query.routing' - $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: @@ -6536,19 +9740,26 @@ paths: x-operation-group: termvectors x-version-added: '1.0' description: Returns information and statistics about terms in the fields of a particular document. + externalDocs: + url: https://opensearch.org/docs/latest parameters: - $ref: '#/components/parameters/termvectors::path.index' - - $ref: '#/components/parameters/termvectors::query.term_statistics' - $ref: '#/components/parameters/termvectors::query.field_statistics' - $ref: '#/components/parameters/termvectors::query.fields' - $ref: '#/components/parameters/termvectors::query.offsets' - - $ref: '#/components/parameters/termvectors::query.positions' - $ref: '#/components/parameters/termvectors::query.payloads' + - $ref: '#/components/parameters/termvectors::query.positions' - $ref: '#/components/parameters/termvectors::query.preference' - - $ref: '#/components/parameters/termvectors::query.routing' - $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: @@ -6560,20 +9771,27 @@ paths: x-operation-group: termvectors x-version-added: '1.0' description: Returns information and statistics about terms in the fields of a particular document. + externalDocs: + url: https://opensearch.org/docs/latest parameters: - - $ref: '#/components/parameters/termvectors::path.index' - $ref: '#/components/parameters/termvectors::path.id' - - $ref: '#/components/parameters/termvectors::query.term_statistics' + - $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.positions' - $ref: '#/components/parameters/termvectors::query.payloads' + - $ref: '#/components/parameters/termvectors::query.positions' - $ref: '#/components/parameters/termvectors::query.preference' - - $ref: '#/components/parameters/termvectors::query.routing' - $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: @@ -6584,53 +9802,32 @@ paths: x-operation-group: termvectors x-version-added: '1.0' description: Returns information and statistics about terms in the fields of a particular document. + externalDocs: + url: https://opensearch.org/docs/latest parameters: - - $ref: '#/components/parameters/termvectors::path.index' - $ref: '#/components/parameters/termvectors::path.id' - - $ref: '#/components/parameters/termvectors::query.term_statistics' + - $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.positions' - $ref: '#/components/parameters/termvectors::query.payloads' + - $ref: '#/components/parameters/termvectors::query.positions' - $ref: '#/components/parameters/termvectors::query.preference' - - $ref: '#/components/parameters/termvectors::query.routing' - $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' - /{index}/_update/{id}: - post: - operationId: update.0 - x-operation-group: update - x-version-added: '1.0' - description: Updates a document with a script or partial document. - 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.wait_for_active_shards' - - $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.lang' - - $ref: '#/components/parameters/update::query.refresh' - - $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.if_seq_no' - - $ref: '#/components/parameters/update::query.if_primary_term' - - $ref: '#/components/parameters/update::query.require_alias' - requestBody: - $ref: '#/components/requestBodies/update' - responses: - '200': - $ref: '#/components/responses/update@200' /{index}/_update_by_query: post: operationId: update_by_query.0 @@ -6643,56 +9840,101 @@ paths: 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.analyzer' + - $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.allow_no_indices' - - $ref: '#/components/parameters/update_by_query::query.conflicts' - - $ref: '#/components/parameters/update_by_query::query.expand_wildcards' - $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.search_type' + - $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.max_docs' + - $ref: '#/components/parameters/update_by_query::query.slices' - $ref: '#/components/parameters/update_by_query::query.sort' - - $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.terminate_after' - $ref: '#/components/parameters/update_by_query::query.stats' - - $ref: '#/components/parameters/update_by_query::query.version' - - $ref: '#/components/parameters/update_by_query::query.request_cache' - - $ref: '#/components/parameters/update_by_query::query.refresh' + - $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.scroll_size' - $ref: '#/components/parameters/update_by_query::query.wait_for_completion' - - $ref: '#/components/parameters/update_by_query::query.requests_per_second' - - $ref: '#/components/parameters/update_by_query::query.slices' + - $ref: '#/components/parameters/_global::query.pretty' + - $ref: '#/components/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' + /{index}/_update/{id}: + post: + operationId: update.0 + x-operation-group: update + x-version-added: '1.0' + description: Updates a document with a script or partial document. + 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' + requestBody: + $ref: '#/components/requestBodies/update' + responses: + '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. + externalDocs: + url: https://opensearch.org/docs/latest parameters: - $ref: '#/components/parameters/indices.get_upgrade::path.index' - - $ref: '#/components/parameters/indices.get_upgrade::query.ignore_unavailable' - $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' @@ -6701,13 +9943,20 @@ paths: x-operation-group: indices.upgrade x-version-added: '1.0' 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.wait_for_completion' - $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' @@ -6717,20 +9966,27 @@ paths: x-operation-group: indices.validate_query x-version-added: '1.0' description: Allows a user to validate a potentially expensive query without executing it. + externalDocs: + url: https://opensearch.org/docs/latest parameters: - $ref: '#/components/parameters/indices.validate_query::path.index' - - $ref: '#/components/parameters/indices.validate_query::query.explain' - - $ref: '#/components/parameters/indices.validate_query::query.ignore_unavailable' + - $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.expand_wildcards' - - $ref: '#/components/parameters/indices.validate_query::query.q' - - $ref: '#/components/parameters/indices.validate_query::query.analyzer' - $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/indices.validate_query::query.all_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.validate_query' responses: @@ -6741,113 +9997,1589 @@ paths: x-operation-group: indices.validate_query x-version-added: '1.0' description: Allows a user to validate a potentially expensive query without executing it. + externalDocs: + url: https://opensearch.org/docs/latest parameters: - $ref: '#/components/parameters/indices.validate_query::path.index' - - $ref: '#/components/parameters/indices.validate_query::query.explain' - - $ref: '#/components/parameters/indices.validate_query::query.ignore_unavailable' + - $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.expand_wildcards' - - $ref: '#/components/parameters/indices.validate_query::query.q' - - $ref: '#/components/parameters/indices.validate_query::query.analyzer' - $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/indices.validate_query::query.all_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.validate_query' responses: '200': $ref: '#/components/responses/indices.validate_query@200' -components: - parameters: - 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' - style: simple - 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' - style: form - 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' - style: form - 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' - style: form - bulk::query.pipeline: - in: query - name: pipeline - description: |- - ID of the pipeline to use to preprocess incoming documents. - If the index has a default ingest pipeline specified, then setting the value to `_none` disables the default ingest pipeline for this request. - If a final pipeline is configured it will always run, regardless of the value of this parameter. - schema: - type: string - style: form - 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' - style: form - bulk::query.require_alias: - in: query - name: require_alias - description: If `true`, the request’s actions must target an index alias. - schema: - type: boolean - style: form - bulk::query.routing: - in: query - name: routing - description: Custom value used to route operations to a specific shard. - schema: - $ref: '#/components/schemas/_common:Routing' - style: form - 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' - style: form - 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: - 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' - style: form - cat.aliases::path.name: + /_opendistro/_knn/stats/{stat}: + get: + operationId: knn.stats.1_superseded + x-operation-group: knn.stats + x-version-added: '1.0' + description: Provides information about the current status of the k-NN plugin. + 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' + responses: + '200': + $ref: '#/components/responses/knn.stats@200' + deprecated: true + x-ignorable: true + /_opendistro/_knn/warmup/{index}: + get: + operationId: knn.warmup.0_superseded + x-operation-group: knn.warmup + x-version-added: '1.0' + description: Preloads native library files into memory, reducing initial search latency for specified indexes. + 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' + responses: + '200': + $ref: '#/components/responses/knn.warmup@200' + deprecated: true + x-ignorable: true + /_opendistro/_knn/{nodeId}/stats/{stat}: + get: + operationId: knn.stats.3_superseded + x-operation-group: knn.stats + x-version-added: '1.0' + description: Provides information about the current status of the k-NN plugin. + 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' + responses: + '200': + $ref: '#/components/responses/knn.stats@200' + deprecated: true + x-ignorable: true + /_opendistro/_rollup/jobs/{rollupID}: + get: + operationId: rollups.get.0_superseded + x-operation-group: rollups.get + x-version-added: '1.0' + description: Get an index rollup. + 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' + responses: + '200': + $ref: '#/components/responses/rollups.get@200' + deprecated: true + x-ignorable: true + put: + operationId: rollups.put.0_superseded + x-operation-group: rollups.put + x-version-added: '1.0' + description: Create or update index rollup. + externalDocs: + 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' + 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' + requestBody: + $ref: '#/components/requestBodies/rollups.put' + deprecated: true + x-ignorable: true + delete: + operationId: rollups.delete.0_superseded + x-operation-group: rollups.delete + x-version-added: '1.0' + description: Delete index rollup. + externalDocs: + 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' + 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' + deprecated: true + x-ignorable: true + /_opendistro/_rollup/jobs/{rollupID}/_explain: + get: + operationId: rollups.explain.0_superseded + x-operation-group: rollups.explain + x-version-added: '1.0' + description: Get a rollup's current status. + 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' + responses: + '200': + $ref: '#/components/responses/rollups.explain@200' + deprecated: true + x-ignorable: true + /_opendistro/_rollup/jobs/{rollupID}/_start: + post: + operationId: rollups.start.0_superseded + x-operation-group: rollups.start + x-version-added: '1.0' + description: Start rollup. + 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' + responses: + '200': + $ref: '#/components/responses/rollups.start@200' + deprecated: true + x-ignorable: true + /_opendistro/_rollup/jobs/{rollupID}/_stop: + post: + operationId: rollups.stop.0_superseded + x-operation-group: rollups.stop + x-version-added: '1.0' + description: Stop rollup. + 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' + responses: + '200': + $ref: '#/components/responses/rollups.stop@200' + deprecated: true + x-ignorable: true + /_opendistro/_security/api/account: + get: + operationId: security.get_account_details.0_superseded + x-operation-group: security.get_account_details + x-version-added: '1.0' + description: Returns account details for the current user. + externalDocs: + url: https://opensearch.org/docs/latest/security/access-control/api/#get-account-details + responses: + '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' + deprecated: true + x-ignorable: true + put: + operationId: security.change_password.0_superseded + x-operation-group: security.change_password + x-version-added: '1.0' + description: Changes the password for the current user. + externalDocs: + url: https://opensearch.org/docs/latest/security/access-control/api/#change-password + requestBody: + $ref: '#/components/requestBodies/security.change_password' + responses: + '200': + $ref: '#/components/responses/security.change_password@200' + parameters: + - $ref: '#/components/parameters/_global::query.pretty' + - $ref: '#/components/parameters/_global::query.human' + - $ref: '#/components/parameters/_global::query.error_trace' + - $ref: '#/components/parameters/_global::query.source' + - $ref: '#/components/parameters/_global::query.filter_path' + deprecated: true + x-ignorable: true + /_opendistro/_security/api/actiongroups/{name}: + get: + operationId: security.get_action_group.0_superseded + x-operation-group: security.get_action_group + x-version-added: '1.0' + description: Retrieves one action group. + 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' + responses: + '200': + $ref: '#/components/responses/security.get_action_group@200' + deprecated: true + x-ignorable: true + put: + operationId: security.create_action_group.0_superseded + x-operation-group: security.create_action_group + x-version-added: '1.0' + description: Creates or replaces the specified action group. + 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' + requestBody: + $ref: '#/components/requestBodies/security.create_action_group' + responses: + '200': + $ref: '#/components/responses/security.create_action_group@200' + deprecated: true + x-ignorable: true + patch: + operationId: security.patch_action_group.0_superseded + x-operation-group: security.patch_action_group + x-version-added: '1.0' + description: Updates individual attributes of an action group. + 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' + requestBody: + $ref: '#/components/requestBodies/security.patch_action_group' + responses: + '200': + $ref: '#/components/responses/security.patch_action_group@200' + deprecated: true + x-ignorable: true + delete: + operationId: security.delete_action_group.0_superseded + x-operation-group: security.delete_action_group + x-version-added: '1.0' + description: Delete a specified action group. + 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' + responses: + '200': + $ref: '#/components/responses/security.delete_action_group@200' + deprecated: true + x-ignorable: true + /_opendistro/_security/api/audit/config: + put: + operationId: security.update_audit_configuration.0_superseded + x-operation-group: security.update_audit_configuration + x-version-added: '1.0' + description: Updates the audit configuration. + externalDocs: + url: https://opensearch.org/docs/latest/security/access-control/api/#audit-logs + requestBody: + $ref: '#/components/requestBodies/security.update_audit_configuration' + responses: + '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' + deprecated: true + x-ignorable: true + /_opendistro/_security/api/authtoken: + post: + operationId: security.authtoken.0_superseded + x-operation-group: security.authtoken + x-version-added: '1.0' + description: Returns the authorization token. + responses: + '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' + deprecated: true + x-ignorable: true + /_opendistro/_security/api/cache: + get: + operationId: security.cache.1_superseded + x-operation-group: security.cache + x-ignorable: true + x-version-added: '1.0' + description: Not supported for cache API. + responses: + '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' + deprecated: true + post: + operationId: security.cache.2_superseded + x-operation-group: security.cache + x-version-added: '1.0' + x-ignorable: true + description: Not supported for cache API. + responses: + '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' + deprecated: true + put: + operationId: security.cache.3_superseded + x-operation-group: security.cache + x-version-added: '1.0' + x-ignorable: true + description: Not supported for cache API. + responses: + '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' + deprecated: true + delete: + operationId: security.flush_cache.0_superseded + x-operation-group: security.flush_cache + x-version-added: '1.0' + description: Flushes the Security plugin user, authentication, and authorization cache. + externalDocs: + url: https://opensearch.org/docs/latest/security/access-control/api/#flush-cache + responses: + '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' + deprecated: true + x-ignorable: true + /_opendistro/_security/api/internalusers/{name}: + get: + operationId: security.get_user.0_superseded + x-operation-group: security.get_user + x-version-added: '1.0' + description: Retrieve one internal user. + 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' + responses: + '200': + $ref: '#/components/responses/security.get_user@200' + deprecated: true + x-ignorable: true + put: + operationId: security.create_user.0_superseded + x-operation-group: security.create_user + x-version-added: '1.0' + description: Creates or replaces the specified user. + 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' + requestBody: + $ref: '#/components/requestBodies/security.create_user' + responses: + '200': + $ref: '#/components/responses/security.create_user@200' + deprecated: true + x-ignorable: true + patch: + operationId: security.patch_user.0_superseded + x-operation-group: security.patch_user + x-version-added: '1.0' + description: Updates individual attributes of an internal user. + 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' + requestBody: + $ref: '#/components/requestBodies/security.patch_user' + responses: + '200': + $ref: '#/components/responses/security.patch_user@200' + deprecated: true + x-ignorable: true + delete: + operationId: security.delete_user.0_superseded + x-operation-group: security.delete_user + x-version-added: '1.0' + description: Delete the specified user. + 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' + responses: + '200': + $ref: '#/components/responses/security.delete_user@200' + deprecated: true + x-ignorable: true + /_opendistro/_security/api/internalusers/{name}/authtoken: + post: + operationId: security.generate_user_token.0_superseded + x-operation-group: security.generate_user_token + x-version-added: '1.0' + 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' + responses: + '200': + $ref: '#/components/responses/security.generate_user_token@200' + '400': + $ref: '#/components/responses/security.generate_user_token@400' + deprecated: true + x-ignorable: true + /_opendistro/_security/api/migrate: + post: + operationId: security.migrate.0_superseded + x-operation-group: security.migrate + x-version-added: '1.0' + description: Migrates security configuration from v6 to v7. + responses: + '200': + $ref: '#/components/responses/security.migrate@200' + '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' + deprecated: true + x-ignorable: true + /_opendistro/_security/api/permissionsinfo: + get: + operationId: security.get_permissions_info.0_superseded + x-operation-group: security.get_permissions_info + x-version-added: '1.0' + description: Gets the evaluated REST API permissions for the currently logged in user. + responses: + '200': + $ref: '#/components/responses/security.get_permissions_info@200' + '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' + deprecated: true + x-ignorable: true + /_opendistro/_security/api/roles/{name}: + get: + operationId: security.get_role.0_superseded + x-operation-group: security.get_role + x-version-added: '1.0' + description: Retrieves one role. + 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' + responses: + '200': + $ref: '#/components/responses/security.get_role@200' + deprecated: true + x-ignorable: true + put: + operationId: security.create_role.0_superseded + x-operation-group: security.create_role + x-version-added: '1.0' + description: Creates or replaces the specified role. + 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' + requestBody: + $ref: '#/components/requestBodies/security.create_role' + responses: + '200': + $ref: '#/components/responses/security.create_role@200' + deprecated: true + x-ignorable: true + patch: + operationId: security.patch_role.0_superseded + x-operation-group: security.patch_role + x-version-added: '1.0' + description: Updates individual attributes of a role. + 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' + requestBody: + $ref: '#/components/requestBodies/security.patch_role' + responses: + '200': + $ref: '#/components/responses/security.patch_role@200' + '400': + $ref: '#/components/responses/security.patch_role@400' + deprecated: true + x-ignorable: true + delete: + operationId: security.delete_role.0_superseded + x-operation-group: security.delete_role + x-version-added: '1.0' + description: Delete the specified role. + 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' + responses: + '200': + $ref: '#/components/responses/security.delete_role@200' + deprecated: true + x-ignorable: true + /_opendistro/_security/api/rolesmapping/{name}: + get: + operationId: security.get_role_mapping.0_superseded + x-operation-group: security.get_role_mapping + x-version-added: '1.0' + description: Retrieves one role mapping. + 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' + responses: + '200': + $ref: '#/components/responses/security.get_role_mapping@200' + deprecated: true + x-ignorable: true + put: + operationId: security.create_role_mapping.0_superseded + x-operation-group: security.create_role_mapping + x-version-added: '1.0' + description: Creates or replaces the specified role mapping. + 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' + requestBody: + $ref: '#/components/requestBodies/security.create_role_mapping' + responses: + '200': + $ref: '#/components/responses/security.create_role_mapping@200' + deprecated: true + x-ignorable: true + patch: + operationId: security.patch_role_mapping.0_superseded + x-operation-group: security.patch_role_mapping + x-version-added: '1.0' + description: Updates individual attributes of a role mapping. + 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' + requestBody: + $ref: '#/components/requestBodies/security.patch_role_mapping' + responses: + '200': + $ref: '#/components/responses/security.patch_role_mapping@200' + '400': + $ref: '#/components/responses/security.patch_role_mapping@400' + deprecated: true + x-ignorable: true + delete: + operationId: security.delete_role_mapping.0_superseded + x-operation-group: security.delete_role_mapping + x-version-added: '1.0' + description: Deletes the specified role mapping. + 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' + responses: + '200': + $ref: '#/components/responses/security.delete_role_mapping@200' + deprecated: true + x-ignorable: true + /_opendistro/_security/api/securityconfig: + get: + operationId: security.get_configuration.0_superseded + x-operation-group: security.get_configuration + x-version-added: '1.0' + description: Returns the current Security plugin configuration in JSON format. + externalDocs: + url: https://opensearch.org/docs/latest/security/access-control/api/#get-configuration + responses: + '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' + deprecated: true + x-ignorable: true + patch: + operationId: security.patch_configuration.0_superseded + x-operation-group: security.patch_configuration + x-version-added: '1.0' + 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' + parameters: + - $ref: '#/components/parameters/_global::query.pretty' + - $ref: '#/components/parameters/_global::query.human' + - $ref: '#/components/parameters/_global::query.error_trace' + - $ref: '#/components/parameters/_global::query.source' + - $ref: '#/components/parameters/_global::query.filter_path' + deprecated: true + x-ignorable: true + /_opendistro/_security/api/securityconfig/config: + put: + operationId: security.update_configuration.0_superseded + x-operation-group: security.update_configuration + x-version-added: '1.0' + 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' + parameters: + - $ref: '#/components/parameters/_global::query.pretty' + - $ref: '#/components/parameters/_global::query.human' + - $ref: '#/components/parameters/_global::query.error_trace' + - $ref: '#/components/parameters/_global::query.source' + - $ref: '#/components/parameters/_global::query.filter_path' + deprecated: true + x-ignorable: true + /_opendistro/_security/api/ssl/certs: + get: + operationId: security.get_certificates.0_superseded + x-operation-group: security.get_certificates + x-version-added: '1.0' + description: Retrieves the cluster security certificates. + externalDocs: + url: https://opensearch.org/docs/latest/security/access-control/api/#get-certificates + responses: + '200': + $ref: '#/components/responses/security.get_certificates@200' + '400': + $ref: '#/components/responses/security.get_certificates@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' + deprecated: true + x-ignorable: true + /_opendistro/_security/api/ssl/transport/reloadcerts: + put: + operationId: security.reload_transport_certificates.0_superseded + x-operation-group: security.reload_transport_certificates + x-version-added: '1.0' + description: Reload Transport layer communication certificates. + externalDocs: + url: https://opensearch.org/docs/latest/security/access-control/api/#reload-transport-certificates + responses: + '200': + $ref: '#/components/responses/security.reload_transport_certificates@200' + '400': + $ref: '#/components/responses/security.reload_transport_certificates@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' + deprecated: true + x-ignorable: true + /_opendistro/_security/api/ssl/http/reloadcerts: + put: + operationId: security.reload_http_certificates.0_superseded + x-operation-group: security.reload_http_certificates + x-version-added: '1.0' + description: Reload HTTP layer communication certificates. + externalDocs: + url: https://opensearch.org/docs/latest/security/access-control/api/#reload-http-certificates + responses: + '200': + $ref: '#/components/responses/security.reload_http_certificates@200' + '400': + $ref: '#/components/responses/security.reload_http_certificates@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' + deprecated: true + x-ignorable: true + /_opendistro/_security/api/nodesdn/{cluster_name}: + get: + operationId: security.get_distinguished_name.0_superseded + x-operation-group: security.get_distinguished_name + x-version-added: '1.0' + description: Retrieves distinguished names. Only accessible to super-admins and with rest-api permissions when enabled. + externalDocs: + url: https://opensearch.org/docs/latest/security/access-control/api/#get-distinguished-names + 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' + responses: + '200': + $ref: '#/components/responses/security.get_distinguished_name@200' + '403': + $ref: '#/components/responses/security.get_distinguished_name@403' + deprecated: true + x-ignorable: true + put: + operationId: security.update_distinguished_name.0_superseded + x-operation-group: security.update_distinguished_name + x-version-added: '1.0' + description: Adds or updates the specified distinguished names in the cluster or node allow list. Only accessible to super-admins and with rest-api permissions when enabled. + externalDocs: + url: https://opensearch.org/docs/latest/security/access-control/api/#update-distinguished-names + 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' + requestBody: + $ref: '#/components/requestBodies/security.update_distinguished_name' + responses: + '200': + $ref: '#/components/responses/security.update_distinguished_name@200' + '403': + $ref: '#/components/responses/security.update_distinguished_name@403' + deprecated: true + x-ignorable: true + patch: + operationId: security.patch_distinguished_name.0_superseded + x-operation-group: security.patch_distinguished_name + x-version-added: '1.0' + 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' + requestBody: + $ref: '#/components/requestBodies/security.patch_distinguished_name' + responses: + '200': + $ref: '#/components/responses/security.patch_distinguished_name@200' + '403': + $ref: '#/components/responses/security.patch_distinguished_name@403' + deprecated: true + x-ignorable: true + delete: + operationId: security.delete_distinguished_name.0_superseded + x-operation-group: security.delete_distinguished_name + x-version-added: '1.0' + description: Deletes all distinguished names in the specified cluster or node allow list. Only accessible to super-admins and with rest-api permissions when enabled. + externalDocs: + url: https://opensearch.org/docs/latest/security/access-control/api/#delete-distinguished-names + 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' + responses: + '200': + $ref: '#/components/responses/security.delete_distinguished_name@200' + '403': + $ref: '#/components/responses/security.delete_distinguished_name@403' + deprecated: true + x-ignorable: true + /_opendistro/_security/api/tenancy/config: + get: + operationId: security.get_tenancy_config.0_superseded + x-operation-group: security.get_tenancy_config + x-version-added: '2.7' + description: Retrieves multi-tenancy configuration. Only accessible to admins and users with REST API permissions. + externalDocs: + url: https://opensearch.org/docs/latest/security/multi-tenancy/dynamic-config/#configuring-multi-tenancy-with-the-rest-api + responses: + '200': + $ref: '#/components/responses/security.get_tenancy_config@200' + '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' + deprecated: true + x-ignorable: true + put: + operationId: security.create_update_tenancy_config.0_superseded + x-operation-group: security.create_update_tenancy_config + x-version-added: '2.7' + description: Creates or replaces the multi-tenancy configuration. Only accessible to admins and users with REST API permissions. + externalDocs: + url: https://opensearch.org/docs/latest/security/multi-tenancy/dynamic-config/#configuring-multi-tenancy-with-the-rest-api + requestBody: + $ref: '#/components/requestBodies/security.create_update_tenancy_config' + responses: + '200': + $ref: '#/components/responses/security.create_update_tenancy_config@200' + '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' + deprecated: true + x-ignorable: true + /_opendistro/_security/api/tenants: + get: + operationId: security.get_tenants.0_superseded + x-operation-group: security.get_tenants + x-version-added: '1.0' + description: Retrieves all tenants. + externalDocs: + url: https://opensearch.org/docs/latest/security/access-control/api/#get-tenants + responses: + '200': + $ref: '#/components/responses/security.get_tenants@200' + '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' + deprecated: true + x-ignorable: true + patch: + operationId: security.patch_tenants.0_superseded + x-operation-group: security.patch_tenants + x-version-added: '1.0' + description: Add, delete, or modify multiple tenants in a single call. + externalDocs: + url: https://opensearch.org/docs/latest/security/access-control/api/#patch-tenants + requestBody: + $ref: '#/components/requestBodies/security.patch_tenants' + responses: + '200': + $ref: '#/components/responses/security.patch_tenants@200' + '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' + deprecated: true + x-ignorable: true + /_opendistro/_security/api/tenants/{name}: + get: + operationId: security.get_tenant.0_superseded + x-operation-group: security.get_tenant + x-version-added: '1.0' + description: Retrieves one tenant. + 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' + responses: + '200': + $ref: '#/components/responses/security.get_tenant@200' + deprecated: true + x-ignorable: true + put: + operationId: security.create_tenant.0_superseded + x-operation-group: security.create_tenant + x-version-added: '1.0' + description: Creates or replaces the specified tenant. + 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' + requestBody: + $ref: '#/components/requestBodies/security.create_tenant' + responses: + '200': + $ref: '#/components/responses/security.create_tenant@200' + '400': + $ref: '#/components/responses/security.create_tenant@400' + deprecated: true + x-ignorable: true + patch: + operationId: security.patch_tenant.0_superseded + x-operation-group: security.patch_tenant + x-version-added: '1.0' + description: Add, delete, or modify a single tenant. + 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' + requestBody: + $ref: '#/components/requestBodies/security.patch_tenant' + responses: + '200': + $ref: '#/components/responses/security.patch_tenant@200' + '400': + $ref: '#/components/responses/security.patch_tenant@400' + deprecated: true + x-ignorable: true + delete: + operationId: security.delete_tenant.0_superseded + x-operation-group: security.delete_tenant + x-version-added: '1.0' + description: Delete the specified tenant. + 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' + responses: + '200': + $ref: '#/components/responses/security.delete_tenant@200' + '400': + $ref: '#/components/responses/security.delete_tenant@400' + deprecated: true + x-ignorable: true + /_opendistro/_security/api/user: + get: + operationId: security.get_users_legacy.0_superseded + x-operation-group: security.get_users_legacy + x-version-added: '1.0' + description: Retrieve all internal users. Legacy API. + responses: + '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' + deprecated: true + x-ignorable: true + /_opendistro/_security/api/user/{name}: + get: + operationId: security.get_user_legacy.0_superseded + x-operation-group: security.get_user_legacy + x-version-added: '1.0' + 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' + responses: + '200': + $ref: '#/components/responses/security.get_user_legacy@200' + deprecated: true + x-ignorable: true + put: + operationId: security.create_user_legacy.0_superseded + x-operation-group: security.create_user_legacy + x-version-added: '1.0' + 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' + requestBody: + $ref: '#/components/requestBodies/security.create_user_legacy' + responses: + '200': + $ref: '#/components/responses/security.create_user_legacy@200' + deprecated: true + x-ignorable: true + delete: + operationId: security.delete_user_legacy.0_superseded + x-operation-group: security.delete_user_legacy + x-version-added: '1.0' + 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' + responses: + '200': + $ref: '#/components/responses/security.delete_user_legacy@200' + deprecated: true + x-ignorable: true + /_opendistro/_security/api/user/{name}/authtoken: + post: + operationId: security.generate_user_token_legacy.0_superseded + x-operation-group: security.generate_user_token_legacy + x-version-added: '1.0' + description: Generates authorization token for the given user. Legacy API. + 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' + responses: + '200': + $ref: '#/components/responses/security.generate_user_token_legacy@200' + '400': + $ref: '#/components/responses/security.generate_user_token_legacy@400' + deprecated: true + x-ignorable: true + /_opendistro/_security/api/validate: + get: + operationId: security.validate.0_superseded + x-operation-group: security.validate + x-version-added: '1.0' + 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' + responses: + '200': + $ref: '#/components/responses/security.validate@200' + '400': + $ref: '#/components/responses/security.validate@400' + deprecated: true + x-ignorable: true + /_opendistro/_security/api/allowlist: + get: + operationId: security.get_allowlist.0_superseded + x-operation-group: security.get_allowlist + x-version-added: '1.0' + description: Retrieves the current list of allowed API accessible to normal user. + externalDocs: + url: https://opensearch.org/docs/latest/security/access-control/api/#access-control-for-the-api + responses: + '200': + $ref: '#/components/responses/security.get_allowlist@200' + parameters: + - $ref: '#/components/parameters/_global::query.pretty' + - $ref: '#/components/parameters/_global::query.human' + - $ref: '#/components/parameters/_global::query.error_trace' + - $ref: '#/components/parameters/_global::query.source' + - $ref: '#/components/parameters/_global::query.filter_path' + deprecated: true + x-ignorable: true + put: + operationId: security.create_allowlist.0_superseded + x-operation-group: security.create_allowlist + x-version-added: '1.0' + description: Creates or replaces the allowlisted APIs. Accessible via Super Admin certificate or REST API permission. + externalDocs: + url: https://opensearch.org/docs/latest/security/access-control/api/#access-control-for-the-api + requestBody: + $ref: '#/components/requestBodies/security.create_allowlist' + responses: + '200': + $ref: '#/components/responses/security.create_allowlist@200' + parameters: + - $ref: '#/components/parameters/_global::query.pretty' + - $ref: '#/components/parameters/_global::query.human' + - $ref: '#/components/parameters/_global::query.error_trace' + - $ref: '#/components/parameters/_global::query.source' + - $ref: '#/components/parameters/_global::query.filter_path' + deprecated: true + x-ignorable: true + patch: + operationId: security.patch_allowlist.0_superseded + x-operation-group: security.patch_allowlist + x-version-added: '1.0' + description: Updates the current list of allowed API accessible to normal user. + externalDocs: + url: https://opensearch.org/docs/latest/security/access-control/api/#access-control-for-the-api + requestBody: + $ref: '#/components/requestBodies/security.patch_allowlist' + responses: + '200': + $ref: '#/components/responses/security.patch_allowlist@200' + parameters: + - $ref: '#/components/parameters/_global::query.pretty' + - $ref: '#/components/parameters/_global::query.human' + - $ref: '#/components/parameters/_global::query.error_trace' + - $ref: '#/components/parameters/_global::query.source' + - $ref: '#/components/parameters/_global::query.filter_path' + deprecated: true + x-ignorable: true + /_opendistro/_security/authinfo: + get: + operationId: security.authinfo.0_superseded + x-operation-group: security.authinfo + x-version-added: '1.0' + 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' + responses: + '200': + $ref: '#/components/responses/security.authinfo@200' + '500': + $ref: '#/components/responses/security.authinfo@500' + deprecated: true + x-ignorable: true + post: + operationId: security.authinfo.1_superseded + x-operation-group: security.authinfo + x-version-added: '1.0' + 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' + responses: + '200': + $ref: '#/components/responses/security.authinfo@200' + '500': + $ref: '#/components/responses/security.authinfo@500' + deprecated: true + x-ignorable: true + /_opendistro/_security/health: + get: + operationId: security.health.0_superseded + x-operation-group: security.health + x-version-added: '1.0' + 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' + externalDocs: + url: https://opensearch.org/docs/latest/security/access-control/api/#health-check + responses: + '200': + $ref: '#/components/responses/security.health@200' + deprecated: true + x-ignorable: true + post: + operationId: security.health.1_superseded + x-operation-group: security.health + x-version-added: '1.0' + 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' + externalDocs: + url: https://opensearch.org/docs/latest/security/access-control/api/#health-check + responses: + '200': + $ref: '#/components/responses/security.health@200' + deprecated: true + x-ignorable: true + /_opendistro/_security/kibanainfo: + get: + operationId: security.get_dashboards_info.0_superseded + x-operation-group: security.get_dashboards_info + x-version-added: '1.0' + description: Retrieves the current security-dashboards plugin configuration. + responses: + '200': + $ref: '#/components/responses/security.get_dashboards_info@200' + '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' + deprecated: true + x-ignorable: true + post: + operationId: security.post_dashboards_info.1_superseded + x-operation-group: security.post_dashboards_info + x-version-added: '1.0' + description: Updates the current security-dashboards plugin configuration. + requestBody: + $ref: '#/components/requestBodies/security.post_dashboards_info' + responses: + '200': + $ref: '#/components/responses/security.post_dashboards_info@200' + '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' + deprecated: true + x-ignorable: true + /_opendistro/_security/tenantinfo: + get: + operationId: security.tenant_info.0_superseded + x-operation-group: security.tenant_info + x-version-added: '1.0' + 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' + '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' + deprecated: true + x-ignorable: true + post: + operationId: security.tenant_info.1_superseded + x-operation-group: security.tenant_info + x-version-added: '1.0' + 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' + '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' + deprecated: true + x-ignorable: true +components: + parameters: + _global::query.pretty: + name: pretty + in: query + description: Whether to pretty format the returned JSON response. + schema: + type: boolean + default: false + x-global: true + _global::query.human: + name: human + in: query + description: Whether to return human readable values for statistics. + schema: + type: boolean + default: true + x-global: true + _global::query.error_trace: + name: error_trace + in: query + description: Whether to include the stack trace of returned errors. + schema: + type: boolean + default: false + x-global: true + _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: + name: filter_path + in: query + description: Comma-separated list of filters used to reduce the response. + schema: + oneOf: + - type: string + - type: array + items: + type: string + x-global: true + 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' + style: simple + 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' + style: form + 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' + style: form + 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' + style: form + bulk::query.pipeline: + in: query + name: pipeline + description: |- + ID of the pipeline to use to preprocess incoming documents. + If the index has a default ingest pipeline specified, then setting the value to `_none` disables the default ingest pipeline for this request. + If a final pipeline is configured it will always run, regardless of the value of this parameter. + schema: + type: string + style: form + 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' + style: form + bulk::query.require_alias: + in: query + name: require_alias + description: If `true`, the request's actions must target an index alias. + schema: + type: boolean + default: false + style: form + bulk::query.routing: + in: query + name: routing + description: Custom value used to route operations to a specific shard. + schema: + $ref: '#/components/schemas/_common:Routing' + style: form + 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' + style: form + 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: + 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' + style: form + x-default: '1' + 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`. @@ -6885,9 +11617,9 @@ components: in: query description: Return help information. schema: + description: Return help information. type: boolean default: false - description: Return help information. cat.aliases::query.local: name: local in: query @@ -6987,7 +11719,7 @@ components: description: Operation timeout for connection to cluster-manager node. schema: $ref: '#/components/schemas/_common:Duration' - x-version-added: 2.0.0 + x-version-added: '2.0' cat.allocation::query.format: name: format in: query @@ -7056,7 +11788,7 @@ components: description: Operation timeout for connection to cluster-manager node. schema: $ref: '#/components/schemas/_common:Duration' - x-version-added: 2.0.0 + x-version-added: '2.0' cat.cluster_manager::query.format: name: format in: query @@ -7293,6 +12025,7 @@ components: description: If true, returns `HH:MM:SS` and Unix epoch timestamps. schema: type: boolean + default: true style: form cat.health::query.v: name: v @@ -7302,25 +12035,6 @@ components: type: boolean default: false description: Verbose mode. Display column headers. - cat.help::query.help: - name: help - in: query - description: Return help information. - schema: - type: boolean - default: false - description: Return help information. - cat.help::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 cat.indices::path.index: in: path name: index @@ -7344,7 +12058,7 @@ components: description: Operation timeout for connection to cluster-manager node. schema: $ref: '#/components/schemas/_common:Duration' - x-version-added: 2.0.0 + x-version-added: '2.0' cat.indices::query.expand_wildcards: in: query name: expand_wildcards @@ -7391,6 +12105,7 @@ components: 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: name: local @@ -7415,6 +12130,7 @@ components: description: If true, the response only includes information from primary shards. schema: type: boolean + default: false style: form cat.indices::query.s: name: s @@ -7448,7 +12164,7 @@ components: description: Operation timeout for connection to cluster-manager node. schema: $ref: '#/components/schemas/_common:Duration' - x-version-added: 2.0.0 + x-version-added: '2.0' cat.master::query.format: name: format in: query @@ -7517,7 +12233,7 @@ components: description: Operation timeout for connection to cluster-manager node. schema: $ref: '#/components/schemas/_common:Duration' - x-version-added: 2.0.0 + x-version-added: '2.0' cat.nodeattrs::query.format: name: format in: query @@ -7593,7 +12309,7 @@ components: description: Operation timeout for connection to cluster-manager node. schema: $ref: '#/components/schemas/_common:Duration' - x-version-added: 2.0.0 + x-version-added: '2.0' cat.nodes::query.format: name: format in: query @@ -7606,9 +12322,10 @@ components: name: full_id description: If `true`, return the full node ID. If `false`, return the shortened node ID. schema: - oneOf: + anyOf: - type: boolean - type: string + default: false style: form cat.nodes::query.h: name: h @@ -7633,13 +12350,13 @@ components: name: local in: query description: Return local information, do not retrieve the state from cluster-manager node. + deprecated: true + x-version-deprecated: '1.0' + x-deprecation-message: This parameter does not cause this API to act locally. schema: type: boolean default: false description: Return local information, do not retrieve the state from cluster-manager node. - x-version-deprecated: '1.0' - x-deprecation-message: This parameter does not cause this API to act locally. - deprecated: true cat.nodes::query.master_timeout: name: master_timeout in: query @@ -7680,7 +12397,7 @@ components: description: Operation timeout for connection to cluster-manager node. schema: $ref: '#/components/schemas/_common:Duration' - x-version-added: 2.0.0 + x-version-added: '2.0' cat.pending_tasks::query.format: name: format in: query @@ -7806,7 +12523,7 @@ components: description: Operation timeout for connection to cluster-manager node. schema: $ref: '#/components/schemas/_common:Duration' - x-version-added: 2.0.0 + x-version-added: '2.0' cat.plugins::query.format: name: format in: query @@ -7885,6 +12602,7 @@ components: description: If `true`, the response only includes ongoing shard recoveries. schema: type: boolean + default: false style: form cat.recovery::query.bytes: in: query @@ -7899,6 +12617,7 @@ components: description: If `true`, the response includes detailed information about shard recoveries. schema: type: boolean + default: false style: form cat.recovery::query.format: name: format @@ -7968,7 +12687,7 @@ components: description: Operation timeout for connection to cluster-manager node. schema: $ref: '#/components/schemas/_common:Duration' - x-version-added: 2.0.0 + x-version-added: '2.0' cat.repositories::query.format: name: format in: query @@ -8036,10 +12755,10 @@ components: in: path description: Comma-separated list or wildcard expression of index names to limit the returned information. schema: - type: string - pattern: ^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$ + type: array description: Comma-separated list or wildcard expression of index names to limit the returned information. - x-data-type: array + items: + type: string required: true cat.segment_replication::query.active_only: name: active_only @@ -8201,7 +12920,7 @@ components: description: Operation timeout for connection to cluster-manager node. schema: $ref: '#/components/schemas/_common:Duration' - x-version-added: 2.0.0 + x-version-added: '2.0' cat.segments::query.format: name: format in: query @@ -8280,7 +12999,7 @@ components: description: Operation timeout for connection to cluster-manager node. schema: $ref: '#/components/schemas/_common:Duration' - x-version-added: 2.0.0 + x-version-added: '2.0' cat.shards::query.format: name: format in: query @@ -8356,7 +13075,7 @@ components: A comma-separated list of snapshot repositories used to limit the request. Accepts wildcard expressions. `_all` returns all repositories. - If any repository fails during the request, Opensearch returns an error. + If any repository fails during the request, OpenSearch returns an error. required: true schema: $ref: '#/components/schemas/_common:Names' @@ -8367,7 +13086,7 @@ components: description: Operation timeout for connection to cluster-manager node. schema: $ref: '#/components/schemas/_common:Duration' - x-version-added: 2.0.0 + x-version-added: '2.0' cat.snapshots::query.format: name: format in: query @@ -8400,6 +13119,7 @@ components: description: If `true`, the response does not include information from unavailable snapshots. schema: type: boolean + default: false style: form cat.snapshots::query.master_timeout: name: master_timeout @@ -8450,6 +13170,7 @@ components: description: If `true`, the response includes detailed information about shard recoveries. schema: type: boolean + default: false style: form cat.tasks::query.format: name: format @@ -8536,7 +13257,7 @@ components: description: Operation timeout for connection to cluster-manager node. schema: $ref: '#/components/schemas/_common:Duration' - x-version-added: 2.0.0 + x-version-added: '2.0' cat.templates::query.format: name: format in: query @@ -8615,7 +13336,7 @@ components: description: Operation timeout for connection to cluster-manager node. schema: $ref: '#/components/schemas/_common:Duration' - x-version-added: 2.0.0 + x-version-added: '2.0' cat.thread_pool::query.format: name: format in: query @@ -8693,6 +13414,7 @@ components: Comma-separated list of scroll IDs to clear. To clear all scroll IDs, use `_all`. required: true + deprecated: true schema: $ref: '#/components/schemas/_common:ScrollIds' style: simple @@ -8702,6 +13424,7 @@ components: 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: in: query @@ -8709,6 +13432,7 @@ components: description: If true, returns YES decisions in explanation. schema: type: boolean + default: false style: form cluster.delete_component_template::path.name: in: path @@ -8726,7 +13450,7 @@ components: description: Operation timeout for connection to cluster-manager node. schema: $ref: '#/components/schemas/_common:Duration' - x-version-added: 2.0.0 + x-version-added: '2.0' cluster.delete_component_template::query.master_timeout: in: query name: master_timeout @@ -8760,6 +13484,7 @@ components: nodes are still in the cluster. schema: type: boolean + default: true style: form cluster.exists_component_template::path.name: in: path @@ -8777,7 +13502,7 @@ components: description: Operation timeout for connection to cluster-manager node. schema: $ref: '#/components/schemas/_common:Duration' - x-version-added: 2.0.0 + x-version-added: '2.0' cluster.exists_component_template::query.local: in: query name: local @@ -8786,6 +13511,7 @@ components: Defaults to false, which means information is retrieved from the master node. schema: type: boolean + default: false style: form cluster.exists_component_template::query.master_timeout: in: query @@ -8816,7 +13542,7 @@ components: description: Operation timeout for connection to cluster-manager node. schema: $ref: '#/components/schemas/_common:Duration' - x-version-added: 2.0.0 + x-version-added: '2.0' cluster.get_component_template::query.local: in: query name: local @@ -8825,6 +13551,7 @@ components: If `false`, information is retrieved from the master node. schema: type: boolean + default: false style: form cluster.get_component_template::query.master_timeout: in: query @@ -8844,7 +13571,6 @@ components: description: Awareness attribute name. schema: type: string - pattern: ^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$ description: Awareness attribute name. required: true cluster.get_settings::query.cluster_manager_timeout: @@ -8853,13 +13579,14 @@ components: description: Operation timeout for connection to cluster-manager node. schema: $ref: '#/components/schemas/_common:Duration' - x-version-added: 2.0.0 + x-version-added: '2.0' cluster.get_settings::query.flat_settings: in: query name: flat_settings description: If `true`, returns settings in flat format. schema: type: boolean + default: false style: form cluster.get_settings::query.include_defaults: in: query @@ -8867,6 +13594,7 @@ components: description: If `true`, returns default cluster settings from the local node. schema: type: boolean + default: false style: form cluster.get_settings::query.master_timeout: in: query @@ -8895,13 +13623,12 @@ components: description: Awareness attribute name. schema: type: string - pattern: ^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$ description: Awareness attribute name. required: true 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, 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 `*`. required: true schema: $ref: '#/components/schemas/_common:Indices' @@ -8919,7 +13646,7 @@ components: description: Operation timeout for connection to cluster-manager node. schema: $ref: '#/components/schemas/_common:Duration' - x-version-added: 2.0.0 + x-version-added: '2.0' cluster.health::query.expand_wildcards: in: query name: expand_wildcards @@ -8940,6 +13667,7 @@ components: description: If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the master node. schema: type: boolean + default: false style: form cluster.health::query.master_timeout: in: query @@ -9008,7 +13736,7 @@ components: description: Operation timeout for connection to cluster-manager node. schema: $ref: '#/components/schemas/_common:Duration' - x-version-added: 2.0.0 + x-version-added: '2.0' cluster.pending_tasks::query.local: in: query name: local @@ -9017,6 +13745,7 @@ components: If `false`, information is retrieved from the master node. schema: type: boolean + default: false style: form cluster.pending_tasks::query.master_timeout: in: query @@ -9064,10 +13793,10 @@ components: 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. - 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. + 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. + 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' @@ -9078,13 +13807,14 @@ components: description: Operation timeout for connection to cluster-manager node. schema: $ref: '#/components/schemas/_common:Duration' - x-version-added: 2.0.0 + x-version-added: '2.0' cluster.put_component_template::query.create: in: query name: create description: If `true`, this request cannot replace or update existing component templates. schema: type: boolean + default: false style: form cluster.put_component_template::query.master_timeout: in: query @@ -9110,7 +13840,6 @@ components: description: Awareness attribute name. schema: type: string - pattern: ^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$ description: Awareness attribute name. required: true cluster.put_decommission_awareness::path.awareness_attribute_value: @@ -9119,7 +13848,6 @@ components: description: Awareness attribute value. schema: type: string - pattern: ^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$ description: Awareness attribute value. required: true cluster.put_settings::query.cluster_manager_timeout: @@ -9128,13 +13856,14 @@ components: description: Operation timeout for connection to cluster-manager node. schema: $ref: '#/components/schemas/_common:Duration' - x-version-added: 2.0.0 + x-version-added: '2.0' cluster.put_settings::query.flat_settings: in: query name: flat_settings - description: 'Return settings in flat format (default: false)' + description: Return settings in flat format. schema: type: boolean + default: false style: form cluster.put_settings::query.master_timeout: in: query @@ -9159,7 +13888,6 @@ components: description: Awareness attribute name. schema: type: string - pattern: ^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$ description: Awareness attribute name. required: true cluster.reroute::query.cluster_manager_timeout: @@ -9168,7 +13896,7 @@ components: description: Operation timeout for connection to cluster-manager node. schema: $ref: '#/components/schemas/_common:Duration' - x-version-added: 2.0.0 + x-version-added: '2.0' cluster.reroute::query.dry_run: in: query name: dry_run @@ -9245,7 +13973,7 @@ components: description: Operation timeout for connection to cluster-manager node. schema: $ref: '#/components/schemas/_common:Duration' - x-version-added: 2.0.0 + x-version-added: '2.0' cluster.state::query.expand_wildcards: in: query name: expand_wildcards @@ -9256,9 +13984,10 @@ components: cluster.state::query.flat_settings: in: query name: flat_settings - description: 'Return settings in flat format (default: false)' + description: Return settings in flat format. schema: type: boolean + default: false style: form cluster.state::query.ignore_unavailable: in: query @@ -9270,9 +13999,10 @@ components: cluster.state::query.local: in: query name: local - description: 'Return local information, do not retrieve the state from cluster-manager node (default: false)' + description: Return local information, do not retrieve the state from cluster-manager node. schema: type: boolean + default: false style: form cluster.state::query.master_timeout: in: query @@ -9312,6 +14042,7 @@ components: description: If `true`, returns settings in flat format. schema: type: boolean + default: false style: form cluster.stats::query.timeout: in: query @@ -9319,7 +14050,7 @@ components: description: |- Period to wait for each node to respond. 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. + However, timed out nodes are included in the response's `_nodes.failed` property. Defaults to no timeout. schema: $ref: '#/components/schemas/_common:Duration' style: form @@ -9351,6 +14082,7 @@ components: This parameter can only be used when the `q` query string parameter is specified. schema: type: boolean + default: false style: form count::query.analyzer: in: query @@ -9425,6 +14157,7 @@ components: Random by default. schema: type: string + default: random style: form count::query.q: in: query @@ -9445,11 +14178,59 @@ components: name: 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. + If a query reaches this limit, OpenSearch terminates the query early. + OpenSearch collects documents before sorting. schema: type: number style: form + 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. + schema: + type: array + description: Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices. + items: + type: string + required: true + 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: + name: expand_wildcards + in: query + description: Whether to expand wildcard expression to concrete indices that are open, closed or both. + schema: + $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: + name: preference + in: query + description: Specify the node or shard the operation should be performed on. + schema: + type: string + default: random + description: Specify the node or shard the operation should be performed on. + create_pit::query.routing: + name: routing + in: query + description: Comma-separated list of specific routing values. + style: form + schema: + type: array + items: + type: string + description: Comma-separated list of specific routing values. + explode: true create::path.id: in: path name: id @@ -9463,8 +14244,8 @@ components: name: index description: |- Name of the data stream or index to target. - If the target doesn’t exist and matches the name or wildcard (`*`) pattern of an index template with a `data_stream` definition, this request creates the data stream. - If the target doesn’t exist and doesn’t match a data stream template, this request creates the index. + If the target doesn't exist and matches the name or wildcard (`*`) pattern of an index template with a `data_stream` definition, this request creates the data stream. + 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' @@ -9483,7 +14264,7 @@ components: 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. + 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' @@ -9527,54 +14308,7 @@ components: schema: $ref: '#/components/schemas/_common:WaitForActiveShards' style: form - 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. - schema: - type: string - pattern: ^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$ - description: Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices. - x-data-type: array - required: true - 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: - name: expand_wildcards - in: query - description: Whether to expand wildcard expression to concrete indices that are open, closed or both. - schema: - $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: - name: preference - in: query - description: Specify the node or shard the operation should be performed on. - schema: - type: string - default: random - description: Specify the node or shard the operation should be performed on. - create_pit::query.routing: - name: routing - in: query - description: Comma-separated list of specific routing values. - style: form - schema: - type: array - items: - type: string - description: Comma-separated list of specific routing values. - explode: true + x-default: '1' dangling_indices.delete_dangling_index::path.index_uuid: in: path name: index_uuid @@ -9597,7 +14331,7 @@ components: description: Operation timeout for connection to cluster-manager node. schema: $ref: '#/components/schemas/_common:Duration' - x-version-added: 2.0.0 + x-version-added: '2.0' dangling_indices.delete_dangling_index::query.master_timeout: in: query name: master_timeout @@ -9637,7 +14371,7 @@ components: description: Operation timeout for connection to cluster-manager node. schema: $ref: '#/components/schemas/_common:Duration' - x-version-added: 2.0.0 + x-version-added: '2.0' dangling_indices.import_dangling_index::query.master_timeout: in: query name: master_timeout @@ -9655,84 +14389,21 @@ components: schema: $ref: '#/components/schemas/_common:Duration' style: form - delete::path.id: - in: path - name: id - description: Unique identifier for the document. - required: true - schema: - $ref: '#/components/schemas/_common:Id' - style: simple - delete::path.index: + delete_by_query_rethrottle::path.task_id: in: path - name: index - description: Name of the target index. + name: task_id + description: The ID for the task. required: true schema: - $ref: '#/components/schemas/_common:IndexName' + $ref: '#/components/schemas/_common:TaskId' style: simple - delete::query.if_primary_term: + delete_by_query_rethrottle::query.requests_per_second: in: query - name: if_primary_term - description: Only perform the operation if the document has this primary term. + name: requests_per_second + description: The throttle for this request in sub-requests per second. schema: type: number style: form - 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' - style: form - 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' - style: form - delete::query.routing: - in: query - name: routing - description: Custom value used to route operations to a specific shard. - schema: - $ref: '#/components/schemas/_common:Routing' - style: form - delete::query.timeout: - in: query - name: timeout - description: Period to wait for active shards. - schema: - $ref: '#/components/schemas/_common:Duration' - style: form - 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' - style: form - delete::query.version_type: - in: query - name: version_type - description: 'Specific version type: `external`, `external_gte`.' - schema: - $ref: '#/components/schemas/_common:VersionType' - style: form - 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' - style: form delete_by_query::path.index: in: path name: index @@ -9793,6 +14464,7 @@ components: description: If `true`, wildcard and prefix queries are analyzed. schema: type: boolean + default: false style: form delete_by_query::query.analyzer: in: query @@ -9835,9 +14507,10 @@ components: delete_by_query::query.from: in: query name: from - description: 'Starting offset (default: 0)' + description: Starting offset. schema: type: number + default: 0 style: form delete_by_query::query.ignore_unavailable: in: query @@ -9870,6 +14543,7 @@ components: Random by default. schema: type: string + default: random style: form delete_by_query::query.q: in: query @@ -9881,7 +14555,7 @@ components: 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. + description: If `true`, OpenSearch refreshes all shards involved in the delete by query after the request completes. schema: type: boolean style: form @@ -9900,6 +14574,7 @@ components: description: The throttle for this request in sub-requests per second. schema: type: number + default: 0 style: form delete_by_query::query.routing: in: query @@ -9921,6 +14596,7 @@ components: description: Size of the scroll request that powers the operation. schema: type: number + default: 100 style: form delete_by_query::query.search_timeout: in: query @@ -9955,6 +14631,7 @@ components: schema: $ref: '#/components/schemas/_common:Slices' style: form + x-default: '1' delete_by_query::query.sort: in: query name: sort @@ -9978,11 +14655,11 @@ components: name: 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. + 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. + 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. schema: type: number @@ -9994,6 +14671,7 @@ components: schema: $ref: '#/components/schemas/_common:Duration' style: form + x-default: 1m delete_by_query::query.version: in: query name: version @@ -10010,27 +14688,14 @@ components: schema: $ref: '#/components/schemas/_common:WaitForActiveShards' style: form + x-default: '1' delete_by_query::query.wait_for_completion: in: query name: wait_for_completion description: If `true`, the request blocks until the operation is complete. schema: type: boolean - style: form - 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' - style: simple - 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. - schema: - type: number + default: true style: form delete_script::path.id: in: path @@ -10046,7 +14711,7 @@ components: description: Operation timeout for connection to cluster-manager node. schema: $ref: '#/components/schemas/_common:Duration' - x-version-added: 2.0.0 + x-version-added: '2.0' delete_script::query.master_timeout: in: query name: master_timeout @@ -10068,7 +14733,86 @@ components: schema: $ref: '#/components/schemas/_common:Duration' style: form - exists::path.id: + delete::path.id: + in: path + name: id + description: Unique identifier for the document. + required: true + schema: + $ref: '#/components/schemas/_common:Id' + style: simple + delete::path.index: + in: path + name: index + description: Name of the target index. + required: true + schema: + $ref: '#/components/schemas/_common:IndexName' + style: simple + delete::query.if_primary_term: + in: query + name: if_primary_term + description: Only perform the operation if the document has this primary term. + schema: + type: number + style: form + 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' + style: form + 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' + style: form + delete::query.routing: + in: query + name: routing + description: Custom value used to route operations to a specific shard. + schema: + $ref: '#/components/schemas/_common:Routing' + style: form + delete::query.timeout: + in: query + name: timeout + description: Period to wait for active shards. + schema: + $ref: '#/components/schemas/_common:Duration' + style: form + 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' + style: form + delete::query.version_type: + in: query + name: version_type + description: 'Specific version type: `external`, `external_gte`.' + schema: + $ref: '#/components/schemas/_common:VersionType' + style: form + 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' + style: form + x-default: '1' + exists_source::path.id: in: path name: id description: Identifier of the document. @@ -10076,7 +14820,7 @@ components: schema: $ref: '#/components/schemas/_common:Id' style: simple - exists::path.index: + exists_source::path.index: in: path name: index description: |- @@ -10086,28 +14830,28 @@ components: schema: $ref: '#/components/schemas/_common:IndexName' style: simple - exists::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' style: form - exists::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' style: form - exists::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' style: form - exists::query.preference: + exists_source::query.preference: in: query name: preference description: |- @@ -10115,39 +14859,30 @@ components: Random by default. schema: type: string + default: random style: form - exists::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::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. + description: If `true`, OpenSearch refreshes all shards involved in the delete by query after the request completes. schema: type: boolean style: form - exists::query.routing: + exists_source::query.routing: in: query name: routing description: Target the specified primary shard. schema: $ref: '#/components/schemas/_common:Routing' style: form - exists::query.stored_fields: - in: query - name: stored_fields - description: |- - List of stored fields to return as part of a hit. - 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' - style: form - exists::query.version: + exists_source::query.version: in: query name: version description: |- @@ -10156,14 +14891,14 @@ components: schema: $ref: '#/components/schemas/_common:VersionNumber' style: form - exists::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' style: form - exists_source::path.id: + exists::path.id: in: path name: id description: Identifier of the document. @@ -10171,7 +14906,7 @@ components: schema: $ref: '#/components/schemas/_common:Id' style: simple - exists_source::path.index: + exists::path.index: in: path name: index description: |- @@ -10181,28 +14916,28 @@ components: schema: $ref: '#/components/schemas/_common:IndexName' style: simple - exists_source::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' style: form - exists_source::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' style: form - exists_source::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' style: form - exists_source::query.preference: + exists::query.preference: in: query name: preference description: |- @@ -10210,29 +14945,40 @@ components: Random by default. schema: type: string + default: random style: form - exists_source::query.realtime: + exists::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::query.refresh: in: query name: refresh - description: If `true`, Opensearch refreshes all shards involved in the delete by query after the request completes. + description: If `true`, OpenSearch refreshes all shards involved in the delete by query after the request completes. schema: type: boolean style: form - exists_source::query.routing: + exists::query.routing: in: query name: routing description: Target the specified primary shard. schema: $ref: '#/components/schemas/_common:Routing' style: form - exists_source::query.version: + exists::query.stored_fields: + in: query + name: stored_fields + description: |- + List of stored fields to return as part of a hit. + 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' + style: form + exists::query.version: in: query name: version description: |- @@ -10241,7 +14987,7 @@ components: schema: $ref: '#/components/schemas/_common:VersionNumber' style: form - exists_source::query.version_type: + exists::query.version_type: in: query name: version_type description: 'Specific version type: `external`, `external_gte`.' @@ -10293,6 +15039,7 @@ components: description: If `true`, wildcard and prefix queries are analyzed. schema: type: boolean + default: false style: form explain::query.analyzer: in: query @@ -10316,6 +15063,7 @@ components: description: Field to use as default where no field prefix is given in the query string. schema: type: string + default: _all style: form explain::query.lenient: in: query @@ -10332,6 +15080,7 @@ components: Random by default. schema: type: string + default: random style: form explain::query.q: in: query @@ -10399,8 +15148,34 @@ components: description: If true, unmapped fields are included in the response. schema: type: boolean + default: false style: form - get::path.id: + 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' + style: simple + 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' + x-version-added: '2.0' + 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' + style: form + x-version-deprecated: 2.0.0 + 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. @@ -10408,7 +15183,7 @@ components: schema: $ref: '#/components/schemas/_common:Id' style: simple - get::path.index: + get_source::path.index: in: path name: index description: Name of the index that contains the document. @@ -10416,105 +15191,71 @@ components: schema: $ref: '#/components/schemas/_common:IndexName' style: simple - get::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. schema: $ref: '#/components/schemas/_core.search:SourceConfigParam' style: form - get::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' style: form - get::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' style: form - get::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. schema: type: string + default: random style: form - get::query.realtime: + get_source::query.realtime: in: query name: realtime - description: 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::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 style: form - get::query.routing: + get_source::query.routing: in: query name: routing description: Target the specified primary shard. schema: $ref: '#/components/schemas/_common:Routing' style: form - get::query.stored_fields: - in: query - name: stored_fields - description: |- - List of stored fields to return as part of a hit. - 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' - style: form - get::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' style: form - get::query.version_type: + get_source::query.version_type: in: query name: version_type description: 'Specific version type: internal, external, external_gte.' schema: $ref: '#/components/schemas/_common:VersionType' style: form - 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' - style: simple - 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' - x-version-added: 2.0.0 - 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' - style: form - x-version-deprecated: 2.0.0 - x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. - get_source::path.id: + get::path.id: in: path name: id description: Unique identifier of the document. @@ -10522,7 +15263,7 @@ components: schema: $ref: '#/components/schemas/_common:Id' style: simple - get_source::path.index: + get::path.index: in: path name: index description: Name of the index that contains the document. @@ -10530,63 +15271,74 @@ components: schema: $ref: '#/components/schemas/_common:IndexName' style: simple - get_source::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. schema: $ref: '#/components/schemas/_core.search:SourceConfigParam' style: form - get_source::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' style: form - get_source::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' style: form - get_source::query.preference: + get::query.preference: in: query name: preference description: Specifies the node or shard the operation should be performed on. Random by default. schema: type: string + default: random style: form - get_source::query.realtime: + get::query.realtime: in: query name: realtime - description: Boolean) 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 - get_source::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 style: form - get_source::query.routing: + get::query.routing: in: query name: routing description: Target the specified primary shard. schema: $ref: '#/components/schemas/_common:Routing' style: form - get_source::query.version: + get::query.stored_fields: + in: query + name: stored_fields + description: |- + List of stored fields to return as part of a hit. + 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' + style: form + 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' style: form - get_source::query.version_type: + get::query.version_type: in: query name: version_type description: 'Specific version type: internal, external, external_gte.' @@ -10650,7 +15402,7 @@ components: 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. + 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' @@ -10661,6 +15413,7 @@ components: description: If `true`, the destination must be an index alias. schema: type: boolean + default: false style: form index::query.routing: in: query @@ -10701,6 +15454,7 @@ components: schema: $ref: '#/components/schemas/_common:WaitForActiveShards' style: form + x-default: '1' indices.add_block::path.block: in: path name: block @@ -10715,7 +15469,7 @@ components: description: A comma separated list of indices to add a block to required: true schema: - $ref: '#/components/schemas/_common:IndexName' + $ref: '#/components/schemas/_common:Indices' style: simple indices.add_block::query.allow_no_indices: in: query @@ -10730,7 +15484,7 @@ components: description: Operation timeout for connection to cluster-manager node. schema: $ref: '#/components/schemas/_common:Duration' - x-version-added: 2.0.0 + x-version-added: '2.0' indices.add_block::query.expand_wildcards: in: query name: expand_wildcards @@ -10827,6 +15581,15 @@ components: schema: $ref: '#/components/schemas/_common:Fields' style: form + 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. + schema: + type: boolean + default: false + style: form indices.clear_cache::query.ignore_unavailable: in: query name: ignore_unavailable @@ -10881,7 +15644,7 @@ components: description: Operation timeout for connection to cluster-manager node. schema: $ref: '#/components/schemas/_common:Duration' - x-version-added: 2.0.0 + x-version-added: '2.0' indices.clone::query.master_timeout: in: query name: master_timeout @@ -10919,6 +15682,7 @@ components: $ref: '#/components/schemas/_common:WaitForActiveShards' style: form indices.clone::query.wait_for_completion: + x-version-added: '2.7' name: wait_for_completion in: query description: Should this request wait until the operation has completed before returning. @@ -10949,7 +15713,7 @@ components: description: Operation timeout for connection to cluster-manager node. schema: $ref: '#/components/schemas/_common:Duration' - x-version-added: 2.0.0 + x-version-added: '2.0' indices.close::query.expand_wildcards: in: query name: expand_wildcards @@ -10998,6 +15762,20 @@ components: schema: $ref: '#/components/schemas/_common:WaitForActiveShards' style: form + indices.create_data_stream::path.name: + in: path + name: name + description: |- + Name of the data stream, which must meet the following criteria: + Lowercase only; + Cannot include `\`, `/`, `*`, `?`, `"`, `<`, `>`, `|`, `,`, `#`, `:`, or a space character; + Cannot start with `-`, `_`, `+`, or `.ds-`; + Cannot be `.` or `..`; + Cannot be longer than 255 bytes. Multi-byte characters count towards this limit faster. + required: true + schema: + $ref: '#/components/schemas/_common:DataStreamName' + style: simple indices.create::path.index: in: path name: index @@ -11012,7 +15790,7 @@ components: description: Operation timeout for connection to cluster-manager node. schema: $ref: '#/components/schemas/_common:Duration' - x-version-added: 2.0.0 + x-version-added: '2.0' indices.create::query.master_timeout: in: query name: master_timeout @@ -11043,20 +15821,6 @@ components: schema: $ref: '#/components/schemas/_common:WaitForActiveShards' style: form - indices.create_data_stream::path.name: - in: path - name: name - description: |- - Name of the data stream, which must meet the following criteria: - Lowercase only; - Cannot include `\`, `/`, `*`, `?`, `"`, `<`, `>`, `|`, `,`, `#`, `:`, or a space character; - Cannot start with `-`, `_`, `+`, or `.ds-`; - Cannot be `.` or `..`; - Cannot be longer than 255 bytes. Multi-byte characters count towards this limit faster. - required: true - schema: - $ref: '#/components/schemas/_common:DataStreamName' - style: simple indices.data_streams_stats::path.name: in: path name: name @@ -11065,76 +15829,9 @@ components: Wildcard expressions (`*`) are supported. To target all data streams in a cluster, omit this parameter or use `*`. required: true - schema: - $ref: '#/components/schemas/_common:IndexName' - style: simple - indices.delete::path.index: - in: path - name: index - description: |- - 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`. - required: true schema: $ref: '#/components/schemas/_common:Indices' style: simple - 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. - schema: - type: boolean - style: form - 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' - x-version-added: 2.0.0 - indices.delete::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`. - Valid values are: `all`, `open`, `closed`, `hidden`, `none`. - schema: - $ref: '#/components/schemas/_common:ExpandWildcards' - style: form - 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. - schema: - type: boolean - style: form - indices.delete::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. - deprecated: true - schema: - $ref: '#/components/schemas/_common:Duration' - style: form - x-version-deprecated: 2.0.0 - 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' - style: form indices.delete_alias::path.index: in: path name: index @@ -11161,7 +15858,7 @@ components: description: Operation timeout for connection to cluster-manager node. schema: $ref: '#/components/schemas/_common:Duration' - x-version-added: 2.0.0 + x-version-added: '2.0' indices.delete_alias::query.master_timeout: in: query name: master_timeout @@ -11205,7 +15902,7 @@ components: description: Operation timeout for connection to cluster-manager node. schema: $ref: '#/components/schemas/_common:Duration' - x-version-added: 2.0.0 + x-version-added: '2.0' indices.delete_index_template::query.master_timeout: in: query name: master_timeout @@ -11239,7 +15936,7 @@ components: description: Operation timeout for connection to cluster-manager node. schema: $ref: '#/components/schemas/_common:Duration' - x-version-added: 2.0.0 + x-version-added: '2.0' indices.delete_template::query.master_timeout: in: query name: master_timeout @@ -11261,15 +15958,19 @@ components: schema: $ref: '#/components/schemas/_common:Duration' style: form - indices.exists::path.index: + indices.delete::path.index: in: path name: index - description: Comma-separated list of data streams, indices, and aliases. Supports wildcards (`*`). + description: |- + 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`. required: true schema: $ref: '#/components/schemas/_common:Indices' style: simple - indices.exists::query.allow_no_indices: + indices.delete::query.allow_no_indices: in: query name: allow_no_indices description: |- @@ -11277,8 +15978,16 @@ components: This behavior applies even if the request targets other open indices. schema: type: boolean + default: false style: form - indices.exists::query.expand_wildcards: + 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' + x-version-added: '2.0' + indices.delete::query.expand_wildcards: in: query name: expand_wildcards description: |- @@ -11289,33 +15998,34 @@ components: schema: $ref: '#/components/schemas/_common:ExpandWildcards' style: form - indices.exists::query.flat_settings: - in: query - name: flat_settings - description: If `true`, returns settings in flat format. - schema: - type: boolean - style: form - indices.exists::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. schema: type: boolean + default: false style: form - indices.exists::query.include_defaults: + indices.delete::query.master_timeout: in: query - name: include_defaults - description: If `true`, return all default settings in the response. + 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. + deprecated: true schema: - type: boolean + $ref: '#/components/schemas/_common:Duration' style: form - indices.exists::query.local: + x-version-deprecated: 2.0.0 + x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + indices.delete::query.timeout: in: query - name: local - description: If `true`, the request retrieves information from the local node only. + 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: - type: boolean + $ref: '#/components/schemas/_common:Duration' style: form indices.exists_alias::path.index: in: path @@ -11368,6 +16078,7 @@ components: description: If `true`, the request retrieves information from the local node only. schema: type: boolean + default: false style: form indices.exists_index_template::path.name: in: path @@ -11383,7 +16094,7 @@ components: description: Operation timeout for connection to cluster-manager node. schema: $ref: '#/components/schemas/_common:Duration' - x-version-added: 2.0.0 + x-version-added: '2.0' indices.exists_index_template::query.flat_settings: name: flat_settings in: query @@ -11424,20 +16135,22 @@ components: description: Operation timeout for connection to cluster-manager node. schema: $ref: '#/components/schemas/_common:Duration' - x-version-added: 2.0.0 + x-version-added: '2.0' indices.exists_template::query.flat_settings: in: query name: flat_settings - description: 'Return settings in flat format (default: false)' + description: Return settings in flat format. schema: type: boolean + default: false style: form indices.exists_template::query.local: in: query name: local - description: 'Return local information, do not retrieve the state from cluster-manager node (default: false)' + description: Return local information, do not retrieve the state from cluster-manager node. schema: type: boolean + default: false style: form indices.exists_template::query.master_timeout: in: query @@ -11449,6 +16162,74 @@ components: style: form x-version-deprecated: 2.0.0 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 (`*`). + required: true + schema: + $ref: '#/components/schemas/_common:Indices' + style: simple + 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. + schema: + type: boolean + default: false + style: form + 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' + x-version-added: '2.0' + indices.exists::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`. + Valid values are: `all`, `open`, `closed`, `hidden`, `none`. + schema: + $ref: '#/components/schemas/_common:ExpandWildcards' + style: form + indices.exists::query.flat_settings: + in: query + name: flat_settings + description: If `true`, returns settings in flat format. + schema: + type: boolean + default: false + style: form + 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. + schema: + type: boolean + default: false + style: form + indices.exists::query.include_defaults: + in: query + name: include_defaults + description: If `true`, return all default settings in the response. + schema: + type: boolean + default: false + style: form + indices.exists::query.local: + in: query + name: local + description: If `true`, the request retrieves information from the local node only. + schema: + type: boolean + default: false + style: form indices.flush::path.index: in: path name: index @@ -11499,9 +16280,10 @@ components: name: wait_if_ongoing description: |- If `true`, the flush operation blocks until execution when another flush operation is running. - If `false`, Opensearch returns an error if you request a flush when another flush operation is running. + If `false`, OpenSearch returns an error if you request a flush when another flush operation is running. schema: type: boolean + default: true style: form indices.forcemerge::path.index: in: path @@ -11528,9 +16310,10 @@ components: indices.forcemerge::query.flush: in: query name: flush - description: 'Specify whether the index should be flushed after performing the operation (default: true)' + description: Specify whether the index should be flushed after performing the operation. schema: type: boolean + default: true style: form indices.forcemerge::query.ignore_unavailable: in: query @@ -11542,7 +16325,10 @@ components: indices.forcemerge::query.max_num_segments: in: query name: max_num_segments - description: 'The number of segments the index should be merged into (default: dynamic)' + description: |- + The number of larger segments into which smaller segments are merged. + Set this parameter to 1 to merge all segments into one segment. + The default behavior is to perform the merge as necessary. schema: type: number style: form @@ -11554,6 +16340,7 @@ components: type: boolean style: form indices.forcemerge::query.primary_only: + x-version-added: '2.13' name: primary_only in: query description: Specify whether the operation should only perform on primary shards. Defaults to false. @@ -11562,87 +16349,14 @@ components: default: false description: Specify whether the operation should only perform on primary shards. Defaults to false. indices.forcemerge::query.wait_for_completion: + x-version-added: '2.7' in: query name: wait_for_completion description: Should the request wait until the force merge is completed. schema: type: boolean + default: true style: form - indices.get::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. - required: true - schema: - $ref: '#/components/schemas/_common:Indices' - style: simple - 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, - 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::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.0 - 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. - schema: - $ref: '#/components/schemas/_common:ExpandWildcards' - style: form - indices.get::query.flat_settings: - in: query - name: flat_settings - description: If true, returns settings in flat format. - schema: - type: boolean - style: form - indices.get::query.ignore_unavailable: - in: query - name: ignore_unavailable - description: If false, requests that target a missing index return an error. - schema: - type: boolean - style: form - indices.get::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::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. - schema: - type: boolean - style: form - 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. - deprecated: true - schema: - $ref: '#/components/schemas/_common:Duration' - style: form - x-version-deprecated: 2.0.0 - x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. indices.get_alias::path.index: in: path name: index @@ -11698,6 +16412,7 @@ components: description: If `true`, the request retrieves information from the local node only. schema: type: boolean + default: false style: form indices.get_data_stream::path.name: in: path @@ -11768,6 +16483,7 @@ components: description: If `true`, the request retrieves information from the local node only. schema: type: boolean + default: false style: form indices.get_index_template::path.name: in: path @@ -11783,13 +16499,14 @@ components: description: Operation timeout for connection to cluster-manager node. schema: $ref: '#/components/schemas/_common:Duration' - x-version-added: 2.0.0 + x-version-added: '2.0' indices.get_index_template::query.flat_settings: in: query name: flat_settings description: If true, returns settings in flat format. schema: type: boolean + default: false style: form indices.get_index_template::query.local: in: query @@ -11797,6 +16514,7 @@ components: description: If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the master node. schema: type: boolean + default: false style: form indices.get_index_template::query.master_timeout: in: query @@ -11834,7 +16552,7 @@ components: description: Operation timeout for connection to cluster-manager node. schema: $ref: '#/components/schemas/_common:Duration' - x-version-added: 2.0.0 + x-version-added: '2.0' indices.get_mapping::query.expand_wildcards: in: query name: expand_wildcards @@ -11853,12 +16571,23 @@ components: schema: type: boolean style: form + indices.get_mapping::query.index: + in: query + 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`. + schema: + $ref: '#/components/schemas/_common:Indices' + style: simple indices.get_mapping::query.local: in: query name: local description: If `true`, the request retrieves information from the local node only. schema: type: boolean + default: false style: form indices.get_mapping::query.master_timeout: in: query @@ -11909,7 +16638,7 @@ components: description: Operation timeout for connection to cluster-manager node. schema: $ref: '#/components/schemas/_common:Duration' - x-version-added: 2.0.0 + x-version-added: '2.0' indices.get_settings::query.expand_wildcards: in: query name: expand_wildcards @@ -11926,6 +16655,7 @@ components: description: If `true`, returns settings in flat format. schema: type: boolean + default: false style: form indices.get_settings::query.ignore_unavailable: in: query @@ -11940,6 +16670,7 @@ components: description: If `true`, return all default settings in the response. schema: type: boolean + default: false style: form indices.get_settings::query.local: in: query @@ -11949,6 +16680,7 @@ components: `false`, information is retrieved from the master node. schema: type: boolean + default: false style: form indices.get_settings::query.master_timeout: in: query @@ -11980,13 +16712,14 @@ components: description: Operation timeout for connection to cluster-manager node. schema: $ref: '#/components/schemas/_common:Duration' - x-version-added: 2.0.0 + x-version-added: '2.0' indices.get_template::query.flat_settings: in: query name: flat_settings description: If `true`, returns settings in flat format. schema: type: boolean + default: false style: form indices.get_template::query.local: in: query @@ -11994,6 +16727,7 @@ components: description: If `true`, the request retrieves information from the local node only. schema: type: boolean + default: false style: form indices.get_template::query.master_timeout: in: query @@ -12012,10 +16746,10 @@ components: in: path description: Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices. schema: - type: string - pattern: ^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$ + type: array description: Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices. - x-data-type: array + items: + type: string required: true indices.get_upgrade::query.allow_no_indices: name: allow_no_indices @@ -12037,6 +16771,86 @@ components: schema: type: boolean description: Whether specified concrete indices 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. + Wildcard expressions (*) are supported. + required: true + schema: + $ref: '#/components/schemas/_common:Indices' + style: simple + 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, + 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: + 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' + 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. + schema: + $ref: '#/components/schemas/_common:ExpandWildcards' + style: form + indices.get::query.flat_settings: + in: query + name: flat_settings + description: If true, returns settings in flat format. + schema: + type: boolean + default: false + style: form + indices.get::query.ignore_unavailable: + in: query + name: ignore_unavailable + description: If false, requests that target a missing index return an error. + schema: + type: boolean + default: false + style: form + indices.get::query.include_defaults: + in: query + name: include_defaults + description: If true, return all default settings in the response. + schema: + type: boolean + default: false + style: form + 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. + schema: + type: boolean + default: false + style: form + 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. + deprecated: true + schema: + $ref: '#/components/schemas/_common:Duration' + style: form + x-version-deprecated: 2.0.0 + x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. indices.open::path.index: in: path name: index @@ -12065,7 +16879,7 @@ components: description: Operation timeout for connection to cluster-manager node. schema: $ref: '#/components/schemas/_common:Duration' - x-version-added: 2.0.0 + x-version-added: '2.0' indices.open::query.expand_wildcards: in: query name: expand_wildcards @@ -12121,6 +16935,7 @@ components: $ref: '#/components/schemas/_common:WaitForActiveShards' style: form indices.open::query.wait_for_completion: + x-version-added: '2.7' name: wait_for_completion in: query description: Should this request wait until the operation has completed before returning. @@ -12144,7 +16959,7 @@ components: name: name description: |- Alias to update. - If the alias doesn’t exist, the request creates it. + If the alias doesn't exist, the request creates it. Index alias names support date math. required: true schema: @@ -12156,7 +16971,7 @@ components: description: Operation timeout for connection to cluster-manager node. schema: $ref: '#/components/schemas/_common:Duration' - x-version-added: 2.0.0 + x-version-added: '2.0' indices.put_alias::query.master_timeout: in: query name: master_timeout @@ -12200,13 +17015,14 @@ components: description: Operation timeout for connection to cluster-manager node. schema: $ref: '#/components/schemas/_common:Duration' - x-version-added: 2.0.0 + x-version-added: '2.0' indices.put_index_template::query.create: in: query name: create description: If `true`, this request cannot replace or update existing index templates. schema: type: boolean + default: false style: form indices.put_index_template::query.master_timeout: name: master_timeout @@ -12240,7 +17056,7 @@ components: description: Operation timeout for connection to cluster-manager node. schema: $ref: '#/components/schemas/_common:Duration' - x-version-added: 2.0.0 + x-version-added: '2.0' indices.put_mapping::query.expand_wildcards: in: query name: expand_wildcards @@ -12286,6 +17102,7 @@ components: description: If `true`, the mappings are applied only to the current write index for the target. schema: type: boolean + default: false style: form indices.put_settings::path.index: in: path @@ -12316,7 +17133,7 @@ components: description: Operation timeout for connection to cluster-manager node. schema: $ref: '#/components/schemas/_common:Duration' - x-version-added: 2.0.0 + x-version-added: '2.0' indices.put_settings::query.expand_wildcards: in: query name: expand_wildcards @@ -12334,11 +17151,12 @@ components: description: If `true`, returns settings in flat format. schema: type: boolean + default: false style: form indices.put_settings::query.ignore_unavailable: in: query name: ignore_unavailable - description: If `true`, returns settings in flat format. + description: Whether specified concrete indices should be ignored when unavailable (missing or closed). schema: type: boolean style: form @@ -12361,6 +17179,7 @@ components: description: If `true`, existing index settings remain unchanged. schema: type: boolean + default: false style: form indices.put_settings::query.timeout: in: query @@ -12385,13 +17204,14 @@ components: description: Operation timeout for connection to cluster-manager node. schema: $ref: '#/components/schemas/_common:Duration' - x-version-added: 2.0.0 + x-version-added: '2.0' indices.put_template::query.create: in: query name: create 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: in: query @@ -12409,7 +17229,7 @@ components: in: query name: order description: |- - Order in which Opensearch applies this template if index + Order in which OpenSearch applies this template if index matches multiple templates. Templates with lower 'order' values are merged first. Templates with higher @@ -12434,6 +17254,7 @@ components: description: If `true`, the response only includes ongoing shard recoveries. schema: type: boolean + default: false style: form indices.recovery::query.detailed: in: query @@ -12441,6 +17262,7 @@ components: description: If `true`, the response includes detailed information about shard recoveries. schema: type: boolean + default: false style: form indices.refresh::path.index: in: path @@ -12526,13 +17348,14 @@ components: description: Operation timeout for connection to cluster-manager node. schema: $ref: '#/components/schemas/_common:Duration' - x-version-added: 2.0.0 + x-version-added: '2.0' 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. schema: type: boolean + default: false style: form indices.rollover::query.master_timeout: in: query @@ -12608,6 +17431,7 @@ components: description: If `true`, the request returns a verbose response. schema: type: boolean + default: false style: form indices.shard_stores::path.index: in: path @@ -12676,7 +17500,7 @@ components: description: Operation timeout for connection to cluster-manager node. schema: $ref: '#/components/schemas/_common:Duration' - x-version-added: 2.0.0 + x-version-added: '2.0' indices.shrink::query.copy_settings: name: copy_settings in: query @@ -12722,6 +17546,7 @@ components: $ref: '#/components/schemas/_common:WaitForActiveShards' style: form indices.shrink::query.wait_for_completion: + x-version-added: '2.7' name: wait_for_completion in: query description: Should this request wait until the operation has completed before returning. @@ -12751,7 +17576,7 @@ components: description: Operation timeout for connection to cluster-manager node. schema: $ref: '#/components/schemas/_common:Duration' - x-version-added: 2.0.0 + x-version-added: '2.0' indices.simulate_index_template::query.create: in: query name: create @@ -12763,6 +17588,7 @@ components: simulation. schema: type: boolean + default: false style: form indices.simulate_index_template::query.master_timeout: in: query @@ -12800,13 +17626,14 @@ components: description: Operation timeout for connection to cluster-manager node. schema: $ref: '#/components/schemas/_common:Duration' - x-version-added: 2.0.0 + x-version-added: '2.0' 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. schema: type: boolean + default: false style: form indices.simulate_template::query.master_timeout: in: query @@ -12840,7 +17667,7 @@ components: description: Operation timeout for connection to cluster-manager node. schema: $ref: '#/components/schemas/_common:Duration' - x-version-added: 2.0.0 + x-version-added: '2.0' indices.split::query.copy_settings: name: copy_settings in: query @@ -12886,6 +17713,7 @@ components: $ref: '#/components/schemas/_common:WaitForActiveShards' style: form indices.split::query.wait_for_completion: + x-version-added: '2.7' name: wait_for_completion in: query description: Should this request wait until the operation has completed before returning. @@ -12946,6 +17774,7 @@ components: description: If true, statistics are not collected from closed indices. schema: type: boolean + default: true style: form indices.stats::query.groups: in: query @@ -12964,6 +17793,7 @@ components: 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: in: query @@ -12971,6 +17801,7 @@ components: 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: in: query @@ -12985,7 +17816,7 @@ components: description: Operation timeout for connection to cluster-manager node. schema: $ref: '#/components/schemas/_common:Duration' - x-version-added: 2.0.0 + x-version-added: '2.0' indices.update_aliases::query.master_timeout: in: query name: master_timeout @@ -13012,10 +17843,10 @@ components: in: path description: Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices. schema: - type: string - pattern: ^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$ + type: array description: Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices. - x-data-type: array + items: + type: string required: true indices.upgrade::query.allow_no_indices: name: allow_no_indices @@ -13045,6 +17876,7 @@ components: type: boolean 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 description: Should this request wait until the operation has completed before returning. @@ -13085,6 +17917,7 @@ components: description: If `true`, wildcard and prefix queries are analyzed. schema: type: boolean + default: false style: form indices.validate_query::query.analyzer: in: query @@ -13173,7 +18006,7 @@ components: description: Operation timeout for connection to cluster-manager node. schema: $ref: '#/components/schemas/_common:Duration' - x-version-added: 2.0.0 + x-version-added: '2.0' ingest.delete_pipeline::query.master_timeout: in: query name: master_timeout @@ -13212,7 +18045,7 @@ components: description: Operation timeout for connection to cluster-manager node. schema: $ref: '#/components/schemas/_common:Duration' - x-version-added: 2.0.0 + x-version-added: '2.0' ingest.get_pipeline::query.master_timeout: in: query name: master_timeout @@ -13239,7 +18072,7 @@ components: description: Operation timeout for connection to cluster-manager node. schema: $ref: '#/components/schemas/_common:Duration' - x-version-added: 2.0.0 + x-version-added: '2.0' ingest.put_pipeline::query.master_timeout: in: query name: master_timeout @@ -13262,7 +18095,7 @@ components: name: id description: |- Pipeline to test. - If you don’t specify a `pipeline` in the request body, this parameter is required. + If you don't specify a `pipeline` in the request body, this parameter is required. required: true schema: $ref: '#/components/schemas/_common:Id' @@ -13273,6 +18106,7 @@ components: description: If `true`, the response includes output data for each processor in the executed pipeline. schema: type: boolean + default: false style: form knn.delete_model::path.model_id: name: model_id @@ -13280,7 +18114,6 @@ components: description: The id of the model. schema: type: string - pattern: ^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$ description: The id of the model. required: true knn.get_model::path.model_id: @@ -13289,7 +18122,6 @@ components: description: The id of the model. schema: type: string - pattern: ^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$ description: The id of the model. required: true knn.search_models::query._source: @@ -13633,49 +18465,49 @@ components: in: path description: Comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes. schema: - type: string - pattern: ^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$ + type: array description: Comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes. - x-data-type: array + items: + type: string required: true 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. schema: - type: string - pattern: ^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$ + type: array description: Comma-separated list of stats to retrieve; use `_all` or empty string to retrieve all stats. - x-enum-options: - - circuit_breaker_triggered - - total_load_time - - eviction_count - - hit_count - - miss_count - - graph_memory_usage - - graph_memory_usage_percentage - - graph_index_requests - - graph_index_errors - - graph_query_requests - - graph_query_errors - - knn_query_requests - - cache_capacity_reached - - load_success_count - - load_exception_count - - indices_in_cache - - script_compilations - - script_compilation_errors - - script_query_requests - - script_query_errors - - nmslib_initialized - - faiss_initialized - - model_index_status - - indexing_from_model_degraded - - training_requests - - training_errors - - training_memory_usage - - training_memory_usage_percentage - x-data-type: array + items: + type: string + enum: + - cache_capacity_reached + - circuit_breaker_triggered + - eviction_count + - faiss_initialized + - graph_index_errors + - graph_index_requests + - graph_memory_usage + - graph_memory_usage_percentage + - graph_query_errors + - graph_query_requests + - hit_count + - indexing_from_model_degraded + - indices_in_cache + - knn_query_requests + - load_exception_count + - load_success_count + - miss_count + - model_index_status + - nmslib_initialized + - script_compilation_errors + - script_compilations + - script_query_errors + - script_query_requests + - total_load_time + - training_errors + - training_memory_usage + - training_memory_usage_percentage + - training_requests required: true knn.stats::query.timeout: name: timeout @@ -13689,7 +18521,6 @@ components: description: The id of the model. schema: type: string - pattern: ^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$ description: The id of the model. required: true knn.train_model::query.preference: @@ -13704,10 +18535,10 @@ components: in: path description: Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices. schema: - type: string - pattern: ^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$ + type: array description: Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices. - x-data-type: array + items: + type: string required: true mget::path.index: in: path @@ -13749,6 +18580,7 @@ components: description: Specifies the node or shard the operation should be performed on. Random by default. schema: type: string + default: random style: form mget::query.realtime: in: query @@ -13778,110 +18610,139 @@ components: schema: $ref: '#/components/schemas/_common:Fields' style: form - msearch::path.index: + 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: + name: model_id + in: path + required: true + schema: + type: string + 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: + name: task_id + in: path + required: true + schema: + type: string + msearch_template::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, indices, and aliases to search. + Supports wildcards (`*`). + To search all data streams and indices, omit this parameter or use `*`. required: true schema: $ref: '#/components/schemas/_common:Indices' style: simple - msearch::query.ccs_minimize_roundtrips: + msearch_template::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 are minimized for cross-cluster search requests. schema: type: boolean + default: true style: form - msearch::query.max_concurrent_searches: + msearch_template::query.max_concurrent_searches: in: query name: max_concurrent_searches - description: Maximum number of concurrent searches the multi search API can execute. - schema: - type: number - style: form - 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. - schema: - type: number - style: form - 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. + description: Maximum number of concurrent searches the API can run. schema: type: number style: form - msearch::query.rest_total_hits_as_int: + msearch_template::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`, the response returns `hits.total` as an integer. + If `false`, it returns `hits.total` as an object. schema: type: boolean + default: false style: form - msearch::query.search_type: + msearch_template::query.search_type: in: query name: search_type - description: Indicates whether global term and document frequencies should be used when scoring returned documents. + description: |- + The type of the search operation. + Available options: `query_then_fetch`, `dfs_query_then_fetch`. schema: $ref: '#/components/schemas/_common:SearchType' style: form - msearch::query.typed_keys: + msearch_template::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. + description: If `true`, the response prefixes aggregation and suggester names with their respective types. schema: type: boolean style: form - msearch_template::path.index: + msearch::path.index: in: path name: index - description: |- - 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 `*`. + description: Comma-separated list of data streams, indices, and index aliases to search. required: true schema: $ref: '#/components/schemas/_common:Indices' style: simple - msearch_template::query.ccs_minimize_roundtrips: + msearch::query.ccs_minimize_roundtrips: in: query name: ccs_minimize_roundtrips - description: If `true`, network round-trips are minimized for cross-cluster search requests. + description: If true, network roundtrips between the coordinating node and remote clusters are minimized for cross-cluster search requests. schema: type: boolean + default: true style: form - msearch_template::query.max_concurrent_searches: + msearch::query.max_concurrent_searches: in: query name: max_concurrent_searches - description: Maximum number of concurrent searches the API can run. + description: Maximum number of concurrent searches the multi search API can execute. schema: type: number style: form - msearch_template::query.rest_total_hits_as_int: + 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. + schema: + type: number + default: 5 + style: form + 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. + schema: + type: number + style: form + msearch::query.rest_total_hits_as_int: in: query name: rest_total_hits_as_int - description: |- - If `true`, the response returns `hits.total` as an integer. - If `false`, it returns `hits.total` as 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_template::query.search_type: + msearch::query.search_type: in: query name: search_type - description: |- - The type of the search operation. - Available options: `query_then_fetch`, `dfs_query_then_fetch`. + description: Indicates whether global term and document frequencies should be used when scoring returned documents. schema: $ref: '#/components/schemas/_common:SearchType' style: form - msearch_template::query.typed_keys: + msearch::query.typed_keys: in: query name: typed_keys - description: If `true`, the response prefixes aggregation and suggester names with their respective types. + description: Specifies whether aggregation and suggester names should be prefixed by their respective types in the response. schema: type: boolean style: form @@ -13899,6 +18760,7 @@ components: description: If `true`, the response includes the document count, sum of document frequencies, and sum of total term frequencies. schema: type: boolean + default: true style: form mtermvectors::query.fields: in: query @@ -13924,6 +18786,7 @@ components: description: If `true`, the response includes term offsets. schema: type: boolean + default: true style: form mtermvectors::query.payloads: in: query @@ -13931,6 +18794,7 @@ components: description: If `true`, the response includes term payloads. schema: type: boolean + default: true style: form mtermvectors::query.positions: in: query @@ -13938,6 +18802,7 @@ components: description: If `true`, the response includes term positions. schema: type: boolean + default: true style: form mtermvectors::query.preference: in: query @@ -13947,6 +18812,7 @@ components: Random by default. schema: type: string + default: random style: form mtermvectors::query.realtime: in: query @@ -13954,6 +18820,7 @@ components: description: If true, the request is real-time as opposed to near-real-time. schema: type: boolean + default: true style: form mtermvectors::query.routing: in: query @@ -13968,6 +18835,7 @@ components: description: If true, the response includes term frequency and document frequency. schema: type: boolean + default: false style: form mtermvectors::query.version: in: query @@ -13988,10 +18856,10 @@ components: in: path description: Comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes. schema: - type: string - pattern: ^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$ + type: array description: Comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes. - x-data-type: array + items: + type: string required: true nodes.hot_threads::query.ignore_idle_threads: name: ignore_idle_threads @@ -14055,12 +18923,29 @@ components: schema: $ref: '#/components/schemas/_common:NodeIds' style: simple + 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. + required: true + schema: + anyOf: + - title: node_id + $ref: '#/components/schemas/_common:NodeIds' + - title: metric + type: array + items: + $ref: '#/components/schemas/nodes.info:Metric' + style: simple nodes.info::query.flat_settings: in: query name: flat_settings description: If true, returns settings in flat format. schema: type: boolean + default: false style: form nodes.info::query.timeout: in: query @@ -14150,6 +19035,7 @@ components: 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: in: query @@ -14261,6 +19147,16 @@ components: in: query schema: type: string + 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: + name: email_group.recipient_list.recipient.keyword + in: query + schema: + type: string notifications.get_configs::query.email.email_account_id: name: email.email_account_id in: query @@ -14281,16 +19177,6 @@ components: in: query schema: type: string - 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: - name: email_group.recipient_list.recipient.keyword - in: query - schema: - type: string notifications.get_configs::query.is_enabled: name: is_enabled in: query @@ -14460,7 +19346,7 @@ components: description: Operation timeout for connection to cluster-manager node. schema: $ref: '#/components/schemas/_common:Duration' - x-version-added: 2.0.0 + x-version-added: '2.0' put_script::query.master_timeout: in: query name: master_timeout @@ -14520,13 +19406,28 @@ components: schema: type: string style: form + reindex_rethrottle::path.task_id: + in: path + name: task_id + description: Identifier for the task. + required: true + schema: + $ref: '#/components/schemas/_common:Id' + style: simple + reindex_rethrottle::query.requests_per_second: + in: query + name: requests_per_second + description: The throttle for this request in sub-requests per second. + schema: + type: number + style: form reindex::query.max_docs: name: max_docs in: query - description: 'Maximum number of documents to process (default: all documents).' + description: Maximum number of documents to process. By default, all documents. schema: type: integer - description: 'Maximum number of documents to process (default: all documents).' + description: Maximum number of documents to process. By default, all documents. format: int32 reindex::query.refresh: in: query @@ -14543,6 +19444,7 @@ components: Defaults to no throttle. schema: type: number + default: 0 style: form reindex::query.scroll: in: query @@ -14556,10 +19458,11 @@ components: 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. + Defaults to 1 slice, meaning the task isn't sliced into subtasks. schema: $ref: '#/components/schemas/_common:Slices' style: form + x-default: '1' reindex::query.timeout: in: query name: timeout @@ -14567,6 +19470,7 @@ components: schema: $ref: '#/components/schemas/_common:Duration' style: form + x-default: 1m reindex::query.wait_for_active_shards: in: query name: wait_for_active_shards @@ -14576,27 +19480,14 @@ components: schema: $ref: '#/components/schemas/_common:WaitForActiveShards' style: form + x-default: '1' reindex::query.wait_for_completion: in: query name: wait_for_completion description: If `true`, the request blocks until the operation is complete. schema: type: boolean - style: form - reindex_rethrottle::path.task_id: - in: path - name: task_id - description: Identifier for the task. - required: true - schema: - $ref: '#/components/schemas/_common:Id' - style: simple - reindex_rethrottle::query.requests_per_second: - in: query - name: requests_per_second - description: The throttle for this request in sub-requests per second. - schema: - type: number + default: true style: form remote_store.restore::query.cluster_manager_timeout: name: cluster_manager_timeout @@ -14604,7 +19495,7 @@ components: description: Operation timeout for connection to cluster-manager node. schema: $ref: '#/components/schemas/_common:Duration' - x-version-added: 2.0.0 + x-version-added: '2.0' remote_store.restore::query.wait_for_completion: name: wait_for_completion in: query @@ -14623,6 +19514,68 @@ components: schema: $ref: '#/components/schemas/_common:Id' style: simple + rollups.delete::path.id: + name: id + in: path + description: Rollup to access + required: true + schema: + $ref: '#/components/schemas/_common:Id' + style: simple + rollups.explain::path.id: + name: id + in: path + description: Rollup to access + required: true + schema: + $ref: '#/components/schemas/_common:Id' + style: simple + rollups.get::path.id: + name: id + in: path + description: Rollup to access + required: true + schema: + $ref: '#/components/schemas/_common:Id' + style: simple + rollups.put::path.id: + name: id + in: path + description: Rollup to access + required: true + schema: + $ref: '#/components/schemas/_common:Id' + style: simple + 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: + name: if_seq_no + in: query + description: Only perform the operation if the document has this sequence number. + schema: + $ref: '#/components/schemas/_common:SequenceNumber' + style: form + rollups.start::path.id: + name: id + in: path + description: Rollup to access + required: true + schema: + $ref: '#/components/schemas/_common:Id' + style: simple + rollups.stop::path.id: + name: id + in: path + description: Rollup to access + required: true + schema: + $ref: '#/components/schemas/_common:Id' + style: simple scroll::path.scroll_id: in: path name: scroll_id @@ -14635,9 +19588,10 @@ components: 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: in: query @@ -14654,6 +19608,235 @@ components: schema: $ref: '#/components/schemas/_common:ScrollId' style: form + search_pipeline.delete::path.id: + name: id + in: path + description: Pipeline ID. + schema: + type: string + required: true + 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' + x-version-added: '2.0' + search_pipeline.delete::query.timeout: + name: timeout + in: query + description: Operation timeout. + schema: + $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: + 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' + search_pipeline.put::path.id: + name: id + in: path + description: Pipeline ID. + schema: + type: string + required: true + 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' + x-version-added: '2.0' + search_pipeline.put::query.timeout: + name: timeout + in: query + description: Operation timeout. + schema: + $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. + required: true + schema: + $ref: '#/components/schemas/_common:Indices' + style: simple + 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. + 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: + 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`. + Valid values are: `all`, `open`, `closed`, `hidden`, `none`. + schema: + $ref: '#/components/schemas/_common:ExpandWildcards' + style: form + 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: + in: query + name: local + description: If `true`, the request retrieves information from the local node only. + schema: + type: boolean + default: false + style: form + search_shards::query.preference: + in: query + name: preference + description: |- + Specifies the node or shard the operation should be performed on. + Random by default. + schema: + type: string + default: random + style: form + search_shards::query.routing: + in: query + name: routing + description: Custom value used to route operations to a specific shard. + schema: + $ref: '#/components/schemas/_common:Routing' + style: form + search_template::path.index: + in: path + name: index + description: |- + Comma-separated list of data streams, indices, + and aliases to search. Supports wildcards (*). + required: true + schema: + $ref: '#/components/schemas/_common:Indices' + style: simple + 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. + 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: + in: query + name: ccs_minimize_roundtrips + description: If `true`, network round-trips are minimized for cross-cluster search requests. + schema: + type: boolean + default: true + style: form + search_template::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`. + Valid values are: `all`, `open`, `closed`, `hidden`, `none`. + schema: + $ref: '#/components/schemas/_common:ExpandWildcards' + style: form + 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: + in: query + name: ignore_throttled + description: If `true`, specified concrete, expanded, or aliased indices are not included in the response when throttled. + schema: + type: boolean + style: form + 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: + in: query + name: preference + description: |- + Specifies the node or shard the operation should be performed on. + Random by default. + schema: + type: string + default: random + style: form + 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: + in: query + name: rest_total_hits_as_int + description: If true, hits.total are rendered as an integer in the response. + schema: + type: boolean + default: false + style: form + search_template::query.routing: + in: query + name: routing + description: Custom value used to route operations to a specific shard. + schema: + $ref: '#/components/schemas/_common:Routing' + style: form + 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' + style: form + search_template::query.search_type: + in: query + name: search_type + description: The type of the search operation. + schema: + $ref: '#/components/schemas/_common:SearchType' + style: form + 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: in: path name: index @@ -14715,6 +19898,7 @@ components: 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: in: query @@ -14724,6 +19908,7 @@ components: This parameter can only be used when the q query string parameter is specified. schema: type: boolean + default: false style: form search::query.analyzer: in: query @@ -14742,6 +19927,16 @@ components: 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. schema: type: number + default: 512 + style: form + 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' style: form search::query.ccs_minimize_roundtrips: in: query @@ -14749,6 +19944,7 @@ components: 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: in: query @@ -14802,6 +19998,7 @@ components: To page through more hits, use the `search_after` parameter. schema: type: number + default: 0 style: form search::query.ignore_throttled: in: query @@ -14842,6 +20039,15 @@ components: 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. schema: type: number + default: 5 + style: form + search::query.phase_took: + name: phase_took + in: query + description: Indicates whether to return phase-level `took` time values in the response. + schema: + type: boolean + default: false style: form search::query.pre_filter_shard_size: in: query @@ -14861,7 +20067,7 @@ components: name: preference description: |- Nodes and shards used for the search. - By default, Opensearch selects from eligible nodes and shards using adaptive replica selection, accounting for allocation awareness. Valid values are: + By default, OpenSearch selects from eligible nodes and shards using adaptive replica selection, accounting for allocation awareness. Valid values are: `_only_local` to run the search only on shards on the local node; `_local` to, if possible, run the search on shards on the local node, or if not, select shards using the default method; `_only_nodes:,` to run the search on only the specified nodes IDs, where, if suitable shards exist on more than one selected node, use shards on those nodes using the default method, or if none of the specified nodes are available, select shards from any available node using the default method; @@ -14870,13 +20076,14 @@ components: `` (any string that does not start with `_`) to route searches with the same `` to the same shards in the same order. schema: type: string + default: random style: form search::query.q: in: query name: q description: |- Query in the Lucene query string syntax using query parameter search. - Query parameter searches do not support the full Opensearch Query DSL but are handy for testing. + Query parameter searches do not support the full OpenSearch Query DSL but are handy for testing. schema: type: string style: form @@ -14895,6 +20102,7 @@ components: description: Indicates whether `hits.total` should be rendered as an integer or an object in the rest search response. schema: type: boolean + default: false style: form search::query.routing: in: query @@ -14943,6 +20151,7 @@ components: To page through more hits, use the `search_after` parameter. schema: type: number + default: 10 style: form search::query.sort: in: query @@ -15014,11 +20223,11 @@ components: name: 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. + 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. + OpenSearch applies this parameter to each shard handling the request. + When possible, let OpenSearch perform early termination automatically. Avoid specifying this parameter for requests that target data streams with backing indices across multiple data tiers. If set to `0` (default), the query does not terminate early. schema: @@ -15064,204 +20273,35 @@ components: schema: type: boolean style: form - search_pipeline.create::path.pipeline: - name: pipeline - in: path - schema: - type: string - required: true - search_pipeline.get::path.pipeline: - name: pipeline - in: path - schema: - type: string - required: true - search_shards::path.index: - in: path - name: index - description: Returns the indices and shards that a search request would be executed against. - required: true - schema: - $ref: '#/components/schemas/_common:Indices' - style: simple - 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. - 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: - 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`. - Valid values are: `all`, `open`, `closed`, `hidden`, `none`. - schema: - $ref: '#/components/schemas/_common:ExpandWildcards' - style: form - 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: - in: query - name: local - description: If `true`, the request retrieves information from the local node only. - schema: - type: boolean - style: form - search_shards::query.preference: - in: query - name: preference - description: |- - Specifies the node or shard the operation should be performed on. - Random by default. - schema: - type: string - style: form - search_shards::query.routing: - in: query - name: routing - description: Custom value used to route operations to a specific shard. - schema: - $ref: '#/components/schemas/_common:Routing' - style: form - search_template::path.index: - in: path - name: index - description: |- - Comma-separated list of data streams, indices, - and aliases to search. Supports wildcards (*). - required: true - schema: - $ref: '#/components/schemas/_common:Indices' - style: simple - 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. - 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: - in: query - name: ccs_minimize_roundtrips - description: If `true`, network round-trips are minimized for cross-cluster search requests. - schema: - type: boolean - style: form - search_template::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`. - Valid values are: `all`, `open`, `closed`, `hidden`, `none`. - schema: - $ref: '#/components/schemas/_common:ExpandWildcards' - style: form - 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: - in: query - name: ignore_throttled - description: If `true`, specified concrete, expanded, or aliased indices are not included in the response when throttled. - schema: - type: boolean - style: form - search_template::query.ignore_unavailable: + security.authinfo::query.auth_type: + name: auth_type 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: - in: query - name: preference - description: |- - Specifies the node or shard the operation should be performed on. - Random by default. + description: The type of current authentication request. schema: type: string - style: form - 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: - in: query - name: rest_total_hits_as_int - description: If true, hits.total are rendered as an integer in the response. - schema: - type: boolean - style: form - search_template::query.routing: - in: query - name: routing - description: Custom value used to route operations to a specific shard. - schema: - $ref: '#/components/schemas/_common:Routing' - style: form - 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' - style: form - search_template::query.search_type: - in: query - name: search_type - description: The type of the search operation. - schema: - $ref: '#/components/schemas/_common:SearchType' - style: form - search_template::query.typed_keys: + required: false + security.authinfo::query.verbose: + name: verbose in: query - name: typed_keys - description: If `true`, the response prefixes aggregation and suggester names with their respective types. + description: Indicates whether a verbose response should be returned. schema: type: boolean - style: form + required: false security.create_action_group::path.action_group: name: action_group in: path - description: The name of the action group to create or replace + description: The name of the action group to create or replace. schema: type: string - description: The name of the action group to create or replace + description: The name of the action group to create or replace. required: true - security.create_role::path.role: + security.create_role_mapping::path.role: name: role in: path schema: type: string required: true - security.create_role_mapping::path.role: + security.create_role::path.role: name: role in: path schema: @@ -15273,6 +20313,12 @@ components: schema: type: string required: true + security.create_user_legacy::path.username: + name: username + in: path + schema: + type: string + required: true security.create_user::path.username: name: username in: path @@ -15287,19 +20333,19 @@ components: type: string description: Action group to delete. required: true - security.delete_distinguished_names::path.cluster_name: + security.delete_distinguished_name::path.cluster_name: name: cluster_name in: path schema: type: string required: true - security.delete_role::path.role: + security.delete_role_mapping::path.role: name: role in: path schema: type: string required: true - security.delete_role_mapping::path.role: + security.delete_role::path.role: name: role in: path schema: @@ -15311,12 +20357,30 @@ components: schema: type: string required: true + security.delete_user_legacy::path.username: + name: username + in: path + schema: + type: string + required: true security.delete_user::path.username: name: username in: path schema: type: string required: true + security.generate_user_token_legacy::path.username: + name: username + in: path + schema: + type: string + required: true + security.generate_user_token::path.username: + name: username + in: path + schema: + type: string + required: true security.get_action_group::path.action_group: name: action_group in: path @@ -15325,44 +20389,76 @@ components: type: string description: Action group to retrieve. required: true - security.get_distinguished_names::path.cluster_name: + security.get_distinguished_name::path.cluster_name: name: cluster_name in: path schema: type: string required: true - security.get_role::path.role: + security.get_distinguished_name::query.show_all: + name: show_all + in: query + schema: + type: boolean + required: false + security.get_distinguished_names::query.show_all: + name: show_all + in: query + schema: + type: boolean + required: false + security.get_role_mapping::path.role: name: role in: path schema: type: string required: true - security.get_role_mapping::path.role: + security.get_role::path.role: name: role in: path schema: type: string required: true + security.get_sslinfo::query.show_dn: + name: show_dn + in: query + description: The domain names from all certificates. + schema: + type: string + description: A boolean flag to indicate whether all domain names should be returned. + required: false security.get_tenant::path.tenant: name: tenant in: path schema: type: string required: true + security.get_user_legacy::path.username: + name: username + in: path + schema: + type: string + required: true security.get_user::path.username: name: username in: path schema: type: string required: true + security.health::query.mode: + name: mode + in: query + schema: + type: string + required: false security.patch_action_group::path.action_group: name: action_group in: path schema: type: string required: true - security.patch_role::path.role: - name: role + security.patch_distinguished_name::path.cluster_name: + name: cluster_name in: path schema: type: string @@ -15373,6 +20469,12 @@ components: schema: type: string required: true + security.patch_role::path.role: + name: role + in: path + schema: + type: string + required: true security.patch_tenant::path.tenant: name: tenant in: path @@ -15385,12 +20487,18 @@ components: schema: type: string required: true - security.update_distinguished_names::path.cluster_name: + security.update_distinguished_name::path.cluster_name: name: cluster_name in: path schema: type: string required: true + security.validate::query.accept_invalid: + name: accept_invalid + in: query + schema: + type: boolean + required: false snapshot.cleanup_repository::path.repository: in: path name: repository @@ -15405,7 +20513,7 @@ components: description: Operation timeout for connection to cluster-manager node. schema: $ref: '#/components/schemas/_common:Duration' - x-version-added: 2.0.0 + x-version-added: '2.0' snapshot.cleanup_repository::query.master_timeout: in: query name: master_timeout @@ -15453,7 +20561,7 @@ components: description: Operation timeout for connection to cluster-manager node. schema: $ref: '#/components/schemas/_common:Duration' - x-version-added: 2.0.0 + x-version-added: '2.0' snapshot.clone::query.master_timeout: in: query name: master_timeout @@ -15464,6 +20572,45 @@ components: style: form x-version-deprecated: 2.0.0 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' + style: simple + 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' + x-version-added: '2.0' + snapshot.create_repository::query.master_timeout: + in: query + name: master_timeout + description: Explicit operation timeout for connection to master node + deprecated: true + schema: + $ref: '#/components/schemas/_common:Duration' + style: form + x-version-deprecated: 2.0.0 + 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' + style: form + 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: in: path name: repository @@ -15486,7 +20633,7 @@ components: description: Operation timeout for connection to cluster-manager node. schema: $ref: '#/components/schemas/_common:Duration' - x-version-added: 2.0.0 + x-version-added: '2.0' snapshot.create::query.master_timeout: in: query name: master_timeout @@ -15503,23 +20650,24 @@ components: description: If `true`, the request returns a response when the snapshot is complete. If `false`, the request returns a response when the snapshot initializes. schema: type: boolean + default: false style: form - snapshot.create_repository::path.repository: + snapshot.delete_repository::path.repository: in: path name: repository - description: A repository name + description: Name of the snapshot repository to unregister. Wildcard (`*`) patterns are supported. required: true schema: - $ref: '#/components/schemas/_common:Name' + $ref: '#/components/schemas/_common:Names' style: simple - snapshot.create_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' - x-version-added: 2.0.0 - snapshot.create_repository::query.master_timeout: + x-version-added: '2.0' + snapshot.delete_repository::query.master_timeout: in: query name: master_timeout description: Explicit operation timeout for connection to master node @@ -15529,20 +20677,13 @@ components: style: form x-version-deprecated: 2.0.0 x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. - snapshot.create_repository::query.timeout: + snapshot.delete_repository::query.timeout: in: query name: timeout description: Explicit operation timeout schema: $ref: '#/components/schemas/_common:Duration' style: form - snapshot.create_repository::query.verify: - in: query - name: verify - description: Whether to verify the repository after creation - schema: - type: boolean - style: form snapshot.delete::path.repository: in: path name: repository @@ -15565,7 +20706,7 @@ components: description: Operation timeout for connection to cluster-manager node. schema: $ref: '#/components/schemas/_common:Duration' - x-version-added: 2.0.0 + x-version-added: '2.0' snapshot.delete::query.master_timeout: in: query name: master_timeout @@ -15576,22 +20717,30 @@ components: style: form x-version-deprecated: 2.0.0 x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. - snapshot.delete_repository::path.repository: + snapshot.get_repository::path.repository: in: path name: repository - description: Name of the snapshot repository to unregister. Wildcard (`*`) patterns are supported. + description: A comma-separated list of repository names required: true schema: $ref: '#/components/schemas/_common:Names' style: simple - snapshot.delete_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' - x-version-added: 2.0.0 - snapshot.delete_repository::query.master_timeout: + x-version-added: '2.0' + snapshot.get_repository::query.local: + in: query + name: local + description: Return local information, do not retrieve the state from cluster-manager node. + schema: + type: boolean + default: false + style: form + snapshot.get_repository::query.master_timeout: in: query name: master_timeout description: Explicit operation timeout for connection to master node @@ -15601,13 +20750,6 @@ components: style: form x-version-deprecated: 2.0.0 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' - style: form snapshot.get::path.repository: in: path name: repository @@ -15633,13 +20775,14 @@ components: description: Operation timeout for connection to cluster-manager node. schema: $ref: '#/components/schemas/_common:Duration' - x-version-added: 2.0.0 + x-version-added: '2.0' snapshot.get::query.ignore_unavailable: in: query name: ignore_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: in: query @@ -15654,42 +20797,10 @@ components: 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. - schema: - type: boolean - style: form - 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' - style: simple - 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' - x-version-added: 2.0.0 - snapshot.get_repository::query.local: - in: query - name: local - description: 'Return local information, do not retrieve the state from cluster-manager node (default: false)' + 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.get_repository::query.master_timeout: - in: query - name: master_timeout - description: Explicit operation timeout for connection to master node - deprecated: true - schema: - $ref: '#/components/schemas/_common:Duration' - style: form - x-version-deprecated: 2.0.0 - x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. snapshot.restore::path.repository: in: path name: repository @@ -15712,7 +20823,7 @@ components: description: Operation timeout for connection to cluster-manager node. schema: $ref: '#/components/schemas/_common:Duration' - x-version-added: 2.0.0 + x-version-added: '2.0' snapshot.restore::query.master_timeout: in: query name: master_timeout @@ -15729,6 +20840,7 @@ components: description: Should this request wait until the operation has completed before returning schema: type: boolean + default: false style: form snapshot.status::path.repository: in: path @@ -15752,13 +20864,14 @@ components: description: Operation timeout for connection to cluster-manager node. schema: $ref: '#/components/schemas/_common:Duration' - x-version-added: 2.0.0 + x-version-added: '2.0' 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 schema: type: boolean + default: false style: form snapshot.status::query.master_timeout: in: query @@ -15784,7 +20897,7 @@ components: description: Operation timeout for connection to cluster-manager node. schema: $ref: '#/components/schemas/_common:Duration' - x-version-added: 2.0.0 + x-version-added: '2.0' snapshot.verify_repository::query.master_timeout: in: query name: master_timeout @@ -15843,6 +20956,7 @@ components: description: Should the request block until the cancellation of the task and its descendant tasks is completed. Defaults to false schema: type: boolean + default: false style: form tasks.get::path.task_id: in: path @@ -15867,6 +20981,7 @@ components: description: If `true`, the request blocks until the task has completed. schema: type: boolean + default: false style: form tasks.list::query.actions: in: query @@ -15885,6 +21000,7 @@ components: description: If `true`, the response includes detailed information about shard recoveries. schema: type: boolean + default: false style: form tasks.list::query.group_by: in: query @@ -15924,6 +21040,7 @@ components: description: If `true`, the request blocks until the operation is complete. schema: type: boolean + default: false style: form termvectors::path.id: in: path @@ -15947,6 +21064,7 @@ components: description: If `true`, the response includes the document count, sum of document frequencies, and sum of total term frequencies. schema: type: boolean + default: true style: form termvectors::query.fields: in: query @@ -15963,6 +21081,7 @@ components: description: If `true`, the response includes term offsets. schema: type: boolean + default: true style: form termvectors::query.payloads: in: query @@ -15970,6 +21089,7 @@ components: description: If `true`, the response includes term payloads. schema: type: boolean + default: true style: form termvectors::query.positions: in: query @@ -15977,6 +21097,7 @@ components: description: If `true`, the response includes term positions. schema: type: boolean + default: true style: form termvectors::query.preference: in: query @@ -15986,6 +21107,7 @@ components: Random by default. schema: type: string + default: random style: form termvectors::query.realtime: in: query @@ -15993,6 +21115,7 @@ components: description: If true, the request is real-time as opposed to near-real-time. schema: type: boolean + default: true style: form termvectors::query.routing: in: query @@ -16007,6 +21130,7 @@ components: description: If `true`, the response includes term frequency and document frequency. schema: type: boolean + default: false style: form termvectors::query.version: in: query @@ -16022,116 +21146,124 @@ components: schema: $ref: '#/components/schemas/_common:VersionType' style: form - update::path.id: - in: path + transforms.delete::path.id: name: id - description: Document ID + in: path + description: Transform to delete required: true schema: $ref: '#/components/schemas/_common:Id' style: simple - update::path.index: + transforms.explain::path.id: + name: id in: path - name: index - description: The name of the index + description: Transform to explain required: true schema: - $ref: '#/components/schemas/_common:IndexName' + $ref: '#/components/schemas/_common:Id' style: simple - update::query._source: - in: query - name: _source - description: |- - 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' - style: form - update::query._source_excludes: - in: query - name: _source_excludes - description: Specify the source fields you want to exclude. + transforms.get::path.id: + name: id + in: path + description: Transform to access + required: true schema: - $ref: '#/components/schemas/_common:Fields' - style: form - update::query._source_includes: - in: query - name: _source_includes - description: Specify the source fields you want to retrieve. + $ref: '#/components/schemas/_common:Id' + style: simple + transforms.put::path.id: + name: id + in: path + description: Transform to create/update + required: true schema: - $ref: '#/components/schemas/_common:Fields' - style: form - update::query.if_primary_term: - in: query + $ref: '#/components/schemas/_common:Id' + style: simple + transforms.put::query.if_primary_term: name: if_primary_term + in: query description: Only perform the operation if the document has this primary term. + required: false schema: type: number style: form - update::query.if_seq_no: - in: query + 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' style: form - update::query.lang: + transforms.search::query.from: + name: from in: query - name: lang - description: The script language. + description: The starting transform to return. Default is `0`. + required: false schema: - type: string - style: form - 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. - schema: - $ref: '#/components/schemas/_common:Refresh' + type: number style: form - update::query.require_alias: + transforms.search::query.search: + name: search in: query - name: require_alias - description: If true, the destination must be an index alias. + description: The search term to use to filter results. + required: false schema: - type: boolean + type: string style: form - update::query.retry_on_conflict: + transforms.search::query.size: + name: size in: query - name: retry_on_conflict - description: Specify how many times should the operation be retried when a conflict occurs. + description: Specifies the number of transforms to return. Default is `10`. + required: false schema: type: number style: form - update::query.routing: + transforms.search::query.sortDirection: + name: sortDirection in: query - name: routing - description: Custom value used to route operations to a specific shard. + description: Specifies the direction to sort results in. Can be `ASC` or `DESC`. Default is `ASC`. + required: false schema: - $ref: '#/components/schemas/_common:Routing' + type: string style: form - update::query.timeout: + transforms.search::query.sortField: + name: sortField in: query - name: timeout - description: |- - Period to wait for dynamic mapping updates and active shards. - This guarantees Opensearch waits for at least the timeout before failing. - The actual wait time could be longer, particularly when multiple waits occur. + description: The field to sort results with. + required: false schema: - $ref: '#/components/schemas/_common:Duration' + type: string style: form - update::query.wait_for_active_shards: + transforms.start::path.id: + name: id + in: path + description: Transform to start + required: true + schema: + $ref: '#/components/schemas/_common:Id' + style: simple + transforms.stop::path.id: + name: id + in: path + description: Transform to stop + required: true + schema: + $ref: '#/components/schemas/_common:Id' + style: simple + 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' + style: simple + update_by_query_rethrottle::query.requests_per_second: in: query - name: wait_for_active_shards - description: |- - The number of shard copies that must be active before proceeding with the operations. - 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. + name: requests_per_second + description: The throttle for this request in sub-requests per second. schema: - $ref: '#/components/schemas/_common:WaitForActiveShards' + type: number style: form update_by_query::path.index: in: path @@ -16193,6 +21325,7 @@ components: description: If `true`, wildcard and prefix queries are analyzed. schema: type: boolean + default: false style: form update_by_query::query.analyzer: in: query @@ -16236,9 +21369,10 @@ components: update_by_query::query.from: in: query name: from - description: 'Starting offset (default: 0)' + description: Starting offset. schema: type: number + default: 0 style: form update_by_query::query.ignore_unavailable: in: query @@ -16281,6 +21415,7 @@ components: Random by default. schema: type: string + default: random style: form update_by_query::query.q: name: q @@ -16292,7 +21427,7 @@ components: update_by_query::query.refresh: in: query name: refresh - description: If `true`, Opensearch refreshes affected shards to make the operation visible to search. + description: If `true`, OpenSearch refreshes affected shards to make the operation visible to search. schema: type: boolean style: form @@ -16309,6 +21444,7 @@ components: description: The throttle for this request in sub-requests per second. schema: type: number + default: 0 style: form update_by_query::query.routing: in: query @@ -16330,6 +21466,7 @@ components: description: Size of the scroll request that powers the operation. schema: type: number + default: 100 style: form update_by_query::query.search_timeout: in: query @@ -16360,6 +21497,7 @@ components: schema: $ref: '#/components/schemas/_common:Slices' style: form + x-default: '1' update_by_query::query.sort: in: query name: sort @@ -16383,11 +21521,11 @@ components: name: 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. + 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. + 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. schema: type: number @@ -16399,6 +21537,7 @@ components: schema: $ref: '#/components/schemas/_common:Duration' style: form + x-default: 1m update_by_query::query.version: in: query name: version @@ -16415,41 +21554,142 @@ components: schema: $ref: '#/components/schemas/_common:WaitForActiveShards' style: form + x-default: '1' update_by_query::query.wait_for_completion: in: query name: wait_for_completion description: If `true`, the request blocks until the operation is complete. schema: type: boolean + default: true style: form - update_by_query_rethrottle::path.task_id: + update::path.id: in: path - name: task_id - description: The ID for the task. + name: id + description: Document ID required: true schema: $ref: '#/components/schemas/_common:Id' style: simple - update_by_query_rethrottle::query.requests_per_second: + update::path.index: + in: path + name: index + description: The name of the index + required: true + schema: + $ref: '#/components/schemas/_common:IndexName' + style: simple + update::query._source: in: query - name: requests_per_second - description: The throttle for this request in sub-requests per second. + name: _source + description: |- + 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' + style: form + update::query._source_excludes: + in: query + name: _source_excludes + description: Specify the source fields you want to exclude. + schema: + $ref: '#/components/schemas/_common:Fields' + style: form + update::query._source_includes: + in: query + name: _source_includes + description: Specify the source fields you want to retrieve. + schema: + $ref: '#/components/schemas/_common:Fields' + style: form + update::query.if_primary_term: + in: query + name: if_primary_term + description: Only perform the operation if the document has this primary term. + schema: + type: number + style: form + 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' + style: form + update::query.lang: + in: query + name: lang + description: The script language. + schema: + type: string + default: painless + style: form + 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. + schema: + $ref: '#/components/schemas/_common:Refresh' + style: form + update::query.require_alias: + in: query + name: require_alias + description: If true, the destination must be an index alias. + schema: + type: boolean + default: false + style: form + 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. schema: type: number + default: 0 + style: form + update::query.routing: + in: query + name: routing + description: Custom value used to route operations to a specific shard. + schema: + $ref: '#/components/schemas/_common:Routing' + style: form + update::query.timeout: + in: query + name: timeout + description: |- + Period to wait for dynamic mapping updates and active shards. + 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' style: form + update::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 operations. + 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' + style: form + x-default: '1' requestBodies: bulk: content: - application/json: + application/x-ndjson: schema: type: array items: - oneOf: + anyOf: - $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 - x-serialize: bulk required: true cat.pit_segments: content: @@ -16521,12 +21761,10 @@ components: properties: persistent: type: object - additionalProperties: - type: object + additionalProperties: {} transient: type: object - additionalProperties: - type: object + additionalProperties: {} description: The settings to be updated. Can be either `transient` or `persistent` (survives cluster restart). required: true cluster.reroute: @@ -16623,7 +21861,7 @@ components: analyzer: description: |- The name of the analyzer that should be applied to the provided `text`. - This could be a built-in analyzer, or an analyzer that’s been configured in the index. + This could be a built-in analyzer, or an analyzer that's been configured in the index. type: string attributes: description: Array of token attributes used to filter the output of the `explain` parameter. @@ -16705,9 +21943,9 @@ components: 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 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. + If an alias points to multiple indices 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' @@ -16732,13 +21970,13 @@ components: template: $ref: '#/components/schemas/indices.put_index_template:IndexTemplateMapping' data_stream: - $ref: '#/components/schemas/indices._common:DataStreamVisibility' + $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. + This number is not automatically generated by OpenSearch. type: number version: $ref: '#/components/schemas/_common:VersionNumber' @@ -16831,7 +22069,7 @@ components: $ref: '#/components/schemas/_common.mapping:TypeMapping' order: description: |- - Order in which Opensearch applies this template if index + Order in which OpenSearch applies this template if index matches multiple templates. Templates with lower 'order' values are merged first. Templates with higher @@ -16914,13 +22152,13 @@ components: template: $ref: '#/components/schemas/indices.put_index_template:IndexTemplateMapping' data_stream: - $ref: '#/components/schemas/indices._common:DataStreamVisibility' + $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. + This number is not automatically generated by OpenSearch. type: number version: $ref: '#/components/schemas/_common:VersionNumber' @@ -16946,8 +22184,7 @@ components: settings: description: Configuration options for the target index. type: object - additionalProperties: - type: object + additionalProperties: {} description: The configuration for the target index (`settings` and `aliases`) indices.update_aliases: content: @@ -16983,7 +22220,7 @@ components: description: Description of the ingest pipeline. type: string on_failure: - 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. + 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' @@ -17060,25 +22297,95 @@ components: $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 - msearch: + ml.register_model: + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: The model name. + version: + type: string + description: The model version. + model_format: + type: string + description: The portable format of the model file. + enum: + - ONNX + - TORCH_SCRIPT + description: + type: string + description: The model description. + model_group_id: + type: string + description: The ID of the model group to which to register the model. + required: + - model_format + - name + - version + ml.register_model_group: content: application/json: + schema: + type: object + properties: + name: + type: string + description: The model group name. + description: + type: string + description: The model group description. + access_mode: + type: string + description: The model group access mode. + enum: + - private + - public + - restricted + backend_roles: + type: array + items: + type: string + description: The backend roles. + add_all_backend_roles: + type: boolean + description: The add all backend roles. + required: + - name + ml.search_models: + content: + application/json: + schema: + type: object + properties: + query: + type: object + description: The query. + size: + type: integer + description: The number of models to return. + required: + - query + - size + msearch: + content: + application/x-ndjson: schema: type: array items: $ref: '#/components/schemas/_core.msearch:RequestItem' description: The request definitions (metadata-search request definition pairs), separated by newlines - x-serialize: bulk required: true msearch_template: content: - application/json: + application/x-ndjson: schema: type: array items: $ref: '#/components/schemas/_core.msearch_template:RequestItem' description: The request definitions (metadata-search request definition pairs), separated by newlines - x-serialize: bulk required: true mtermvectors: content: @@ -17236,6 +22543,11 @@ components: If no `id` or `` is specified, this parameter is required. type: string description: The search definition template and its params + rollups.put: + content: + application/json: + schema: + $ref: '#/components/schemas/rollups._common:RollupEntity' scripts_painless_execute: content: application/json: @@ -17280,7 +22592,7 @@ components: 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. + description: Configuration of search extensions defined by OpenSearch plugins. type: object additionalProperties: type: object @@ -17370,11 +22682,11 @@ components: 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. + 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. + OpenSearch applies this parameter to each shard handling the request. + When possible, let OpenSearch perform early termination automatically. Avoid specifying this parameter for requests that target data streams with backing indices across multiple data tiers. If set to `0` (default), the query does not terminate early. type: number @@ -17408,7 +22720,7 @@ components: items: type: string description: The search definition using the Query DSL - search_pipeline.create: + search_pipeline.put: content: application/json: schema: @@ -17450,11 +22762,22 @@ components: schema: $ref: '#/components/schemas/security._common:ChangePasswordRequestContent' required: true + security.config_upgrade_perform: + content: + application/json: + schema: + $ref: '#/components/schemas/security._common:ConfigUpgradePayload' security.create_action_group: content: application/json: schema: - $ref: '#/components/schemas/security._common:Action_Group' + $ref: '#/components/schemas/security._common:ActionGroup' + required: true + security.create_allowlist: + content: + application/json: + schema: + $ref: '#/components/schemas/security._common:AllowListConfig' required: true security.create_role: content: @@ -17474,12 +22797,32 @@ components: schema: $ref: '#/components/schemas/security._common:CreateTenantParams' required: true + security.create_update_tenancy_config: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/security._common:MultiTenancyConfig' + required: true security.create_user: content: application/json: schema: $ref: '#/components/schemas/security._common:User' required: true + security.create_user_legacy: + content: + application/json: + schema: + $ref: '#/components/schemas/security._common:User' + required: true + security.generate_obo_token: + content: + application/json: + schema: + $ref: '#/components/schemas/security._common:OBOToken' + required: true security.patch_action_group: content: application/json: @@ -17496,6 +22839,14 @@ components: items: $ref: '#/components/schemas/security._common:PatchOperation' required: true + security.patch_allowlist: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/security._common:PatchOperation' + required: true security.patch_audit_configuration: content: application/json: @@ -17512,6 +22863,11 @@ components: items: $ref: '#/components/schemas/security._common:PatchOperation' required: true + security.patch_distinguished_name: + content: + application/json: + schema: + $ref: '#/components/schemas/security._common:PatchOperation' security.patch_distinguished_names: content: application/json: @@ -17584,6 +22940,12 @@ components: items: $ref: '#/components/schemas/security._common:PatchOperation' required: true + security.post_dashboards_info: + content: + application/json: + schema: + $ref: '#/components/schemas/security._common:DashboardsInfo' + required: false security.update_audit_configuration: content: application/json: @@ -17596,11 +22958,11 @@ components: schema: $ref: '#/components/schemas/security._common:DynamicConfig' required: true - security.update_distinguished_names: + security.update_distinguished_name: content: application/json: schema: - $ref: '#/components/schemas/security._common:DistinguishedNames' + $ref: '#/components/schemas/security._common:PatchOperation' snapshot.clone: content: application/json: @@ -17651,8 +23013,8 @@ components: settings: $ref: '#/components/schemas/snapshot._common:RepositorySettings' required: - - type - settings + - type description: The repository definition required: true snapshot.restore: @@ -17703,6 +23065,11 @@ components: additionalProperties: type: string description: Define parameters and or supply a document to get termvectors for. See documentation. + transforms.put: + content: + application/json: + schema: + $ref: '#/components/schemas/transforms._common:Transform' update: content: application/json: @@ -17781,6 +23148,8 @@ components: cat.aliases@200: description: '' content: + text/plain: + type: string application/json: schema: type: array @@ -17789,6 +23158,8 @@ components: cat.all_pit_segments@200: description: '' content: + text/plain: + type: string application/json: schema: type: array @@ -17797,6 +23168,8 @@ components: cat.allocation@200: description: '' content: + text/plain: + type: string application/json: schema: type: array @@ -17804,9 +23177,19 @@ components: $ref: '#/components/schemas/cat.allocation:AllocationRecord' cat.cluster_manager@200: description: '' + content: + text/plain: + type: string + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/cat.cluster_manager:ClusterManagerRecord' cat.count@200: description: '' content: + text/plain: + type: string application/json: schema: type: array @@ -17815,6 +23198,8 @@ components: cat.fielddata@200: description: '' content: + text/plain: + type: string application/json: schema: type: array @@ -17823,30 +23208,64 @@ components: cat.health@200: description: '' content: + text/plain: + type: string application/json: schema: type: array items: $ref: '#/components/schemas/cat.health:HealthRecord' + application/yaml: + schema: + type: array + items: + $ref: '#/components/schemas/cat.health:HealthRecord' + application/cbor: + schema: + type: array + items: + $ref: '#/components/schemas/cat.health:HealthRecord' + application/smile: + schema: + type: array + items: + $ref: '#/components/schemas/cat.health:HealthRecord' cat.help@200: description: '' content: - application/json: + text/plain: schema: - type: array - items: - $ref: '#/components/schemas/cat.help:HelpRecord' + type: string cat.indices@200: description: '' content: + text/plain: + type: string application/json: schema: type: array items: $ref: '#/components/schemas/cat.indices:IndicesRecord' + application/yaml: + schema: + type: array + items: + $ref: '#/components/schemas/cat.indices:IndicesRecord' + application/cbor: + schema: + type: array + items: + $ref: '#/components/schemas/cat.indices:IndicesRecord' + application/smile: + schema: + type: array + items: + $ref: '#/components/schemas/cat.indices:IndicesRecord' cat.master@200: description: '' content: + text/plain: + type: string application/json: schema: type: array @@ -17855,6 +23274,8 @@ components: cat.nodeattrs@200: description: '' content: + text/plain: + type: string application/json: schema: type: array @@ -17863,6 +23284,8 @@ components: cat.nodes@200: description: '' content: + text/plain: + type: string application/json: schema: type: array @@ -17871,6 +23294,8 @@ components: cat.pending_tasks@200: description: '' content: + text/plain: + type: string application/json: schema: type: array @@ -17879,6 +23304,8 @@ components: cat.pit_segments@200: description: '' content: + text/plain: + type: string application/json: schema: type: array @@ -17887,6 +23314,8 @@ components: cat.plugins@200: description: '' content: + text/plain: + type: string application/json: schema: type: array @@ -17895,6 +23324,8 @@ components: cat.recovery@200: description: '' content: + text/plain: + type: string application/json: schema: type: array @@ -17903,6 +23334,8 @@ components: cat.repositories@200: description: '' content: + text/plain: + type: string application/json: schema: type: array @@ -17911,6 +23344,8 @@ components: cat.segment_replication@200: description: '' content: + text/plain: + type: string application/json: schema: type: array @@ -17919,6 +23354,8 @@ components: cat.segments@200: description: '' content: + text/plain: + type: string application/json: schema: type: array @@ -17927,6 +23364,8 @@ components: cat.shards@200: description: '' content: + text/plain: + type: string application/json: schema: type: array @@ -17935,6 +23374,8 @@ components: cat.snapshots@200: description: '' content: + text/plain: + type: string application/json: schema: type: array @@ -17943,6 +23384,8 @@ components: cat.tasks@200: description: '' content: + text/plain: + type: string application/json: schema: type: array @@ -17951,6 +23394,8 @@ components: cat.templates@200: description: '' content: + text/plain: + type: string application/json: schema: type: array @@ -17959,6 +23404,8 @@ components: cat.thread_pool@200: description: '' content: + text/plain: + type: string application/json: schema: type: array @@ -17976,8 +23423,8 @@ components: num_freed: type: number required: - - succeeded - num_freed + - succeeded cluster.allocation_explain@200: description: '' content: @@ -18145,12 +23592,10 @@ components: type: boolean persistent: type: object - additionalProperties: - type: object + additionalProperties: {} transient: type: object - additionalProperties: - type: object + additionalProperties: {} required: - acknowledged - persistent @@ -18210,14 +23655,8 @@ components: _shards: $ref: '#/components/schemas/_common:ShardStatistics' required: - - count - _shards - create@200: - description: '' - content: - application/json: - schema: - $ref: '#/components/schemas/_common:WriteResponseBase' + - count create_pit@200: description: '' content: @@ -18232,6 +23671,12 @@ components: creation_time: type: integer format: int64 + create@200: + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/_common:WriteResponseBase' dangling_indices.delete_dangling_index@200: description: '' content: @@ -18251,18 +23696,16 @@ components: schema: type: object properties: + _nodes: + $ref: '#/components/schemas/_common:NodeStatistics' + cluster_name: + $ref: '#/components/schemas/_common:Name' dangling_indices: type: array items: $ref: '#/components/schemas/dangling_indices.list_dangling_indices:DanglingIndex' required: - dangling_indices - delete@200: - description: '' - content: - application/json: - schema: - $ref: '#/components/schemas/_common:WriteResponseBase' delete_all_pits@200: description: '' content: @@ -18274,6 +23717,12 @@ components: type: array items: $ref: '#/components/schemas/_core._common:PitsDetailsDeleteAll' + delete_by_query_rethrottle@200: + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/tasks._common:TaskListResponseBase' delete_by_query@200: description: '' content: @@ -18315,12 +23764,6 @@ components: type: number version_conflicts: type: number - delete_by_query_rethrottle@200: - description: '' - content: - application/json: - schema: - $ref: '#/components/schemas/tasks._common:TaskListResponseBase' delete_pit@200: description: '' content: @@ -18338,14 +23781,20 @@ components: application/json: schema: $ref: '#/components/schemas/_common:AcknowledgedResponseBase' - exists@200: + delete@200: description: '' content: - application/json: {} + application/json: + schema: + $ref: '#/components/schemas/_common:WriteResponseBase' exists_source@200: description: '' content: application/json: {} + exists@200: + description: '' + content: + application/json: {} explain@200: description: '' content: @@ -18364,8 +23813,8 @@ components: get: $ref: '#/components/schemas/_common:InlineGet' required: - - _index - _id + - _index - matched field_caps@200: description: '' @@ -18383,14 +23832,8 @@ components: additionalProperties: $ref: '#/components/schemas/_core.field_caps:FieldCapability' required: - - indices - fields - get@200: - description: '' - content: - application/json: - schema: - $ref: '#/components/schemas/_core.get:GetResult' + - indices get_all_pits@200: description: '' content: @@ -18402,22 +23845,6 @@ components: type: array items: $ref: '#/components/schemas/_core._common:PitDetail' - get_script@200: - description: '' - content: - application/json: - schema: - type: object - properties: - _id: - $ref: '#/components/schemas/_common:Id' - found: - type: boolean - script: - $ref: '#/components/schemas/_common:StoredScript' - required: - - _id - - found get_script_context@200: description: '' content: @@ -18449,18 +23876,46 @@ components: required: - language_contexts - types_allowed + get_script@200: + description: '' + content: + application/json: + schema: + type: object + properties: + _id: + $ref: '#/components/schemas/_common:Id' + found: + type: boolean + script: + $ref: '#/components/schemas/_common:StoredScript' + required: + - _id + - found get_source@200: description: '' content: application/json: schema: type: object + get@200: + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/_core.get:GetResult' index@200: description: '' content: application/json: schema: $ref: '#/components/schemas/_common:WriteResponseBase' + index@201: + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/_common:WriteResponseBase' indices.add_block@200: description: '' content: @@ -18478,8 +23933,8 @@ components: $ref: '#/components/schemas/indices.add_block:IndicesBlockStatus' required: - acknowledged - - shards_acknowledged - indices + - shards_acknowledged indices.analyze@200: description: '' content: @@ -18535,6 +23990,12 @@ components: - acknowledged - indices - shards_acknowledged + indices.create_data_stream@200: + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/_common:AcknowledgedResponseBase' indices.create@200: description: '' content: @@ -18549,15 +24010,9 @@ components: acknowledged: type: boolean required: + - acknowledged - index - shards_acknowledged - - acknowledged - indices.create_data_stream@200: - description: '' - content: - application/json: - schema: - $ref: '#/components/schemas/_common:AcknowledgedResponseBase' indices.data_streams_stats@200: description: '' content: @@ -18589,12 +24044,6 @@ components: - data_stream_count - data_streams - total_store_size_bytes - indices.delete@200: - description: '' - content: - application/json: - schema: - $ref: '#/components/schemas/_common:IndicesResponseBase' indices.delete_alias@200: description: '' content: @@ -18619,10 +24068,12 @@ components: application/json: schema: $ref: '#/components/schemas/_common:AcknowledgedResponseBase' - indices.exists@200: + indices.delete@200: description: '' content: - application/json: {} + application/json: + schema: + $ref: '#/components/schemas/_common:IndicesResponseBase' indices.exists_alias@200: description: '' content: @@ -18635,6 +24086,14 @@ components: description: '' content: application/json: {} + indices.exists@200: + description: '' + content: + application/json: {} + indices.exists@404: + description: '' + content: + application/json: {} indices.flush@200: description: '' content: @@ -18646,15 +24105,15 @@ components: content: application/json: schema: - $ref: '#/components/schemas/indices.forcemerge._types:ForceMergeResponseBody' - indices.get@200: - description: '' - content: - application/json: - schema: - type: object - additionalProperties: - $ref: '#/components/schemas/indices._common:IndexState' + allOf: + - $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/ + type: string indices.get_alias@200: description: '' content: @@ -18723,20 +24182,35 @@ components: $ref: '#/components/schemas/indices._common:TemplateMapping' indices.get_upgrade@200: description: '' - indices.open@200: + indices.get@200: description: '' content: application/json: schema: type: object - properties: - acknowledged: - type: boolean - shards_acknowledged: - type: boolean - required: - - acknowledged - - shards_acknowledged + additionalProperties: + $ref: '#/components/schemas/indices._common:IndexState' + indices.open@200: + description: '' + content: + application/json: + schema: + oneOf: + - type: object + properties: + task: + $ref: '#/components/schemas/_common:TaskId' + additionalProperties: false + - type: object + properties: + acknowledged: + type: boolean + shards_acknowledged: + type: boolean + required: + - acknowledged + - shards_acknowledged + additionalProperties: false indices.put_alias@200: description: '' content: @@ -18801,9 +24275,9 @@ components: items: $ref: '#/components/schemas/indices.resolve_index:ResolveIndexDataStreamsItem' required: - - indices - aliases - data_streams + - indices indices.rollover@200: description: '' content: @@ -18849,8 +24323,8 @@ components: _shards: $ref: '#/components/schemas/_common:ShardStatistics' required: - - indices - _shards + - indices indices.shard_stores@200: description: '' content: @@ -18879,8 +24353,8 @@ components: $ref: '#/components/schemas/_common:IndexName' required: - acknowledged - - shards_acknowledged - index + - shards_acknowledged indices.simulate_index_template@200: description: '' content: @@ -18917,8 +24391,8 @@ components: $ref: '#/components/schemas/_common:IndexName' required: - acknowledged - - shards_acknowledged - index + - shards_acknowledged indices.stats@200: description: '' content: @@ -18935,8 +24409,8 @@ components: _all: $ref: '#/components/schemas/indices.stats:IndicesStats' required: - - _shards - _all + - _shards indices.update_aliases@200: description: '' content: @@ -18980,7 +24454,7 @@ components: tagline: type: string version: - $ref: '#/components/schemas/_common:OpensearchVersionInfo' + $ref: '#/components/schemas/_common:OpenSearchVersionInfo' required: - cluster_name - cluster_uuid @@ -19058,13 +24532,116 @@ components: $ref: '#/components/schemas/_core.mget:ResponseItem' required: - docs - msearch@200: + ml.delete_model_group@200: + content: + application/json: + schema: + type: object + ml.delete_model@200: + content: + application/json: + schema: + type: object + ml.get_model_group@200: + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: The model group name. + latest_version: + type: number + description: The latest version. + description: + type: string + description: The model group description. + access: + type: string + description: The model group access. + created_time: + type: integer + format: int64 + last_updated_time: + type: integer + format: int64 + required: + - access + - description + - latest_version + - name + ml.get_task@200: + content: + application/json: + schema: + type: object + properties: + model_id: + type: string + description: The model ID. + state: + type: string + description: The state. + enum: + - CANCELLED + - COMPLETED + - COMPLETED_WITH_ERROR + - CREATED + - FAILED + - RUNNING + required: + - state + ml.register_model_group@200: + content: + application/json: + schema: + type: object + properties: + model_group_id: + type: string + description: The model group ID. + status: + type: string + description: The status. + required: + - model_group_id + - status + ml.register_model@200: + content: + application/json: + schema: + type: object + properties: + task_id: + type: string + description: The task ID. + model_id: + type: string + description: The model ID. + status: + type: string + description: The status. + required: + - status + - task_id + ml.search_models@200: + content: + application/json: + schema: + type: object + properties: + hits: + $ref: '#/components/schemas/ml._common:SearchModelHits' + required: + - hits + msearch_template@200: description: '' content: application/json: schema: $ref: '#/components/schemas/_core.msearch:MultiSearchResult' - msearch_template@200: + msearch@200: description: '' content: application/json: @@ -19142,6 +24719,25 @@ components: application/json: schema: $ref: '#/components/schemas/notifications._common:GetConfigsResponse' + notifications.list_channels@200: + description: '' + content: + application/json: + schema: + type: object + properties: + start_index: + type: integer + format: int64 + total_hits: + type: integer + format: int64 + total_hit_relation: + $ref: '#/components/schemas/notifications._common:TotalHitRelation' + channel_list: + type: array + items: + $ref: '#/components/schemas/notifications._common:NotificationChannel' notifications.list_features@200: description: '' content: @@ -19207,9 +24803,22 @@ components: additionalProperties: type: object required: - - metric_score - details - failures + - metric_score + reindex_rethrottle@200: + description: '' + content: + application/json: + schema: + type: object + properties: + nodes: + type: object + additionalProperties: + $ref: '#/components/schemas/_core.reindex_rethrottle:ReindexNode' + required: + - nodes reindex@200: description: '' content: @@ -19251,19 +24860,6 @@ components: type: number version_conflicts: type: number - reindex_rethrottle@200: - description: '' - content: - application/json: - schema: - type: object - properties: - nodes: - type: object - additionalProperties: - $ref: '#/components/schemas/_core.reindex_rethrottle:ReindexNode' - required: - - nodes remote_store.restore@200: description: '' content: @@ -19300,6 +24896,27 @@ components: type: object required: - template_output + rollups.delete@200: + description: '' + rollups.explain@200: + content: + application/json: + schema: + $ref: '#/components/schemas/rollups._common:ExplainEntities' + rollups.get@200: + content: + application/json: + schema: + $ref: '#/components/schemas/rollups._common:RollupEntity' + rollups.put@200: + content: + application/json: + schema: + $ref: '#/components/schemas/rollups._common:RollupEntity' + rollups.start@200: + description: '' + rollups.stop@200: + description: '' scripts_painless_execute@200: description: '' content: @@ -19317,13 +24934,7 @@ components: application/json: schema: $ref: '#/components/schemas/_core.search:ResponseBody' - search@200: - description: '' - content: - application/json: - schema: - $ref: '#/components/schemas/_core.search:ResponseBody' - search_pipeline.create@200: + search_pipeline.delete@200: description: '' content: application/json: @@ -19338,6 +24949,15 @@ components: application/json: schema: $ref: '#/components/schemas/search_pipeline._common:SearchPipelineMap' + search_pipeline.put@200: + description: '' + content: + application/json: + schema: + type: object + properties: + acknowledged: + type: boolean search_shards@200: description: '' content: @@ -19360,9 +24980,9 @@ components: additionalProperties: $ref: '#/components/schemas/_core.search_shards:ShardStoreIndex' required: + - indices - nodes - shards - - indices search_template@200: description: '' content: @@ -19407,514 +25027,664 @@ components: terminated_early: type: boolean required: - - took - - timed_out - _shards - hits + - timed_out + - took + search@200: + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/_core.search:ResponseBody' + security.authinfo@200: + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/security._common:AuthInfo' + security.authinfo@500: + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/security._common:InternalServerError' + security.authtoken@200: + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/security._common:Ok' + security.cache@501: + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/security._common:MethodNotImplemented' security.change_password@200: description: '' content: application/json: schema: - type: object - properties: - status: - type: string - description: Security Operation Status - message: - type: string - description: Security Operation Message + $ref: '#/components/schemas/security._common:Ok' + security.config_upgrade_check@200: + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/security._common:UpgradeCheck' + security.config_upgrade_perform@200: + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/security._common:UpgradePerform' security.create_action_group@200: description: '' content: application/json: schema: - type: object - properties: - status: - type: string - description: Security Operation Status - message: - type: string - description: Security Operation Message - security.create_role@200: + $ref: '#/components/schemas/security._common:Ok' + security.create_allowlist@200: description: '' content: application/json: schema: - type: object - properties: - status: - type: string - description: Security Operation Status - message: - type: string - description: Security Operation Message + $ref: '#/components/schemas/security._common:AllowListConfig' security.create_role_mapping@200: description: '' content: application/json: schema: - type: object - properties: - status: - type: string - description: Security Operation Status - message: - type: string - description: Security Operation Message + $ref: '#/components/schemas/security._common:Ok' + security.create_role@200: + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/security._common:Ok' security.create_tenant@200: description: '' content: application/json: schema: - type: object - properties: - status: - type: string - description: Security Operation Status - message: - type: string - description: Security Operation Message + $ref: '#/components/schemas/security._common:Ok' + security.create_tenant@400: + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/security._common:BadRequest' + security.create_update_tenancy_config@200: + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/security._common:MultiTenancyConfig' + security.create_update_tenancy_config@400: + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/security._common:BadRequest' + security.create_user_legacy@200: + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/security._common:Ok' security.create_user@200: description: '' content: application/json: schema: - type: object - properties: - status: - type: string - description: Security Operation Status - message: - type: string - description: Security Operation Message + $ref: '#/components/schemas/security._common:Ok' security.delete_action_group@200: description: '' content: application/json: schema: - type: object - properties: - status: - type: string - description: Security Operation Status - message: - type: string - description: Security Operation Message - security.delete_distinguished_names@200: + $ref: '#/components/schemas/security._common:Ok' + security.delete_distinguished_name@200: + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/security._common:Ok' + security.delete_distinguished_name@403: + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/security._common:Unauthorized' + security.delete_role_mapping@200: + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/security._common:Ok' + security.delete_role@200: + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/security._common:Ok' + security.delete_tenant@200: + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/security._common:Ok' + security.delete_tenant@400: + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/security._common:BadRequest' + security.delete_user_legacy@200: + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/security._common:Ok' + security.delete_user@200: + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/security._common:Ok' + security.flush_cache@200: + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/security._common:Ok' + security.generate_obo_token@200: + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/security._common:GenerateOBOToken' + security.generate_obo_token@400: + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/security._common:BadRequest' + security.generate_user_token_legacy@200: + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/security._common:Ok' + security.generate_user_token_legacy@400: + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/security._common:BadRequest' + security.generate_user_token@200: + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/security._common:Ok' + security.generate_user_token@400: + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/security._common:BadRequest' + security.get_account_details@200: + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/security._common:AccountDetails' + security.get_action_group@200: + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/security._common:ActionGroupsMap' + security.get_action_groups@200: + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/security._common:ActionGroupsMap' + security.get_allowlist@200: + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/security._common:AllowListConfig' + security.get_audit_configuration@200: + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/security._common:AuditConfigWithReadOnly' + security.get_certificates@200: + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/security._common:GetCertificates' + security.get_certificates@400: + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/security._common:BadRequest' + security.get_configuration@200: + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/security._common:DynamicConfig' + security.get_dashboards_info@200: + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/security._common:DashboardsInfo' + security.get_dashboards_info@500: + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/security._common:InternalServerError' + 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@403: + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/security._common:Unauthorized' + security.get_distinguished_names@200: + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/security._common:DistinguishedNamesMap' + security.get_distinguished_names@403: + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/security._common:Unauthorized' + security.get_permissions_info@200: + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/security._common:PermissionsInfo' + security.get_permissions_info@500: + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/security._common:InternalServerError' + security.get_role_mapping@200: + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/security._common:RoleMappings' + security.get_role_mappings@200: + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/security._common:RoleMappings' + security.get_role@200: + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/security._common:RolesMap' + security.get_roles@200: + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/security._common:RolesMap' + security.get_sslinfo@200: + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/security._common:SSLInfo' + security.get_sslinfo@500: + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/security._common:InternalServerError' + security.get_tenancy_config@200: + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/security._common:MultiTenancyConfig' + security.get_tenancy_config@400: + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/security._common:BadRequest' + security.get_tenant@200: + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/security._common:TenantsMap' + security.get_tenants@200: + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/security._common:TenantsMap' + security.get_tenants@400: + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/security._common:BadRequest' + security.get_user_legacy@200: + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/security._common:UsersMap' + security.get_user@200: + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/security._common:UsersMap' + security.get_users_legacy@200: + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/security._common:UsersMap' + security.get_users@200: + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/security._common:UsersMap' + security.health@200: + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/security._common:HealthInfo' + security.migrate@200: + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/security._common:Ok' + security.migrate@400: + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/security._common:BadRequest' + security.patch_action_group@200: + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/security._common:Ok' + security.patch_action_groups@200: + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/security._common:Ok' + security.patch_allowlist@200: description: '' content: application/json: schema: - type: object - properties: - status: - type: string - description: Security Operation Status - message: - type: string - description: Security Operation Message - security.delete_role@200: + $ref: '#/components/schemas/security._common:AllowListConfig' + security.patch_audit_configuration@200: description: '' content: application/json: schema: - type: object - properties: - status: - type: string - description: Security Operation Status - message: - type: string - description: Security Operation Message - security.delete_role_mapping@200: + $ref: '#/components/schemas/security._common:Ok' + security.patch_configuration@200: description: '' content: application/json: schema: - type: object - properties: - status: - type: string - description: Security Operation Status - message: - type: string - description: Security Operation Message - security.delete_tenant@200: + $ref: '#/components/schemas/security._common:Ok' + security.patch_distinguished_name@200: description: '' content: application/json: schema: - type: object - properties: - status: - type: string - description: Security Operation Status - message: - type: string - description: Security Operation Message - security.delete_user@200: + $ref: '#/components/schemas/security._common:Ok' + security.patch_distinguished_name@403: description: '' content: application/json: schema: - type: object - properties: - status: - type: string - description: Security Operation Status - message: - type: string - description: Security Operation Message - security.flush_cache@200: + $ref: '#/components/schemas/security._common:Unauthorized' + security.patch_distinguished_names@200: description: '' content: application/json: schema: - type: object - properties: - status: - type: string - description: Security Operation Status - message: - type: string - description: Security Operation Message - security.get_account_details@200: + $ref: '#/components/schemas/security._common:Ok' + security.patch_distinguished_names@403: description: '' content: application/json: schema: - $ref: '#/components/schemas/security._common:AccountDetails' - security.get_action_group@200: + $ref: '#/components/schemas/security._common:Unauthorized' + security.patch_role_mapping@200: description: '' content: application/json: schema: - $ref: '#/components/schemas/security._common:ActionGroupsMap' - security.get_action_groups@200: + $ref: '#/components/schemas/security._common:Ok' + security.patch_role_mapping@400: description: '' content: application/json: schema: - $ref: '#/components/schemas/security._common:ActionGroupsMap' - security.get_audit_configuration@200: + $ref: '#/components/schemas/security._common:BadRequest' + security.patch_role_mappings@200: description: '' content: application/json: schema: - $ref: '#/components/schemas/security._common:AuditConfigWithReadOnly' - security.get_certificates@200: + $ref: '#/components/schemas/security._common:Ok' + security.patch_role_mappings@400: description: '' content: application/json: schema: - type: object - properties: - http_certificates_list: - type: array - items: - $ref: '#/components/schemas/security._common:CertificatesDetail' - transport_certificates_list: - type: array - items: - $ref: '#/components/schemas/security._common:CertificatesDetail' - security.get_configuration@200: + $ref: '#/components/schemas/security._common:BadRequest' + security.patch_role@200: description: '' content: application/json: schema: - $ref: '#/components/schemas/security._common:DynamicConfig' - security.get_distinguished_names@200: + $ref: '#/components/schemas/security._common:Ok' + security.patch_role@400: description: '' content: application/json: schema: - $ref: '#/components/schemas/security._common:DistinguishedNamesMap' - security.get_role@200: + $ref: '#/components/schemas/security._common:BadRequest' + security.patch_roles@200: description: '' content: application/json: schema: - $ref: '#/components/schemas/security._common:RolesMap' - security.get_role_mapping@200: + $ref: '#/components/schemas/security._common:Ok' + security.patch_roles@400: description: '' content: application/json: schema: - $ref: '#/components/schemas/security._common:RoleMappings' - security.get_role_mappings@200: + $ref: '#/components/schemas/security._common:BadRequest' + security.patch_tenant@200: description: '' content: application/json: schema: - $ref: '#/components/schemas/security._common:RoleMappings' - security.get_roles@200: + $ref: '#/components/schemas/security._common:Ok' + security.patch_tenant@400: description: '' content: application/json: schema: - $ref: '#/components/schemas/security._common:RolesMap' - security.get_tenant@200: + $ref: '#/components/schemas/security._common:BadRequest' + security.patch_tenants@200: description: '' content: application/json: schema: - $ref: '#/components/schemas/security._common:TenantsMap' - security.get_tenants@200: + $ref: '#/components/schemas/security._common:Ok' + security.patch_tenants@400: description: '' content: application/json: schema: - $ref: '#/components/schemas/security._common:TenantsMap' - security.get_user@200: + $ref: '#/components/schemas/security._common:BadRequest' + security.patch_user@200: description: '' content: application/json: schema: - $ref: '#/components/schemas/security._common:UsersMap' - security.get_users@200: + $ref: '#/components/schemas/security._common:Ok' + security.patch_users@200: description: '' content: application/json: schema: - $ref: '#/components/schemas/security._common:UsersMap' - security.health@200: + $ref: '#/components/schemas/security._common:Ok' + security.post_dashboards_info@200: description: '' content: application/json: schema: - type: object - properties: - message: - type: string - mode: - type: string - status: - type: string - security.patch_action_group@200: + $ref: '#/components/schemas/security._common:DashboardsInfo' + security.post_dashboards_info@500: description: '' content: application/json: schema: - type: object - properties: - status: - type: string - description: Security Operation Status - message: - type: string - description: Security Operation Message - security.patch_action_groups@200: + $ref: '#/components/schemas/security._common:InternalServerError' + security.reload_http_certificates@200: description: '' content: application/json: schema: - type: object - properties: - status: - type: string - description: Security Operation Status - message: - type: string - description: Security Operation Message - security.patch_audit_configuration@200: - description: '' - security.patch_configuration@200: + $ref: '#/components/schemas/security._common:Ok' + security.reload_http_certificates@400: description: '' content: application/json: schema: - type: object - properties: - status: - type: string - description: Security Operation Status - message: - type: string - description: Security Operation Message - security.patch_distinguished_names@200: + $ref: '#/components/schemas/security._common:BadRequest' + security.reload_transport_certificates@200: description: '' content: application/json: schema: - type: object - properties: - status: - type: string - description: Security Operation Status - message: - type: string - description: Security Operation Message - security.patch_role@200: + $ref: '#/components/schemas/security._common:Ok' + security.reload_transport_certificates@400: description: '' content: application/json: schema: - type: object - properties: - status: - type: string - description: Security Operation Status - message: - type: string - description: Security Operation Message - security.patch_role_mapping@200: + $ref: '#/components/schemas/security._common:BadRequest' + security.tenant_info@200: description: '' content: application/json: schema: - type: object - properties: - status: - type: string - description: Security Operation Status - message: - type: string - description: Security Operation Message - security.patch_role_mappings@200: + $ref: '#/components/schemas/security._common:TenantInfo' + security.tenant_info@500: description: '' content: application/json: schema: - type: object - properties: - status: - type: string - description: Security Operation Status - message: - type: string - description: Security Operation Message - security.patch_roles@200: + $ref: '#/components/schemas/security._common:InternalServerError' + security.update_audit_configuration@200: description: '' content: application/json: schema: - type: object - properties: - status: - type: string - description: Security Operation Status - message: - type: string - description: Security Operation Message - security.patch_tenant@200: + $ref: '#/components/schemas/security._common:Ok' + security.update_configuration@200: description: '' content: application/json: schema: - type: object - properties: - status: - type: string - description: Security Operation Status - message: - type: string - description: Security Operation Message - security.patch_tenants@200: + $ref: '#/components/schemas/security._common:Ok' + security.update_distinguished_name@200: description: '' content: application/json: schema: - type: object - properties: - status: - type: string - description: Security Operation Status - message: - type: string - description: Security Operation Message - security.patch_user@200: + $ref: '#/components/schemas/security._common:Ok' + security.update_distinguished_name@403: description: '' content: application/json: schema: - type: object - properties: - status: - type: string - description: Security Operation Status - message: - type: string - description: Security Operation Message - security.patch_users@200: + $ref: '#/components/schemas/security._common:Unauthorized' + security.validate@200: description: '' content: application/json: schema: - type: object - properties: - status: - type: string - description: Security Operation Status - message: - type: string - description: Security Operation Message - security.reload_http_certificates@200: + $ref: '#/components/schemas/security._common:Ok' + security.validate@400: description: '' content: application/json: schema: - type: object - properties: - status: - type: string - description: Security Operation Status - message: - type: string - description: Security Operation Message - security.reload_transport_certificates@200: + $ref: '#/components/schemas/security._common:BadRequest' + security.who_am_i_protected@200: description: '' content: application/json: schema: - type: object - properties: - status: - type: string - description: Security Operation Status - message: - type: string - description: Security Operation Message - security.update_audit_configuration@200: + $ref: '#/components/schemas/security._common:WhoAmI' + security.who_am_i_protected@500: description: '' content: application/json: schema: - type: object - properties: - status: - type: string - description: Security Operation Status - message: - type: string - description: Security Operation Message - security.update_configuration@200: + $ref: '#/components/schemas/security._common:InternalServerError' + security.who_am_i@200: description: '' content: application/json: schema: - type: object - properties: - status: - type: string - description: Security Operation Status - message: - type: string - description: Security Operation Message - security.update_distinguished_names@200: + $ref: '#/components/schemas/security._common:WhoAmI' + security.who_am_i@500: description: '' content: application/json: schema: - type: object - properties: - status: - type: string - description: Security Operation Status - message: - type: string - description: Security Operation Message + $ref: '#/components/schemas/security._common:InternalServerError' snapshot.cleanup_repository@200: description: '' content: @@ -19932,6 +25702,12 @@ components: application/json: schema: $ref: '#/components/schemas/_common:AcknowledgedResponseBase' + snapshot.create_repository@200: + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/_common:AcknowledgedResponseBase' snapshot.create@200: description: '' content: @@ -19944,7 +25720,7 @@ components: type: boolean snapshot: $ref: '#/components/schemas/snapshot._common:SnapshotInfo' - snapshot.create_repository@200: + snapshot.delete_repository@200: description: '' content: application/json: @@ -19956,12 +25732,14 @@ components: application/json: schema: $ref: '#/components/schemas/_common:AcknowledgedResponseBase' - snapshot.delete_repository@200: + snapshot.get_repository@200: description: '' content: application/json: schema: - $ref: '#/components/schemas/_common:AcknowledgedResponseBase' + type: object + additionalProperties: + $ref: '#/components/schemas/snapshot._common:Repository' snapshot.get@200: description: '' content: @@ -19984,16 +25762,8 @@ components: description: The number of remaining snapshots that were not returned due to size limits and that can be fetched by additional requests using the next field value. type: number required: - - total - remaining - snapshot.get_repository@200: - description: '' - content: - application/json: - schema: - type: object - additionalProperties: - $ref: '#/components/schemas/snapshot._common:Repository' + - total snapshot.restore@200: description: '' content: @@ -20083,17 +25853,61 @@ components: _version: $ref: '#/components/schemas/_common:VersionNumber' required: - - found - _id - _index - - took - _version - update@200: + - found + - took + transforms.delete@200: description: '' + transforms.explain@200: content: application/json: schema: - $ref: '#/components/schemas/_core.update:UpdateWriteResponseBase' + $ref: '#/components/schemas/transforms._common:ExplainResponse' + transforms.get@200: + content: + application/json: + schema: + $ref: '#/components/schemas/transforms._common:TransformEntity' + transforms.preview@200: + content: + application/json: + schema: + $ref: '#/components/schemas/transforms._common:Preview' + transforms.put@200: + content: + application/json: + schema: + $ref: '#/components/schemas/transforms._common:TransformEntity' + transforms.search@200: + content: + application/json: + schema: + $ref: '#/components/schemas/transforms._common:TransformsResponse' + transforms.start@200: + content: + application/json: + schema: + $ref: '#/components/schemas/_common:AcknowledgedResponseBase' + transforms.stop@200: + content: + application/json: + schema: + $ref: '#/components/schemas/_common:AcknowledgedResponseBase' + update_by_query_rethrottle@200: + description: '' + content: + application/json: + schema: + type: object + properties: + nodes: + type: object + additionalProperties: + $ref: '#/components/schemas/_core.update_by_query_rethrottle:UpdateByQueryRethrottleNode' + required: + - nodes update_by_query@200: description: '' content: @@ -20135,1155 +25949,2443 @@ components: $ref: '#/components/schemas/_common:Duration' throttled_until_millis: $ref: '#/components/schemas/_common:DurationValueUnitMillis' - update_by_query_rethrottle@200: + update@200: description: '' content: application/json: schema: - type: object - properties: - nodes: - type: object - additionalProperties: - $ref: '#/components/schemas/_core.update_by_query_rethrottle:UpdateByQueryRethrottleNode' - required: - - nodes + $ref: '#/components/schemas/_core.update:UpdateWriteResponseBase' schemas: - _common.aggregations:AdjacencyMatrixAggregate: - allOf: - - $ref: '#/components/schemas/_common.aggregations:MultiBucketAggregateBaseAdjacencyMatrixBucket' - - type: object - _common.aggregations:AdjacencyMatrixAggregation: - allOf: - - $ref: '#/components/schemas/_common.aggregations:BucketAggregationBase' - - type: object - properties: - filters: - description: |- - Filters used to create buckets. - At least one filter is required. - type: object - additionalProperties: - $ref: '#/components/schemas/_common.query_dsl:QueryContainer' - _common.aggregations:AdjacencyMatrixBucket: - allOf: - - $ref: '#/components/schemas/_common.aggregations:MultiBucketBase' - - type: object - properties: - key: - type: string - required: - - key - _common.aggregations:Aggregate: + _common:AcknowledgedResponseBase: + type: object + properties: + acknowledged: + description: For a successful response, this value is always true. On failure, an exception is returned instead. + type: boolean + required: + - acknowledged + _common:ActionStatusOptions: + type: string + enum: + - failure + - simulated + - success + - throttled + _common:BaseNode: + type: object + properties: + attributes: + type: object + additionalProperties: + type: string + host: + $ref: '#/components/schemas/_common:Host' + ip: + $ref: '#/components/schemas/_common:Ip' + name: + $ref: '#/components/schemas/_common:Name' + roles: + $ref: '#/components/schemas/_common:NodeRoles' + transport_address: + $ref: '#/components/schemas/_common:TransportAddress' + required: + - attributes + - host + - ip + - name + - transport_address + _common:BulkIndexByScrollFailure: + type: object + properties: + cause: + $ref: '#/components/schemas/_common:ErrorCause' + id: + $ref: '#/components/schemas/_common:Id' + index: + $ref: '#/components/schemas/_common:IndexName' + status: + type: number + type: + type: string + required: + - cause + - id + - index + - status + - type + _common:BulkStats: + type: object + properties: + total_operations: + type: number + total_time: + $ref: '#/components/schemas/_common:Duration' + total_time_in_millis: + $ref: '#/components/schemas/_common:DurationValueUnitMillis' + total_size: + $ref: '#/components/schemas/_common:ByteSize' + total_size_in_bytes: + type: number + avg_time: + $ref: '#/components/schemas/_common:Duration' + avg_time_in_millis: + $ref: '#/components/schemas/_common:DurationValueUnitMillis' + avg_size: + $ref: '#/components/schemas/_common:ByteSize' + avg_size_in_bytes: + type: number + required: + - avg_size_in_bytes + - avg_time_in_millis + - total_operations + - total_size_in_bytes + - total_time_in_millis + _common:byte: + type: number + _common:Bytes: + type: string + enum: + - b + - g + - gb + - k + - kb + - m + - mb + - p + - pb + - t + - tb + _common:ByteSize: oneOf: - - $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: number + - type: string + _common:ClusterDetails: + type: object + properties: + status: + $ref: '#/components/schemas/_common:ClusterSearchStatus' + indices: + type: string + took: + $ref: '#/components/schemas/_common:DurationValueUnitMillis' + timed_out: + type: boolean + _shards: + $ref: '#/components/schemas/_common:ShardStatistics' + failures: + type: array + items: + $ref: '#/components/schemas/_common:ShardFailure' + required: + - indices + - status + - timed_out + _common:ClusterSearchStatus: + type: string + enum: + - failed + - partial + - running + - skipped + - successful + _common:ClusterStatistics: + type: object + properties: + skipped: + type: number + successful: + type: number + total: + type: number + running: + type: number + partial: + type: number + failed: + type: number + details: + type: object + additionalProperties: + $ref: '#/components/schemas/_common:ClusterDetails' + required: + - failed + - partial + - running + - skipped + - successful + - total + _common:CompletionStats: type: object properties: - meta: - $ref: '#/components/schemas/_common:Metadata' - _common.aggregations:AggregateOrder: - oneOf: - - type: object + size_in_bytes: + description: Total amount, in bytes, of memory used for completion across all shards assigned to selected nodes. + type: number + size: + $ref: '#/components/schemas/_common:ByteSize' + fields: + type: object additionalProperties: - $ref: '#/components/schemas/_common:SortOrder' - minProperties: 1 - maxProperties: 1 + $ref: '#/components/schemas/_common:FieldSizeUsage' + required: + - size_in_bytes + _common:Conflicts: + type: string + enum: + - abort + - proceed + _common:CoordsGeoBounds: + type: object + properties: + top: + type: number + bottom: + type: number + left: + type: number + right: + type: number + required: + - bottom + - left + - right + - top + _common:DataStreamName: + type: string + _common:DataStreamNames: + oneOf: + - $ref: '#/components/schemas/_common:DataStreamName' - type: array items: - type: object - additionalProperties: - $ref: '#/components/schemas/_common:SortOrder' - minProperties: 1 - maxProperties: 1 - _common.aggregations:Aggregation: + $ref: '#/components/schemas/_common:DataStreamName' + _common:DateFormat: + type: string + _common:DateMath: + type: string + _common:DateTime: + description: |- + A date and time, either as a string whose format can depend on the context (defaulting to ISO 8601), or a + number of milliseconds since the Epoch. OpenSearch accepts both as input, but will generally output a string + representation. + oneOf: + - type: string + - $ref: '#/components/schemas/_common:EpochTimeUnitMillis' + _common:DFIIndependenceMeasure: + type: string + enum: + - chisquared + - saturated + - standardized + _common:DFRAfterEffect: + type: string + enum: + - b + - l + - no + _common:DFRBasicModel: + type: string + enum: + - be + - d + - g + - if + - in + - ine + - p + _common:Distance: + type: string + _common:DistanceUnit: + type: string + enum: + - cm + - ft + - in + - km + - m + - mi + - mm + - nmi + - yd + _common:DocStats: type: object properties: - meta: - $ref: '#/components/schemas/_common:Metadata' - name: - type: string - _common.aggregations:AggregationContainer: - allOf: - - type: object - properties: - aggregations: - description: |- - Sub-aggregations for this aggregation. - Only applies to bucket aggregations. - type: object - additionalProperties: - $ref: '#/components/schemas/_common.aggregations:AggregationContainer' - meta: - $ref: '#/components/schemas/_common:Metadata' - - type: object - properties: - adjacency_matrix: - $ref: '#/components/schemas/_common.aggregations:AdjacencyMatrixAggregation' - auto_date_histogram: - $ref: '#/components/schemas/_common.aggregations:AutoDateHistogramAggregation' - avg: - $ref: '#/components/schemas/_common.aggregations:AverageAggregation' - avg_bucket: - $ref: '#/components/schemas/_common.aggregations:AverageBucketAggregation' - boxplot: - $ref: '#/components/schemas/_common.aggregations:BoxplotAggregation' - bucket_script: - $ref: '#/components/schemas/_common.aggregations:BucketScriptAggregation' - bucket_selector: - $ref: '#/components/schemas/_common.aggregations:BucketSelectorAggregation' - bucket_sort: - $ref: '#/components/schemas/_common.aggregations:BucketSortAggregation' - bucket_count_ks_test: - $ref: '#/components/schemas/_common.aggregations:BucketKsAggregation' - bucket_correlation: - $ref: '#/components/schemas/_common.aggregations:BucketCorrelationAggregation' - cardinality: - $ref: '#/components/schemas/_common.aggregations:CardinalityAggregation' - categorize_text: - $ref: '#/components/schemas/_common.aggregations:CategorizeTextAggregation' - children: - $ref: '#/components/schemas/_common.aggregations:ChildrenAggregation' - composite: - $ref: '#/components/schemas/_common.aggregations:CompositeAggregation' - cumulative_cardinality: - $ref: '#/components/schemas/_common.aggregations:CumulativeCardinalityAggregation' - cumulative_sum: - $ref: '#/components/schemas/_common.aggregations:CumulativeSumAggregation' - date_histogram: - $ref: '#/components/schemas/_common.aggregations:DateHistogramAggregation' - date_range: - $ref: '#/components/schemas/_common.aggregations:DateRangeAggregation' - derivative: - $ref: '#/components/schemas/_common.aggregations:DerivativeAggregation' - diversified_sampler: - $ref: '#/components/schemas/_common.aggregations:DiversifiedSamplerAggregation' - extended_stats: - $ref: '#/components/schemas/_common.aggregations:ExtendedStatsAggregation' - extended_stats_bucket: - $ref: '#/components/schemas/_common.aggregations:ExtendedStatsBucketAggregation' - frequent_item_sets: - $ref: '#/components/schemas/_common.aggregations:FrequentItemSetsAggregation' - filter: - $ref: '#/components/schemas/_common.query_dsl:QueryContainer' - filters: - $ref: '#/components/schemas/_common.aggregations:FiltersAggregation' - geo_bounds: - $ref: '#/components/schemas/_common.aggregations:GeoBoundsAggregation' - geo_centroid: - $ref: '#/components/schemas/_common.aggregations:GeoCentroidAggregation' - geo_distance: - $ref: '#/components/schemas/_common.aggregations:GeoDistanceAggregation' - geohash_grid: - $ref: '#/components/schemas/_common.aggregations:GeoHashGridAggregation' - geo_line: - $ref: '#/components/schemas/_common.aggregations:GeoLineAggregation' - geotile_grid: - $ref: '#/components/schemas/_common.aggregations:GeoTileGridAggregation' - geohex_grid: - $ref: '#/components/schemas/_common.aggregations:GeohexGridAggregation' - global: - $ref: '#/components/schemas/_common.aggregations:GlobalAggregation' - histogram: - $ref: '#/components/schemas/_common.aggregations:HistogramAggregation' - ip_range: - $ref: '#/components/schemas/_common.aggregations:IpRangeAggregation' - ip_prefix: - $ref: '#/components/schemas/_common.aggregations:IpPrefixAggregation' - inference: - $ref: '#/components/schemas/_common.aggregations:InferenceAggregation' - line: - $ref: '#/components/schemas/_common.aggregations:GeoLineAggregation' - matrix_stats: - $ref: '#/components/schemas/_common.aggregations:MatrixStatsAggregation' - max: - $ref: '#/components/schemas/_common.aggregations:MaxAggregation' - max_bucket: - $ref: '#/components/schemas/_common.aggregations:MaxBucketAggregation' - median_absolute_deviation: - $ref: '#/components/schemas/_common.aggregations:MedianAbsoluteDeviationAggregation' - min: - $ref: '#/components/schemas/_common.aggregations:MinAggregation' - min_bucket: - $ref: '#/components/schemas/_common.aggregations:MinBucketAggregation' - missing: - $ref: '#/components/schemas/_common.aggregations:MissingAggregation' - moving_avg: - $ref: '#/components/schemas/_common.aggregations:MovingAverageAggregation' - moving_percentiles: - $ref: '#/components/schemas/_common.aggregations:MovingPercentilesAggregation' - moving_fn: - $ref: '#/components/schemas/_common.aggregations:MovingFunctionAggregation' - multi_terms: - $ref: '#/components/schemas/_common.aggregations:MultiTermsAggregation' - nested: - $ref: '#/components/schemas/_common.aggregations:NestedAggregation' - normalize: - $ref: '#/components/schemas/_common.aggregations:NormalizeAggregation' - parent: - $ref: '#/components/schemas/_common.aggregations:ParentAggregation' - percentile_ranks: - $ref: '#/components/schemas/_common.aggregations:PercentileRanksAggregation' - percentiles: - $ref: '#/components/schemas/_common.aggregations:PercentilesAggregation' - percentiles_bucket: - $ref: '#/components/schemas/_common.aggregations:PercentilesBucketAggregation' - range: - $ref: '#/components/schemas/_common.aggregations:RangeAggregation' - rare_terms: - $ref: '#/components/schemas/_common.aggregations:RareTermsAggregation' - rate: - $ref: '#/components/schemas/_common.aggregations:RateAggregation' - reverse_nested: - $ref: '#/components/schemas/_common.aggregations:ReverseNestedAggregation' - sampler: - $ref: '#/components/schemas/_common.aggregations:SamplerAggregation' - scripted_metric: - $ref: '#/components/schemas/_common.aggregations:ScriptedMetricAggregation' - serial_diff: - $ref: '#/components/schemas/_common.aggregations:SerialDifferencingAggregation' - significant_terms: - $ref: '#/components/schemas/_common.aggregations:SignificantTermsAggregation' - significant_text: - $ref: '#/components/schemas/_common.aggregations:SignificantTextAggregation' - stats: - $ref: '#/components/schemas/_common.aggregations:StatsAggregation' - stats_bucket: - $ref: '#/components/schemas/_common.aggregations:StatsBucketAggregation' - string_stats: - $ref: '#/components/schemas/_common.aggregations:StringStatsAggregation' - sum: - $ref: '#/components/schemas/_common.aggregations:SumAggregation' - sum_bucket: - $ref: '#/components/schemas/_common.aggregations:SumBucketAggregation' - terms: - $ref: '#/components/schemas/_common.aggregations:TermsAggregation' - top_hits: - $ref: '#/components/schemas/_common.aggregations:TopHitsAggregation' - t_test: - $ref: '#/components/schemas/_common.aggregations:TTestAggregation' - top_metrics: - $ref: '#/components/schemas/_common.aggregations:TopMetricsAggregation' - value_count: - $ref: '#/components/schemas/_common.aggregations:ValueCountAggregation' - weighted_avg: - $ref: '#/components/schemas/_common.aggregations:WeightedAverageAggregation' - variable_width_histogram: - $ref: '#/components/schemas/_common.aggregations:VariableWidthHistogramAggregation' - minProperties: 1 - maxProperties: 1 - _common.aggregations:AggregationRange: + count: + description: |- + Total number of non-deleted documents across all primary shards assigned to selected nodes. + This number is based on documents in Lucene segments and may include documents from nested fields. + type: number + deleted: + description: |- + Total number of deleted documents across all primary shards assigned to selected nodes. + This number is based on documents in Lucene segments. + OpenSearch reclaims the disk space of deleted Lucene documents when a segment is merged. + type: number + required: + - count + _common:DocStatus: + description: Item level REST category class codes during indexing. type: object properties: - from: - description: Start of the range (inclusive). - oneOf: - - type: number - - type: string - - nullable: true - type: string - key: - description: Custom key to return the range with. - type: string - to: - description: End of the range (exclusive). - oneOf: - - type: number - - type: string - - nullable: true - type: string - _common.aggregations:ArrayPercentilesItem: + 1xx: + type: number + 2xx: + type: number + 3xx: + type: number + 4xx: + type: number + 5xx: + type: number + _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)$ + type: string + _common:DurationLarge: + description: |- + A date histogram interval. Similar to `Duration` with additional units: `w` (week), `M` (month), `q` (quarter) and + `y` (year) + type: string + _common:DurationValueUnitMillis: + allOf: + - $ref: '#/components/schemas/_common:UnitMillis' + _common:DurationValueUnitNanos: + allOf: + - $ref: '#/components/schemas/_common:UnitNanos' + _common:EmptyObject: + type: object + _common:EpochTimeUnitMillis: + allOf: + - $ref: '#/components/schemas/_common:UnitMillis' + _common:EpochTimeUnitSeconds: + allOf: + - $ref: '#/components/schemas/_common:UnitSeconds' + _common:ErrorCause: type: object properties: - key: + type: + description: The type of error type: string - value: - oneOf: - - type: number - - nullable: true - type: string - value_as_string: + reason: + description: A human-readable explanation of the error, in english + type: string + stack_trace: + 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' + root_cause: + type: array + items: + $ref: '#/components/schemas/_common:ErrorCause' + suppressed: + type: array + items: + $ref: '#/components/schemas/_common:ErrorCause' required: - - key - - value - _common.aggregations:AutoDateHistogramAggregate: - allOf: - - $ref: '#/components/schemas/_common.aggregations:MultiBucketAggregateBaseDateHistogramBucket' - - type: object - properties: - interval: - $ref: '#/components/schemas/_common:DurationLarge' - required: - - interval - _common.aggregations:AutoDateHistogramAggregation: - allOf: - - $ref: '#/components/schemas/_common.aggregations:BucketAggregationBase' - - type: object - properties: - buckets: - description: The target number of buckets. - type: number - 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' - missing: - $ref: '#/components/schemas/_common:DateTime' - offset: - description: Time zone specified as a ISO 8601 UTC offset. - type: string - params: - type: object - additionalProperties: - type: object - script: - $ref: '#/components/schemas/_common:Script' - time_zone: - $ref: '#/components/schemas/_common:TimeZone' - _common.aggregations:AverageAggregation: - allOf: - - $ref: '#/components/schemas/_common.aggregations:FormatMetricAggregationBase' - - type: object - _common.aggregations:AverageBucketAggregation: - allOf: - - $ref: '#/components/schemas/_common.aggregations:PipelineAggregationBase' - - type: object - _common.aggregations:AvgAggregate: - allOf: - - $ref: '#/components/schemas/_common.aggregations:SingleMetricAggregateBase' - - type: object - _common.aggregations:BoxPlotAggregate: - allOf: - - $ref: '#/components/schemas/_common.aggregations:AggregateBase' - - type: object - properties: - min: - type: number - max: - type: number - q1: - type: number - q2: - type: number - q3: - type: number - lower: - type: number - upper: - type: number - min_as_string: - type: string - max_as_string: - type: string - q1_as_string: - type: string - q2_as_string: - type: string - q3_as_string: - type: string - lower_as_string: - type: string - upper_as_string: - type: string - required: - - min - - max - - q1 - - q2 - - q3 - - lower - - upper - _common.aggregations:BoxplotAggregation: - allOf: - - $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: - allOf: - - $ref: '#/components/schemas/_common.aggregations:Aggregation' - - type: object - _common.aggregations:BucketCorrelationAggregation: - allOf: - - $ref: '#/components/schemas/_common.aggregations:BucketPathAggregation' + - type + _common:ErrorResponseBase: + type: object + properties: + error: + $ref: '#/components/schemas/_common:ErrorCause' + status: + type: number + required: + - error + - status + _common:ExpandWildcard: + type: string + enum: + - all + - closed + - hidden + - none + - open + _common:ExpandWildcards: + oneOf: + - $ref: '#/components/schemas/_common:ExpandWildcard' + - type: array + items: + $ref: '#/components/schemas/_common:ExpandWildcard' + _common:Field: + description: Path to field or array of paths. Some API's support wildcards in the path to select multiple fields. + type: string + _common:FielddataStats: + type: object + properties: + evictions: + type: number + memory_size: + $ref: '#/components/schemas/_common:ByteSize' + memory_size_in_bytes: + type: number + fields: + type: object + additionalProperties: + $ref: '#/components/schemas/_common:FieldMemoryUsage' + required: + - memory_size_in_bytes + _common:FieldMemoryUsage: + type: object + properties: + memory_size: + $ref: '#/components/schemas/_common:ByteSize' + memory_size_in_bytes: + type: number + required: + - memory_size_in_bytes + _common:Fields: + oneOf: + - $ref: '#/components/schemas/_common:Field' + - type: array + items: + $ref: '#/components/schemas/_common:Field' + _common:FieldSizeUsage: + type: object + properties: + size: + $ref: '#/components/schemas/_common:ByteSize' + size_in_bytes: + type: number + required: + - size_in_bytes + _common:FieldValue: + description: A field value. + oneOf: + - type: number + - type: number + - type: string + - type: boolean + - nullable: true + type: string - type: object - properties: - function: - $ref: '#/components/schemas/_common.aggregations:BucketCorrelationFunction' - required: - - function - _common.aggregations:BucketCorrelationFunction: + _common:FlushStats: type: object properties: - count_correlation: - $ref: '#/components/schemas/_common.aggregations:BucketCorrelationFunctionCountCorrelation' + periodic: + type: number + total: + type: number + total_time: + $ref: '#/components/schemas/_common:Duration' + total_time_in_millis: + $ref: '#/components/schemas/_common:DurationValueUnitMillis' required: - - count_correlation - _common.aggregations:BucketCorrelationFunctionCountCorrelation: + - periodic + - total + - total_time_in_millis + _common:Fuzziness: + oneOf: + - type: string + - type: number + _common:GeoBounds: + description: |- + A geo bounding box. It can be represented in various ways: + - as 4 top/bottom/left/right coordinates + - as 2 top_left / bottom_right points + - as 2 top_right / bottom_left points + - as a WKT bounding box + oneOf: + - $ref: '#/components/schemas/_common:CoordsGeoBounds' + - $ref: '#/components/schemas/_common:TopLeftBottomRightGeoBounds' + - $ref: '#/components/schemas/_common:TopRightBottomLeftGeoBounds' + - $ref: '#/components/schemas/_common:WktGeoBounds' + _common:GeoDistanceSort: type: object properties: - indicator: - $ref: '#/components/schemas/_common.aggregations:BucketCorrelationFunctionCountCorrelationIndicator' + mode: + $ref: '#/components/schemas/_common:SortMode' + distance_type: + $ref: '#/components/schemas/_common:GeoDistanceType' + ignore_unmapped: + type: boolean + order: + $ref: '#/components/schemas/_common:SortOrder' + unit: + $ref: '#/components/schemas/_common:DistanceUnit' + _common:GeoDistanceType: + type: string + enum: + - arc + - plane + _common:GeoHash: + type: string + _common:GeoHashLocation: + type: object + properties: + geohash: + $ref: '#/components/schemas/_common:GeoHash' required: - - indicator - _common.aggregations:BucketCorrelationFunctionCountCorrelationIndicator: + - geohash + _common:GeoHashPrecision: + description: A precision that can be expressed as a geohash length between 1 and 12, or a distance measure like "1km", "10m". + oneOf: + - type: number + - type: string + _common:GeoHexCell: + description: A map hex cell (H3) reference + type: string + _common:GeoLine: 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 - to which the term values are correlated. + type: + description: Always `"LineString"` + type: string + coordinates: + description: Array of `[lon, lat]` coordinates + type: array + items: + type: array + items: + type: number + required: + - coordinates + - type + _common:GeoLocation: + description: |- + A latitude/longitude as a 2 dimensional point. It can be represented in various ways: + - as a `{lat, long}` object + - as a geo hash value + - as a `[lon, lat]` array + - as a string in `", "` or WKT point formats + oneOf: + - $ref: '#/components/schemas/_common:LatLonGeoLocation' + - $ref: '#/components/schemas/_common:GeoHashLocation' + - type: array + items: + type: number + - type: string + _common:GeoShapeRelation: + type: string + enum: + - contains + - disjoint + - intersects + - within + _common:GeoTile: + description: A map tile reference, represented as `{zoom}/{x}/{y}` + type: string + _common:GeoTilePrecision: + type: number + _common:GetStats: + type: object + properties: + current: type: number - expectations: - description: |- - An array of numbers with which to correlate the configured `bucket_path` values. - The length of this value must always equal the number of buckets returned by the `bucket_path`. + exists_time: + $ref: '#/components/schemas/_common:Duration' + exists_time_in_millis: + $ref: '#/components/schemas/_common:DurationValueUnitMillis' + exists_total: + type: number + missing_time: + $ref: '#/components/schemas/_common:Duration' + missing_time_in_millis: + $ref: '#/components/schemas/_common:DurationValueUnitMillis' + missing_total: + type: number + time: + $ref: '#/components/schemas/_common:Duration' + time_in_millis: + $ref: '#/components/schemas/_common:DurationValueUnitMillis' + total: + type: number + required: + - current + - exists_time_in_millis + - exists_total + - missing_time_in_millis + - missing_total + - time_in_millis + - total + _common:HealthStatus: + type: string + enum: + - green + - red + - yellow + _common:HealthStatusCapitalized: + type: string + enum: + - GREEN + - RED + - YELLOW + _common:Host: + type: string + _common:HourAndMinute: + type: object + properties: + hour: type: array items: type: number - 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, - must equal expectations. + minute: type: array items: type: number required: - - doc_count - - expectations - _common.aggregations:BucketKsAggregation: + - hour + - minute + _common:HttpHeaders: + type: object + additionalProperties: + oneOf: + - type: string + - type: array + items: + type: string + _common:IBDistribution: + type: string + enum: + - ll + - spl + _common:IBLambda: + type: string + enum: + - df + - ttf + _common:Id: + type: string + _common:Ids: + oneOf: + - $ref: '#/components/schemas/_common:Id' + - type: array + items: + $ref: '#/components/schemas/_common:Id' + _common:IndexAlias: + type: string + _common:IndexingStats: + type: object + properties: + index_current: + type: number + delete_current: + type: number + delete_time: + $ref: '#/components/schemas/_common:Duration' + delete_time_in_millis: + $ref: '#/components/schemas/_common:DurationValueUnitMillis' + delete_total: + type: number + doc_status: + $ref: '#/components/schemas/_common:DocStatus' + is_throttled: + type: boolean + noop_update_total: + type: number + throttle_time: + $ref: '#/components/schemas/_common:Duration' + throttle_time_in_millis: + $ref: '#/components/schemas/_common:DurationValueUnitMillis' + index_time: + $ref: '#/components/schemas/_common:Duration' + index_time_in_millis: + $ref: '#/components/schemas/_common:DurationValueUnitMillis' + index_total: + type: number + index_failed: + type: number + types: + type: object + additionalProperties: + $ref: '#/components/schemas/_common:IndexingStats' + write_load: + type: number + required: + - delete_current + - delete_time_in_millis + - delete_total + - index_current + - index_failed + - index_time_in_millis + - index_total + - is_throttled + - noop_update_total + - throttle_time_in_millis + _common:IndexName: + type: string + _common:Indices: + oneOf: + - $ref: '#/components/schemas/_common:IndexName' + - type: array + items: + $ref: '#/components/schemas/_common:IndexName' + _common:IndicesResponseBase: allOf: - - $ref: '#/components/schemas/_common.aggregations:BucketPathAggregation' + - $ref: '#/components/schemas/_common:AcknowledgedResponseBase' - type: object properties: - alternative: - description: |- - A list of string values indicating which K-S test alternative to calculate. The valid values - are: "greater", "less", "two_sided". This parameter is key for determining the K-S statistic used - when calculating the K-S test. Default value is all possible alternative hypotheses. - type: array - items: - type: string - fractions: - description: |- - A list of doubles indicating the distribution of the samples with which to compare to the `buckets_path` results. - In typical usage this is the overall proportion of documents in each bucket, which is compared with the actual - document proportions in each bucket from the sibling aggregation counts. The default is to assume that overall - documents are uniformly distributed on these buckets, which they would be if one used equal percentiles of a - metric to define the bucket end points. - type: array - items: - type: number - sampling_method: - description: |- - Indicates the sampling methodology when calculating the K-S test. Note, this is sampling of the returned values. - This determines the cumulative distribution function (CDF) points used comparing the two samples. Default is - `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: + _shards: + $ref: '#/components/schemas/_common:ShardStatistics' + _common:InlineGet: + type: object + properties: + fields: + type: object + additionalProperties: + type: object + found: + type: boolean + _seq_no: + $ref: '#/components/schemas/_common:SequenceNumber' + _primary_term: + type: number + _routing: + $ref: '#/components/schemas/_common:Routing' + _source: + type: object + required: + - found + _common:InlineGetDictUserDefined: + type: object + properties: + fields: + type: object + additionalProperties: + type: object + found: + type: boolean + _seq_no: + $ref: '#/components/schemas/_common:SequenceNumber' + _primary_term: + type: number + _routing: + $ref: '#/components/schemas/_common:Routing' + _source: + type: object + additionalProperties: true + required: + - found + _common:InlineScript: allOf: - - $ref: '#/components/schemas/_common.aggregations:SingleMetricAggregateBase' + - $ref: '#/components/schemas/_common:ScriptBase' - type: object properties: - keys: - type: array - items: + lang: + $ref: '#/components/schemas/_common:ScriptLanguage' + options: + type: object + additionalProperties: type: string + source: + description: The script source. + type: string required: - - keys - _common.aggregations:BucketPathAggregation: - allOf: - - $ref: '#/components/schemas/_common.aggregations:Aggregation' - - type: object - properties: - buckets_path: - $ref: '#/components/schemas/_common.aggregations:BucketsPath' - _common.aggregations:BucketScriptAggregation: - allOf: - - $ref: '#/components/schemas/_common.aggregations:PipelineAggregationBase' - - type: object - properties: - script: - $ref: '#/components/schemas/_common:Script' - _common.aggregations:BucketSelectorAggregation: - allOf: - - $ref: '#/components/schemas/_common.aggregations:PipelineAggregationBase' - - type: object - properties: - script: - $ref: '#/components/schemas/_common:Script' - _common.aggregations:BucketSortAggregation: - allOf: - - $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' - 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: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. + - source + _common:Ip: + type: string + _common:KnnQuery: + type: object + properties: + field: + $ref: '#/components/schemas/_common:Field' + query_vector: + $ref: '#/components/schemas/_common:QueryVector' + query_vector_builder: + $ref: '#/components/schemas/_common:QueryVectorBuilder' + k: + description: The final number of nearest neighbors to return as top hits + type: number + num_candidates: + description: The number of nearest neighbor candidates to consider per shard + type: number + boost: + description: Boost value to apply to kNN scores + type: number + filter: + description: Filters for the kNN search query + oneOf: + - $ref: '#/components/schemas/_common.query_dsl:QueryContainer' + - type: array + items: + $ref: '#/components/schemas/_common.query_dsl:QueryContainer' + similarity: + description: The minimum similarity for a vector to be considered a match + type: number + required: + - field + - k + - num_candidates + _common:LatLonGeoLocation: + type: object + properties: + lat: + description: Latitude + type: number + lon: + description: Longitude + type: number + required: + - lat + - lon + _common:Level: + type: string + enum: + - cluster + - indices + - shards + _common:MergesStats: + type: object + properties: + current: + type: number + current_docs: + type: number + current_size: + type: string + current_size_in_bytes: + type: number + total: + type: number + total_auto_throttle: + type: string + total_auto_throttle_in_bytes: + type: number + total_docs: + type: number + total_size: + type: string + total_size_in_bytes: + type: number + total_stopped_time: + $ref: '#/components/schemas/_common:Duration' + total_stopped_time_in_millis: + $ref: '#/components/schemas/_common:DurationValueUnitMillis' + total_throttled_time: + $ref: '#/components/schemas/_common:Duration' + total_throttled_time_in_millis: + $ref: '#/components/schemas/_common:DurationValueUnitMillis' + total_time: + $ref: '#/components/schemas/_common:Duration' + total_time_in_millis: + $ref: '#/components/schemas/_common:DurationValueUnitMillis' + unreferenced_file_cleanups_performed: + type: number + required: + - current + - current_docs + - current_size_in_bytes + - total + - total_auto_throttle_in_bytes + - total_docs + - total_size_in_bytes + - total_stopped_time_in_millis + - total_throttled_time_in_millis + - total_time_in_millis + _common:Metadata: + type: object + additionalProperties: true + _common:Metrics: oneOf: - - type: object - additionalProperties: - $ref: '#/components/schemas/_common.aggregations:AdjacencyMatrixBucket' + - type: string - type: array items: - $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. + type: string + _common:MinimumShouldMatch: + description: The minimum number of terms that should match as integer, percentage or range oneOf: - - type: object - additionalProperties: - $ref: '#/components/schemas/_common.aggregations:CompositeBucket' - - type: array - items: - $ref: '#/components/schemas/_common.aggregations:CompositeBucket' - _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. + - type: number + - type: string + _common:MultiTermQueryRewrite: + type: string + _common:Name: + type: string + _common:Names: oneOf: - - type: object - additionalProperties: - $ref: '#/components/schemas/_common.aggregations:DateHistogramBucket' + - $ref: '#/components/schemas/_common:Name' - type: array items: - $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 + $ref: '#/components/schemas/_common:Name' + _common:NestedSortValue: + type: object + properties: + filter: + $ref: '#/components/schemas/_common.query_dsl:QueryContainer' + max_children: + type: number + nested: + $ref: '#/components/schemas/_common:NestedSortValue' + path: + $ref: '#/components/schemas/_common:Field' + required: + - path + _common:NodeAttributes: + type: object + properties: + attributes: + description: Lists node attributes. + type: object additionalProperties: - $ref: '#/components/schemas/_common.aggregations:DoubleTermsBucket' - - type: array - items: - $ref: '#/components/schemas/_common.aggregations:DoubleTermsBucket' - _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. + type: string + ephemeral_id: + $ref: '#/components/schemas/_common:Id' + id: + $ref: '#/components/schemas/_common:NodeId' + name: + $ref: '#/components/schemas/_common:NodeName' + transport_address: + $ref: '#/components/schemas/_common:TransportAddress' + roles: + $ref: '#/components/schemas/_common:NodeRoles' + external_id: + type: string + required: + - attributes + - ephemeral_id + - name + - transport_address + _common:NodeId: + type: string + _common:NodeIds: oneOf: - - type: object - additionalProperties: - $ref: '#/components/schemas/_common.aggregations:FiltersBucket' + - $ref: '#/components/schemas/_common:NodeId' - type: array items: - $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 + $ref: '#/components/schemas/_common:NodeId' + _common:NodeName: + type: string + _common:NodeRole: + type: string + enum: + - client + - cluster_manager + - coordinating_only + - data + - data_cold + - data_content + - data_frozen + - data_hot + - data_warm + - ingest + - master + - ml + - remote_cluster_client + - transform + - voting_only + _common:NodeRoles: + description: '* @doc_id node-roles' + type: array + items: + $ref: '#/components/schemas/_common:NodeRole' + _common:NodeShard: + type: object + properties: + state: + $ref: '#/components/schemas/indices.stats:ShardRoutingState' + primary: + type: boolean + node: + $ref: '#/components/schemas/_common:NodeName' + shard: + type: number + index: + $ref: '#/components/schemas/_common:IndexName' + allocation_id: + type: object additionalProperties: - $ref: '#/components/schemas/_common.aggregations:FrequentItemSetsBucket' - - type: array + $ref: '#/components/schemas/_common:Id' + recovery_source: + type: object + additionalProperties: + $ref: '#/components/schemas/_common:Id' + unassigned_info: + $ref: '#/components/schemas/cluster.allocation_explain:UnassignedInformation' + relocating_node: + oneOf: + - $ref: '#/components/schemas/_common:NodeId' + - nullable: true + type: string + relocation_failure_info: + $ref: '#/components/schemas/_common:RelocationFailureInfo' + required: + - index + - primary + - shard + - state + _common:NodeStatistics: + type: object + properties: + failures: + type: array items: - $ref: '#/components/schemas/_common.aggregations:FrequentItemSetsBucket' - _common.aggregations:BucketsGeoHashGridBucket: + $ref: '#/components/schemas/_common:ErrorCause' + total: + description: Total number of nodes selected by the request. + type: number + successful: + description: Number of nodes that responded successfully to the request. + type: number + failed: + description: Number of nodes that rejected the request or failed to respond. If this value is not 0, a reason for the rejection or failure is included in the response. + type: number + required: + - failed + - successful + - total + _common:Normalization: + type: string + enum: + - h1 + - h2 + - h3 + - no + - z + _common:OpenSearchVersionInfo: + type: object + properties: + build_date: + $ref: '#/components/schemas/_common:DateTime' + build_flavor: + type: string + build_hash: + type: string + build_snapshot: + type: boolean + build_type: + type: string + distribution: + type: string + lucene_version: + $ref: '#/components/schemas/_common:VersionString' + minimum_index_compatibility_version: + $ref: '#/components/schemas/_common:VersionString' + minimum_wire_compatibility_version: + $ref: '#/components/schemas/_common:VersionString' + number: + type: string + required: + - build_date + - build_hash + - build_snapshot + - build_type + - distribution + - lucene_version + - minimum_index_compatibility_version + - minimum_wire_compatibility_version + - number + _common:OpType: + type: string + enum: + - create + - index + _common:Password: + type: string + _common:Percentage: + oneOf: + - type: string + - type: number + _common:PhaseTook: + type: object + properties: + dfs_pre_query: + $ref: '#/components/schemas/_common:uint' + query: + $ref: '#/components/schemas/_common:uint' + fetch: + $ref: '#/components/schemas/_common:uint' + dfs_query: + $ref: '#/components/schemas/_common:uint' + expand: + $ref: '#/components/schemas/_common:uint' + can_match: + $ref: '#/components/schemas/_common:uint' + required: + - can_match + - dfs_pre_query + - dfs_query + - expand + - fetch + - query + _common:PipelineName: + type: string + _common:PipeSeparatedFlagsSimpleQueryStringFlag: 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. + A set of flags that can be represented as a single enum value or a set of values that are encoded + as a pipe-separated string + + 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' + - type: string + _common:PluginStats: + type: object + properties: + classname: + type: string + description: + type: string + extended_plugins: + type: array + items: + type: string + has_native_controller: + type: boolean + java_version: + $ref: '#/components/schemas/_common:VersionString' + name: + $ref: '#/components/schemas/_common:Name' + version: + $ref: '#/components/schemas/_common:VersionString' + licensed: + type: boolean + custom_foldername: + nullable: true + type: string + opensearch_version: + $ref: '#/components/schemas/_common:VersionString' + required: + - classname + - description + - extended_plugins + - has_native_controller + - java_version + - name + - opensearch_version + - version + _common:QueryCacheStats: + type: object + properties: + cache_count: + description: |- + Total number of entries added to the query cache across all shards assigned to selected nodes. + This number includes current and evicted entries. + type: number + cache_size: + description: Total number of entries currently in the query cache across all shards assigned to selected nodes. + type: number + evictions: + description: Total number of query cache evictions across all shards assigned to selected nodes. + type: number + hit_count: + description: Total count of query cache hits across all shards assigned to selected nodes. + type: number + memory_size: + $ref: '#/components/schemas/_common:ByteSize' + memory_size_in_bytes: + description: Total amount, in bytes, of memory used for the query cache across all shards assigned to selected nodes. + type: number + miss_count: + description: Total count of query cache misses across all shards assigned to selected nodes. + type: number + total_count: + description: Total count of hits and misses in the query cache across all shards assigned to selected nodes. + type: number + required: + - cache_count + - cache_size + - evictions + - hit_count + - memory_size_in_bytes + - miss_count + - total_count + _common:QueryVector: + type: array + items: + type: number + _common:QueryVectorBuilder: + type: object + properties: + text_embedding: + $ref: '#/components/schemas/_common:TextEmbedding' + minProperties: 1 + maxProperties: 1 + _common:RankBase: + type: object + _common:RankContainer: + type: object + properties: + rrf: + $ref: '#/components/schemas/_common:RrfRank' + minProperties: 1 + maxProperties: 1 + _common:RecoveryStats: + type: object + properties: + current_as_source: + type: number + current_as_target: + type: number + throttle_time: + $ref: '#/components/schemas/_common:Duration' + throttle_time_in_millis: + $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: + type: object + properties: + external_total: + type: number + external_total_time_in_millis: + $ref: '#/components/schemas/_common:DurationValueUnitMillis' + listeners: + type: number + total: + type: number + total_time: + $ref: '#/components/schemas/_common:Duration' + total_time_in_millis: + $ref: '#/components/schemas/_common:DurationValueUnitMillis' + required: + - external_total + - external_total_time_in_millis + - listeners + - total + - total_time_in_millis + _common:RelationName: + type: string + _common:RelocationFailureInfo: + type: object + properties: + failed_attempts: + type: number + required: + - failed_attempts + _common:RemoteStoreDownloadStats: + type: object + description: Statistics related to downloads to the remote segment store. + properties: + total_download_size: + description: The total amount of data download from the remote segment store. + $ref: '#/components/schemas/_common:RemoteStoreUploadDownloadStats' + total_time_spent_in_millis: + description: The total duration, in milliseconds, spent on downloads from the remote segment store. + $ref: '#/components/schemas/_common:DurationValueUnitMillis' + required: + - total_download_size + - total_time_spent_in_millis + _common:RemoteStoreStats: + type: object + description: Statistics about remote segment store operations. + properties: + upload: + $ref: '#/components/schemas/_common:RemoteStoreUploadStats' + download: + $ref: '#/components/schemas/_common:RemoteStoreDownloadStats' + required: + - download + - upload + _common:RemoteStoreTranslogStats: + type: object + properties: + upload: + $ref: '#/components/schemas/_common:RemoteStoreTranslogUploadStats' + required: + - upload + _common:RemoteStoreTranslogUploadStats: + type: object + description: Statistics related to uploads to the remote translog store. + properties: + total_uploads: + $ref: '#/components/schemas/_common:RemoteStoreTranslogUploadTotalUploadsStats' + total_upload_size: + $ref: '#/components/schemas/_common:RemoteStoreTranslogUploadTotalUploadSizeStats' + required: + - total_upload_size + - total_uploads + _common:RemoteStoreTranslogUploadTotalUploadSizeStats: + type: object + description: The total amount of data uploaded to the remote translog store. + properties: + failed_bytes: + description: The number of bytes that failed to upload to the remote translog store. + $ref: '#/components/schemas/_common:ByteSize' + started_bytes: + description: The number of bytes successfully uploaded to the remote translog store. + $ref: '#/components/schemas/_common:ByteSize' + succeeded_bytes: + description: The number of bytes successfully uploaded to the remote translog store. + $ref: '#/components/schemas/_common:ByteSize' + required: + - failed_bytes + - started_bytes + - succeeded_bytes + _common:RemoteStoreTranslogUploadTotalUploadsStats: + type: object + description: The number of syncs to the remote translog store. + properties: + failed: + description: The number of failed upload syncs to the remote translog store. + type: number + started: + description: The number of upload syncs to the remote translog store that have started. + type: number + succeeded: + description: The number of successful upload syncs to the remote translog store. + type: number + required: + - failed + - started + - succeeded + _common:RemoteStoreUploadDownloadStats: + type: object + description: The amount of data, in bytes, uploaded or downloaded to/from the remote segment store. + properties: + failed_bytes: + description: The number of bytes that failed to upload/upload to/from the remote segment store. + $ref: '#/components/schemas/_common:ByteSize' + 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:ByteSize' + succeeded_bytes: + description: The number of bytes successfully uploaded/downloaded to/from the remote segment store. + $ref: '#/components/schemas/_common:ByteSize' + required: + - failed_bytes + - started_bytes + - succeeded_bytes + _common:RemoteStoreUploadPressureStats: + type: object + description: Statistics related to segment store upload backpressure. + properties: + total_rejections: + description: The total number of requests rejected due to segment store upload backpressure. + type: number + required: + - total_rejections + _common:RemoteStoreUploadRefreshSizeLagStats: + type: object + description: The amount of lag during upload between the remote segment store and the local store. + properties: + 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:ByteSize' + 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:ByteSize' + required: + - max_bytes + - total_bytes + _common:RemoteStoreUploadStats: + type: object + description: Statistics related to uploads to the remote segment store. + properties: + 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' + pressure: + $ref: '#/components/schemas/_common:RemoteStoreUploadPressureStats' + refresh_size_lag: + $ref: '#/components/schemas/_common:RemoteStoreUploadRefreshSizeLagStats' + 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' + total_upload_size: + $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: + type: object + properties: + evictions: + type: number + hit_count: + type: number + memory_size: + type: string + memory_size_in_bytes: + type: number + miss_count: + type: number + required: + - evictions + - hit_count + - memory_size_in_bytes + - miss_count + _common:RequestStats: + type: object + properties: + time_in_millis: + $ref: '#/components/schemas/_common:DurationValueUnitMillis' + current: + type: number + total: + type: number + _common:Result: + type: string + enum: + - created + - deleted + - noop + - not_found + - updated + _common:Retries: + type: object + properties: + bulk: + type: number + search: + type: number + required: + - bulk + - search + _common:Routing: + type: string + _common:RrfRank: + allOf: + - $ref: '#/components/schemas/_common:RankBase' - type: object - additionalProperties: - $ref: '#/components/schemas/_common.aggregations:GeoHashGridBucket' - - type: array - items: - $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. + properties: + rank_constant: + description: How much influence documents in individual result sets per query have over the final ranked result set + type: number + window_size: + description: Size of the individual result sets per query + type: number + _common:ScheduleTimeOfDay: + description: A time of day, expressed either as `hh:mm`, `noon`, `midnight`, or an hour/minutes structure. oneOf: - - type: object - additionalProperties: - $ref: '#/components/schemas/_common.aggregations:GeoHexGridBucket' - - type: array - items: - $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. + - type: string + - $ref: '#/components/schemas/_common:HourAndMinute' + _common:ScoreSort: + type: object + properties: + order: + $ref: '#/components/schemas/_common:SortOrder' + _common:Script: oneOf: - - type: object + - $ref: '#/components/schemas/_common:InlineScript' + - $ref: '#/components/schemas/_common:StoredScriptId' + _common:ScriptBase: + type: object + properties: + params: + description: |- + Specifies any named parameters that are passed into the script as variables. + Use parameters instead of hard-coded values to decrease compile time. + type: object additionalProperties: - $ref: '#/components/schemas/_common.aggregations:GeoTileGridBucket' - - type: array - items: - $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. + type: object + _common:ScriptField: + type: object + properties: + script: + $ref: '#/components/schemas/_common:Script' + ignore_failure: + type: boolean + required: + - script + _common:ScriptLanguage: + type: string + enum: + - expression + - java + - mustache + - painless + _common:ScriptSort: + type: object + properties: + order: + $ref: '#/components/schemas/_common:SortOrder' + script: + $ref: '#/components/schemas/_common:Script' + type: + $ref: '#/components/schemas/_common:ScriptSortType' + mode: + $ref: '#/components/schemas/_common:SortMode' + nested: + $ref: '#/components/schemas/_common:NestedSortValue' + required: + - script + _common:ScriptSortType: + type: string + enum: + - number + - string + - version + _common:ScrollId: + type: string + _common:ScrollIds: oneOf: - - type: object - additionalProperties: - $ref: '#/components/schemas/_common.aggregations:HistogramBucket' + - $ref: '#/components/schemas/_common:ScrollId' - type: array items: - $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 + $ref: '#/components/schemas/_common:ScrollId' + _common:SearchStats: + type: object + properties: + concurrent_query_total: + description: The total number of query operations that use concurrent segment search. + type: number + concurrent_query_time: + $ref: '#/components/schemas/_common:Duration' + concurrent_query_time_in_millis: + description: The total amount of time taken by all query operations that use concurrent segment search, in milliseconds. + $ref: '#/components/schemas/_common:DurationValueUnitMillis' + concurrent_query_current: + description: The number of currently running query operations that use concurrent segment search. + type: number + concurrent_avg_slice_count: + description: The average slice count of all search requests. This is computed as the total slice count divided by the total number of concurrent search requests. + type: number + fetch_current: + description: The number of shard fetch operations that are currently running. + type: number + fetch_time: + description: The total amount of time for all shard fetch operations. + $ref: '#/components/schemas/_common:Duration' + fetch_time_in_millis: + description: The total amount of time for all shard fetch operations, in milliseconds. + $ref: '#/components/schemas/_common:DurationValueUnitMillis' + fetch_total: + description: The total number of shard fetch operations. + type: number + open_contexts: + description: The number of open search contexts. + type: number + point_in_time_total: + description: The total number of shard Point in Time (PIT) contexts that have been created (completed and active) since the node last restarted. + type: number + point_in_time_time: + $ref: '#/components/schemas/_common:Duration' + point_in_time_time_in_millis: + description: The amount of time that shard PIT contexts have been held open since the node last restarted, in milliseconds. + $ref: '#/components/schemas/_common:DurationValueUnitMillis' + point_in_time_current: + description: The number of shard PIT contexts currently open. + type: number + query_current: + description: The number of shard query operations that are currently running. + type: number + query_time: + description: The total amount of time for all shard query operations. + $ref: '#/components/schemas/_common:Duration' + query_time_in_millis: + description: The total amount of time for all shard query operations, in milliseconds. + $ref: '#/components/schemas/_common:DurationValueUnitMillis' + query_total: + description: The total number of shard query operations. + type: number + request: + type: object + description: Statistics about coordinator search operations for the node. additionalProperties: - $ref: '#/components/schemas/_common.aggregations:IpPrefixBucket' - - type: array - items: - $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 + $ref: '#/components/schemas/_common:RequestStats' + search_idle_reactivate_count_total: + type: number + scroll_current: + description: The number of shard scroll operations that are currently running. + type: number + scroll_time: + description: The total amount of time for all shard scroll operations. + $ref: '#/components/schemas/_common:Duration' + scroll_time_in_millis: + description: The total amount of time for all shard scroll operations, in milliseconds. + $ref: '#/components/schemas/_common:DurationValueUnitMillis' + scroll_total: + description: The total number of shard scroll operations. + type: number + suggest_current: + description: The number of shard suggest operations that are currently running. + type: number + suggest_time: + description: The total amount of time for all shard suggest operations. + $ref: '#/components/schemas/_common:Duration' + suggest_time_in_millis: + description: The total amount of time for all shard suggest operations, in milliseconds. + $ref: '#/components/schemas/_common:DurationValueUnitMillis' + suggest_total: + description: The total number of shard suggest operations. + type: number + groups: + type: object additionalProperties: - $ref: '#/components/schemas/_common.aggregations:IpRangeBucket' - - type: array - items: - $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 + $ref: '#/components/schemas/_common:SearchStats' + required: + - fetch_current + - fetch_time_in_millis + - fetch_total + - query_current + - query_time_in_millis + - query_total + - scroll_current + - scroll_time_in_millis + - scroll_total + - suggest_current + - suggest_time_in_millis + - suggest_total + _common:SearchType: + type: string + enum: + - dfs_query_then_fetch + - query_then_fetch + _common:SegmentReplicationStats: + type: object + properties: + max_bytes_behind: + $ref: '#/components/schemas/_common:ByteSize' + max_replication_lag: + $ref: '#/components/schemas/_common:ByteSize' + total_bytes_behind: + $ref: '#/components/schemas/_common:ByteSize' + required: + - max_bytes_behind + - max_replication_lag + - total_bytes_behind + _common:SegmentsStats: + type: object + properties: + count: + description: Total number of segments across all shards assigned to selected nodes. + type: number + doc_values_memory: + $ref: '#/components/schemas/_common:ByteSize' + doc_values_memory_in_bytes: + description: Total amount, in bytes, of memory used for doc values across all shards assigned to selected nodes. + type: number + 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/_common.aggregations:LongRareTermsBucket' - - type: array + $ref: '#/components/schemas/indices.stats:ShardFileSizeInfo' + fixed_bit_set: + $ref: '#/components/schemas/_common:ByteSize' + fixed_bit_set_memory_in_bytes: + description: Total amount of memory, in bytes, used by fixed bit sets across all shards assigned to selected nodes. + type: number + index_writer_memory: + $ref: '#/components/schemas/_common:ByteSize' + index_writer_max_memory_in_bytes: + type: number + index_writer_memory_in_bytes: + description: Total amount, in bytes, of memory used by all index writers across all shards assigned to selected nodes. + type: number + max_unsafe_auto_id_timestamp: + description: Unix timestamp, in milliseconds, of the most recently retried indexing request. + type: number + memory: + $ref: '#/components/schemas/_common:ByteSize' + memory_in_bytes: + description: Total amount, in bytes, of memory used for segments across all shards assigned to selected nodes. + type: number + norms_memory: + $ref: '#/components/schemas/_common:ByteSize' + norms_memory_in_bytes: + description: Total amount, in bytes, of memory used for normalization factors across all shards assigned to selected nodes. + type: number + points_memory: + $ref: '#/components/schemas/_common:ByteSize' + points_memory_in_bytes: + description: Total amount, in bytes, of memory used for points across all shards assigned to selected nodes. + type: number + stored_memory: + $ref: '#/components/schemas/_common:ByteSize' + stored_fields_memory_in_bytes: + description: Total amount, in bytes, of memory used for stored fields across all shards assigned to selected nodes. + type: number + terms_memory_in_bytes: + description: Total amount, in bytes, of memory used for terms across all shards assigned to selected nodes. + type: number + terms_memory: + $ref: '#/components/schemas/_common:ByteSize' + term_vectory_memory: + $ref: '#/components/schemas/_common:ByteSize' + term_vectors_memory_in_bytes: + description: Total amount, in bytes, of memory used for term vectors across all shards assigned to selected nodes. + type: number + version_map_memory: + $ref: '#/components/schemas/_common:ByteSize' + version_map_memory_in_bytes: + description: Total amount, in bytes, of memory used by all version maps across all shards assigned to selected nodes. + type: number + remote_store: + $ref: '#/components/schemas/_common:RemoteStoreStats' + segment_replication: + $ref: '#/components/schemas/_common:SegmentReplicationStats' + required: + - count + - doc_values_memory_in_bytes + - file_sizes + - fixed_bit_set_memory_in_bytes + - index_writer_memory_in_bytes + - max_unsafe_auto_id_timestamp + - memory_in_bytes + - norms_memory_in_bytes + - points_memory_in_bytes + - stored_fields_memory_in_bytes + - term_vectors_memory_in_bytes + - terms_memory_in_bytes + - version_map_memory_in_bytes + _common:SequenceNumber: + type: number + _common:ShardFailure: + type: object + properties: + index: + $ref: '#/components/schemas/_common:IndexName' + node: + type: string + reason: + $ref: '#/components/schemas/_common:ErrorCause' + shard: + type: number + status: + type: string + required: + - reason + - shard + _common:ShardsOperationResponseBase: + type: object + properties: + _shards: + $ref: '#/components/schemas/_common:ShardStatistics' + required: + - _shards + _common:ShardStatistics: + type: object + properties: + failed: + $ref: '#/components/schemas/_common:uint' + successful: + $ref: '#/components/schemas/_common:uint' + total: + $ref: '#/components/schemas/_common:uint' + failures: + type: array items: - $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. + $ref: '#/components/schemas/_common:ShardFailure' + skipped: + $ref: '#/components/schemas/_common:uint' + required: + - failed + - successful + - total + _common:short: + type: number + _common:SlicedScroll: + type: object + properties: + field: + $ref: '#/components/schemas/_common:Field' + id: + $ref: '#/components/schemas/_common:Id' + max: + type: number + required: + - id + - max + _common:Slices: + description: Slices configuration used to parallelize a process. oneOf: - - type: object - additionalProperties: - $ref: '#/components/schemas/_common.aggregations:LongTermsBucket' - - type: array - items: - $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. + - type: number + - $ref: '#/components/schemas/_common:SlicesCalculation' + _common:SlicesCalculation: + type: string + enum: + - auto + _common:Sort: oneOf: - - type: object - additionalProperties: - $ref: '#/components/schemas/_common.aggregations:MultiTermsBucket' + - $ref: '#/components/schemas/_common:SortCombinations' - type: array items: - $ref: '#/components/schemas/_common.aggregations:MultiTermsBucket' - _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 - path forms they accept. + $ref: '#/components/schemas/_common:SortCombinations' + _common:SortCombinations: oneOf: - - type: string - - type: array - items: - type: string - - type: object + - $ref: '#/components/schemas/_common:Field' + - $ref: '#/components/schemas/_common:SortOptions' + _common:SortMode: + type: string + enum: + - avg + - max + - median + - min + - sum + _common:SortOptions: + type: object + properties: + _score: + $ref: '#/components/schemas/_common:ScoreSort' + _doc: + $ref: '#/components/schemas/_common:ScoreSort' + _geo_distance: + $ref: '#/components/schemas/_common:GeoDistanceSort' + _script: + $ref: '#/components/schemas/_common:ScriptSort' + minProperties: 1 + maxProperties: 1 + _common:SortOrder: + type: string + enum: + - asc + - desc + _common:SortResults: + type: array + items: + $ref: '#/components/schemas/_common:FieldValue' + _common:StoredScript: + type: object + properties: + lang: + $ref: '#/components/schemas/_common:ScriptLanguage' + options: + type: object additionalProperties: type: string - _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' - - type: array - items: - $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' - - type: array - items: - $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: + source: + description: The script source. + type: string + required: + - lang + - source + _common:StoredScriptId: + allOf: + - $ref: '#/components/schemas/_common:ScriptBase' - type: object - additionalProperties: - $ref: '#/components/schemas/_common.aggregations:SignificantLongTermsBucket' - - type: array - items: - $ref: '#/components/schemas/_common.aggregations:SignificantLongTermsBucket' - _common.aggregations:BucketsSignificantStringTermsBucket: + properties: + id: + $ref: '#/components/schemas/_common:Id' + required: + - id + _common:StoreStats: + type: object + properties: + size: + $ref: '#/components/schemas/_common:ByteSize' + size_in_bytes: + description: Total size, in bytes, of all shards assigned to selected nodes. + type: number + reserved: + $ref: '#/components/schemas/_common:ByteSize' + reserved_in_bytes: + description: A prediction, in bytes, of how much larger the shard stores will eventually grow due to ongoing peer recoveries, restoring snapshots, and similar activities. + type: number + total_data_set_size: + $ref: '#/components/schemas/_common:ByteSize' + total_data_set_size_in_bytes: + description: |- + Total data set size, in bytes, of all shards assigned to selected nodes. + This includes the size of shards not stored fully on the nodes, such as the cache for partially mounted indices. + type: number + required: + - reserved_in_bytes + - size_in_bytes + _common:Stringifiedboolean: 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' - - type: array - items: - $ref: '#/components/schemas/_common.aggregations:SignificantStringTermsBucket' - _common.aggregations:BucketsStringRareTermsBucket: + Some APIs will return values such as numbers also as a string (notably epoch timestamps). This behavior + is used to capture this behavior while keeping the semantics of the field type. + + Depending on the target language, code generators can keep the union or remove it and leniently parse + strings to the target type. + oneOf: + - type: boolean + - type: string + _common:StringifiedEpochTimeUnitMillis: 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. + Some APIs will return values such as numbers also as a string (notably epoch timestamps). This behavior + is used to capture this behavior while keeping the semantics of the field type. + + Depending on the target language, code generators can keep the union or remove it and leniently parse + strings to the target type. oneOf: - - type: object - additionalProperties: - $ref: '#/components/schemas/_common.aggregations:StringRareTermsBucket' - - type: array - items: - $ref: '#/components/schemas/_common.aggregations:StringRareTermsBucket' - _common.aggregations:BucketsStringTermsBucket: + - $ref: '#/components/schemas/_common:EpochTimeUnitMillis' + - type: string + _common:StringifiedEpochTimeUnitSeconds: 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. + Some APIs will return values such as numbers also as a string (notably epoch timestamps). This behavior + is used to capture this behavior while keeping the semantics of the field type. + + Depending on the target language, code generators can keep the union or remove it and leniently parse + strings to the target type. oneOf: - - type: object - additionalProperties: - $ref: '#/components/schemas/_common.aggregations:StringTermsBucket' - - type: array - items: - $ref: '#/components/schemas/_common.aggregations:StringTermsBucket' - _common.aggregations:BucketsVariableWidthHistogramBucket: + - $ref: '#/components/schemas/_common:EpochTimeUnitSeconds' + - type: string + _common:Stringifiedinteger: 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. + Some APIs will return values such as numbers also as a string (notably epoch timestamps). This behavior + is used to capture this behavior while keeping the semantics of the field type. + + Depending on the target language, code generators can keep the union or remove it and leniently parse + strings to the target type. oneOf: - - type: object - additionalProperties: - $ref: '#/components/schemas/_common.aggregations:VariableWidthHistogramBucket' - - type: array - items: - $ref: '#/components/schemas/_common.aggregations:VariableWidthHistogramBucket' - _common.aggregations:BucketsVoid: + - type: number + - type: string + _common:StringifiedVersionNumber: 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. + Some APIs will return values such as numbers also as a string (notably epoch timestamps). This behavior + is used to capture this behavior while keeping the semantics of the field type. + + Depending on the target language, code generators can keep the union or remove it and leniently parse + strings to the target type. oneOf: - - type: object - additionalProperties: - $ref: '#/components/schemas/_common:Void' - - type: array - items: - $ref: '#/components/schemas/_common:Void' - _common.aggregations:CalendarInterval: - type: string - enum: - - second - - minute - - hour - - day - - week - - month - - quarter - - year - _common.aggregations:CardinalityAggregate: - allOf: - - $ref: '#/components/schemas/_common.aggregations:AggregateBase' - - type: object - properties: - value: - type: number - required: - - value - _common.aggregations:CardinalityAggregation: - allOf: - - $ref: '#/components/schemas/_common.aggregations:MetricAggregationBase' - - type: object - properties: - precision_threshold: - description: |- - A unique count below which counts are expected to be close to accurate. - This allows to trade memory for accuracy. - type: number - rehash: - type: boolean - execution_hint: - $ref: '#/components/schemas/_common.aggregations:CardinalityExecutionMode' - _common.aggregations:CardinalityExecutionMode: + - $ref: '#/components/schemas/_common:VersionNumber' + - type: string + _common:SuggestMode: type: string enum: - - global_ordinals - - segment_ordinals - - direct - - save_memory_heuristic - - save_time_heuristic - _common.aggregations:CategorizeTextAggregation: - allOf: - - $ref: '#/components/schemas/_common.aggregations:Aggregation' - - type: object - properties: - 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. - 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 - max_matched_tokens: - description: |- - The maximum number of token positions to match on before attempting to merge categories. Larger - values will use more memory and create narrower categories. Max allowed value is 100. - type: number - similarity_threshold: - description: |- - The minimum percentage of tokens that must match for text to be added to the category bucket. Must - be between 1 and 100. The larger the value the narrower the categories. Larger values will increase memory - usage and create narrower categories. - type: number - categorization_filters: - description: |- - 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. - 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. - type: array - items: - type: string - categorization_analyzer: - $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 - size: - description: The number of buckets to return. - type: number - min_doc_count: - description: The minimum number of documents in a bucket to be returned to the results. - type: number - shard_min_doc_count: - description: The minimum number of documents in a bucket to be returned from the shard before merging. - type: number - required: - - field - _common.aggregations:CategorizeTextAnalyzer: + - always + - missing + - popular + _common:TaskFailure: + type: object + properties: + task_id: + type: number + node_id: + $ref: '#/components/schemas/_common:NodeId' + status: + type: string + reason: + $ref: '#/components/schemas/_common:ErrorCause' + required: + - node_id + - reason + - status + - task_id + _common:TaskId: oneOf: - type: string - - $ref: '#/components/schemas/_common.aggregations:CustomCategorizeTextAnalyzer' - _common.aggregations:ChiSquareHeuristic: + - type: number + _common:TextEmbedding: 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 - 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 + model_id: + type: string + model_text: + type: string required: - - background_is_superset - - include_negatives - _common.aggregations:ChildrenAggregate: - allOf: - - $ref: '#/components/schemas/_common.aggregations:SingleBucketAggregateBase' - - type: object - _common.aggregations:ChildrenAggregation: - allOf: - - $ref: '#/components/schemas/_common.aggregations:BucketAggregationBase' - - type: object - properties: - type: - $ref: '#/components/schemas/_common:RelationName' - _common.aggregations:ClassificationInferenceOptions: + - model_id + - model_text + _common:TimeOfDay: + description: Time of day, expressed as HH:MM:SS + type: string + _common:TimeUnit: + type: string + enum: + - d + - h + - m + - micros + - ms + - nanos + - s + _common:TimeZone: + type: string + _common:TopLeftBottomRightGeoBounds: type: object properties: - num_top_classes: - description: Specifies the number of top class predictions to return. Defaults to 0. + top_left: + $ref: '#/components/schemas/_common:GeoLocation' + bottom_right: + $ref: '#/components/schemas/_common:GeoLocation' + required: + - bottom_right + - top_left + _common:TopRightBottomLeftGeoBounds: + type: object + properties: + top_right: + $ref: '#/components/schemas/_common:GeoLocation' + bottom_left: + $ref: '#/components/schemas/_common:GeoLocation' + required: + - bottom_left + - top_right + _common:TranslogStats: + type: object + properties: + earliest_last_modified_age: type: number - num_top_feature_importance_values: - description: Specifies the maximum number of feature importance values per document. + operations: 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.' + remote_store: + $ref: '#/components/schemas/_common:RemoteStoreTranslogStats' + size: type: string - results_field: - description: The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + size_in_bytes: + type: number + uncommitted_operations: + type: number + uncommitted_size: type: string - top_classes_results_field: - description: Specifies the field to which the top classes are written. Defaults to top_classes. + uncommitted_size_in_bytes: + type: number + required: + - earliest_last_modified_age + - operations + - size_in_bytes + - uncommitted_operations + - uncommitted_size_in_bytes + _common:TransportAddress: + type: string + _common:uint: + type: number + _common:ulong: + type: number + _common:UnitMillis: + description: Time unit for milliseconds + type: number + _common:UnitNanos: + description: Time unit for nanoseconds + type: number + _common:UnitSeconds: + description: Time unit for seconds + type: number + _common:Username: + type: string + _common:Uuid: + type: string + _common:VersionNumber: + type: number + _common:VersionString: + type: string + _common:VersionType: + type: string + enum: + - external + - external_gte + - force + - internal + _common:Void: + description: |- + The absence of any type. This is commonly used in APIs that don't return a body. + + Although "void" is generally used for the unit type that has only one value, this is to be interpreted as + the bottom type that has no value at all. Most languages have a unit type, but few have a bottom type. + + See https://en.m.wikipedia.org/wiki/Unit_type and https://en.m.wikipedia.org/wiki/Bottom_type + type: object + _common:WaitForActiveShardOptions: + type: string + enum: + - all + - index-setting + _common:WaitForActiveShards: + oneOf: + - type: number + - $ref: '#/components/schemas/_common:WaitForActiveShardOptions' + _common:WaitForEvents: + type: string + enum: + - high + - immediate + - languid + - low + - normal + - urgent + _common:WarmerStats: + type: object + properties: + current: + type: number + total: + type: number + total_time: + $ref: '#/components/schemas/_common:Duration' + total_time_in_millis: + $ref: '#/components/schemas/_common:DurationValueUnitMillis' + required: + - current + - total + - total_time_in_millis + _common:WktGeoBounds: + type: object + properties: + wkt: type: string - _common.aggregations:CompositeAggregate: + required: + - wkt + _common:WriteResponseBase: + type: object + properties: + _id: + $ref: '#/components/schemas/_common:Id' + _index: + $ref: '#/components/schemas/_common:IndexName' + _primary_term: + type: number + result: + $ref: '#/components/schemas/_common:Result' + _seq_no: + $ref: '#/components/schemas/_common:SequenceNumber' + _shards: + $ref: '#/components/schemas/_common:ShardStatistics' + _version: + $ref: '#/components/schemas/_common:VersionNumber' + forced_refresh: + type: boolean + required: + - _id + - _index + - _primary_term + - _seq_no + - _shards + - _version + - result + _common.aggregations:AdjacencyMatrixAggregate: allOf: - - $ref: '#/components/schemas/_common.aggregations:MultiBucketAggregateBaseCompositeBucket' + - $ref: '#/components/schemas/_common.aggregations:MultiBucketAggregateBaseAdjacencyMatrixBucket' - type: object - properties: - after_key: - $ref: '#/components/schemas/_common.aggregations:CompositeAggregateKey' - _common.aggregations:CompositeAggregateKey: - type: object - additionalProperties: - $ref: '#/components/schemas/_common:FieldValue' - _common.aggregations:CompositeAggregation: + _common.aggregations:AdjacencyMatrixAggregation: allOf: - $ref: '#/components/schemas/_common.aggregations:BucketAggregationBase' - type: object properties: - after: - $ref: '#/components/schemas/_common.aggregations:CompositeAggregateKey' - size: - description: The number of composite buckets that should be returned. - type: number - sources: + filters: description: |- - The value sources used to build composite buckets. - Keys are returned in the order of the `sources` definition. - type: array - items: - type: object - additionalProperties: - $ref: '#/components/schemas/_common.aggregations:CompositeAggregationSource' - _common.aggregations:CompositeAggregationBase: + Filters used to create buckets. + At least one filter is required. + type: object + additionalProperties: + $ref: '#/components/schemas/_common.query_dsl:QueryContainer' + _common.aggregations:AdjacencyMatrixBucket: + allOf: + - $ref: '#/components/schemas/_common.aggregations:MultiBucketBase' + - type: object + properties: + key: + type: string + required: + - key + _common.aggregations:Aggregate: + oneOf: + - $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: - field: - $ref: '#/components/schemas/_common:Field' - missing_bucket: - type: boolean - missing_order: - $ref: '#/components/schemas/_common.aggregations:MissingOrder' - script: - $ref: '#/components/schemas/_common:Script' - value_type: - $ref: '#/components/schemas/_common.aggregations:ValueType' - order: - $ref: '#/components/schemas/_common:SortOrder' - _common.aggregations:CompositeAggregationSource: + meta: + $ref: '#/components/schemas/_common:Metadata' + _common.aggregations:AggregateOrder: + oneOf: + - type: object + additionalProperties: + $ref: '#/components/schemas/_common:SortOrder' + minProperties: 1 + maxProperties: 1 + - type: array + items: + type: object + additionalProperties: + $ref: '#/components/schemas/_common:SortOrder' + minProperties: 1 + maxProperties: 1 + _common.aggregations:Aggregation: type: object properties: - terms: - $ref: '#/components/schemas/_common.aggregations:CompositeTermsAggregation' - histogram: - $ref: '#/components/schemas/_common.aggregations:CompositeHistogramAggregation' - date_histogram: - $ref: '#/components/schemas/_common.aggregations:CompositeDateHistogramAggregation' - geotile_grid: - $ref: '#/components/schemas/_common.aggregations:CompositeGeoTileGridAggregation' - _common.aggregations:CompositeBucket: + meta: + $ref: '#/components/schemas/_common:Metadata' + name: + type: string + _common.aggregations:AggregationContainer: allOf: - - $ref: '#/components/schemas/_common.aggregations:MultiBucketBase' - type: object properties: - key: - $ref: '#/components/schemas/_common.aggregations:CompositeAggregateKey' - required: - - key - _common.aggregations:CompositeDateHistogramAggregation: - allOf: - - $ref: '#/components/schemas/_common.aggregations:CompositeAggregationBase' + aggregations: + description: |- + Sub-aggregations for this aggregation. + Only applies to bucket aggregations. + type: object + additionalProperties: + $ref: '#/components/schemas/_common.aggregations:AggregationContainer' + meta: + $ref: '#/components/schemas/_common:Metadata' - type: object properties: - format: + adjacency_matrix: + $ref: '#/components/schemas/_common.aggregations:AdjacencyMatrixAggregation' + auto_date_histogram: + $ref: '#/components/schemas/_common.aggregations:AutoDateHistogramAggregation' + avg: + $ref: '#/components/schemas/_common.aggregations:AverageAggregation' + avg_bucket: + $ref: '#/components/schemas/_common.aggregations:AverageBucketAggregation' + boxplot: + $ref: '#/components/schemas/_common.aggregations:BoxplotAggregation' + bucket_script: + $ref: '#/components/schemas/_common.aggregations:BucketScriptAggregation' + bucket_selector: + $ref: '#/components/schemas/_common.aggregations:BucketSelectorAggregation' + bucket_sort: + $ref: '#/components/schemas/_common.aggregations:BucketSortAggregation' + bucket_count_ks_test: + $ref: '#/components/schemas/_common.aggregations:BucketKsAggregation' + bucket_correlation: + $ref: '#/components/schemas/_common.aggregations:BucketCorrelationAggregation' + cardinality: + $ref: '#/components/schemas/_common.aggregations:CardinalityAggregation' + categorize_text: + $ref: '#/components/schemas/_common.aggregations:CategorizeTextAggregation' + children: + $ref: '#/components/schemas/_common.aggregations:ChildrenAggregation' + composite: + $ref: '#/components/schemas/_common.aggregations:CompositeAggregation' + cumulative_cardinality: + $ref: '#/components/schemas/_common.aggregations:CumulativeCardinalityAggregation' + cumulative_sum: + $ref: '#/components/schemas/_common.aggregations:CumulativeSumAggregation' + date_histogram: + $ref: '#/components/schemas/_common.aggregations:DateHistogramAggregation' + date_range: + $ref: '#/components/schemas/_common.aggregations:DateRangeAggregation' + derivative: + $ref: '#/components/schemas/_common.aggregations:DerivativeAggregation' + diversified_sampler: + $ref: '#/components/schemas/_common.aggregations:DiversifiedSamplerAggregation' + extended_stats: + $ref: '#/components/schemas/_common.aggregations:ExtendedStatsAggregation' + extended_stats_bucket: + $ref: '#/components/schemas/_common.aggregations:ExtendedStatsBucketAggregation' + frequent_item_sets: + $ref: '#/components/schemas/_common.aggregations:FrequentItemSetsAggregation' + filter: + $ref: '#/components/schemas/_common.query_dsl:QueryContainer' + filters: + $ref: '#/components/schemas/_common.aggregations:FiltersAggregation' + geo_bounds: + $ref: '#/components/schemas/_common.aggregations:GeoBoundsAggregation' + geo_centroid: + $ref: '#/components/schemas/_common.aggregations:GeoCentroidAggregation' + geo_distance: + $ref: '#/components/schemas/_common.aggregations:GeoDistanceAggregation' + geohash_grid: + $ref: '#/components/schemas/_common.aggregations:GeoHashGridAggregation' + geo_line: + $ref: '#/components/schemas/_common.aggregations:GeoLineAggregation' + geotile_grid: + $ref: '#/components/schemas/_common.aggregations:GeoTileGridAggregation' + geohex_grid: + $ref: '#/components/schemas/_common.aggregations:GeohexGridAggregation' + global: + $ref: '#/components/schemas/_common.aggregations:GlobalAggregation' + histogram: + $ref: '#/components/schemas/_common.aggregations:HistogramAggregation' + ip_range: + $ref: '#/components/schemas/_common.aggregations:IpRangeAggregation' + ip_prefix: + $ref: '#/components/schemas/_common.aggregations:IpPrefixAggregation' + inference: + $ref: '#/components/schemas/_common.aggregations:InferenceAggregation' + line: + $ref: '#/components/schemas/_common.aggregations:GeoLineAggregation' + matrix_stats: + $ref: '#/components/schemas/_common.aggregations:MatrixStatsAggregation' + max: + $ref: '#/components/schemas/_common.aggregations:MaxAggregation' + max_bucket: + $ref: '#/components/schemas/_common.aggregations:MaxBucketAggregation' + median_absolute_deviation: + $ref: '#/components/schemas/_common.aggregations:MedianAbsoluteDeviationAggregation' + min: + $ref: '#/components/schemas/_common.aggregations:MinAggregation' + min_bucket: + $ref: '#/components/schemas/_common.aggregations:MinBucketAggregation' + missing: + $ref: '#/components/schemas/_common.aggregations:MissingAggregation' + moving_avg: + $ref: '#/components/schemas/_common.aggregations:MovingAverageAggregation' + moving_percentiles: + $ref: '#/components/schemas/_common.aggregations:MovingPercentilesAggregation' + moving_fn: + $ref: '#/components/schemas/_common.aggregations:MovingFunctionAggregation' + multi_terms: + $ref: '#/components/schemas/_common.aggregations:MultiTermsAggregation' + nested: + $ref: '#/components/schemas/_common.aggregations:NestedAggregation' + normalize: + $ref: '#/components/schemas/_common.aggregations:NormalizeAggregation' + parent: + $ref: '#/components/schemas/_common.aggregations:ParentAggregation' + percentile_ranks: + $ref: '#/components/schemas/_common.aggregations:PercentileRanksAggregation' + percentiles: + $ref: '#/components/schemas/_common.aggregations:PercentilesAggregation' + percentiles_bucket: + $ref: '#/components/schemas/_common.aggregations:PercentilesBucketAggregation' + range: + $ref: '#/components/schemas/_common.aggregations:RangeAggregation' + rare_terms: + $ref: '#/components/schemas/_common.aggregations:RareTermsAggregation' + rate: + $ref: '#/components/schemas/_common.aggregations:RateAggregation' + reverse_nested: + $ref: '#/components/schemas/_common.aggregations:ReverseNestedAggregation' + sampler: + $ref: '#/components/schemas/_common.aggregations:SamplerAggregation' + scripted_metric: + $ref: '#/components/schemas/_common.aggregations:ScriptedMetricAggregation' + serial_diff: + $ref: '#/components/schemas/_common.aggregations:SerialDifferencingAggregation' + significant_terms: + $ref: '#/components/schemas/_common.aggregations:SignificantTermsAggregation' + significant_text: + $ref: '#/components/schemas/_common.aggregations:SignificantTextAggregation' + stats: + $ref: '#/components/schemas/_common.aggregations:StatsAggregation' + stats_bucket: + $ref: '#/components/schemas/_common.aggregations:StatsBucketAggregation' + string_stats: + $ref: '#/components/schemas/_common.aggregations:StringStatsAggregation' + sum: + $ref: '#/components/schemas/_common.aggregations:SumAggregation' + sum_bucket: + $ref: '#/components/schemas/_common.aggregations:SumBucketAggregation' + terms: + $ref: '#/components/schemas/_common.aggregations:TermsAggregation' + top_hits: + $ref: '#/components/schemas/_common.aggregations:TopHitsAggregation' + t_test: + $ref: '#/components/schemas/_common.aggregations:TTestAggregation' + top_metrics: + $ref: '#/components/schemas/_common.aggregations:TopMetricsAggregation' + value_count: + $ref: '#/components/schemas/_common.aggregations:ValueCountAggregation' + weighted_avg: + $ref: '#/components/schemas/_common.aggregations:WeightedAverageAggregation' + variable_width_histogram: + $ref: '#/components/schemas/_common.aggregations:VariableWidthHistogramAggregation' + minProperties: 1 + maxProperties: 1 + _common.aggregations:AggregationRange: + type: object + properties: + from: + description: Start of the range (inclusive). + oneOf: + - type: number + - type: string + - nullable: true type: string - calendar_interval: - $ref: '#/components/schemas/_common:DurationLarge' - fixed_interval: - $ref: '#/components/schemas/_common:DurationLarge' - offset: - $ref: '#/components/schemas/_common:Duration' - time_zone: - $ref: '#/components/schemas/_common:TimeZone' - _common.aggregations:CompositeGeoTileGridAggregation: - allOf: - - $ref: '#/components/schemas/_common.aggregations:CompositeAggregationBase' - - type: object - properties: - precision: - type: number - bounds: - $ref: '#/components/schemas/_common:GeoBounds' - _common.aggregations:CompositeHistogramAggregation: - allOf: - - $ref: '#/components/schemas/_common.aggregations:CompositeAggregationBase' - - type: object - properties: - interval: - type: number - required: - - interval - _common.aggregations:CompositeTermsAggregation: - allOf: - - $ref: '#/components/schemas/_common.aggregations:CompositeAggregationBase' - - type: object - _common.aggregations:CumulativeCardinalityAggregate: - allOf: - - $ref: '#/components/schemas/_common.aggregations:AggregateBase' - - type: object - properties: - value: - type: number - value_as_string: + key: + description: Custom key to return the range with. + type: string + to: + description: End of the range (exclusive). + oneOf: + - type: number + - type: string + - nullable: true type: string - required: - - value - _common.aggregations:CumulativeCardinalityAggregation: - allOf: - - $ref: '#/components/schemas/_common.aggregations:PipelineAggregationBase' - - type: object - _common.aggregations:CumulativeSumAggregation: - allOf: - - $ref: '#/components/schemas/_common.aggregations:PipelineAggregationBase' - - type: object - _common.aggregations:CustomCategorizeTextAnalyzer: + _common.aggregations:ArrayPercentilesItem: type: object properties: - char_filter: - type: array - items: - type: string - tokenizer: + key: type: string - filter: - type: array - items: - type: string - _common.aggregations:DateHistogramAggregate: + value: + oneOf: + - type: number + - nullable: true + type: string + value_as_string: + type: string + required: + - key + - value + _common.aggregations:AutoDateHistogramAggregate: allOf: - $ref: '#/components/schemas/_common.aggregations:MultiBucketAggregateBaseDateHistogramBucket' - type: object - _common.aggregations:DateHistogramAggregation: + properties: + interval: + $ref: '#/components/schemas/_common:DurationLarge' + required: + - interval + _common.aggregations:AutoDateHistogramAggregation: allOf: - $ref: '#/components/schemas/_common.aggregations:BucketAggregationBase' - type: object properties: - calendar_interval: - $ref: '#/components/schemas/_common.aggregations:CalendarInterval' - extended_bounds: - $ref: '#/components/schemas/_common.aggregations:ExtendedBoundsFieldDateMath' - hard_bounds: - $ref: '#/components/schemas/_common.aggregations:ExtendedBoundsFieldDateMath' + buckets: + description: The target number of buckets. + type: number field: $ref: '#/components/schemas/_common:Field' - fixed_interval: - $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' - 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 + minimum_interval: + $ref: '#/components/schemas/_common.aggregations:MinimumInterval' missing: $ref: '#/components/schemas/_common:DateTime' offset: - $ref: '#/components/schemas/_common:Duration' - order: - $ref: '#/components/schemas/_common.aggregations:AggregateOrder' + description: Time zone specified as a ISO 8601 UTC offset. + type: string params: type: object additionalProperties: @@ -21292,884 +28394,869 @@ components: $ref: '#/components/schemas/_common:Script' time_zone: $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: - allOf: - - $ref: '#/components/schemas/_common.aggregations:MultiBucketBase' - - type: object - properties: - key_as_string: - type: string - key: - $ref: '#/components/schemas/_common:EpochTimeUnitMillis' - required: - - key - _common.aggregations:DateRangeAggregate: + _common.aggregations:AverageAggregation: allOf: - - $ref: '#/components/schemas/_common.aggregations:RangeAggregate' + - $ref: '#/components/schemas/_common.aggregations:FormatMetricAggregationBase' - type: object - _common.aggregations:DateRangeAggregation: + _common.aggregations:AverageBucketAggregation: allOf: - - $ref: '#/components/schemas/_common.aggregations:BucketAggregationBase' + - $ref: '#/components/schemas/_common.aggregations:PipelineAggregationBase' - type: object - properties: - 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' - ranges: - description: Array of date ranges. - type: array - items: - $ref: '#/components/schemas/_common.aggregations:DateRangeExpression' - time_zone: - $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: - type: object - properties: - from: - $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: + _common.aggregations:AvgAggregate: allOf: - $ref: '#/components/schemas/_common.aggregations:SingleMetricAggregateBase' - type: object - properties: - normalized_value: - type: number - normalized_value_as_string: - type: string - _common.aggregations:DerivativeAggregation: - allOf: - - $ref: '#/components/schemas/_common.aggregations:PipelineAggregationBase' - - type: object - _common.aggregations:DiversifiedSamplerAggregation: + _common.aggregations:BoxPlotAggregate: allOf: - - $ref: '#/components/schemas/_common.aggregations:BucketAggregationBase' + - $ref: '#/components/schemas/_common.aggregations:AggregateBase' - type: object properties: - execution_hint: - $ref: '#/components/schemas/_common.aggregations:SamplerAggregationExecutionHint' - max_docs_per_value: - description: Limits how many documents are permitted per choice of de-duplicating value. + min: type: number - script: - $ref: '#/components/schemas/_common:Script' - shard_size: - description: Limits how many top-scoring documents are collected in the sample processed on each shard. + max: type: number - field: - $ref: '#/components/schemas/_common:Field' - _common.aggregations:DoubleTermsAggregate: - allOf: - - $ref: '#/components/schemas/_common.aggregations:TermsAggregateBaseDoubleTermsBucket' - - type: object - _common.aggregations:DoubleTermsBucket: - allOf: - - $ref: '#/components/schemas/_common.aggregations:TermsBucketBase' - - type: object - properties: - key: + q1: type: number - key_as_string: + q2: + type: number + q3: + type: number + lower: + type: number + upper: + type: number + min_as_string: type: string - required: - - key - _common.aggregations:EwmaModelSettings: - type: object - properties: - alpha: - type: number - _common.aggregations:EwmaMovingAverageAggregation: - allOf: - - $ref: '#/components/schemas/_common.aggregations:MovingAverageAggregationBase' - - type: object - properties: - model: + max_as_string: type: string - enum: - - ewma - settings: - $ref: '#/components/schemas/_common.aggregations:EwmaModelSettings' - required: - - model - - settings - _common.aggregations:ExtendedBoundsFieldDateMath: - type: object - properties: - max: - $ref: '#/components/schemas/_common.aggregations:FieldDateMath' - min: - $ref: '#/components/schemas/_common.aggregations:FieldDateMath' - required: - - max - - min - _common.aggregations:ExtendedBoundsdouble: - type: object - properties: - max: - description: Maximum value for the bound. - type: number - min: - description: Minimum value for the bound. - type: number - required: - - max - - min - _common.aggregations:ExtendedStatsAggregate: - allOf: - - $ref: '#/components/schemas/_common.aggregations:StatsAggregate' - - type: object - properties: - sum_of_squares: - oneOf: - - type: number - - nullable: true - type: string - variance: - oneOf: - - type: number - - nullable: true - type: string - variance_population: - oneOf: - - type: number - - nullable: true - type: string - variance_sampling: - oneOf: - - type: number - - nullable: true - type: string - std_deviation: - oneOf: - - type: number - - nullable: true - type: string - std_deviation_population: - oneOf: - - type: number - - nullable: true - type: string - std_deviation_sampling: - oneOf: - - type: number - - nullable: true - type: string - std_deviation_bounds: - $ref: '#/components/schemas/_common.aggregations:StandardDeviationBounds' - sum_of_squares_as_string: + q1_as_string: type: string - variance_as_string: + q2_as_string: type: string - variance_population_as_string: + q3_as_string: type: string - variance_sampling_as_string: + lower_as_string: type: string - std_deviation_as_string: + upper_as_string: type: string - std_deviation_bounds_as_string: - $ref: '#/components/schemas/_common.aggregations:StandardDeviationBoundsAsString' required: - - sum_of_squares - - variance - - variance_population - - variance_sampling - - std_deviation - - std_deviation_population - - std_deviation_sampling - _common.aggregations:ExtendedStatsAggregation: + - lower + - max + - min + - q1 + - q2 + - q3 + - upper + _common.aggregations:BoxplotAggregation: allOf: - - $ref: '#/components/schemas/_common.aggregations:FormatMetricAggregationBase' + - $ref: '#/components/schemas/_common.aggregations:MetricAggregationBase' - type: object properties: - sigma: - description: The number of standard deviations above/below the mean to display. + 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:ExtendedStatsBucketAggregate: + _common.aggregations:BucketAggregationBase: allOf: - - $ref: '#/components/schemas/_common.aggregations:ExtendedStatsAggregate' + - $ref: '#/components/schemas/_common.aggregations:Aggregation' - type: object - _common.aggregations:ExtendedStatsBucketAggregation: + _common.aggregations:BucketCorrelationAggregation: allOf: - - $ref: '#/components/schemas/_common.aggregations:PipelineAggregationBase' + - $ref: '#/components/schemas/_common.aggregations:BucketPathAggregation' - type: object properties: - sigma: - description: The number of standard deviations above/below the mean to display. - type: number - _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' - - type: number - _common.aggregations:FilterAggregate: + function: + $ref: '#/components/schemas/_common.aggregations:BucketCorrelationFunction' + required: + - function + _common.aggregations:BucketCorrelationFunction: + type: object + properties: + count_correlation: + $ref: '#/components/schemas/_common.aggregations:BucketCorrelationFunctionCountCorrelation' + required: + - count_correlation + _common.aggregations:BucketCorrelationFunctionCountCorrelation: + type: object + properties: + indicator: + $ref: '#/components/schemas/_common.aggregations:BucketCorrelationFunctionCountCorrelationIndicator' + required: + - indicator + _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 + to which the term values are correlated. + type: number + expectations: + description: |- + An array of numbers with which to correlate the configured `bucket_path` values. + The length of this value must always equal the number of buckets returned by the `bucket_path`. + type: array + items: + type: number + 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, + must equal expectations. + type: array + items: + type: number + required: + - doc_count + - expectations + _common.aggregations:BucketKsAggregation: allOf: - - $ref: '#/components/schemas/_common.aggregations:SingleBucketAggregateBase' + - $ref: '#/components/schemas/_common.aggregations:BucketPathAggregation' - type: object - _common.aggregations:FiltersAggregate: + properties: + alternative: + description: |- + A list of string values indicating which K-S test alternative to calculate. The valid values + are: "greater", "less", "two_sided". This parameter is key for determining the K-S statistic used + when calculating the K-S test. Default value is all possible alternative hypotheses. + type: array + items: + type: string + fractions: + description: |- + A list of doubles indicating the distribution of the samples with which to compare to the `buckets_path` results. + In typical usage this is the overall proportion of documents in each bucket, which is compared with the actual + document proportions in each bucket from the sibling aggregation counts. The default is to assume that overall + documents are uniformly distributed on these buckets, which they would be if one used equal percentiles of a + metric to define the bucket end points. + type: array + items: + type: number + sampling_method: + description: |- + Indicates the sampling methodology when calculating the K-S test. Note, this is sampling of the returned values. + This determines the cumulative distribution function (CDF) points used comparing the two samples. Default is + `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: allOf: - - $ref: '#/components/schemas/_common.aggregations:MultiBucketAggregateBaseFiltersBucket' + - $ref: '#/components/schemas/_common.aggregations:SingleMetricAggregateBase' - type: object - _common.aggregations:FiltersAggregation: + properties: + keys: + type: array + items: + type: string + required: + - keys + _common.aggregations:BucketPathAggregation: allOf: - - $ref: '#/components/schemas/_common.aggregations:BucketAggregationBase' + - $ref: '#/components/schemas/_common.aggregations:Aggregation' - type: object properties: - filters: - $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 - other_bucket_key: - description: The key with which the other bucket is returned. - type: string - keyed: - description: |- - 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: - allOf: - - $ref: '#/components/schemas/_common.aggregations:MultiBucketBase' + buckets_path: + $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 - _common.aggregations:FormatMetricAggregationBase: + additionalProperties: + $ref: '#/components/schemas/_common.aggregations:AdjacencyMatrixBucket' + - type: array + items: + $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' + - type: array + items: + $ref: '#/components/schemas/_common.aggregations:CompositeBucket' + _common.aggregations:BucketScriptAggregation: allOf: - - $ref: '#/components/schemas/_common.aggregations:MetricAggregationBase' + - $ref: '#/components/schemas/_common.aggregations:PipelineAggregationBase' - type: object properties: - format: - type: string - _common.aggregations:FormattableMetricAggregation: + script: + $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' + - type: array + items: + $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' + - type: array + items: + $ref: '#/components/schemas/_common.aggregations:DoubleTermsBucket' + _common.aggregations:BucketSelectorAggregation: allOf: - - $ref: '#/components/schemas/_common.aggregations:MetricAggregationBase' + - $ref: '#/components/schemas/_common.aggregations:PipelineAggregationBase' - type: object properties: - format: - type: string - _common.aggregations:FrequentItemSetsAggregate: - allOf: - - $ref: '#/components/schemas/_common.aggregations:MultiBucketAggregateBaseFrequentItemSetsBucket' + script: + $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 - _common.aggregations:FrequentItemSetsAggregation: - type: object - properties: - fields: - description: Fields to analyze. - type: array + additionalProperties: + $ref: '#/components/schemas/_common.aggregations:FiltersBucket' + - type: array items: - $ref: '#/components/schemas/_common.aggregations:FrequentItemSetsField' - minimum_set_size: - description: The minimum size of one item set. - type: number - minimum_support: - description: The minimum support of one item set. - type: number - size: - description: The number of top item sets to return. - type: number - filter: - $ref: '#/components/schemas/_common.query_dsl:QueryContainer' - required: - - fields - _common.aggregations:FrequentItemSetsBucket: + $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' + - type: array + items: + $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' + - type: array + items: + $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' + - type: array + items: + $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' + - type: array + items: + $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' + - type: array + items: + $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' + - type: array + items: + $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' + - type: array + items: + $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' + - type: array + items: + $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' + - type: array + items: + $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' + - type: array + items: + $ref: '#/components/schemas/_common.aggregations:MultiTermsBucket' + _common.aggregations:BucketSortAggregation: allOf: - - $ref: '#/components/schemas/_common.aggregations:MultiBucketBase' + - $ref: '#/components/schemas/_common.aggregations:Aggregation' - type: object properties: - key: - type: object - additionalProperties: - type: array - items: - type: string - support: + from: + description: Buckets in positions prior to `from` will be truncated. type: number - required: - - key - - support - _common.aggregations:FrequentItemSetsField: - type: object - properties: - field: - $ref: '#/components/schemas/_common:Field' - exclude: - $ref: '#/components/schemas/_common.aggregations:TermsExclude' - include: - $ref: '#/components/schemas/_common.aggregations:TermsInclude' - required: - - field - _common.aggregations:GapPolicy: - type: string - enum: - - skip - - insert_zeros - - keep_values - _common.aggregations:GeoBoundsAggregate: - allOf: - - $ref: '#/components/schemas/_common.aggregations:AggregateBase' + gap_policy: + $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: + 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 + path forms they accept. + oneOf: + - type: string + - type: array + items: + type: string - type: object - properties: - bounds: - $ref: '#/components/schemas/_common:GeoBounds' - _common.aggregations:GeoBoundsAggregation: - allOf: - - $ref: '#/components/schemas/_common.aggregations:MetricAggregationBase' + additionalProperties: + type: string + _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 - properties: - wrap_longitude: - description: Specifies whether the bounding box should be allowed to overlap the international date line. - type: boolean - _common.aggregations:GeoCentroidAggregate: + additionalProperties: + $ref: '#/components/schemas/_common.query_dsl:QueryContainer' + - type: array + items: + $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' + - type: array + items: + $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' + - type: array + items: + $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' + - type: array + items: + $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' + - type: array + items: + $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' + - type: array + items: + $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' + - type: array + items: + $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' + - type: array + items: + $ref: '#/components/schemas/_common:Void' + _common.aggregations:CalendarInterval: + type: string + enum: + - day + - hour + - minute + - month + - quarter + - second + - week + - year + _common.aggregations:CardinalityAggregate: allOf: - $ref: '#/components/schemas/_common.aggregations:AggregateBase' - type: object properties: - count: + value: type: number - location: - $ref: '#/components/schemas/_common:GeoLocation' required: - - count - _common.aggregations:GeoCentroidAggregation: + - value + _common.aggregations:CardinalityAggregation: allOf: - $ref: '#/components/schemas/_common.aggregations:MetricAggregationBase' - type: object properties: - count: + precision_threshold: + description: |- + A unique count below which counts are expected to be close to accurate. + This allows to trade memory for accuracy. type: number - location: - $ref: '#/components/schemas/_common:GeoLocation' - _common.aggregations:GeoDistanceAggregate: - allOf: - - $ref: '#/components/schemas/_common.aggregations:RangeAggregate' - - type: object - _common.aggregations:GeoDistanceAggregation: + rehash: + type: boolean + execution_hint: + $ref: '#/components/schemas/_common.aggregations:CardinalityExecutionMode' + _common.aggregations:CardinalityExecutionMode: + type: string + enum: + - direct + - global_ordinals + - save_memory_heuristic + - save_time_heuristic + - segment_ordinals + _common.aggregations:CategorizeTextAggregation: allOf: - - $ref: '#/components/schemas/_common.aggregations:BucketAggregationBase' + - $ref: '#/components/schemas/_common.aggregations:Aggregation' - type: object properties: - distance_type: - $ref: '#/components/schemas/_common:GeoDistanceType' field: $ref: '#/components/schemas/_common:Field' - origin: - $ref: '#/components/schemas/_common:GeoLocation' - ranges: - description: An array of ranges used to bucket documents. + max_unique_tokens: + description: |- + The maximum number of unique tokens at any position up to max_matched_tokens. 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 + max_matched_tokens: + description: |- + The maximum number of token positions to match on before attempting to merge categories. Larger + values will use more memory and create narrower categories. Max allowed value is 100. + type: number + similarity_threshold: + description: |- + The minimum percentage of tokens that must match for text to be added to the category bucket. Must + be between 1 and 100. The larger the value the narrower the categories. Larger values will increase memory + usage and create narrower categories. + type: number + categorization_filters: + description: |- + 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. + 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. type: array items: - $ref: '#/components/schemas/_common.aggregations:AggregationRange' - unit: - $ref: '#/components/schemas/_common:DistanceUnit' - _common.aggregations:GeoHashGridAggregate: - allOf: - - $ref: '#/components/schemas/_common.aggregations:MultiBucketAggregateBaseGeoHashGridBucket' - - type: object - _common.aggregations:GeoHashGridAggregation: - allOf: - - $ref: '#/components/schemas/_common.aggregations:BucketAggregationBase' - - type: object - properties: - bounds: - $ref: '#/components/schemas/_common:GeoBounds' - field: - $ref: '#/components/schemas/_common:Field' - precision: - $ref: '#/components/schemas/_common:GeoHashPrecision' + type: string + categorization_analyzer: + $ref: '#/components/schemas/_common.aggregations:CategorizeTextAnalyzer' shard_size: - description: |- - Allows for more accurate counting of the top cells returned in the final result the aggregation. - Defaults to returning `max(10,(size x number-of-shards))` buckets from each shard. + description: The number of categorization buckets to return from each shard before merging all the results. type: number size: - description: The maximum number of geohash buckets to return. + description: The number of buckets to return. + type: number + min_doc_count: + description: The minimum number of documents in a bucket to be returned to the results. + type: number + shard_min_doc_count: + description: The minimum number of documents in a bucket to be returned from the shard before merging. type: number - _common.aggregations:GeoHashGridBucket: - allOf: - - $ref: '#/components/schemas/_common.aggregations:MultiBucketBase' - - type: object - properties: - key: - $ref: '#/components/schemas/_common:GeoHash' required: - - key - _common.aggregations:GeoHexGridAggregate: - allOf: - - $ref: '#/components/schemas/_common.aggregations:MultiBucketAggregateBaseGeoHexGridBucket' - - type: object - _common.aggregations:GeoHexGridBucket: + - field + _common.aggregations:CategorizeTextAnalyzer: + oneOf: + - type: string + - $ref: '#/components/schemas/_common.aggregations:CustomCategorizeTextAnalyzer' + _common.aggregations:ChildrenAggregate: allOf: - - $ref: '#/components/schemas/_common.aggregations:MultiBucketBase' + - $ref: '#/components/schemas/_common.aggregations:SingleBucketAggregateBase' - type: object - properties: - key: - $ref: '#/components/schemas/_common:GeoHexCell' - required: - - key - _common.aggregations:GeoLineAggregate: + _common.aggregations:ChildrenAggregation: allOf: - - $ref: '#/components/schemas/_common.aggregations:AggregateBase' + - $ref: '#/components/schemas/_common.aggregations:BucketAggregationBase' - type: object properties: type: - type: string - geometry: - $ref: '#/components/schemas/_common:GeoLine' - properties: - type: object - required: - - type - - geometry - - properties - _common.aggregations:GeoLineAggregation: + $ref: '#/components/schemas/_common:RelationName' + _common.aggregations:ChiSquareHeuristic: type: object properties: - point: - $ref: '#/components/schemas/_common.aggregations:GeoLinePoint' - sort: - $ref: '#/components/schemas/_common.aggregations:GeoLineSort' - include_sort: - description: When `true`, returns an additional array of the sort values in the feature 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 + 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 - sort_order: - $ref: '#/components/schemas/_common:SortOrder' - size: - description: |- - The maximum length of the line represented in the aggregation. - Valid sizes are between 1 and 10000. - type: number - required: - - point - - sort - _common.aggregations:GeoLinePoint: - type: object - properties: - field: - $ref: '#/components/schemas/_common:Field' required: - - field - _common.aggregations:GeoLineSort: + - background_is_superset + - include_negatives + _common.aggregations:ClassificationInferenceOptions: type: object properties: - field: - $ref: '#/components/schemas/_common:Field' - required: - - field - _common.aggregations:GeoTileGridAggregate: - allOf: - - $ref: '#/components/schemas/_common.aggregations:MultiBucketAggregateBaseGeoTileGridBucket' - - type: object - _common.aggregations:GeoTileGridAggregation: - allOf: - - $ref: '#/components/schemas/_common.aggregations:BucketAggregationBase' - - type: object - properties: - field: - $ref: '#/components/schemas/_common:Field' - precision: - $ref: '#/components/schemas/_common:GeoTilePrecision' - shard_size: - description: |- - Allows for more accurate counting of the top cells returned in the final result the aggregation. - Defaults to returning `max(10,(size x number-of-shards))` buckets from each shard. - type: number - size: - description: The maximum number of buckets to return. - type: number - bounds: - $ref: '#/components/schemas/_common:GeoBounds' - _common.aggregations:GeoTileGridBucket: + num_top_classes: + description: Specifies the number of top class predictions to return. Defaults to 0. + type: number + num_top_feature_importance_values: + 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.' + type: string + results_field: + 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. + type: string + _common.aggregations:CompositeAggregate: allOf: - - $ref: '#/components/schemas/_common.aggregations:MultiBucketBase' + - $ref: '#/components/schemas/_common.aggregations:MultiBucketAggregateBaseCompositeBucket' - type: object properties: - key: - $ref: '#/components/schemas/_common:GeoTile' - required: - - key - _common.aggregations:GeohexGridAggregation: + after_key: + $ref: '#/components/schemas/_common.aggregations:CompositeAggregateKey' + _common.aggregations:CompositeAggregateKey: + type: object + additionalProperties: + $ref: '#/components/schemas/_common:FieldValue' + _common.aggregations:CompositeAggregation: allOf: - $ref: '#/components/schemas/_common.aggregations:BucketAggregationBase' - type: object properties: - 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. - type: number - bounds: - $ref: '#/components/schemas/_common:GeoBounds' + after: + $ref: '#/components/schemas/_common.aggregations:CompositeAggregateKey' size: - description: Maximum number of buckets to return. - type: number - shard_size: - description: Number of buckets returned from each shard. + description: The number of composite buckets that should be returned. type: number - required: - - field - _common.aggregations:GlobalAggregate: - allOf: - - $ref: '#/components/schemas/_common.aggregations:SingleBucketAggregateBase' - - type: object - _common.aggregations:GlobalAggregation: - allOf: - - $ref: '#/components/schemas/_common.aggregations:BucketAggregationBase' - - type: object - _common.aggregations:GoogleNormalizedDistanceHeuristic: + sources: + description: |- + The value sources used to build composite buckets. + Keys are returned in the order of the `sources` definition. + type: array + items: + type: object + additionalProperties: + $ref: '#/components/schemas/_common.aggregations:CompositeAggregationSource' + _common.aggregations:CompositeAggregationBase: 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. + field: + $ref: '#/components/schemas/_common:Field' + missing_bucket: type: boolean - _common.aggregations:HdrMethod: + missing_order: + $ref: '#/components/schemas/_common.aggregations:MissingOrder' + script: + $ref: '#/components/schemas/_common:Script' + value_type: + $ref: '#/components/schemas/_common.aggregations:ValueType' + order: + $ref: '#/components/schemas/_common:SortOrder' + _common.aggregations:CompositeAggregationSource: 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: - allOf: - - $ref: '#/components/schemas/_common.aggregations:PercentilesAggregateBase' - - type: object - _common.aggregations:HdrPercentilesAggregate: - allOf: - - $ref: '#/components/schemas/_common.aggregations:PercentilesAggregateBase' - - type: object - _common.aggregations:HistogramAggregate: + terms: + $ref: '#/components/schemas/_common.aggregations:CompositeTermsAggregation' + histogram: + $ref: '#/components/schemas/_common.aggregations:CompositeHistogramAggregation' + date_histogram: + $ref: '#/components/schemas/_common.aggregations:CompositeDateHistogramAggregation' + geotile_grid: + $ref: '#/components/schemas/_common.aggregations:CompositeGeoTileGridAggregation' + _common.aggregations:CompositeBucket: allOf: - - $ref: '#/components/schemas/_common.aggregations:MultiBucketAggregateBaseHistogramBucket' + - $ref: '#/components/schemas/_common.aggregations:MultiBucketBase' - type: object - _common.aggregations:HistogramAggregation: + properties: + key: + $ref: '#/components/schemas/_common.aggregations:CompositeAggregateKey' + required: + - key + _common.aggregations:CompositeDateHistogramAggregation: allOf: - - $ref: '#/components/schemas/_common.aggregations:BucketAggregationBase' + - $ref: '#/components/schemas/_common.aggregations:CompositeAggregationBase' - type: object properties: - extended_bounds: - $ref: '#/components/schemas/_common.aggregations:ExtendedBoundsdouble' - hard_bounds: - $ref: '#/components/schemas/_common.aggregations:ExtendedBoundsdouble' - field: - $ref: '#/components/schemas/_common:Field' - interval: - description: |- - The interval for the buckets. - Must be a positive decimal. - type: number - min_doc_count: - description: |- - Only returns buckets that have `min_doc_count` number of documents. - By default, the response will fill gaps in the histogram with empty buckets. - type: number - missing: - description: |- - The value to apply to documents that do not have a value. - By default, documents without a value are ignored. - type: number - offset: - description: |- - By default, the bucket keys start with 0 and then continue in even spaced steps of `interval`. - The bucket boundaries can be shifted by using the `offset` option. - type: number - order: - $ref: '#/components/schemas/_common.aggregations:AggregateOrder' - 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: + calendar_interval: + $ref: '#/components/schemas/_common:DurationLarge' + fixed_interval: + $ref: '#/components/schemas/_common:DurationLarge' + offset: + $ref: '#/components/schemas/_common:Duration' + time_zone: + $ref: '#/components/schemas/_common:TimeZone' + _common.aggregations:CompositeGeoTileGridAggregation: allOf: - - $ref: '#/components/schemas/_common.aggregations:MultiBucketBase' + - $ref: '#/components/schemas/_common.aggregations:CompositeAggregationBase' - type: object properties: - key_as_string: - type: string - key: + precision: type: number - required: - - key - _common.aggregations:HoltLinearModelSettings: - type: object - properties: - alpha: - type: number - beta: - type: number - _common.aggregations:HoltMovingAverageAggregation: + bounds: + $ref: '#/components/schemas/_common:GeoBounds' + _common.aggregations:CompositeHistogramAggregation: allOf: - - $ref: '#/components/schemas/_common.aggregations:MovingAverageAggregationBase' + - $ref: '#/components/schemas/_common.aggregations:CompositeAggregationBase' - type: object properties: - model: - type: string - enum: - - holt - settings: - $ref: '#/components/schemas/_common.aggregations:HoltLinearModelSettings' + interval: + type: number required: - - model - - settings - _common.aggregations:HoltWintersModelSettings: - type: object - properties: - alpha: - type: number - beta: - type: number - gamma: - type: number - pad: - type: boolean - period: - type: number - type: - $ref: '#/components/schemas/_common.aggregations:HoltWintersType' - _common.aggregations:HoltWintersMovingAverageAggregation: + - interval + _common.aggregations:CompositeTermsAggregation: allOf: - - $ref: '#/components/schemas/_common.aggregations:MovingAverageAggregationBase' + - $ref: '#/components/schemas/_common.aggregations:CompositeAggregationBase' - type: object - properties: - model: - type: string - enum: - - holt_winters - settings: - $ref: '#/components/schemas/_common.aggregations:HoltWintersModelSettings' - required: - - model - - settings - _common.aggregations:HoltWintersType: - type: string - enum: - - add - - mult - _common.aggregations:InferenceAggregate: + _common.aggregations:CumulativeCardinalityAggregate: allOf: - $ref: '#/components/schemas/_common.aggregations:AggregateBase' - type: object properties: value: - $ref: '#/components/schemas/_common:FieldValue' - feature_importance: - type: array - items: - $ref: '#/components/schemas/_common.aggregations:InferenceFeatureImportance' - top_classes: - type: array - items: - $ref: '#/components/schemas/_common.aggregations:InferenceTopClassEntry' - warning: + type: number + value_as_string: type: string - _common.aggregations:InferenceAggregation: + required: + - value + _common.aggregations:CumulativeCardinalityAggregation: allOf: - $ref: '#/components/schemas/_common.aggregations:PipelineAggregationBase' - type: object - properties: - model_id: - $ref: '#/components/schemas/_common:Name' - inference_config: - $ref: '#/components/schemas/_common.aggregations:InferenceConfigContainer' - required: - - model_id - _common.aggregations:InferenceClassImportance: - type: object - properties: - class_name: - type: string - importance: - type: number - required: - - class_name - - importance - _common.aggregations:InferenceConfigContainer: - type: object - properties: - regression: - $ref: '#/components/schemas/_common.aggregations:RegressionInferenceOptions' - classification: - $ref: '#/components/schemas/_common.aggregations:ClassificationInferenceOptions' - minProperties: 1 - maxProperties: 1 - _common.aggregations:InferenceFeatureImportance: + _common.aggregations:CumulativeSumAggregation: + allOf: + - $ref: '#/components/schemas/_common.aggregations:PipelineAggregationBase' + - type: object + _common.aggregations:CustomCategorizeTextAnalyzer: type: object properties: - feature_name: + char_filter: + type: array + items: + type: string + tokenizer: type: string - importance: - type: number - classes: + filter: type: array items: - $ref: '#/components/schemas/_common.aggregations:InferenceClassImportance' - required: - - feature_name - _common.aggregations:InferenceTopClassEntry: - type: object - properties: - class_name: - $ref: '#/components/schemas/_common:FieldValue' - class_probability: - type: number - class_score: - type: number - required: - - class_name - - class_probability - - class_score - _common.aggregations:IpPrefixAggregate: + type: string + _common.aggregations:DateHistogramAggregate: allOf: - - $ref: '#/components/schemas/_common.aggregations:MultiBucketAggregateBaseIpPrefixBucket' + - $ref: '#/components/schemas/_common.aggregations:MultiBucketAggregateBaseDateHistogramBucket' - type: object - _common.aggregations:IpPrefixAggregation: + _common.aggregations:DateHistogramAggregation: allOf: - $ref: '#/components/schemas/_common.aggregations:BucketAggregationBase' - type: object properties: + calendar_interval: + $ref: '#/components/schemas/_common.aggregations:CalendarInterval' + extended_bounds: + $ref: '#/components/schemas/_common.aggregations:ExtendedBoundsFieldDateMath' + hard_bounds: + $ref: '#/components/schemas/_common.aggregations:ExtendedBoundsFieldDateMath' field: $ref: '#/components/schemas/_common:Field' - prefix_length: + fixed_interval: + $ref: '#/components/schemas/_common:Duration' + format: description: |- - Length of the network prefix. For IPv4 addresses the accepted range is [0, 32]. - For IPv6 addresses the accepted range is [0, 128]. + 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' + 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 - is_ipv6: - description: Defines whether the prefix applies to IPv6 addresses. - type: boolean - append_prefix_length: - description: Defines whether the prefix length is appended to IP address keys in the response. - type: boolean + missing: + $ref: '#/components/schemas/_common:DateTime' + offset: + $ref: '#/components/schemas/_common:Duration' + order: + $ref: '#/components/schemas/_common.aggregations:AggregateOrder' + params: + type: object + additionalProperties: + type: object + script: + $ref: '#/components/schemas/_common:Script' + time_zone: + $ref: '#/components/schemas/_common:TimeZone' keyed: - description: Defines whether buckets are returned as a hash rather than an array in the response. + 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 - min_doc_count: - description: Minimum number of documents in a bucket for it to be included in the response. - type: number - required: - - field - - prefix_length - _common.aggregations:IpPrefixBucket: + _common.aggregations:DateHistogramBucket: allOf: - $ref: '#/components/schemas/_common.aggregations:MultiBucketBase' - type: object properties: - is_ipv6: - type: boolean - key: - type: string - prefix_length: - type: number - netmask: + key_as_string: type: string + key: + $ref: '#/components/schemas/_common:EpochTimeUnitMillis' required: - - is_ipv6 - key - - prefix_length - _common.aggregations:IpRangeAggregate: + _common.aggregations:DateRangeAggregate: allOf: - - $ref: '#/components/schemas/_common.aggregations:MultiBucketAggregateBaseIpRangeBucket' + - $ref: '#/components/schemas/_common.aggregations:RangeAggregate' - type: object - _common.aggregations:IpRangeAggregation: + _common.aggregations:DateRangeAggregation: allOf: - $ref: '#/components/schemas/_common.aggregations:BucketAggregationBase' - type: object properties: 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' ranges: - description: Array of IP ranges. + description: Array of date ranges. type: array items: - $ref: '#/components/schemas/_common.aggregations:IpRangeAggregationRange' - _common.aggregations:IpRangeAggregationRange: + $ref: '#/components/schemas/_common.aggregations:DateRangeExpression' + time_zone: + $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: type: object properties: from: - description: Start of the range. - oneOf: - - type: string - - nullable: true - type: string - mask: - description: IP range defined as a CIDR mask. + $ref: '#/components/schemas/_common.aggregations:FieldDateMath' + key: + description: Custom key to return the range with. type: string to: - description: End of the range. - oneOf: - - type: string - - nullable: true - type: string - _common.aggregations:IpRangeBucket: - allOf: - - $ref: '#/components/schemas/_common.aggregations:MultiBucketBase' - - type: object - properties: - key: - type: string - from: - type: string - to: - type: string - _common.aggregations:KeyedPercentiles: - type: object - additionalProperties: - oneOf: - - type: string - - type: number - - nullable: true - type: string - _common.aggregations:LinearMovingAverageAggregation: + $ref: '#/components/schemas/_common.aggregations:FieldDateMath' + _common.aggregations:DerivativeAggregate: allOf: - - $ref: '#/components/schemas/_common.aggregations:MovingAverageAggregationBase' + - $ref: '#/components/schemas/_common.aggregations:SingleMetricAggregateBase' - type: object properties: - model: + normalized_value: + type: number + normalized_value_as_string: type: string - enum: - - linear - settings: - $ref: '#/components/schemas/_common:EmptyObject' - required: - - model - - settings - _common.aggregations:LongRareTermsAggregate: + _common.aggregations:DerivativeAggregation: allOf: - - $ref: '#/components/schemas/_common.aggregations:MultiBucketAggregateBaseLongRareTermsBucket' + - $ref: '#/components/schemas/_common.aggregations:PipelineAggregationBase' - type: object - _common.aggregations:LongRareTermsBucket: + _common.aggregations:DiversifiedSamplerAggregation: allOf: - - $ref: '#/components/schemas/_common.aggregations:MultiBucketBase' + - $ref: '#/components/schemas/_common.aggregations:BucketAggregationBase' - type: object properties: - key: + execution_hint: + $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 - key_as_string: - type: string - required: - - key - _common.aggregations:LongTermsAggregate: + 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: allOf: - - $ref: '#/components/schemas/_common.aggregations:TermsAggregateBaseLongTermsBucket' + - $ref: '#/components/schemas/_common.aggregations:TermsAggregateBaseDoubleTermsBucket' - type: object - _common.aggregations:LongTermsBucket: + _common.aggregations:DoubleTermsBucket: allOf: - $ref: '#/components/schemas/_common.aggregations:TermsBucketBase' - type: object @@ -22180,2900 +29267,2393 @@ components: type: string required: - key - _common.aggregations:MatrixAggregation: - allOf: - - $ref: '#/components/schemas/_common.aggregations:Aggregation' - - type: object - properties: - fields: - $ref: '#/components/schemas/_common:Fields' - missing: - description: |- - The value to apply to documents that do not have a value. - By default, documents without a value are ignored. - type: object - additionalProperties: - type: number - _common.aggregations:MatrixStatsAggregate: + _common.aggregations:EwmaModelSettings: + type: object + properties: + alpha: + type: number + _common.aggregations:EwmaMovingAverageAggregation: allOf: - - $ref: '#/components/schemas/_common.aggregations:AggregateBase' + - $ref: '#/components/schemas/_common.aggregations:MovingAverageAggregationBase' - type: object properties: - doc_count: - type: number - fields: - type: array - items: - $ref: '#/components/schemas/_common.aggregations:MatrixStatsFields' + model: + type: string + enum: + - ewma + settings: + $ref: '#/components/schemas/_common.aggregations:EwmaModelSettings' required: - - doc_count - _common.aggregations:MatrixStatsAggregation: - allOf: - - $ref: '#/components/schemas/_common.aggregations:MatrixAggregation' - - type: object - properties: - mode: - $ref: '#/components/schemas/_common:SortMode' - _common.aggregations:MatrixStatsFields: + - model + - settings + _common.aggregations:ExtendedBoundsdouble: type: object properties: - name: - $ref: '#/components/schemas/_common:Field' - count: - type: number - mean: - type: number - variance: - type: number - skewness: + max: + description: Maximum value for the bound. type: number - kurtosis: + min: + description: Minimum value for the bound. type: number - covariance: - type: object - additionalProperties: - type: number - correlation: - type: object - additionalProperties: - type: number required: - - name - - count - - mean - - variance - - skewness - - kurtosis - - covariance - - correlation - _common.aggregations:MaxAggregate: - allOf: - - $ref: '#/components/schemas/_common.aggregations:SingleMetricAggregateBase' - - type: object - _common.aggregations:MaxAggregation: - allOf: - - $ref: '#/components/schemas/_common.aggregations:FormatMetricAggregationBase' - - type: object - _common.aggregations:MaxBucketAggregation: - allOf: - - $ref: '#/components/schemas/_common.aggregations:PipelineAggregationBase' - - type: object - _common.aggregations:MedianAbsoluteDeviationAggregate: + - max + - min + _common.aggregations:ExtendedBoundsFieldDateMath: + type: object + properties: + max: + $ref: '#/components/schemas/_common.aggregations:FieldDateMath' + min: + $ref: '#/components/schemas/_common.aggregations:FieldDateMath' + required: + - max + - min + _common.aggregations:ExtendedStatsAggregate: allOf: - - $ref: '#/components/schemas/_common.aggregations:SingleMetricAggregateBase' + - $ref: '#/components/schemas/_common.aggregations:StatsAggregate' - type: object - _common.aggregations:MedianAbsoluteDeviationAggregation: + properties: + sum_of_squares: + oneOf: + - type: number + - nullable: true + type: string + variance: + oneOf: + - type: number + - nullable: true + type: string + variance_population: + oneOf: + - type: number + - nullable: true + type: string + variance_sampling: + oneOf: + - type: number + - nullable: true + type: string + std_deviation: + oneOf: + - type: number + - nullable: true + type: string + std_deviation_population: + oneOf: + - type: number + - nullable: true + type: string + std_deviation_sampling: + oneOf: + - type: number + - nullable: true + type: string + std_deviation_bounds: + $ref: '#/components/schemas/_common.aggregations:StandardDeviationBounds' + sum_of_squares_as_string: + type: string + variance_as_string: + type: string + variance_population_as_string: + type: string + variance_sampling_as_string: + type: string + std_deviation_as_string: + type: string + std_deviation_bounds_as_string: + $ref: '#/components/schemas/_common.aggregations:StandardDeviationBoundsAsString' + required: + - std_deviation + - std_deviation_population + - std_deviation_sampling + - sum_of_squares + - variance + - variance_population + - variance_sampling + _common.aggregations:ExtendedStatsAggregation: allOf: - $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. + sigma: + description: The number of standard deviations above/below the mean to display. type: number - _common.aggregations:MetricAggregationBase: - type: object - properties: - field: - $ref: '#/components/schemas/_common:Field' - missing: - $ref: '#/components/schemas/_common.aggregations:Missing' - script: - $ref: '#/components/schemas/_common:Script' - _common.aggregations:MinAggregate: - allOf: - - $ref: '#/components/schemas/_common.aggregations:SingleMetricAggregateBase' - - type: object - _common.aggregations:MinAggregation: + _common.aggregations:ExtendedStatsBucketAggregate: allOf: - - $ref: '#/components/schemas/_common.aggregations:FormatMetricAggregationBase' + - $ref: '#/components/schemas/_common.aggregations:ExtendedStatsAggregate' - type: object - _common.aggregations:MinBucketAggregation: + _common.aggregations:ExtendedStatsBucketAggregation: allOf: - $ref: '#/components/schemas/_common.aggregations:PipelineAggregationBase' - type: object - _common.aggregations:MinimumInterval: - type: string - enum: - - second - - minute - - hour - - day - - month - - year - _common.aggregations:Missing: + properties: + sigma: + description: The number of standard deviations above/below the mean to display. + type: number + _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: - - type: string - - type: number + - $ref: '#/components/schemas/_common:DateMath' - type: number - - type: boolean - _common.aggregations:MissingAggregate: + _common.aggregations:FilterAggregate: allOf: - $ref: '#/components/schemas/_common.aggregations:SingleBucketAggregateBase' - type: object - _common.aggregations:MissingAggregation: + _common.aggregations:FiltersAggregate: allOf: - - $ref: '#/components/schemas/_common.aggregations:BucketAggregationBase' + - $ref: '#/components/schemas/_common.aggregations:MultiBucketAggregateBaseFiltersBucket' - type: object - properties: - field: - $ref: '#/components/schemas/_common:Field' - missing: - $ref: '#/components/schemas/_common.aggregations:Missing' - _common.aggregations:MissingOrder: - type: string - enum: - - first - - last - - default - _common.aggregations:MovingAverageAggregation: - 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: + _common.aggregations:FiltersAggregation: allOf: - - $ref: '#/components/schemas/_common.aggregations:PipelineAggregationBase' + - $ref: '#/components/schemas/_common.aggregations:BucketAggregationBase' - type: object properties: - minimize: + filters: + $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 - predict: - type: number - window: - type: number - _common.aggregations:MovingFunctionAggregation: - allOf: - - $ref: '#/components/schemas/_common.aggregations:PipelineAggregationBase' - - type: object - properties: - script: - description: The script that should be executed on each window of data. + other_bucket_key: + description: The key with which the other bucket is returned. type: string - shift: - description: |- - By default, the window consists of the last n values excluding the current bucket. - Increasing `shift` by 1, moves the starting window position by 1 to the right. - type: number - window: - description: The size of window to "slide" across the histogram. - type: number - _common.aggregations:MovingPercentilesAggregation: - allOf: - - $ref: '#/components/schemas/_common.aggregations:PipelineAggregationBase' - - type: object - properties: - window: - description: The size of window to "slide" across the histogram. - type: number - shift: - description: |- - By default, the window consists of the last n values excluding the current bucket. - Increasing `shift` by 1, moves the starting window position by 1 to the right. - type: number keyed: + description: |- + 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:MultiBucketAggregateBaseAdjacencyMatrixBucket: + _common.aggregations:FiltersBucket: allOf: - - $ref: '#/components/schemas/_common.aggregations:AggregateBase' + - $ref: '#/components/schemas/_common.aggregations:MultiBucketBase' - type: object - properties: - buckets: - $ref: '#/components/schemas/_common.aggregations:BucketsAdjacencyMatrixBucket' - required: - - buckets - _common.aggregations:MultiBucketAggregateBaseCompositeBucket: + _common.aggregations:FormatMetricAggregationBase: allOf: - - $ref: '#/components/schemas/_common.aggregations:AggregateBase' + - $ref: '#/components/schemas/_common.aggregations:MetricAggregationBase' - type: object properties: - buckets: - $ref: '#/components/schemas/_common.aggregations:BucketsCompositeBucket' - required: - - buckets - _common.aggregations:MultiBucketAggregateBaseDateHistogramBucket: + format: + type: string + _common.aggregations:FormattableMetricAggregation: allOf: - - $ref: '#/components/schemas/_common.aggregations:AggregateBase' + - $ref: '#/components/schemas/_common.aggregations:MetricAggregationBase' - type: object properties: - buckets: - $ref: '#/components/schemas/_common.aggregations:BucketsDateHistogramBucket' - required: - - buckets - _common.aggregations:MultiBucketAggregateBaseDoubleTermsBucket: + format: + type: string + _common.aggregations:FrequentItemSetsAggregate: allOf: - - $ref: '#/components/schemas/_common.aggregations:AggregateBase' + - $ref: '#/components/schemas/_common.aggregations:MultiBucketAggregateBaseFrequentItemSetsBucket' - type: object - properties: - buckets: - $ref: '#/components/schemas/_common.aggregations:BucketsDoubleTermsBucket' - required: - - buckets - _common.aggregations:MultiBucketAggregateBaseFiltersBucket: + _common.aggregations:FrequentItemSetsAggregation: + type: object + properties: + fields: + description: Fields to analyze. + type: array + items: + $ref: '#/components/schemas/_common.aggregations:FrequentItemSetsField' + minimum_set_size: + description: The minimum size of one item set. + type: number + minimum_support: + description: The minimum support of one item set. + type: number + size: + description: The number of top item sets to return. + type: number + filter: + $ref: '#/components/schemas/_common.query_dsl:QueryContainer' + required: + - fields + _common.aggregations:FrequentItemSetsBucket: allOf: - - $ref: '#/components/schemas/_common.aggregations:AggregateBase' + - $ref: '#/components/schemas/_common.aggregations:MultiBucketBase' - type: object properties: - buckets: - $ref: '#/components/schemas/_common.aggregations:BucketsFiltersBucket' + key: + type: object + additionalProperties: + type: array + items: + type: string + support: + type: number required: - - buckets - _common.aggregations:MultiBucketAggregateBaseFrequentItemSetsBucket: + - key + - support + _common.aggregations:FrequentItemSetsField: + type: object + properties: + field: + $ref: '#/components/schemas/_common:Field' + exclude: + $ref: '#/components/schemas/_common.aggregations:TermsExclude' + include: + $ref: '#/components/schemas/_common.aggregations:TermsInclude' + required: + - field + _common.aggregations:GapPolicy: + type: string + enum: + - insert_zeros + - keep_values + - skip + _common.aggregations:GeoBoundsAggregate: allOf: - $ref: '#/components/schemas/_common.aggregations:AggregateBase' - type: object properties: - buckets: - $ref: '#/components/schemas/_common.aggregations:BucketsFrequentItemSetsBucket' - required: - - buckets - _common.aggregations:MultiBucketAggregateBaseGeoHashGridBucket: + bounds: + $ref: '#/components/schemas/_common:GeoBounds' + _common.aggregations:GeoBoundsAggregation: allOf: - - $ref: '#/components/schemas/_common.aggregations:AggregateBase' + - $ref: '#/components/schemas/_common.aggregations:MetricAggregationBase' - type: object properties: - buckets: - $ref: '#/components/schemas/_common.aggregations:BucketsGeoHashGridBucket' - required: - - buckets - _common.aggregations:MultiBucketAggregateBaseGeoHexGridBucket: + wrap_longitude: + description: Specifies whether the bounding box should be allowed to overlap the international date line. + type: boolean + _common.aggregations:GeoCentroidAggregate: allOf: - $ref: '#/components/schemas/_common.aggregations:AggregateBase' - type: object properties: - buckets: - $ref: '#/components/schemas/_common.aggregations:BucketsGeoHexGridBucket' + count: + type: number + location: + $ref: '#/components/schemas/_common:GeoLocation' required: - - buckets - _common.aggregations:MultiBucketAggregateBaseGeoTileGridBucket: + - count + _common.aggregations:GeoCentroidAggregation: allOf: - - $ref: '#/components/schemas/_common.aggregations:AggregateBase' + - $ref: '#/components/schemas/_common.aggregations:MetricAggregationBase' - type: object properties: - buckets: - $ref: '#/components/schemas/_common.aggregations:BucketsGeoTileGridBucket' - required: - - buckets - _common.aggregations:MultiBucketAggregateBaseHistogramBucket: + count: + type: number + location: + $ref: '#/components/schemas/_common:GeoLocation' + _common.aggregations:GeoDistanceAggregate: allOf: - - $ref: '#/components/schemas/_common.aggregations:AggregateBase' + - $ref: '#/components/schemas/_common.aggregations:RangeAggregate' - type: object - properties: - buckets: - $ref: '#/components/schemas/_common.aggregations:BucketsHistogramBucket' - required: - - buckets - _common.aggregations:MultiBucketAggregateBaseIpPrefixBucket: + _common.aggregations:GeoDistanceAggregation: allOf: - - $ref: '#/components/schemas/_common.aggregations:AggregateBase' + - $ref: '#/components/schemas/_common.aggregations:BucketAggregationBase' - type: object properties: - buckets: - $ref: '#/components/schemas/_common.aggregations:BucketsIpPrefixBucket' - required: - - buckets - _common.aggregations:MultiBucketAggregateBaseIpRangeBucket: + distance_type: + $ref: '#/components/schemas/_common:GeoDistanceType' + field: + $ref: '#/components/schemas/_common:Field' + origin: + $ref: '#/components/schemas/_common:GeoLocation' + ranges: + description: An array of ranges used to bucket documents. + type: array + items: + $ref: '#/components/schemas/_common.aggregations:AggregationRange' + unit: + $ref: '#/components/schemas/_common:DistanceUnit' + _common.aggregations:GeoHashGridAggregate: allOf: - - $ref: '#/components/schemas/_common.aggregations:AggregateBase' + - $ref: '#/components/schemas/_common.aggregations:MultiBucketAggregateBaseGeoHashGridBucket' - type: object - properties: - buckets: - $ref: '#/components/schemas/_common.aggregations:BucketsIpRangeBucket' - required: - - buckets - _common.aggregations:MultiBucketAggregateBaseLongRareTermsBucket: + _common.aggregations:GeoHashGridAggregation: allOf: - - $ref: '#/components/schemas/_common.aggregations:AggregateBase' + - $ref: '#/components/schemas/_common.aggregations:BucketAggregationBase' - type: object properties: - buckets: - $ref: '#/components/schemas/_common.aggregations:BucketsLongRareTermsBucket' - required: - - buckets - _common.aggregations:MultiBucketAggregateBaseLongTermsBucket: + bounds: + $ref: '#/components/schemas/_common:GeoBounds' + field: + $ref: '#/components/schemas/_common:Field' + precision: + $ref: '#/components/schemas/_common:GeoHashPrecision' + shard_size: + description: |- + Allows for more accurate counting of the top cells returned in the final result the aggregation. + Defaults to returning `max(10,(size x number-of-shards))` buckets from each shard. + type: number + size: + description: The maximum number of geohash buckets to return. + type: number + _common.aggregations:GeoHashGridBucket: allOf: - - $ref: '#/components/schemas/_common.aggregations:AggregateBase' + - $ref: '#/components/schemas/_common.aggregations:MultiBucketBase' - type: object properties: - buckets: - $ref: '#/components/schemas/_common.aggregations:BucketsLongTermsBucket' + key: + $ref: '#/components/schemas/_common:GeoHash' required: - - buckets - _common.aggregations:MultiBucketAggregateBaseMultiTermsBucket: + - key + _common.aggregations:GeoHexGridAggregate: allOf: - - $ref: '#/components/schemas/_common.aggregations:AggregateBase' + - $ref: '#/components/schemas/_common.aggregations:MultiBucketAggregateBaseGeoHexGridBucket' - type: object - properties: - buckets: - $ref: '#/components/schemas/_common.aggregations:BucketsMultiTermsBucket' - required: - - buckets - _common.aggregations:MultiBucketAggregateBaseRangeBucket: + _common.aggregations:GeohexGridAggregation: allOf: - - $ref: '#/components/schemas/_common.aggregations:AggregateBase' + - $ref: '#/components/schemas/_common.aggregations:BucketAggregationBase' - type: object properties: - buckets: - $ref: '#/components/schemas/_common.aggregations:BucketsRangeBucket' + 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. + type: number + bounds: + $ref: '#/components/schemas/_common:GeoBounds' + size: + description: Maximum number of buckets to return. + type: number + shard_size: + description: Number of buckets returned from each shard. + type: number required: - - buckets - _common.aggregations:MultiBucketAggregateBaseSignificantLongTermsBucket: + - field + _common.aggregations:GeoHexGridBucket: allOf: - - $ref: '#/components/schemas/_common.aggregations:AggregateBase' + - $ref: '#/components/schemas/_common.aggregations:MultiBucketBase' - type: object properties: - buckets: - $ref: '#/components/schemas/_common.aggregations:BucketsSignificantLongTermsBucket' + key: + $ref: '#/components/schemas/_common:GeoHexCell' required: - - buckets - _common.aggregations:MultiBucketAggregateBaseSignificantStringTermsBucket: + - key + _common.aggregations:GeoLineAggregate: allOf: - $ref: '#/components/schemas/_common.aggregations:AggregateBase' - type: object properties: - buckets: - $ref: '#/components/schemas/_common.aggregations:BucketsSignificantStringTermsBucket' + type: + type: string + geometry: + $ref: '#/components/schemas/_common:GeoLine' + properties: + type: object required: - - buckets - _common.aggregations:MultiBucketAggregateBaseStringRareTermsBucket: + - geometry + - properties + - type + _common.aggregations:GeoLineAggregation: + type: object + properties: + point: + $ref: '#/components/schemas/_common.aggregations:GeoLinePoint' + sort: + $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' + size: + description: |- + The maximum length of the line represented in the aggregation. + Valid sizes are between 1 and 10000. + type: number + required: + - point + - sort + _common.aggregations:GeoLinePoint: + type: object + properties: + field: + $ref: '#/components/schemas/_common:Field' + required: + - field + _common.aggregations:GeoLineSort: + type: object + properties: + field: + $ref: '#/components/schemas/_common:Field' + required: + - field + _common.aggregations:GeoTileGridAggregate: allOf: - - $ref: '#/components/schemas/_common.aggregations:AggregateBase' + - $ref: '#/components/schemas/_common.aggregations:MultiBucketAggregateBaseGeoTileGridBucket' - type: object - properties: - buckets: - $ref: '#/components/schemas/_common.aggregations:BucketsStringRareTermsBucket' - required: - - buckets - _common.aggregations:MultiBucketAggregateBaseStringTermsBucket: + _common.aggregations:GeoTileGridAggregation: allOf: - - $ref: '#/components/schemas/_common.aggregations:AggregateBase' + - $ref: '#/components/schemas/_common.aggregations:BucketAggregationBase' - type: object properties: - buckets: - $ref: '#/components/schemas/_common.aggregations:BucketsStringTermsBucket' - required: - - buckets - _common.aggregations:MultiBucketAggregateBaseVariableWidthHistogramBucket: + field: + $ref: '#/components/schemas/_common:Field' + precision: + $ref: '#/components/schemas/_common:GeoTilePrecision' + shard_size: + description: |- + Allows for more accurate counting of the top cells returned in the final result the aggregation. + Defaults to returning `max(10,(size x number-of-shards))` buckets from each shard. + type: number + size: + description: The maximum number of buckets to return. + type: number + bounds: + $ref: '#/components/schemas/_common:GeoBounds' + _common.aggregations:GeoTileGridBucket: allOf: - - $ref: '#/components/schemas/_common.aggregations:AggregateBase' + - $ref: '#/components/schemas/_common.aggregations:MultiBucketBase' - type: object properties: - buckets: - $ref: '#/components/schemas/_common.aggregations:BucketsVariableWidthHistogramBucket' + key: + $ref: '#/components/schemas/_common:GeoTile' required: - - buckets - _common.aggregations:MultiBucketAggregateBaseVoid: + - key + _common.aggregations:GlobalAggregate: allOf: - - $ref: '#/components/schemas/_common.aggregations:AggregateBase' + - $ref: '#/components/schemas/_common.aggregations:SingleBucketAggregateBase' - type: object - properties: - buckets: - $ref: '#/components/schemas/_common.aggregations:BucketsVoid' - required: - - buckets - _common.aggregations:MultiBucketBase: + _common.aggregations:GlobalAggregation: + allOf: + - $ref: '#/components/schemas/_common.aggregations:BucketAggregationBase' + - type: object + _common.aggregations:GoogleNormalizedDistanceHeuristic: type: object properties: - doc_count: - type: number - required: - - doc_count - _common.aggregations:MultiTermLookup: + 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: type: object properties: - field: - $ref: '#/components/schemas/_common:Field' - missing: - $ref: '#/components/schemas/_common.aggregations:Missing' - required: - - field - _common.aggregations:MultiTermsAggregate: + number_of_significant_value_digits: + description: Specifies the resolution of values for the histogram in number of significant digits. + type: number + _common.aggregations:HdrPercentileRanksAggregate: allOf: - - $ref: '#/components/schemas/_common.aggregations:TermsAggregateBaseMultiTermsBucket' + - $ref: '#/components/schemas/_common.aggregations:PercentilesAggregateBase' - type: object - _common.aggregations:MultiTermsAggregation: + _common.aggregations:HdrPercentilesAggregate: + allOf: + - $ref: '#/components/schemas/_common.aggregations:PercentilesAggregateBase' + - type: object + _common.aggregations:HistogramAggregate: + allOf: + - $ref: '#/components/schemas/_common.aggregations:MultiBucketAggregateBaseHistogramBucket' + - type: object + _common.aggregations:HistogramAggregation: allOf: - $ref: '#/components/schemas/_common.aggregations:BucketAggregationBase' - type: object properties: - collect_mode: - $ref: '#/components/schemas/_common.aggregations:TermsAggregationCollectMode' - order: - $ref: '#/components/schemas/_common.aggregations:AggregateOrder' + extended_bounds: + $ref: '#/components/schemas/_common.aggregations:ExtendedBoundsdouble' + hard_bounds: + $ref: '#/components/schemas/_common.aggregations:ExtendedBoundsdouble' + field: + $ref: '#/components/schemas/_common:Field' + interval: + description: |- + The interval for the buckets. + Must be a positive decimal. + type: number min_doc_count: - description: The minimum number of documents in a bucket for it to be returned. + description: |- + Only returns buckets that have `min_doc_count` number of documents. + By default, the response will fill gaps in the histogram with empty buckets. type: number - shard_min_doc_count: - description: The minimum number of documents in a bucket on each shard for it to be returned. + missing: + description: |- + The value to apply to documents that do not have a value. + By default, documents without a value are ignored. type: number - shard_size: + offset: description: |- - The number of candidate terms produced by each shard. - By default, `shard_size` will be automatically estimated based on the number of shards and the `size` parameter. + By default, the bucket keys start with 0 and then continue in even spaced steps of `interval`. + The bucket boundaries can be shifted by using the `offset` option. type: number - show_term_doc_count_error: - description: Calculates the doc count error on per term basis. + order: + $ref: '#/components/schemas/_common.aggregations:AggregateOrder' + 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 - size: - description: The number of term buckets should be returned out of the overall terms list. - type: number - terms: - description: The field from which to generate sets of terms. - type: array - items: - $ref: '#/components/schemas/_common.aggregations:MultiTermLookup' - required: - - terms - _common.aggregations:MultiTermsBucket: + _common.aggregations:HistogramBucket: allOf: - $ref: '#/components/schemas/_common.aggregations:MultiBucketBase' - type: object properties: - key: - type: array - items: - $ref: '#/components/schemas/_common:FieldValue' key_as_string: type: string - doc_count_error_upper_bound: + key: type: number required: - key - _common.aggregations:MutualInformationHeuristic: + _common.aggregations:HoltLinearModelSettings: 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 - include_negatives: - description: Set to `false` to filter out the terms that appear less often in the subset than in documents outside the subset. + alpha: + type: number + beta: + type: number + _common.aggregations:HoltMovingAverageAggregation: + allOf: + - $ref: '#/components/schemas/_common.aggregations:MovingAverageAggregationBase' + - type: object + properties: + model: + type: string + enum: + - holt + settings: + $ref: '#/components/schemas/_common.aggregations:HoltLinearModelSettings' + required: + - model + - settings + _common.aggregations:HoltWintersModelSettings: + type: object + properties: + alpha: + type: number + beta: + type: number + gamma: + type: number + pad: type: boolean - _common.aggregations:NestedAggregate: + period: + type: number + type: + $ref: '#/components/schemas/_common.aggregations:HoltWintersType' + _common.aggregations:HoltWintersMovingAverageAggregation: allOf: - - $ref: '#/components/schemas/_common.aggregations:SingleBucketAggregateBase' + - $ref: '#/components/schemas/_common.aggregations:MovingAverageAggregationBase' - type: object - _common.aggregations:NestedAggregation: + properties: + model: + type: string + enum: + - holt_winters + settings: + $ref: '#/components/schemas/_common.aggregations:HoltWintersModelSettings' + required: + - model + - settings + _common.aggregations:HoltWintersType: + type: string + enum: + - add + - mult + _common.aggregations:InferenceAggregate: allOf: - - $ref: '#/components/schemas/_common.aggregations:BucketAggregationBase' + - $ref: '#/components/schemas/_common.aggregations:AggregateBase' - type: object properties: - path: - $ref: '#/components/schemas/_common:Field' - _common.aggregations:NormalizeAggregation: + value: + $ref: '#/components/schemas/_common:FieldValue' + feature_importance: + type: array + items: + $ref: '#/components/schemas/_common.aggregations:InferenceFeatureImportance' + top_classes: + type: array + items: + $ref: '#/components/schemas/_common.aggregations:InferenceTopClassEntry' + warning: + type: string + _common.aggregations:InferenceAggregation: allOf: - $ref: '#/components/schemas/_common.aggregations:PipelineAggregationBase' - type: object properties: - method: - $ref: '#/components/schemas/_common.aggregations:NormalizeMethod' - _common.aggregations:NormalizeMethod: - type: string - enum: - - rescale_0_1 - - rescale_0_100 - - percent_of_sum - - mean - - z-score - - softmax - _common.aggregations:ParentAggregate: + model_id: + $ref: '#/components/schemas/_common:Name' + inference_config: + $ref: '#/components/schemas/_common.aggregations:InferenceConfigContainer' + required: + - model_id + _common.aggregations:InferenceClassImportance: + type: object + properties: + class_name: + type: string + importance: + type: number + required: + - class_name + - importance + _common.aggregations:InferenceConfigContainer: + type: object + properties: + regression: + $ref: '#/components/schemas/_common.aggregations:RegressionInferenceOptions' + classification: + $ref: '#/components/schemas/_common.aggregations:ClassificationInferenceOptions' + minProperties: 1 + maxProperties: 1 + _common.aggregations:InferenceFeatureImportance: + type: object + properties: + feature_name: + type: string + importance: + type: number + classes: + type: array + items: + $ref: '#/components/schemas/_common.aggregations:InferenceClassImportance' + required: + - feature_name + _common.aggregations:InferenceTopClassEntry: + type: object + properties: + class_name: + $ref: '#/components/schemas/_common:FieldValue' + class_probability: + type: number + class_score: + type: number + required: + - class_name + - class_probability + - class_score + _common.aggregations:IpPrefixAggregate: allOf: - - $ref: '#/components/schemas/_common.aggregations:SingleBucketAggregateBase' + - $ref: '#/components/schemas/_common.aggregations:MultiBucketAggregateBaseIpPrefixBucket' - type: object - _common.aggregations:ParentAggregation: + _common.aggregations:IpPrefixAggregation: allOf: - $ref: '#/components/schemas/_common.aggregations:BucketAggregationBase' - type: object properties: - type: - $ref: '#/components/schemas/_common:RelationName' - _common.aggregations:PercentageScoreHeuristic: - type: object - _common.aggregations:PercentileRanksAggregation: - allOf: - - $ref: '#/components/schemas/_common.aggregations:FormatMetricAggregationBase' - - type: object - properties: - keyed: + field: + $ref: '#/components/schemas/_common:Field' + prefix_length: description: |- - By default, the aggregation associates a unique string key with each bucket and returns the ranges as a hash rather than an array. - Set to `false` to disable this behavior. + Length of the network prefix. For IPv4 addresses the accepted range is [0, 32]. + For IPv6 addresses the accepted range is [0, 128]. + type: number + is_ipv6: + description: Defines whether the prefix applies to IPv6 addresses. + type: boolean + append_prefix_length: + description: Defines whether the prefix length is appended to IP address keys in the response. type: boolean - values: - description: An array of values for which to calculate the percentile ranks. - oneOf: - - type: array - items: - type: number - - nullable: true - type: string - hdr: - $ref: '#/components/schemas/_common.aggregations:HdrMethod' - tdigest: - $ref: '#/components/schemas/_common.aggregations:TDigest' - _common.aggregations:Percentiles: - oneOf: - - $ref: '#/components/schemas/_common.aggregations:KeyedPercentiles' - - type: array - items: - $ref: '#/components/schemas/_common.aggregations:ArrayPercentilesItem' - _common.aggregations:PercentilesAggregateBase: - allOf: - - $ref: '#/components/schemas/_common.aggregations:AggregateBase' - - type: object - properties: - values: - $ref: '#/components/schemas/_common.aggregations:Percentiles' - required: - - values - _common.aggregations:PercentilesAggregation: - allOf: - - $ref: '#/components/schemas/_common.aggregations:FormatMetricAggregationBase' - - type: object - properties: keyed: - description: |- - By default, the aggregation associates a unique string key with each bucket and returns the ranges as a hash rather than an array. - Set to `false` to disable this behavior. + description: Defines whether buckets are returned as a hash rather than an array in the response. type: boolean - percents: - description: The percentiles to calculate. - type: array - items: - type: number - hdr: - $ref: '#/components/schemas/_common.aggregations:HdrMethod' - tdigest: - $ref: '#/components/schemas/_common.aggregations:TDigest' - _common.aggregations:PercentilesBucketAggregate: - allOf: - - $ref: '#/components/schemas/_common.aggregations:PercentilesAggregateBase' - - type: object - _common.aggregations:PercentilesBucketAggregation: - allOf: - - $ref: '#/components/schemas/_common.aggregations:PipelineAggregationBase' - - type: object - properties: - percents: - description: The list of percentiles to calculate. - type: array - items: - type: number - _common.aggregations:PipelineAggregationBase: + min_doc_count: + description: Minimum number of documents in a bucket for it to be included in the response. + type: number + required: + - field + - prefix_length + _common.aggregations:IpPrefixBucket: allOf: - - $ref: '#/components/schemas/_common.aggregations:BucketPathAggregation' + - $ref: '#/components/schemas/_common.aggregations:MultiBucketBase' - type: object properties: - format: - description: |- - `DecimalFormat` pattern for the output value. - If specified, the formatted value is returned in the aggregation’s `value_as_string` property. + is_ipv6: + type: boolean + key: type: string - gap_policy: - $ref: '#/components/schemas/_common.aggregations:GapPolicy' - _common.aggregations:RangeAggregate: + prefix_length: + type: number + netmask: + type: string + required: + - is_ipv6 + - key + - prefix_length + _common.aggregations:IpRangeAggregate: allOf: - - $ref: '#/components/schemas/_common.aggregations:MultiBucketAggregateBaseRangeBucket' + - $ref: '#/components/schemas/_common.aggregations:MultiBucketAggregateBaseIpRangeBucket' - type: object - _common.aggregations:RangeAggregation: + _common.aggregations:IpRangeAggregation: allOf: - $ref: '#/components/schemas/_common.aggregations:BucketAggregationBase' - type: object properties: field: $ref: '#/components/schemas/_common:Field' - missing: - description: |- - The value to apply to documents that do not have a value. - By default, documents without a value are ignored. - type: number ranges: - description: An array of ranges used to bucket documents. + description: Array of IP ranges. type: array items: - $ref: '#/components/schemas/_common.aggregations:AggregationRange' - 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: + $ref: '#/components/schemas/_common.aggregations:IpRangeAggregationRange' + _common.aggregations:IpRangeAggregationRange: + type: object + properties: + from: + description: Start of the range. + oneOf: + - type: string + - nullable: true type: string - _common.aggregations:RangeBucket: + mask: + description: IP range defined as a CIDR mask. + type: string + to: + description: End of the range. + oneOf: + - type: string + - nullable: true + type: string + _common.aggregations:IpRangeBucket: allOf: - $ref: '#/components/schemas/_common.aggregations:MultiBucketBase' - type: object properties: - from: - type: number - to: - type: number - from_as_string: + key: type: string - to_as_string: + from: type: string - key: - description: The bucket key. Present if the aggregation is _not_ keyed + to: type: string - _common.aggregations:RareTermsAggregation: + _common.aggregations:KeyedPercentiles: + type: object + additionalProperties: + oneOf: + - type: string + - type: number + - nullable: true + type: string + _common.aggregations:LinearMovingAverageAggregation: allOf: - - $ref: '#/components/schemas/_common.aggregations:BucketAggregationBase' + - $ref: '#/components/schemas/_common.aggregations:MovingAverageAggregationBase' - type: object properties: - exclude: - $ref: '#/components/schemas/_common.aggregations:TermsExclude' - field: - $ref: '#/components/schemas/_common:Field' - include: - $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' - precision: - description: |- - The precision of the internal CuckooFilters. - Smaller precision leads to better approximation, but higher memory usage. - type: number - value_type: + model: type: string - _common.aggregations:RateAggregate: + enum: + - linear + settings: + $ref: '#/components/schemas/_common:EmptyObject' + required: + - model + - settings + _common.aggregations:LongRareTermsAggregate: allOf: - - $ref: '#/components/schemas/_common.aggregations:AggregateBase' + - $ref: '#/components/schemas/_common.aggregations:MultiBucketAggregateBaseLongRareTermsBucket' + - type: object + _common.aggregations:LongRareTermsBucket: + allOf: + - $ref: '#/components/schemas/_common.aggregations:MultiBucketBase' - type: object properties: - value: + key: type: number - value_as_string: + key_as_string: type: string required: - - value - _common.aggregations:RateAggregation: + - key + _common.aggregations:LongTermsAggregate: allOf: - - $ref: '#/components/schemas/_common.aggregations:FormatMetricAggregationBase' + - $ref: '#/components/schemas/_common.aggregations:TermsAggregateBaseLongTermsBucket' - type: object - properties: - unit: - $ref: '#/components/schemas/_common.aggregations:CalendarInterval' - mode: - $ref: '#/components/schemas/_common.aggregations:RateMode' - _common.aggregations:RateMode: - type: string - enum: - - sum - - value_count - _common.aggregations:RegressionInferenceOptions: - type: object - properties: - results_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:LongTermsBucket: allOf: - - $ref: '#/components/schemas/_common.aggregations:SingleBucketAggregateBase' + - $ref: '#/components/schemas/_common.aggregations:TermsBucketBase' - type: object - _common.aggregations:ReverseNestedAggregation: + properties: + key: + type: number + key_as_string: + type: string + required: + - key + _common.aggregations:MatrixAggregation: allOf: - - $ref: '#/components/schemas/_common.aggregations:BucketAggregationBase' + - $ref: '#/components/schemas/_common.aggregations:Aggregation' - type: object properties: - path: - $ref: '#/components/schemas/_common:Field' - _common.aggregations:SamplerAggregate: + fields: + $ref: '#/components/schemas/_common:Fields' + missing: + description: |- + The value to apply to documents that do not have a value. + By default, documents without a value are ignored. + type: object + additionalProperties: + type: number + _common.aggregations:MatrixStatsAggregate: allOf: - - $ref: '#/components/schemas/_common.aggregations:SingleBucketAggregateBase' + - $ref: '#/components/schemas/_common.aggregations:AggregateBase' - type: object - _common.aggregations:SamplerAggregation: + properties: + doc_count: + type: number + fields: + type: array + items: + $ref: '#/components/schemas/_common.aggregations:MatrixStatsFields' + required: + - doc_count + _common.aggregations:MatrixStatsAggregation: allOf: - - $ref: '#/components/schemas/_common.aggregations:BucketAggregationBase' + - $ref: '#/components/schemas/_common.aggregations:MatrixAggregation' - 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: - type: string - enum: - - map - - global_ordinals - - bytes_hash - _common.aggregations:ScriptedHeuristic: + mode: + $ref: '#/components/schemas/_common:SortMode' + _common.aggregations:MatrixStatsFields: type: object properties: - script: - $ref: '#/components/schemas/_common:Script' + name: + $ref: '#/components/schemas/_common:Field' + count: + type: number + mean: + type: number + variance: + type: number + skewness: + type: number + kurtosis: + type: number + covariance: + type: object + additionalProperties: + type: number + correlation: + type: object + additionalProperties: + type: number required: - - script - _common.aggregations:ScriptedMetricAggregate: + - correlation + - count + - covariance + - kurtosis + - mean + - name + - skewness + - variance + _common.aggregations:MaxAggregate: allOf: - - $ref: '#/components/schemas/_common.aggregations:AggregateBase' + - $ref: '#/components/schemas/_common.aggregations:SingleMetricAggregateBase' - type: object - properties: - value: - type: object - required: - - value - _common.aggregations:ScriptedMetricAggregation: + _common.aggregations:MaxAggregation: allOf: - - $ref: '#/components/schemas/_common.aggregations:MetricAggregationBase' + - $ref: '#/components/schemas/_common.aggregations:FormatMetricAggregationBase' - type: object - properties: - combine_script: - $ref: '#/components/schemas/_common:Script' - init_script: - $ref: '#/components/schemas/_common:Script' - map_script: - $ref: '#/components/schemas/_common:Script' - params: - description: |- - A global object with script parameters for `init`, `map` and `combine` scripts. - It is shared between the scripts. - type: object - additionalProperties: - type: object - reduce_script: - $ref: '#/components/schemas/_common:Script' - _common.aggregations:SerialDifferencingAggregation: + _common.aggregations:MaxBucketAggregation: allOf: - $ref: '#/components/schemas/_common.aggregations:PipelineAggregationBase' - type: object - properties: - lag: - description: |- - The historical bucket to subtract from the current value. - Must be a positive, non-zero integer. - type: number - _common.aggregations:SignificantLongTermsAggregate: + _common.aggregations:MedianAbsoluteDeviationAggregate: allOf: - - $ref: '#/components/schemas/_common.aggregations:SignificantTermsAggregateBaseSignificantLongTermsBucket' + - $ref: '#/components/schemas/_common.aggregations:SingleMetricAggregateBase' - type: object - _common.aggregations:SignificantLongTermsBucket: + _common.aggregations:MedianAbsoluteDeviationAggregation: allOf: - - $ref: '#/components/schemas/_common.aggregations:SignificantTermsBucketBase' + - $ref: '#/components/schemas/_common.aggregations:FormatMetricAggregationBase' - type: object properties: - key: + 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 - key_as_string: - type: string - required: - - key - _common.aggregations:SignificantStringTermsAggregate: - allOf: - - $ref: '#/components/schemas/_common.aggregations:SignificantTermsAggregateBaseSignificantStringTermsBucket' - - type: object - _common.aggregations:SignificantStringTermsBucket: + _common.aggregations:MetricAggregationBase: + type: object + properties: + field: + $ref: '#/components/schemas/_common:Field' + missing: + $ref: '#/components/schemas/_common.aggregations:Missing' + script: + $ref: '#/components/schemas/_common:Script' + _common.aggregations:MinAggregate: allOf: - - $ref: '#/components/schemas/_common.aggregations:SignificantTermsBucketBase' + - $ref: '#/components/schemas/_common.aggregations:SingleMetricAggregateBase' - type: object - properties: - key: - type: string - required: - - key - _common.aggregations:SignificantTermsAggregateBaseSignificantLongTermsBucket: + _common.aggregations:MinAggregation: allOf: - - $ref: '#/components/schemas/_common.aggregations:MultiBucketAggregateBaseSignificantLongTermsBucket' + - $ref: '#/components/schemas/_common.aggregations:FormatMetricAggregationBase' - type: object - properties: - bg_count: - type: number - doc_count: - type: number - _common.aggregations:SignificantTermsAggregateBaseSignificantStringTermsBucket: + _common.aggregations:MinBucketAggregation: allOf: - - $ref: '#/components/schemas/_common.aggregations:MultiBucketAggregateBaseSignificantStringTermsBucket' + - $ref: '#/components/schemas/_common.aggregations:PipelineAggregationBase' - type: object - properties: - bg_count: - type: number - doc_count: - type: number - _common.aggregations:SignificantTermsAggregateBaseVoid: + _common.aggregations:MinimumInterval: + type: string + enum: + - day + - hour + - minute + - month + - second + - year + _common.aggregations:Missing: + oneOf: + - type: string + - type: number + - type: number + - type: boolean + _common.aggregations:MissingAggregate: allOf: - - $ref: '#/components/schemas/_common.aggregations:MultiBucketAggregateBaseVoid' + - $ref: '#/components/schemas/_common.aggregations:SingleBucketAggregateBase' - type: object - properties: - bg_count: - type: number - doc_count: - type: number - _common.aggregations:SignificantTermsAggregation: + _common.aggregations:MissingAggregation: allOf: - $ref: '#/components/schemas/_common.aggregations:BucketAggregationBase' - type: object properties: - background_filter: - $ref: '#/components/schemas/_common.query_dsl:QueryContainer' - chi_square: - $ref: '#/components/schemas/_common.aggregations:ChiSquareHeuristic' - exclude: - $ref: '#/components/schemas/_common.aggregations:TermsExclude' - execution_hint: - $ref: '#/components/schemas/_common.aggregations:TermsAggregationExecutionHint' field: $ref: '#/components/schemas/_common:Field' - gnd: - $ref: '#/components/schemas/_common.aggregations:GoogleNormalizedDistanceHeuristic' - include: - $ref: '#/components/schemas/_common.aggregations:TermsInclude' - jlh: - $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' - percentage: - $ref: '#/components/schemas/_common.aggregations:PercentageScoreHeuristic' - script_heuristic: - $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`. - Terms will only be considered if their local shard frequency within the set is higher than the `shard_min_doc_count`. - type: number - shard_size: - description: |- - Can be used to control the volumes of candidate terms produced by each shard. - By default, `shard_size` will be automatically estimated based on the number of shards and the `size` parameter. + missing: + $ref: '#/components/schemas/_common.aggregations:Missing' + _common.aggregations:MissingOrder: + type: string + enum: + - default + - first + - last + _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: + allOf: + - $ref: '#/components/schemas/_common.aggregations:PipelineAggregationBase' + - type: object + properties: + minimize: + type: boolean + predict: type: number - size: - description: The number of buckets returned out of the overall terms list. + window: type: number - _common.aggregations:SignificantTermsBucketBase: + _common.aggregations:MovingFunctionAggregation: allOf: - - $ref: '#/components/schemas/_common.aggregations:MultiBucketBase' + - $ref: '#/components/schemas/_common.aggregations:PipelineAggregationBase' - type: object properties: - score: + script: + description: The script that should be executed on each window of data. + type: string + shift: + description: |- + By default, the window consists of the last n values excluding the current bucket. + Increasing `shift` by 1, moves the starting window position by 1 to the right. type: number - bg_count: + window: + description: The size of window to "slide" across the histogram. type: number - required: - - score - - bg_count - _common.aggregations:SignificantTextAggregation: + _common.aggregations:MovingPercentilesAggregation: allOf: - - $ref: '#/components/schemas/_common.aggregations:BucketAggregationBase' + - $ref: '#/components/schemas/_common.aggregations:PipelineAggregationBase' - type: object properties: - background_filter: - $ref: '#/components/schemas/_common.query_dsl:QueryContainer' - chi_square: - $ref: '#/components/schemas/_common.aggregations:ChiSquareHeuristic' - exclude: - $ref: '#/components/schemas/_common.aggregations:TermsExclude' - execution_hint: - $ref: '#/components/schemas/_common.aggregations:TermsAggregationExecutionHint' - 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' - include: - $ref: '#/components/schemas/_common.aggregations:TermsInclude' - jlh: - $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' - percentage: - $ref: '#/components/schemas/_common.aggregations:PercentageScoreHeuristic' - script_heuristic: - $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. - Values will only be considered if their local shard frequency within the set is higher than the `shard_min_doc_count`. + window: + description: The size of window to "slide" across the histogram. type: number - shard_size: + shift: description: |- - The number of candidate terms produced by each shard. - By default, `shard_size` will be automatically estimated based on the number of shards and the `size` parameter. - type: number - size: - description: The number of buckets returned out of the overall terms list. + By default, the window consists of the last n values excluding the current bucket. + Increasing `shift` by 1, moves the starting window position by 1 to the right. type: number - source_fields: - $ref: '#/components/schemas/_common:Fields' - _common.aggregations:SimpleMovingAverageAggregation: + keyed: + type: boolean + _common.aggregations:MultiBucketAggregateBaseAdjacencyMatrixBucket: allOf: - - $ref: '#/components/schemas/_common.aggregations:MovingAverageAggregationBase' + - $ref: '#/components/schemas/_common.aggregations:AggregateBase' - type: object properties: - model: - type: string - enum: - - simple - settings: - $ref: '#/components/schemas/_common:EmptyObject' + buckets: + $ref: '#/components/schemas/_common.aggregations:BucketsAdjacencyMatrixBucket' required: - - model - - settings - _common.aggregations:SimpleValueAggregate: - allOf: - - $ref: '#/components/schemas/_common.aggregations:SingleMetricAggregateBase' - - type: object - _common.aggregations:SingleBucketAggregateBase: + - buckets + _common.aggregations:MultiBucketAggregateBaseCompositeBucket: allOf: - $ref: '#/components/schemas/_common.aggregations:AggregateBase' - type: object properties: - doc_count: - type: number + buckets: + $ref: '#/components/schemas/_common.aggregations:BucketsCompositeBucket' required: - - doc_count - _common.aggregations:SingleMetricAggregateBase: + - buckets + _common.aggregations:MultiBucketAggregateBaseDateHistogramBucket: allOf: - $ref: '#/components/schemas/_common.aggregations:AggregateBase' - type: object properties: - value: - description: |- - The metric value. A missing value generally means that there was no data to aggregate, - unless specified otherwise. - oneOf: - - type: number - - nullable: true - type: string - value_as_string: - type: string + buckets: + $ref: '#/components/schemas/_common.aggregations:BucketsDateHistogramBucket' required: - - value - _common.aggregations:StandardDeviationBounds: - type: object - properties: - upper: - oneOf: - - type: number - - nullable: true - type: string - lower: - oneOf: - - type: number - - nullable: true - type: string - upper_population: - oneOf: - - type: number - - nullable: true - type: string - lower_population: - oneOf: - - type: number - - nullable: true - type: string - upper_sampling: - oneOf: - - type: number - - nullable: true - type: string - lower_sampling: - oneOf: - - type: number - - nullable: true - type: string - required: - - upper - - lower - - upper_population - - lower_population - - upper_sampling - - lower_sampling - _common.aggregations:StandardDeviationBoundsAsString: - type: object - properties: - upper: - type: string - lower: - type: string - upper_population: - type: string - lower_population: - type: string - upper_sampling: - type: string - lower_sampling: - type: string - required: - - upper - - lower - - upper_population - - lower_population - - upper_sampling - - lower_sampling - _common.aggregations:StatsAggregate: + - buckets + _common.aggregations:MultiBucketAggregateBaseDoubleTermsBucket: allOf: - $ref: '#/components/schemas/_common.aggregations:AggregateBase' - type: object properties: - count: - type: number - min: - oneOf: - - type: number - - nullable: true - type: string - max: - oneOf: - - type: number - - nullable: true - type: string - avg: - oneOf: - - type: number - - nullable: true - type: string - sum: - type: number - min_as_string: - type: string - max_as_string: - type: string - avg_as_string: - type: string - sum_as_string: - type: string + buckets: + $ref: '#/components/schemas/_common.aggregations:BucketsDoubleTermsBucket' required: - - count - - min - - max - - avg - - sum - _common.aggregations:StatsAggregation: - allOf: - - $ref: '#/components/schemas/_common.aggregations:FormatMetricAggregationBase' - - type: object - _common.aggregations:StatsBucketAggregate: - allOf: - - $ref: '#/components/schemas/_common.aggregations:StatsAggregate' - - type: object - _common.aggregations:StatsBucketAggregation: - allOf: - - $ref: '#/components/schemas/_common.aggregations:PipelineAggregationBase' - - type: object - _common.aggregations:StringRareTermsAggregate: - allOf: - - $ref: '#/components/schemas/_common.aggregations:MultiBucketAggregateBaseStringRareTermsBucket' - - type: object - _common.aggregations:StringRareTermsBucket: + - buckets + _common.aggregations:MultiBucketAggregateBaseFiltersBucket: allOf: - - $ref: '#/components/schemas/_common.aggregations:MultiBucketBase' + - $ref: '#/components/schemas/_common.aggregations:AggregateBase' - type: object properties: - key: - type: string + buckets: + $ref: '#/components/schemas/_common.aggregations:BucketsFiltersBucket' required: - - key - _common.aggregations:StringStatsAggregate: + - buckets + _common.aggregations:MultiBucketAggregateBaseFrequentItemSetsBucket: allOf: - $ref: '#/components/schemas/_common.aggregations:AggregateBase' - type: object properties: - count: - type: number - min_length: - oneOf: - - type: number - - nullable: true - type: string - max_length: - oneOf: - - type: number - - nullable: true - type: string - avg_length: - oneOf: - - type: number - - nullable: true - type: string - entropy: - oneOf: - - type: number - - nullable: true - type: string - distribution: - oneOf: - - type: object - additionalProperties: - type: number - - nullable: true - type: string - min_length_as_string: - type: string - max_length_as_string: - type: string - avg_length_as_string: - type: string + buckets: + $ref: '#/components/schemas/_common.aggregations:BucketsFrequentItemSetsBucket' required: - - count - - min_length - - max_length - - avg_length - - entropy - _common.aggregations:StringStatsAggregation: + - buckets + _common.aggregations:MultiBucketAggregateBaseGeoHashGridBucket: allOf: - - $ref: '#/components/schemas/_common.aggregations:MetricAggregationBase' + - $ref: '#/components/schemas/_common.aggregations:AggregateBase' - type: object properties: - show_distribution: - description: Shows the probability distribution for all characters. - type: boolean - _common.aggregations:StringTermsAggregate: - allOf: - - $ref: '#/components/schemas/_common.aggregations:TermsAggregateBaseStringTermsBucket' - - type: object - _common.aggregations:StringTermsBucket: + buckets: + $ref: '#/components/schemas/_common.aggregations:BucketsGeoHashGridBucket' + required: + - buckets + _common.aggregations:MultiBucketAggregateBaseGeoHexGridBucket: allOf: - - $ref: '#/components/schemas/_common.aggregations:TermsBucketBase' + - $ref: '#/components/schemas/_common.aggregations:AggregateBase' - type: object properties: - key: - $ref: '#/components/schemas/_common:FieldValue' + buckets: + $ref: '#/components/schemas/_common.aggregations:BucketsGeoHexGridBucket' required: - - key - _common.aggregations:SumAggregate: + - buckets + _common.aggregations:MultiBucketAggregateBaseGeoTileGridBucket: allOf: - - $ref: '#/components/schemas/_common.aggregations:SingleMetricAggregateBase' + - $ref: '#/components/schemas/_common.aggregations:AggregateBase' - type: object - _common.aggregations:SumAggregation: + properties: + buckets: + $ref: '#/components/schemas/_common.aggregations:BucketsGeoTileGridBucket' + required: + - buckets + _common.aggregations:MultiBucketAggregateBaseHistogramBucket: allOf: - - $ref: '#/components/schemas/_common.aggregations:FormatMetricAggregationBase' + - $ref: '#/components/schemas/_common.aggregations:AggregateBase' - type: object - _common.aggregations:SumBucketAggregation: + properties: + buckets: + $ref: '#/components/schemas/_common.aggregations:BucketsHistogramBucket' + required: + - buckets + _common.aggregations:MultiBucketAggregateBaseIpPrefixBucket: allOf: - - $ref: '#/components/schemas/_common.aggregations:PipelineAggregationBase' + - $ref: '#/components/schemas/_common.aggregations:AggregateBase' - type: object - _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: + properties: + buckets: + $ref: '#/components/schemas/_common.aggregations:BucketsIpPrefixBucket' + required: + - buckets + _common.aggregations:MultiBucketAggregateBaseIpRangeBucket: allOf: - - $ref: '#/components/schemas/_common.aggregations:PercentilesAggregateBase' + - $ref: '#/components/schemas/_common.aggregations:AggregateBase' - type: object - _common.aggregations:TDigestPercentilesAggregate: + properties: + buckets: + $ref: '#/components/schemas/_common.aggregations:BucketsIpRangeBucket' + required: + - buckets + _common.aggregations:MultiBucketAggregateBaseLongRareTermsBucket: allOf: - - $ref: '#/components/schemas/_common.aggregations:PercentilesAggregateBase' + - $ref: '#/components/schemas/_common.aggregations:AggregateBase' - type: object - _common.aggregations:TTestAggregate: + properties: + buckets: + $ref: '#/components/schemas/_common.aggregations:BucketsLongRareTermsBucket' + required: + - buckets + _common.aggregations:MultiBucketAggregateBaseLongTermsBucket: allOf: - $ref: '#/components/schemas/_common.aggregations:AggregateBase' - type: object properties: - value: - oneOf: - - type: number - - nullable: true - type: string - value_as_string: - type: string + buckets: + $ref: '#/components/schemas/_common.aggregations:BucketsLongTermsBucket' required: - - value - _common.aggregations:TTestAggregation: + - buckets + _common.aggregations:MultiBucketAggregateBaseMultiTermsBucket: allOf: - - $ref: '#/components/schemas/_common.aggregations:Aggregation' + - $ref: '#/components/schemas/_common.aggregations:AggregateBase' - type: object properties: - a: - $ref: '#/components/schemas/_common.aggregations:TestPopulation' - b: - $ref: '#/components/schemas/_common.aggregations:TestPopulation' - type: - $ref: '#/components/schemas/_common.aggregations:TTestType' - _common.aggregations:TTestType: - type: string - enum: - - paired - - homoscedastic - - heteroscedastic - _common.aggregations:TermsAggregateBaseDoubleTermsBucket: + buckets: + $ref: '#/components/schemas/_common.aggregations:BucketsMultiTermsBucket' + required: + - buckets + _common.aggregations:MultiBucketAggregateBaseRangeBucket: allOf: - - $ref: '#/components/schemas/_common.aggregations:MultiBucketAggregateBaseDoubleTermsBucket' + - $ref: '#/components/schemas/_common.aggregations:AggregateBase' - type: object properties: - doc_count_error_upper_bound: - type: number - sum_other_doc_count: - type: number - _common.aggregations:TermsAggregateBaseLongTermsBucket: + buckets: + $ref: '#/components/schemas/_common.aggregations:BucketsRangeBucket' + required: + - buckets + _common.aggregations:MultiBucketAggregateBaseSignificantLongTermsBucket: allOf: - - $ref: '#/components/schemas/_common.aggregations:MultiBucketAggregateBaseLongTermsBucket' + - $ref: '#/components/schemas/_common.aggregations:AggregateBase' - type: object properties: - doc_count_error_upper_bound: - type: number - sum_other_doc_count: - type: number - _common.aggregations:TermsAggregateBaseMultiTermsBucket: + buckets: + $ref: '#/components/schemas/_common.aggregations:BucketsSignificantLongTermsBucket' + required: + - buckets + _common.aggregations:MultiBucketAggregateBaseSignificantStringTermsBucket: allOf: - - $ref: '#/components/schemas/_common.aggregations:MultiBucketAggregateBaseMultiTermsBucket' + - $ref: '#/components/schemas/_common.aggregations:AggregateBase' - type: object properties: - doc_count_error_upper_bound: - type: number - sum_other_doc_count: - type: number - _common.aggregations:TermsAggregateBaseStringTermsBucket: + buckets: + $ref: '#/components/schemas/_common.aggregations:BucketsSignificantStringTermsBucket' + required: + - buckets + _common.aggregations:MultiBucketAggregateBaseStringRareTermsBucket: allOf: - - $ref: '#/components/schemas/_common.aggregations:MultiBucketAggregateBaseStringTermsBucket' + - $ref: '#/components/schemas/_common.aggregations:AggregateBase' - type: object properties: - doc_count_error_upper_bound: - type: number - sum_other_doc_count: - type: number - _common.aggregations:TermsAggregateBaseVoid: + buckets: + $ref: '#/components/schemas/_common.aggregations:BucketsStringRareTermsBucket' + required: + - buckets + _common.aggregations:MultiBucketAggregateBaseStringTermsBucket: allOf: - - $ref: '#/components/schemas/_common.aggregations:MultiBucketAggregateBaseVoid' + - $ref: '#/components/schemas/_common.aggregations:AggregateBase' - type: object properties: - doc_count_error_upper_bound: - type: number - sum_other_doc_count: - type: number - _common.aggregations:TermsAggregation: + buckets: + $ref: '#/components/schemas/_common.aggregations:BucketsStringTermsBucket' + required: + - buckets + _common.aggregations:MultiBucketAggregateBaseVariableWidthHistogramBucket: allOf: - - $ref: '#/components/schemas/_common.aggregations:BucketAggregationBase' + - $ref: '#/components/schemas/_common.aggregations:AggregateBase' - type: object properties: - collect_mode: - $ref: '#/components/schemas/_common.aggregations:TermsAggregationCollectMode' - exclude: - $ref: '#/components/schemas/_common.aggregations:TermsExclude' - execution_hint: - $ref: '#/components/schemas/_common.aggregations:TermsAggregationExecutionHint' - field: - $ref: '#/components/schemas/_common:Field' - include: - $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' - missing_order: - $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' - script: - $ref: '#/components/schemas/_common:Script' - shard_size: - description: |- - The number of candidate terms produced by each shard. - By default, `shard_size` will be automatically estimated based on the number of shards and the `size` parameter. - type: number - show_term_doc_count_error: - description: Set to `true` to return the `doc_count_error_upper_bound`, which is an upper bound to the error on the `doc_count` returned by each shard. - type: boolean - size: - description: The number of buckets returned out of the overall terms list. - type: number - format: - type: string - _common.aggregations:TermsAggregationCollectMode: - type: string - enum: - - depth_first - - breadth_first - _common.aggregations:TermsAggregationExecutionHint: - type: string - enum: - - map - - global_ordinals - - global_ordinals_hash - - global_ordinals_low_cardinality - _common.aggregations:TermsBucketBase: + buckets: + $ref: '#/components/schemas/_common.aggregations:BucketsVariableWidthHistogramBucket' + required: + - buckets + _common.aggregations:MultiBucketAggregateBaseVoid: allOf: - - $ref: '#/components/schemas/_common.aggregations:MultiBucketBase' + - $ref: '#/components/schemas/_common.aggregations:AggregateBase' - type: object properties: - doc_count_error: - type: number - _common.aggregations:TermsExclude: - oneOf: - - type: string - - type: array - items: - type: string - _common.aggregations:TermsInclude: - oneOf: - - type: string - - type: array - items: - type: string - - $ref: '#/components/schemas/_common.aggregations:TermsPartition' - _common.aggregations:TermsPartition: + buckets: + $ref: '#/components/schemas/_common.aggregations:BucketsVoid' + required: + - buckets + _common.aggregations:MultiBucketBase: type: object properties: - num_partitions: - description: The number of partitions. - type: number - partition: - description: The partition number for this request. + doc_count: type: number required: - - num_partitions - - partition - _common.aggregations:TestPopulation: + - doc_count + _common.aggregations:MultiTermLookup: type: object properties: field: $ref: '#/components/schemas/_common:Field' - script: - $ref: '#/components/schemas/_common:Script' - filter: - $ref: '#/components/schemas/_common.query_dsl:QueryContainer' + missing: + $ref: '#/components/schemas/_common.aggregations:Missing' required: - field - _common.aggregations:TopHitsAggregate: + _common.aggregations:MultiTermsAggregate: allOf: - - $ref: '#/components/schemas/_common.aggregations:AggregateBase' + - $ref: '#/components/schemas/_common.aggregations:TermsAggregateBaseMultiTermsBucket' - type: object - properties: - hits: - $ref: '#/components/schemas/_core.search:HitsMetadata' - required: - - hits - _common.aggregations:TopHitsAggregation: + _common.aggregations:MultiTermsAggregation: allOf: - - $ref: '#/components/schemas/_common.aggregations:MetricAggregationBase' + - $ref: '#/components/schemas/_common.aggregations:BucketAggregationBase' - type: object properties: - docvalue_fields: - $ref: '#/components/schemas/_common:Fields' - explain: - description: If `true`, returns detailed information about score computation as part of a hit. - type: boolean - from: - description: Starting document offset. + collect_mode: + $ref: '#/components/schemas/_common.aggregations:TermsAggregationCollectMode' + order: + $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 - 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' - size: - description: The maximum number of top matching hits to return per bucket. + shard_min_doc_count: + description: The minimum number of documents in a bucket on each shard for it to be returned. type: number - sort: - $ref: '#/components/schemas/_common:Sort' - _source: - $ref: '#/components/schemas/_core.search:SourceConfig' - stored_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 - 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. + shard_size: + description: |- + The number of candidate terms produced by each shard. + By default, `shard_size` will be automatically estimated based on the number of shards and the `size` parameter. + type: number + show_term_doc_count_error: + description: Calculates the doc count error on per term basis. type: boolean - _common.aggregations:TopMetrics: - type: object - properties: - sort: - type: array - items: - oneOf: - - $ref: '#/components/schemas/_common:FieldValue' - - nullable: true - type: string - metrics: - type: object - additionalProperties: - oneOf: - - $ref: '#/components/schemas/_common:FieldValue' - - nullable: true - type: string - required: - - sort - - metrics - _common.aggregations:TopMetricsAggregate: - allOf: - - $ref: '#/components/schemas/_common.aggregations:AggregateBase' - - type: object - properties: - top: + size: + description: The number of term buckets should be returned out of the overall terms list. + type: number + terms: + description: The field from which to generate sets of terms. type: array items: - $ref: '#/components/schemas/_common.aggregations:TopMetrics' + $ref: '#/components/schemas/_common.aggregations:MultiTermLookup' required: - - top - _common.aggregations:TopMetricsAggregation: + - terms + _common.aggregations:MultiTermsBucket: allOf: - - $ref: '#/components/schemas/_common.aggregations:MetricAggregationBase' + - $ref: '#/components/schemas/_common.aggregations:MultiBucketBase' - type: object properties: - metrics: - description: The fields of the top document to return. - oneOf: - - $ref: '#/components/schemas/_common.aggregations:TopMetricsValue' - - type: array - items: - $ref: '#/components/schemas/_common.aggregations:TopMetricsValue' - size: - description: The number of top documents from which to return metrics. + key: + type: array + items: + $ref: '#/components/schemas/_common:FieldValue' + key_as_string: + type: string + doc_count_error_upper_bound: type: number - sort: - $ref: '#/components/schemas/_common:Sort' - _common.aggregations:TopMetricsValue: + required: + - key + _common.aggregations:MutualInformationHeuristic: type: object properties: - field: - $ref: '#/components/schemas/_common:Field' - required: - - field - _common.aggregations:UnmappedRareTermsAggregate: - allOf: - - $ref: '#/components/schemas/_common.aggregations:MultiBucketAggregateBaseVoid' - - type: object - _common.aggregations:UnmappedSamplerAggregate: + 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 + 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: allOf: - $ref: '#/components/schemas/_common.aggregations:SingleBucketAggregateBase' - type: object - _common.aggregations:UnmappedSignificantTermsAggregate: - allOf: - - $ref: '#/components/schemas/_common.aggregations:SignificantTermsAggregateBaseVoid' - - type: object - _common.aggregations:UnmappedTermsAggregate: - allOf: - - $ref: '#/components/schemas/_common.aggregations:TermsAggregateBaseVoid' - - type: object - _common.aggregations:ValueCountAggregate: + _common.aggregations:NestedAggregation: allOf: - - $ref: '#/components/schemas/_common.aggregations:SingleMetricAggregateBase' + - $ref: '#/components/schemas/_common.aggregations:BucketAggregationBase' - type: object - _common.aggregations:ValueCountAggregation: + properties: + path: + $ref: '#/components/schemas/_common:Field' + _common.aggregations:NormalizeAggregation: allOf: - - $ref: '#/components/schemas/_common.aggregations:FormattableMetricAggregation' + - $ref: '#/components/schemas/_common.aggregations:PipelineAggregationBase' - type: object - _common.aggregations:ValueType: + properties: + method: + $ref: '#/components/schemas/_common.aggregations:NormalizeMethod' + _common.aggregations:NormalizeMethod: type: string enum: - - string - - long - - double - - number - - date - - date_nanos - - ip - - numeric - - geo_point - - boolean - _common.aggregations:VariableWidthHistogramAggregate: - allOf: - - $ref: '#/components/schemas/_common.aggregations:MultiBucketAggregateBaseVariableWidthHistogramBucket' - - type: object - _common.aggregations:VariableWidthHistogramAggregation: - type: object - properties: - field: - $ref: '#/components/schemas/_common:Field' - buckets: - description: The target number of buckets. - type: number - shard_size: - description: |- - The number of buckets that the coordinating node will request from each shard. - Defaults to `buckets * 50`. - type: number - initial_buffer: - description: |- - 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: + - mean + - percent_of_sum + - rescale_0_1 + - rescale_0_100 + - softmax + - z-score + _common.aggregations:ParentAggregate: allOf: - - $ref: '#/components/schemas/_common.aggregations:MultiBucketBase' + - $ref: '#/components/schemas/_common.aggregations:SingleBucketAggregateBase' - type: object - properties: - min: - type: number - key: - type: number - max: - type: number - min_as_string: - type: string - key_as_string: - type: string - max_as_string: - type: string - required: - - min - - key - - max - _common.aggregations:WeightedAverageAggregation: + _common.aggregations:ParentAggregation: allOf: - - $ref: '#/components/schemas/_common.aggregations:Aggregation' + - $ref: '#/components/schemas/_common.aggregations:BucketAggregationBase' - type: object properties: - format: - description: A numeric response formatter. - type: string - value: - $ref: '#/components/schemas/_common.aggregations:WeightedAverageValue' - value_type: - $ref: '#/components/schemas/_common.aggregations:ValueType' - weight: - $ref: '#/components/schemas/_common.aggregations:WeightedAverageValue' - _common.aggregations:WeightedAverageValue: + type: + $ref: '#/components/schemas/_common:RelationName' + _common.aggregations:PercentageScoreHeuristic: type: object - properties: - 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: + _common.aggregations:PercentileRanksAggregation: allOf: - - $ref: '#/components/schemas/_common.aggregations:SingleMetricAggregateBase' + - $ref: '#/components/schemas/_common.aggregations:FormatMetricAggregationBase' - type: object - _common.analysis:Analyzer: - discriminator: - propertyName: type + properties: + keyed: + description: |- + By default, the aggregation associates a unique string key with each bucket and returns the ranges as a hash rather than an array. + Set to `false` to disable this behavior. + type: boolean + values: + description: An array of values for which to calculate the percentile ranks. + oneOf: + - type: array + items: + type: number + - nullable: true + type: string + hdr: + $ref: '#/components/schemas/_common.aggregations:HdrMethod' + tdigest: + $ref: '#/components/schemas/_common.aggregations:TDigest' + _common.aggregations:Percentiles: 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' - _common.analysis:AsciiFoldingTokenFilter: + - $ref: '#/components/schemas/_common.aggregations:KeyedPercentiles' + - type: array + items: + $ref: '#/components/schemas/_common.aggregations:ArrayPercentilesItem' + _common.aggregations:PercentilesAggregateBase: allOf: - - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' + - $ref: '#/components/schemas/_common.aggregations:AggregateBase' - type: object properties: - type: - type: string - enum: - - asciifolding - preserve_original: - $ref: '#/components/schemas/_common:Stringifiedboolean' + values: + $ref: '#/components/schemas/_common.aggregations:Percentiles' required: - - type - _common.analysis:CharFilter: - oneOf: - - type: string - - $ref: '#/components/schemas/_common.analysis:CharFilterDefinition' - _common.analysis:CharFilterBase: - type: object - properties: - version: - $ref: '#/components/schemas/_common:VersionString' - _common.analysis:CharFilterDefinition: - 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: + - values + _common.aggregations:PercentilesAggregation: allOf: - - $ref: '#/components/schemas/_common.analysis:TokenizerBase' + - $ref: '#/components/schemas/_common.aggregations:FormatMetricAggregationBase' - type: object properties: - type: - type: string - enum: - - char_group - tokenize_on_chars: + keyed: + description: |- + By default, the aggregation associates a unique string key with each bucket and returns the ranges as a hash rather than an array. + Set to `false` to disable this behavior. + type: boolean + percents: + description: The percentiles to calculate. type: array items: - type: string - max_token_length: - type: number - required: - - type - - tokenize_on_chars - _common.analysis:CommonGramsTokenFilter: + type: number + hdr: + $ref: '#/components/schemas/_common.aggregations:HdrMethod' + tdigest: + $ref: '#/components/schemas/_common.aggregations:TDigest' + _common.aggregations:PercentilesBucketAggregate: allOf: - - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' + - $ref: '#/components/schemas/_common.aggregations:PercentilesAggregateBase' + - type: object + _common.aggregations:PercentilesBucketAggregation: + allOf: + - $ref: '#/components/schemas/_common.aggregations:PipelineAggregationBase' - type: object properties: - type: - type: string - enum: - - common_grams - common_words: + percents: + description: The list of percentiles to calculate. type: array items: - type: string - common_words_path: - type: string - ignore_case: - type: boolean - query_mode: - type: boolean - required: - - type - _common.analysis:CompoundWordTokenFilterBase: + type: number + _common.aggregations:PipelineAggregationBase: allOf: - - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' + - $ref: '#/components/schemas/_common.aggregations:BucketPathAggregation' - type: object properties: - hyphenation_patterns_path: - type: string - max_subword_size: - type: number - min_subword_size: - type: number - min_word_size: - type: number - only_longest_match: - type: boolean - word_list: - type: array - items: - type: string - word_list_path: + format: + description: |- + `DecimalFormat` pattern for the output value. + If specified, the formatted value is returned in the aggregation's `value_as_string` property. type: string - _common.analysis:ConditionTokenFilter: + gap_policy: + $ref: '#/components/schemas/_common.aggregations:GapPolicy' + _common.aggregations:RangeAggregate: allOf: - - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' + - $ref: '#/components/schemas/_common.aggregations:MultiBucketAggregateBaseRangeBucket' + - type: object + _common.aggregations:RangeAggregation: + allOf: + - $ref: '#/components/schemas/_common.aggregations:BucketAggregationBase' - type: object properties: - type: - type: string - enum: - - condition - filter: + field: + $ref: '#/components/schemas/_common:Field' + missing: + description: |- + The value to apply to documents that do not have a value. + By default, documents without a value are ignored. + type: number + ranges: + description: An array of ranges used to bucket documents. type: array items: - type: string + $ref: '#/components/schemas/_common.aggregations:AggregationRange' script: $ref: '#/components/schemas/_common:Script' - required: - - type - - filter - - script - _common.analysis:CustomAnalyzer: - type: object - properties: - type: - type: string - enum: - - custom - char_filter: - type: array - items: - type: string - filter: - type: array - items: - type: string - position_increment_gap: - type: number - position_offset_gap: - type: number - tokenizer: - type: string - required: - - type - - tokenizer - _common.analysis:CustomNormalizer: - type: object - properties: - type: - type: string - enum: - - custom - char_filter: - type: array - items: - type: string - filter: - type: array - items: - type: string - required: - - type - _common.analysis:DelimitedPayloadEncoding: - type: string - enum: - - int - - float - - identity - _common.analysis:DelimitedPayloadTokenFilter: + 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: allOf: - - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' + - $ref: '#/components/schemas/_common.aggregations:MultiBucketBase' - type: object properties: - type: + from: + type: number + to: + type: number + from_as_string: type: string - enum: - - delimited_payload - delimiter: + to_as_string: type: string - encoding: - $ref: '#/components/schemas/_common.analysis:DelimitedPayloadEncoding' - required: - - type - _common.analysis:DictionaryDecompounderTokenFilter: + key: + description: The bucket key. Present if the aggregation is _not_ keyed + type: string + _common.aggregations:RareTermsAggregation: allOf: - - $ref: '#/components/schemas/_common.analysis:CompoundWordTokenFilterBase' + - $ref: '#/components/schemas/_common.aggregations:BucketAggregationBase' - type: object properties: - type: + exclude: + $ref: '#/components/schemas/_common.aggregations:TermsExclude' + field: + $ref: '#/components/schemas/_common:Field' + include: + $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' + precision: + description: |- + The precision of the internal CuckooFilters. + Smaller precision leads to better approximation, but higher memory usage. + type: number + value_type: + type: string + _common.aggregations:RateAggregate: + allOf: + - $ref: '#/components/schemas/_common.aggregations:AggregateBase' + - type: object + properties: + value: + type: number + value_as_string: type: string - enum: - - dictionary_decompounder required: - - type - _common.analysis:DutchAnalyzer: + - value + _common.aggregations:RateAggregation: + allOf: + - $ref: '#/components/schemas/_common.aggregations:FormatMetricAggregationBase' + - type: object + properties: + unit: + $ref: '#/components/schemas/_common.aggregations:CalendarInterval' + mode: + $ref: '#/components/schemas/_common.aggregations:RateMode' + _common.aggregations:RateMode: + type: string + enum: + - sum + - value_count + _common.aggregations:RegressionInferenceOptions: type: object properties: - type: - type: string - enum: - - dutch - stopwords: - $ref: '#/components/schemas/_common.analysis:StopWords' - required: - - type - _common.analysis:EdgeNGramSide: + results_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: + allOf: + - $ref: '#/components/schemas/_common.aggregations:SingleBucketAggregateBase' + - type: object + _common.aggregations:ReverseNestedAggregation: + allOf: + - $ref: '#/components/schemas/_common.aggregations:BucketAggregationBase' + - type: object + properties: + path: + $ref: '#/components/schemas/_common:Field' + _common.aggregations:SamplerAggregate: + allOf: + - $ref: '#/components/schemas/_common.aggregations:SingleBucketAggregateBase' + - type: object + _common.aggregations:SamplerAggregation: + allOf: + - $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: type: string enum: - - front - - back - _common.analysis:EdgeNGramTokenFilter: + - bytes_hash + - global_ordinals + - map + _common.aggregations:ScriptedHeuristic: + type: object + properties: + script: + $ref: '#/components/schemas/_common:Script' + required: + - script + _common.aggregations:ScriptedMetricAggregate: allOf: - - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' + - $ref: '#/components/schemas/_common.aggregations:AggregateBase' - type: object properties: - type: - type: string - enum: - - edge_ngram - max_gram: - type: number - min_gram: - type: number - side: - $ref: '#/components/schemas/_common.analysis:EdgeNGramSide' - preserve_original: - $ref: '#/components/schemas/_common:Stringifiedboolean' + value: + type: object required: - - type - _common.analysis:EdgeNGramTokenizer: + - value + _common.aggregations:ScriptedMetricAggregation: allOf: - - $ref: '#/components/schemas/_common.analysis:TokenizerBase' + - $ref: '#/components/schemas/_common.aggregations:MetricAggregationBase' - type: object properties: - type: - type: string - enum: - - edge_ngram - custom_token_chars: - type: string - max_gram: - type: number - min_gram: - type: number - token_chars: - type: array - items: - $ref: '#/components/schemas/_common.analysis:TokenChar' - required: - - type - - max_gram - - min_gram - - token_chars - _common.analysis:ElisionTokenFilter: + combine_script: + $ref: '#/components/schemas/_common:Script' + init_script: + $ref: '#/components/schemas/_common:Script' + map_script: + $ref: '#/components/schemas/_common:Script' + params: + description: |- + A global object with script parameters for `init`, `map` and `combine` scripts. + It is shared between the scripts. + type: object + additionalProperties: + type: object + reduce_script: + $ref: '#/components/schemas/_common:Script' + _common.aggregations:SerialDifferencingAggregation: allOf: - - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' + - $ref: '#/components/schemas/_common.aggregations:PipelineAggregationBase' - type: object properties: - type: - type: string - enum: - - elision - articles: - type: array - items: - type: string - articles_path: - type: string - articles_case: - $ref: '#/components/schemas/_common:Stringifiedboolean' - required: - - type - _common.analysis:FingerprintAnalyzer: - type: object - properties: - type: - type: string - enum: - - fingerprint - version: - $ref: '#/components/schemas/_common:VersionString' - max_output_size: - type: number - preserve_original: - type: boolean - separator: - type: string - stopwords: - $ref: '#/components/schemas/_common.analysis:StopWords' - stopwords_path: - type: string - required: - - type - - max_output_size - - preserve_original - - separator - _common.analysis:FingerprintTokenFilter: + lag: + description: |- + The historical bucket to subtract from the current value. + Must be a positive, non-zero integer. + type: number + _common.aggregations:SignificantLongTermsAggregate: allOf: - - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' + - $ref: '#/components/schemas/_common.aggregations:SignificantTermsAggregateBaseSignificantLongTermsBucket' + - type: object + _common.aggregations:SignificantLongTermsBucket: + allOf: + - $ref: '#/components/schemas/_common.aggregations:SignificantTermsBucketBase' - type: object properties: - type: - type: string - enum: - - fingerprint - max_output_size: + key: type: number - separator: + key_as_string: type: string required: - - type - _common.analysis:HtmlStripCharFilter: + - key + _common.aggregations:SignificantStringTermsAggregate: allOf: - - $ref: '#/components/schemas/_common.analysis:CharFilterBase' + - $ref: '#/components/schemas/_common.aggregations:SignificantTermsAggregateBaseSignificantStringTermsBucket' + - type: object + _common.aggregations:SignificantStringTermsBucket: + allOf: + - $ref: '#/components/schemas/_common.aggregations:SignificantTermsBucketBase' - type: object properties: - type: + key: type: string - enum: - - html_strip required: - - type - _common.analysis:HunspellTokenFilter: + - key + _common.aggregations:SignificantTermsAggregateBaseSignificantLongTermsBucket: allOf: - - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' + - $ref: '#/components/schemas/_common.aggregations:MultiBucketAggregateBaseSignificantLongTermsBucket' - type: object properties: - type: - type: string - enum: - - hunspell - dedup: - type: boolean - dictionary: - type: string - locale: - type: string - longest_only: - type: boolean - required: - - type - - locale - _common.analysis:HyphenationDecompounderTokenFilter: + bg_count: + type: number + doc_count: + type: number + _common.aggregations:SignificantTermsAggregateBaseSignificantStringTermsBucket: allOf: - - $ref: '#/components/schemas/_common.analysis:CompoundWordTokenFilterBase' + - $ref: '#/components/schemas/_common.aggregations:MultiBucketAggregateBaseSignificantStringTermsBucket' - type: object properties: - type: - type: string - enum: - - hyphenation_decompounder - required: - - type - _common.analysis:IcuAnalyzer: - type: object - properties: - type: - type: string - enum: - - icu_analyzer - method: - $ref: '#/components/schemas/_common.analysis:IcuNormalizationType' - mode: - $ref: '#/components/schemas/_common.analysis:IcuNormalizationMode' - required: - - type - - method - - mode - _common.analysis:IcuCollationAlternate: - type: string - enum: - - shifted - - non-ignorable - _common.analysis:IcuCollationCaseFirst: - type: string - enum: - - lower - - upper - _common.analysis:IcuCollationDecomposition: - type: string - enum: - - no - - identical - _common.analysis:IcuCollationStrength: - type: string - enum: - - primary - - secondary - - tertiary - - quaternary - - identical - _common.analysis:IcuCollationTokenFilter: + bg_count: + type: number + doc_count: + type: number + _common.aggregations:SignificantTermsAggregateBaseVoid: allOf: - - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' + - $ref: '#/components/schemas/_common.aggregations:MultiBucketAggregateBaseVoid' - type: object properties: - type: - type: string - enum: - - icu_collation - alternate: - $ref: '#/components/schemas/_common.analysis:IcuCollationAlternate' - caseFirst: - $ref: '#/components/schemas/_common.analysis:IcuCollationCaseFirst' - caseLevel: - type: boolean - country: - type: string - decomposition: - $ref: '#/components/schemas/_common.analysis:IcuCollationDecomposition' - hiraganaQuaternaryMode: - type: boolean - language: - type: string - numeric: - type: boolean - rules: - type: string - strength: - $ref: '#/components/schemas/_common.analysis:IcuCollationStrength' - variableTop: - type: string - variant: - type: string - required: - - type - _common.analysis:IcuFoldingTokenFilter: + bg_count: + type: number + doc_count: + type: number + _common.aggregations:SignificantTermsAggregation: allOf: - - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' + - $ref: '#/components/schemas/_common.aggregations:BucketAggregationBase' - type: object properties: - type: - type: string - enum: - - icu_folding - unicode_set_filter: - type: string - required: - - type - - unicode_set_filter - _common.analysis:IcuNormalizationCharFilter: + background_filter: + $ref: '#/components/schemas/_common.query_dsl:QueryContainer' + chi_square: + $ref: '#/components/schemas/_common.aggregations:ChiSquareHeuristic' + exclude: + $ref: '#/components/schemas/_common.aggregations:TermsExclude' + execution_hint: + $ref: '#/components/schemas/_common.aggregations:TermsAggregationExecutionHint' + field: + $ref: '#/components/schemas/_common:Field' + gnd: + $ref: '#/components/schemas/_common.aggregations:GoogleNormalizedDistanceHeuristic' + include: + $ref: '#/components/schemas/_common.aggregations:TermsInclude' + jlh: + $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' + percentage: + $ref: '#/components/schemas/_common.aggregations:PercentageScoreHeuristic' + script_heuristic: + $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`. + Terms will only be considered if their local shard frequency within the set is higher than the `shard_min_doc_count`. + type: number + shard_size: + description: |- + Can be used to control the volumes of candidate terms produced by each shard. + By default, `shard_size` will be automatically estimated based on the number of shards and the `size` parameter. + type: number + size: + description: The number of buckets returned out of the overall terms list. + type: number + _common.aggregations:SignificantTermsBucketBase: allOf: - - $ref: '#/components/schemas/_common.analysis:CharFilterBase' + - $ref: '#/components/schemas/_common.aggregations:MultiBucketBase' - type: object properties: - type: - type: string - enum: - - icu_normalizer - mode: - $ref: '#/components/schemas/_common.analysis:IcuNormalizationMode' - name: - $ref: '#/components/schemas/_common.analysis:IcuNormalizationType' + score: + type: number + bg_count: + type: number required: - - type - _common.analysis:IcuNormalizationMode: - type: string - enum: - - decompose - - compose - _common.analysis:IcuNormalizationTokenFilter: + - bg_count + - score + _common.aggregations:SignificantTextAggregation: allOf: - - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' + - $ref: '#/components/schemas/_common.aggregations:BucketAggregationBase' - type: object properties: - type: - type: string - enum: - - icu_normalizer - name: - $ref: '#/components/schemas/_common.analysis:IcuNormalizationType' - required: - - type - - name - _common.analysis:IcuNormalizationType: - type: string - enum: - - nfc - - nfkc - - nfkc_cf - _common.analysis:IcuTokenizer: + background_filter: + $ref: '#/components/schemas/_common.query_dsl:QueryContainer' + chi_square: + $ref: '#/components/schemas/_common.aggregations:ChiSquareHeuristic' + exclude: + $ref: '#/components/schemas/_common.aggregations:TermsExclude' + execution_hint: + $ref: '#/components/schemas/_common.aggregations:TermsAggregationExecutionHint' + 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' + include: + $ref: '#/components/schemas/_common.aggregations:TermsInclude' + jlh: + $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' + percentage: + $ref: '#/components/schemas/_common.aggregations:PercentageScoreHeuristic' + script_heuristic: + $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. + 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: + description: |- + The number of candidate terms produced by each shard. + By default, `shard_size` will be automatically estimated based on the number of shards and the `size` parameter. + type: number + size: + description: The number of buckets returned out of the overall terms list. + type: number + source_fields: + $ref: '#/components/schemas/_common:Fields' + _common.aggregations:SimpleMovingAverageAggregation: allOf: - - $ref: '#/components/schemas/_common.analysis:TokenizerBase' + - $ref: '#/components/schemas/_common.aggregations:MovingAverageAggregationBase' - type: object properties: - type: + model: type: string enum: - - icu_tokenizer - rule_files: - type: string + - simple + settings: + $ref: '#/components/schemas/_common:EmptyObject' required: - - type - - rule_files - _common.analysis:IcuTransformDirection: - type: string - enum: - - forward - - reverse - _common.analysis:IcuTransformTokenFilter: + - model + - settings + _common.aggregations:SimpleValueAggregate: allOf: - - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' + - $ref: '#/components/schemas/_common.aggregations:SingleMetricAggregateBase' - type: object - properties: - type: - type: string - enum: - - icu_transform - dir: - $ref: '#/components/schemas/_common.analysis:IcuTransformDirection' - id: - type: string - required: - - type - - id - _common.analysis:KStemTokenFilter: + _common.aggregations:SingleBucketAggregateBase: allOf: - - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' + - $ref: '#/components/schemas/_common.aggregations:AggregateBase' - type: object properties: - type: - type: string - enum: - - kstem + doc_count: + type: number required: - - type - _common.analysis:KeepTypesMode: - type: string - enum: - - include - - exclude - _common.analysis:KeepTypesTokenFilter: + - doc_count + _common.aggregations:SingleMetricAggregateBase: allOf: - - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' + - $ref: '#/components/schemas/_common.aggregations:AggregateBase' - type: object properties: - type: + value: + description: |- + The metric value. A missing value generally means that there was no data to aggregate, + unless specified otherwise. + oneOf: + - type: number + - nullable: true + type: string + value_as_string: type: string - enum: - - keep_types - mode: - $ref: '#/components/schemas/_common.analysis:KeepTypesMode' - types: - type: array - items: - type: string required: - - type - _common.analysis:KeepWordsTokenFilter: - allOf: - - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' - - type: object - properties: - type: + - value + _common.aggregations:StandardDeviationBounds: + type: object + properties: + upper: + oneOf: + - type: number + - nullable: true type: string - enum: - - keep - keep_words: - type: array - items: - type: string - keep_words_case: - type: boolean - keep_words_path: + lower: + oneOf: + - type: number + - nullable: true type: string - required: - - type - _common.analysis:KeywordAnalyzer: + upper_population: + oneOf: + - type: number + - nullable: true + type: string + lower_population: + oneOf: + - type: number + - nullable: true + type: string + upper_sampling: + oneOf: + - type: number + - nullable: true + type: string + lower_sampling: + oneOf: + - type: number + - nullable: true + type: string + required: + - lower + - lower_population + - lower_sampling + - upper + - upper_population + - upper_sampling + _common.aggregations:StandardDeviationBoundsAsString: type: object properties: - type: + upper: + type: string + lower: + type: string + upper_population: + type: string + lower_population: + type: string + upper_sampling: + type: string + lower_sampling: type: string - enum: - - keyword - version: - $ref: '#/components/schemas/_common:VersionString' required: - - type - _common.analysis:KeywordMarkerTokenFilter: + - lower + - lower_population + - lower_sampling + - upper + - upper_population + - upper_sampling + _common.aggregations:StatsAggregate: allOf: - - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' + - $ref: '#/components/schemas/_common.aggregations:AggregateBase' - type: object properties: - type: + count: + type: number + min: + oneOf: + - type: number + - nullable: true + type: string + max: + oneOf: + - type: number + - nullable: true + type: string + avg: + oneOf: + - type: number + - nullable: true + type: string + sum: + type: number + min_as_string: type: string - enum: - - keyword_marker - ignore_case: - type: boolean - keywords: - type: array - items: - type: string - keywords_path: + max_as_string: type: string - keywords_pattern: + avg_as_string: + type: string + sum_as_string: type: string required: - - type - _common.analysis:KeywordTokenizer: + - avg + - count + - max + - min + - sum + _common.aggregations:StatsAggregation: allOf: - - $ref: '#/components/schemas/_common.analysis:TokenizerBase' + - $ref: '#/components/schemas/_common.aggregations:FormatMetricAggregationBase' - type: object - properties: - type: - type: string - enum: - - keyword - buffer_size: - type: number - required: - - type - - buffer_size - _common.analysis:KuromojiAnalyzer: - type: object - properties: - type: - type: string - enum: - - kuromoji - mode: - $ref: '#/components/schemas/_common.analysis:KuromojiTokenizationMode' - user_dictionary: - type: string - required: - - type - - mode - _common.analysis:KuromojiIterationMarkCharFilter: + _common.aggregations:StatsBucketAggregate: allOf: - - $ref: '#/components/schemas/_common.analysis:CharFilterBase' + - $ref: '#/components/schemas/_common.aggregations:StatsAggregate' - type: object - properties: - type: - type: string - enum: - - kuromoji_iteration_mark - normalize_kana: - type: boolean - normalize_kanji: - type: boolean - required: - - type - - normalize_kana - - normalize_kanji - _common.analysis:KuromojiPartOfSpeechTokenFilter: + _common.aggregations:StatsBucketAggregation: allOf: - - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' + - $ref: '#/components/schemas/_common.aggregations:PipelineAggregationBase' - type: object - properties: - type: - type: string - enum: - - kuromoji_part_of_speech - stoptags: - type: array - items: - type: string - required: - - type - - stoptags - _common.analysis:KuromojiReadingFormTokenFilter: + _common.aggregations:StringRareTermsAggregate: allOf: - - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' + - $ref: '#/components/schemas/_common.aggregations:MultiBucketAggregateBaseStringRareTermsBucket' - type: object - properties: - type: - type: string - enum: - - kuromoji_readingform - use_romaji: - type: boolean - required: - - type - - use_romaji - _common.analysis:KuromojiStemmerTokenFilter: + _common.aggregations:StringRareTermsBucket: allOf: - - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' + - $ref: '#/components/schemas/_common.aggregations:MultiBucketBase' - type: object properties: - type: + key: type: string - enum: - - kuromoji_stemmer - minimum_length: - type: number required: - - type - - minimum_length - _common.analysis:KuromojiTokenizationMode: - type: string - enum: - - normal - - search - - extended - _common.analysis:KuromojiTokenizer: + - key + _common.aggregations:StringStatsAggregate: allOf: - - $ref: '#/components/schemas/_common.analysis:TokenizerBase' + - $ref: '#/components/schemas/_common.aggregations:AggregateBase' - type: object properties: - type: - type: string - enum: - - kuromoji_tokenizer - discard_punctuation: - type: boolean - mode: - $ref: '#/components/schemas/_common.analysis:KuromojiTokenizationMode' - nbest_cost: + count: type: number - nbest_examples: + min_length: + oneOf: + - type: number + - nullable: true + type: string + max_length: + oneOf: + - type: number + - nullable: true + type: string + avg_length: + oneOf: + - type: number + - nullable: true + type: string + entropy: + oneOf: + - type: number + - nullable: true + type: string + distribution: + oneOf: + - type: object + additionalProperties: + type: number + - nullable: true + type: string + min_length_as_string: type: string - user_dictionary: + max_length_as_string: + type: string + avg_length_as_string: type: string - user_dictionary_rules: - type: array - items: - type: string - discard_compound_token: - type: boolean required: - - type - - mode - _common.analysis:Language: - type: string - enum: - - Arabic - - Armenian - - Basque - - Brazilian - - Bulgarian - - Catalan - - Chinese - - Cjk - - Czech - - Danish - - Dutch - - English - - Estonian - - Finnish - - French - - Galician - - German - - Greek - - Hindi - - Hungarian - - Indonesian - - Irish - - Italian - - Latvian - - Norwegian - - Persian - - Portuguese - - Romanian - - Russian - - Sorani - - Spanish - - Swedish - - Turkish - - Thai - _common.analysis:LanguageAnalyzer: - type: object - properties: - type: - type: string - enum: - - language - version: - $ref: '#/components/schemas/_common:VersionString' - language: - $ref: '#/components/schemas/_common.analysis:Language' - stem_exclusion: - type: array - items: - type: string - stopwords: - $ref: '#/components/schemas/_common.analysis:StopWords' - stopwords_path: - type: string - required: - - type - - language - - stem_exclusion - _common.analysis:LengthTokenFilter: + - avg_length + - count + - entropy + - max_length + - min_length + _common.aggregations:StringStatsAggregation: allOf: - - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' + - $ref: '#/components/schemas/_common.aggregations:MetricAggregationBase' - type: object properties: - type: - type: string - enum: - - length - max: - type: number - min: - type: number - required: - - type - _common.analysis:LetterTokenizer: + show_distribution: + description: Shows the probability distribution for all characters. + type: boolean + _common.aggregations:StringTermsAggregate: allOf: - - $ref: '#/components/schemas/_common.analysis:TokenizerBase' + - $ref: '#/components/schemas/_common.aggregations:TermsAggregateBaseStringTermsBucket' - type: object - properties: - type: - type: string - enum: - - letter - required: - - type - _common.analysis:LimitTokenCountTokenFilter: + _common.aggregations:StringTermsBucket: allOf: - - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' + - $ref: '#/components/schemas/_common.aggregations:TermsBucketBase' - type: object properties: - type: - type: string - enum: - - limit - consume_all_tokens: - type: boolean - max_token_count: - $ref: '#/components/schemas/_common:Stringifiedinteger' + key: + $ref: '#/components/schemas/_common:FieldValue' required: - - type - _common.analysis:LowercaseNormalizer: + - key + _common.aggregations:SumAggregate: + allOf: + - $ref: '#/components/schemas/_common.aggregations:SingleMetricAggregateBase' + - type: object + _common.aggregations:SumAggregation: + allOf: + - $ref: '#/components/schemas/_common.aggregations:FormatMetricAggregationBase' + - type: object + _common.aggregations:SumBucketAggregation: + allOf: + - $ref: '#/components/schemas/_common.aggregations:PipelineAggregationBase' + - type: object + _common.aggregations:TDigest: type: object properties: - type: - type: string - enum: - - lowercase - required: - - type - _common.analysis:LowercaseTokenFilter: + 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: allOf: - - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' + - $ref: '#/components/schemas/_common.aggregations:PercentilesAggregateBase' + - type: object + _common.aggregations:TDigestPercentilesAggregate: + allOf: + - $ref: '#/components/schemas/_common.aggregations:PercentilesAggregateBase' + - type: object + _common.aggregations:TermsAggregateBaseDoubleTermsBucket: + allOf: + - $ref: '#/components/schemas/_common.aggregations:MultiBucketAggregateBaseDoubleTermsBucket' - type: object properties: - type: - type: string - enum: - - lowercase - language: - type: string - required: - - type - _common.analysis:LowercaseTokenizer: + doc_count_error_upper_bound: + type: number + sum_other_doc_count: + type: number + _common.aggregations:TermsAggregateBaseLongTermsBucket: allOf: - - $ref: '#/components/schemas/_common.analysis:TokenizerBase' + - $ref: '#/components/schemas/_common.aggregations:MultiBucketAggregateBaseLongTermsBucket' - type: object properties: - type: - type: string - enum: - - lowercase - required: - - type - _common.analysis:MappingCharFilter: + doc_count_error_upper_bound: + type: number + sum_other_doc_count: + type: number + _common.aggregations:TermsAggregateBaseMultiTermsBucket: allOf: - - $ref: '#/components/schemas/_common.analysis:CharFilterBase' + - $ref: '#/components/schemas/_common.aggregations:MultiBucketAggregateBaseMultiTermsBucket' - type: object properties: - type: - type: string - enum: - - mapping - mappings: - type: array - items: - type: string - mappings_path: - type: string - required: - - type - _common.analysis:MultiplexerTokenFilter: + doc_count_error_upper_bound: + type: number + sum_other_doc_count: + type: number + _common.aggregations:TermsAggregateBaseStringTermsBucket: allOf: - - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' + - $ref: '#/components/schemas/_common.aggregations:MultiBucketAggregateBaseStringTermsBucket' - type: object properties: - type: - type: string - enum: - - multiplexer - filters: - type: array - items: - type: string - preserve_original: - $ref: '#/components/schemas/_common:Stringifiedboolean' - required: - - type - - filters - _common.analysis:NGramTokenFilter: + doc_count_error_upper_bound: + type: number + sum_other_doc_count: + type: number + _common.aggregations:TermsAggregateBaseVoid: allOf: - - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' + - $ref: '#/components/schemas/_common.aggregations:MultiBucketAggregateBaseVoid' - type: object properties: - type: - type: string - enum: - - ngram - max_gram: + doc_count_error_upper_bound: type: number - min_gram: + sum_other_doc_count: type: number - preserve_original: - $ref: '#/components/schemas/_common:Stringifiedboolean' - required: - - type - _common.analysis:NGramTokenizer: + _common.aggregations:TermsAggregation: allOf: - - $ref: '#/components/schemas/_common.analysis:TokenizerBase' + - $ref: '#/components/schemas/_common.aggregations:BucketAggregationBase' - type: object properties: - type: - type: string - enum: - - ngram - custom_token_chars: + collect_mode: + $ref: '#/components/schemas/_common.aggregations:TermsAggregationCollectMode' + exclude: + $ref: '#/components/schemas/_common.aggregations:TermsExclude' + execution_hint: + $ref: '#/components/schemas/_common.aggregations:TermsAggregationExecutionHint' + field: + $ref: '#/components/schemas/_common:Field' + include: + $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' + missing_order: + $ref: '#/components/schemas/_common.aggregations:MissingOrder' + missing_bucket: + type: boolean + value_type: + description: Coerced unmapped fields into the specified type. type: string - max_gram: + order: + $ref: '#/components/schemas/_common.aggregations:AggregateOrder' + script: + $ref: '#/components/schemas/_common:Script' + shard_size: + description: |- + The number of candidate terms produced by each shard. + By default, `shard_size` will be automatically estimated based on the number of shards and the `size` parameter. type: number - min_gram: + show_term_doc_count_error: + description: Set to `true` to return the `doc_count_error_upper_bound`, which is an upper bound to the error on the `doc_count` returned by each shard. + type: boolean + size: + description: The number of buckets returned out of the overall terms list. type: number - token_chars: - type: array - items: - $ref: '#/components/schemas/_common.analysis:TokenChar' - required: - - type - - max_gram - - min_gram - - token_chars - _common.analysis:NoriAnalyzer: - type: object - properties: - type: - type: string - enum: - - nori - version: - $ref: '#/components/schemas/_common:VersionString' - decompound_mode: - $ref: '#/components/schemas/_common.analysis:NoriDecompoundMode' - stoptags: - type: array - items: - type: string - user_dictionary: - type: string - required: - - type - _common.analysis:NoriDecompoundMode: + format: + type: string + _common.aggregations:TermsAggregationCollectMode: type: string enum: - - discard - - none - - mixed - _common.analysis:NoriPartOfSpeechTokenFilter: + - breadth_first + - depth_first + _common.aggregations:TermsAggregationExecutionHint: + type: string + enum: + - global_ordinals + - global_ordinals_hash + - global_ordinals_low_cardinality + - map + _common.aggregations:TermsBucketBase: allOf: - - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' + - $ref: '#/components/schemas/_common.aggregations:MultiBucketBase' - type: object properties: - type: - type: string - enum: - - nori_part_of_speech - stoptags: - type: array - items: - type: string - required: - - type - _common.analysis:NoriTokenizer: + doc_count_error: + type: number + _common.aggregations:TermsExclude: + oneOf: + - type: string + - type: array + items: + type: string + _common.aggregations:TermsInclude: + oneOf: + - type: string + - type: array + items: + type: string + - $ref: '#/components/schemas/_common.aggregations:TermsPartition' + _common.aggregations:TermsPartition: + type: object + properties: + num_partitions: + description: The number of partitions. + type: number + partition: + description: The partition number for this request. + type: number + required: + - num_partitions + - partition + _common.aggregations:TestPopulation: + type: object + properties: + field: + $ref: '#/components/schemas/_common:Field' + script: + $ref: '#/components/schemas/_common:Script' + filter: + $ref: '#/components/schemas/_common.query_dsl:QueryContainer' + required: + - field + _common.aggregations:TopHitsAggregate: allOf: - - $ref: '#/components/schemas/_common.analysis:TokenizerBase' + - $ref: '#/components/schemas/_common.aggregations:AggregateBase' - type: object properties: - type: - type: string - enum: - - nori_tokenizer - decompound_mode: - $ref: '#/components/schemas/_common.analysis:NoriDecompoundMode' - discard_punctuation: - type: boolean - user_dictionary: - type: string - user_dictionary_rules: - type: array - items: - type: string + hits: + $ref: '#/components/schemas/_core.search:HitsMetadata' required: - - type - _common.analysis:Normalizer: - discriminator: - propertyName: type - oneOf: - - $ref: '#/components/schemas/_common.analysis:LowercaseNormalizer' - - $ref: '#/components/schemas/_common.analysis:CustomNormalizer' - _common.analysis:PathHierarchyTokenizer: + - hits + _common.aggregations:TopHitsAggregation: allOf: - - $ref: '#/components/schemas/_common.analysis:TokenizerBase' + - $ref: '#/components/schemas/_common.aggregations:MetricAggregationBase' - type: object properties: - type: - type: string - enum: - - path_hierarchy - buffer_size: - $ref: '#/components/schemas/_common:Stringifiedinteger' - delimiter: - type: string - replacement: - type: string - reverse: - $ref: '#/components/schemas/_common:Stringifiedboolean' - skip: - $ref: '#/components/schemas/_common:Stringifiedinteger' - required: - - type - - buffer_size - - delimiter - - reverse - - skip - _common.analysis:PatternAnalyzer: + docvalue_fields: + $ref: '#/components/schemas/_common:Fields' + explain: + description: If `true`, returns detailed information about score computation as part of a hit. + type: boolean + from: + description: Starting document offset. + type: number + 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' + size: + description: The maximum number of top matching hits to return per bucket. + type: number + sort: + $ref: '#/components/schemas/_common:Sort' + _source: + $ref: '#/components/schemas/_core.search:SourceConfig' + stored_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 + 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 + _common.aggregations:TopMetrics: type: object properties: - type: - type: string - enum: - - pattern - version: - $ref: '#/components/schemas/_common:VersionString' - flags: - type: string - lowercase: - type: boolean - pattern: - type: string - stopwords: - $ref: '#/components/schemas/_common.analysis:StopWords' + sort: + type: array + items: + oneOf: + - $ref: '#/components/schemas/_common:FieldValue' + - nullable: true + type: string + metrics: + type: object + additionalProperties: + oneOf: + - $ref: '#/components/schemas/_common:FieldValue' + - nullable: true + type: string required: - - type - - pattern - _common.analysis:PatternCaptureTokenFilter: + - metrics + - sort + _common.aggregations:TopMetricsAggregate: allOf: - - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' + - $ref: '#/components/schemas/_common.aggregations:AggregateBase' - type: object properties: - type: - type: string - enum: - - pattern_capture - patterns: + top: type: array items: - type: string - preserve_original: - $ref: '#/components/schemas/_common:Stringifiedboolean' + $ref: '#/components/schemas/_common.aggregations:TopMetrics' required: - - type - - patterns - _common.analysis:PatternReplaceCharFilter: + - top + _common.aggregations:TopMetricsAggregation: allOf: - - $ref: '#/components/schemas/_common.analysis:CharFilterBase' + - $ref: '#/components/schemas/_common.aggregations:MetricAggregationBase' - type: object properties: - type: - type: string - enum: - - pattern_replace - flags: - type: string - pattern: - type: string - replacement: - type: string - required: - - type - - pattern - _common.analysis:PatternReplaceTokenFilter: + metrics: + description: The fields of the top document to return. + oneOf: + - $ref: '#/components/schemas/_common.aggregations:TopMetricsValue' + - type: array + items: + $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: + type: object + properties: + field: + $ref: '#/components/schemas/_common:Field' + required: + - field + _common.aggregations:TTestAggregate: allOf: - - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' + - $ref: '#/components/schemas/_common.aggregations:AggregateBase' - type: object properties: - type: - type: string - enum: - - pattern_replace - all: - type: boolean - flags: - type: string - pattern: - type: string - replacement: + value: + oneOf: + - type: number + - nullable: true + type: string + value_as_string: type: string required: - - type - - pattern - _common.analysis:PatternTokenizer: + - value + _common.aggregations:TTestAggregation: allOf: - - $ref: '#/components/schemas/_common.analysis:TokenizerBase' + - $ref: '#/components/schemas/_common.aggregations:Aggregation' - type: object properties: + a: + $ref: '#/components/schemas/_common.aggregations:TestPopulation' + b: + $ref: '#/components/schemas/_common.aggregations:TestPopulation' type: - type: string - enum: - - pattern - flags: - type: string - group: - type: number - pattern: - type: string - required: - - type - _common.analysis:PhoneticEncoder: - type: string - enum: - - metaphone - - double_metaphone - - soundex - - refined_soundex - - caverphone1 - - caverphone2 - - cologne - - nysiis - - koelnerphonetik - - haasephonetik - - beider_morse - - daitch_mokotoff - _common.analysis:PhoneticLanguage: - type: string - enum: - - any - - common - - cyrillic - - english - - french - - german - - hebrew - - hungarian - - polish - - romanian - - russian - - spanish - _common.analysis:PhoneticNameType: - type: string - enum: - - generic - - ashkenazi - - sephardic - _common.analysis:PhoneticRuleType: + $ref: '#/components/schemas/_common.aggregations:TTestType' + _common.aggregations:TTestType: type: string enum: - - approx - - exact - _common.analysis:PhoneticTokenFilter: + - heteroscedastic + - homoscedastic + - paired + _common.aggregations:UnmappedRareTermsAggregate: allOf: - - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' + - $ref: '#/components/schemas/_common.aggregations:MultiBucketAggregateBaseVoid' - type: object - properties: - type: - type: string - enum: - - phonetic - encoder: - $ref: '#/components/schemas/_common.analysis:PhoneticEncoder' - languageset: - type: array - items: - $ref: '#/components/schemas/_common.analysis:PhoneticLanguage' - max_code_len: - type: number - name_type: - $ref: '#/components/schemas/_common.analysis:PhoneticNameType' - replace: - type: boolean - rule_type: - $ref: '#/components/schemas/_common.analysis:PhoneticRuleType' - required: - - type - - encoder - - languageset - - name_type - - rule_type - _common.analysis:PorterStemTokenFilter: + _common.aggregations:UnmappedSamplerAggregate: allOf: - - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' + - $ref: '#/components/schemas/_common.aggregations:SingleBucketAggregateBase' + - type: object + _common.aggregations:UnmappedSignificantTermsAggregate: + allOf: + - $ref: '#/components/schemas/_common.aggregations:SignificantTermsAggregateBaseVoid' + - type: object + _common.aggregations:UnmappedTermsAggregate: + allOf: + - $ref: '#/components/schemas/_common.aggregations:TermsAggregateBaseVoid' + - type: object + _common.aggregations:ValueCountAggregate: + allOf: + - $ref: '#/components/schemas/_common.aggregations:SingleMetricAggregateBase' - type: object - properties: - type: - type: string - enum: - - porter_stem - required: - - type - _common.analysis:PredicateTokenFilter: + _common.aggregations:ValueCountAggregation: allOf: - - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' + - $ref: '#/components/schemas/_common.aggregations:FormattableMetricAggregation' - type: object - properties: - type: - type: string - enum: - - predicate_token_filter - script: - $ref: '#/components/schemas/_common:Script' - required: - - type - - script - _common.analysis:RemoveDuplicatesTokenFilter: + _common.aggregations:ValueType: + type: string + enum: + - boolean + - date + - date_nanos + - double + - geo_point + - ip + - long + - number + - numeric + - string + _common.aggregations:VariableWidthHistogramAggregate: allOf: - - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' + - $ref: '#/components/schemas/_common.aggregations:MultiBucketAggregateBaseVariableWidthHistogramBucket' - type: object - properties: - type: - type: string - enum: - - remove_duplicates - required: - - type - _common.analysis:ReverseTokenFilter: + _common.aggregations:VariableWidthHistogramAggregation: + type: object + properties: + field: + $ref: '#/components/schemas/_common:Field' + buckets: + description: The target number of buckets. + type: number + shard_size: + description: |- + The number of buckets that the coordinating node will request from each shard. + Defaults to `buckets * 50`. + type: number + initial_buffer: + description: |- + 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: allOf: - - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' + - $ref: '#/components/schemas/_common.aggregations:MultiBucketBase' - type: object properties: - type: + min: + type: number + key: + type: number + max: + type: number + min_as_string: + type: string + key_as_string: + type: string + max_as_string: type: string - enum: - - reverse required: - - type - _common.analysis:ShingleTokenFilter: + - key + - max + - min + _common.aggregations:WeightedAverageAggregation: allOf: - - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' + - $ref: '#/components/schemas/_common.aggregations:Aggregation' - type: object properties: - type: - type: string - enum: - - shingle - filler_token: - type: string - max_shingle_size: - oneOf: - - type: number - - type: string - min_shingle_size: - oneOf: - - type: number - - type: string - output_unigrams: - type: boolean - output_unigrams_if_no_shingles: - type: boolean - token_separator: + format: + description: A numeric response formatter. type: string - required: - - type - _common.analysis:SimpleAnalyzer: + value: + $ref: '#/components/schemas/_common.aggregations:WeightedAverageValue' + value_type: + $ref: '#/components/schemas/_common.aggregations:ValueType' + weight: + $ref: '#/components/schemas/_common.aggregations:WeightedAverageValue' + _common.aggregations:WeightedAverageValue: type: object properties: - type: - type: string - enum: - - simple - version: - $ref: '#/components/schemas/_common:VersionString' - required: - - type - _common.analysis:SnowballAnalyzer: + 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: + allOf: + - $ref: '#/components/schemas/_common.aggregations:SingleMetricAggregateBase' + - type: object + _common.analysis:Analyzer: type: object - properties: - type: - type: string - enum: - - snowball - version: - $ref: '#/components/schemas/_common:VersionString' - language: - $ref: '#/components/schemas/_common.analysis:SnowballLanguage' - stopwords: - $ref: '#/components/schemas/_common.analysis:StopWords' - required: - - type - - language - _common.analysis:SnowballLanguage: - type: string - enum: - - Armenian - - Basque - - Catalan - - Danish - - Dutch - - English - - Finnish - - French - - German - - German2 - - Hungarian - - Italian - - Kp - - Lovins - - Norwegian - - Porter - - Portuguese - - Romanian - - Russian - - Spanish - - Swedish - - Turkish - _common.analysis:SnowballTokenFilter: + 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' + _common.analysis:AsciiFoldingTokenFilter: allOf: - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' - type: object @@ -25081,26 +31661,31 @@ components: type: type: string enum: - - snowball - language: - $ref: '#/components/schemas/_common.analysis:SnowballLanguage' + - asciifolding + preserve_original: + $ref: '#/components/schemas/_common:Stringifiedboolean' required: - type - - language - _common.analysis:StandardAnalyzer: + _common.analysis:CharFilter: + oneOf: + - type: string + - $ref: '#/components/schemas/_common.analysis:CharFilterDefinition' + _common.analysis:CharFilterBase: type: object properties: - type: - type: string - enum: - - standard - max_token_length: - type: number - stopwords: - $ref: '#/components/schemas/_common.analysis:StopWords' - required: - - type - _common.analysis:StandardTokenizer: + version: + $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: allOf: - $ref: '#/components/schemas/_common.analysis:TokenizerBase' - type: object @@ -25108,12 +31693,17 @@ components: type: type: string enum: - - standard + - char_group + tokenize_on_chars: + type: array + items: + type: string max_token_length: type: number required: + - tokenize_on_chars - type - _common.analysis:StemmerOverrideTokenFilter: + _common.analysis:CommonGramsTokenFilter: allOf: - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' - type: object @@ -25121,105 +31711,41 @@ components: type: type: string enum: - - stemmer_override - rules: + - common_grams + common_words: type: array items: type: string - rules_path: - type: string - required: - - type - _common.analysis:StemmerTokenFilter: - allOf: - - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' - - type: object - properties: - type: - type: string - enum: - - stemmer - language: - type: string - required: - - type - _common.analysis:StopAnalyzer: - type: object - properties: - type: - type: string - enum: - - stop - version: - $ref: '#/components/schemas/_common:VersionString' - stopwords: - $ref: '#/components/schemas/_common.analysis:StopWords' - stopwords_path: - type: string - required: - - type - _common.analysis:StopTokenFilter: - allOf: - - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' - - type: object - properties: - type: + common_words_path: type: string - enum: - - stop ignore_case: type: boolean - remove_trailing: + query_mode: type: boolean - stopwords: - $ref: '#/components/schemas/_common.analysis:StopWords' - stopwords_path: - type: string required: - type - _common.analysis:StopWords: - description: |- - 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: - - type: string - - type: array - items: - type: string - _common.analysis:SynonymFormat: - type: string - enum: - - solr - - wordnet - _common.analysis:SynonymGraphTokenFilter: + _common.analysis:CompoundWordTokenFilterBase: allOf: - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' - type: object properties: - type: + hyphenation_patterns_path: type: string - enum: - - synonym_graph - expand: - type: boolean - format: - $ref: '#/components/schemas/_common.analysis:SynonymFormat' - lenient: + max_subword_size: + type: number + min_subword_size: + type: number + min_word_size: + type: number + only_longest_match: type: boolean - synonyms: + word_list: type: array items: type: string - synonyms_path: - type: string - tokenizer: + word_list_path: type: string - updateable: - type: boolean - required: - - type - _common.analysis:SynonymTokenFilter: + _common.analysis:ConditionTokenFilter: allOf: - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' - type: object @@ -25227,134 +31753,107 @@ components: type: type: string enum: - - synonym - expand: - type: boolean - format: - $ref: '#/components/schemas/_common.analysis:SynonymFormat' - lenient: - type: boolean - synonyms: + - condition + filter: type: array items: type: string - synonyms_path: - type: string - tokenizer: - type: string - updateable: - type: boolean + script: + $ref: '#/components/schemas/_common:Script' required: + - filter + - script - type - _common.analysis:TokenChar: - type: string - enum: - - letter - - digit - - whitespace - - punctuation - - symbol - - custom - _common.analysis:TokenFilter: - oneOf: - - type: string - - $ref: '#/components/schemas/_common.analysis:TokenFilterDefinition' - _common.analysis:TokenFilterBase: + _common.analysis:CustomAnalyzer: type: object properties: - version: - $ref: '#/components/schemas/_common:VersionString' - _common.analysis:TokenFilterDefinition: - 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: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' - _common.analysis:Tokenizer: - oneOf: - - type: string - - $ref: '#/components/schemas/_common.analysis:TokenizerDefinition' - _common.analysis:TokenizerBase: + type: + type: string + enum: + - custom + char_filter: + type: array + items: + type: string + filter: + type: array + items: + type: string + position_increment_gap: + type: number + position_offset_gap: + type: number + tokenizer: + type: string + required: + - tokenizer + - type + _common.analysis:CustomNormalizer: type: object properties: - version: - $ref: '#/components/schemas/_common:VersionString' - _common.analysis:TokenizerDefinition: - 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' - _common.analysis:TrimTokenFilter: + type: + type: string + enum: + - custom + char_filter: + type: array + items: + type: string + filter: + type: array + items: + type: string + required: + - type + _common.analysis:DelimitedPayloadEncoding: + type: string + enum: + - float + - identity + - int + _common.analysis:DelimitedPayloadTokenFilter: + allOf: + - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' + - type: object + properties: + type: + type: string + enum: + - delimited_payload + delimiter: + type: string + encoding: + $ref: '#/components/schemas/_common.analysis:DelimitedPayloadEncoding' + required: + - type + _common.analysis:DictionaryDecompounderTokenFilter: allOf: - - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' + - $ref: '#/components/schemas/_common.analysis:CompoundWordTokenFilterBase' - type: object properties: type: type: string enum: - - trim + - dictionary_decompounder required: - type - _common.analysis:TruncateTokenFilter: + _common.analysis:DutchAnalyzer: + type: object + properties: + type: + type: string + enum: + - dutch + stopwords: + $ref: '#/components/schemas/_common.analysis:StopWords' + required: + - type + _common.analysis:EdgeNGramSide: + type: string + enum: + - back + - front + _common.analysis:EdgeNGramTokenFilter: allOf: - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' - type: object @@ -25362,12 +31861,18 @@ components: type: type: string enum: - - truncate - length: + - edge_ngram + max_gram: + type: number + min_gram: type: number + side: + $ref: '#/components/schemas/_common.analysis:EdgeNGramSide' + preserve_original: + $ref: '#/components/schemas/_common:Stringifiedboolean' required: - type - _common.analysis:UaxEmailUrlTokenizer: + _common.analysis:EdgeNGramTokenizer: allOf: - $ref: '#/components/schemas/_common.analysis:TokenizerBase' - type: object @@ -25375,12 +31880,23 @@ components: type: type: string enum: - - uax_url_email - max_token_length: + - edge_ngram + custom_token_chars: + type: string + max_gram: + type: number + min_gram: type: number + token_chars: + type: array + items: + $ref: '#/components/schemas/_common.analysis:TokenChar' required: + - max_gram + - min_gram + - token_chars - type - _common.analysis:UniqueTokenFilter: + _common.analysis:ElisionTokenFilter: allOf: - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' - type: object @@ -25388,92 +31904,68 @@ components: type: type: string enum: - - unique - only_on_same_position: - type: boolean - required: - - type - _common.analysis:UppercaseTokenFilter: - allOf: - - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' - - type: object - properties: - type: + - elision + articles: + type: array + items: + type: string + articles_path: type: string - enum: - - uppercase + articles_case: + $ref: '#/components/schemas/_common:Stringifiedboolean' required: - type - _common.analysis:WhitespaceAnalyzer: + _common.analysis:FingerprintAnalyzer: type: object properties: type: type: string enum: - - whitespace + - fingerprint version: $ref: '#/components/schemas/_common:VersionString' + max_output_size: + type: number + preserve_original: + type: boolean + separator: + type: string + stopwords: + $ref: '#/components/schemas/_common.analysis:StopWords' + stopwords_path: + type: string required: + - max_output_size + - preserve_original + - separator - type - _common.analysis:WhitespaceTokenizer: + _common.analysis:FingerprintTokenFilter: allOf: - - $ref: '#/components/schemas/_common.analysis:TokenizerBase' + - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' - type: object properties: type: type: string enum: - - whitespace - max_token_length: + - fingerprint + max_output_size: type: number + separator: + type: string required: - type - _common.analysis:WordDelimiterGraphTokenFilter: + _common.analysis:HtmlStripCharFilter: allOf: - - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' + - $ref: '#/components/schemas/_common.analysis:CharFilterBase' - type: object properties: type: type: string enum: - - word_delimiter_graph - adjust_offsets: - type: boolean - catenate_all: - type: boolean - catenate_numbers: - type: boolean - catenate_words: - type: boolean - generate_number_parts: - type: boolean - generate_word_parts: - type: boolean - ignore_keywords: - type: boolean - preserve_original: - $ref: '#/components/schemas/_common:Stringifiedboolean' - protected_words: - type: array - items: - type: string - protected_words_path: - type: string - split_on_case_change: - type: boolean - split_on_numerics: - type: boolean - stem_english_possessive: - type: boolean - type_table: - type: array - items: - type: string - type_table_path: - type: string + - html_strip required: - type - _common.analysis:WordDelimiterTokenFilter: + _common.analysis:HunspellTokenFilter: allOf: - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' - type: object @@ -25481,5023 +31973,4607 @@ components: type: type: string enum: - - word_delimiter - catenate_all: - type: boolean - catenate_numbers: - type: boolean - catenate_words: - type: boolean - generate_number_parts: - type: boolean - generate_word_parts: + - hunspell + dedup: type: boolean - preserve_original: - $ref: '#/components/schemas/_common:Stringifiedboolean' - protected_words: - type: array - items: - type: string - protected_words_path: + dictionary: type: string - split_on_case_change: - type: boolean - split_on_numerics: - type: boolean - stem_english_possessive: - type: boolean - type_table: - type: array - items: - type: string - type_table_path: + locale: type: string + longest_only: + type: boolean required: + - locale - type - _common.mapping:AggregateMetricDoubleProperty: + _common.analysis:HyphenationDecompounderTokenFilter: allOf: - - $ref: '#/components/schemas/_common.mapping:PropertyBase' + - $ref: '#/components/schemas/_common.analysis:CompoundWordTokenFilterBase' - type: object properties: type: type: string enum: - - aggregate_metric_double - default_metric: - type: string - metrics: - type: array - items: - type: string - time_series_metric: - $ref: '#/components/schemas/_common.mapping:TimeSeriesMetricType' + - hyphenation_decompounder required: - type - - default_metric - - metrics - _common.mapping:AllField: + _common.analysis:IcuAnalyzer: type: object properties: - analyzer: - type: string - enabled: - type: boolean - omit_norms: - type: boolean - search_analyzer: - type: string - similarity: + type: type: string - store: - type: boolean - store_term_vector_offsets: - type: boolean - store_term_vector_payloads: - type: boolean - store_term_vector_positions: - type: boolean - store_term_vectors: - type: boolean + enum: + - icu_analyzer + method: + $ref: '#/components/schemas/_common.analysis:IcuNormalizationType' + mode: + $ref: '#/components/schemas/_common.analysis:IcuNormalizationMode' required: - - analyzer - - enabled - - omit_norms - - search_analyzer - - similarity - - store - - store_term_vector_offsets - - store_term_vector_payloads - - store_term_vector_positions - - store_term_vectors - _common.mapping:BinaryProperty: + - method + - mode + - type + _common.analysis:IcuCollationAlternate: + type: string + enum: + - non-ignorable + - shifted + _common.analysis:IcuCollationCaseFirst: + type: string + enum: + - lower + - upper + _common.analysis:IcuCollationDecomposition: + type: string + enum: + - identical + - no + _common.analysis:IcuCollationStrength: + type: string + enum: + - identical + - primary + - quaternary + - secondary + - tertiary + _common.analysis:IcuCollationTokenFilter: allOf: - - $ref: '#/components/schemas/_common.mapping:DocValuesPropertyBase' + - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' - type: object properties: type: type: string enum: - - binary + - icu_collation + alternate: + $ref: '#/components/schemas/_common.analysis:IcuCollationAlternate' + caseFirst: + $ref: '#/components/schemas/_common.analysis:IcuCollationCaseFirst' + caseLevel: + type: boolean + country: + type: string + decomposition: + $ref: '#/components/schemas/_common.analysis:IcuCollationDecomposition' + hiraganaQuaternaryMode: + type: boolean + language: + type: string + numeric: + type: boolean + rules: + type: string + strength: + $ref: '#/components/schemas/_common.analysis:IcuCollationStrength' + variableTop: + type: string + variant: + type: string required: - type - _common.mapping:BooleanProperty: + _common.analysis:IcuFoldingTokenFilter: allOf: - - $ref: '#/components/schemas/_common.mapping:DocValuesPropertyBase' + - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' - type: object properties: - boost: - type: number - fielddata: - $ref: '#/components/schemas/indices._common:NumericFielddata' - index: - type: boolean - null_value: - type: boolean type: type: string enum: - - boolean + - icu_folding + unicode_set_filter: + type: string required: - type - _common.mapping:ByteNumberProperty: + - unicode_set_filter + _common.analysis:IcuNormalizationCharFilter: allOf: - - $ref: '#/components/schemas/_common.mapping:NumberPropertyBase' + - $ref: '#/components/schemas/_common.analysis:CharFilterBase' - type: object properties: type: type: string enum: - - byte - null_value: - $ref: '#/components/schemas/_common:byte' + - icu_normalizer + mode: + $ref: '#/components/schemas/_common.analysis:IcuNormalizationMode' + name: + $ref: '#/components/schemas/_common.analysis:IcuNormalizationType' required: - type - _common.mapping:CompletionProperty: + _common.analysis:IcuNormalizationMode: + type: string + enum: + - compose + - decompose + _common.analysis:IcuNormalizationTokenFilter: allOf: - - $ref: '#/components/schemas/_common.mapping:DocValuesPropertyBase' + - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' - type: object properties: - analyzer: - type: string - contexts: - type: array - items: - $ref: '#/components/schemas/_common.mapping:SuggestContext' - max_input_length: - type: number - preserve_position_increments: - type: boolean - preserve_separators: - type: boolean - search_analyzer: - type: string type: type: string enum: - - completion + - icu_normalizer + name: + $ref: '#/components/schemas/_common.analysis:IcuNormalizationType' required: + - name - type - _common.mapping:ConstantKeywordProperty: + _common.analysis:IcuNormalizationType: + type: string + enum: + - nfc + - nfkc + - nfkc_cf + _common.analysis:IcuTokenizer: allOf: - - $ref: '#/components/schemas/_common.mapping:PropertyBase' + - $ref: '#/components/schemas/_common.analysis:TokenizerBase' - type: object properties: - value: - type: object type: type: string enum: - - constant_keyword + - icu_tokenizer + rule_files: + type: string required: + - rule_files - type - _common.mapping:CorePropertyBase: - allOf: - - $ref: '#/components/schemas/_common.mapping:PropertyBase' - - type: object - properties: - copy_to: - $ref: '#/components/schemas/_common:Fields' - similarity: - type: string - store: - type: boolean - _common.mapping:DataStreamTimestamp: - type: object - properties: - enabled: - type: boolean - required: - - enabled - _common.mapping:DateNanosProperty: + _common.analysis:IcuTransformDirection: + type: string + enum: + - forward + - reverse + _common.analysis:IcuTransformTokenFilter: allOf: - - $ref: '#/components/schemas/_common.mapping:DocValuesPropertyBase' + - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' - type: object properties: - boost: - type: number - format: - type: string - ignore_malformed: - type: boolean - index: - type: boolean - null_value: - $ref: '#/components/schemas/_common:DateTime' - precision_step: - type: number type: type: string enum: - - date_nanos + - icu_transform + dir: + $ref: '#/components/schemas/_common.analysis:IcuTransformDirection' + id: + type: string required: + - id - type - _common.mapping:DateProperty: + _common.analysis:KeepTypesMode: + type: string + enum: + - exclude + - include + _common.analysis:KeepTypesTokenFilter: allOf: - - $ref: '#/components/schemas/_common.mapping:DocValuesPropertyBase' + - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' - type: object properties: - boost: - type: number - fielddata: - $ref: '#/components/schemas/indices._common:NumericFielddata' - format: - type: string - ignore_malformed: - type: boolean - index: - type: boolean - null_value: - $ref: '#/components/schemas/_common:DateTime' - precision_step: - type: number - locale: - type: string type: type: string enum: - - date + - keep_types + mode: + $ref: '#/components/schemas/_common.analysis:KeepTypesMode' + types: + type: array + items: + type: string required: - type - _common.mapping:DateRangeProperty: + _common.analysis:KeepWordsTokenFilter: allOf: - - $ref: '#/components/schemas/_common.mapping:RangePropertyBase' + - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' - type: object properties: - format: - type: string type: type: string enum: - - date_range + - keep + keep_words: + type: array + items: + type: string + keep_words_case: + type: boolean + keep_words_path: + type: string required: - type - _common.mapping:DenseVectorIndexOptions: + _common.analysis:KeywordAnalyzer: type: object properties: type: type: string - m: - type: number - ef_construction: - type: number + enum: + - keyword + version: + $ref: '#/components/schemas/_common:VersionString' required: - type - - m - - ef_construction - _common.mapping:DenseVectorProperty: - 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: - - type - - dims - _common.mapping:DocValuesPropertyBase: - allOf: - - $ref: '#/components/schemas/_common.mapping:CorePropertyBase' - - type: object - properties: - doc_values: - type: boolean - _common.mapping:DoubleNumberProperty: - allOf: - - $ref: '#/components/schemas/_common.mapping:NumberPropertyBase' - - type: object - properties: - type: - type: string - enum: - - double - null_value: - type: number - required: - - type - _common.mapping:DoubleRangeProperty: + _common.analysis:KeywordMarkerTokenFilter: allOf: - - $ref: '#/components/schemas/_common.mapping:RangePropertyBase' + - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' - type: object properties: type: type: string enum: - - double_range + - keyword_marker + ignore_case: + type: boolean + keywords: + type: array + items: + type: string + keywords_path: + type: string + keywords_pattern: + type: string required: - type - _common.mapping:DynamicMapping: - type: string - enum: - - strict - - runtime - - 'true' - - 'false' - _common.mapping:DynamicProperty: + _common.analysis:KeywordTokenizer: allOf: - - $ref: '#/components/schemas/_common.mapping:DocValuesPropertyBase' + - $ref: '#/components/schemas/_common.analysis:TokenizerBase' - type: object properties: type: type: string enum: - - '{dynamic_property}' - enabled: - type: boolean - null_value: - $ref: '#/components/schemas/_common:FieldValue' - boost: - type: number - coerce: - type: boolean - script: - $ref: '#/components/schemas/_common:Script' - on_script_error: - $ref: '#/components/schemas/_common.mapping:OnScriptError' - ignore_malformed: - type: boolean - time_series_metric: - $ref: '#/components/schemas/_common.mapping:TimeSeriesMetricType' - analyzer: - type: string - eager_global_ordinals: - type: boolean - index: - type: boolean - index_options: - $ref: '#/components/schemas/_common.mapping:IndexOptions' - index_phrases: - type: boolean - index_prefixes: - $ref: '#/components/schemas/_common.mapping:TextIndexPrefixes' - norms: - type: boolean - position_increment_gap: - type: number - search_analyzer: - type: string - search_quote_analyzer: - type: string - term_vector: - $ref: '#/components/schemas/_common.mapping:TermVectorOption' - format: - type: string - precision_step: + - keyword + buffer_size: type: number - locale: - type: string required: + - buffer_size - type - _common.mapping:DynamicTemplate: - type: object - properties: - mapping: - $ref: '#/components/schemas/_common.mapping:Property' - match: - type: string - match_mapping_type: - type: string - match_pattern: - $ref: '#/components/schemas/_common.mapping:MatchType' - path_match: - type: string - path_unmatch: - type: string - unmatch: - type: string - _common.mapping:FieldAliasProperty: + _common.analysis:KStemTokenFilter: allOf: - - $ref: '#/components/schemas/_common.mapping:PropertyBase' + - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' - type: object properties: - path: - $ref: '#/components/schemas/_common:Field' type: type: string enum: - - alias + - kstem required: - type - _common.mapping:FieldMapping: + _common.analysis:KuromojiAnalyzer: type: object properties: - full_name: + type: + type: string + enum: + - kuromoji + mode: + $ref: '#/components/schemas/_common.analysis:KuromojiTokenizationMode' + user_dictionary: type: string - mapping: - type: object - additionalProperties: - $ref: '#/components/schemas/_common.mapping:Property' - minProperties: 1 - maxProperties: 1 - required: - - full_name - - mapping - _common.mapping:FieldNamesField: - type: object - properties: - enabled: - type: boolean required: - - enabled - _common.mapping:FlattenedProperty: + - mode + - type + _common.analysis:KuromojiIterationMarkCharFilter: allOf: - - $ref: '#/components/schemas/_common.mapping:PropertyBase' + - $ref: '#/components/schemas/_common.analysis:CharFilterBase' - type: object properties: - boost: - type: number - depth_limit: - type: number - doc_values: - type: boolean - eager_global_ordinals: - type: boolean - index: - type: boolean - index_options: - $ref: '#/components/schemas/_common.mapping:IndexOptions' - null_value: - type: string - similarity: + type: type: string - split_queries_on_whitespace: + enum: + - kuromoji_iteration_mark + normalize_kana: type: boolean + normalize_kanji: + type: boolean + required: + - normalize_kana + - normalize_kanji + - type + _common.analysis:KuromojiPartOfSpeechTokenFilter: + allOf: + - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' + - type: object + properties: type: type: string enum: - - flattened + - kuromoji_part_of_speech + stoptags: + type: array + items: + type: string required: + - stoptags - type - _common.mapping:FloatNumberProperty: + _common.analysis:KuromojiReadingFormTokenFilter: allOf: - - $ref: '#/components/schemas/_common.mapping:NumberPropertyBase' + - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' - type: object properties: type: type: string enum: - - float - null_value: - type: number + - kuromoji_readingform + use_romaji: + type: boolean required: - type - _common.mapping:FloatRangeProperty: + - use_romaji + _common.analysis:KuromojiStemmerTokenFilter: allOf: - - $ref: '#/components/schemas/_common.mapping:RangePropertyBase' + - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' - type: object properties: type: type: string enum: - - float_range + - kuromoji_stemmer + minimum_length: + type: number required: + - minimum_length - type - _common.mapping:GeoOrientation: + _common.analysis:KuromojiTokenizationMode: type: string enum: - - right - - left - _common.mapping:GeoPointProperty: + - extended + - normal + - search + _common.analysis:KuromojiTokenizer: allOf: - - $ref: '#/components/schemas/_common.mapping:DocValuesPropertyBase' + - $ref: '#/components/schemas/_common.analysis:TokenizerBase' - type: object properties: - ignore_malformed: - type: boolean - ignore_z_value: - type: boolean - null_value: - $ref: '#/components/schemas/_common:GeoLocation' type: type: string enum: - - geo_point + - kuromoji_tokenizer + discard_punctuation: + type: boolean + mode: + $ref: '#/components/schemas/_common.analysis:KuromojiTokenizationMode' + nbest_cost: + type: number + nbest_examples: + type: string + user_dictionary: + type: string + user_dictionary_rules: + type: array + items: + type: string + discard_compound_token: + type: boolean required: + - mode - type - _common.mapping:GeoShapeProperty: + _common.analysis:Language: + type: string + enum: + - Arabic + - Armenian + - Basque + - Brazilian + - Bulgarian + - Catalan + - Chinese + - Cjk + - Czech + - Danish + - Dutch + - English + - Estonian + - Finnish + - French + - Galician + - German + - Greek + - Hindi + - Hungarian + - Indonesian + - Irish + - Italian + - Latvian + - Norwegian + - Persian + - Portuguese + - Romanian + - Russian + - Sorani + - Spanish + - Swedish + - Thai + - Turkish + _common.analysis:LanguageAnalyzer: + type: object + properties: + type: + type: string + enum: + - language + version: + $ref: '#/components/schemas/_common:VersionString' + language: + $ref: '#/components/schemas/_common.analysis:Language' + stem_exclusion: + type: array + items: + type: string + stopwords: + $ref: '#/components/schemas/_common.analysis:StopWords' + stopwords_path: + type: string + required: + - language + - stem_exclusion + - type + _common.analysis:LengthTokenFilter: allOf: - - $ref: '#/components/schemas/_common.mapping:DocValuesPropertyBase' + - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' - type: object properties: - coerce: - type: boolean - ignore_malformed: - type: boolean - ignore_z_value: - type: boolean - orientation: - $ref: '#/components/schemas/_common.mapping:GeoOrientation' - strategy: - $ref: '#/components/schemas/_common.mapping:GeoStrategy' type: type: string enum: - - geo_shape + - length + max: + type: number + min: + type: number required: - type - _common.mapping:GeoStrategy: - type: string - enum: - - recursive - - term - _common.mapping:HalfFloatNumberProperty: + _common.analysis:LetterTokenizer: allOf: - - $ref: '#/components/schemas/_common.mapping:NumberPropertyBase' + - $ref: '#/components/schemas/_common.analysis:TokenizerBase' - type: object properties: type: type: string enum: - - half_float - null_value: - type: number + - letter required: - type - _common.mapping:HistogramProperty: + _common.analysis:LimitTokenCountTokenFilter: allOf: - - $ref: '#/components/schemas/_common.mapping:PropertyBase' + - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' - type: object properties: - ignore_malformed: - type: boolean type: type: string enum: - - histogram + - limit + consume_all_tokens: + type: boolean + max_token_count: + $ref: '#/components/schemas/_common:Stringifiedinteger' required: - type - _common.mapping:IndexField: + _common.analysis:LowercaseNormalizer: type: object properties: - enabled: - type: boolean + type: + type: string + enum: + - lowercase required: - - enabled - _common.mapping:IndexOptions: - type: string - enum: - - docs - - freqs - - positions - - offsets - _common.mapping:IntegerNumberProperty: + - type + _common.analysis:LowercaseTokenFilter: allOf: - - $ref: '#/components/schemas/_common.mapping:NumberPropertyBase' + - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' - type: object properties: type: type: string enum: - - integer - null_value: - type: number + - lowercase + language: + type: string required: - type - _common.mapping:IntegerRangeProperty: + _common.analysis:LowercaseTokenizer: allOf: - - $ref: '#/components/schemas/_common.mapping:RangePropertyBase' + - $ref: '#/components/schemas/_common.analysis:TokenizerBase' - type: object properties: type: type: string enum: - - integer_range + - lowercase required: - type - _common.mapping:IpProperty: + _common.analysis:MappingCharFilter: allOf: - - $ref: '#/components/schemas/_common.mapping:DocValuesPropertyBase' + - $ref: '#/components/schemas/_common.analysis:CharFilterBase' - type: object properties: - boost: - type: number - index: - type: boolean - ignore_malformed: - 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 + - mapping + mappings: + type: array + items: + type: string + mappings_path: + type: string required: - type - _common.mapping:IpRangeProperty: + _common.analysis:MultiplexerTokenFilter: allOf: - - $ref: '#/components/schemas/_common.mapping:RangePropertyBase' + - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' - type: object properties: type: type: string enum: - - ip_range + - multiplexer + filters: + type: array + items: + type: string + preserve_original: + $ref: '#/components/schemas/_common:Stringifiedboolean' required: + - filters - type - _common.mapping:JoinProperty: + _common.analysis:NGramTokenFilter: allOf: - - $ref: '#/components/schemas/_common.mapping:PropertyBase' + - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' - type: object properties: - relations: - type: object - additionalProperties: - oneOf: - - $ref: '#/components/schemas/_common:RelationName' - - type: array - items: - $ref: '#/components/schemas/_common:RelationName' - eager_global_ordinals: - type: boolean type: type: string enum: - - join + - ngram + max_gram: + type: number + min_gram: + type: number + preserve_original: + $ref: '#/components/schemas/_common:Stringifiedboolean' required: - type - _common.mapping:KeywordProperty: + _common.analysis:NGramTokenizer: allOf: - - $ref: '#/components/schemas/_common.mapping:DocValuesPropertyBase' + - $ref: '#/components/schemas/_common.analysis:TokenizerBase' - type: object properties: - boost: - type: number - eager_global_ordinals: - type: boolean - index: - type: boolean - index_options: - $ref: '#/components/schemas/_common.mapping:IndexOptions' - normalizer: + type: type: string - norms: - type: boolean - null_value: + enum: + - ngram + custom_token_chars: 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 + max_gram: + type: number + min_gram: + type: number + token_chars: + type: array + items: + $ref: '#/components/schemas/_common.analysis:TokenChar' + required: + - max_gram + - min_gram + - token_chars + - type + _common.analysis:NoriAnalyzer: + type: object + properties: + type: + type: string + enum: + - nori + version: + $ref: '#/components/schemas/_common:VersionString' + decompound_mode: + $ref: '#/components/schemas/_common.analysis:NoriDecompoundMode' + stoptags: + type: array + items: + type: string + user_dictionary: + type: string + required: + - type + _common.analysis:NoriDecompoundMode: + type: string + enum: + - discard + - mixed + - none + _common.analysis:NoriPartOfSpeechTokenFilter: + allOf: + - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' + - type: object + properties: type: type: string enum: - - keyword + - nori_part_of_speech + stoptags: + type: array + items: + type: string required: - type - _common.mapping:LongNumberProperty: + _common.analysis:NoriTokenizer: allOf: - - $ref: '#/components/schemas/_common.mapping:NumberPropertyBase' + - $ref: '#/components/schemas/_common.analysis:TokenizerBase' - type: object properties: type: type: string enum: - - long - null_value: - type: number + - nori_tokenizer + decompound_mode: + $ref: '#/components/schemas/_common.analysis:NoriDecompoundMode' + discard_punctuation: + type: boolean + user_dictionary: + type: string + user_dictionary_rules: + type: array + items: + type: string required: - type - _common.mapping:LongRangeProperty: + _common.analysis:Normalizer: + type: object + discriminator: + propertyName: type + oneOf: + - $ref: '#/components/schemas/_common.analysis:LowercaseNormalizer' + - $ref: '#/components/schemas/_common.analysis:CustomNormalizer' + _common.analysis:PathHierarchyTokenizer: allOf: - - $ref: '#/components/schemas/_common.mapping:RangePropertyBase' + - $ref: '#/components/schemas/_common.analysis:TokenizerBase' - type: object properties: type: type: string enum: - - long_range + - path_hierarchy + buffer_size: + $ref: '#/components/schemas/_common:Stringifiedinteger' + delimiter: + type: string + replacement: + type: string + reverse: + $ref: '#/components/schemas/_common:Stringifiedboolean' + skip: + $ref: '#/components/schemas/_common:Stringifiedinteger' required: + - buffer_size + - delimiter + - reverse + - skip - type - _common.mapping:MatchOnlyTextProperty: + _common.analysis:PatternAnalyzer: type: object properties: type: type: string enum: - - match_only_text - fields: - description: |- - Multi-fields allow the same string value to be indexed in multiple ways for different purposes, such as one - 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' - meta: - description: Metadata about the field. - type: object - additionalProperties: - type: string - copy_to: - $ref: '#/components/schemas/_common:Fields' + - pattern + version: + $ref: '#/components/schemas/_common:VersionString' + flags: + type: string + lowercase: + type: boolean + pattern: + type: string + stopwords: + $ref: '#/components/schemas/_common.analysis:StopWords' required: + - pattern - type - _common.mapping:MatchType: - type: string - enum: - - simple - - regex - _common.mapping:Murmur3HashProperty: + _common.analysis:PatternCaptureTokenFilter: allOf: - - $ref: '#/components/schemas/_common.mapping:DocValuesPropertyBase' + - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' - type: object properties: type: type: string enum: - - murmur3 + - pattern_capture + patterns: + type: array + items: + type: string + preserve_original: + $ref: '#/components/schemas/_common:Stringifiedboolean' required: + - patterns - type - _common.mapping:NestedProperty: + _common.analysis:PatternReplaceCharFilter: allOf: - - $ref: '#/components/schemas/_common.mapping:CorePropertyBase' + - $ref: '#/components/schemas/_common.analysis:CharFilterBase' - type: object properties: - enabled: - type: boolean - include_in_parent: - type: boolean - include_in_root: - type: boolean type: type: string enum: - - nested + - pattern_replace + flags: + type: string + pattern: + type: string + replacement: + type: string required: + - pattern - type - _common.mapping:NumberPropertyBase: - allOf: - - $ref: '#/components/schemas/_common.mapping:DocValuesPropertyBase' - - type: object - properties: - boost: - type: number - coerce: - type: boolean - ignore_malformed: - 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.analysis:PatternReplaceTokenFilter: allOf: - - $ref: '#/components/schemas/_common.mapping:CorePropertyBase' + - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' - type: object properties: - enabled: - type: boolean type: type: string enum: - - object - _common.mapping:OnScriptError: - type: string - enum: - - fail - - continue - _common.mapping:PercolatorProperty: - allOf: - - $ref: '#/components/schemas/_common.mapping:PropertyBase' - - type: object - properties: - type: + - pattern_replace + all: + type: boolean + flags: + type: string + pattern: + type: string + replacement: type: string - enum: - - percolator required: + - pattern - type - _common.mapping:PointProperty: + _common.analysis:PatternTokenizer: allOf: - - $ref: '#/components/schemas/_common.mapping:DocValuesPropertyBase' + - $ref: '#/components/schemas/_common.analysis:TokenizerBase' - type: object properties: - ignore_malformed: - type: boolean - ignore_z_value: - type: boolean - null_value: - type: string type: type: string enum: - - point + - pattern + flags: + type: string + group: + type: number + pattern: + type: string required: - type - _common.mapping:Property: - discriminator: - propertyName: type - oneOf: - - $ref: '#/components/schemas/_common.mapping:BinaryProperty' - - $ref: '#/components/schemas/_common.mapping:BooleanProperty' - - $ref: '#/components/schemas/_common.mapping:DynamicProperty' - - $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:PointProperty' - - $ref: '#/components/schemas/_common.mapping:ShapeProperty' - - $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' - _common.mapping:PropertyBase: - type: object - properties: - meta: - description: Metadata about the field. - type: object - additionalProperties: - type: string - properties: - type: object - additionalProperties: - $ref: '#/components/schemas/_common.mapping:Property' - ignore_above: - type: number - dynamic: - $ref: '#/components/schemas/_common.mapping:DynamicMapping' - fields: - type: object - additionalProperties: - $ref: '#/components/schemas/_common.mapping:Property' - _common.mapping:RangePropertyBase: - allOf: - - $ref: '#/components/schemas/_common.mapping:DocValuesPropertyBase' - - type: object - properties: - boost: - type: number - coerce: - type: boolean - index: - type: boolean - _common.mapping:RankFeatureProperty: + _common.analysis:PhoneticEncoder: + type: string + enum: + - beider_morse + - caverphone1 + - caverphone2 + - cologne + - daitch_mokotoff + - double_metaphone + - haasephonetik + - koelnerphonetik + - metaphone + - nysiis + - refined_soundex + - soundex + _common.analysis:PhoneticLanguage: + type: string + enum: + - any + - common + - cyrillic + - english + - french + - german + - hebrew + - hungarian + - polish + - romanian + - russian + - spanish + _common.analysis:PhoneticNameType: + type: string + enum: + - ashkenazi + - generic + - sephardic + _common.analysis:PhoneticRuleType: + type: string + enum: + - approx + - exact + _common.analysis:PhoneticTokenFilter: allOf: - - $ref: '#/components/schemas/_common.mapping:PropertyBase' + - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' - type: object properties: - positive_score_impact: - type: boolean type: type: string enum: - - rank_feature + - phonetic + encoder: + $ref: '#/components/schemas/_common.analysis:PhoneticEncoder' + languageset: + type: array + items: + $ref: '#/components/schemas/_common.analysis:PhoneticLanguage' + max_code_len: + type: number + name_type: + $ref: '#/components/schemas/_common.analysis:PhoneticNameType' + replace: + type: boolean + rule_type: + $ref: '#/components/schemas/_common.analysis:PhoneticRuleType' required: + - encoder + - languageset + - name_type + - rule_type - type - _common.mapping:RankFeaturesProperty: + _common.analysis:PorterStemTokenFilter: allOf: - - $ref: '#/components/schemas/_common.mapping:PropertyBase' + - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' - type: object properties: type: type: string enum: - - rank_features + - porter_stem required: - type - _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:RuntimeFieldType: - type: string - enum: - - boolean - - date - - double - - geo_point - - ip - - keyword - - long - - lookup - _common.mapping:RuntimeFields: - type: object - additionalProperties: - $ref: '#/components/schemas/_common.mapping:RuntimeField' - _common.mapping:ScaledFloatNumberProperty: + _common.analysis:PredicateTokenFilter: allOf: - - $ref: '#/components/schemas/_common.mapping:NumberPropertyBase' + - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' - type: object properties: type: type: string enum: - - scaled_float - null_value: - type: number - scaling_factor: - type: number + - predicate_token_filter + script: + $ref: '#/components/schemas/_common:Script' required: + - script - type - _common.mapping:SearchAsYouTypeProperty: + _common.analysis:RemoveDuplicatesTokenFilter: allOf: - - $ref: '#/components/schemas/_common.mapping:CorePropertyBase' + - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' - type: object properties: - analyzer: - type: string - index: - type: boolean - index_options: - $ref: '#/components/schemas/_common.mapping:IndexOptions' - max_shingle_size: - type: number - norms: - type: boolean - search_analyzer: - type: string - search_quote_analyzer: - type: string - term_vector: - $ref: '#/components/schemas/_common.mapping:TermVectorOption' type: type: string enum: - - search_as_you_type + - remove_duplicates required: - type - _common.mapping:ShapeProperty: + _common.analysis:ReverseTokenFilter: allOf: - - $ref: '#/components/schemas/_common.mapping:DocValuesPropertyBase' + - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' - type: object properties: - coerce: - type: boolean - ignore_malformed: - type: boolean - ignore_z_value: - type: boolean - orientation: - $ref: '#/components/schemas/_common.mapping:GeoOrientation' type: type: string enum: - - shape + - reverse required: - type - _common.mapping:ShortNumberProperty: + _common.analysis:ShingleTokenFilter: allOf: - - $ref: '#/components/schemas/_common.mapping:NumberPropertyBase' + - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' - type: object properties: type: type: string enum: - - short - null_value: - $ref: '#/components/schemas/_common:short' + - shingle + filler_token: + type: string + max_shingle_size: + oneOf: + - type: number + - type: string + min_shingle_size: + oneOf: + - type: number + - type: string + output_unigrams: + type: boolean + output_unigrams_if_no_shingles: + type: boolean + token_separator: + type: string required: - type - _common.mapping:SizeField: + _common.analysis:SimpleAnalyzer: type: object properties: - enabled: - type: boolean + type: + type: string + enum: + - simple + version: + $ref: '#/components/schemas/_common:VersionString' required: - - enabled - _common.mapping:SourceField: + - type + _common.analysis:SnowballAnalyzer: type: object properties: - compress: - type: boolean - compress_threshold: + type: type: string - enabled: - type: boolean - excludes: - type: array - items: - type: string - includes: - type: array - items: - type: string - mode: - $ref: '#/components/schemas/_common.mapping:SourceFieldMode' - _common.mapping:SourceFieldMode: + enum: + - snowball + version: + $ref: '#/components/schemas/_common:VersionString' + language: + $ref: '#/components/schemas/_common.analysis:SnowballLanguage' + stopwords: + $ref: '#/components/schemas/_common.analysis:StopWords' + required: + - language + - type + _common.analysis:SnowballLanguage: type: string enum: - - disabled - - stored - - synthetic - _common.mapping:SparseVectorProperty: + - Armenian + - Basque + - Catalan + - Danish + - Dutch + - English + - Finnish + - French + - German + - German2 + - Hungarian + - Italian + - Kp + - Lovins + - Norwegian + - Porter + - Portuguese + - Romanian + - Russian + - Spanish + - Swedish + - Turkish + _common.analysis:SnowballTokenFilter: allOf: - - $ref: '#/components/schemas/_common.mapping:PropertyBase' + - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' - type: object properties: type: type: string enum: - - sparse_vector + - snowball + language: + $ref: '#/components/schemas/_common.analysis:SnowballLanguage' required: + - language - type - _common.mapping:SuggestContext: + _common.analysis:StandardAnalyzer: type: object properties: - name: - $ref: '#/components/schemas/_common:Name' - path: - $ref: '#/components/schemas/_common:Field' type: type: string - precision: - oneOf: - - type: number - - type: string - required: - - name - - type - _common.mapping:TermVectorOption: - type: string - enum: - - no - - yes - - with_offsets - - with_positions - - with_positions_offsets - - with_positions_offsets_payloads - - with_positions_payloads - _common.mapping:TextIndexPrefixes: - type: object - properties: - max_chars: - type: number - min_chars: + enum: + - standard + max_token_length: type: number + stopwords: + $ref: '#/components/schemas/_common.analysis:StopWords' required: - - max_chars - - min_chars - _common.mapping:TextProperty: + - type + _common.analysis:StandardTokenizer: allOf: - - $ref: '#/components/schemas/_common.mapping:CorePropertyBase' + - $ref: '#/components/schemas/_common.analysis:TokenizerBase' - type: object properties: - analyzer: - type: string - boost: - type: number - eager_global_ordinals: - type: boolean - fielddata: - type: boolean - fielddata_frequency_filter: - $ref: '#/components/schemas/indices._common:FielddataFrequencyFilter' - index: - type: boolean - index_options: - $ref: '#/components/schemas/_common.mapping:IndexOptions' - index_phrases: - type: boolean - index_prefixes: - $ref: '#/components/schemas/_common.mapping:TextIndexPrefixes' - norms: - type: boolean - position_increment_gap: - type: number - search_analyzer: - type: string - search_quote_analyzer: - type: string - term_vector: - $ref: '#/components/schemas/_common.mapping:TermVectorOption' type: type: string enum: - - text + - standard + max_token_length: + type: number required: - type - _common.mapping:TimeSeriesMetricType: - type: string - enum: - - gauge - - counter - - summary - - histogram - - position - _common.mapping:TokenCountProperty: + _common.analysis:StemmerOverrideTokenFilter: allOf: - - $ref: '#/components/schemas/_common.mapping:DocValuesPropertyBase' + - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' - type: object properties: - analyzer: - type: string - boost: - type: number - index: - type: boolean - null_value: - type: number - enable_position_increments: - type: boolean type: type: string enum: - - token_count + - stemmer_override + rules: + type: array + items: + type: string + rules_path: + type: string required: - type - _common.mapping:TypeMapping: - type: object - properties: - all_field: - $ref: '#/components/schemas/_common.mapping:AllField' - date_detection: - type: boolean - dynamic: - $ref: '#/components/schemas/_common.mapping:DynamicMapping' - dynamic_date_formats: - type: array - items: - type: string - dynamic_templates: - type: array - items: - type: object - additionalProperties: - $ref: '#/components/schemas/_common.mapping:DynamicTemplate' - _field_names: - $ref: '#/components/schemas/_common.mapping:FieldNamesField' - index_field: - $ref: '#/components/schemas/_common.mapping:IndexField' - _meta: - $ref: '#/components/schemas/_common:Metadata' - numeric_detection: - type: boolean - properties: - type: object - additionalProperties: - $ref: '#/components/schemas/_common.mapping:Property' - _routing: - $ref: '#/components/schemas/_common.mapping:RoutingField' - _size: - $ref: '#/components/schemas/_common.mapping:SizeField' - _source: - $ref: '#/components/schemas/_common.mapping:SourceField' - runtime: - type: object - additionalProperties: - $ref: '#/components/schemas/_common.mapping:RuntimeField' - enabled: - type: boolean - _data_stream_timestamp: - $ref: '#/components/schemas/_common.mapping:DataStreamTimestamp' - _common.mapping:UnsignedLongNumberProperty: + _common.analysis:StemmerTokenFilter: allOf: - - $ref: '#/components/schemas/_common.mapping:NumberPropertyBase' + - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' - type: object properties: type: type: string enum: - - unsigned_long - null_value: - $ref: '#/components/schemas/_common:ulong' + - stemmer + language: + type: string required: - type - _common.mapping:VersionProperty: + _common.analysis:StopAnalyzer: + type: object + properties: + type: + type: string + enum: + - stop + version: + $ref: '#/components/schemas/_common:VersionString' + stopwords: + $ref: '#/components/schemas/_common.analysis:StopWords' + stopwords_path: + type: string + required: + - type + _common.analysis:StopTokenFilter: allOf: - - $ref: '#/components/schemas/_common.mapping:DocValuesPropertyBase' + - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' - type: object properties: type: type: string enum: - - version + - stop + ignore_case: + type: boolean + remove_trailing: + type: boolean + stopwords: + $ref: '#/components/schemas/_common.analysis:StopWords' + stopwords_path: + type: string required: - type - _common.mapping:WildcardProperty: + _common.analysis:StopWords: + description: |- + 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: + - type: string + - type: array + items: + type: string + _common.analysis:SynonymFormat: + type: string + enum: + - solr + - wordnet + _common.analysis:SynonymGraphTokenFilter: allOf: - - $ref: '#/components/schemas/_common.mapping:DocValuesPropertyBase' + - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' - type: object properties: type: type: string enum: - - wildcard - null_value: + - synonym_graph + expand: + type: boolean + format: + $ref: '#/components/schemas/_common.analysis:SynonymFormat' + lenient: + type: boolean + synonyms: + type: array + items: + type: string + synonyms_path: type: string + tokenizer: + type: string + updateable: + type: boolean required: - type - _common.query_dsl:BoolQuery: - allOf: - - $ref: '#/components/schemas/_common.query_dsl:QueryBase' - - type: object - properties: - filter: - description: |- - 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' - - type: array - items: - $ref: '#/components/schemas/_common.query_dsl:QueryContainer' - minimum_should_match: - $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' - - type: array - items: - $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' - - type: array - items: - $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' - - type: array - items: - $ref: '#/components/schemas/_common.query_dsl:QueryContainer' - _common.query_dsl:BoostingQuery: - allOf: - - $ref: '#/components/schemas/_common.query_dsl:QueryBase' - - type: object - properties: - negative_boost: - description: Floating point number between 0 and 1.0 used to decrease the relevance scores of documents matching the `negative` query. - type: number - negative: - $ref: '#/components/schemas/_common.query_dsl:QueryContainer' - positive: - $ref: '#/components/schemas/_common.query_dsl:QueryContainer' - required: - - negative_boost - - negative - - positive - _common.query_dsl:ChildScoreMode: - type: string - enum: - - none - - avg - - sum - - max - - min - _common.query_dsl:CombinedFieldsOperator: - type: string - enum: - - or - - and - _common.query_dsl:CombinedFieldsQuery: + _common.analysis:SynonymTokenFilter: allOf: - - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' - 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: + type: string + enum: + - synonym + expand: + type: boolean + format: + $ref: '#/components/schemas/_common.analysis:SynonymFormat' + lenient: + type: boolean + synonyms: type: array items: - $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 + synonyms_path: type: string - auto_generate_synonyms_phrase_query: - description: If true, match phrase queries are automatically created for multi-term synonyms. + tokenizer: + type: string + updateable: type: boolean - operator: - $ref: '#/components/schemas/_common.query_dsl:CombinedFieldsOperator' - minimum_should_match: - $ref: '#/components/schemas/_common:MinimumShouldMatch' - zero_terms_query: - $ref: '#/components/schemas/_common.query_dsl:CombinedFieldsZeroTerms' required: - - fields - - query - _common.query_dsl:CombinedFieldsZeroTerms: + - type + _common.analysis:TokenChar: type: string enum: - - none - - all - _common.query_dsl:CommonTermsQuery: - allOf: - - $ref: '#/components/schemas/_common.query_dsl:QueryBase' - - type: object - properties: - analyzer: - type: string - cutoff_frequency: - type: number - high_freq_operator: - $ref: '#/components/schemas/_common.query_dsl:Operator' - low_freq_operator: - $ref: '#/components/schemas/_common.query_dsl:Operator' - minimum_should_match: - $ref: '#/components/schemas/_common:MinimumShouldMatch' - query: - type: string - required: - - query - _common.query_dsl:ConstantScoreQuery: - allOf: - - $ref: '#/components/schemas/_common.query_dsl:QueryBase' - - type: object - properties: - filter: - $ref: '#/components/schemas/_common.query_dsl:QueryContainer' - required: - - filter - _common.query_dsl:DateDecayFunction: - allOf: - - $ref: '#/components/schemas/_common.query_dsl:DecayFunctionBase' - - type: object - _common.query_dsl:DateDistanceFeatureQuery: - allOf: - - $ref: '#/components/schemas/_common.query_dsl:DistanceFeatureQueryBaseDateMathDuration' - - type: object - _common.query_dsl:DateRangeQuery: - allOf: - - $ref: '#/components/schemas/_common.query_dsl:RangeQueryBase' - - type: object - properties: - gt: - $ref: '#/components/schemas/_common:DateMath' - gte: - $ref: '#/components/schemas/_common:DateMath' - lt: - $ref: '#/components/schemas/_common:DateMath' - lte: - $ref: '#/components/schemas/_common:DateMath' - from: - oneOf: - - $ref: '#/components/schemas/_common:DateMath' - - nullable: true - type: string - to: - oneOf: - - $ref: '#/components/schemas/_common:DateMath' - - nullable: true - type: string - format: - $ref: '#/components/schemas/_common:DateFormat' - time_zone: - $ref: '#/components/schemas/_common:TimeZone' - _common.query_dsl:DecayFunction: + - custom + - digit + - letter + - punctuation + - symbol + - whitespace + _common.analysis:TokenFilter: 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: + - type: string + - $ref: '#/components/schemas/_common.analysis:TokenFilterDefinition' + _common.analysis:TokenFilterBase: type: object properties: - multi_value_mode: - $ref: '#/components/schemas/_common.query_dsl:MultiValueMode' - _common.query_dsl:DisMaxQuery: + version: + $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: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' + _common.analysis:Tokenizer: + oneOf: + - type: string + - $ref: '#/components/schemas/_common.analysis:TokenizerDefinition' + _common.analysis:TokenizerBase: + type: object + properties: + version: + $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' + _common.analysis:TrimTokenFilter: + allOf: + - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' + - type: object + properties: + type: + type: string + enum: + - trim + required: + - type + _common.analysis:TruncateTokenFilter: allOf: - - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' - type: object properties: - queries: - description: |- - One or more query clauses. - Returned documents must match one or more of these queries. - If a document matches multiple queries, Opensearch uses the highest relevance score. - type: array - items: - $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: + type: string + enum: + - truncate + length: type: number required: - - queries - _common.query_dsl:DistanceFeatureQuery: - oneOf: - - $ref: '#/components/schemas/_common.query_dsl:GeoDistanceFeatureQuery' - - $ref: '#/components/schemas/_common.query_dsl:DateDistanceFeatureQuery' - _common.query_dsl:DistanceFeatureQueryBaseDateMathDuration: + - type + _common.analysis:UaxEmailUrlTokenizer: allOf: - - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - $ref: '#/components/schemas/_common.analysis:TokenizerBase' - type: object properties: - origin: - $ref: '#/components/schemas/_common:DateMath' - pivot: - $ref: '#/components/schemas/_common:Duration' - field: - $ref: '#/components/schemas/_common:Field' + type: + type: string + enum: + - uax_url_email + max_token_length: + type: number required: - - origin - - pivot - - field - _common.query_dsl:DistanceFeatureQueryBaseGeoLocationDistance: + - type + _common.analysis:UniqueTokenFilter: allOf: - - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' - type: object properties: - origin: - $ref: '#/components/schemas/_common:GeoLocation' - pivot: - $ref: '#/components/schemas/_common:Distance' - field: - $ref: '#/components/schemas/_common:Field' + type: + type: string + enum: + - unique + only_on_same_position: + type: boolean required: - - origin - - pivot - - field - _common.query_dsl:ExistsQuery: + - type + _common.analysis:UppercaseTokenFilter: allOf: - - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' - type: object properties: - field: - $ref: '#/components/schemas/_common:Field' + type: + type: string + enum: + - uppercase required: - - field - _common.query_dsl:FieldAndFormat: + - type + _common.analysis:WhitespaceAnalyzer: type: object properties: - field: - $ref: '#/components/schemas/_common:Field' - format: - description: Format in which the values are returned. + type: type: string - include_unmapped: - type: boolean - required: - - field - _common.query_dsl:FieldValueFactorModifier: - type: string - enum: - - none - - log - - log1p - - log2p - - ln - - ln1p - - ln2p - - square - - sqrt - - reciprocal - _common.query_dsl:FieldValueFactorScoreFunction: - type: object - properties: - field: - $ref: '#/components/schemas/_common:Field' - factor: - description: Optional factor to multiply the field value with. - type: number - missing: - description: |- - Value used if the document doesn’t have that field. - The modifier and factor are still applied to it as though it were read from the document. - type: number - modifier: - $ref: '#/components/schemas/_common.query_dsl:FieldValueFactorModifier' + enum: + - whitespace + version: + $ref: '#/components/schemas/_common:VersionString' required: - - field - _common.query_dsl:FunctionBoostMode: - type: string - enum: - - multiply - - replace - - sum - - avg - - max - - min - _common.query_dsl:FunctionScoreContainer: - allOf: - - type: object - properties: - filter: - $ref: '#/components/schemas/_common.query_dsl:QueryContainer' - weight: - type: number - - type: object - properties: - exp: - $ref: '#/components/schemas/_common.query_dsl:DecayFunction' - gauss: - $ref: '#/components/schemas/_common.query_dsl:DecayFunction' - linear: - $ref: '#/components/schemas/_common.query_dsl:DecayFunction' - field_value_factor: - $ref: '#/components/schemas/_common.query_dsl:FieldValueFactorScoreFunction' - random_score: - $ref: '#/components/schemas/_common.query_dsl:RandomScoreFunction' - script_score: - $ref: '#/components/schemas/_common.query_dsl:ScriptScoreFunction' - minProperties: 1 - maxProperties: 1 - _common.query_dsl:FunctionScoreMode: - type: string - enum: - - multiply - - sum - - avg - - first - - max - - min - _common.query_dsl:FunctionScoreQuery: - allOf: - - $ref: '#/components/schemas/_common.query_dsl:QueryBase' - - type: object - properties: - boost_mode: - $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' - max_boost: - description: Restricts the new score to not exceed the provided limit. - type: number - min_score: - description: Excludes documents that do not meet the provided score threshold. - type: number - query: - $ref: '#/components/schemas/_common.query_dsl:QueryContainer' - score_mode: - $ref: '#/components/schemas/_common.query_dsl:FunctionScoreMode' - _common.query_dsl:FuzzyQuery: + - type + _common.analysis:WhitespaceTokenizer: allOf: - - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - $ref: '#/components/schemas/_common.analysis:TokenizerBase' - type: object properties: - max_expansions: - description: Maximum number of variations created. - type: number - prefix_length: - description: Number of beginning characters left unchanged when creating expansions. + type: + type: string + enum: + - whitespace + max_token_length: type: number - rewrite: - $ref: '#/components/schemas/_common:MultiTermQueryRewrite' - transpositions: - description: Indicates whether edits include transpositions of two adjacent characters (for example `ab` to `ba`). - type: boolean - fuzziness: - $ref: '#/components/schemas/_common:Fuzziness' - value: - description: Term you wish to find in the provided field. - oneOf: - - type: string - - type: number - - type: boolean required: - - value - _common.query_dsl:GeoBoundingBoxQuery: + - type + _common.analysis:WordDelimiterGraphTokenFilter: allOf: - - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' - type: object properties: type: - $ref: '#/components/schemas/_common.query_dsl:GeoExecution' - validation_method: - $ref: '#/components/schemas/_common.query_dsl:GeoValidationMethod' - ignore_unmapped: - description: |- - Set to `true` to ignore an unmapped field and not match any documents for this query. - Set to `false` to throw an exception if the field is not mapped. + type: string + enum: + - word_delimiter_graph + adjust_offsets: type: boolean - _common.query_dsl:GeoDecayFunction: - allOf: - - $ref: '#/components/schemas/_common.query_dsl:DecayFunctionBase' - - type: object - _common.query_dsl:GeoDistanceFeatureQuery: - allOf: - - $ref: '#/components/schemas/_common.query_dsl:DistanceFeatureQueryBaseGeoLocationDistance' - - type: object - _common.query_dsl:GeoDistanceQuery: - allOf: - - $ref: '#/components/schemas/_common.query_dsl:QueryBase' - - type: object - properties: - distance: - $ref: '#/components/schemas/_common:Distance' - distance_type: - $ref: '#/components/schemas/_common:GeoDistanceType' - validation_method: - $ref: '#/components/schemas/_common.query_dsl:GeoValidationMethod' - required: - - distance - _common.query_dsl:GeoExecution: - type: string - enum: - - memory - - indexed - _common.query_dsl:GeoPolygonQuery: - allOf: - - $ref: '#/components/schemas/_common.query_dsl:QueryBase' - - type: object - properties: - validation_method: - $ref: '#/components/schemas/_common.query_dsl:GeoValidationMethod' - ignore_unmapped: + catenate_all: type: boolean - _common.query_dsl:GeoShapeQuery: - allOf: - - $ref: '#/components/schemas/_common.query_dsl:QueryBase' - - type: object - properties: - ignore_unmapped: - description: |- - Set to `true` to ignore an unmapped field and not match any documents for this query. - Set to `false` to throw an exception if the field is not mapped. + catenate_numbers: type: boolean - _common.query_dsl:GeoValidationMethod: - type: string - enum: - - coerce - - ignore_malformed - - strict - _common.query_dsl:HasChildQuery: - allOf: - - $ref: '#/components/schemas/_common.query_dsl:QueryBase' - - type: object - properties: - ignore_unmapped: - description: Indicates whether to ignore an unmapped `type` and not return any documents instead of an error. + catenate_words: type: boolean - inner_hits: - $ref: '#/components/schemas/_core.search:InnerHits' - max_children: - description: |- - Maximum number of child documents that match the query allowed for a returned parent document. - If the parent document exceeds this limit, it is excluded from the search results. - type: number - min_children: - description: |- - Minimum number of child documents that match the query required to match the query for a returned parent document. - If the parent document does not meet this limit, it is excluded from the search results. - type: number - query: - $ref: '#/components/schemas/_common.query_dsl:QueryContainer' - score_mode: - $ref: '#/components/schemas/_common.query_dsl:ChildScoreMode' - type: - $ref: '#/components/schemas/_common:RelationName' + generate_number_parts: + type: boolean + generate_word_parts: + type: boolean + ignore_keywords: + type: boolean + preserve_original: + $ref: '#/components/schemas/_common:Stringifiedboolean' + protected_words: + type: array + items: + type: string + protected_words_path: + type: string + split_on_case_change: + type: boolean + split_on_numerics: + type: boolean + stem_english_possessive: + type: boolean + type_table: + type: array + items: + type: string + type_table_path: + type: string required: - - query - type - _common.query_dsl:HasParentQuery: + _common.analysis:WordDelimiterTokenFilter: allOf: - - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' - type: object properties: - ignore_unmapped: - description: |- - Indicates whether to ignore an unmapped `parent_type` and not return any documents instead of an error. - You can use this parameter to query multiple indices that may not contain the `parent_type`. + type: + type: string + enum: + - word_delimiter + catenate_all: type: boolean - inner_hits: - $ref: '#/components/schemas/_core.search:InnerHits' - parent_type: - $ref: '#/components/schemas/_common:RelationName' - query: - $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. + catenate_numbers: type: boolean - required: - - parent_type - - query - _common.query_dsl:IdsQuery: - allOf: - - $ref: '#/components/schemas/_common.query_dsl:QueryBase' - - type: object - properties: - values: - $ref: '#/components/schemas/_common:Ids' - _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' - max_gaps: - description: |- - Maximum number of positions between the matching terms. - Intervals produced by the rules further apart than this are not considered matches. - type: number - ordered: - 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' - required: - - intervals - _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' - filter: - $ref: '#/components/schemas/_common.query_dsl:IntervalsFilter' - required: - - intervals - _common.query_dsl:IntervalsContainer: - type: object - properties: - all_of: - $ref: '#/components/schemas/_common.query_dsl:IntervalsAllOf' - any_of: - $ref: '#/components/schemas/_common.query_dsl:IntervalsAnyOf' - fuzzy: - $ref: '#/components/schemas/_common.query_dsl:IntervalsFuzzy' - match: - $ref: '#/components/schemas/_common.query_dsl:IntervalsMatch' - prefix: - $ref: '#/components/schemas/_common.query_dsl:IntervalsPrefix' - wildcard: - $ref: '#/components/schemas/_common.query_dsl:IntervalsWildcard' - minProperties: 1 - maxProperties: 1 - _common.query_dsl:IntervalsFilter: - type: object - properties: - after: - $ref: '#/components/schemas/_common.query_dsl:IntervalsContainer' - before: - $ref: '#/components/schemas/_common.query_dsl:IntervalsContainer' - contained_by: - $ref: '#/components/schemas/_common.query_dsl:IntervalsContainer' - containing: - $ref: '#/components/schemas/_common.query_dsl:IntervalsContainer' - not_contained_by: - $ref: '#/components/schemas/_common.query_dsl:IntervalsContainer' - not_containing: - $ref: '#/components/schemas/_common.query_dsl:IntervalsContainer' - not_overlapping: - $ref: '#/components/schemas/_common.query_dsl:IntervalsContainer' - overlapping: - $ref: '#/components/schemas/_common.query_dsl:IntervalsContainer' - script: - $ref: '#/components/schemas/_common:Script' - minProperties: 1 - maxProperties: 1 - _common.query_dsl:IntervalsFuzzy: - type: object - properties: - analyzer: - description: Analyzer used to normalize the term. - type: string - fuzziness: - $ref: '#/components/schemas/_common:Fuzziness' - prefix_length: - description: Number of beginning characters left unchanged when creating expansions. - type: number - term: - description: The term to match. - type: string - transpositions: - description: Indicates whether edits include transpositions of two adjacent characters (for example, `ab` to `ba`). - type: boolean - use_field: - $ref: '#/components/schemas/_common:Field' - required: - - term - _common.query_dsl:IntervalsMatch: - type: object - properties: - analyzer: - description: Analyzer used to analyze terms in the query. - type: string - max_gaps: - description: |- - Maximum number of positions between the matching terms. - Terms further apart than this are not considered matches. - type: number - ordered: - description: If `true`, matching terms must appear in their specified order. - type: boolean - query: - description: Text you wish to find in the provided field. - type: string - use_field: - $ref: '#/components/schemas/_common:Field' - filter: - $ref: '#/components/schemas/_common.query_dsl:IntervalsFilter' - required: - - query - _common.query_dsl:IntervalsPrefix: - type: object - properties: - analyzer: - description: Analyzer used to analyze the `prefix`. - type: string - prefix: - description: Beginning characters of terms you wish to find in the top-level field. - type: string - use_field: - $ref: '#/components/schemas/_common:Field' - required: - - prefix - _common.query_dsl:IntervalsQuery: + catenate_words: + type: boolean + generate_number_parts: + type: boolean + generate_word_parts: + type: boolean + preserve_original: + $ref: '#/components/schemas/_common:Stringifiedboolean' + protected_words: + type: array + items: + type: string + protected_words_path: + type: string + split_on_case_change: + type: boolean + split_on_numerics: + type: boolean + stem_english_possessive: + type: boolean + type_table: + type: array + items: + type: string + type_table_path: + type: string + required: + - type + _common.mapping:AggregateMetricDoubleProperty: allOf: - - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - $ref: '#/components/schemas/_common.mapping:PropertyBase' - type: object properties: - all_of: - $ref: '#/components/schemas/_common.query_dsl:IntervalsAllOf' - any_of: - $ref: '#/components/schemas/_common.query_dsl:IntervalsAnyOf' - fuzzy: - $ref: '#/components/schemas/_common.query_dsl:IntervalsFuzzy' - match: - $ref: '#/components/schemas/_common.query_dsl:IntervalsMatch' - prefix: - $ref: '#/components/schemas/_common.query_dsl:IntervalsPrefix' - wildcard: - $ref: '#/components/schemas/_common.query_dsl:IntervalsWildcard' - minProperties: 1 - maxProperties: 1 - _common.query_dsl:IntervalsWildcard: + type: + type: string + enum: + - aggregate_metric_double + default_metric: + type: string + metrics: + type: array + items: + type: string + time_series_metric: + $ref: '#/components/schemas/_common.mapping:TimeSeriesMetricType' + required: + - default_metric + - metrics + - type + _common.mapping:AllField: type: object properties: analyzer: - description: |- - Analyzer used to analyze the `pattern`. - Defaults to the top-level field's analyzer. type: string - pattern: - description: Wildcard pattern used to find matching terms. + enabled: + type: boolean + omit_norms: + type: boolean + search_analyzer: type: string - use_field: - $ref: '#/components/schemas/_common:Field' + similarity: + type: string + store: + type: boolean + store_term_vector_offsets: + type: boolean + store_term_vector_payloads: + type: boolean + store_term_vector_positions: + type: boolean + store_term_vectors: + type: boolean required: - - pattern - _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: - type: object - properties: - doc: - description: A document not present in the index. - type: object - fields: - type: array - items: - $ref: '#/components/schemas/_common:Field' - _id: - $ref: '#/components/schemas/_common:Id' - _index: - $ref: '#/components/schemas/_common:IndexName' - per_field_analyzer: - type: object - additionalProperties: - type: string - routing: - $ref: '#/components/schemas/_common:Routing' - version: - $ref: '#/components/schemas/_common:VersionNumber' - version_type: - $ref: '#/components/schemas/_common:VersionType' - _common.query_dsl:MatchAllQuery: + - analyzer + - enabled + - omit_norms + - search_analyzer + - similarity + - store + - store_term_vector_offsets + - store_term_vector_payloads + - store_term_vector_positions + - store_term_vectors + _common.mapping:BinaryProperty: allOf: - - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - $ref: '#/components/schemas/_common.mapping:DocValuesPropertyBase' - type: object - _common.query_dsl:MatchBoolPrefixQuery: + properties: + type: + type: string + enum: + - binary + required: + - type + _common.mapping:BooleanProperty: allOf: - - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - $ref: '#/components/schemas/_common.mapping:DocValuesPropertyBase' - 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' - fuzzy_rewrite: - $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`). - Can be applied to the term subqueries constructed for all terms but the final term. - type: boolean - max_expansions: - description: |- - Maximum number of terms to which the query will expand. - Can be applied to the term subqueries constructed for all terms but the final term. - type: number - minimum_should_match: - $ref: '#/components/schemas/_common:MinimumShouldMatch' - operator: - $ref: '#/components/schemas/_common.query_dsl:Operator' - prefix_length: - description: |- - Number of beginning characters left unchanged for fuzzy matching. - Can be applied to the term subqueries constructed for all terms but the final term. + boost: type: number - query: - description: |- - Terms you wish to find in the provided field. - The last term is used in a prefix query. + fielddata: + $ref: '#/components/schemas/indices._common:NumericFielddata' + index: + type: boolean + null_value: + type: boolean + type: type: string + enum: + - boolean required: - - query - _common.query_dsl:MatchNoneQuery: + - type + _common.mapping:ByteNumberProperty: allOf: - - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - $ref: '#/components/schemas/_common.mapping:NumberPropertyBase' - type: object - _common.query_dsl:MatchPhrasePrefixQuery: + properties: + type: + type: string + enum: + - byte + null_value: + $ref: '#/components/schemas/_common:byte' + required: + - type + _common.mapping:CompletionProperty: allOf: - - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - $ref: '#/components/schemas/_common.mapping:DocValuesPropertyBase' - type: object properties: analyzer: - description: Analyzer used to convert text in the query value into tokens. type: string - max_expansions: - description: Maximum number of terms to which the last provided term of the query value will expand. + contexts: + type: array + items: + $ref: '#/components/schemas/_common.mapping:SuggestContext' + max_input_length: type: number - query: - description: Text you wish to find in the provided field. + preserve_position_increments: + type: boolean + preserve_separators: + type: boolean + search_analyzer: type: string - slop: - description: Maximum number of positions allowed between matching tokens. - type: number - zero_terms_query: - $ref: '#/components/schemas/_common.query_dsl:ZeroTermsQuery' + type: + type: string + enum: + - completion required: - - query - _common.query_dsl:MatchPhraseQuery: + - type + _common.mapping:ConstantKeywordProperty: allOf: - - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - $ref: '#/components/schemas/_common.mapping:PropertyBase' - type: object properties: - analyzer: - description: Analyzer used to convert the text in the query value into tokens. - type: string - query: - description: Query terms that are analyzed and turned into a phrase query. + value: + type: object + type: type: string - slop: - description: Maximum number of positions allowed between matching tokens. - type: number - zero_terms_query: - $ref: '#/components/schemas/_common.query_dsl:ZeroTermsQuery' + enum: + - constant_keyword required: - - query - _common.query_dsl:MatchQuery: + - type + _common.mapping:CorePropertyBase: allOf: - - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - $ref: '#/components/schemas/_common.mapping:PropertyBase' - type: object properties: - analyzer: - description: Analyzer used to convert the text in the query value into tokens. + copy_to: + $ref: '#/components/schemas/_common:Fields' + similarity: type: string - auto_generate_synonyms_phrase_query: - description: If `true`, match phrase queries are automatically created for multi-term synonyms. + store: type: boolean - cutoff_frequency: - deprecated: true + _common.mapping:DataStreamTimestamp: + type: object + properties: + enabled: + type: boolean + required: + - enabled + _common.mapping:DateNanosProperty: + allOf: + - $ref: '#/components/schemas/_common.mapping:DocValuesPropertyBase' + - type: object + properties: + boost: type: number - fuzziness: - $ref: '#/components/schemas/_common:Fuzziness' - fuzzy_rewrite: - $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`). + format: + type: string + ignore_malformed: type: boolean - lenient: - description: If `true`, format-based errors, such as providing a text query value for a numeric field, are ignored. + index: type: boolean - max_expansions: - description: Maximum number of terms to which the query will expand. - type: number - minimum_should_match: - $ref: '#/components/schemas/_common:MinimumShouldMatch' - operator: - $ref: '#/components/schemas/_common.query_dsl:Operator' - prefix_length: - description: Number of beginning characters left unchanged for fuzzy matching. + null_value: + $ref: '#/components/schemas/_common:DateTime' + precision_step: type: number - query: - 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' + type: + type: string + enum: + - date_nanos required: - - query - _common.query_dsl:MoreLikeThisQuery: + - type + _common.mapping:DateProperty: allOf: - - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - $ref: '#/components/schemas/_common.mapping:DocValuesPropertyBase' - type: object properties: - analyzer: - description: |- - The analyzer that is used to analyze the free form text. - Defaults to the analyzer associated with the first field in fields. - type: string - boost_terms: - description: |- - Each term in the formed query could be further boosted by their tf-idf score. - This sets the boost factor to use when using this feature. - Defaults to deactivated (0). + boost: type: number - fail_on_unsupported_field: - description: Controls whether the query should fail (throw an exception) if any of the specified fields are not of the supported types (`text` or `keyword`). + fielddata: + $ref: '#/components/schemas/indices._common:NumericFielddata' + format: + type: string + ignore_malformed: type: boolean - fields: - description: |- - A list of fields to fetch and analyze the text from. - Defaults to the `index.query.default_field` index setting, which has a default value of `*`. - type: array - items: - $ref: '#/components/schemas/_common:Field' - include: - description: Specifies whether the input documents should also be included in the search results returned. + index: 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' - - type: array - items: - $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: number - max_query_terms: - description: The maximum number of query terms that can be selected. - type: number - max_word_length: - description: |- - The maximum word length above which the terms are ignored. - Defaults to unbounded (`0`). - type: number - min_doc_freq: - description: The minimum document frequency below which the terms are ignored from the input document. + null_value: + $ref: '#/components/schemas/_common:DateTime' + precision_step: type: number - minimum_should_match: - $ref: '#/components/schemas/_common:MinimumShouldMatch' - min_term_freq: - description: The minimum term frequency below which the terms are ignored from the input document. + locale: + type: string + type: + type: string + enum: + - date + required: + - type + _common.mapping:DateRangeProperty: + allOf: + - $ref: '#/components/schemas/_common.mapping:RangePropertyBase' + - type: object + properties: + format: + type: string + type: + type: string + enum: + - 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: + allOf: + - $ref: '#/components/schemas/_common.mapping:PropertyBase' + - type: object + properties: + type: + type: string + enum: + - dense_vector + dims: type: number - min_word_length: - description: The minimum word length below which the terms are ignored. + 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' + - type: object + properties: + doc_values: + type: boolean + _common.mapping:DoubleNumberProperty: + allOf: + - $ref: '#/components/schemas/_common.mapping:NumberPropertyBase' + - type: object + properties: + type: + type: string + enum: + - double + null_value: type: number - per_field_analyzer: - description: Overrides the default analyzer. - type: object - additionalProperties: - type: string - routing: - $ref: '#/components/schemas/_common:Routing' - stop_words: - $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' - - type: array - items: - $ref: '#/components/schemas/_common.query_dsl:Like' - version: - $ref: '#/components/schemas/_common:VersionNumber' - version_type: - $ref: '#/components/schemas/_common:VersionType' required: - - like - _common.query_dsl:MultiMatchQuery: + - type + _common.mapping:DoubleRangeProperty: allOf: - - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - $ref: '#/components/schemas/_common.mapping:RangePropertyBase' - type: object properties: - analyzer: - description: Analyzer used to convert the text in the query value into tokens. + type: type: string - auto_generate_synonyms_phrase_query: - description: If `true`, match phrase queries are automatically created for multi-term synonyms. + enum: + - double_range + required: + - type + _common.mapping:DynamicMapping: + type: string + enum: + - 'false' + - runtime + - strict + - 'true' + _common.mapping:DynamicProperty: + allOf: + - $ref: '#/components/schemas/_common.mapping:DocValuesPropertyBase' + - type: object + properties: + type: + type: string + enum: + - '{dynamic_property}' + enabled: type: boolean - cutoff_frequency: - deprecated: true + null_value: + $ref: '#/components/schemas/_common:FieldValue' + boost: type: number - fields: - $ref: '#/components/schemas/_common:Fields' - fuzziness: - $ref: '#/components/schemas/_common:Fuzziness' - fuzzy_rewrite: - $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`). - Can be applied to the term subqueries constructed for all terms but the final term. + coerce: + type: boolean + script: + $ref: '#/components/schemas/_common:Script' + on_script_error: + $ref: '#/components/schemas/_common.mapping:OnScriptError' + ignore_malformed: + type: boolean + time_series_metric: + $ref: '#/components/schemas/_common.mapping:TimeSeriesMetricType' + analyzer: + type: string + eager_global_ordinals: + type: boolean + index: + type: boolean + index_options: + $ref: '#/components/schemas/_common.mapping:IndexOptions' + index_phrases: type: boolean - lenient: - description: If `true`, format-based errors, such as providing a text query value for a numeric field, are ignored. + index_prefixes: + $ref: '#/components/schemas/_common.mapping:TextIndexPrefixes' + norms: type: boolean - max_expansions: - description: Maximum number of terms to which the query will expand. - type: number - minimum_should_match: - $ref: '#/components/schemas/_common:MinimumShouldMatch' - operator: - $ref: '#/components/schemas/_common.query_dsl:Operator' - prefix_length: - description: Number of beginning characters left unchanged for fuzzy matching. + position_increment_gap: type: number - query: - description: Text, number, boolean value or date you wish to find in the provided field. + search_analyzer: type: string - slop: - description: Maximum number of positions allowed between matching tokens. - type: number - tie_breaker: - description: Determines how scores for each per-term blended query and scores across groups are combined. + search_quote_analyzer: + type: string + term_vector: + $ref: '#/components/schemas/_common.mapping:TermVectorOption' + format: + type: string + precision_step: type: number - type: - $ref: '#/components/schemas/_common.query_dsl:TextQueryType' - zero_terms_query: - $ref: '#/components/schemas/_common.query_dsl:ZeroTermsQuery' + locale: + type: string required: - - query - _common.query_dsl:MultiValueMode: - type: string - enum: - - min - - max - - avg - - sum - _common.query_dsl:NestedQuery: + - type + _common.mapping:DynamicTemplate: + type: object + properties: + mapping: + $ref: '#/components/schemas/_common.mapping:Property' + match: + type: string + match_mapping_type: + type: string + match_pattern: + $ref: '#/components/schemas/_common.mapping:MatchType' + path_match: + type: string + path_unmatch: + type: string + unmatch: + type: string + _common.mapping:FieldAliasProperty: allOf: - - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - $ref: '#/components/schemas/_common.mapping:PropertyBase' - type: object properties: - ignore_unmapped: - description: Indicates whether to ignore an unmapped path and not return any documents instead of an error. - type: boolean - inner_hits: - $ref: '#/components/schemas/_core.search:InnerHits' path: $ref: '#/components/schemas/_common:Field' - query: - $ref: '#/components/schemas/_common.query_dsl:QueryContainer' - score_mode: - $ref: '#/components/schemas/_common.query_dsl:ChildScoreMode' + type: + type: string + enum: + - alias required: - - path - - query - _common.query_dsl:NumberRangeQuery: + - type + _common.mapping:FieldMapping: + type: object + properties: + full_name: + type: string + mapping: + type: object + additionalProperties: + $ref: '#/components/schemas/_common.mapping:Property' + minProperties: 1 + maxProperties: 1 + required: + - full_name + - mapping + _common.mapping:FieldNamesField: + type: object + properties: + enabled: + type: boolean + required: + - enabled + _common.mapping:FlattenedProperty: allOf: - - $ref: '#/components/schemas/_common.query_dsl:RangeQueryBase' + - $ref: '#/components/schemas/_common.mapping:PropertyBase' - type: object properties: - gt: - description: Greater than. - type: number - gte: - description: Greater than or equal to. + boost: type: number - lt: - description: Less than. + depth_limit: type: number - lte: - description: Less than or equal to. + doc_values: + type: boolean + eager_global_ordinals: + type: boolean + index: + type: boolean + index_options: + $ref: '#/components/schemas/_common.mapping:IndexOptions' + null_value: + type: string + similarity: + type: string + split_queries_on_whitespace: + type: boolean + type: + type: string + enum: + - flattened + required: + - type + _common.mapping:FloatNumberProperty: + allOf: + - $ref: '#/components/schemas/_common.mapping:NumberPropertyBase' + - type: object + properties: + type: + type: string + enum: + - float + null_value: type: number - from: - oneOf: - - type: number - - nullable: true - type: string - to: - oneOf: - - type: number - - nullable: true - type: string - _common.query_dsl:NumericDecayFunction: + required: + - type + _common.mapping:FloatRangeProperty: allOf: - - $ref: '#/components/schemas/_common.query_dsl:DecayFunctionBase' + - $ref: '#/components/schemas/_common.mapping:RangePropertyBase' - type: object - _common.query_dsl:Operator: + properties: + type: + type: string + enum: + - float_range + required: + - type + _common.mapping:GeoOrientation: type: string enum: - - and - - or - _common.query_dsl:ParentIdQuery: + - left + - right + _common.mapping:GeoPointProperty: allOf: - - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - $ref: '#/components/schemas/_common.mapping:DocValuesPropertyBase' - type: object properties: - id: - $ref: '#/components/schemas/_common:Id' - ignore_unmapped: - description: Indicates whether to ignore an unmapped `type` and not return any documents instead of an error. + ignore_malformed: + type: boolean + ignore_z_value: type: boolean + null_value: + $ref: '#/components/schemas/_common:GeoLocation' type: - $ref: '#/components/schemas/_common:RelationName' - _common.query_dsl:PercolateQuery: - allOf: - - $ref: '#/components/schemas/_common.query_dsl:QueryBase' - - type: object - properties: - document: - description: The source of the document being percolated. - type: object - documents: - description: An array of sources of the documents being percolated. - type: array - items: - type: object - field: - $ref: '#/components/schemas/_common:Field' - id: - $ref: '#/components/schemas/_common:Id' - index: - $ref: '#/components/schemas/_common:IndexName' - name: - description: The suffix used for the `_percolator_document_slot` field when multiple `percolate` queries are specified. - type: string - preference: - description: Preference used to fetch document to percolate. type: string - routing: - $ref: '#/components/schemas/_common:Routing' - version: - $ref: '#/components/schemas/_common:VersionNumber' + enum: + - geo_point required: - - field - _common.query_dsl:PinnedDoc: - type: object - properties: - _id: - $ref: '#/components/schemas/_common:Id' - _index: - $ref: '#/components/schemas/_common:IndexName' - required: - - _id - - _index - _common.query_dsl:PinnedQuery: - allOf: - - $ref: '#/components/schemas/_common.query_dsl:QueryBase' - - allOf: - - type: object - properties: - organic: - $ref: '#/components/schemas/_common.query_dsl:QueryContainer' - required: - - organic - - type: object - properties: - ids: - description: |- - Document IDs listed in the order they are to appear in results. - Required if `docs` is not specified. - type: array - items: - $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' - minProperties: 1 - maxProperties: 1 - _common.query_dsl:PrefixQuery: + - type + _common.mapping:GeoShapeProperty: allOf: - - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - $ref: '#/components/schemas/_common.mapping:DocValuesPropertyBase' - type: object properties: - rewrite: - $ref: '#/components/schemas/_common:MultiTermQueryRewrite' - value: - description: Beginning characters of terms you wish to find in the provided field. - type: string - case_insensitive: - description: |- - Allows ASCII case insensitive matching of the value 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. + coerce: type: boolean - required: - - value - _common.query_dsl:QueryBase: - type: object - properties: - boost: - description: |- - Floating point number used to decrease or increase the relevance scores of the query. - Boost values are relative to the default value of 1.0. - A boost value between 0 and 1.0 decreases the relevance score. - A value greater than 1.0 increases the relevance score. - type: number - _name: - type: string - _common.query_dsl:QueryContainer: - type: object - properties: - bool: - $ref: '#/components/schemas/_common.query_dsl:BoolQuery' - boosting: - $ref: '#/components/schemas/_common.query_dsl:BoostingQuery' - common: - deprecated: true - type: object - additionalProperties: - $ref: '#/components/schemas/_common.query_dsl:CommonTermsQuery' - minProperties: 1 - maxProperties: 1 - combined_fields: - $ref: '#/components/schemas/_common.query_dsl:CombinedFieldsQuery' - constant_score: - $ref: '#/components/schemas/_common.query_dsl:ConstantScoreQuery' - dis_max: - $ref: '#/components/schemas/_common.query_dsl:DisMaxQuery' - distance_feature: - $ref: '#/components/schemas/_common.query_dsl:DistanceFeatureQuery' - exists: - $ref: '#/components/schemas/_common.query_dsl:ExistsQuery' - function_score: - $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' - minProperties: 1 - maxProperties: 1 - geo_bounding_box: - $ref: '#/components/schemas/_common.query_dsl:GeoBoundingBoxQuery' - geo_distance: - $ref: '#/components/schemas/_common.query_dsl:GeoDistanceQuery' - geo_polygon: - $ref: '#/components/schemas/_common.query_dsl:GeoPolygonQuery' - geo_shape: - $ref: '#/components/schemas/_common.query_dsl:GeoShapeQuery' - has_child: - $ref: '#/components/schemas/_common.query_dsl:HasChildQuery' - has_parent: - $ref: '#/components/schemas/_common.query_dsl:HasParentQuery' - ids: - $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' - minProperties: 1 - maxProperties: 1 - match: - description: |- - Returns documents that match a provided text, number, date or boolean value. - The provided text is analyzed before matching. - type: object - additionalProperties: - $ref: '#/components/schemas/_common.query_dsl:MatchQuery' - minProperties: 1 - maxProperties: 1 - match_all: - $ref: '#/components/schemas/_common.query_dsl:MatchAllQuery' - match_bool_prefix: - description: |- - Analyzes its input and constructs a `bool` query from the terms. - Each term except the last is used in a `term` query. - The last term is used in a prefix query. - type: object - additionalProperties: - $ref: '#/components/schemas/_common.query_dsl:MatchBoolPrefixQuery' - minProperties: 1 - maxProperties: 1 - match_none: - $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' - minProperties: 1 - maxProperties: 1 - match_phrase_prefix: - description: |- - Returns documents that contain the words of a provided text, in the same order as provided. - 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' - minProperties: 1 - maxProperties: 1 - more_like_this: - $ref: '#/components/schemas/_common.query_dsl:MoreLikeThisQuery' - multi_match: - $ref: '#/components/schemas/_common.query_dsl:MultiMatchQuery' - nested: - $ref: '#/components/schemas/_common.query_dsl:NestedQuery' - parent_id: - $ref: '#/components/schemas/_common.query_dsl:ParentIdQuery' - percolate: - $ref: '#/components/schemas/_common.query_dsl:PercolateQuery' - pinned: - $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' - minProperties: 1 - maxProperties: 1 - query_string: - $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' - minProperties: 1 - maxProperties: 1 - rank_feature: - $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' - minProperties: 1 - maxProperties: 1 - rule_query: - $ref: '#/components/schemas/_common.query_dsl:RuleQuery' - script: - $ref: '#/components/schemas/_common.query_dsl:ScriptQuery' - script_score: - $ref: '#/components/schemas/_common.query_dsl:ScriptScoreQuery' - shape: - $ref: '#/components/schemas/_common.query_dsl:ShapeQuery' - simple_query_string: - $ref: '#/components/schemas/_common.query_dsl:SimpleQueryStringQuery' - span_containing: - $ref: '#/components/schemas/_common.query_dsl:SpanContainingQuery' - field_masking_span: - $ref: '#/components/schemas/_common.query_dsl:SpanFieldMaskingQuery' - span_first: - $ref: '#/components/schemas/_common.query_dsl:SpanFirstQuery' - span_multi: - $ref: '#/components/schemas/_common.query_dsl:SpanMultiTermQuery' - span_near: - $ref: '#/components/schemas/_common.query_dsl:SpanNearQuery' - span_not: - $ref: '#/components/schemas/_common.query_dsl:SpanNotQuery' - span_or: - $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' - minProperties: 1 - maxProperties: 1 - span_within: - $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. - type: object - additionalProperties: - $ref: '#/components/schemas/_common.query_dsl:TermQuery' - minProperties: 1 - maxProperties: 1 - terms: - $ref: '#/components/schemas/_common.query_dsl:TermsQuery' - 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. - type: object - additionalProperties: - $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' - minProperties: 1 - maxProperties: 1 - weighted_tokens: - 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' - 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' - minProperties: 1 - maxProperties: 1 - wrapper: - $ref: '#/components/schemas/_common.query_dsl:WrapperQuery' - type: - $ref: '#/components/schemas/_common.query_dsl:TypeQuery' - minProperties: 1 - maxProperties: 1 - _common.query_dsl:QueryStringQuery: + ignore_malformed: + type: boolean + ignore_z_value: + type: boolean + orientation: + $ref: '#/components/schemas/_common.mapping:GeoOrientation' + strategy: + $ref: '#/components/schemas/_common.mapping:GeoStrategy' + type: + type: string + enum: + - geo_shape + required: + - type + _common.mapping:GeoStrategy: + type: string + enum: + - recursive + - term + _common.mapping:HalfFloatNumberProperty: allOf: - - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - $ref: '#/components/schemas/_common.mapping:NumberPropertyBase' - type: object properties: - allow_leading_wildcard: - description: If `true`, the wildcard characters `*` and `?` are allowed as the first character of the query string. + type: + type: string + enum: + - half_float + null_value: + type: number + required: + - type + _common.mapping:HistogramProperty: + allOf: + - $ref: '#/components/schemas/_common.mapping:PropertyBase' + - type: object + properties: + ignore_malformed: type: boolean - analyzer: - description: Analyzer used to convert text in the query string into tokens. + type: type: string - analyze_wildcard: - description: If `true`, the query attempts to analyze wildcard terms in the query string. + enum: + - histogram + required: + - type + _common.mapping:IndexField: + type: object + properties: + enabled: + type: boolean + required: + - enabled + _common.mapping:IndexOptions: + type: string + enum: + - docs + - freqs + - offsets + - positions + _common.mapping:IntegerNumberProperty: + allOf: + - $ref: '#/components/schemas/_common.mapping:NumberPropertyBase' + - type: object + properties: + type: + type: string + enum: + - integer + null_value: + type: number + required: + - type + _common.mapping:IntegerRangeProperty: + allOf: + - $ref: '#/components/schemas/_common.mapping:RangePropertyBase' + - type: object + properties: + type: + type: string + enum: + - integer_range + required: + - type + _common.mapping:IpProperty: + allOf: + - $ref: '#/components/schemas/_common.mapping:DocValuesPropertyBase' + - type: object + properties: + boost: + type: number + index: type: boolean - auto_generate_synonyms_phrase_query: - description: If `true`, match phrase queries are automatically created for multi-term synonyms. + ignore_malformed: type: boolean - default_field: - $ref: '#/components/schemas/_common:Field' - default_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. + 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 - escape: + type: + type: string + enum: + - ip + required: + - type + _common.mapping:IpRangeProperty: + allOf: + - $ref: '#/components/schemas/_common.mapping:RangePropertyBase' + - type: object + properties: + type: + type: string + enum: + - ip_range + required: + - type + _common.mapping:JoinProperty: + allOf: + - $ref: '#/components/schemas/_common.mapping:PropertyBase' + - type: object + properties: + relations: + type: object + additionalProperties: + oneOf: + - $ref: '#/components/schemas/_common:RelationName' + - type: array + items: + $ref: '#/components/schemas/_common:RelationName' + eager_global_ordinals: type: boolean - fields: - description: Array of fields to search. Supports wildcards (`*`). - type: array - items: - $ref: '#/components/schemas/_common:Field' - fuzziness: - $ref: '#/components/schemas/_common:Fuzziness' - fuzzy_max_expansions: - description: Maximum number of terms to which the query expands for fuzzy matching. - type: number - fuzzy_prefix_length: - description: Number of beginning characters left unchanged for fuzzy matching. + type: + type: string + enum: + - join + required: + - type + _common.mapping:KeywordProperty: + allOf: + - $ref: '#/components/schemas/_common.mapping:DocValuesPropertyBase' + - type: object + properties: + boost: type: number - fuzzy_rewrite: - $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`). + eager_global_ordinals: type: boolean - lenient: - description: If `true`, format-based errors, such as providing a text value for a numeric field, are ignored. + index: type: boolean - max_determinized_states: - description: Maximum number of automaton states required for the query. - type: number - minimum_should_match: - $ref: '#/components/schemas/_common:MinimumShouldMatch' - phrase_slop: - description: Maximum number of positions allowed between matching tokens for phrases. - type: number - query: - description: Query string you wish to parse and use for search. + index_options: + $ref: '#/components/schemas/_common.mapping:IndexOptions' + normalizer: type: string - quote_analyzer: - description: |- - Analyzer used to convert quoted text in the query string into tokens. - For quoted text, this parameter overrides the analyzer specified in the `analyzer` parameter. + norms: + type: boolean + null_value: type: string - quote_field_suffix: - description: |- - Suffix appended to quoted text in the query string. - You can use this suffix to use a different analysis method for exact matches. + 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 - rewrite: - $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. + enum: + - keyword + required: + - type + _common.mapping:LongNumberProperty: + allOf: + - $ref: '#/components/schemas/_common.mapping:NumberPropertyBase' + - type: object + properties: + type: + type: string + enum: + - long + null_value: type: number - time_zone: - $ref: '#/components/schemas/_common:TimeZone' + required: + - type + _common.mapping:LongRangeProperty: + allOf: + - $ref: '#/components/schemas/_common.mapping:RangePropertyBase' + - type: object + properties: type: - $ref: '#/components/schemas/_common.query_dsl:TextQueryType' + type: string + enum: + - long_range required: - - query - _common.query_dsl:RandomScoreFunction: + - type + _common.mapping:MatchOnlyTextProperty: type: object properties: - field: - $ref: '#/components/schemas/_common:Field' - seed: - oneOf: - - type: number - - type: string - _common.query_dsl:RangeQuery: - oneOf: - - $ref: '#/components/schemas/_common.query_dsl:DateRangeQuery' - - $ref: '#/components/schemas/_common.query_dsl:NumberRangeQuery' - _common.query_dsl:RangeQueryBase: + type: + type: string + enum: + - match_only_text + fields: + description: |- + Multi-fields allow the same string value to be indexed in multiple ways for different purposes, such as one + 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' + meta: + description: Metadata about the field. + type: object + additionalProperties: + type: string + copy_to: + $ref: '#/components/schemas/_common:Fields' + required: + - type + _common.mapping:MatchType: + type: string + enum: + - regex + - simple + _common.mapping:Murmur3HashProperty: allOf: - - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - $ref: '#/components/schemas/_common.mapping:DocValuesPropertyBase' - type: object properties: - relation: - $ref: '#/components/schemas/_common.query_dsl:RangeRelation' - _common.query_dsl:RangeRelation: + type: + type: string + enum: + - murmur3 + required: + - type + _common.mapping:NestedProperty: + allOf: + - $ref: '#/components/schemas/_common.mapping:CorePropertyBase' + - type: object + properties: + enabled: + type: boolean + include_in_parent: + type: boolean + include_in_root: + type: boolean + type: + type: string + enum: + - nested + required: + - type + _common.mapping:NumberPropertyBase: + allOf: + - $ref: '#/components/schemas/_common.mapping:DocValuesPropertyBase' + - type: object + properties: + boost: + type: number + coerce: + type: boolean + ignore_malformed: + 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: + allOf: + - $ref: '#/components/schemas/_common.mapping:CorePropertyBase' + - type: object + properties: + enabled: + type: boolean + type: + type: string + enum: + - object + _common.mapping:OnScriptError: type: string enum: - - within - - contains - - intersects - _common.query_dsl:RankFeatureFunction: - type: object - _common.query_dsl:RankFeatureFunctionLinear: + - continue + - fail + _common.mapping:PercolatorProperty: allOf: - - $ref: '#/components/schemas/_common.query_dsl:RankFeatureFunction' + - $ref: '#/components/schemas/_common.mapping:PropertyBase' - type: object - _common.query_dsl:RankFeatureFunctionLogarithm: + properties: + type: + type: string + enum: + - percolator + required: + - type + _common.mapping:PointProperty: allOf: - - $ref: '#/components/schemas/_common.query_dsl:RankFeatureFunction' + - $ref: '#/components/schemas/_common.mapping:DocValuesPropertyBase' - type: object properties: - scaling_factor: - description: Configurable scaling factor. - type: number + ignore_malformed: + type: boolean + ignore_z_value: + type: boolean + null_value: + type: string + type: + type: string + enum: + - point required: - - scaling_factor - _common.query_dsl:RankFeatureFunctionSaturation: + - type + _common.mapping:Property: + type: object + discriminator: + propertyName: type + oneOf: + - $ref: '#/components/schemas/_common.mapping:BinaryProperty' + - $ref: '#/components/schemas/_common.mapping:BooleanProperty' + - $ref: '#/components/schemas/_common.mapping:DynamicProperty' + - $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:PointProperty' + - $ref: '#/components/schemas/_common.mapping:ShapeProperty' + - $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' + _common.mapping:PropertyBase: + type: object + properties: + meta: + description: Metadata about the field. + type: object + additionalProperties: + type: string + properties: + type: object + additionalProperties: + $ref: '#/components/schemas/_common.mapping:Property' + ignore_above: + type: number + dynamic: + $ref: '#/components/schemas/_common.mapping:DynamicMapping' + fields: + type: object + additionalProperties: + $ref: '#/components/schemas/_common.mapping:Property' + _common.mapping:RangePropertyBase: allOf: - - $ref: '#/components/schemas/_common.query_dsl:RankFeatureFunction' + - $ref: '#/components/schemas/_common.mapping:DocValuesPropertyBase' - type: object properties: - pivot: - description: Configurable pivot value so that the result will be less than 0.5. + boost: type: number - _common.query_dsl:RankFeatureFunctionSigmoid: + coerce: + type: boolean + index: + type: boolean + _common.mapping:RankFeatureProperty: + allOf: + - $ref: '#/components/schemas/_common.mapping:PropertyBase' + - type: object + properties: + positive_score_impact: + type: boolean + type: + type: string + enum: + - rank_feature + required: + - type + _common.mapping:RankFeaturesProperty: + allOf: + - $ref: '#/components/schemas/_common.mapping:PropertyBase' + - type: object + properties: + type: + type: string + enum: + - rank_features + required: + - type + _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: allOf: - - $ref: '#/components/schemas/_common.query_dsl:RankFeatureFunction' + - $ref: '#/components/schemas/_common.mapping:NumberPropertyBase' - type: object properties: - pivot: - description: Configurable pivot value so that the result will be less than 0.5. + type: + type: string + enum: + - scaled_float + null_value: type: number - exponent: - description: Configurable Exponent. + scaling_factor: type: number required: - - pivot - - exponent - _common.query_dsl:RankFeatureQuery: - allOf: - - $ref: '#/components/schemas/_common.query_dsl:QueryBase' - - type: object - properties: - field: - $ref: '#/components/schemas/_common:Field' - saturation: - $ref: '#/components/schemas/_common.query_dsl:RankFeatureFunctionSaturation' - log: - $ref: '#/components/schemas/_common.query_dsl:RankFeatureFunctionLogarithm' - linear: - $ref: '#/components/schemas/_common.query_dsl:RankFeatureFunctionLinear' - sigmoid: - $ref: '#/components/schemas/_common.query_dsl:RankFeatureFunctionSigmoid' - required: - - field - _common.query_dsl:RegexpQuery: + - type + _common.mapping:SearchAsYouTypeProperty: allOf: - - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - $ref: '#/components/schemas/_common.mapping:CorePropertyBase' - type: object properties: - case_insensitive: - description: |- - Allows case insensitive matching of the regular expression value with the indexed field values when set to `true`. - When `false`, case sensitivity of matching depends on the underlying field’s mapping. - type: boolean - flags: - description: Enables optional operators for the regular expression. + analyzer: type: string - max_determinized_states: - description: Maximum number of automaton states required for the query. + index: + type: boolean + index_options: + $ref: '#/components/schemas/_common.mapping:IndexOptions' + max_shingle_size: type: number - rewrite: - $ref: '#/components/schemas/_common:MultiTermQueryRewrite' - value: - description: Regular expression for terms you wish to find in the provided field. + norms: + type: boolean + search_analyzer: + type: string + search_quote_analyzer: + type: string + term_vector: + $ref: '#/components/schemas/_common.mapping:TermVectorOption' + type: type: string + enum: + - search_as_you_type required: - - value - _common.query_dsl:RuleQuery: + - type + _common.mapping:ShapeProperty: allOf: - - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - $ref: '#/components/schemas/_common.mapping:DocValuesPropertyBase' - type: object properties: - organic: - $ref: '#/components/schemas/_common.query_dsl:QueryContainer' - ruleset_id: - $ref: '#/components/schemas/_common:Id' - match_criteria: - type: object + coerce: + type: boolean + ignore_malformed: + type: boolean + ignore_z_value: + type: boolean + orientation: + $ref: '#/components/schemas/_common.mapping:GeoOrientation' + type: + type: string + enum: + - shape required: - - organic - - ruleset_id - - match_criteria - _common.query_dsl:ScriptQuery: + - type + _common.mapping:ShortNumberProperty: allOf: - - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - $ref: '#/components/schemas/_common.mapping:NumberPropertyBase' - type: object properties: - script: - $ref: '#/components/schemas/_common:Script' + type: + type: string + enum: + - short + null_value: + $ref: '#/components/schemas/_common:short' required: - - script - _common.query_dsl:ScriptScoreFunction: + - type + _common.mapping:SizeField: type: object properties: - script: - $ref: '#/components/schemas/_common:Script' + enabled: + type: boolean required: - - script - _common.query_dsl:ScriptScoreQuery: + - enabled + _common.mapping:SourceField: + type: object + properties: + compress: + type: boolean + compress_threshold: + type: string + enabled: + type: boolean + excludes: + type: array + items: + type: string + includes: + 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.query_dsl:QueryBase' + - $ref: '#/components/schemas/_common.mapping:PropertyBase' - type: object properties: - min_score: - description: Documents with a score lower than this floating point number are excluded from the search results. - type: number - query: - $ref: '#/components/schemas/_common.query_dsl:QueryContainer' - script: - $ref: '#/components/schemas/_common:Script' + type: + type: string + enum: + - sparse_vector required: - - query - - script - _common.query_dsl:ShapeQuery: - allOf: - - $ref: '#/components/schemas/_common.query_dsl:QueryBase' - - type: object - properties: - ignore_unmapped: - description: When set to `true` the query ignores an unmapped field and will not match any documents. - type: boolean - _common.query_dsl:SimpleQueryStringFlag: + - type + _common.mapping:SuggestContext: + type: object + properties: + name: + $ref: '#/components/schemas/_common:Name' + path: + $ref: '#/components/schemas/_common:Field' + type: + type: string + precision: + oneOf: + - type: number + - type: string + required: + - name + - type + _common.mapping:TermVectorOption: type: string enum: - - NONE - - AND - - NOT - - OR - - PREFIX - - PHRASE - - PRECEDENCE - - ESCAPE - - WHITESPACE - - FUZZY - - NEAR - - SLOP - - ALL - _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: + - no + - with_offsets + - with_positions + - with_positions_offsets + - with_positions_offsets_payloads + - with_positions_payloads + - yes + _common.mapping:TextIndexPrefixes: + type: object + properties: + max_chars: + type: number + min_chars: + type: number + required: + - max_chars + - min_chars + _common.mapping:TextProperty: allOf: - - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - $ref: '#/components/schemas/_common.mapping:CorePropertyBase' - type: object properties: analyzer: - description: Analyzer used to convert text in the query string into tokens. type: string - analyze_wildcard: - description: If `true`, the query attempts to analyze wildcard terms in the query string. + boost: + type: number + eager_global_ordinals: type: boolean - auto_generate_synonyms_phrase_query: - description: If `true`, the parser creates a match_phrase query for each multi-position token. + fielddata: type: boolean - default_operator: - $ref: '#/components/schemas/_common.query_dsl:Operator' - fields: - description: |- - Array of fields you wish to search. - Accepts wildcard expressions. - You also can boost relevance scores for matches to particular fields using a caret (`^`) notation. - Defaults to the `index.query.default_field index` setting, which has a default value of `*`. - type: array - items: - $ref: '#/components/schemas/_common:Field' - flags: - $ref: '#/components/schemas/_common.query_dsl:SimpleQueryStringFlags' - fuzzy_max_expansions: - description: Maximum number of terms to which the query expands for fuzzy matching. - type: number - fuzzy_prefix_length: - description: Number of beginning characters left unchanged for fuzzy matching. - type: number - fuzzy_transpositions: - description: If `true`, edits for fuzzy matching include transpositions of two adjacent characters (for example, `ab` to `ba`). + fielddata_frequency_filter: + $ref: '#/components/schemas/indices._common:FielddataFrequencyFilter' + index: type: boolean - lenient: - description: If `true`, format-based errors, such as providing a text value for a numeric field, are ignored. + index_options: + $ref: '#/components/schemas/_common.mapping:IndexOptions' + index_phrases: type: boolean - minimum_should_match: - $ref: '#/components/schemas/_common:MinimumShouldMatch' - query: - description: Query string in the simple query string syntax you wish to parse and use for search. + index_prefixes: + $ref: '#/components/schemas/_common.mapping:TextIndexPrefixes' + norms: + type: boolean + position_increment_gap: + type: number + search_analyzer: type: string - quote_field_suffix: - description: Suffix appended to quoted text in the query string. + search_quote_analyzer: + type: string + term_vector: + $ref: '#/components/schemas/_common.mapping:TermVectorOption' + type: type: string + enum: + - text required: - - query - _common.query_dsl:SpanContainingQuery: + - type + _common.mapping:TimeSeriesMetricType: + type: string + enum: + - counter + - gauge + - histogram + - position + - summary + _common.mapping:TokenCountProperty: allOf: - - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - $ref: '#/components/schemas/_common.mapping:DocValuesPropertyBase' - type: object properties: - big: - $ref: '#/components/schemas/_common.query_dsl:SpanQuery' - little: - $ref: '#/components/schemas/_common.query_dsl:SpanQuery' + analyzer: + type: string + boost: + type: number + index: + type: boolean + null_value: + type: number + enable_position_increments: + type: boolean + type: + type: string + enum: + - token_count required: - - big - - little - _common.query_dsl:SpanFieldMaskingQuery: + - type + _common.mapping:TypeMapping: + type: object + properties: + all_field: + $ref: '#/components/schemas/_common.mapping:AllField' + date_detection: + type: boolean + dynamic: + $ref: '#/components/schemas/_common.mapping:DynamicMapping' + dynamic_date_formats: + type: array + items: + type: string + dynamic_templates: + type: array + items: + type: object + additionalProperties: + $ref: '#/components/schemas/_common.mapping:DynamicTemplate' + _field_names: + $ref: '#/components/schemas/_common.mapping:FieldNamesField' + index_field: + $ref: '#/components/schemas/_common.mapping:IndexField' + _meta: + $ref: '#/components/schemas/_common:Metadata' + numeric_detection: + type: boolean + properties: + type: object + additionalProperties: + $ref: '#/components/schemas/_common.mapping:Property' + _routing: + $ref: '#/components/schemas/_common.mapping:RoutingField' + _size: + $ref: '#/components/schemas/_common.mapping:SizeField' + _source: + $ref: '#/components/schemas/_common.mapping:SourceField' + runtime: + type: object + additionalProperties: + $ref: '#/components/schemas/_common.mapping:RuntimeField' + enabled: + type: boolean + _data_stream_timestamp: + $ref: '#/components/schemas/_common.mapping:DataStreamTimestamp' + _common.mapping:UnsignedLongNumberProperty: allOf: - - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - $ref: '#/components/schemas/_common.mapping:NumberPropertyBase' - type: object properties: - field: - $ref: '#/components/schemas/_common:Field' - query: - $ref: '#/components/schemas/_common.query_dsl:SpanQuery' + type: + type: string + enum: + - unsigned_long + null_value: + $ref: '#/components/schemas/_common:ulong' required: - - field - - query - _common.query_dsl:SpanFirstQuery: + - type + _common.mapping:VersionProperty: allOf: - - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - $ref: '#/components/schemas/_common.mapping:DocValuesPropertyBase' - type: object properties: - end: - description: Controls the maximum end position permitted in a match. - type: number - match: - $ref: '#/components/schemas/_common.query_dsl:SpanQuery' + type: + type: string + enum: + - version required: - - end - - match - _common.query_dsl:SpanGapQuery: - description: Can only be used as a clause in a span_near query. - type: object - additionalProperties: - type: number - minProperties: 1 - maxProperties: 1 - _common.query_dsl:SpanMultiTermQuery: + - type + _common.mapping:WildcardProperty: allOf: - - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - $ref: '#/components/schemas/_common.mapping:DocValuesPropertyBase' - type: object properties: - match: - $ref: '#/components/schemas/_common.query_dsl:QueryContainer' + type: + type: string + enum: + - wildcard + null_value: + type: string required: - - match - _common.query_dsl:SpanNearQuery: + - type + _common.query_dsl:BoolQuery: allOf: - $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' - in_order: - description: Controls whether matches are required to be in-order. - type: boolean - slop: - description: Controls the maximum number of intervening unmatched positions permitted. - type: number - required: - - clauses - _common.query_dsl:SpanNotQuery: + filter: + description: |- + 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' + - type: array + items: + $ref: '#/components/schemas/_common.query_dsl:QueryContainer' + minimum_should_match: + $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' + - type: array + items: + $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' + - type: array + items: + $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' + - type: array + items: + $ref: '#/components/schemas/_common.query_dsl:QueryContainer' + _common.query_dsl:BoostingQuery: allOf: - $ref: '#/components/schemas/_common.query_dsl:QueryBase' - type: object properties: - dist: - description: |- - The number of tokens from within the include span that can’t have overlap with the exclude span. - Equivalent to setting both `pre` and `post`. - type: number - exclude: - $ref: '#/components/schemas/_common.query_dsl:SpanQuery' - include: - $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: number - pre: - description: The number of tokens before the include span that can’t have overlap with the exclude span. + negative_boost: + description: Floating point number between 0 and 1.0 used to decrease the relevance scores of documents matching the `negative` query. type: number + negative: + $ref: '#/components/schemas/_common.query_dsl:QueryContainer' + positive: + $ref: '#/components/schemas/_common.query_dsl:QueryContainer' required: - - exclude - - include - _common.query_dsl:SpanOrQuery: + - negative + - negative_boost + - positive + _common.query_dsl:ChildScoreMode: + type: string + enum: + - avg + - max + - min + - none + - sum + _common.query_dsl:CombinedFieldsOperator: + type: string + enum: + - and + - or + _common.query_dsl:CombinedFieldsQuery: allOf: - $ref: '#/components/schemas/_common.query_dsl:QueryBase' - type: object properties: - clauses: - description: Array of one or more other span type queries. + 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.query_dsl:SpanQuery' - required: - - clauses - _common.query_dsl:SpanQuery: - type: object - properties: - span_containing: - $ref: '#/components/schemas/_common.query_dsl:SpanContainingQuery' - field_masking_span: - $ref: '#/components/schemas/_common.query_dsl:SpanFieldMaskingQuery' - span_first: - $ref: '#/components/schemas/_common.query_dsl:SpanFirstQuery' - span_gap: - $ref: '#/components/schemas/_common.query_dsl:SpanGapQuery' - span_multi: - $ref: '#/components/schemas/_common.query_dsl:SpanMultiTermQuery' - span_near: - $ref: '#/components/schemas/_common.query_dsl:SpanNearQuery' - span_not: - $ref: '#/components/schemas/_common.query_dsl:SpanNotQuery' - span_or: - $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' - minProperties: 1 - maxProperties: 1 - span_within: - $ref: '#/components/schemas/_common.query_dsl:SpanWithinQuery' - minProperties: 1 - maxProperties: 1 - _common.query_dsl:SpanTermQuery: - allOf: - - $ref: '#/components/schemas/_common.query_dsl:QueryBase' - - type: object - properties: - value: + $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. + type: boolean + operator: + $ref: '#/components/schemas/_common.query_dsl:CombinedFieldsOperator' + minimum_should_match: + $ref: '#/components/schemas/_common:MinimumShouldMatch' + zero_terms_query: + $ref: '#/components/schemas/_common.query_dsl:CombinedFieldsZeroTerms' required: - - value - _common.query_dsl:SpanWithinQuery: + - fields + - query + _common.query_dsl:CombinedFieldsZeroTerms: + type: string + enum: + - all + - none + _common.query_dsl:CommonTermsQuery: allOf: - $ref: '#/components/schemas/_common.query_dsl:QueryBase' - type: object properties: - big: - $ref: '#/components/schemas/_common.query_dsl:SpanQuery' - little: - $ref: '#/components/schemas/_common.query_dsl:SpanQuery' + analyzer: + type: string + cutoff_frequency: + type: number + high_freq_operator: + $ref: '#/components/schemas/_common.query_dsl:Operator' + low_freq_operator: + $ref: '#/components/schemas/_common.query_dsl:Operator' + minimum_should_match: + $ref: '#/components/schemas/_common:MinimumShouldMatch' + query: + type: string required: - - big - - little - _common.query_dsl:TermQuery: + - query + _common.query_dsl:ConstantScoreQuery: allOf: - $ref: '#/components/schemas/_common.query_dsl:QueryBase' - type: object properties: - value: - $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`. - When `false`, the case sensitivity of matching depends on the underlying field’s mapping. - type: boolean + filter: + $ref: '#/components/schemas/_common.query_dsl:QueryContainer' required: - - value - _common.query_dsl:TermsQuery: + - filter + _common.query_dsl:DateDecayFunction: allOf: - - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - $ref: '#/components/schemas/_common.query_dsl:DecayFunctionBase' - type: object - _common.query_dsl:TermsSetQuery: + _common.query_dsl:DateDistanceFeatureQuery: allOf: - - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - $ref: '#/components/schemas/_common.query_dsl:DistanceFeatureQueryBaseDateMathDuration' - type: object - properties: - minimum_should_match_field: - $ref: '#/components/schemas/_common:Field' - minimum_should_match_script: - $ref: '#/components/schemas/_common:Script' - terms: - description: Array of terms you wish to find in the provided field. - type: array - items: - type: string - required: - - terms - _common.query_dsl:TextExpansionQuery: + _common.query_dsl:DateRangeQuery: allOf: - - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - $ref: '#/components/schemas/_common.query_dsl:RangeQueryBase' - type: object properties: - model_id: - description: The text expansion NLP model to use - type: string - model_text: - description: The query text - type: string - pruning_config: - $ref: '#/components/schemas/_common.query_dsl:TokenPruningConfig' - required: - - model_id - - model_text - _common.query_dsl:TextQueryType: - type: string - enum: - - best_fields - - most_fields - - cross_fields - - phrase - - phrase_prefix - - bool_prefix - _common.query_dsl:TokenPruningConfig: + gt: + $ref: '#/components/schemas/_common:DateMath' + gte: + $ref: '#/components/schemas/_common:DateMath' + lt: + $ref: '#/components/schemas/_common:DateMath' + lte: + $ref: '#/components/schemas/_common:DateMath' + from: + oneOf: + - $ref: '#/components/schemas/_common:DateMath' + - nullable: true + type: string + to: + oneOf: + - $ref: '#/components/schemas/_common:DateMath' + - nullable: true + type: string + format: + $ref: '#/components/schemas/_common:DateFormat' + time_zone: + $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: type: object properties: - tokens_freq_ratio_threshold: - description: Tokens whose frequency is more than this threshold times the average frequency of all tokens in the specified field are considered outliers and pruned. - type: number - tokens_weight_threshold: - description: Tokens whose weight is less than this threshold are considered nonsignificant and pruned. - type: number - only_score_pruned_tokens: - description: Whether to only score pruned tokens, vs only scoring kept tokens. - type: boolean - _common.query_dsl:TypeQuery: + multi_value_mode: + $ref: '#/components/schemas/_common.query_dsl:MultiValueMode' + _common.query_dsl:DisMaxQuery: allOf: - $ref: '#/components/schemas/_common.query_dsl:QueryBase' - type: object properties: - value: - type: string + queries: + description: |- + One or more query clauses. + Returned documents must match one or more of these queries. + If a document matches multiple queries, OpenSearch uses the highest relevance score. + type: array + items: + $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 required: - - value - _common.query_dsl:WeightedTokensQuery: + - queries + _common.query_dsl:DistanceFeatureQuery: + oneOf: + - $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' - type: object properties: - tokens: - description: The tokens representing this query - type: object - additionalProperties: - type: number - pruning_config: - $ref: '#/components/schemas/_common.query_dsl:TokenPruningConfig' + origin: + $ref: '#/components/schemas/_common:DateMath' + pivot: + $ref: '#/components/schemas/_common:Duration' + field: + $ref: '#/components/schemas/_common:Field' required: - - tokens - _common.query_dsl:WildcardQuery: + - field + - origin + - pivot + _common.query_dsl:DistanceFeatureQueryBaseGeoLocationDistance: allOf: - $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' - 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: + origin: + $ref: '#/components/schemas/_common:GeoLocation' + pivot: + $ref: '#/components/schemas/_common:Distance' + field: + $ref: '#/components/schemas/_common:Field' + required: + - field + - origin + - pivot + _common.query_dsl:ExistsQuery: allOf: - $ref: '#/components/schemas/_common.query_dsl:QueryBase' - type: object properties: - query: - description: |- - A base64 encoded query. - The binary data format can be any of JSON, YAML, CBOR or SMILE encodings - type: string + field: + $ref: '#/components/schemas/_common:Field' required: - - query - _common.query_dsl:ZeroTermsQuery: - type: string - enum: - - all - - none - _common:AcknowledgedResponseBase: - type: object - properties: - acknowledged: - description: For a successful response, this value is always true. On failure, an exception is returned instead. - type: boolean - required: - - acknowledged - _common:ActionStatusOptions: - type: string - enum: - - success - - failure - - simulated - - throttled - _common:BaseNode: - type: object - properties: - attributes: - type: object - additionalProperties: - type: string - host: - $ref: '#/components/schemas/_common:Host' - ip: - $ref: '#/components/schemas/_common:Ip' - name: - $ref: '#/components/schemas/_common:Name' - roles: - $ref: '#/components/schemas/_common:NodeRoles' - transport_address: - $ref: '#/components/schemas/_common:TransportAddress' - required: - - attributes - - host - - ip - - name - - transport_address - _common:BulkIndexByScrollFailure: - type: object - properties: - cause: - $ref: '#/components/schemas/_common:ErrorCause' - id: - $ref: '#/components/schemas/_common:Id' - index: - $ref: '#/components/schemas/_common:IndexName' - status: - type: number - type: - type: string - required: - - cause - - id - - index - - status - - type - _common:BulkStats: - type: object - properties: - total_operations: - type: number - total_time: - $ref: '#/components/schemas/_common:Duration' - total_time_in_millis: - $ref: '#/components/schemas/_common:DurationValueUnitMillis' - total_size: - $ref: '#/components/schemas/_common:ByteSize' - total_size_in_bytes: - type: number - avg_time: - $ref: '#/components/schemas/_common:Duration' - avg_time_in_millis: - $ref: '#/components/schemas/_common:DurationValueUnitMillis' - avg_size: - $ref: '#/components/schemas/_common:ByteSize' - avg_size_in_bytes: - type: number - required: - - total_operations - - total_time_in_millis - - total_size_in_bytes - - avg_time_in_millis - - avg_size_in_bytes - _common:ByteSize: - oneOf: - - type: number - - type: string - _common:Bytes: - type: string - enum: - - b - - k - - kb - - m - - mb - - g - - gb - - t - - tb - - p - - pb - _common:ClusterDetails: - type: object - properties: - status: - $ref: '#/components/schemas/_common:ClusterSearchStatus' - indices: - type: string - took: - $ref: '#/components/schemas/_common:DurationValueUnitMillis' - timed_out: - type: boolean - _shards: - $ref: '#/components/schemas/_common:ShardStatistics' - failures: - type: array - items: - $ref: '#/components/schemas/_common:ShardFailure' - required: - - status - - indices - - timed_out - _common:ClusterSearchStatus: - type: string - enum: - - running - - successful - - partial - - skipped - - failed - _common:ClusterStatistics: - type: object - properties: - skipped: - type: number - successful: - type: number - total: - type: number - running: - type: number - partial: - type: number - failed: - type: number - details: - type: object - additionalProperties: - $ref: '#/components/schemas/_common:ClusterDetails' - required: - - skipped - - successful - - total - - running - - partial - - failed - _common:CompletionStats: - type: object - properties: - size_in_bytes: - description: Total amount, in bytes, of memory used for completion across all shards assigned to selected nodes. - type: number - size: - $ref: '#/components/schemas/_common:ByteSize' - fields: - type: object - additionalProperties: - $ref: '#/components/schemas/_common:FieldSizeUsage' - required: - - size_in_bytes - _common:Conflicts: - type: string - enum: - - abort - - proceed - _common:CoordsGeoBounds: + - field + _common.query_dsl:FieldAndFormat: type: object properties: - top: - type: number - bottom: - type: number - left: - type: number - right: - type: number - required: - - top - - bottom - - left - - right - _common:DFIIndependenceMeasure: - type: string - enum: - - standardized - - saturated - - chisquared - _common:DFRAfterEffect: - type: string - enum: - - no - - b - - l - _common:DFRBasicModel: - type: string - enum: - - be - - d - - g - - if - - in - - ine - - p - _common:DataStreamName: - type: string - _common:DataStreamNames: - oneOf: - - $ref: '#/components/schemas/_common:DataStreamName' - - type: array - items: - $ref: '#/components/schemas/_common:DataStreamName' - _common:DateFormat: - type: string - _common:DateMath: - type: string - _common:DateTime: - description: |- - A date and time, either as a string whose format can depend on the context (defaulting to ISO 8601), or a - number of milliseconds since the Epoch. Opensearch accepts both as input, but will generally output a string - representation. - oneOf: - - type: string - - $ref: '#/components/schemas/_common:EpochTimeUnitMillis' - _common:Distance: - type: string - _common:DistanceUnit: - type: string - enum: - - in - - ft - - yd - - mi - - nmi - - km - - m - - cm - - mm - _common:DocStats: + field: + $ref: '#/components/schemas/_common:Field' + format: + description: Format in which the values are returned. + type: string + include_unmapped: + type: boolean + required: + - field + _common.query_dsl:FieldValueFactorModifier: + type: string + enum: + - ln + - ln1p + - ln2p + - log + - log1p + - log2p + - none + - reciprocal + - sqrt + - square + _common.query_dsl:FieldValueFactorScoreFunction: type: object properties: - count: - description: |- - Total number of non-deleted documents across all primary shards assigned to selected nodes. - This number is based on documents in Lucene segments and may include documents from nested fields. + field: + $ref: '#/components/schemas/_common:Field' + factor: + description: Optional factor to multiply the field value with. type: number - deleted: + missing: description: |- - Total number of deleted documents across all primary shards assigned to selected nodes. - This number is based on documents in Lucene segments. - Opensearch reclaims the disk space of deleted Lucene documents when a segment is merged. + Value used if the document doesn't have that field. + The modifier and factor are still applied to it as though it were read from the document. type: number + modifier: + $ref: '#/components/schemas/_common.query_dsl:FieldValueFactorModifier' required: - - count - _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. - x-data-type: time - pattern: ^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$ + - field + _common.query_dsl:FunctionBoostMode: type: string - _common:DurationLarge: - description: |- - A date histogram interval. Similar to `Duration` with additional units: `w` (week), `M` (month), `q` (quarter) and - `y` (year) + enum: + - avg + - max + - min + - multiply + - replace + - sum + _common.query_dsl:FunctionScoreContainer: + allOf: + - type: object + properties: + filter: + $ref: '#/components/schemas/_common.query_dsl:QueryContainer' + weight: + type: number + - type: object + properties: + exp: + $ref: '#/components/schemas/_common.query_dsl:DecayFunction' + gauss: + $ref: '#/components/schemas/_common.query_dsl:DecayFunction' + linear: + $ref: '#/components/schemas/_common.query_dsl:DecayFunction' + field_value_factor: + $ref: '#/components/schemas/_common.query_dsl:FieldValueFactorScoreFunction' + random_score: + $ref: '#/components/schemas/_common.query_dsl:RandomScoreFunction' + script_score: + $ref: '#/components/schemas/_common.query_dsl:ScriptScoreFunction' + minProperties: 1 + maxProperties: 1 + _common.query_dsl:FunctionScoreMode: type: string - _common:DurationValueUnitMillis: + enum: + - avg + - first + - max + - min + - multiply + - sum + _common.query_dsl:FunctionScoreQuery: allOf: - - $ref: '#/components/schemas/_common:UnitMillis' - _common:DurationValueUnitNanos: + - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - type: object + properties: + boost_mode: + $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' + max_boost: + description: Restricts the new score to not exceed the provided limit. + type: number + min_score: + description: Excludes documents that do not meet the provided score threshold. + type: number + query: + $ref: '#/components/schemas/_common.query_dsl:QueryContainer' + score_mode: + $ref: '#/components/schemas/_common.query_dsl:FunctionScoreMode' + _common.query_dsl:FuzzyQuery: allOf: - - $ref: '#/components/schemas/_common:UnitNanos' - _common:EmptyObject: - type: object - _common:EpochTimeUnitMillis: + - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - type: object + properties: + max_expansions: + description: Maximum number of variations created. + type: number + prefix_length: + description: Number of beginning characters left unchanged when creating expansions. + type: number + rewrite: + $ref: '#/components/schemas/_common:MultiTermQueryRewrite' + transpositions: + description: Indicates whether edits include transpositions of two adjacent characters (for example `ab` to `ba`). + type: boolean + fuzziness: + $ref: '#/components/schemas/_common:Fuzziness' + value: + description: Term you wish to find in the provided field. + oneOf: + - type: string + - type: number + - type: boolean + required: + - value + _common.query_dsl:GeoBoundingBoxQuery: allOf: - - $ref: '#/components/schemas/_common:UnitMillis' - _common:EpochTimeUnitSeconds: + - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - type: object + properties: + type: + $ref: '#/components/schemas/_common.query_dsl:GeoExecution' + validation_method: + $ref: '#/components/schemas/_common.query_dsl:GeoValidationMethod' + ignore_unmapped: + description: |- + Set to `true` to ignore an unmapped field and not match any documents for this query. + Set to `false` to throw an exception if the field is not mapped. + type: boolean + _common.query_dsl:GeoDecayFunction: allOf: - - $ref: '#/components/schemas/_common:UnitSeconds' - _common:ErrorCause: - type: object - properties: - type: - description: The type of error - type: string - reason: - description: A human-readable explanation of the error, in english - type: string - stack_trace: - 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' - root_cause: - type: array - items: - $ref: '#/components/schemas/_common:ErrorCause' - suppressed: - type: array - items: - $ref: '#/components/schemas/_common:ErrorCause' - required: - - type - _common:ErrorResponseBase: - type: object - properties: - error: - $ref: '#/components/schemas/_common:ErrorCause' - status: - type: number - required: - - error - - status - _common:ExpandWildcard: + - $ref: '#/components/schemas/_common.query_dsl:DecayFunctionBase' + - type: object + _common.query_dsl:GeoDistanceFeatureQuery: + allOf: + - $ref: '#/components/schemas/_common.query_dsl:DistanceFeatureQueryBaseGeoLocationDistance' + - type: object + _common.query_dsl:GeoDistanceQuery: + allOf: + - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - type: object + properties: + distance: + $ref: '#/components/schemas/_common:Distance' + distance_type: + $ref: '#/components/schemas/_common:GeoDistanceType' + validation_method: + $ref: '#/components/schemas/_common.query_dsl:GeoValidationMethod' + required: + - distance + _common.query_dsl:GeoExecution: type: string enum: - - all - - open - - closed - - hidden - - none - _common:ExpandWildcards: - oneOf: - - $ref: '#/components/schemas/_common:ExpandWildcard' - - type: array - items: - $ref: '#/components/schemas/_common:ExpandWildcard' - _common:Field: - description: Path to field or array of paths. Some API's support wildcards in the path to select multiple fields. + - indexed + - memory + _common.query_dsl:GeoPolygonQuery: + allOf: + - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - type: object + properties: + validation_method: + $ref: '#/components/schemas/_common.query_dsl:GeoValidationMethod' + ignore_unmapped: + type: boolean + _common.query_dsl:GeoShapeQuery: + allOf: + - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - type: object + properties: + ignore_unmapped: + description: |- + Set to `true` to ignore an unmapped field and not match any documents for this query. + Set to `false` to throw an exception if the field is not mapped. + type: boolean + _common.query_dsl:GeoValidationMethod: type: string - _common:FieldMemoryUsage: - type: object - properties: - memory_size: - $ref: '#/components/schemas/_common:ByteSize' - memory_size_in_bytes: - type: number - required: - - memory_size_in_bytes - _common:FieldSizeUsage: - type: object - properties: - size: - $ref: '#/components/schemas/_common:ByteSize' - size_in_bytes: - type: number - required: - - size_in_bytes - _common:FieldValue: - description: A field value. - oneOf: - - type: number - - type: number - - type: string - - type: boolean - - nullable: true - type: string + enum: + - coerce + - ignore_malformed + - strict + _common.query_dsl:HasChildQuery: + allOf: + - $ref: '#/components/schemas/_common.query_dsl:QueryBase' - type: object - _common:FielddataStats: + properties: + ignore_unmapped: + description: Indicates whether to ignore an unmapped `type` and not return any documents instead of an error. + type: boolean + inner_hits: + $ref: '#/components/schemas/_core.search:InnerHits' + max_children: + description: |- + Maximum number of child documents that match the query allowed for a returned parent document. + If the parent document exceeds this limit, it is excluded from the search results. + type: number + min_children: + description: |- + Minimum number of child documents that match the query required to match the query for a returned parent document. + If the parent document does not meet this limit, it is excluded from the search results. + type: number + query: + $ref: '#/components/schemas/_common.query_dsl:QueryContainer' + score_mode: + $ref: '#/components/schemas/_common.query_dsl:ChildScoreMode' + type: + $ref: '#/components/schemas/_common:RelationName' + required: + - query + - type + _common.query_dsl:HasParentQuery: + allOf: + - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - type: object + properties: + ignore_unmapped: + description: |- + Indicates whether to ignore an unmapped `parent_type` and not return any documents instead of an error. + You can use this parameter to query multiple indices that may not contain the `parent_type`. + type: boolean + inner_hits: + $ref: '#/components/schemas/_core.search:InnerHits' + parent_type: + $ref: '#/components/schemas/_common:RelationName' + query: + $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: + allOf: + - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - type: object + properties: + values: + $ref: '#/components/schemas/_common:Ids' + _common.query_dsl:IntervalsAllOf: type: object properties: - evictions: - type: number - memory_size: - $ref: '#/components/schemas/_common:ByteSize' - memory_size_in_bytes: - type: number - fields: - type: object - additionalProperties: - $ref: '#/components/schemas/_common:FieldMemoryUsage' - required: - - memory_size_in_bytes - _common:Fields: - oneOf: - - $ref: '#/components/schemas/_common:Field' - - type: array + 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:Field' - _common:FlushStats: - type: object - properties: - periodic: - type: number - total: + $ref: '#/components/schemas/_common.query_dsl:IntervalsContainer' + max_gaps: + description: |- + Maximum number of positions between the matching terms. + Intervals produced by the rules further apart than this are not considered matches. type: number - total_time: - $ref: '#/components/schemas/_common:Duration' - total_time_in_millis: - $ref: '#/components/schemas/_common:DurationValueUnitMillis' - required: - - periodic - - total - - total_time_in_millis - _common:Fuzziness: - oneOf: - - type: string - - type: number - _common:GeoBounds: - description: |- - A geo bounding box. It can be represented in various ways: - - as 4 top/bottom/left/right coordinates - - as 2 top_left / bottom_right points - - as 2 top_right / bottom_left points - - as a WKT bounding box - oneOf: - - $ref: '#/components/schemas/_common:CoordsGeoBounds' - - $ref: '#/components/schemas/_common:TopLeftBottomRightGeoBounds' - - $ref: '#/components/schemas/_common:TopRightBottomLeftGeoBounds' - - $ref: '#/components/schemas/_common:WktGeoBounds' - _common:GeoDistanceSort: - type: object - properties: - mode: - $ref: '#/components/schemas/_common:SortMode' - distance_type: - $ref: '#/components/schemas/_common:GeoDistanceType' - ignore_unmapped: + ordered: + description: If `true`, intervals produced by the rules should appear in the order in which they are specified. type: boolean - order: - $ref: '#/components/schemas/_common:SortOrder' - unit: - $ref: '#/components/schemas/_common:DistanceUnit' - _common:GeoDistanceType: - type: string - enum: - - arc - - plane - _common:GeoHash: - type: string - _common:GeoHashLocation: - type: object - properties: - geohash: - $ref: '#/components/schemas/_common:GeoHash' + filter: + $ref: '#/components/schemas/_common.query_dsl:IntervalsFilter' required: - - geohash - _common:GeoHashPrecision: - description: A precision that can be expressed as a geohash length between 1 and 12, or a distance measure like "1km", "10m". - oneOf: - - type: number - - type: string - _common:GeoHexCell: - description: A map hex cell (H3) reference - type: string - _common:GeoLine: + - intervals + _common.query_dsl:IntervalsAnyOf: type: object properties: - type: - description: Always `"LineString"` - type: string - coordinates: - description: Array of `[lon, lat]` coordinates + intervals: + description: An array of rules to match. type: array items: - type: array - items: - type: number + $ref: '#/components/schemas/_common.query_dsl:IntervalsContainer' + filter: + $ref: '#/components/schemas/_common.query_dsl:IntervalsFilter' required: - - type - - coordinates - _common:GeoLocation: - description: |- - A latitude/longitude as a 2 dimensional point. It can be represented in various ways: - - as a `{lat, long}` object - - as a geo hash value - - as a `[lon, lat]` array - - as a string in `", "` or WKT point formats - oneOf: - - $ref: '#/components/schemas/_common:LatLonGeoLocation' - - $ref: '#/components/schemas/_common:GeoHashLocation' - - type: array - items: - type: number - - type: string - _common:GeoShapeRelation: - type: string - enum: - - intersects - - disjoint - - within - - contains - _common:GeoTile: - description: A map tile reference, represented as `{zoom}/{x}/{y}` - type: string - _common:GeoTilePrecision: - type: number - _common:GetStats: + - intervals + _common.query_dsl:IntervalsContainer: + type: object + properties: + all_of: + $ref: '#/components/schemas/_common.query_dsl:IntervalsAllOf' + any_of: + $ref: '#/components/schemas/_common.query_dsl:IntervalsAnyOf' + fuzzy: + $ref: '#/components/schemas/_common.query_dsl:IntervalsFuzzy' + match: + $ref: '#/components/schemas/_common.query_dsl:IntervalsMatch' + prefix: + $ref: '#/components/schemas/_common.query_dsl:IntervalsPrefix' + wildcard: + $ref: '#/components/schemas/_common.query_dsl:IntervalsWildcard' + minProperties: 1 + maxProperties: 1 + _common.query_dsl:IntervalsFilter: + type: object + properties: + after: + $ref: '#/components/schemas/_common.query_dsl:IntervalsContainer' + before: + $ref: '#/components/schemas/_common.query_dsl:IntervalsContainer' + contained_by: + $ref: '#/components/schemas/_common.query_dsl:IntervalsContainer' + containing: + $ref: '#/components/schemas/_common.query_dsl:IntervalsContainer' + not_contained_by: + $ref: '#/components/schemas/_common.query_dsl:IntervalsContainer' + not_containing: + $ref: '#/components/schemas/_common.query_dsl:IntervalsContainer' + not_overlapping: + $ref: '#/components/schemas/_common.query_dsl:IntervalsContainer' + overlapping: + $ref: '#/components/schemas/_common.query_dsl:IntervalsContainer' + script: + $ref: '#/components/schemas/_common:Script' + minProperties: 1 + maxProperties: 1 + _common.query_dsl:IntervalsFuzzy: type: object properties: - current: - type: number - exists_time: - $ref: '#/components/schemas/_common:Duration' - exists_time_in_millis: - $ref: '#/components/schemas/_common:DurationValueUnitMillis' - exists_total: - type: number - missing_time: - $ref: '#/components/schemas/_common:Duration' - missing_time_in_millis: - $ref: '#/components/schemas/_common:DurationValueUnitMillis' - missing_total: + analyzer: + description: Analyzer used to normalize the term. + type: string + fuzziness: + $ref: '#/components/schemas/_common:Fuzziness' + prefix_length: + description: Number of beginning characters left unchanged when creating expansions. type: number - time: - $ref: '#/components/schemas/_common:Duration' - time_in_millis: - $ref: '#/components/schemas/_common:DurationValueUnitMillis' - total: + term: + description: The term to match. + type: string + transpositions: + description: Indicates whether edits include transpositions of two adjacent characters (for example, `ab` to `ba`). + type: boolean + use_field: + $ref: '#/components/schemas/_common:Field' + required: + - term + _common.query_dsl:IntervalsMatch: + type: object + properties: + analyzer: + description: Analyzer used to analyze terms in the query. + type: string + max_gaps: + description: |- + Maximum number of positions between the matching terms. + Terms further apart than this are not considered matches. type: number + ordered: + description: If `true`, matching terms must appear in their specified order. + type: boolean + query: + description: Text you wish to find in the provided field. + type: string + use_field: + $ref: '#/components/schemas/_common:Field' + filter: + $ref: '#/components/schemas/_common.query_dsl:IntervalsFilter' required: - - current - - exists_time_in_millis - - exists_total - - missing_time_in_millis - - missing_total - - time_in_millis - - total - _common:HealthStatus: - type: string - enum: - - green - - yellow - - red - _common:Host: - type: string - _common:HourAndMinute: + - query + _common.query_dsl:IntervalsPrefix: type: object properties: - hour: - type: array - items: - type: number - minute: - type: array - items: - type: number + analyzer: + description: Analyzer used to analyze the `prefix`. + type: string + prefix: + description: Beginning characters of terms you wish to find in the top-level field. + type: string + use_field: + $ref: '#/components/schemas/_common:Field' required: - - hour - - minute - _common:HttpHeaders: + - prefix + _common.query_dsl:IntervalsQuery: + allOf: + - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - type: object + properties: + all_of: + $ref: '#/components/schemas/_common.query_dsl:IntervalsAllOf' + any_of: + $ref: '#/components/schemas/_common.query_dsl:IntervalsAnyOf' + fuzzy: + $ref: '#/components/schemas/_common.query_dsl:IntervalsFuzzy' + match: + $ref: '#/components/schemas/_common.query_dsl:IntervalsMatch' + prefix: + $ref: '#/components/schemas/_common.query_dsl:IntervalsPrefix' + wildcard: + $ref: '#/components/schemas/_common.query_dsl:IntervalsWildcard' + minProperties: 1 + maxProperties: 1 + _common.query_dsl:IntervalsWildcard: type: object - additionalProperties: - oneOf: - - type: string - - type: array - items: - type: string - _common:IBDistribution: - type: string - enum: - - ll - - spl - _common:IBLambda: - type: string - enum: - - df - - ttf - _common:Id: - type: string - _common:Ids: + properties: + analyzer: + description: |- + Analyzer used to analyze the `pattern`. + Defaults to the top-level field's analyzer. + type: string + pattern: + description: Wildcard pattern used to find matching terms. + type: string + use_field: + $ref: '#/components/schemas/_common:Field' + required: + - pattern + _common.query_dsl:Like: + description: Text that we want similar documents for or a lookup to a document's field for the text. oneOf: - - $ref: '#/components/schemas/_common:Id' - - type: array - items: - $ref: '#/components/schemas/_common:Id' - _common:IndexAlias: - type: string - _common:IndexName: - type: string - _common:IndexingStats: + - type: string + - $ref: '#/components/schemas/_common.query_dsl:LikeDocument' + _common.query_dsl:LikeDocument: type: object properties: - index_current: - type: number - delete_current: - type: number - delete_time: - $ref: '#/components/schemas/_common:Duration' - delete_time_in_millis: - $ref: '#/components/schemas/_common:DurationValueUnitMillis' - delete_total: - type: number - is_throttled: - type: boolean - noop_update_total: - type: number - throttle_time: - $ref: '#/components/schemas/_common:Duration' - throttle_time_in_millis: - $ref: '#/components/schemas/_common:DurationValueUnitMillis' - index_time: - $ref: '#/components/schemas/_common:Duration' - index_time_in_millis: - $ref: '#/components/schemas/_common:DurationValueUnitMillis' - index_total: - type: number - index_failed: - type: number - types: + doc: + description: A document not present in the index. type: object - additionalProperties: - $ref: '#/components/schemas/_common:IndexingStats' - write_load: - type: number - required: - - index_current - - delete_current - - delete_time_in_millis - - delete_total - - is_throttled - - noop_update_total - - throttle_time_in_millis - - index_time_in_millis - - index_total - - index_failed - _common:Indices: - oneOf: - - $ref: '#/components/schemas/_common:IndexName' - - type: array + fields: + type: array items: - $ref: '#/components/schemas/_common:IndexName' - _common:IndicesResponseBase: + $ref: '#/components/schemas/_common:Field' + _id: + $ref: '#/components/schemas/_common:Id' + _index: + $ref: '#/components/schemas/_common:IndexName' + per_field_analyzer: + type: object + additionalProperties: + type: string + routing: + $ref: '#/components/schemas/_common:Routing' + version: + $ref: '#/components/schemas/_common:VersionNumber' + version_type: + $ref: '#/components/schemas/_common:VersionType' + _common.query_dsl:MatchAllQuery: + allOf: + - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - type: object + _common.query_dsl:MatchBoolPrefixQuery: + allOf: + - $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' + fuzzy_rewrite: + $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`). + Can be applied to the term subqueries constructed for all terms but the final term. + type: boolean + max_expansions: + description: |- + Maximum number of terms to which the query will expand. + Can be applied to the term subqueries constructed for all terms but the final term. + type: number + minimum_should_match: + $ref: '#/components/schemas/_common:MinimumShouldMatch' + operator: + $ref: '#/components/schemas/_common.query_dsl:Operator' + prefix_length: + description: |- + Number of beginning characters left unchanged for fuzzy matching. + Can be applied to the term subqueries constructed for all terms but the final term. + type: number + query: + description: |- + Terms you wish to find in the provided field. + The last term is used in a prefix query. + type: string + required: + - query + _common.query_dsl:MatchNoneQuery: + allOf: + - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - type: object + _common.query_dsl:MatchPhrasePrefixQuery: + allOf: + - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - type: object + properties: + analyzer: + description: Analyzer used to convert text in the query value into tokens. + type: string + max_expansions: + description: Maximum number of terms to which the last provided term of the query value will expand. + type: number + query: + description: Text you wish to find in the provided field. + type: string + slop: + description: Maximum number of positions allowed between matching tokens. + type: number + zero_terms_query: + $ref: '#/components/schemas/_common.query_dsl:ZeroTermsQuery' + required: + - query + _common.query_dsl:MatchPhraseQuery: + allOf: + - $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 + query: + description: Query terms that are analyzed and turned into a phrase query. + type: string + slop: + description: Maximum number of positions allowed between matching tokens. + type: number + zero_terms_query: + $ref: '#/components/schemas/_common.query_dsl:ZeroTermsQuery' + required: + - query + _common.query_dsl:MatchQuery: + allOf: + - $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 + auto_generate_synonyms_phrase_query: + description: If `true`, match phrase queries are automatically created for multi-term synonyms. + type: boolean + cutoff_frequency: + deprecated: true + type: number + fuzziness: + $ref: '#/components/schemas/_common:Fuzziness' + fuzzy_rewrite: + $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 + lenient: + description: If `true`, format-based errors, such as providing a text query value for a numeric field, are ignored. + type: boolean + max_expansions: + description: Maximum number of terms to which the query will expand. + type: number + minimum_should_match: + $ref: '#/components/schemas/_common:MinimumShouldMatch' + operator: + $ref: '#/components/schemas/_common.query_dsl:Operator' + prefix_length: + description: Number of beginning characters left unchanged for fuzzy matching. + type: number + query: + 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' + required: + - query + _common.query_dsl:MoreLikeThisQuery: + allOf: + - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - type: object + properties: + analyzer: + description: |- + The analyzer that is used to analyze the free form text. + Defaults to the analyzer associated with the first field in fields. + type: string + boost_terms: + description: |- + Each term in the formed query could be further boosted by their tf-idf score. + This sets the boost factor to use when using this feature. + Defaults to deactivated (0). + type: number + fail_on_unsupported_field: + description: Controls whether the query should fail (throw an exception) if any of the specified fields are not of the supported types (`text` or `keyword`). + type: boolean + fields: + description: |- + A list of fields to fetch and analyze the text from. + Defaults to the `index.query.default_field` index setting, which has a default value of `*`. + type: array + items: + $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' + - type: array + items: + $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: number + max_query_terms: + description: The maximum number of query terms that can be selected. + type: number + max_word_length: + description: |- + The maximum word length above which the terms are ignored. + Defaults to unbounded (`0`). + type: number + min_doc_freq: + description: The minimum document frequency below which the terms are ignored from the input document. + type: number + minimum_should_match: + $ref: '#/components/schemas/_common:MinimumShouldMatch' + min_term_freq: + description: The minimum term frequency below which the terms are ignored from the input document. + type: number + min_word_length: + description: The minimum word length below which the terms are ignored. + type: number + per_field_analyzer: + description: Overrides the default analyzer. + type: object + additionalProperties: + type: string + routing: + $ref: '#/components/schemas/_common:Routing' + stop_words: + $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' + - type: array + items: + $ref: '#/components/schemas/_common.query_dsl:Like' + version: + $ref: '#/components/schemas/_common:VersionNumber' + version_type: + $ref: '#/components/schemas/_common:VersionType' + required: + - like + _common.query_dsl:MultiMatchQuery: + allOf: + - $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 + auto_generate_synonyms_phrase_query: + description: If `true`, match phrase queries are automatically created for multi-term synonyms. + type: boolean + cutoff_frequency: + deprecated: true + type: number + fields: + $ref: '#/components/schemas/_common:Fields' + fuzziness: + $ref: '#/components/schemas/_common:Fuzziness' + fuzzy_rewrite: + $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`). + Can be applied to the term subqueries constructed for all terms but the final term. + type: boolean + lenient: + description: If `true`, format-based errors, such as providing a text query value for a numeric field, are ignored. + type: boolean + max_expansions: + description: Maximum number of terms to which the query will expand. + type: number + minimum_should_match: + $ref: '#/components/schemas/_common:MinimumShouldMatch' + operator: + $ref: '#/components/schemas/_common.query_dsl:Operator' + prefix_length: + description: Number of beginning characters left unchanged for fuzzy matching. + type: number + query: + 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. + type: number + tie_breaker: + description: Determines how scores for each per-term blended query and scores across groups are combined. + type: number + type: + $ref: '#/components/schemas/_common.query_dsl:TextQueryType' + zero_terms_query: + $ref: '#/components/schemas/_common.query_dsl:ZeroTermsQuery' + required: + - query + _common.query_dsl:MultiValueMode: + type: string + enum: + - avg + - max + - min + - sum + _common.query_dsl:NestedQuery: + allOf: + - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - type: object + properties: + ignore_unmapped: + description: Indicates whether to ignore an unmapped path and not return any documents instead of an error. + type: boolean + inner_hits: + $ref: '#/components/schemas/_core.search:InnerHits' + path: + $ref: '#/components/schemas/_common:Field' + query: + $ref: '#/components/schemas/_common.query_dsl:QueryContainer' + score_mode: + $ref: '#/components/schemas/_common.query_dsl:ChildScoreMode' + required: + - path + - query + _common.query_dsl:NumberRangeQuery: allOf: - - $ref: '#/components/schemas/_common:AcknowledgedResponseBase' + - $ref: '#/components/schemas/_common.query_dsl:RangeQueryBase' - type: object properties: - _shards: - $ref: '#/components/schemas/_common:ShardStatistics' - _common:InlineGet: - type: object - properties: - fields: - type: object - additionalProperties: - type: object - found: - type: boolean - _seq_no: - $ref: '#/components/schemas/_common:SequenceNumber' - _primary_term: - type: number - _routing: - $ref: '#/components/schemas/_common:Routing' - _source: - type: object - required: - - found - - _source - _common:InlineGetDictUserDefined: - type: object - properties: - fields: - type: object - additionalProperties: - type: object - found: - type: boolean - _seq_no: - $ref: '#/components/schemas/_common:SequenceNumber' - _primary_term: - type: number - _routing: - $ref: '#/components/schemas/_common:Routing' - _source: - type: object - additionalProperties: - type: object - required: - - found - - _source - _common:InlineScript: + gt: + description: Greater than. + type: number + gte: + description: Greater than or equal to. + type: number + lt: + description: Less than. + type: number + lte: + description: Less than or equal to. + type: number + from: + oneOf: + - type: number + - nullable: true + type: string + to: + oneOf: + - type: number + - nullable: true + type: string + _common.query_dsl:NumericDecayFunction: allOf: - - $ref: '#/components/schemas/_common:ScriptBase' + - $ref: '#/components/schemas/_common.query_dsl:DecayFunctionBase' + - type: object + _common.query_dsl:Operator: + type: string + enum: + - and + - or + _common.query_dsl:ParentIdQuery: + allOf: + - $ref: '#/components/schemas/_common.query_dsl:QueryBase' - type: object properties: - lang: - $ref: '#/components/schemas/_common:ScriptLanguage' - options: + id: + $ref: '#/components/schemas/_common:Id' + ignore_unmapped: + description: Indicates whether to ignore an unmapped `type` and not return any documents instead of an error. + type: boolean + type: + $ref: '#/components/schemas/_common:RelationName' + _common.query_dsl:PercolateQuery: + allOf: + - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - type: object + properties: + document: + description: The source of the document being percolated. type: object - additionalProperties: - type: string - source: - description: The script source. + documents: + description: An array of sources of the documents being percolated. + type: array + items: + type: object + field: + $ref: '#/components/schemas/_common:Field' + id: + $ref: '#/components/schemas/_common:Id' + index: + $ref: '#/components/schemas/_common:IndexName' + name: + description: The suffix used for the `_percolator_document_slot` field when multiple `percolate` queries are specified. type: string + preference: + description: Preference used to fetch document to percolate. + type: string + routing: + $ref: '#/components/schemas/_common:Routing' + version: + $ref: '#/components/schemas/_common:VersionNumber' required: - - source - _common:Ip: - type: string - _common:KnnQuery: - type: object - properties: - field: - $ref: '#/components/schemas/_common:Field' - query_vector: - $ref: '#/components/schemas/_common:QueryVector' - query_vector_builder: - $ref: '#/components/schemas/_common:QueryVectorBuilder' - k: - description: The final number of nearest neighbors to return as top hits - type: number - num_candidates: - description: The number of nearest neighbor candidates to consider per shard - type: number - boost: - description: Boost value to apply to kNN scores - type: number - filter: - description: Filters for the kNN search query - oneOf: - - $ref: '#/components/schemas/_common.query_dsl:QueryContainer' - - type: array - items: - $ref: '#/components/schemas/_common.query_dsl:QueryContainer' - similarity: - description: The minimum similarity for a vector to be considered a match - type: number - required: - - field - - k - - num_candidates - _common:LatLonGeoLocation: + - field + _common.query_dsl:PinnedDoc: type: object properties: - lat: - description: Latitude - type: number - lon: - description: Longitude - type: number + _id: + $ref: '#/components/schemas/_common:Id' + _index: + $ref: '#/components/schemas/_common:IndexName' required: - - lat - - lon - _common:Level: - type: string - enum: - - cluster - - indices - - shards - _common:MergesStats: + - _id + - _index + _common.query_dsl:PinnedQuery: + allOf: + - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - allOf: + - type: object + properties: + organic: + $ref: '#/components/schemas/_common.query_dsl:QueryContainer' + required: + - organic + - type: object + properties: + ids: + description: |- + Document IDs listed in the order they are to appear in results. + Required if `docs` is not specified. + type: array + items: + $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' + minProperties: 1 + maxProperties: 1 + _common.query_dsl:PrefixQuery: + allOf: + - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - type: object + properties: + rewrite: + $ref: '#/components/schemas/_common:MultiTermQueryRewrite' + value: + description: Beginning characters of terms you wish to find in the provided field. + type: string + case_insensitive: + description: |- + Allows ASCII case insensitive matching of the value 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 + required: + - value + _common.query_dsl:QueryBase: type: object properties: - current: - type: number - current_docs: - type: number - current_size: - type: string - current_size_in_bytes: - type: number - total: - type: number - total_auto_throttle: - type: string - total_auto_throttle_in_bytes: - type: number - total_docs: + boost: + description: |- + Floating point number used to decrease or increase the relevance scores of the query. + Boost values are relative to the default value of 1.0. + A boost value between 0 and 1.0 decreases the relevance score. + A value greater than 1.0 increases the relevance score. type: number - total_size: + _name: type: string - total_size_in_bytes: - type: number - total_stopped_time: - $ref: '#/components/schemas/_common:Duration' - total_stopped_time_in_millis: - $ref: '#/components/schemas/_common:DurationValueUnitMillis' - total_throttled_time: - $ref: '#/components/schemas/_common:Duration' - total_throttled_time_in_millis: - $ref: '#/components/schemas/_common:DurationValueUnitMillis' - total_time: - $ref: '#/components/schemas/_common:Duration' - total_time_in_millis: - $ref: '#/components/schemas/_common:DurationValueUnitMillis' - required: - - current - - current_docs - - current_size_in_bytes - - total - - total_auto_throttle_in_bytes - - total_docs - - total_size_in_bytes - - total_stopped_time_in_millis - - total_throttled_time_in_millis - - total_time_in_millis - _common:Metadata: - type: object - additionalProperties: - type: object - _common:Metrics: - oneOf: - - type: string - - type: array - items: - type: string - _common:MinimumShouldMatch: - description: The minimum number of terms that should match as integer, percentage or range - oneOf: - - type: number - - type: string - _common:MultiTermQueryRewrite: - type: string - _common:Name: - type: string - _common:Names: - oneOf: - - $ref: '#/components/schemas/_common:Name' - - type: array - items: - $ref: '#/components/schemas/_common:Name' - _common:NestedSortValue: + _common.query_dsl:QueryContainer: type: object properties: - filter: - $ref: '#/components/schemas/_common.query_dsl:QueryContainer' - max_children: - type: number + bool: + $ref: '#/components/schemas/_common.query_dsl:BoolQuery' + boosting: + $ref: '#/components/schemas/_common.query_dsl:BoostingQuery' + common: + deprecated: true + type: object + additionalProperties: + $ref: '#/components/schemas/_common.query_dsl:CommonTermsQuery' + minProperties: 1 + maxProperties: 1 + combined_fields: + $ref: '#/components/schemas/_common.query_dsl:CombinedFieldsQuery' + constant_score: + $ref: '#/components/schemas/_common.query_dsl:ConstantScoreQuery' + dis_max: + $ref: '#/components/schemas/_common.query_dsl:DisMaxQuery' + distance_feature: + $ref: '#/components/schemas/_common.query_dsl:DistanceFeatureQuery' + exists: + $ref: '#/components/schemas/_common.query_dsl:ExistsQuery' + function_score: + $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' + minProperties: 1 + maxProperties: 1 + geo_bounding_box: + $ref: '#/components/schemas/_common.query_dsl:GeoBoundingBoxQuery' + geo_distance: + $ref: '#/components/schemas/_common.query_dsl:GeoDistanceQuery' + geo_polygon: + $ref: '#/components/schemas/_common.query_dsl:GeoPolygonQuery' + geo_shape: + $ref: '#/components/schemas/_common.query_dsl:GeoShapeQuery' + has_child: + $ref: '#/components/schemas/_common.query_dsl:HasChildQuery' + has_parent: + $ref: '#/components/schemas/_common.query_dsl:HasParentQuery' + ids: + $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' + minProperties: 1 + maxProperties: 1 + match: + description: |- + 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' + - {} + minProperties: 1 + maxProperties: 1 + match_all: + $ref: '#/components/schemas/_common.query_dsl:MatchAllQuery' + match_bool_prefix: + description: |- + Analyzes its input and constructs a `bool` query from the terms. + Each term except the last is used in a `term` query. + The last term is used in a prefix query. + type: object + additionalProperties: + $ref: '#/components/schemas/_common.query_dsl:MatchBoolPrefixQuery' + minProperties: 1 + maxProperties: 1 + match_none: + $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' + minProperties: 1 + maxProperties: 1 + match_phrase_prefix: + description: |- + Returns documents that contain the words of a provided text, in the same order as provided. + 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' + minProperties: 1 + maxProperties: 1 + more_like_this: + $ref: '#/components/schemas/_common.query_dsl:MoreLikeThisQuery' + multi_match: + $ref: '#/components/schemas/_common.query_dsl:MultiMatchQuery' nested: - $ref: '#/components/schemas/_common:NestedSortValue' - path: - $ref: '#/components/schemas/_common:Field' - required: - - path - _common:NodeAttributes: - type: object - properties: - attributes: - description: Lists node attributes. + $ref: '#/components/schemas/_common.query_dsl:NestedQuery' + parent_id: + $ref: '#/components/schemas/_common.query_dsl:ParentIdQuery' + percolate: + $ref: '#/components/schemas/_common.query_dsl:PercolateQuery' + pinned: + $ref: '#/components/schemas/_common.query_dsl:PinnedQuery' + prefix: + description: Returns documents that contain a specific prefix in a provided field. type: object additionalProperties: - type: string - ephemeral_id: - $ref: '#/components/schemas/_common:Id' - id: - $ref: '#/components/schemas/_common:NodeId' - name: - $ref: '#/components/schemas/_common:NodeName' - transport_address: - $ref: '#/components/schemas/_common:TransportAddress' - roles: - $ref: '#/components/schemas/_common:NodeRoles' - external_id: - type: string - required: - - attributes - - ephemeral_id - - name - - transport_address - _common:NodeId: - type: string - _common:NodeIds: - oneOf: - - $ref: '#/components/schemas/_common:NodeId' - - type: array - items: - $ref: '#/components/schemas/_common:NodeId' - _common:NodeName: - type: string - _common:NodeRole: - type: string - enum: - - master - - data - - data_cold - - data_content - - data_frozen - - data_hot - - data_warm - - client - - ingest - - ml - - voting_only - - transform - - remote_cluster_client - - coordinating_only - _common:NodeRoles: - description: '* @doc_id node-roles' - type: array - items: - $ref: '#/components/schemas/_common:NodeRole' - _common:NodeShard: - type: object - properties: - state: - $ref: '#/components/schemas/indices.stats:ShardRoutingState' - primary: - type: boolean - node: - $ref: '#/components/schemas/_common:NodeName' - shard: - type: number - index: - $ref: '#/components/schemas/_common:IndexName' - allocation_id: + $ref: '#/components/schemas/_common.query_dsl:PrefixQuery' + minProperties: 1 + maxProperties: 1 + query_string: + $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' + minProperties: 1 + maxProperties: 1 + rank_feature: + $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' + minProperties: 1 + maxProperties: 1 + rule_query: + $ref: '#/components/schemas/_common.query_dsl:RuleQuery' + script: + $ref: '#/components/schemas/_common.query_dsl:ScriptQuery' + script_score: + $ref: '#/components/schemas/_common.query_dsl:ScriptScoreQuery' + shape: + $ref: '#/components/schemas/_common.query_dsl:ShapeQuery' + simple_query_string: + $ref: '#/components/schemas/_common.query_dsl:SimpleQueryStringQuery' + span_containing: + $ref: '#/components/schemas/_common.query_dsl:SpanContainingQuery' + field_masking_span: + $ref: '#/components/schemas/_common.query_dsl:SpanFieldMaskingQuery' + span_first: + $ref: '#/components/schemas/_common.query_dsl:SpanFirstQuery' + span_multi: + $ref: '#/components/schemas/_common.query_dsl:SpanMultiTermQuery' + span_near: + $ref: '#/components/schemas/_common.query_dsl:SpanNearQuery' + span_not: + $ref: '#/components/schemas/_common.query_dsl:SpanNotQuery' + span_or: + $ref: '#/components/schemas/_common.query_dsl:SpanOrQuery' + span_term: + description: Matches spans containing a term. type: object additionalProperties: - $ref: '#/components/schemas/_common:Id' - recovery_source: + $ref: '#/components/schemas/_common.query_dsl:SpanTermQuery' + minProperties: 1 + maxProperties: 1 + span_within: + $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. type: object additionalProperties: - $ref: '#/components/schemas/_common:Id' - unassigned_info: - $ref: '#/components/schemas/cluster.allocation_explain:UnassignedInformation' - relocating_node: - oneOf: - - $ref: '#/components/schemas/_common:NodeId' - - nullable: true - type: string - relocation_failure_info: - $ref: '#/components/schemas/_common:RelocationFailureInfo' - required: - - state - - primary - - shard - - index - _common:NodeStatistics: - type: object - properties: - failures: - type: array - items: - $ref: '#/components/schemas/_common:ErrorCause' - total: - description: Total number of nodes selected by the request. - type: number - successful: - description: Number of nodes that responded successfully to the request. - type: number - failed: - description: Number of nodes that rejected the request or failed to respond. If this value is not 0, a reason for the rejection or failure is included in the response. - type: number - required: - - total - - successful - - failed - _common:Normalization: - type: string - enum: - - no - - h1 - - h2 - - h3 - - z - _common:OpType: - type: string - enum: - - index - - create - _common:OpensearchVersionInfo: - type: object - properties: - build_date: - $ref: '#/components/schemas/_common:DateTime' - build_flavor: - type: string - build_hash: - type: string - build_snapshot: - type: boolean - build_type: - type: string - lucene_version: - $ref: '#/components/schemas/_common:VersionString' - minimum_index_compatibility_version: - $ref: '#/components/schemas/_common:VersionString' - minimum_wire_compatibility_version: - $ref: '#/components/schemas/_common:VersionString' - number: - type: string - required: - - build_date - - build_flavor - - build_hash - - build_snapshot - - build_type - - lucene_version - - minimum_index_compatibility_version - - minimum_wire_compatibility_version - - number - _common:Password: - type: string - _common:Percentage: - oneOf: - - type: string - - type: number - _common:PipeSeparatedFlagsSimpleQueryStringFlag: - description: |- - A set of flags that can be represented as a single enum value or a set of values that are encoded - as a pipe-separated string - - 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' - - type: string - _common:PipelineName: - type: string - _common:PluginStats: - type: object - properties: - classname: - type: string - description: - type: string - extended_plugins: - type: array - items: - type: string - has_native_controller: - type: boolean - java_version: - $ref: '#/components/schemas/_common:VersionString' - name: - $ref: '#/components/schemas/_common:Name' - version: - $ref: '#/components/schemas/_common:VersionString' - licensed: - type: boolean - opensearch_version: - $ref: '#/components/schemas/_common:VersionString' - required: - - classname - - description - - opensearch_version - - extended_plugins - - has_native_controller - - java_version - - name - - version - - licensed - _common:QueryCacheStats: - type: object - properties: - cache_count: + $ref: '#/components/schemas/_common.query_dsl:TermQuery' + minProperties: 1 + maxProperties: 1 + terms: + $ref: '#/components/schemas/_common.query_dsl:TermsQuery' + terms_set: description: |- - Total number of entries added to the query cache across all shards assigned to selected nodes. - This number includes current and evicted entries. - type: number - cache_size: - description: Total number of entries currently in the query cache across all shards assigned to selected nodes. - type: number - evictions: - description: Total number of query cache evictions across all shards assigned to selected nodes. - type: number - hit_count: - description: Total count of query cache hits across all shards assigned to selected nodes. - type: number - memory_size: - $ref: '#/components/schemas/_common:ByteSize' - memory_size_in_bytes: - description: Total amount, in bytes, of memory used for the query cache across all shards assigned to selected nodes. - type: number - miss_count: - description: Total count of query cache misses across all shards assigned to selected nodes. - type: number - total_count: - description: Total count of hits and misses in the query cache across all shards assigned to selected nodes. - type: number - required: - - cache_count - - cache_size - - evictions - - hit_count - - memory_size_in_bytes - - miss_count - - total_count - _common:QueryVector: - type: array - items: - type: number - _common:QueryVectorBuilder: - type: object - properties: - text_embedding: - $ref: '#/components/schemas/_common:TextEmbedding' - minProperties: 1 - maxProperties: 1 - _common:RankBase: - type: object - _common:RankContainer: - type: object - properties: - rrf: - $ref: '#/components/schemas/_common:RrfRank' + 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. + type: object + additionalProperties: + $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' + minProperties: 1 + maxProperties: 1 + weighted_tokens: + 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' + 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' + minProperties: 1 + maxProperties: 1 + wrapper: + $ref: '#/components/schemas/_common.query_dsl:WrapperQuery' + type: + $ref: '#/components/schemas/_common.query_dsl:TypeQuery' minProperties: 1 maxProperties: 1 - _common:RecoveryStats: - type: object - properties: - current_as_source: - type: number - current_as_target: - type: number - throttle_time: - $ref: '#/components/schemas/_common:Duration' - throttle_time_in_millis: - $ref: '#/components/schemas/_common:DurationValueUnitMillis' - required: - - current_as_source - - current_as_target - - throttle_time_in_millis - _common:Refresh: - type: string - enum: - - 'true' - - 'false' - - wait_for - _common:RefreshStats: - type: object - properties: - external_total: - type: number - external_total_time_in_millis: - $ref: '#/components/schemas/_common:DurationValueUnitMillis' - listeners: - type: number - total: - type: number - total_time: - $ref: '#/components/schemas/_common:Duration' - total_time_in_millis: - $ref: '#/components/schemas/_common:DurationValueUnitMillis' - required: - - external_total - - external_total_time_in_millis - - listeners - - total - - total_time_in_millis - _common:RelationName: - type: string - _common:RelocationFailureInfo: - type: object - properties: - failed_attempts: - type: number - required: - - failed_attempts - _common:RequestCacheStats: + _common.query_dsl:QueryStringQuery: + allOf: + - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - type: object + properties: + allow_leading_wildcard: + description: If `true`, the wildcard characters `*` and `?` are allowed as the first character of the query string. + type: boolean + analyzer: + description: Analyzer used to convert text in the query string into tokens. + type: string + analyze_wildcard: + description: If `true`, the query attempts to analyze wildcard terms in the query string. + type: boolean + auto_generate_synonyms_phrase_query: + description: If `true`, match phrase queries are automatically created for multi-term synonyms. + type: boolean + default_field: + $ref: '#/components/schemas/_common:Field' + default_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 + escape: + type: boolean + fields: + description: Array of fields to search. Supports wildcards (`*`). + type: array + items: + $ref: '#/components/schemas/_common:Field' + fuzziness: + $ref: '#/components/schemas/_common:Fuzziness' + fuzzy_max_expansions: + description: Maximum number of terms to which the query expands for fuzzy matching. + type: number + fuzzy_prefix_length: + description: Number of beginning characters left unchanged for fuzzy matching. + type: number + fuzzy_rewrite: + $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 + lenient: + description: If `true`, format-based errors, such as providing a text value for a numeric field, are ignored. + type: boolean + max_determinized_states: + description: Maximum number of automaton states required for the query. + type: number + minimum_should_match: + $ref: '#/components/schemas/_common:MinimumShouldMatch' + phrase_slop: + description: Maximum number of positions allowed between matching tokens for phrases. + type: number + query: + description: Query string you wish to parse and use for search. + type: string + quote_analyzer: + description: |- + Analyzer used to convert quoted text in the query string into tokens. + For quoted text, this parameter overrides the analyzer specified in the `analyzer` parameter. + type: string + quote_field_suffix: + description: |- + Suffix appended to quoted text in the query string. + You can use this suffix to use a different analysis method for exact matches. + type: string + rewrite: + $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 + time_zone: + $ref: '#/components/schemas/_common:TimeZone' + type: + $ref: '#/components/schemas/_common.query_dsl:TextQueryType' + required: + - query + _common.query_dsl:RandomScoreFunction: type: object properties: - evictions: - type: number - hit_count: - type: number - memory_size: - type: string - memory_size_in_bytes: - type: number - miss_count: - type: number - required: - - evictions - - hit_count - - memory_size_in_bytes - - miss_count - _common:Result: + field: + $ref: '#/components/schemas/_common:Field' + seed: + oneOf: + - type: number + - type: string + _common.query_dsl:RangeQuery: + oneOf: + - $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' + - type: object + properties: + relation: + $ref: '#/components/schemas/_common.query_dsl:RangeRelation' + _common.query_dsl:RangeRelation: type: string enum: - - created - - updated - - deleted - - not_found - - noop - _common:Retries: + - contains + - intersects + - within + _common.query_dsl:RankFeatureFunction: type: object - properties: - bulk: - type: number - search: - type: number - required: - - bulk - - search - _common:Routing: - type: string - _common:RrfRank: + _common.query_dsl:RankFeatureFunctionLinear: + allOf: + - $ref: '#/components/schemas/_common.query_dsl:RankFeatureFunction' + - type: object + _common.query_dsl:RankFeatureFunctionLogarithm: + allOf: + - $ref: '#/components/schemas/_common.query_dsl:RankFeatureFunction' + - type: object + properties: + scaling_factor: + description: Configurable scaling factor. + type: number + required: + - scaling_factor + _common.query_dsl:RankFeatureFunctionSaturation: + allOf: + - $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 + _common.query_dsl:RankFeatureFunctionSigmoid: + allOf: + - $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 + exponent: + description: Configurable Exponent. + type: number + required: + - exponent + - pivot + _common.query_dsl:RankFeatureQuery: + allOf: + - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - type: object + properties: + field: + $ref: '#/components/schemas/_common:Field' + saturation: + $ref: '#/components/schemas/_common.query_dsl:RankFeatureFunctionSaturation' + log: + $ref: '#/components/schemas/_common.query_dsl:RankFeatureFunctionLogarithm' + linear: + $ref: '#/components/schemas/_common.query_dsl:RankFeatureFunctionLinear' + sigmoid: + $ref: '#/components/schemas/_common.query_dsl:RankFeatureFunctionSigmoid' + required: + - field + _common.query_dsl:RegexpQuery: + allOf: + - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - type: object + properties: + case_insensitive: + description: |- + Allows case insensitive matching of the regular expression value with the indexed field values when set to `true`. + When `false`, case sensitivity of matching depends on the underlying field's mapping. + type: boolean + flags: + description: Enables optional operators for the regular expression. + type: string + max_determinized_states: + description: Maximum number of automaton states required for the query. + type: number + rewrite: + $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: allOf: - - $ref: '#/components/schemas/_common:RankBase' + - $ref: '#/components/schemas/_common.query_dsl:QueryBase' - type: object properties: - rank_constant: - description: How much influence documents in individual result sets per query have over the final ranked result set - type: number - window_size: - description: Size of the individual result sets per query - type: number - _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: - type: object - properties: - order: - $ref: '#/components/schemas/_common:SortOrder' - _common:Script: - oneOf: - - $ref: '#/components/schemas/_common:InlineScript' - - $ref: '#/components/schemas/_common:StoredScriptId' - _common:ScriptBase: - type: object - properties: - params: - description: |- - Specifies any named parameters that are passed into the script as variables. - Use parameters instead of hard-coded values to decrease compile time. - type: object - additionalProperties: - type: object - _common:ScriptField: - type: object - properties: - script: - $ref: '#/components/schemas/_common:Script' - ignore_failure: - type: boolean - required: - - script - _common:ScriptLanguage: - type: string - enum: - - painless - - expression - - mustache - - java - _common:ScriptSort: + organic: + $ref: '#/components/schemas/_common.query_dsl:QueryContainer' + ruleset_id: + $ref: '#/components/schemas/_common:Id' + match_criteria: + type: object + required: + - match_criteria + - organic + - ruleset_id + _common.query_dsl:ScriptQuery: + allOf: + - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - type: object + properties: + script: + $ref: '#/components/schemas/_common:Script' + required: + - script + _common.query_dsl:ScriptScoreFunction: type: object properties: - order: - $ref: '#/components/schemas/_common:SortOrder' script: $ref: '#/components/schemas/_common:Script' - type: - $ref: '#/components/schemas/_common:ScriptSortType' - mode: - $ref: '#/components/schemas/_common:SortMode' - nested: - $ref: '#/components/schemas/_common:NestedSortValue' required: - script - _common:ScriptSortType: - type: string - enum: - - string - - number - - version - _common:ScrollId: - type: string - _common:ScrollIds: - oneOf: - - $ref: '#/components/schemas/_common:ScrollId' - - type: array - items: - $ref: '#/components/schemas/_common:ScrollId' - _common:SearchStats: - type: object - properties: - fetch_current: - type: number - fetch_time: - $ref: '#/components/schemas/_common:Duration' - fetch_time_in_millis: - $ref: '#/components/schemas/_common:DurationValueUnitMillis' - fetch_total: - type: number - open_contexts: - type: number - query_current: - type: number - query_time: - $ref: '#/components/schemas/_common:Duration' - query_time_in_millis: - $ref: '#/components/schemas/_common:DurationValueUnitMillis' - query_total: - type: number - scroll_current: - type: number - scroll_time: - $ref: '#/components/schemas/_common:Duration' - scroll_time_in_millis: - $ref: '#/components/schemas/_common:DurationValueUnitMillis' - scroll_total: - type: number - suggest_current: - type: number - suggest_time: - $ref: '#/components/schemas/_common:Duration' - suggest_time_in_millis: - $ref: '#/components/schemas/_common:DurationValueUnitMillis' - suggest_total: - type: number - groups: - type: object - additionalProperties: - $ref: '#/components/schemas/_common:SearchStats' - required: - - fetch_current - - fetch_time_in_millis - - fetch_total - - query_current - - query_time_in_millis - - query_total - - scroll_current - - scroll_time_in_millis - - scroll_total - - suggest_current - - suggest_time_in_millis - - suggest_total - _common:SearchType: - type: string - enum: - - query_then_fetch - - dfs_query_then_fetch - _common:SegmentsStats: - type: object - properties: - count: - description: Total number of segments across all shards assigned to selected nodes. - type: number - doc_values_memory: - $ref: '#/components/schemas/_common:ByteSize' - doc_values_memory_in_bytes: - description: Total amount, in bytes, of memory used for doc values across all shards assigned to selected nodes. - type: number - 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' - fixed_bit_set: - $ref: '#/components/schemas/_common:ByteSize' - fixed_bit_set_memory_in_bytes: - description: Total amount of memory, in bytes, used by fixed bit sets across all shards assigned to selected nodes. - type: number - index_writer_memory: - $ref: '#/components/schemas/_common:ByteSize' - index_writer_max_memory_in_bytes: - type: number - index_writer_memory_in_bytes: - description: Total amount, in bytes, of memory used by all index writers across all shards assigned to selected nodes. - type: number - max_unsafe_auto_id_timestamp: - description: Unix timestamp, in milliseconds, of the most recently retried indexing request. - type: number - memory: - $ref: '#/components/schemas/_common:ByteSize' - memory_in_bytes: - description: Total amount, in bytes, of memory used for segments across all shards assigned to selected nodes. - type: number - norms_memory: - $ref: '#/components/schemas/_common:ByteSize' - norms_memory_in_bytes: - description: Total amount, in bytes, of memory used for normalization factors across all shards assigned to selected nodes. - type: number - points_memory: - $ref: '#/components/schemas/_common:ByteSize' - points_memory_in_bytes: - description: Total amount, in bytes, of memory used for points across all shards assigned to selected nodes. - type: number - stored_memory: - $ref: '#/components/schemas/_common:ByteSize' - stored_fields_memory_in_bytes: - description: Total amount, in bytes, of memory used for stored fields across all shards assigned to selected nodes. - type: number - terms_memory_in_bytes: - description: Total amount, in bytes, of memory used for terms across all shards assigned to selected nodes. - type: number - terms_memory: - $ref: '#/components/schemas/_common:ByteSize' - term_vectory_memory: - $ref: '#/components/schemas/_common:ByteSize' - term_vectors_memory_in_bytes: - description: Total amount, in bytes, of memory used for term vectors across all shards assigned to selected nodes. - type: number - version_map_memory: - $ref: '#/components/schemas/_common:ByteSize' - version_map_memory_in_bytes: - description: Total amount, in bytes, of memory used by all version maps across all shards assigned to selected nodes. - type: number - required: - - count - - doc_values_memory_in_bytes - - file_sizes - - fixed_bit_set_memory_in_bytes - - index_writer_memory_in_bytes - - max_unsafe_auto_id_timestamp - - memory_in_bytes - - norms_memory_in_bytes - - points_memory_in_bytes - - stored_fields_memory_in_bytes - - terms_memory_in_bytes - - term_vectors_memory_in_bytes - - version_map_memory_in_bytes - _common:SequenceNumber: - type: number - _common:ShardFailure: - type: object - properties: - index: - $ref: '#/components/schemas/_common:IndexName' - node: - type: string - reason: - $ref: '#/components/schemas/_common:ErrorCause' - shard: - type: number - status: - type: string - required: - - reason - - shard - _common:ShardStatistics: - type: object - properties: - failed: - $ref: '#/components/schemas/_common:uint' - successful: - $ref: '#/components/schemas/_common:uint' - total: - $ref: '#/components/schemas/_common:uint' - failures: - type: array - items: - $ref: '#/components/schemas/_common:ShardFailure' - skipped: - $ref: '#/components/schemas/_common:uint' - required: - - failed - - successful - - total - _common:ShardsOperationResponseBase: - type: object - properties: - _shards: - $ref: '#/components/schemas/_common:ShardStatistics' - required: - - _shards - _common:SlicedScroll: - type: object - properties: - field: - $ref: '#/components/schemas/_common:Field' - id: - $ref: '#/components/schemas/_common:Id' - max: - type: number - required: - - id - - max - _common:Slices: - description: Slices configuration used to parallelize a process. - oneOf: - - type: number - - $ref: '#/components/schemas/_common:SlicesCalculation' - _common:SlicesCalculation: - type: string - enum: - - auto - _common:Sort: - oneOf: - - $ref: '#/components/schemas/_common:SortCombinations' - - type: array - items: - $ref: '#/components/schemas/_common:SortCombinations' - _common:SortCombinations: - oneOf: - - $ref: '#/components/schemas/_common:Field' - - $ref: '#/components/schemas/_common:SortOptions' - _common:SortMode: + _common.query_dsl:ScriptScoreQuery: + allOf: + - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - type: object + properties: + min_score: + description: Documents with a score lower than this floating point number are excluded from the search results. + type: number + query: + $ref: '#/components/schemas/_common.query_dsl:QueryContainer' + script: + $ref: '#/components/schemas/_common:Script' + required: + - query + - script + _common.query_dsl:ShapeQuery: + allOf: + - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - type: object + properties: + ignore_unmapped: + description: When set to `true` the query ignores an unmapped field and will not match any documents. + type: boolean + _common.query_dsl:SimpleQueryStringFlag: type: string enum: - - min - - max - - sum - - avg - - median - _common:SortOptions: + - ALL + - AND + - ESCAPE + - FUZZY + - NEAR + - NONE + - NOT + - OR + - PHRASE + - PRECEDENCE + - 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` + allOf: + - $ref: '#/components/schemas/_common:PipeSeparatedFlagsSimpleQueryStringFlag' + _common.query_dsl:SimpleQueryStringQuery: + allOf: + - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - type: object + properties: + analyzer: + description: Analyzer used to convert text in the query string into tokens. + type: string + analyze_wildcard: + 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. + type: boolean + default_operator: + $ref: '#/components/schemas/_common.query_dsl:Operator' + fields: + description: |- + Array of fields you wish to search. + Accepts wildcard expressions. + You also can boost relevance scores for matches to particular fields using a caret (`^`) notation. + Defaults to the `index.query.default_field index` setting, which has a default value of `*`. + type: array + items: + $ref: '#/components/schemas/_common:Field' + flags: + $ref: '#/components/schemas/_common.query_dsl:SimpleQueryStringFlags' + fuzzy_max_expansions: + description: Maximum number of terms to which the query expands for fuzzy matching. + type: number + fuzzy_prefix_length: + description: Number of beginning characters left unchanged for fuzzy matching. + type: number + fuzzy_transpositions: + description: If `true`, edits for fuzzy matching include transpositions of two adjacent characters (for example, `ab` to `ba`). + type: boolean + lenient: + 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' + query: + description: Query string in the simple query string syntax you wish to parse and use for search. + type: string + quote_field_suffix: + description: Suffix appended to quoted text in the query string. + type: string + required: + - query + _common.query_dsl:SpanContainingQuery: + allOf: + - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - type: object + properties: + big: + $ref: '#/components/schemas/_common.query_dsl:SpanQuery' + little: + $ref: '#/components/schemas/_common.query_dsl:SpanQuery' + required: + - big + - little + _common.query_dsl:SpanFieldMaskingQuery: + allOf: + - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - type: object + properties: + field: + $ref: '#/components/schemas/_common:Field' + query: + $ref: '#/components/schemas/_common.query_dsl:SpanQuery' + required: + - field + - query + _common.query_dsl:SpanFirstQuery: + allOf: + - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - type: object + properties: + end: + description: Controls the maximum end position permitted in a match. + type: number + match: + $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. type: object - properties: - _score: - $ref: '#/components/schemas/_common:ScoreSort' - _doc: - $ref: '#/components/schemas/_common:ScoreSort' - _geo_distance: - $ref: '#/components/schemas/_common:GeoDistanceSort' - _script: - $ref: '#/components/schemas/_common:ScriptSort' + additionalProperties: + type: number minProperties: 1 maxProperties: 1 - _common:SortOrder: - type: string - enum: - - asc - - desc - _common:SortResults: - type: array - items: - $ref: '#/components/schemas/_common:FieldValue' - _common:StoreStats: - type: object - properties: - size: - $ref: '#/components/schemas/_common:ByteSize' - size_in_bytes: - description: Total size, in bytes, of all shards assigned to selected nodes. - type: number - reserved: - $ref: '#/components/schemas/_common:ByteSize' - reserved_in_bytes: - description: A prediction, in bytes, of how much larger the shard stores will eventually grow due to ongoing peer recoveries, restoring snapshots, and similar activities. - type: number - total_data_set_size: - $ref: '#/components/schemas/_common:ByteSize' - total_data_set_size_in_bytes: - description: |- - Total data set size, in bytes, of all shards assigned to selected nodes. - This includes the size of shards not stored fully on the nodes, such as the cache for partially mounted indices. - type: number - required: - - size_in_bytes - - reserved_in_bytes - _common:StoredScript: + _common.query_dsl:SpanMultiTermQuery: + allOf: + - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - type: object + properties: + match: + $ref: '#/components/schemas/_common.query_dsl:QueryContainer' + required: + - match + _common.query_dsl:SpanNearQuery: + allOf: + - $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' + in_order: + description: Controls whether matches are required to be in-order. + type: boolean + slop: + description: Controls the maximum number of intervening unmatched positions permitted. + type: number + required: + - clauses + _common.query_dsl:SpanNotQuery: + allOf: + - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - type: object + properties: + dist: + description: |- + The number of tokens from within the include span that can't have overlap with the exclude span. + Equivalent to setting both `pre` and `post`. + type: number + exclude: + $ref: '#/components/schemas/_common.query_dsl:SpanQuery' + include: + $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: number + pre: + description: The number of tokens before the include span that can't have overlap with the exclude span. + type: number + required: + - exclude + - include + _common.query_dsl:SpanOrQuery: + allOf: + - $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' + required: + - clauses + _common.query_dsl:SpanQuery: type: object properties: - lang: - $ref: '#/components/schemas/_common:ScriptLanguage' - options: + span_containing: + $ref: '#/components/schemas/_common.query_dsl:SpanContainingQuery' + field_masking_span: + $ref: '#/components/schemas/_common.query_dsl:SpanFieldMaskingQuery' + span_first: + $ref: '#/components/schemas/_common.query_dsl:SpanFirstQuery' + span_gap: + $ref: '#/components/schemas/_common.query_dsl:SpanGapQuery' + span_multi: + $ref: '#/components/schemas/_common.query_dsl:SpanMultiTermQuery' + span_near: + $ref: '#/components/schemas/_common.query_dsl:SpanNearQuery' + span_not: + $ref: '#/components/schemas/_common.query_dsl:SpanNotQuery' + span_or: + $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: - type: string - source: - description: The script source. - type: string - required: - - lang - - source - _common:StoredScriptId: + $ref: '#/components/schemas/_common.query_dsl:SpanTermQuery' + minProperties: 1 + maxProperties: 1 + span_within: + $ref: '#/components/schemas/_common.query_dsl:SpanWithinQuery' + minProperties: 1 + maxProperties: 1 + _common.query_dsl:SpanTermQuery: allOf: - - $ref: '#/components/schemas/_common:ScriptBase' + - $ref: '#/components/schemas/_common.query_dsl:QueryBase' - type: object properties: - id: - $ref: '#/components/schemas/_common:Id' + value: + type: string required: - - id - _common:StringifiedEpochTimeUnitMillis: - description: |- - Some APIs will return values such as numbers also as a string (notably epoch timestamps). This behavior - is used to capture this behavior while keeping the semantics of the field type. - - 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' - - type: string - _common:StringifiedEpochTimeUnitSeconds: - description: |- - Some APIs will return values such as numbers also as a string (notably epoch timestamps). This behavior - is used to capture this behavior while keeping the semantics of the field type. - - 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' - - type: string - _common:StringifiedVersionNumber: - description: |- - Some APIs will return values such as numbers also as a string (notably epoch timestamps). This behavior - is used to capture this behavior while keeping the semantics of the field type. - - 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' - - type: string - _common:Stringifiedboolean: - description: |- - Some APIs will return values such as numbers also as a string (notably epoch timestamps). This behavior - is used to capture this behavior while keeping the semantics of the field type. - - Depending on the target language, code generators can keep the union or remove it and leniently parse - strings to the target type. - oneOf: - - type: boolean - - type: string - _common:Stringifiedinteger: - description: |- - Some APIs will return values such as numbers also as a string (notably epoch timestamps). This behavior - is used to capture this behavior while keeping the semantics of the field type. - - Depending on the target language, code generators can keep the union or remove it and leniently parse - strings to the target type. - oneOf: - - type: number - - type: string - _common:SuggestMode: - type: string - enum: - - missing - - popular - - always - _common:TaskFailure: - type: object - properties: - task_id: - type: number - node_id: - $ref: '#/components/schemas/_common:NodeId' - status: - type: string - reason: - $ref: '#/components/schemas/_common:ErrorCause' - required: - - task_id - - node_id - - status - - reason - _common:TaskId: - oneOf: - - type: string - - type: number - _common:TextEmbedding: - type: object - properties: - model_id: - type: string - model_text: - type: string - required: - - model_id - - model_text - _common:TimeOfDay: - description: Time of day, expressed as HH:MM:SS - type: string - _common:TimeUnit: + - value + _common.query_dsl:SpanWithinQuery: + allOf: + - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - type: object + properties: + big: + $ref: '#/components/schemas/_common.query_dsl:SpanQuery' + little: + $ref: '#/components/schemas/_common.query_dsl:SpanQuery' + required: + - big + - little + _common.query_dsl:TermQuery: + allOf: + - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - type: object + properties: + value: + $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`. + When `false`, the case sensitivity of matching depends on the underlying field's mapping. + type: boolean + required: + - value + _common.query_dsl:TermsQuery: + allOf: + - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - type: object + _common.query_dsl:TermsSetQuery: + allOf: + - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - type: object + properties: + minimum_should_match_field: + $ref: '#/components/schemas/_common:Field' + minimum_should_match_script: + $ref: '#/components/schemas/_common:Script' + terms: + description: Array of terms you wish to find in the provided field. + type: array + items: + type: string + required: + - terms + _common.query_dsl:TextExpansionQuery: + allOf: + - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - type: object + properties: + model_id: + description: The text expansion NLP model to use + type: string + model_text: + description: The query text + type: string + pruning_config: + $ref: '#/components/schemas/_common.query_dsl:TokenPruningConfig' + required: + - model_id + - model_text + _common.query_dsl:TextQueryType: type: string enum: - - nanos - - micros - - ms - - s - - m - - h - - d - _common:TimeZone: - type: string - _common:TopLeftBottomRightGeoBounds: - type: object - properties: - top_left: - $ref: '#/components/schemas/_common:GeoLocation' - bottom_right: - $ref: '#/components/schemas/_common:GeoLocation' - required: - - top_left - - bottom_right - _common:TopRightBottomLeftGeoBounds: - type: object - properties: - top_right: - $ref: '#/components/schemas/_common:GeoLocation' - bottom_left: - $ref: '#/components/schemas/_common:GeoLocation' - required: - - top_right - - bottom_left - _common:TranslogStats: + - best_fields + - bool_prefix + - cross_fields + - most_fields + - phrase + - phrase_prefix + _common.query_dsl:TokenPruningConfig: type: object properties: - earliest_last_modified_age: - type: number - operations: - type: number - size: - type: string - size_in_bytes: - type: number - uncommitted_operations: + tokens_freq_ratio_threshold: + description: Tokens whose frequency is more than this threshold times the average frequency of all tokens in the specified field are considered outliers and pruned. type: number - uncommitted_size: - type: string - uncommitted_size_in_bytes: + tokens_weight_threshold: + description: Tokens whose weight is less than this threshold are considered nonsignificant and pruned. type: number - required: - - earliest_last_modified_age - - operations - - size_in_bytes - - uncommitted_operations - - uncommitted_size_in_bytes - _common:TransportAddress: - type: string - _common:UnitMillis: - description: Time unit for milliseconds - type: number - _common:UnitNanos: - description: Time unit for nanoseconds - type: number - _common:UnitSeconds: - description: Time unit for seconds - type: number - _common:Username: - type: string - _common:Uuid: - type: string - _common:VersionNumber: - type: number - _common:VersionString: - type: string - _common:VersionType: - type: string - enum: - - internal - - external - - external_gte - - force - _common:Void: - description: |- - The absence of any type. This is commonly used in APIs that don't return a body. - - Although "void" is generally used for the unit type that has only one value, this is to be interpreted as - the bottom type that has no value at all. Most languages have a unit type, but few have a bottom type. - - See https://en.m.wikipedia.org/wiki/Unit_type and https://en.m.wikipedia.org/wiki/Bottom_type - type: object - _common:WaitForActiveShardOptions: + only_score_pruned_tokens: + description: Whether to only score pruned tokens, vs only scoring kept tokens. + type: boolean + _common.query_dsl:TypeQuery: + allOf: + - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - type: object + properties: + value: + type: string + required: + - value + _common.query_dsl:WeightedTokensQuery: + allOf: + - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - type: object + properties: + tokens: + description: The tokens representing this query + type: object + additionalProperties: + type: number + pruning_config: + $ref: '#/components/schemas/_common.query_dsl:TokenPruningConfig' + required: + - tokens + _common.query_dsl:WildcardQuery: + allOf: + - $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' + 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: + allOf: + - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - type: object + properties: + query: + description: |- + A base64 encoded query. + The binary data format can be any of JSON, YAML, CBOR or SMILE encodings + type: string + required: + - query + _common.query_dsl:ZeroTermsQuery: type: string enum: - all - - index-setting - _common:WaitForActiveShards: - oneOf: - - type: number - - $ref: '#/components/schemas/_common:WaitForActiveShardOptions' - _common:WaitForEvents: - type: string - enum: - - immediate - - urgent - - high - - normal - - low - - languid - _common:WarmerStats: - type: object - properties: - current: - type: number - total: - type: number - total_time: - $ref: '#/components/schemas/_common:Duration' - total_time_in_millis: - $ref: '#/components/schemas/_common:DurationValueUnitMillis' - required: - - current - - total - - total_time_in_millis - _common:WktGeoBounds: - type: object - properties: - wkt: - type: string - required: - - wkt - _common:WriteResponseBase: - type: object - properties: - _id: - $ref: '#/components/schemas/_common:Id' - _index: - $ref: '#/components/schemas/_common:IndexName' - _primary_term: - type: number - result: - $ref: '#/components/schemas/_common:Result' - _seq_no: - $ref: '#/components/schemas/_common:SequenceNumber' - _shards: - $ref: '#/components/schemas/_common:ShardStatistics' - _version: - $ref: '#/components/schemas/_common:VersionNumber' - forced_refresh: - type: boolean - required: - - _id - - _index - - _primary_term - - result - - _seq_no - - _shards - - _version - _common:byte: - type: number - _common:short: - type: number - _common:uint: - type: number - _common:ulong: - type: number + - none _core._common:DeletedPit: type: object properties: @@ -30585,7 +36661,7 @@ components: properties: _id: description: The document ID associated with the operation. - oneOf: + anyOf: - type: string - nullable: true type: string @@ -30652,7 +36728,7 @@ components: - type: object properties: require_alias: - description: If `true`, the request’s actions must target an index alias. + description: If `true`, the request's actions must target an index alias. type: boolean retry_on_conflict: type: number @@ -30666,7 +36742,7 @@ components: A map from the full name of fields to the name of dynamic templates. Defaults to an empty map. If a name matches a dynamic template, then that template will be applied regardless of other match predicates defined in the template. - If a field is already defined in the mapping, then this parameter won’t be used. + If a field is already defined in the mapping, then this parameter won't be used. type: object additionalProperties: type: string @@ -30677,7 +36753,7 @@ components: If a final pipeline is configured it will always run, regardless of the value of this parameter. type: string require_alias: - description: If `true`, the request’s actions must target an index alias. + description: If `true`, the request's actions must target an index alias. type: boolean _core.explain:Explanation: type: object @@ -30745,7 +36821,7 @@ components: metric_conflicts_indices: description: |- The list of indices where this field is present if these indices - don’t have the same `time_series_metric` value for this field. + don't have the same `time_series_metric` value for this field. type: array items: $ref: '#/components/schemas/_common:IndexName' @@ -30753,33 +36829,6 @@ components: - aggregatable - searchable - type - _core.get:GetResult: - type: object - properties: - _index: - $ref: '#/components/schemas/_common:IndexName' - fields: - type: object - additionalProperties: - type: object - found: - type: boolean - _id: - $ref: '#/components/schemas/_common:Id' - _primary_term: - type: number - _routing: - type: string - _seq_no: - $ref: '#/components/schemas/_common:SequenceNumber' - _source: - type: object - _version: - $ref: '#/components/schemas/_common:VersionNumber' - required: - - _index - - found - - _id _core.get_script_context:Context: type: object properties: @@ -30805,8 +36854,8 @@ components: $ref: '#/components/schemas/_core.get_script_context:ContextMethodParam' required: - name - - return_type - params + - return_type _core.get_script_context:ContextMethodParam: type: object properties: @@ -30829,6 +36878,33 @@ components: required: - contexts - language + _core.get:GetResult: + type: object + properties: + _index: + $ref: '#/components/schemas/_common:IndexName' + fields: + type: object + additionalProperties: + type: object + found: + type: boolean + _id: + $ref: '#/components/schemas/_common:Id' + _primary_term: + type: number + _routing: + type: string + _seq_no: + $ref: '#/components/schemas/_common:SequenceNumber' + _source: + type: object + _version: + $ref: '#/components/schemas/_common:VersionNumber' + required: + - _id + - _index + - found _core.mget:MultiGetError: type: object properties: @@ -30839,9 +36915,9 @@ components: _index: $ref: '#/components/schemas/_common:IndexName' required: - - error - _id - _index + - error _core.mget:Operation: type: object properties: @@ -30865,25 +36941,35 @@ components: oneOf: - $ref: '#/components/schemas/_core.get:GetResult' - $ref: '#/components/schemas/_core.mget:MultiGetError' - _core.msearch:MultiSearchItem: - allOf: - - $ref: '#/components/schemas/_core.search:ResponseBody' - - type: object - properties: - status: - type: number - _core.msearch:MultiSearchResult: + _core.msearch_template:RequestItem: + oneOf: + - $ref: '#/components/schemas/_core.msearch:MultisearchHeader' + - $ref: '#/components/schemas/_core.msearch_template:TemplateConfig' + _core.msearch_template:TemplateConfig: type: object properties: - took: - type: number - responses: - type: array - items: - $ref: '#/components/schemas/_core.msearch:ResponseItem' - required: - - took - - responses + explain: + description: If `true`, returns detailed information about score calculation as part of each hit. + type: boolean + id: + $ref: '#/components/schemas/_common:Id' + params: + description: |- + Key-value pairs used to replace Mustache variables in the template. + The key is the variable name. + The value is the variable value. + type: object + additionalProperties: + type: object + profile: + description: If `true`, the query execution is profiled. + type: boolean + source: + description: |- + An inline search template. Supports the same parameters as the search API's + request body. Also supports Mustache variables. If no id is specified, this + parameter is required. + type: string _core.msearch:MultisearchBody: type: object properties: @@ -30899,7 +36985,7 @@ components: 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. + description: Configuration of search extensions defined by OpenSearch plugins. type: object additionalProperties: type: object @@ -30976,7 +37062,7 @@ components: 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 + limit, OpenSearch terminates the query early. OpenSearch collects documents before sorting. Defaults to 0, which does not terminate query execution early. type: number stats: @@ -31037,6 +37123,25 @@ components: type: boolean ignore_throttled: type: boolean + _core.msearch:MultiSearchItem: + allOf: + - $ref: '#/components/schemas/_core.search:ResponseBody' + - type: object + properties: + status: + type: number + _core.msearch:MultiSearchResult: + type: object + properties: + took: + type: number + responses: + type: array + items: + $ref: '#/components/schemas/_core.msearch:ResponseItem' + required: + - responses + - took _core.msearch:RequestItem: oneOf: - $ref: '#/components/schemas/_core.msearch:MultisearchHeader' @@ -31045,35 +37150,6 @@ components: oneOf: - $ref: '#/components/schemas/_core.msearch:MultiSearchItem' - $ref: '#/components/schemas/_common:ErrorResponseBase' - _core.msearch_template:RequestItem: - oneOf: - - $ref: '#/components/schemas/_core.msearch:MultisearchHeader' - - $ref: '#/components/schemas/_core.msearch_template:TemplateConfig' - _core.msearch_template:TemplateConfig: - type: object - properties: - explain: - description: If `true`, returns detailed information about score calculation as part of each hit. - type: boolean - id: - $ref: '#/components/schemas/_common:Id' - params: - description: |- - Key-value pairs used to replace Mustache variables in the template. - The key is the variable name. - The value is the variable value. - type: object - additionalProperties: - type: object - profile: - description: If `true`, the query execution is profiled. - type: boolean - source: - description: |- - An inline search template. Supports the same parameters as the search API's - request body. Also supports Mustache variables. If no id is specified, this - parameter is required. - type: string _core.mtermvectors:Operation: type: object properties: @@ -31141,7 +37217,7 @@ components: _index: $ref: '#/components/schemas/_common:IndexName' rating: - description: The document’s relevance with regard to this search request. + description: The document's relevance with regard to this search request. type: number required: - _id @@ -31198,7 +37274,7 @@ components: description: The metric_score in the 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 in the search result for this query 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 in the search result for this query 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' @@ -31215,19 +37291,17 @@ components: additionalProperties: type: object required: - - metric_score - - unrated_docs - hits - metric_details + - metric_score + - unrated_docs _core.rank_eval:RankEvalMetricDiscountedCumulativeGain: allOf: - $ref: '#/components/schemas/_core.rank_eval:RankEvalMetricBase' - type: object properties: normalize: - externalDocs: - url: https://en.wikipedia.org/wiki/Discounted_cumulative_gain#Normalized_DCG - description: If set to true, this metric will calculate the Normalized DCG. + description: If set to true, this metric will calculate the Normalized DCG (https://en.wikipedia.org/wiki/Discounted_cumulative_gain#Normalized_DCG). type: boolean _core.rank_eval:RankEvalMetricExpectedReciprocalRank: allOf: @@ -31241,17 +37315,17 @@ components: - maximum_relevance _core.rank_eval:RankEvalMetricMeanReciprocalRank: allOf: - - $ref: '#/components/schemas/_core.rank_eval:RankEvalMetricRatingTreshold' + - $ref: '#/components/schemas/_core.rank_eval:RankEvalMetricRatingThreshold' - type: object _core.rank_eval:RankEvalMetricPrecision: allOf: - - $ref: '#/components/schemas/_core.rank_eval:RankEvalMetricRatingTreshold' + - $ref: '#/components/schemas/_core.rank_eval:RankEvalMetricRatingThreshold' - type: object properties: ignore_unlabeled: description: Controls how unlabeled documents in the search results are counted. If set to true, unlabeled documents are ignored and neither count as relevant or irrelevant. Set to false (the default), they are treated as irrelevant. type: boolean - _core.rank_eval:RankEvalMetricRatingTreshold: + _core.rank_eval:RankEvalMetricRatingThreshold: allOf: - $ref: '#/components/schemas/_core.rank_eval:RankEvalMetricBase' - type: object @@ -31261,7 +37335,7 @@ components: type: number _core.rank_eval:RankEvalMetricRecall: allOf: - - $ref: '#/components/schemas/_core.rank_eval:RankEvalMetricRatingTreshold' + - $ref: '#/components/schemas/_core.rank_eval:RankEvalMetricRatingThreshold' - type: object _core.rank_eval:RankEvalQuery: type: object @@ -31304,66 +37378,6 @@ components: required: - _id - _index - _core.reindex:Destination: - type: object - properties: - index: - $ref: '#/components/schemas/_common:IndexName' - op_type: - $ref: '#/components/schemas/_common:OpType' - pipeline: - description: The name of the pipeline to use. - type: string - routing: - $ref: '#/components/schemas/_common:Routing' - version_type: - $ref: '#/components/schemas/_common:VersionType' - required: - - index - _core.reindex:RemoteSource: - type: object - properties: - connect_timeout: - $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' - username: - $ref: '#/components/schemas/_common:Username' - password: - $ref: '#/components/schemas/_common:Password' - socket_timeout: - $ref: '#/components/schemas/_common:Duration' - required: - - host - _core.reindex:Source: - type: object - properties: - index: - $ref: '#/components/schemas/_common:Indices' - query: - $ref: '#/components/schemas/_common.query_dsl:QueryContainer' - remote: - $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. - type: number - slice: - $ref: '#/components/schemas/_common:SlicedScroll' - sort: - $ref: '#/components/schemas/_common:Sort' - _source: - $ref: '#/components/schemas/_common:Fields' - runtime_mappings: - $ref: '#/components/schemas/_common.mapping:RuntimeFields' - required: - - index _core.reindex_rethrottle:ReindexNode: allOf: - $ref: '#/components/schemas/_common:BaseNode' @@ -31451,18 +37465,78 @@ components: - action - cancellable - description + - headers - id - node - running_time_in_nanos - start_time_in_millis - status - type - - headers + _core.reindex:Destination: + type: object + properties: + index: + $ref: '#/components/schemas/_common:IndexName' + op_type: + $ref: '#/components/schemas/_common:OpType' + pipeline: + description: The name of the pipeline to use. + type: string + routing: + $ref: '#/components/schemas/_common:Routing' + version_type: + $ref: '#/components/schemas/_common:VersionType' + required: + - index + _core.reindex:RemoteSource: + type: object + properties: + connect_timeout: + $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' + username: + $ref: '#/components/schemas/_common:Username' + password: + $ref: '#/components/schemas/_common:Password' + socket_timeout: + $ref: '#/components/schemas/_common:Duration' + required: + - host + _core.reindex:Source: + type: object + properties: + index: + $ref: '#/components/schemas/_common:Indices' + query: + $ref: '#/components/schemas/_common.query_dsl:QueryContainer' + remote: + $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. + type: number + slice: + $ref: '#/components/schemas/_common:SlicedScroll' + sort: + $ref: '#/components/schemas/_common:Sort' + _source: + $ref: '#/components/schemas/_common:Fields' + runtime_mappings: + $ref: '#/components/schemas/_common.mapping:RuntimeFields' + required: + - index _core.scripts_painless_execute:PainlessContextSetup: type: object properties: document: - description: Document that’s temporarily indexed in-memory and accessible from the script. + description: Document that's temporarily indexed in-memory and accessible from the script. type: object index: $ref: '#/components/schemas/_common:IndexName' @@ -31472,6 +37546,15 @@ components: - document - index - query + _core.search_shards:ShardStoreIndex: + type: object + properties: + aliases: + type: array + items: + $ref: '#/components/schemas/_common:Name' + filter: + $ref: '#/components/schemas/_common.query_dsl:QueryContainer' _core.search:AggregationBreakdown: type: object properties: @@ -31696,10 +37779,10 @@ components: items: $ref: '#/components/schemas/_core.search:FetchProfile' required: - - type + - breakdown - description - time_in_nanos - - breakdown + - type _core.search:FetchProfileBreakdown: type: object properties: @@ -31796,7 +37879,7 @@ components: 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 `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. type: number no_match_size: description: The amount of text you want to return from the beginning of the field if there are no matching fragments to highlight. @@ -31843,17 +37926,6 @@ components: type: boolean tags_schema: $ref: '#/components/schemas/_core.search:HighlighterTagsSchema' - _core.search:HighlightField: - allOf: - - $ref: '#/components/schemas/_core.search:HighlightBase' - - type: object - properties: - fragment_offset: - type: number - matched_fields: - $ref: '#/components/schemas/_common:Fields' - analyzer: - $ref: '#/components/schemas/_common.analysis:Analyzer' _core.search:HighlighterEncoder: type: string enum: @@ -31875,9 +37947,20 @@ components: _core.search:HighlighterType: type: string enum: - - plain - fvh + - plain - unified + _core.search:HighlightField: + allOf: + - $ref: '#/components/schemas/_core.search:HighlightBase' + - type: object + properties: + fragment_offset: + type: number + matched_fields: + $ref: '#/components/schemas/_common:Fields' + analyzer: + $ref: '#/components/schemas/_common.analysis:Analyzer' _core.search:Hit: type: object properties: @@ -31939,8 +38022,8 @@ components: sort: $ref: '#/components/schemas/_common:SortResults' required: - - _index - _id + - _index _core.search:HitsMetadata: type: object properties: @@ -32045,8 +38128,8 @@ components: collate_match: type: boolean required: - - text - score + - text _core.search:PointInTimeReference: type: object properties: @@ -32109,20 +38192,20 @@ components: - advance_count - build_scorer - build_scorer_count + - compute_max_score + - compute_max_score_count - create_weight - create_weight_count - match - match_count - - shallow_advance - - shallow_advance_count - next_doc - next_doc_count - score - score_count - - compute_max_score - - compute_max_score_count - set_min_competitive_score - set_min_competitive_score_count + - shallow_advance + - shallow_advance_count _core.search:QueryProfile: type: object properties: @@ -32176,6 +38259,9 @@ components: type: boolean _shards: $ref: '#/components/schemas/_common:ShardStatistics' + phase_took: + x-version-added: '2.12' + $ref: '#/components/schemas/_common:PhaseTook' hits: $ref: '#/components/schemas/_core.search:HitsMetadata' aggregations: @@ -32207,10 +38293,10 @@ components: terminated_early: type: boolean required: - - took - - timed_out - _shards - hits + - timed_out + - took _core.search:ScoreMode: type: string enum: @@ -32325,9 +38411,9 @@ components: collate_match: type: boolean required: - - text - - score - freq + - score + - text _core.search:TotalHits: type: object properties: @@ -32352,15 +38438,6 @@ components: oneOf: - type: boolean - type: number - _core.search_shards:ShardStoreIndex: - type: object - properties: - aliases: - type: array - items: - $ref: '#/components/schemas/_common:Name' - filter: - $ref: '#/components/schemas/_common.query_dsl:QueryContainer' _core.termvectors:FieldStatistics: type: object properties: @@ -32446,13 +38523,6 @@ components: type: number required: - position - _core.update:UpdateWriteResponseBase: - allOf: - - $ref: '#/components/schemas/_common:WriteResponseBase' - - type: object - properties: - get: - $ref: '#/components/schemas/_common:InlineGet' _core.update_by_query_rethrottle:UpdateByQueryRethrottleNode: allOf: - $ref: '#/components/schemas/_common:BaseNode' @@ -32464,6 +38534,13 @@ components: $ref: '#/components/schemas/tasks._common:TaskInfo' required: - tasks + _core.update:UpdateWriteResponseBase: + allOf: + - $ref: '#/components/schemas/_common:WriteResponseBase' + - type: object + properties: + get: + $ref: '#/components/schemas/_common:InlineGet' cat._common:CatPitSegmentsRecord: type: object properties: @@ -32576,58 +38653,73 @@ components: type: string disk.indices: description: |- - Disk space used by the node’s shards. Does not include disk space for the translog or unassigned shards. + Disk space used by the node's shards. Does not include disk space for the translog or unassigned shards. IMPORTANT: This metric double-counts disk space for hard-linked files, such as those created when shrinking, splitting, or cloning an index. - oneOf: + anyOf: - $ref: '#/components/schemas/_common:ByteSize' - nullable: true type: string disk.used: description: |- Total disk space in use. - Opensearch retrieves this metric from the node’s operating system (OS). - The metric includes disk space for: Opensearch, including the translog and unassigned shards; the node’s operating system; any other applications or files on the node. + OpenSearch retrieves this metric from the node's operating system (OS). + The metric includes disk space for: OpenSearch, including the translog and unassigned shards; the node's operating system; any other applications or files on the node. Unlike `disk.indices`, this metric does not double-count disk space for hard-linked files. - oneOf: + anyOf: - $ref: '#/components/schemas/_common:ByteSize' - nullable: true type: string disk.avail: description: |- - Free disk space available to Opensearch. - Opensearch retrieves this metric from the node’s operating system. + Free disk space available to OpenSearch. + OpenSearch retrieves this metric from the node's operating system. Disk-based shard allocation uses this metric to assign shards to nodes based on available disk space. - oneOf: + anyOf: - $ref: '#/components/schemas/_common:ByteSize' - nullable: true type: string disk.total: description: Total disk space for the node, including in-use and available space. - oneOf: + anyOf: - $ref: '#/components/schemas/_common:ByteSize' - nullable: true type: string disk.percent: description: Total percentage of disk space in use. Calculated as `disk.used / disk.total`. - oneOf: + anyOf: - $ref: '#/components/schemas/_common:Percentage' - nullable: true type: string host: description: Network host for the node. Set using the `network.host` setting. - oneOf: + anyOf: - $ref: '#/components/schemas/_common:Host' - nullable: true type: string ip: description: IP address and port for the node. - oneOf: + anyOf: - $ref: '#/components/schemas/_common:Ip' - nullable: true type: string node: description: Name for the node. Set using the `node.name` setting. type: string + cat.cluster_manager:ClusterManagerRecord: + type: object + properties: + id: + description: node id + type: string + host: + description: host name + type: string + ip: + description: ip address + type: string + node: + description: node name + type: string cat.count:CountRecord: type: object properties: @@ -32702,13 +38794,9 @@ components: active_shards_percent: description: active number of shards in percent type: string - cat.help:HelpRecord: - type: object - properties: - endpoint: + discovered_cluster_manager: + description: cluster manager is discovered or not type: string - required: - - endpoint cat.indices:IndicesRecord: type: object properties: @@ -32732,13 +38820,13 @@ components: type: string docs.count: description: available docs - oneOf: + anyOf: - type: string - nullable: true type: string docs.deleted: description: deleted docs - oneOf: + anyOf: - type: string - nullable: true type: string @@ -32750,13 +38838,13 @@ components: type: string store.size: description: store size of primaries & replicas - oneOf: + anyOf: - type: string - nullable: true type: string pri.store.size: description: store size of primaries - oneOf: + anyOf: - type: string - nullable: true type: string @@ -33209,13 +39297,13 @@ components: version: $ref: '#/components/schemas/_common:VersionString' flavor: - description: The Opensearch distribution flavor. + description: The OpenSearch distribution flavor. type: string type: - description: The Opensearch distribution type. + description: The OpenSearch distribution type. type: string build: - description: The Opensearch build hash. + description: The OpenSearch build hash. type: string jdk: description: The Java version. @@ -33622,7 +39710,7 @@ components: generation: description: |- The segment generation number. - Opensearch increments this generation number for each segment written then uses this number to derive the segment name. + OpenSearch increments this generation number for each segment written then uses this number to derive the segment name. type: string docs.count: description: |- @@ -33635,7 +39723,7 @@ components: The number of deleted documents in the segment, which might be higher or lower than the number of delete operations you have performed. This number excludes deletes that were performed recently and do not yet belong to a segment. Deleted documents are cleaned up by the automatic merge process if it makes sense to do so. - Also, Opensearch creates extra deleted documents to internally track the recent history of operations on a shard. + Also, OpenSearch creates extra deleted documents to internally track the recent history of operations on a shard. type: string size: $ref: '#/components/schemas/_common:ByteSize' @@ -33645,7 +39733,7 @@ components: description: |- If `true`, the segment is synced to disk. Segments that are synced can survive a hard reboot. - If `false`, the data from uncommitted segments is also stored in the transaction log so that Opensearch is able to replay changes on the next start. + If `false`, the data from uncommitted segments is also stored in the transaction log so that OpenSearch is able to replay changes on the next start. type: string searchable: description: |- @@ -33682,19 +39770,19 @@ components: type: string docs: description: The number of documents in the shard. - oneOf: + anyOf: - type: string - nullable: true type: string store: description: The disk space used by the shard. - oneOf: + anyOf: - type: string - nullable: true type: string ip: description: The IP address of the node. - oneOf: + anyOf: - type: string - nullable: true type: string @@ -33703,7 +39791,7 @@ components: type: string node: description: The name of node. - oneOf: + anyOf: - type: string - nullable: true type: string @@ -33719,11 +39807,11 @@ components: `CLUSTER_RECOVERED`: Unassigned as a result of a full cluster recovery. `DANGLING_INDEX_IMPORTED`: Unassigned as a result of importing a dangling index. `EXISTING_INDEX_RESTORED`: Unassigned as a result of restoring into a closed index. - `FORCED_EMPTY_PRIMARY`: The shard’s allocation was last modified by forcing an empty primary using the cluster reroute API. + `FORCED_EMPTY_PRIMARY`: The shard's allocation was last modified by forcing an empty primary using the cluster reroute API. `INDEX_CLOSED`: Unassigned because the index was closed. `INDEX_CREATED`: Unassigned as a result of an API creation of an index. `INDEX_REOPENED`: Unassigned as a result of opening a closed index. - `MANUAL_ALLOCATION`: The shard’s allocation was last modified by the cluster reroute API. + `MANUAL_ALLOCATION`: The shard's allocation was last modified by the cluster reroute API. `NEW_INDEX_RESTORED`: Unassigned as a result of restoring into a new index. `NODE_LEFT`: Unassigned as a result of the node hosting it leaving the cluster. `NODE_RESTARTING`: Similar to `NODE_LEFT`, except that the node was registered as restarting using the node shutdown API. @@ -33823,7 +39911,7 @@ components: description: The number of completed merge operations. type: string merges.total_docs: - description: The nuber of merged documents. + description: The number of merged documents. type: string merges.total_size: description: The size of current merges. @@ -33838,7 +39926,7 @@ components: description: The time spent in refreshes. type: string refresh.external_total: - description: The total nunber of external refreshes. + description: The total number of external refreshes. type: string refresh.external_time: description: The time spent in external refreshes. @@ -34034,7 +40122,7 @@ components: type: string version: description: The template version. - oneOf: + anyOf: - $ref: '#/components/schemas/_common:VersionString' - nullable: true type: string @@ -34095,25 +40183,25 @@ components: type: string core: description: The core number of active threads allowed in a scaling thread pool. - oneOf: + anyOf: - type: string - nullable: true type: string max: description: The maximum number of active threads allowed in a scaling thread pool. - oneOf: + anyOf: - type: string - nullable: true type: string size: description: The number of active threads allowed in a fixed thread pool. - oneOf: + anyOf: - type: string - nullable: true type: string keep_alive: description: The thread keep alive time. - oneOf: + anyOf: - type: string - nullable: true type: string @@ -34125,8 +40213,8 @@ components: component_template: $ref: '#/components/schemas/cluster._common:ComponentTemplateNode' required: - - name - component_template + - name cluster._common:ComponentTemplateNode: type: object properties: @@ -34173,10 +40261,10 @@ components: cluster.allocation_explain:AllocationExplainDecision: type: string enum: + - ALWAYS - NO - - YES - THROTTLE - - ALWAYS + - YES cluster.allocation_explain:AllocationStore: type: object properties: @@ -34224,9 +40312,9 @@ components: $ref: '#/components/schemas/cluster.allocation_explain:ReservedSize' required: - nodes - - shard_sizes - - shard_paths - reserved_sizes + - shard_paths + - shard_sizes cluster.allocation_explain:CurrentNode: type: object properties: @@ -34243,22 +40331,22 @@ components: weight_ranking: type: number required: + - attributes - id - name - - attributes - transport_address - weight_ranking cluster.allocation_explain:Decision: type: string enum: - - yes - - no - - worse_balance - - throttled - - awaiting_info - allocation_delayed - - no_valid_shard_copy + - awaiting_info + - no - no_attempt + - no_valid_shard_copy + - throttled + - worse_balance + - yes cluster.allocation_explain:DiskUsage: type: object properties: @@ -34275,11 +40363,11 @@ components: used_disk_percent: type: number required: + - free_bytes + - free_disk_percent - path - total_bytes - used_bytes - - free_bytes - - free_disk_percent - used_disk_percent cluster.allocation_explain:NodeAllocationExplanation: type: object @@ -34322,9 +40410,9 @@ components: most_available: $ref: '#/components/schemas/cluster.allocation_explain:DiskUsage' required: - - node_name - least_available - most_available + - node_name cluster.allocation_explain:ReservedSize: type: object properties: @@ -34341,8 +40429,8 @@ components: required: - node_id - path - - total - shards + - total cluster.allocation_explain:UnassignedInformation: type: object properties: @@ -34366,21 +40454,21 @@ components: cluster.allocation_explain:UnassignedInformationReason: type: string enum: - - INDEX_CREATED + - ALLOCATION_FAILED - CLUSTER_RECOVERED - - INDEX_REOPENED - DANGLING_INDEX_IMPORTED - - NEW_INDEX_RESTORED - EXISTING_INDEX_RESTORED - - REPLICA_ADDED - - ALLOCATION_FAILED - - NODE_LEFT - - REROUTE_CANCELLED - - REINITIALIZED - - REALLOCATED_REPLICA - - PRIMARY_FAILED - FORCED_EMPTY_PRIMARY + - INDEX_CREATED + - INDEX_REOPENED - MANUAL_ALLOCATION + - NEW_INDEX_RESTORED + - NODE_LEFT + - PRIMARY_FAILED + - REALLOCATED_REPLICA + - REINITIALIZED + - REPLICA_ADDED + - REROUTE_CANCELLED cluster.health:HealthResponseBody: type: object properties: @@ -34482,10 +40570,10 @@ components: cluster.health:Level: type: string enum: + - awareness_attributes - cluster - indices - shards - - awareness_attributes cluster.health:ShardHealthStats: type: object properties: @@ -34536,6 +40624,7 @@ components: - source - time_in_queue_millis cluster.remote_info:ClusterRemoteInfo: + type: object discriminator: propertyName: mode oneOf: @@ -34563,14 +40652,14 @@ components: max_proxy_socket_connections: type: number required: - - mode - connected - initial_connect_timeout - - skip_unavailable + - max_proxy_socket_connections + - mode + - num_proxy_sockets_connected - proxy_address - server_name - - num_proxy_sockets_connected - - max_proxy_socket_connections + - skip_unavailable cluster.remote_info:ClusterRemoteSniffInfo: type: object properties: @@ -34593,13 +40682,13 @@ components: items: type: string required: - - mode - connected + - initial_connect_timeout - max_connections_per_cluster + - mode - num_nodes_connected - - initial_connect_timeout - - skip_unavailable - seeds + - skip_unavailable cluster.reroute:Command: type: object properties: @@ -34626,10 +40715,10 @@ components: 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 - - shard - node - - accept_data_loss + - shard cluster.reroute:CommandAllocateReplicaAction: type: object properties: @@ -34641,8 +40730,8 @@ components: type: string required: - index - - shard - node + - shard cluster.reroute:CommandCancelAction: type: object properties: @@ -34656,8 +40745,8 @@ components: type: boolean required: - index - - shard - node + - shard cluster.reroute:CommandMoveAction: type: object properties: @@ -34672,9 +40761,9 @@ components: description: The node to move the shard to type: string required: + - from_node - index - shard - - from_node - to_node cluster.reroute:RerouteDecision: type: object @@ -34727,15 +40816,15 @@ components: cluster.state:Metric: type: string enum: + - _all - blocks + - cluster_manager_node + - master_node - metadata - nodes - - routing_table - routing_nodes - - master_node - - cluster_manager_node + - routing_table - version - - _all cluster.stats:CharFilterTypes: type: object properties: @@ -34795,7 +40884,7 @@ components: 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. + This is the actual amount of free disk space the selected OpenSearch nodes can use. type: number free_in_bytes: description: Total number of unallocated bytes in file stores across all selected nodes. @@ -34842,11 +40931,11 @@ components: - count - docs - fielddata + - mappings - query_cache - segments - shards - store - - mappings cluster.stats:ClusterIndicesShards: type: object properties: @@ -35032,7 +41121,7 @@ components: os: $ref: '#/components/schemas/cluster.stats:ClusterOperatingSystem' packaging_types: - description: Contains statistics about Opensearch distributions installed on selected nodes. + description: Contains statistics about OpenSearch distributions installed on selected nodes. type: array items: $ref: '#/components/schemas/cluster.stats:NodePackagingType' @@ -35046,7 +41135,7 @@ components: process: $ref: '#/components/schemas/cluster.stats:ClusterProcess' versions: - description: Array of Opensearch versions used on selected nodes. + description: Array of OpenSearch versions used on selected nodes. type: array items: $ref: '#/components/schemas/_common:VersionString' @@ -35232,9 +41321,9 @@ components: description: The number of fields that declare a script. type: number required: - - name - count - index_count + - name cluster.stats:FieldTypesMappings: type: object properties: @@ -35329,7 +41418,7 @@ components: description: Number of selected nodes using the distribution flavor and file type. type: number flavor: - description: Type of Opensearch distribution. This is always `default`. + description: Type of OpenSearch distribution. This is always `default`. type: string type: description: File type (such as `tar` or `zip`) used for the distribution package. @@ -35400,7 +41489,7 @@ components: name: $ref: '#/components/schemas/_common:Name' scriptless_count: - description: Number of runtime fields that don’t declare a script. + 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. @@ -35463,9 +41552,9 @@ components: node_ids: $ref: '#/components/schemas/_common:Ids' required: + - creation_date_millis - index_name - index_uuid - - creation_date_millis - node_ids indices._common:Alias: type: object @@ -35528,7 +41617,7 @@ components: description: If `true`, the data stream allows custom routing on write request. type: boolean generation: - description: Current generation for the data stream. This number acts as a cumulative count of the stream’s rollovers, starting at 1. + description: Current generation for the data stream. This number acts as a cumulative count of the stream's rollovers, starting at 1. type: number hidden: description: If `true`, the data stream is hidden. @@ -35542,8 +41631,8 @@ components: type: boolean indices: description: |- - Array of objects containing information about the data stream’s backing indices. - The last item in this array contains information about the stream’s current write index. + Array of objects containing information about the data stream's backing indices. + The last item in this array contains information about the stream's current write index. type: array items: $ref: '#/components/schemas/indices._common:DataStreamIndex' @@ -35555,9 +41644,9 @@ components: 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:HealthStatus' + $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. + 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' @@ -35565,9 +41654,6 @@ components: $ref: '#/components/schemas/indices._common:DataStreamTimestampField' required: - generation - - hidden - - next_generation_managed_by - - prefer_ilm - indices - name - status @@ -35590,8 +41676,6 @@ components: required: - index_name - index_uuid - - managed_by - - prefer_ilm indices._common:DataStreamLifecycle: type: object properties: @@ -35648,11 +41732,6 @@ components: $ref: '#/components/schemas/_common:Field' required: - name - indices._common:DataStreamVisibility: - type: object - properties: - hidden: - type: boolean indices._common:DownsampleConfig: type: object properties: @@ -35686,9 +41765,41 @@ components: indices._common:IndexCheckOnStartup: type: string enum: - - 'true' - - 'false' - checksum + - 'false' + - 'true' + indices._common:IndexingPressure: + type: object + properties: + memory: + $ref: '#/components/schemas/indices._common:IndexingPressureMemory' + required: + - memory + indices._common:IndexingPressureMemory: + type: object + properties: + limit: + description: |- + Number of outstanding bytes that may be consumed by indexing requests. When this limit is reached or exceeded, + the node will reject new coordinating and primary operations. When replica operations consume 1.5x this limit, + the node will reject new replica operations. Defaults to 10% of the heap. + type: number + indices._common:IndexingSlowlogSettings: + type: object + properties: + level: + type: string + source: + type: number + reformat: + type: boolean + threshold: + $ref: '#/components/schemas/indices._common:IndexingSlowlogThresholds' + indices._common:IndexingSlowlogThresholds: + type: object + properties: + index: + $ref: '#/components/schemas/indices._common:SlowlogThresholdLevels' indices._common:IndexRouting: type: object properties: @@ -35730,9 +41841,9 @@ components: type: string enum: - all - - primaries - new_primaries - none + - primaries indices._common:IndexRoutingRebalance: type: object properties: @@ -35744,9 +41855,9 @@ components: type: string enum: - all + - none - primaries - replicas - - none indices._common:IndexSegmentSort: type: object properties: @@ -35914,6 +42025,7 @@ components: $ref: '#/components/schemas/indices._common:IndexingPressure' store: $ref: '#/components/schemas/indices._common:Storage' + additionalProperties: {} description: The index settings to be updated indices._common:IndexSettingsAnalysis: type: object @@ -35956,7 +42068,7 @@ components: 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. + 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' @@ -36018,7 +42130,7 @@ components: 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. + This number is not automatically generated by OpenSearch. type: number _meta: $ref: '#/components/schemas/_common:Metadata' @@ -36028,7 +42140,6 @@ components: $ref: '#/components/schemas/indices._common:IndexTemplateDataStreamConfiguration' required: - index_patterns - - composed_of description: New index template definition to be simulated, if no index template name is specified indices._common:IndexTemplateDataStreamConfiguration: type: object @@ -36039,6 +42150,8 @@ components: allow_custom_routing: description: If true, the data stream supports custom routing. type: boolean + timestamp_field: + $ref: '#/components/schemas/indices._common:DataStreamTimestampField' indices._common:IndexTemplateSummary: type: object properties: @@ -36064,43 +42177,11 @@ components: $ref: '#/components/schemas/_common:VersionString' created_string: type: string - indices._common:IndexingPressure: - type: object - properties: - memory: - $ref: '#/components/schemas/indices._common:IndexingPressureMemory' - required: - - memory - indices._common:IndexingPressureMemory: - type: object - properties: - limit: - description: |- - Number of outstanding bytes that may be consumed by indexing requests. When this limit is reached or exceeded, - the node will reject new coordinating and primary operations. When replica operations consume 1.5x this limit, - the node will reject new replica operations. Defaults to 10% of the heap. - type: number - indices._common:IndexingSlowlogSettings: - type: object - properties: - level: - type: string - source: - type: number - reformat: - type: boolean - threshold: - $ref: '#/components/schemas/indices._common:IndexingSlowlogTresholds' - indices._common:IndexingSlowlogTresholds: - type: object - properties: - index: - $ref: '#/components/schemas/indices._common:SlowlogTresholdLevels' indices._common:ManagedBy: type: string enum: - - Index Lifecycle Management - Data stream lifecycle + - Index Lifecycle Management - Unmanaged indices._common:MappingLimitSettings: type: object @@ -36135,15 +42216,15 @@ components: 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. + OpenSearch will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features. type: number indices._common:MappingLimitSettingsFieldNameLength: type: object properties: limit: description: |- - 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 + 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: number indices._common:MappingLimitSettingsNestedFields: @@ -36216,13 +42297,13 @@ components: indices._common:SegmentSortMissing: type: string enum: - - _last - _first + - _last indices._common:SegmentSortMode: type: string enum: - - min - max + - min indices._common:SegmentSortOrder: type: string enum: @@ -36381,8 +42462,8 @@ components: reformat: type: boolean threshold: - $ref: '#/components/schemas/indices._common:SlowlogTresholds' - indices._common:SlowlogTresholdLevels: + $ref: '#/components/schemas/indices._common:SlowlogThresholds' + indices._common:SlowlogThresholdLevels: type: object properties: warn: @@ -36393,13 +42474,13 @@ components: $ref: '#/components/schemas/_common:Duration' trace: $ref: '#/components/schemas/_common:Duration' - indices._common:SlowlogTresholds: + indices._common:SlowlogThresholds: type: object properties: query: - $ref: '#/components/schemas/indices._common:SlowlogTresholdLevels' + $ref: '#/components/schemas/indices._common:SlowlogThresholdLevels' fetch: - $ref: '#/components/schemas/indices._common:SlowlogTresholdLevels' + $ref: '#/components/schemas/indices._common:SlowlogThresholdLevels' indices._common:SoftDeletes: type: object properties: @@ -36426,9 +42507,9 @@ components: type: string enum: - fs - - niofs - - mmapfs - hybridfs + - mmapfs + - niofs indices._common:TemplateMapping: type: object properties: @@ -36470,8 +42551,8 @@ components: indices._common:TranslogDurability: type: string enum: - - request - async + - request indices._common:TranslogRetention: type: object properties: @@ -36494,8 +42575,8 @@ components: blocked: type: boolean required: - - name - blocked + - name indices.analyze:AnalyzeDetail: type: object properties: @@ -36515,6 +42596,18 @@ components: $ref: '#/components/schemas/indices.analyze:TokenDetail' required: - custom_analyzer + indices.analyze:AnalyzerDetail: + type: object + properties: + name: + type: string + tokens: + type: array + items: + $ref: '#/components/schemas/indices.analyze:ExplainAnalyzeToken' + required: + - name + - tokens indices.analyze:AnalyzeToken: type: object properties: @@ -36536,18 +42629,6 @@ components: - start_offset - token - type - indices.analyze:AnalyzerDetail: - type: object - properties: - name: - type: string - tokens: - type: array - items: - $ref: '#/components/schemas/indices.analyze:ExplainAnalyzeToken' - required: - - name - - tokens indices.analyze:CharFilterDetail: type: object properties: @@ -36641,23 +42722,13 @@ components: store_size: $ref: '#/components/schemas/_common:ByteSize' store_size_bytes: - description: Total size, in bytes, of all shards for the data stream’s backing indices. + description: Total size, in bytes, of all shards for the data stream's backing indices. type: number required: - backing_indices - data_stream - maximum_timestamp - store_size_bytes - indices.forcemerge._types:ForceMergeResponseBody: - allOf: - - $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/ - type: string indices.get_alias:IndexAliases: type: object properties: @@ -36684,8 +42755,8 @@ components: index_template: $ref: '#/components/schemas/indices._common:IndexTemplate' required: - - name - index_template + - name indices.get_mapping:IndexMappingRecord: type: object properties: @@ -36939,8 +43010,8 @@ components: indices: $ref: '#/components/schemas/_common:Indices' required: - - name - indices + - name indices.resolve_index:ResolveIndexDataStreamsItem: type: object properties: @@ -36951,9 +43022,9 @@ components: backing_indices: $ref: '#/components/schemas/_common:Indices' required: + - backing_indices - name - timestamp_field - - backing_indices indices.resolve_index:ResolveIndexItem: type: object properties: @@ -36970,8 +43041,8 @@ components: data_stream: $ref: '#/components/schemas/_common:DataStreamName' required: - - name - attributes + - name indices.rollover:RolloverConditions: type: object properties: @@ -37047,9 +43118,9 @@ components: - compound - deleted_docs - generation + - num_docs - search - size_in_bytes - - num_docs - version indices.segments:ShardSegmentRouting: type: object @@ -37079,8 +43150,8 @@ components: $ref: '#/components/schemas/indices.segments:Segment' required: - num_committed_segments - - routing - num_search_segments + - routing - segments indices.shard_stores:IndicesShardStores: type: object @@ -37121,10 +43192,10 @@ components: indices.shard_stores:ShardStoreStatus: type: string enum: + - all - green - - yellow - red - - all + - yellow indices.shard_stores:ShardStoreWrapper: type: object properties: @@ -37144,8 +43215,8 @@ components: items: type: string required: - - name - index_patterns + - name indices.simulate_template:Template: type: object properties: @@ -37164,8 +43235,8 @@ components: indices.stats:IndexMetadataState: type: string enum: - - open - close + - open indices.stats:IndexStats: type: object properties: @@ -37288,8 +43359,8 @@ components: required: - id - retaining_seq_no - - timestamp - source + - timestamp indices.stats:ShardPath: type: object properties: @@ -37340,9 +43411,9 @@ components: items: $ref: '#/components/schemas/indices.stats:ShardLease' required: + - leases - primary_term - version - - leases indices.stats:ShardRouting: type: object properties: @@ -37364,10 +43435,10 @@ components: indices.stats:ShardRoutingState: type: string enum: - - UNASSIGNED - INITIALIZING - - STARTED - RELOCATING + - STARTED + - UNASSIGNED indices.stats:ShardSequenceNumber: type: object properties: @@ -37607,7 +43678,7 @@ components: - 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`). + 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' @@ -37642,13 +43713,13 @@ components: ingest._common:ConvertType: type: string enum: + - auto + - boolean + - double + - float - integer - long - - float - - double - string - - boolean - - auto ingest._common:CsvProcessor: allOf: - $ref: '#/components/schemas/ingest._common:ProcessorBase' @@ -37895,7 +43966,7 @@ components: items: type: string trace_match: - description: When `true`, `_ingest._grok_match_index` will be inserted into your matched document’s metadata with the index into the pattern found in `patterns` that matched. + description: When `true`, `_ingest._grok_match_index` will be inserted into your matched document's metadata with the index into the pattern found in `patterns` that matched. type: boolean required: - field @@ -38018,8 +44089,8 @@ components: ingest._common:JsonProcessorConflictStrategy: type: string enum: - - replace - merge + - replace ingest._common:KeyValueProcessor: allOf: - $ref: '#/components/schemas/ingest._common:ProcessorBase' @@ -38102,8 +44173,6 @@ components: $ref: '#/components/schemas/_common:VersionNumber' _meta: $ref: '#/components/schemas/_common:Metadata' - required: - - _meta ingest._common:PipelineProcessor: allOf: - $ref: '#/components/schemas/ingest._common:ProcessorBase' @@ -38211,6 +44280,8 @@ components: $ref: '#/components/schemas/ingest._common:CircleProcessor' inference: $ref: '#/components/schemas/ingest._common:InferenceProcessor' + text_embedding: + $ref: '#/components/schemas/ingest._common:TextEmbeddingProcessor' minProperties: 1 maxProperties: 1 ingest._common:RemoveProcessor: @@ -38324,6 +44395,24 @@ components: required: - field - separator + ingest._common:TextEmbeddingProcessor: + allOf: + - $ref: '#/components/schemas/ingest._common:ProcessorBase' + - type: object + properties: + model_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 + additionalProperties: + type: string + description: + type: string + description: A brief description of the processor. + required: + - field_map + - model_id ingest._common:TrimProcessor: allOf: - $ref: '#/components/schemas/ingest._common:ProcessorBase' @@ -38381,7 +44470,7 @@ components: items: $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. + 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' @@ -38390,16 +44479,16 @@ components: ingest._common:UserAgentProperty: type: string enum: - - NAME + - BUILD + - DEVICE - MAJOR - MINOR - - PATCH + - NAME - OS - - OS_NAME - OS_MAJOR - OS_MINOR - - DEVICE - - BUILD + - OS_NAME + - PATCH ingest.simulate:Document: type: object properties: @@ -38472,15 +44561,54 @@ components: type: string description: Search operation type. enum: - - query_then_fetch - dfs_query_then_fetch + - query_then_fetch knn._common:SuggestMode: type: string description: Specify suggest mode. enum: + - always - missing - popular - - always + ml._common:HitsTotal: + type: object + properties: + value: + type: integer + description: The total number of hits. + relation: + type: string + description: The relation. + required: + - relation + - value + ml._common:SearchModelHits: + type: object + properties: + total: + $ref: '#/components/schemas/ml._common:HitsTotal' + hits: + type: array + items: + $ref: '#/components/schemas/ml._common:SearchModelHitsHit' + required: + - hits + - total + ml._common:SearchModelHitsHit: + type: object + properties: + _index: + type: string + description: The index. + _id: + type: string + description: The hit ID. + model_id: + type: string + description: The model ID. + required: + - _id + - model_id nodes._common:AdaptiveSelection: type: object properties: @@ -38537,13 +44665,13 @@ components: type: object properties: control_group: - description: The `cpu` control group to which the Opensearch process belongs. + description: The `cpu` control group to which the OpenSearch process belongs. type: string cfs_period_micros: - description: The period of time, in microseconds, for how regularly all tasks in the same cgroup as the Opensearch process should have their access to CPU resources reallocated. + description: The period of time, in microseconds, for how regularly all tasks in the same cgroup as the OpenSearch process should have their access to CPU resources reallocated. type: number cfs_quota_micros: - 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`. + 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' @@ -38554,7 +44682,7 @@ components: description: The number of reporting periods (as specified by `cfs_period_micros`) that have elapsed. type: number number_of_times_throttled: - description: The number of times all tasks in the same cgroup as the Opensearch process have been throttled. + 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' @@ -38562,17 +44690,17 @@ components: type: object properties: control_group: - description: The `memory` control group to which the Opensearch process belongs. + description: The `memory` control group to which the OpenSearch process belongs. type: string limit_in_bytes: description: |- - The maximum amount of user memory (including file cache) allowed for all tasks in the same cgroup as the Opensearch process. + The maximum amount of user memory (including file cache) allowed for all tasks in the same cgroup as the OpenSearch process. This value can be too big to store in a `long`, so is returned as a string so that the value returned can exactly match what the underlying operating system interface returns. Any value that is too large to parse into a `long` almost certainly means no limit has been set for the cgroup. type: string usage_in_bytes: description: |- - The total current memory usage by processes in the cgroup, in bytes, by all tasks in the same cgroup as the Opensearch process. + 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: @@ -38593,7 +44721,7 @@ components: description: Remote address for the HTTP connection. type: string last_uri: - description: The URI of the client’s most recent request. + description: The URI of the client's most recent request. type: string opened_time_millis: description: Time at which the client opened the connection. @@ -38612,7 +44740,7 @@ components: type: number x_opaque_id: description: |- - Value from the client’s `x-opaque-id` HTTP header. + 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: @@ -38622,6 +44750,15 @@ components: type: array items: $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' + failed_count: + type: number nodes._common:ClusterStateQueue: type: object properties: @@ -38634,6 +44771,11 @@ components: committed: description: Number of committed cluster states in queue. type: number + nodes._common:ClusterStateStats: + type: object + properties: + overall: + $ref: '#/components/schemas/nodes._common:ClusterStateOverallStats' nodes._common:ClusterStateUpdate: type: object properties: @@ -38706,7 +44848,7 @@ components: type: object properties: control_group: - description: The `cpuacct` control group to which the Opensearch process belongs. + description: The `cpuacct` control group to which the OpenSearch process belongs. type: string usage_nanos: $ref: '#/components/schemas/_common:DurationValueUnitNanos' @@ -38719,6 +44861,10 @@ components: available_in_bytes: description: Total number of bytes available to this Java virtual machine on this file store. type: number + 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. + type: number disk_queue: type: string disk_reads: @@ -38759,6 +44905,8 @@ components: properties: cluster_state_queue: $ref: '#/components/schemas/nodes._common:ClusterStateQueue' + cluster_state_stats: + $ref: '#/components/schemas/nodes._common:ClusterStateStats' published_cluster_states: $ref: '#/components/schemas/nodes._common:PublishedClusterStates' cluster_state_update: @@ -38809,13 +44957,13 @@ components: description: |- 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 utilise. + This is the actual amount of free disk space the OpenSearch node can utilize. type: string 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 utilise. + This is the actual amount of free disk space the OpenSearch node can utilize. type: number free: description: Total unallocated disk space in all file stores. @@ -38829,6 +44977,10 @@ components: total_in_bytes: description: Total size of all file stores in bytes. type: number + cache_reserved_in_bytes: + x-version-added: '2.7' + description: Total size of cache bytes reserved in all file stores. + type: number nodes._common:GarbageCollector: type: object properties: @@ -38922,26 +45074,26 @@ components: description: The Linux device name. type: string operations: - description: The total number of read and write operations for the device completed since starting Opensearch. + description: The total number of read and write operations for the device completed since starting OpenSearch. type: number read_kilobytes: - description: The total number of kilobytes read for the device since starting Opensearch. + description: The total number of kilobytes read for the device since starting OpenSearch. type: number read_operations: - description: The total number of read operations for the device completed since starting Opensearch. + description: The total number of read operations for the device completed since starting OpenSearch. type: number write_kilobytes: - description: The total number of kilobytes written for the device since starting Opensearch. + description: The total number of kilobytes written for the device since starting OpenSearch. type: number write_operations: - description: The total number of write operations for the device completed since starting Opensearch. + description: The total number of write operations for the device completed since starting OpenSearch. type: number nodes._common:IoStats: type: object properties: devices: description: |- - Array of disk metrics for each device that is backing an Opensearch data path. + Array of disk metrics for each device that is backing an OpenSearch data path. These disk metrics are probed periodically and averages between the last probe and the current probe are computed. type: array items: @@ -39029,6 +45181,15 @@ components: $ref: '#/components/schemas/nodes._common:Processor' type: type: string + nodes._common:LastGcStats: + type: object + properties: + used_in_bytes: + type: number + max_in_bytes: + type: number + usage_percent: + type: number nodes._common:MemoryStats: type: object properties: @@ -39122,6 +45283,9 @@ components: peak_max_in_bytes: description: Largest amount of memory, in bytes, historically used by the heap. type: number + last_gc_stats: + description: Most recent GC cycle stats for a particular memory pool. + $ref: '#/components/schemas/nodes._common:LastGcStats' nodes._common:PressureMemory: type: object properties: @@ -39220,9 +45384,9 @@ components: type: string description: The type to sample. enum: + - block - cpu - wait - - block nodes._common:ScriptCache: type: object properties: @@ -39278,6 +45442,191 @@ components: type: string compressed_size_in_bytes: type: number + nodes._common:ShardAdmissionControlStats: + type: object + properties: + global_io_usage: + $ref: '#/components/schemas/nodes._common:UsageStats' + global_cpu_usage: + $ref: '#/components/schemas/nodes._common:UsageStats' + nodes._common:ShardCachesStats: + type: object + additionalProperties: + $ref: '#/components/schemas/nodes._common:ShardCacheStats' + nodes._common:ShardCacheStats: + type: object + properties: + size_in_bytes: + type: number + evictions: + type: number + hit_count: + type: number + miss_count: + type: number + item_count: + type: number + store_name: + type: string + nodes._common:ShardClusterManagerThrottlingStats: + type: object + properties: + stats: + $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: + type: object + properties: + stats: + type: object + enabled: + type: boolean + enforced: + type: boolean + total_rejections_breakup_shadow_mode: + $ref: '#/components/schemas/nodes._common:TotalRejectionsBreakupShadowMode' + nodes._common:ShardRepositoriesStats: + type: array + nodes._common:ShardResourceUsageStats: + type: object + additionalProperties: + $ref: '#/components/schemas/nodes._common:ShardResourceUsageStatsDetail' + nodes._common:ShardResourceUsageStatsDetail: + type: object + properties: + timestamp: + type: number + cpu_utilization_percent: + $ref: '#/components/schemas/_common:Percentage' + memory_utilization_percent: + $ref: '#/components/schemas/_common:Percentage' + io_usage_stats: + $ref: '#/components/schemas/nodes._common:ShardResourceUsageStatsIoUsageStats' + nodes._common:ShardResourceUsageStatsIoUsageStats: + type: object + properties: + max_io_utilization_percent: + $ref: '#/components/schemas/_common:Percentage' + nodes._common:ShardSearchBackpressureMode: + type: string + enum: + - disabled + - enforced + - monitor_only + nodes._common:ShardSearchBackpressureStats: + type: object + properties: + search_task: + $ref: '#/components/schemas/nodes._common:ShardSearchBackpressureTaskStats' + search_shard_task: + $ref: '#/components/schemas/nodes._common:ShardSearchBackpressureTaskStats' + mode: + $ref: '#/components/schemas/nodes._common:ShardSearchBackpressureMode' + nodes._common:ShardSearchBackpressureTaskCancellationStats: + type: object + properties: + cancellation_count: + type: number + cancellation_limit_reached_count: + type: number + nodes._common:ShardSearchBackpressureTaskResourceTrackerCpuUsageTrackerStats: + type: object + properties: + cancellation_count: + type: number + current_max_millis: + $ref: '#/components/schemas/_common:DurationValueUnitMillis' + current_avg_millis: + $ref: '#/components/schemas/_common:DurationValueUnitMillis' + nodes._common:ShardSearchBackpressureTaskResourceTrackerElapsedTimeTrackerStats: + type: object + properties: + cancellation_count: + type: number + current_max_millis: + $ref: '#/components/schemas/_common:DurationValueUnitMillis' + current_avg_millis: + $ref: '#/components/schemas/_common:DurationValueUnitMillis' + nodes._common:ShardSearchBackpressureTaskResourceTrackerHeapUsageTrackerStats: + type: object + properties: + cancellation_count: + type: number + current_max_bytes: + type: number + current_avg_bytes: + type: number + rolling_avg_bytes: + type: number + nodes._common:ShardSearchBackpressureTaskResourceTrackerStats: + type: object + properties: + heap_usage_tracker: + $ref: '#/components/schemas/nodes._common:ShardSearchBackpressureTaskResourceTrackerHeapUsageTrackerStats' + elapsed_time_tracker: + $ref: '#/components/schemas/nodes._common:ShardSearchBackpressureTaskResourceTrackerElapsedTimeTrackerStats' + cpu_usage_tracker: + $ref: '#/components/schemas/nodes._common:ShardSearchBackpressureTaskResourceTrackerCpuUsageTrackerStats' + nodes._common:ShardSearchBackpressureTaskStats: + type: object + properties: + resource_tracker_stats: + $ref: '#/components/schemas/nodes._common:ShardSearchBackpressureTaskResourceTrackerStats' + cancellation_stats: + $ref: '#/components/schemas/nodes._common:ShardSearchBackpressureTaskCancellationStats' + nodes._common:ShardSearchPipelineStats: + type: object + properties: + total_request: + $ref: '#/components/schemas/nodes._common:ShardSearchPipelineTotalStats' + total_response: + $ref: '#/components/schemas/nodes._common:ShardSearchPipelineTotalStats' + pipelines: + type: object + nodes._common:ShardSearchPipelineTotalStats: + type: object + properties: + count: + type: number + time_in_millis: + $ref: '#/components/schemas/_common:DurationValueUnitMillis' + current: + type: number + failed: + type: number + nodes._common:ShardSegmentReplicationBackpressureStats: + type: object + properties: + total_rejected_requests: + type: number + nodes._common:ShardTaskCancellationStats: + type: object + properties: + search_shard_task: + $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: + type: object + properties: + stats: + $ref: '#/components/schemas/nodes._common:ShardWeightedRoutingStatsDetail' + nodes._common:ShardWeightedRoutingStatsDetail: + type: object + properties: + fail_open_count: + type: number nodes._common:Stats: type: object properties: @@ -39348,6 +45697,28 @@ components: $ref: '#/components/schemas/nodes._common:IndexingPressure' indices: $ref: '#/components/schemas/indices.stats:ShardStats' + shard_indexing_pressure: + $ref: '#/components/schemas/nodes._common:ShardIndexingPressureStats' + search_backpressure: + $ref: '#/components/schemas/nodes._common:ShardSearchBackpressureStats' + cluster_manager_throttling: + $ref: '#/components/schemas/nodes._common:ShardClusterManagerThrottlingStats' + weighted_routing: + $ref: '#/components/schemas/nodes._common:ShardWeightedRoutingStats' + task_cancellation: + $ref: '#/components/schemas/nodes._common:ShardTaskCancellationStats' + resource_usage_stats: + $ref: '#/components/schemas/nodes._common:ShardResourceUsageStats' + search_pipeline: + $ref: '#/components/schemas/nodes._common:ShardSearchPipelineStats' + segment_replication_backpressure: + $ref: '#/components/schemas/nodes._common:ShardSegmentReplicationBackpressureStats' + repositories: + $ref: '#/components/schemas/nodes._common:ShardRepositoriesStats' + admission_control: + $ref: '#/components/schemas/nodes._common:ShardAdmissionControlStats' + caches: + $ref: '#/components/schemas/nodes._common:ShardCachesStats' nodes._common:ThreadCount: type: object properties: @@ -39369,6 +45740,20 @@ components: threads: description: Number of threads in the thread pool. type: number + 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:TotalRejectionsBreakupShadowMode: + type: object + properties: + node_limits: + type: number + no_successful_request_limits: + type: number + throughput_degradation_limits: + type: number nodes._common:Transport: type: object properties: @@ -39423,6 +45808,16 @@ 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: + type: object + properties: + rejection_count: + type: object + nodes._common:UsageStats: + type: object + properties: + transport: + $ref: '#/components/schemas/nodes._common:TransportUsageStats' nodes.info:DeprecationIndexing: type: object properties: @@ -39435,19 +45830,19 @@ components: nodes.info:Metric: type: string enum: - - settings + - _all + - aggregations + - http + - indices + - ingest + - jvm - os + - plugins - process - - jvm + - search_pipelines + - settings - thread_pool - transport - - http - - plugins - - ingest - - aggregations - - indices - - search_pipelines - - _all nodes.info:NodeInfo: type: object properties: @@ -39511,9 +45906,10 @@ components: type: object additionalProperties: $ref: '#/components/schemas/nodes.info:NodeInfoAggregation' + search_pipelines: + $ref: '#/components/schemas/nodes.info:NodeInfoSearchPipelines' required: - attributes - - build_flavor - build_hash - build_type - host @@ -39552,13 +45948,13 @@ components: type: string required: - type - nodes.info:NodeInfoDiscover: + nodes.info:NodeInfoDiscovery: type: object properties: + type: + type: string seed_hosts: type: string - required: - - seed_hosts nodes.info:NodeInfoHttp: type: object properties: @@ -39712,9 +46108,8 @@ components: items: type: string required: - - logs - home - - repo + - logs nodes.info:NodeInfoRepositories: type: object properties: @@ -39746,6 +46141,20 @@ components: $ref: '#/components/schemas/nodes.info:NodeInfoSearchRemote' required: - remote + nodes.info:NodeInfoSearchPipelines: + type: object + properties: + response_processors: + type: array + items: + $ref: '#/components/schemas/nodes.info:NodeInfoIngestProcessor' + request_processors: + type: array + items: + $ref: '#/components/schemas/nodes.info:NodeInfoIngestProcessor' + required: + - request_processors + - response_processors nodes.info:NodeInfoSearchRemote: type: object properties: @@ -39765,7 +46174,7 @@ components: repositories: $ref: '#/components/schemas/nodes.info:NodeInfoRepositories' discovery: - $ref: '#/components/schemas/nodes.info:NodeInfoDiscover' + $ref: '#/components/schemas/nodes.info:NodeInfoDiscovery' action: $ref: '#/components/schemas/nodes.info:NodeInfoAction' client: @@ -39784,12 +46193,14 @@ components: $ref: '#/components/schemas/nodes.info:NodeInfoSearch' ingest: $ref: '#/components/schemas/nodes.info:NodeInfoSettingsIngest' + index: + $ref: '#/components/schemas/nodes.info:NodeInfoSettingsIndex' required: + - client - cluster + - http - node - path - - client - - http - transport nodes.info:NodeInfoSettingsCluster: type: object @@ -39800,13 +46211,14 @@ components: $ref: '#/components/schemas/indices._common:IndexRouting' election: $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' required: - name - - election nodes.info:NodeInfoSettingsClusterElection: type: object properties: @@ -39818,7 +46230,7 @@ components: type: object properties: type: - $ref: '#/components/schemas/nodes.info:NodeInfoSettingsHttpType' + type: string type.default: type: string compression: @@ -39831,13 +46243,28 @@ components: - type: string required: - type - nodes.info:NodeInfoSettingsHttpType: + nodes.info:NodeInfoSettingsIndex: type: object properties: - default: - type: string - required: - - default + store: + $ref: '#/components/schemas/nodes.info:NodeInfoSettingsIndexStore' + nodes.info:NodeInfoSettingsIndexHybrid: + type: object + properties: + mmap: + $ref: '#/components/schemas/nodes.info:NodeInfoSettingsIndexStoreMmap' + nodes.info:NodeInfoSettingsIndexStore: + type: object + properties: + hybrid: + $ref: '#/components/schemas/nodes.info:NodeInfoSettingsIndexHybrid' + nodes.info:NodeInfoSettingsIndexStoreMmap: + type: object + properties: + extensions: + type: array + items: + type: string nodes.info:NodeInfoSettingsIngest: type: object properties: @@ -39922,30 +46349,28 @@ components: name: $ref: '#/components/schemas/_common:Name' attr: - type: object - additionalProperties: - type: object + $ref: '#/components/schemas/nodes.info:NodeInfoShardIndexingPressureEnabled' max_local_storage_nodes: type: string required: - - name - attr + - name nodes.info:NodeInfoSettingsTransport: type: object properties: type: - $ref: '#/components/schemas/nodes.info:NodeInfoSettingsTransportType' + type: string type.default: type: string required: - type - nodes.info:NodeInfoSettingsTransportType: + nodes.info:NodeInfoShardIndexingPressureEnabled: type: object properties: - default: + shard_indexing_pressure_enabled: type: string required: - - default + - shard_indexing_pressure_enabled nodes.info:NodeInfoTransport: type: object properties: @@ -39961,8 +46386,8 @@ components: type: string required: - bound_address - - publish_address - profiles + - publish_address nodes.info:NodeJvmInfo: type: object properties: @@ -39988,6 +46413,8 @@ components: type: string vm_version: $ref: '#/components/schemas/_common:VersionString' + bundled_jdk: + type: boolean using_bundled_jdk: type: boolean using_compressed_ordinary_object_pointers: @@ -39999,7 +46426,9 @@ components: items: type: string required: + - bundled_jdk - gc_collectors + - input_arguments - mem - memory_pools - pid @@ -40008,8 +46437,6 @@ components: - vm_name - vm_vendor - vm_version - - using_bundled_jdk - - input_arguments nodes.info:NodeOperatingSystemInfo: type: object properties: @@ -40107,40 +46534,55 @@ components: nodes.stats:IndexMetric: type: string enum: - - store - - indexing + - _all + - completion + - docs + - fielddata + - flush - get - - search + - indexing - merge - - flush - - refresh - query_cache - - fielddata - - docs - - warmer - - completion + - recovery + - refresh + - request_cache + - search - segments - - translog + - store - suggest - - request_cache - - recovery - - _all + - translog + - warmer nodes.stats:Metric: type: string enum: + - _all + - adaptive_selection + - admission_control - breaker + - caches + - cluster_manager_throttling + - discovery + - file_cache - fs - http + - indexing_pressure - indices + - ingest - jvm - os - process + - repositories + - resource_usage_stats + - script + - script_cache + - search_backpressure + - search_pipeline + - segment_replication_backpressure + - shard_indexing_pressure + - task_cancellation - thread_pool - transport - - discovery - - indexing_pressure - - search_pipeline - - _all + - weighted_routing nodes.stats:ResponseBase: allOf: - $ref: '#/components/schemas/nodes._common:NodesResponseBase' @@ -40157,8 +46599,8 @@ components: nodes.usage:Metric: type: string enum: - - rest_actions - _all + - rest_actions nodes.usage:NodeUsage: type: object properties: @@ -40175,10 +46617,10 @@ components: additionalProperties: type: object required: + - aggregations - rest_actions - since - timestamp - - aggregations nodes.usage:ResponseBase: allOf: - $ref: '#/components/schemas/nodes._common:NodesResponseBase' @@ -40230,9 +46672,9 @@ components: notifications._common:EmailEncryptionMethod: type: string enum: + - none - ssl - start_tls - - none notifications._common:EmailGroup: type: object properties: @@ -40305,9 +46747,9 @@ components: notifications._common:HttpMethodType: type: string enum: + - PATCH - POST - PUT - - PATCH notifications._common:MicrosoftTeamsItem: type: object properties: @@ -40315,19 +46757,32 @@ components: type: string required: - url + notifications._common:NotificationChannel: + type: object + properties: + config_id: + type: string + name: + type: string + description: + type: string + config_type: + $ref: '#/components/schemas/notifications._common:NotificationConfigType' + is_enabled: + type: boolean notifications._common:NotificationConfigType: type: string description: Type of notification configuration. enum: - - slack - chime - - microsoft_teams - - webhook - email - - sns + - email_group + - microsoft_teams - ses_account + - slack - smtp_account - - email_group + - sns + - webhook notifications._common:NotificationsConfig: type: object properties: @@ -40394,23 +46849,23 @@ components: notifications._common:RestStatus: type: string enum: + - accepted - continue - - switching_protocols - - ok - created - - accepted - - non_authoritative_information - - no_content - - reset_content - - partial_content + - found + - moved_permanently - multi_status - multiple_choices - - moved_permanently - - found - - see_other + - no_content + - non_authoritative_information - not_modified - - use_proxy + - ok + - partial_content + - reset_content + - see_other + - switching_protocols - temporary_redirect + - use_proxy notifications._common:SesAccount: type: object properties: @@ -40418,17 +46873,17 @@ components: type: string role_arn: type: string - from_addess: + from_address: type: string required: - - from_addess + - from_address - region notifications._common:SeverityType: type: string enum: + - critical - high - info - - critical notifications._common:SlackItem: type: object properties: @@ -40446,10 +46901,10 @@ components: format: int32 method: $ref: '#/components/schemas/notifications._common:EmailEncryptionMethod' - from_addess: + from_address: type: string required: - - from_addess + - from_address - host - method - port @@ -40501,6 +46956,192 @@ components: successful: type: integer format: int32 + rollups._common:Continuous: + type: object + properties: + next_window_start_time: + type: number + next_window_end_time: + type: number + status: + type: string + failure_reason: + type: string + stats: + $ref: '#/components/schemas/rollups._common:Stats' + rollups._common:Cron: + type: object + properties: + expression: + type: string + timezone: + type: string + rollups._common:DateHistogramDimension: + type: object + properties: + fixed_interval: + type: string + calendar_interval: + type: string + timezone: + type: string + source_field: + type: string + target_field: + type: string + rollups._common:DimensionsConfigItem: + type: object + properties: + histogram: + $ref: '#/components/schemas/rollups._common:HistogramDimension' + date_histogram: + $ref: '#/components/schemas/rollups._common:DateHistogramDimension' + terms: + $ref: '#/components/schemas/rollups._common:TermsDimension' + minProperties: 1 + maxProperties: 1 + rollups._common:Explain: + type: object + properties: + rollup_id: + type: string + last_updated_time: + type: number + continuous: + $ref: '#/components/schemas/rollups._common:Continuous' + rollups._common:ExplainEntities: + type: object + properties: + item: + $ref: '#/components/schemas/rollups._common:Explain' + rollups._common:HistogramDimension: + type: object + properties: + source_field: + type: string + target_field: + type: string + interval: + type: string + rollups._common:Interval: + type: object + properties: + start_time: + type: number + period: + type: number + unit: + type: string + cron: + oneOf: + - type: array + items: + $ref: '#/components/schemas/rollups._common:Cron' + - $ref: '#/components/schemas/rollups._common:Cron' + schedule_delay: + type: number + rollups._common:MetricsConfigItem: + type: object + properties: + source_field: + type: string + target_field: + type: string + metrics: + type: array + items: + $ref: '#/components/schemas/rollups._common:MetricsConfigMetrics' + rollups._common:MetricsConfigMetrics: + type: object + properties: + avg: + type: object + sum: + type: object + max: + type: object + min: + type: object + value_count: + type: object + minProperties: 1 + maxProperties: 1 + rollups._common:Rollup: + type: object + properties: + rollup_id: + type: string + enabled: + type: boolean + schedule: + $ref: '#/components/schemas/rollups._common:Schedule' + last_updated_time: + type: number + enabled_time: + type: number + description: + type: string + schema_version: + type: number + source_index: + type: string + target_index: + type: string + metadata_id: + type: string + page_size: + type: number + delay: + type: number + continuous: + type: boolean + dimensions: + type: array + items: + $ref: '#/components/schemas/rollups._common:DimensionsConfigItem' + metrics: + type: array + items: + $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: + type: object + properties: + _id: + type: string + _seqNo: + type: number + _primaryTerm: + type: number + rollup: + $ref: '#/components/schemas/rollups._common:Rollup' + rollups._common:Schedule: + type: object + properties: + interval: + $ref: '#/components/schemas/rollups._common:Interval' + rollups._common:Stats: + type: object + properties: + pages_processed: + type: number + documents_processed: + type: number + rollups_indexed: + type: number + index_time_in_ms: + type: number + search_time_in_ms: + type: number + rollups._common:TermsDimension: + type: object + properties: + source_field: + type: string + target_field: + type: string search_pipeline._common:FilterQueryRequestProcessor: type: object properties: @@ -40619,8 +47260,8 @@ components: search_pipeline._common:ScoreNormalizationTechnique: type: string enum: - - min_max - l2 + - min_max search_pipeline._common:SearchPipelineMap: type: object additionalProperties: @@ -40757,11 +47398,7 @@ components: type: array items: type: string - security._common:ActionGroupsMap: - type: object - additionalProperties: - $ref: '#/components/schemas/security._common:Action_Group' - security._common:Action_Group: + security._common:ActionGroup: type: object properties: reserved: @@ -40778,6 +47415,23 @@ components: type: string static: type: boolean + security._common:ActionGroupsMap: + type: object + additionalProperties: + $ref: '#/components/schemas/security._common:ActionGroup' + security._common:AllowConfig: + 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:AllowListConfig: + type: object + properties: + config: + $ref: '#/components/schemas/security._common:AllowConfig' security._common:AuditConfig: type: object properties: @@ -40827,6 +47481,61 @@ components: type: boolean enable_rest: type: boolean + security._common:AuthInfo: + type: object + properties: + user: + type: string + description: Stringified User object. + user_name: + type: string + description: User's name. + user_requested_tenant: + type: string + description: Name of the tenant the user wants to switch to. + remote_address: + type: string + description: The IP address of remote user. + backend_roles: + type: array + description: Backend roles associated with the user. + custom_attribute_names: + type: array + description: Name of the attributes associated with the user. + roles: + type: array + description: Roles associated with the user. + tenants: + type: object + description: Tenants the user has access to with read-write or read-only access indicator. + principal: + type: string + description: User principal. + peer_certificates: + type: number + description: Number of peer certificates. + sso_logout_url: + type: string + description: Logout url. + size_of_user: + type: string + description: Size of user in memory. + size_of_custom_attributes: + type: string + description: Size of user's custom attributes in bytes. + size_of_backendroles: + type: string + description: Size of backend roles in bytes. + security._common:BadRequest: + type: object + properties: + status: + type: string + enum: + - 400 + message: + type: string + description: Message returned as part of BAD_REQUEST response. security._common:CertificatesDetail: type: object properties: @@ -40845,10 +47554,10 @@ components: properties: current_password: type: string - description: The current password + description: The current password. password: type: string - description: The new password to set + description: The new password to set. required: - current_password - password @@ -40880,11 +47589,53 @@ components: type: boolean internal_config: type: boolean + security._common:ConfigUpgradePayload: + type: object + properties: + config: + type: array + description: List of configs to be upgraded. security._common:CreateTenantParams: type: object properties: description: type: string + security._common:DashboardsInfo: + type: object + properties: + user_name: + type: string + description: User's name + not_fail_on_forbidden_enabled: + type: boolean + description: Indicates whether DNFOF is enabled. + opensearch_dashboards_mt_enabled: + type: boolean + description: Indicates whether multi-tenancy is enabled. + opensearch_dashboards_index: + type: string + description: Name of the dashboards index. + opensearch_dashboards_server_user: + type: string + description: Name of the user used to connect dashboards to the server. + multitenancy_enabled: + type: boolean + description: Indicates whether multi-tenancy is enabled. + private_tenant_enabled: + type: boolean + description: Indicates whether private tenant is enabled for all users. + default_tenant: + type: string + description: The default tenant setting for the dashboard. + sign_in_options: + type: array + description: List of available sign-in options available. + password_validation_error_message: + type: string + description: Error message when password validation fails. + password_validation_regex: + type: string + description: Reg-ex to be used to perform password validation. security._common:DistinguishedNames: type: object properties: @@ -40925,6 +47676,38 @@ components: type: string doNotFailOnForbiddenEmpty: type: boolean + security._common:GenerateOBOToken: + type: object + properties: + user: + type: string + description: The name of the entity requesting token. + authenticationToken: + type: string + description: The generated OBO token. + durationSeconds: + type: string + description: The duration of the token, defaulted to 300s. + security._common:GetCertificates: + type: object + properties: + http_certificates_list: + type: array + items: + $ref: '#/components/schemas/security._common:CertificatesDetail' + transport_certificates_list: + type: array + items: + $ref: '#/components/schemas/security._common:CertificatesDetail' + security._common:HealthInfo: + type: object + properties: + message: + type: string + mode: + type: string + status: + type: string security._common:IndexPermission: type: object properties: @@ -40946,12 +47729,66 @@ components: type: array items: type: string + security._common:InternalServerError: + type: object + properties: + error: + type: string + description: Error message during request execution. + security._common:MethodNotImplemented: + type: object + properties: + status: + type: string + enum: + - 501 + message: + type: string + description: Message returned as part of NOT_IMPLEMENTED response. + security._common:MultiTenancyConfig: + type: object + properties: + default_tenant: + type: string + private_tenant_enabled: + type: boolean + multitenancy_enabled: + type: boolean + sign_in_options: + type: array + items: + type: string + description: Value in seconds. + security._common:OBOToken: + type: object + properties: + description: + type: string + description: Contains the description supplied by the user to describe the token. + service: + type: string + description: A name of the service if generating a token for that service. + duration: + type: string + description: Value in seconds. + required: + - description + security._common:Ok: + type: object + properties: + status: + type: string + enum: + - 200 + message: + type: string + description: Message returned as part of OK response. security._common:PatchOperation: type: object properties: op: type: string - description: 'The operation to perform. Possible values: remove,add, replace, move, copy, test.' + description: 'The operation to perform. Possible values: remove, add, replace, move, copy, test.' path: type: string description: The path to the resource. @@ -40960,6 +47797,18 @@ components: required: - op - path + security._common:PermissionsInfo: + type: object + properties: + user: + type: string + user_name: + type: string + has_api_access: + type: boolean + disabled_endpoints: + type: object + description: An object with disabled APIs as key and array of http methods as values. security._common:Role: type: object properties: @@ -41016,6 +47865,54 @@ components: type: object additionalProperties: $ref: '#/components/schemas/security._common:Role' + security._common:SSLInfo: + type: object + properties: + principal: + type: string + description: User principal. + peer_certificates: + type: number + description: Number of certificates. + peer_certificates_list: + type: array + description: List of domain names from peer certificates. + local_certificates_list: + type: array + description: List of domain names from local certificates. + ssl_protocol: + type: string + description: Protocol for this ssl setup. + ssl_cipher: + type: string + description: Cipher for this ssl setup. + ssl_openssl_available: + type: boolean + description: A boolean to indicate if OpenSSL is available. + ssl_openssl_version: + type: string + description: Version of openssl. + ssl_openssl_version_string: + type: string + description: Full version string for openssl version. + ssl_openssl_non_available_cause: + type: string + description: Reason for openssl unavailability. + ssl_openssl_supports_key_manager_factory: + type: boolean + description: Indicates where KMF is supported. + ssl_openssl_supports_hostname_validation: + type: boolean + description: Indicates whether hostname validation is supported. + ssl_provider_http: + type: string + description: Returns http provider's name. + ssl_provider_transport_server: + type: string + description: Returns transport server's name. + ssl_provider_transport_client: + type: string + description: Returns transport client's name. security._common:Tenant: type: object properties: @@ -41027,6 +47924,10 @@ components: type: string static: type: boolean + security._common:TenantInfo: + type: object + additionalProperties: + type: string security._common:TenantPermission: type: object properties: @@ -41042,6 +47943,32 @@ components: type: object additionalProperties: $ref: '#/components/schemas/security._common:Tenant' + security._common:Unauthorized: + type: object + properties: + status: + type: string + enum: + - 403 + message: + type: string + description: Message returned as part of FORBIDDEN response. + security._common:UpgradeCheck: + type: object + properties: + status: + type: string + upgradeAvailable: + type: boolean + upgradeActions: + type: object + security._common:UpgradePerform: + type: object + properties: + status: + type: string + upgrades: + type: object security._common:User: type: object properties: @@ -41069,6 +47996,10 @@ components: type: object additionalProperties: type: string + security._common:UsersMap: + type: object + additionalProperties: + $ref: '#/components/schemas/security._common:User' security._common:UserTenants: type: object properties: @@ -41078,10 +48009,15 @@ components: type: boolean admin: type: boolean - security._common:UsersMap: + security._common:WhoAmI: type: object - additionalProperties: - $ref: '#/components/schemas/security._common:User' + properties: + dn: + type: string + is_admin: + type: string + is_node_certificate_request: + type: string snapshot._common:FileCountSnapshotStats: type: object properties: @@ -41104,9 +48040,9 @@ components: max_segments_per_shard: type: number required: + - max_segments_per_shard - shard_count - size_in_bytes - - max_segments_per_shard snapshot._common:InfoFeatureState: type: object properties: @@ -41127,8 +48063,8 @@ components: settings: $ref: '#/components/schemas/snapshot._common:RepositorySettings' required: - - type - settings + - type snapshot._common:RepositorySettings: type: object properties: @@ -41195,9 +48131,9 @@ components: $ref: '#/components/schemas/_common:DurationValueUnitMillis' required: - incremental - - total - start_time_in_millis - time_in_millis + - total snapshot._common:ShardsStatsSummaryItem: type: object properties: @@ -41396,8 +48332,8 @@ components: $ref: '#/components/schemas/_common:ShardStatistics' required: - indices - - snapshot - shards + - snapshot snapshot.verify_repository:CompactNodeInfo: type: object properties: @@ -41409,8 +48345,8 @@ components: type: string enum: - nodes - - parents - none + - parents tasks._common:NodeTasks: type: object properties: @@ -41512,3 +48448,201 @@ components: $ref: '#/components/schemas/tasks._common:NodeTasks' tasks: $ref: '#/components/schemas/tasks._common:TaskInfos' + transforms._common:ContinuousStats: + type: object + properties: + last_timestamp: + type: number + documents_behind: + type: object + additionalProperties: + type: number + transforms._common:DateHistogramGroup: + type: object + properties: + fixed_interval: + type: string + calendar_interval: + type: string + timezone: + type: string + source_field: + type: string + target_field: + type: string + transforms._common:Explain: + type: object + properties: + metadata_id: + type: string + transform_metadata: + $ref: '#/components/schemas/transforms._common:TransformMetadata' + transforms._common:ExplainResponse: + type: object + additionalProperties: + $ref: '#/components/schemas/transforms._common:Explain' + transforms._common:ExplainStats: + type: object + properties: + pages_processed: + type: number + documents_processed: + type: number + documents_indexed: + type: number + index_time_in_millis: + type: number + search_time_in_millis: + type: number + transforms._common:GroupsConfigItem: + type: object + properties: + histogram: + $ref: '#/components/schemas/transforms._common:HistogramGroup' + date_histogram: + $ref: '#/components/schemas/transforms._common:DateHistogramGroup' + terms: + $ref: '#/components/schemas/transforms._common:TermsGroup' + minProperties: 1 + maxProperties: 1 + transforms._common:HistogramGroup: + type: object + properties: + source_field: + type: string + target_field: + type: string + interval: + type: string + transforms._common:MetricsConfigItem: + type: object + properties: + source_field: + type: string + target_field: + type: string + metrics: + type: array + items: + $ref: '#/components/schemas/transforms._common:MetricsConfigMetrics' + transforms._common:MetricsConfigMetrics: + type: object + properties: + avg: + type: object + sum: + type: object + max: + type: object + min: + type: object + value_count: + type: object + minProperties: 1 + maxProperties: 1 + transforms._common:Preview: + type: object + properties: + documents: + type: array + items: + type: object + transforms._common:Schedule: + type: object + properties: + interval: + $ref: '#/components/schemas/transforms._common:ScheduleInterval' + required: + - interval + transforms._common:ScheduleInterval: + type: object + properties: + start_time: + type: number + period: + type: number + unit: + type: string + transforms._common:TermsGroup: + type: object + properties: + source_field: + type: string + target_field: + type: string + transforms._common:Transform: + type: object + properties: + transform_id: + type: string + schema_version: + type: number + continuous: + type: boolean + schedule: + $ref: '#/components/schemas/transforms._common:Schedule' + metadata_id: + type: string + updated_at: + type: string + enabled: + type: boolean + enabled_at: + type: number + description: + type: string + source_index: + type: string + data_selection_query: + $ref: '#/components/schemas/_common.query_dsl:QueryContainer' + target_index: + type: string + roles: + type: array + items: + type: string + page_size: + type: number + groups: + type: array + items: + $ref: '#/components/schemas/transforms._common:GroupsConfigItem' + aggregations: + type: array + items: + $ref: '#/components/schemas/transforms._common:MetricsConfigItem' + transforms._common:TransformEntity: + type: object + properties: + _id: + type: string + _seqNo: + type: number + _primaryTerm: + type: number + transform: + $ref: '#/components/schemas/transforms._common:Transform' + transforms._common:TransformMetadata: + type: object + properties: + continuous_stats: + $ref: '#/components/schemas/transforms._common:ContinuousStats' + transform_id: + type: string + last_updated_at: + type: number + status: + type: string + failure_reason: + type: string + stats: + $ref: '#/components/schemas/transforms._common:ExplainStats' + transforms._common:TransformsResponse: + type: object + properties: + total_transforms: + type: number + transforms: + type: array + items: + $ref: '#/components/schemas/transforms._common:TransformEntity' diff --git a/src/OpenSearch.Client/_Generated/Descriptors.Cat.cs b/src/OpenSearch.Client/_Generated/Descriptors.Cat.cs index 855fc353c9..d3c7ef50e6 100644 --- a/src/OpenSearch.Client/_Generated/Descriptors.Cat.cs +++ b/src/OpenSearch.Client/_Generated/Descriptors.Cat.cs @@ -387,15 +387,8 @@ public partial class CatHelpDescriptor ICatHelpRequest { internal override ApiUrls ApiUrls => ApiUrlsLookups.CatHelp; - // values part of the url path // Request parameters - /// Return help information. - public CatHelpDescriptor Help(bool? help = true) => Qs("help", help); - - /// Comma-separated list of column names or column aliases to sort by. - public CatHelpDescriptor SortByColumns(params string[] sortbycolumns) => - Qs("s", sortbycolumns); } /// Descriptor for Indices https://opensearch.org/docs/latest/api-reference/cat/cat-indices/ @@ -1099,7 +1092,7 @@ public CatSnapshotsDescriptor(Names repository) // values part of the url path Names ICatSnapshotsRequest.RepositoryName => Self.RouteValues.Get("repository"); - /// A comma-separated list of snapshot repositories used to limit the request. Accepts wildcard expressions. `_all` returns all repositories. If any repository fails during the request, Opensearch returns an error. + /// A comma-separated list of snapshot repositories used to limit the request. Accepts wildcard expressions. `_all` returns all repositories. If any repository fails during the request, OpenSearch returns an error. public CatSnapshotsDescriptor RepositoryName(Names repository) => Assign(repository, (a, v) => a.RouteValues.Optional("repository", v)); diff --git a/src/OpenSearch.Client/_Generated/Descriptors.Cluster.cs b/src/OpenSearch.Client/_Generated/Descriptors.Cluster.cs index 30c6705853..426e0af0be 100644 --- a/src/OpenSearch.Client/_Generated/Descriptors.Cluster.cs +++ b/src/OpenSearch.Client/_Generated/Descriptors.Cluster.cs @@ -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, 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 `*`. public ClusterHealthDescriptor Index(Indices index) => Assign(index, (a, v) => a.RouteValues.Optional("index", v)); @@ -409,7 +409,7 @@ public PostVotingConfigExclusionsDescriptor NodeNames(params string[] nodenames) public PostVotingConfigExclusionsDescriptor Timeout(Time timeout) => Qs("timeout", timeout); } - /// Descriptor for PutComponentTemplate + /// Descriptor for PutComponentTemplate https://opensearch.org/docs/latest/im-plugin/index-templates/#use-component-templates-to-create-an-index-template public partial class PutComponentTemplateDescriptor : RequestDescriptorBase< PutComponentTemplateDescriptor, @@ -471,7 +471,7 @@ public partial class ClusterPutSettingsDescriptor public ClusterPutSettingsDescriptor ClusterManagerTimeout(Time clustermanagertimeout) => Qs("cluster_manager_timeout", clustermanagertimeout); - /// Return settings in flat format (default: false). + /// Return settings in flat format. public ClusterPutSettingsDescriptor FlatSettings(bool? flatsettings = true) => Qs("flat_settings", flatsettings); @@ -602,7 +602,7 @@ public ClusterStateDescriptor ClusterManagerTimeout(Time clustermanagertimeout) public ClusterStateDescriptor ExpandWildcards(ExpandWildcards? expandwildcards) => Qs("expand_wildcards", expandwildcards); - /// Return settings in flat format (default: false). + /// Return settings in flat format. public ClusterStateDescriptor FlatSettings(bool? flatsettings = true) => Qs("flat_settings", flatsettings); @@ -610,7 +610,7 @@ public ClusterStateDescriptor FlatSettings(bool? flatsettings = true) => public ClusterStateDescriptor IgnoreUnavailable(bool? ignoreunavailable = true) => Qs("ignore_unavailable", ignoreunavailable); - /// Return local information, do not retrieve the state from cluster-manager node (default: false). + /// 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. @@ -661,7 +661,7 @@ public ClusterStatsDescriptor NodeId(NodeIds nodeId) => public ClusterStatsDescriptor FlatSettings(bool? flatsettings = true) => Qs("flat_settings", flatsettings); - /// Period to wait for each node to respond. 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. + /// Period to wait for each node to respond. 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. public ClusterStatsDescriptor Timeout(Time timeout) => Qs("timeout", timeout); } } diff --git a/src/OpenSearch.Client/_Generated/Descriptors.Indices.cs b/src/OpenSearch.Client/_Generated/Descriptors.Indices.cs index df68ddd1d5..6e49115199 100644 --- a/src/OpenSearch.Client/_Generated/Descriptors.Indices.cs +++ b/src/OpenSearch.Client/_Generated/Descriptors.Indices.cs @@ -196,7 +196,7 @@ public GetComposableIndexTemplateDescriptor MasterTimeout(Time mastertimeout) => Qs("master_timeout", mastertimeout); } - /// Descriptor for PutComposableTemplate + /// Descriptor for PutComposableTemplate https://opensearch.org/docs/latest/im-plugin/index-templates/ public partial class PutComposableIndexTemplateDescriptor : RequestDescriptorBase< PutComposableIndexTemplateDescriptor, diff --git a/src/OpenSearch.Client/_Generated/Descriptors.Ingest.cs b/src/OpenSearch.Client/_Generated/Descriptors.Ingest.cs index 7fe0558ed6..9ade495896 100644 --- a/src/OpenSearch.Client/_Generated/Descriptors.Ingest.cs +++ b/src/OpenSearch.Client/_Generated/Descriptors.Ingest.cs @@ -217,7 +217,7 @@ public SimulatePipelineDescriptor(Id id) // values part of the url path Id ISimulatePipelineRequest.Id => Self.RouteValues.Get("id"); - /// Pipeline to test. If you don’t specify a `pipeline` in the request body, this parameter is required. + /// Pipeline to test. If you don't specify a `pipeline` in the request body, this parameter is required. public SimulatePipelineDescriptor Id(Id id) => Assign(id, (a, v) => a.RouteValues.Optional("id", v)); diff --git a/src/OpenSearch.Client/_Generated/Descriptors.Snapshot.cs b/src/OpenSearch.Client/_Generated/Descriptors.Snapshot.cs index fa0f00b86d..f5fd45f6b1 100644 --- a/src/OpenSearch.Client/_Generated/Descriptors.Snapshot.cs +++ b/src/OpenSearch.Client/_Generated/Descriptors.Snapshot.cs @@ -144,7 +144,7 @@ public CloneSnapshotDescriptor MasterTimeout(Time mastertimeout) => Qs("master_timeout", mastertimeout); } - /// Descriptor for Snapshot + /// Descriptor for Snapshot https://opensearch.org/docs/latest/api-reference/snapshots/create-snapshot/ public partial class SnapshotDescriptor : RequestDescriptorBase, ISnapshotRequest @@ -184,7 +184,7 @@ public SnapshotDescriptor WaitForCompletion(bool? waitforcompletion = true) => Qs("wait_for_completion", waitforcompletion); } - /// Descriptor for CreateRepository + /// Descriptor for CreateRepository https://opensearch.org/docs/latest/api-reference/snapshots/create-repository/ public partial class CreateRepositoryDescriptor : RequestDescriptorBase< CreateRepositoryDescriptor, @@ -352,7 +352,7 @@ public GetSnapshotDescriptor IgnoreUnavailable(bool? ignoreunavailable = true) = 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); } @@ -389,7 +389,7 @@ public GetRepositoryDescriptor RepositoryName(Names repository) => public GetRepositoryDescriptor ClusterManagerTimeout(Time clustermanagertimeout) => Qs("cluster_manager_timeout", clustermanagertimeout); - /// Return local information, do not retrieve the state from cluster-manager node (default: false). + /// 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. diff --git a/src/OpenSearch.Client/_Generated/OpenSearchClient.Cluster.cs b/src/OpenSearch.Client/_Generated/OpenSearchClient.Cluster.cs index e486d94e12..0201f5a5b2 100644 --- a/src/OpenSearch.Client/_Generated/OpenSearchClient.Cluster.cs +++ b/src/OpenSearch.Client/_Generated/OpenSearchClient.Cluster.cs @@ -416,7 +416,7 @@ Task PostVotingConfigExclusionsAsync( /// /// PUT request to the cluster.put_component_template API, read more about this API online: /// - /// + /// https://opensearch.org/docs/latest/im-plugin/index-templates/#use-component-templates-to-create-an-index-template /// PutComponentTemplateResponse PutComponentTemplate( Name name, @@ -426,7 +426,7 @@ Func selector /// /// PUT request to the cluster.put_component_template API, read more about this API online: /// - /// + /// https://opensearch.org/docs/latest/im-plugin/index-templates/#use-component-templates-to-create-an-index-template /// Task PutComponentTemplateAsync( Name name, @@ -437,14 +437,14 @@ Task PutComponentTemplateAsync( /// /// PUT request to the cluster.put_component_template API, read more about this API online: /// - /// + /// https://opensearch.org/docs/latest/im-plugin/index-templates/#use-component-templates-to-create-an-index-template /// PutComponentTemplateResponse PutComponentTemplate(IPutComponentTemplateRequest request); /// /// PUT request to the cluster.put_component_template API, read more about this API online: /// - /// + /// https://opensearch.org/docs/latest/im-plugin/index-templates/#use-component-templates-to-create-an-index-template /// Task PutComponentTemplateAsync( IPutComponentTemplateRequest request, @@ -1129,7 +1129,7 @@ public Task PostVotingConfigExclusionsAsync( /// /// PUT request to the cluster.put_component_template API, read more about this API online: /// - /// + /// https://opensearch.org/docs/latest/im-plugin/index-templates/#use-component-templates-to-create-an-index-template /// public PutComponentTemplateResponse PutComponentTemplate( Name name, @@ -1142,7 +1142,7 @@ Func selector /// /// PUT request to the cluster.put_component_template API, read more about this API online: /// - /// + /// https://opensearch.org/docs/latest/im-plugin/index-templates/#use-component-templates-to-create-an-index-template /// public Task PutComponentTemplateAsync( Name name, @@ -1157,7 +1157,7 @@ public Task PutComponentTemplateAsync( /// /// PUT request to the cluster.put_component_template API, read more about this API online: /// - /// + /// https://opensearch.org/docs/latest/im-plugin/index-templates/#use-component-templates-to-create-an-index-template /// public PutComponentTemplateResponse PutComponentTemplate( IPutComponentTemplateRequest request @@ -1170,7 +1170,7 @@ IPutComponentTemplateRequest request /// /// PUT request to the cluster.put_component_template API, read more about this API online: /// - /// + /// https://opensearch.org/docs/latest/im-plugin/index-templates/#use-component-templates-to-create-an-index-template /// public Task PutComponentTemplateAsync( IPutComponentTemplateRequest request, diff --git a/src/OpenSearch.Client/_Generated/OpenSearchClient.Indices.cs b/src/OpenSearch.Client/_Generated/OpenSearchClient.Indices.cs index c3364bb7fd..35b4191243 100644 --- a/src/OpenSearch.Client/_Generated/OpenSearchClient.Indices.cs +++ b/src/OpenSearch.Client/_Generated/OpenSearchClient.Indices.cs @@ -196,7 +196,7 @@ Task GetComposableTemplateAsync( /// /// PUT request to the indices.put_index_template API, read more about this API online: /// - /// + /// https://opensearch.org/docs/latest/im-plugin/index-templates/ /// PutComposableIndexTemplateResponse PutComposableTemplate( Name name, @@ -206,7 +206,7 @@ Func s /// /// PUT request to the indices.put_index_template API, read more about this API online: /// - /// + /// https://opensearch.org/docs/latest/im-plugin/index-templates/ /// Task PutComposableTemplateAsync( Name name, @@ -217,7 +217,7 @@ Task PutComposableTemplateAsync( /// /// PUT request to the indices.put_index_template API, read more about this API online: /// - /// + /// https://opensearch.org/docs/latest/im-plugin/index-templates/ /// PutComposableIndexTemplateResponse PutComposableTemplate( IPutComposableIndexTemplateRequest request @@ -226,7 +226,7 @@ IPutComposableIndexTemplateRequest request /// /// PUT request to the indices.put_index_template API, read more about this API online: /// - /// + /// https://opensearch.org/docs/latest/im-plugin/index-templates/ /// Task PutComposableTemplateAsync( IPutComposableIndexTemplateRequest request, @@ -437,7 +437,7 @@ public Task GetComposableTemplateAsync( /// /// PUT request to the indices.put_index_template API, read more about this API online: /// - /// + /// https://opensearch.org/docs/latest/im-plugin/index-templates/ /// public PutComposableIndexTemplateResponse PutComposableTemplate( Name name, @@ -450,7 +450,7 @@ Func s /// /// PUT request to the indices.put_index_template API, read more about this API online: /// - /// + /// https://opensearch.org/docs/latest/im-plugin/index-templates/ /// public Task PutComposableTemplateAsync( Name name, @@ -465,7 +465,7 @@ public Task PutComposableTemplateAsync( /// /// PUT request to the indices.put_index_template API, read more about this API online: /// - /// + /// https://opensearch.org/docs/latest/im-plugin/index-templates/ /// public PutComposableIndexTemplateResponse PutComposableTemplate( IPutComposableIndexTemplateRequest request @@ -478,7 +478,7 @@ IPutComposableIndexTemplateRequest request /// /// PUT request to the indices.put_index_template API, read more about this API online: /// - /// + /// https://opensearch.org/docs/latest/im-plugin/index-templates/ /// public Task PutComposableTemplateAsync( IPutComposableIndexTemplateRequest request, diff --git a/src/OpenSearch.Client/_Generated/OpenSearchClient.Snapshot.cs b/src/OpenSearch.Client/_Generated/OpenSearchClient.Snapshot.cs index ba7a72b432..0313143f72 100644 --- a/src/OpenSearch.Client/_Generated/OpenSearchClient.Snapshot.cs +++ b/src/OpenSearch.Client/_Generated/OpenSearchClient.Snapshot.cs @@ -140,7 +140,7 @@ Task CloneAsync( /// /// PUT request to the snapshot.create API, read more about this API online: /// - /// + /// https://opensearch.org/docs/latest/api-reference/snapshots/create-snapshot/ /// SnapshotResponse Snapshot( Name repository, @@ -151,7 +151,7 @@ SnapshotResponse Snapshot( /// /// PUT request to the snapshot.create API, read more about this API online: /// - /// + /// https://opensearch.org/docs/latest/api-reference/snapshots/create-snapshot/ /// Task SnapshotAsync( Name repository, @@ -163,14 +163,14 @@ Task SnapshotAsync( /// /// PUT request to the snapshot.create API, read more about this API online: /// - /// + /// https://opensearch.org/docs/latest/api-reference/snapshots/create-snapshot/ /// SnapshotResponse Snapshot(ISnapshotRequest request); /// /// PUT request to the snapshot.create API, read more about this API online: /// - /// + /// https://opensearch.org/docs/latest/api-reference/snapshots/create-snapshot/ /// Task SnapshotAsync( ISnapshotRequest request, @@ -180,7 +180,7 @@ Task SnapshotAsync( /// /// PUT request to the snapshot.create_repository API, read more about this API online: /// - /// + /// https://opensearch.org/docs/latest/api-reference/snapshots/create-repository/ /// CreateRepositoryResponse CreateRepository( Name repository, @@ -190,7 +190,7 @@ Func selector /// /// PUT request to the snapshot.create_repository API, read more about this API online: /// - /// + /// https://opensearch.org/docs/latest/api-reference/snapshots/create-repository/ /// Task CreateRepositoryAsync( Name repository, @@ -201,14 +201,14 @@ Task CreateRepositoryAsync( /// /// PUT request to the snapshot.create_repository API, read more about this API online: /// - /// + /// https://opensearch.org/docs/latest/api-reference/snapshots/create-repository/ /// CreateRepositoryResponse CreateRepository(ICreateRepositoryRequest request); /// /// PUT request to the snapshot.create_repository API, read more about this API online: /// - /// + /// https://opensearch.org/docs/latest/api-reference/snapshots/create-repository/ /// Task CreateRepositoryAsync( ICreateRepositoryRequest request, @@ -619,7 +619,7 @@ public Task CloneAsync( /// /// PUT request to the snapshot.create API, read more about this API online: /// - /// + /// https://opensearch.org/docs/latest/api-reference/snapshots/create-snapshot/ /// public SnapshotResponse Snapshot( Name repository, @@ -635,7 +635,7 @@ public SnapshotResponse Snapshot( /// /// PUT request to the snapshot.create API, read more about this API online: /// - /// + /// https://opensearch.org/docs/latest/api-reference/snapshots/create-snapshot/ /// public Task SnapshotAsync( Name repository, @@ -653,7 +653,7 @@ public Task SnapshotAsync( /// /// PUT request to the snapshot.create API, read more about this API online: /// - /// + /// https://opensearch.org/docs/latest/api-reference/snapshots/create-snapshot/ /// public SnapshotResponse Snapshot(ISnapshotRequest request) => DoRequest(request, request.RequestParameters); @@ -661,7 +661,7 @@ public SnapshotResponse Snapshot(ISnapshotRequest request) => /// /// PUT request to the snapshot.create API, read more about this API online: /// - /// + /// https://opensearch.org/docs/latest/api-reference/snapshots/create-snapshot/ /// public Task SnapshotAsync( ISnapshotRequest request, @@ -676,7 +676,7 @@ public Task SnapshotAsync( /// /// PUT request to the snapshot.create_repository API, read more about this API online: /// - /// + /// https://opensearch.org/docs/latest/api-reference/snapshots/create-repository/ /// public CreateRepositoryResponse CreateRepository( Name repository, @@ -689,7 +689,7 @@ Func selector /// /// PUT request to the snapshot.create_repository API, read more about this API online: /// - /// + /// https://opensearch.org/docs/latest/api-reference/snapshots/create-repository/ /// public Task CreateRepositoryAsync( Name repository, @@ -704,7 +704,7 @@ public Task CreateRepositoryAsync( /// /// PUT request to the snapshot.create_repository API, read more about this API online: /// - /// + /// https://opensearch.org/docs/latest/api-reference/snapshots/create-repository/ /// public CreateRepositoryResponse CreateRepository(ICreateRepositoryRequest request) => DoRequest( @@ -715,7 +715,7 @@ public CreateRepositoryResponse CreateRepository(ICreateRepositoryRequest reques /// /// PUT request to the snapshot.create_repository API, read more about this API online: /// - /// + /// https://opensearch.org/docs/latest/api-reference/snapshots/create-repository/ /// public Task CreateRepositoryAsync( ICreateRepositoryRequest request, diff --git a/src/OpenSearch.Client/_Generated/Requests.Cat.cs b/src/OpenSearch.Client/_Generated/Requests.Cat.cs index 5e8c854fda..600fcd4bce 100644 --- a/src/OpenSearch.Client/_Generated/Requests.Cat.cs +++ b/src/OpenSearch.Client/_Generated/Requests.Cat.cs @@ -600,23 +600,9 @@ public partial class CatHelpRequest { protected ICatHelpRequest Self => this; internal override ApiUrls ApiUrls => ApiUrlsLookups.CatHelp; - // values part of the url path // Request parameters - /// Return help information. - public bool? Help - { - get => Q("help"); - set => Q("help", value); - } - - /// Comma-separated list of column names or column aliases to sort by. - public string[] SortByColumns - { - get => Q("s"); - set => Q("s", value); - } } [InterfaceDataContract] diff --git a/src/OpenSearch.Client/_Generated/Requests.Cluster.cs b/src/OpenSearch.Client/_Generated/Requests.Cluster.cs index 4c32c79440..2132bd4bfa 100644 --- a/src/OpenSearch.Client/_Generated/Requests.Cluster.cs +++ b/src/OpenSearch.Client/_Generated/Requests.Cluster.cs @@ -596,7 +596,7 @@ public partial interface IPutComponentTemplateRequest Name Name { get; } } - /// Request for PutComponentTemplate + /// Request for PutComponentTemplate https://opensearch.org/docs/latest/im-plugin/index-templates/#use-component-templates-to-create-an-index-template public partial class PutComponentTemplateRequest : PlainRequestBase, IPutComponentTemplateRequest @@ -678,7 +678,7 @@ public Time ClusterManagerTimeout set => Q("cluster_manager_timeout", value); } - /// Return settings in flat format (default: false). + /// Return settings in flat format. public bool? FlatSettings { get => Q("flat_settings"); @@ -855,7 +855,7 @@ public ExpandWildcards? ExpandWildcards set => Q("expand_wildcards", value); } - /// Return settings in flat format (default: false). + /// Return settings in flat format. public bool? FlatSettings { get => Q("flat_settings"); @@ -869,7 +869,7 @@ public bool? IgnoreUnavailable set => Q("ignore_unavailable", value); } - /// Return local information, do not retrieve the state from cluster-manager node (default: false). + /// Return local information, do not retrieve the state from cluster-manager node. public bool? Local { get => Q("local"); @@ -939,7 +939,7 @@ public bool? FlatSettings /// /// Period to wait for each node to respond. 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. + /// However, timed out nodes are included in the response's `_nodes.failed` property. Defaults to no timeout. /// public Time Timeout { diff --git a/src/OpenSearch.Client/_Generated/Requests.Indices.cs b/src/OpenSearch.Client/_Generated/Requests.Indices.cs index 1bc8df509b..8b3c196a4b 100644 --- a/src/OpenSearch.Client/_Generated/Requests.Indices.cs +++ b/src/OpenSearch.Client/_Generated/Requests.Indices.cs @@ -262,7 +262,7 @@ public partial interface IPutComposableIndexTemplateRequest Name Name { get; } } - /// Request for PutComposableTemplate + /// Request for PutComposableTemplate https://opensearch.org/docs/latest/im-plugin/index-templates/ public partial class PutComposableIndexTemplateRequest : PlainRequestBase, IPutComposableIndexTemplateRequest diff --git a/src/OpenSearch.Client/_Generated/Requests.Snapshot.cs b/src/OpenSearch.Client/_Generated/Requests.Snapshot.cs index 13596e7623..90e5f164ff 100644 --- a/src/OpenSearch.Client/_Generated/Requests.Snapshot.cs +++ b/src/OpenSearch.Client/_Generated/Requests.Snapshot.cs @@ -192,7 +192,7 @@ public partial interface ISnapshotRequest : IRequest Name Snapshot { get; } } - /// Request for Snapshot + /// Request for Snapshot https://opensearch.org/docs/latest/api-reference/snapshots/create-snapshot/ public partial class SnapshotRequest : PlainRequestBase, ISnapshotRequest @@ -258,7 +258,7 @@ public partial interface ICreateRepositoryRequest : IRequestRequest for CreateRepository + /// Request for CreateRepository https://opensearch.org/docs/latest/api-reference/snapshots/create-repository/ public partial class CreateRepositoryRequest : PlainRequestBase, ICreateRepositoryRequest @@ -492,7 +492,7 @@ public Time MasterTimeout } /// - /// If true, returns additional information about each snapshot such as the version of Opensearch which took the snapshot, the start and end + /// 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 bool? Verbose @@ -539,7 +539,7 @@ public Time ClusterManagerTimeout set => Q("cluster_manager_timeout", value); } - /// Return local information, do not retrieve the state from cluster-manager node (default: false). + /// Return local information, do not retrieve the state from cluster-manager node. public bool? Local { get => Q("local"); diff --git a/src/OpenSearch.Net/_Generated/Api/Enums.cs b/src/OpenSearch.Net/_Generated/Api/Enums.cs index 36f9f1240c..4ee4fea5e3 100644 --- a/src/OpenSearch.Net/_Generated/Api/Enums.cs +++ b/src/OpenSearch.Net/_Generated/Api/Enums.cs @@ -58,6 +58,12 @@ public enum Bytes [EnumMember(Value = "b")] B, + [EnumMember(Value = "g")] + G, + + [EnumMember(Value = "gb")] + Gb, + [EnumMember(Value = "k")] K, @@ -70,28 +76,25 @@ public enum Bytes [EnumMember(Value = "mb")] Mb, - [EnumMember(Value = "g")] - G, + [EnumMember(Value = "p")] + P, - [EnumMember(Value = "gb")] - Gb, + [EnumMember(Value = "pb")] + Pb, [EnumMember(Value = "t")] T, [EnumMember(Value = "tb")] - Tb, - - [EnumMember(Value = "p")] - P, - - [EnumMember(Value = "pb")] - Pb + Tb } [StringEnum] public enum ClusterHealthLevel { + [EnumMember(Value = "awareness_attributes")] + AwarenessAttributes, + [EnumMember(Value = "cluster")] Cluster, @@ -99,10 +102,7 @@ public enum ClusterHealthLevel Indices, [EnumMember(Value = "shards")] - Shards, - - [EnumMember(Value = "awareness_attributes")] - AwarenessAttributes + Shards } [Flags, StringEnum] @@ -111,23 +111,23 @@ public enum ClusterStateMetric [EnumMember(Value = "blocks")] Blocks = 1 << 0, + [EnumMember(Value = "cluster_manager_node")] + ClusterManagerNode = 1 << 1, + + [EnumMember(Value = "master_node")] + MasterNode = 1 << 2, + [EnumMember(Value = "metadata")] - Metadata = 1 << 1, + Metadata = 1 << 3, [EnumMember(Value = "nodes")] - Nodes = 1 << 2, - - [EnumMember(Value = "routing_table")] - RoutingTable = 1 << 3, + Nodes = 1 << 4, [EnumMember(Value = "routing_nodes")] - RoutingNodes = 1 << 4, + RoutingNodes = 1 << 5, - [EnumMember(Value = "master_node")] - MasterNode = 1 << 5, - - [EnumMember(Value = "cluster_manager_node")] - ClusterManagerNode = 1 << 6, + [EnumMember(Value = "routing_table")] + RoutingTable = 1 << 6, [EnumMember(Value = "version")] Version = 1 << 7, @@ -142,17 +142,17 @@ public enum ExpandWildcards [EnumMember(Value = "all")] All = 1 << 0, - [EnumMember(Value = "open")] - Open = 1 << 1, - [EnumMember(Value = "closed")] - Closed = 1 << 2, + Closed = 1 << 1, [EnumMember(Value = "hidden")] - Hidden = 1 << 3, + Hidden = 1 << 2, [EnumMember(Value = "none")] - None = 1 << 4 + None = 1 << 3, + + [EnumMember(Value = "open")] + Open = 1 << 4 } [StringEnum] @@ -161,11 +161,11 @@ public enum HealthStatus [EnumMember(Value = "green")] Green, - [EnumMember(Value = "yellow")] - Yellow, - [EnumMember(Value = "red")] - Red + Red, + + [EnumMember(Value = "yellow")] + Yellow } [StringEnum] @@ -184,41 +184,41 @@ public enum Level [Flags, StringEnum] public enum NodesInfoMetric { - [EnumMember(Value = "settings")] - Settings = 1 << 0, - - [EnumMember(Value = "os")] - Os = 1 << 1, + [EnumMember(Value = "aggregations")] + Aggregations = 1 << 0, - [EnumMember(Value = "process")] - Process = 1 << 2, + [EnumMember(Value = "http")] + Http = 1 << 1, - [EnumMember(Value = "jvm")] - Jvm = 1 << 3, + [EnumMember(Value = "indices")] + Indices = 1 << 2, - [EnumMember(Value = "thread_pool")] - ThreadPool = 1 << 4, + [EnumMember(Value = "ingest")] + Ingest = 1 << 3, - [EnumMember(Value = "transport")] - Transport = 1 << 5, + [EnumMember(Value = "jvm")] + Jvm = 1 << 4, - [EnumMember(Value = "http")] - Http = 1 << 6, + [EnumMember(Value = "os")] + Os = 1 << 5, [EnumMember(Value = "plugins")] - Plugins = 1 << 7, + Plugins = 1 << 6, - [EnumMember(Value = "ingest")] - Ingest = 1 << 8, + [EnumMember(Value = "process")] + Process = 1 << 7, - [EnumMember(Value = "aggregations")] - Aggregations = 1 << 9, + [EnumMember(Value = "search_pipelines")] + SearchPipelines = 1 << 8, - [EnumMember(Value = "indices")] - Indices = 1 << 10, + [EnumMember(Value = "settings")] + Settings = 1 << 9, - [EnumMember(Value = "search_pipelines")] - SearchPipelines = 1 << 11, + [EnumMember(Value = "thread_pool")] + ThreadPool = 1 << 10, + + [EnumMember(Value = "transport")] + Transport = 1 << 11, [EnumMember(Value = "_all")] All = 1 << 12 @@ -227,69 +227,69 @@ public enum NodesInfoMetric [StringEnum] public enum NodesSampleType { + [EnumMember(Value = "block")] + Block, + [EnumMember(Value = "cpu")] Cpu, [EnumMember(Value = "wait")] - Wait, - - [EnumMember(Value = "block")] - Block + Wait } [Flags, StringEnum] public enum NodesStatsIndexMetric { - [EnumMember(Value = "store")] - Store = 1 << 0, + [EnumMember(Value = "completion")] + Completion = 1 << 0, - [EnumMember(Value = "indexing")] - Indexing = 1 << 1, + [EnumMember(Value = "docs")] + Docs = 1 << 1, - [EnumMember(Value = "get")] - Get = 1 << 2, + [EnumMember(Value = "fielddata")] + Fielddata = 1 << 2, - [EnumMember(Value = "search")] - Search = 1 << 3, + [EnumMember(Value = "flush")] + Flush = 1 << 3, - [EnumMember(Value = "merge")] - Merge = 1 << 4, + [EnumMember(Value = "get")] + Get = 1 << 4, - [EnumMember(Value = "flush")] - Flush = 1 << 5, + [EnumMember(Value = "indexing")] + Indexing = 1 << 5, - [EnumMember(Value = "refresh")] - Refresh = 1 << 6, + [EnumMember(Value = "merge")] + Merge = 1 << 6, [EnumMember(Value = "query_cache")] QueryCache = 1 << 7, - [EnumMember(Value = "fielddata")] - Fielddata = 1 << 8, + [EnumMember(Value = "recovery")] + Recovery = 1 << 8, - [EnumMember(Value = "docs")] - Docs = 1 << 9, + [EnumMember(Value = "refresh")] + Refresh = 1 << 9, - [EnumMember(Value = "warmer")] - Warmer = 1 << 10, + [EnumMember(Value = "request_cache")] + RequestCache = 1 << 10, - [EnumMember(Value = "completion")] - Completion = 1 << 11, + [EnumMember(Value = "search")] + Search = 1 << 11, [EnumMember(Value = "segments")] Segments = 1 << 12, - [EnumMember(Value = "translog")] - Translog = 1 << 13, + [EnumMember(Value = "store")] + Store = 1 << 13, [EnumMember(Value = "suggest")] Suggest = 1 << 14, - [EnumMember(Value = "request_cache")] - RequestCache = 1 << 15, + [EnumMember(Value = "translog")] + Translog = 1 << 15, - [EnumMember(Value = "recovery")] - Recovery = 1 << 16, + [EnumMember(Value = "warmer")] + Warmer = 1 << 16, [EnumMember(Value = "_all")] All = 1 << 17 @@ -298,44 +298,89 @@ public enum NodesStatsIndexMetric [Flags, StringEnum] public enum NodesStatsMetric { + [EnumMember(Value = "adaptive_selection")] + AdaptiveSelection = 1 << 0, + + [EnumMember(Value = "admission_control")] + AdmissionControl = 1 << 1, + [EnumMember(Value = "breaker")] - Breaker = 1 << 0, + Breaker = 1 << 2, + + [EnumMember(Value = "caches")] + Caches = 1 << 3, + + [EnumMember(Value = "cluster_manager_throttling")] + ClusterManagerThrottling = 1 << 4, + + [EnumMember(Value = "discovery")] + Discovery = 1 << 5, + + [EnumMember(Value = "file_cache")] + FileCache = 1 << 6, [EnumMember(Value = "fs")] - Fs = 1 << 1, + Fs = 1 << 7, [EnumMember(Value = "http")] - Http = 1 << 2, + Http = 1 << 8, + + [EnumMember(Value = "indexing_pressure")] + IndexingPressure = 1 << 9, [EnumMember(Value = "indices")] - Indices = 1 << 3, + Indices = 1 << 10, + + [EnumMember(Value = "ingest")] + Ingest = 1 << 11, [EnumMember(Value = "jvm")] - Jvm = 1 << 4, + Jvm = 1 << 12, [EnumMember(Value = "os")] - Os = 1 << 5, + Os = 1 << 13, [EnumMember(Value = "process")] - Process = 1 << 6, + Process = 1 << 14, - [EnumMember(Value = "thread_pool")] - ThreadPool = 1 << 7, + [EnumMember(Value = "repositories")] + Repositories = 1 << 15, - [EnumMember(Value = "transport")] - Transport = 1 << 8, + [EnumMember(Value = "resource_usage_stats")] + ResourceUsageStats = 1 << 16, - [EnumMember(Value = "discovery")] - Discovery = 1 << 9, + [EnumMember(Value = "script")] + Script = 1 << 17, - [EnumMember(Value = "indexing_pressure")] - IndexingPressure = 1 << 10, + [EnumMember(Value = "script_cache")] + ScriptCache = 1 << 18, + + [EnumMember(Value = "search_backpressure")] + SearchBackpressure = 1 << 19, [EnumMember(Value = "search_pipeline")] - SearchPipeline = 1 << 11, + SearchPipeline = 1 << 20, + + [EnumMember(Value = "segment_replication_backpressure")] + SegmentReplicationBackpressure = 1 << 21, + + [EnumMember(Value = "shard_indexing_pressure")] + ShardIndexingPressure = 1 << 22, + + [EnumMember(Value = "task_cancellation")] + TaskCancellation = 1 << 23, + + [EnumMember(Value = "thread_pool")] + ThreadPool = 1 << 24, + + [EnumMember(Value = "transport")] + Transport = 1 << 25, + + [EnumMember(Value = "weighted_routing")] + WeightedRouting = 1 << 26, [EnumMember(Value = "_all")] - All = 1 << 12 + All = 1 << 27 } [Flags, StringEnum] @@ -354,18 +399,24 @@ public enum TasksGroupBy [EnumMember(Value = "nodes")] Nodes, - [EnumMember(Value = "parents")] - Parents, - [EnumMember(Value = "none")] - None + None, + + [EnumMember(Value = "parents")] + Parents } [StringEnum] public enum TimeUnit { - [EnumMember(Value = "nanos")] - Nanos, + [EnumMember(Value = "d")] + D, + + [EnumMember(Value = "h")] + H, + + [EnumMember(Value = "m")] + M, [EnumMember(Value = "micros")] Micros, @@ -373,17 +424,11 @@ public enum TimeUnit [EnumMember(Value = "ms")] Ms, - [EnumMember(Value = "s")] - S, - - [EnumMember(Value = "m")] - M, - - [EnumMember(Value = "h")] - H, + [EnumMember(Value = "nanos")] + Nanos, - [EnumMember(Value = "d")] - D + [EnumMember(Value = "s")] + S } [StringEnum] @@ -399,23 +444,23 @@ public enum WaitForActiveShardOptions [StringEnum] public enum WaitForEvents { + [EnumMember(Value = "high")] + High, + [EnumMember(Value = "immediate")] Immediate, - [EnumMember(Value = "urgent")] - Urgent, + [EnumMember(Value = "languid")] + Languid, - [EnumMember(Value = "high")] - High, + [EnumMember(Value = "low")] + Low, [EnumMember(Value = "normal")] Normal, - [EnumMember(Value = "low")] - Low, - - [EnumMember(Value = "languid")] - Languid + [EnumMember(Value = "urgent")] + Urgent } public static partial class KnownEnums @@ -443,16 +488,16 @@ public static string GetStringValue(this Bytes enumValue) => enumValue switch { Bytes.B => "b", + Bytes.G => "g", + Bytes.Gb => "gb", Bytes.K => "k", Bytes.Kb => "kb", Bytes.M => "m", Bytes.Mb => "mb", - Bytes.G => "g", - Bytes.Gb => "gb", - Bytes.T => "t", - Bytes.Tb => "tb", Bytes.P => "p", Bytes.Pb => "pb", + Bytes.T => "t", + Bytes.Tb => "tb", _ => throw new ArgumentException( $"'{enumValue.ToString()}' is not a valid value for enum 'Bytes'" @@ -462,10 +507,10 @@ public static string GetStringValue(this Bytes enumValue) => public static string GetStringValue(this ClusterHealthLevel enumValue) => enumValue switch { + ClusterHealthLevel.AwarenessAttributes => "awareness_attributes", ClusterHealthLevel.Cluster => "cluster", ClusterHealthLevel.Indices => "indices", ClusterHealthLevel.Shards => "shards", - ClusterHealthLevel.AwarenessAttributes => "awareness_attributes", _ => throw new ArgumentException( $"'{enumValue.ToString()}' is not a valid value for enum 'ClusterHealthLevel'" @@ -479,18 +524,18 @@ public static string GetStringValue(this ClusterStateMetric enumValue) var list = new List(); if ((enumValue & ClusterStateMetric.Blocks) != 0) list.Add("blocks"); + if ((enumValue & ClusterStateMetric.ClusterManagerNode) != 0) + list.Add("cluster_manager_node"); + if ((enumValue & ClusterStateMetric.MasterNode) != 0) + list.Add("master_node"); if ((enumValue & ClusterStateMetric.Metadata) != 0) list.Add("metadata"); if ((enumValue & ClusterStateMetric.Nodes) != 0) list.Add("nodes"); - if ((enumValue & ClusterStateMetric.RoutingTable) != 0) - list.Add("routing_table"); if ((enumValue & ClusterStateMetric.RoutingNodes) != 0) list.Add("routing_nodes"); - if ((enumValue & ClusterStateMetric.MasterNode) != 0) - list.Add("master_node"); - if ((enumValue & ClusterStateMetric.ClusterManagerNode) != 0) - list.Add("cluster_manager_node"); + if ((enumValue & ClusterStateMetric.RoutingTable) != 0) + list.Add("routing_table"); if ((enumValue & ClusterStateMetric.Version) != 0) list.Add("version"); return string.Join(",", list); @@ -501,14 +546,14 @@ public static string GetStringValue(this ExpandWildcards enumValue) var list = new List(); if ((enumValue & ExpandWildcards.All) != 0) list.Add("all"); - if ((enumValue & ExpandWildcards.Open) != 0) - list.Add("open"); if ((enumValue & ExpandWildcards.Closed) != 0) list.Add("closed"); if ((enumValue & ExpandWildcards.Hidden) != 0) list.Add("hidden"); if ((enumValue & ExpandWildcards.None) != 0) list.Add("none"); + if ((enumValue & ExpandWildcards.Open) != 0) + list.Add("open"); return string.Join(",", list); } @@ -516,8 +561,8 @@ public static string GetStringValue(this HealthStatus enumValue) => enumValue switch { HealthStatus.Green => "green", - HealthStatus.Yellow => "yellow", HealthStatus.Red => "red", + HealthStatus.Yellow => "yellow", _ => throw new ArgumentException( $"'{enumValue.ToString()}' is not a valid value for enum 'HealthStatus'" @@ -541,39 +586,39 @@ public static string GetStringValue(this NodesInfoMetric enumValue) if ((enumValue & NodesInfoMetric.All) != 0) return "_all"; var list = new List(); - if ((enumValue & NodesInfoMetric.Settings) != 0) - list.Add("settings"); + if ((enumValue & NodesInfoMetric.Aggregations) != 0) + list.Add("aggregations"); + if ((enumValue & NodesInfoMetric.Http) != 0) + list.Add("http"); + if ((enumValue & NodesInfoMetric.Indices) != 0) + list.Add("indices"); + if ((enumValue & NodesInfoMetric.Ingest) != 0) + list.Add("ingest"); + if ((enumValue & NodesInfoMetric.Jvm) != 0) + list.Add("jvm"); if ((enumValue & NodesInfoMetric.Os) != 0) list.Add("os"); + if ((enumValue & NodesInfoMetric.Plugins) != 0) + list.Add("plugins"); if ((enumValue & NodesInfoMetric.Process) != 0) list.Add("process"); - if ((enumValue & NodesInfoMetric.Jvm) != 0) - list.Add("jvm"); + if ((enumValue & NodesInfoMetric.SearchPipelines) != 0) + list.Add("search_pipelines"); + if ((enumValue & NodesInfoMetric.Settings) != 0) + list.Add("settings"); if ((enumValue & NodesInfoMetric.ThreadPool) != 0) list.Add("thread_pool"); if ((enumValue & NodesInfoMetric.Transport) != 0) list.Add("transport"); - if ((enumValue & NodesInfoMetric.Http) != 0) - list.Add("http"); - if ((enumValue & NodesInfoMetric.Plugins) != 0) - list.Add("plugins"); - if ((enumValue & NodesInfoMetric.Ingest) != 0) - list.Add("ingest"); - if ((enumValue & NodesInfoMetric.Aggregations) != 0) - list.Add("aggregations"); - if ((enumValue & NodesInfoMetric.Indices) != 0) - list.Add("indices"); - if ((enumValue & NodesInfoMetric.SearchPipelines) != 0) - list.Add("search_pipelines"); return string.Join(",", list); } public static string GetStringValue(this NodesSampleType enumValue) => enumValue switch { + NodesSampleType.Block => "block", NodesSampleType.Cpu => "cpu", NodesSampleType.Wait => "wait", - NodesSampleType.Block => "block", _ => throw new ArgumentException( $"'{enumValue.ToString()}' is not a valid value for enum 'NodesSampleType'" @@ -585,40 +630,40 @@ public static string GetStringValue(this NodesStatsIndexMetric enumValue) if ((enumValue & NodesStatsIndexMetric.All) != 0) return "_all"; var list = new List(); - if ((enumValue & NodesStatsIndexMetric.Store) != 0) - list.Add("store"); - if ((enumValue & NodesStatsIndexMetric.Indexing) != 0) - list.Add("indexing"); + if ((enumValue & NodesStatsIndexMetric.Completion) != 0) + list.Add("completion"); + if ((enumValue & NodesStatsIndexMetric.Docs) != 0) + list.Add("docs"); + if ((enumValue & NodesStatsIndexMetric.Fielddata) != 0) + list.Add("fielddata"); + if ((enumValue & NodesStatsIndexMetric.Flush) != 0) + list.Add("flush"); if ((enumValue & NodesStatsIndexMetric.Get) != 0) list.Add("get"); - if ((enumValue & NodesStatsIndexMetric.Search) != 0) - list.Add("search"); + if ((enumValue & NodesStatsIndexMetric.Indexing) != 0) + list.Add("indexing"); if ((enumValue & NodesStatsIndexMetric.Merge) != 0) list.Add("merge"); - if ((enumValue & NodesStatsIndexMetric.Flush) != 0) - list.Add("flush"); - if ((enumValue & NodesStatsIndexMetric.Refresh) != 0) - list.Add("refresh"); if ((enumValue & NodesStatsIndexMetric.QueryCache) != 0) list.Add("query_cache"); - if ((enumValue & NodesStatsIndexMetric.Fielddata) != 0) - list.Add("fielddata"); - if ((enumValue & NodesStatsIndexMetric.Docs) != 0) - list.Add("docs"); - if ((enumValue & NodesStatsIndexMetric.Warmer) != 0) - list.Add("warmer"); - if ((enumValue & NodesStatsIndexMetric.Completion) != 0) - list.Add("completion"); + if ((enumValue & NodesStatsIndexMetric.Recovery) != 0) + list.Add("recovery"); + if ((enumValue & NodesStatsIndexMetric.Refresh) != 0) + list.Add("refresh"); + if ((enumValue & NodesStatsIndexMetric.RequestCache) != 0) + list.Add("request_cache"); + if ((enumValue & NodesStatsIndexMetric.Search) != 0) + list.Add("search"); if ((enumValue & NodesStatsIndexMetric.Segments) != 0) list.Add("segments"); - if ((enumValue & NodesStatsIndexMetric.Translog) != 0) - list.Add("translog"); + if ((enumValue & NodesStatsIndexMetric.Store) != 0) + list.Add("store"); if ((enumValue & NodesStatsIndexMetric.Suggest) != 0) list.Add("suggest"); - if ((enumValue & NodesStatsIndexMetric.RequestCache) != 0) - list.Add("request_cache"); - if ((enumValue & NodesStatsIndexMetric.Recovery) != 0) - list.Add("recovery"); + if ((enumValue & NodesStatsIndexMetric.Translog) != 0) + list.Add("translog"); + if ((enumValue & NodesStatsIndexMetric.Warmer) != 0) + list.Add("warmer"); return string.Join(",", list); } @@ -627,30 +672,60 @@ public static string GetStringValue(this NodesStatsMetric enumValue) if ((enumValue & NodesStatsMetric.All) != 0) return "_all"; var list = new List(); + if ((enumValue & NodesStatsMetric.AdaptiveSelection) != 0) + list.Add("adaptive_selection"); + if ((enumValue & NodesStatsMetric.AdmissionControl) != 0) + list.Add("admission_control"); if ((enumValue & NodesStatsMetric.Breaker) != 0) list.Add("breaker"); + if ((enumValue & NodesStatsMetric.Caches) != 0) + list.Add("caches"); + if ((enumValue & NodesStatsMetric.ClusterManagerThrottling) != 0) + list.Add("cluster_manager_throttling"); + if ((enumValue & NodesStatsMetric.Discovery) != 0) + list.Add("discovery"); + if ((enumValue & NodesStatsMetric.FileCache) != 0) + list.Add("file_cache"); if ((enumValue & NodesStatsMetric.Fs) != 0) list.Add("fs"); if ((enumValue & NodesStatsMetric.Http) != 0) list.Add("http"); + if ((enumValue & NodesStatsMetric.IndexingPressure) != 0) + list.Add("indexing_pressure"); if ((enumValue & NodesStatsMetric.Indices) != 0) list.Add("indices"); + if ((enumValue & NodesStatsMetric.Ingest) != 0) + list.Add("ingest"); if ((enumValue & NodesStatsMetric.Jvm) != 0) list.Add("jvm"); if ((enumValue & NodesStatsMetric.Os) != 0) list.Add("os"); if ((enumValue & NodesStatsMetric.Process) != 0) list.Add("process"); + if ((enumValue & NodesStatsMetric.Repositories) != 0) + list.Add("repositories"); + if ((enumValue & NodesStatsMetric.ResourceUsageStats) != 0) + list.Add("resource_usage_stats"); + if ((enumValue & NodesStatsMetric.Script) != 0) + list.Add("script"); + if ((enumValue & NodesStatsMetric.ScriptCache) != 0) + list.Add("script_cache"); + if ((enumValue & NodesStatsMetric.SearchBackpressure) != 0) + list.Add("search_backpressure"); + if ((enumValue & NodesStatsMetric.SearchPipeline) != 0) + list.Add("search_pipeline"); + if ((enumValue & NodesStatsMetric.SegmentReplicationBackpressure) != 0) + list.Add("segment_replication_backpressure"); + if ((enumValue & NodesStatsMetric.ShardIndexingPressure) != 0) + list.Add("shard_indexing_pressure"); + if ((enumValue & NodesStatsMetric.TaskCancellation) != 0) + list.Add("task_cancellation"); if ((enumValue & NodesStatsMetric.ThreadPool) != 0) list.Add("thread_pool"); if ((enumValue & NodesStatsMetric.Transport) != 0) list.Add("transport"); - if ((enumValue & NodesStatsMetric.Discovery) != 0) - list.Add("discovery"); - if ((enumValue & NodesStatsMetric.IndexingPressure) != 0) - list.Add("indexing_pressure"); - if ((enumValue & NodesStatsMetric.SearchPipeline) != 0) - list.Add("search_pipeline"); + if ((enumValue & NodesStatsMetric.WeightedRouting) != 0) + list.Add("weighted_routing"); return string.Join(",", list); } @@ -668,8 +743,8 @@ public static string GetStringValue(this TasksGroupBy enumValue) => enumValue switch { TasksGroupBy.Nodes => "nodes", - TasksGroupBy.Parents => "parents", TasksGroupBy.None => "none", + TasksGroupBy.Parents => "parents", _ => throw new ArgumentException( $"'{enumValue.ToString()}' is not a valid value for enum 'TasksGroupBy'" @@ -679,13 +754,13 @@ public static string GetStringValue(this TasksGroupBy enumValue) => public static string GetStringValue(this TimeUnit enumValue) => enumValue switch { - TimeUnit.Nanos => "nanos", + TimeUnit.D => "d", + TimeUnit.H => "h", + TimeUnit.M => "m", TimeUnit.Micros => "micros", TimeUnit.Ms => "ms", + TimeUnit.Nanos => "nanos", TimeUnit.S => "s", - TimeUnit.M => "m", - TimeUnit.H => "h", - TimeUnit.D => "d", _ => throw new ArgumentException( $"'{enumValue.ToString()}' is not a valid value for enum 'TimeUnit'" @@ -706,12 +781,12 @@ public static string GetStringValue(this WaitForActiveShardOptions enumValue) => public static string GetStringValue(this WaitForEvents enumValue) => enumValue switch { - WaitForEvents.Immediate => "immediate", - WaitForEvents.Urgent => "urgent", WaitForEvents.High => "high", - WaitForEvents.Normal => "normal", - WaitForEvents.Low => "low", + WaitForEvents.Immediate => "immediate", WaitForEvents.Languid => "languid", + WaitForEvents.Low => "low", + WaitForEvents.Normal => "normal", + WaitForEvents.Urgent => "urgent", _ => throw new ArgumentException( $"'{enumValue.ToString()}' is not a valid value for enum 'WaitForEvents'" diff --git a/src/OpenSearch.Net/_Generated/Api/RequestParameters/RequestParameters.Cat.cs b/src/OpenSearch.Net/_Generated/Api/RequestParameters/RequestParameters.Cat.cs index 13a6c1cbdf..8c7a89b8e4 100644 --- a/src/OpenSearch.Net/_Generated/Api/RequestParameters/RequestParameters.Cat.cs +++ b/src/OpenSearch.Net/_Generated/Api/RequestParameters/RequestParameters.Cat.cs @@ -483,20 +483,6 @@ public partial class CatHelpRequestParameters : RequestParameters HttpMethod.GET; public override bool SupportsBody => false; - - /// Return help information. - public bool? Help - { - get => Q("help"); - set => Q("help", value); - } - - /// Comma-separated list of column names or column aliases to sort by. - public string[] SortByColumns - { - get => Q("s"); - set => Q("s", value); - } } /// Request options for Indices https://opensearch.org/docs/latest/api-reference/cat/cat-indices/ diff --git a/src/OpenSearch.Net/_Generated/Api/RequestParameters/RequestParameters.Cluster.cs b/src/OpenSearch.Net/_Generated/Api/RequestParameters/RequestParameters.Cluster.cs index cb0a9221e5..2c6f2b3b20 100644 --- a/src/OpenSearch.Net/_Generated/Api/RequestParameters/RequestParameters.Cluster.cs +++ b/src/OpenSearch.Net/_Generated/Api/RequestParameters/RequestParameters.Cluster.cs @@ -481,7 +481,7 @@ public TimeSpan Timeout } } - /// Request options for PutComponentTemplate + /// Request options for PutComponentTemplate https://opensearch.org/docs/latest/im-plugin/index-templates/#use-component-templates-to-create-an-index-template public partial class PutComponentTemplateRequestParameters : RequestParameters { @@ -547,7 +547,7 @@ public TimeSpan ClusterManagerTimeout set => Q("cluster_manager_timeout", value); } - /// Return settings in flat format (default: false). + /// Return settings in flat format. public bool? FlatSettings { get => Q("flat_settings"); @@ -684,7 +684,7 @@ public ExpandWildcards? ExpandWildcards set => Q("expand_wildcards", value); } - /// Return settings in flat format (default: false). + /// Return settings in flat format. public bool? FlatSettings { get => Q("flat_settings"); @@ -698,7 +698,7 @@ public bool? IgnoreUnavailable set => Q("ignore_unavailable", value); } - /// Return local information, do not retrieve the state from cluster-manager node (default: false). + /// Return local information, do not retrieve the state from cluster-manager node. public bool? Local { get => Q("local"); @@ -746,7 +746,7 @@ public bool? FlatSettings /// /// Period to wait for each node to respond. 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. + /// However, timed out nodes are included in the response's `_nodes.failed` property. Defaults to no timeout. /// public TimeSpan Timeout { diff --git a/src/OpenSearch.Net/_Generated/Api/RequestParameters/RequestParameters.Indices.cs b/src/OpenSearch.Net/_Generated/Api/RequestParameters/RequestParameters.Indices.cs index e90bef5c25..e3a2850b14 100644 --- a/src/OpenSearch.Net/_Generated/Api/RequestParameters/RequestParameters.Indices.cs +++ b/src/OpenSearch.Net/_Generated/Api/RequestParameters/RequestParameters.Indices.cs @@ -177,7 +177,7 @@ public TimeSpan MasterTimeout } } - /// Request options for PutComposableTemplate + /// Request options for PutComposableTemplate https://opensearch.org/docs/latest/im-plugin/index-templates/ public partial class PutComposableIndexTemplateRequestParameters : RequestParameters { diff --git a/src/OpenSearch.Net/_Generated/Api/RequestParameters/RequestParameters.Snapshot.cs b/src/OpenSearch.Net/_Generated/Api/RequestParameters/RequestParameters.Snapshot.cs index f5bddaba84..cd0c3c6255 100644 --- a/src/OpenSearch.Net/_Generated/Api/RequestParameters/RequestParameters.Snapshot.cs +++ b/src/OpenSearch.Net/_Generated/Api/RequestParameters/RequestParameters.Snapshot.cs @@ -111,7 +111,7 @@ public TimeSpan MasterTimeout } } - /// Request options for Snapshot + /// Request options for Snapshot https://opensearch.org/docs/latest/api-reference/snapshots/create-snapshot/ public partial class SnapshotRequestParameters : RequestParameters { public override HttpMethod DefaultHttpMethod => HttpMethod.PUT; @@ -149,7 +149,7 @@ public bool? WaitForCompletion } } - /// Request options for CreateRepository + /// Request options for CreateRepository https://opensearch.org/docs/latest/api-reference/snapshots/create-repository/ public partial class CreateRepositoryRequestParameters : RequestParameters { @@ -284,7 +284,7 @@ public TimeSpan MasterTimeout } /// - /// If true, returns additional information about each snapshot such as the version of Opensearch which took the snapshot, the start and end + /// 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 bool? Verbose @@ -309,7 +309,7 @@ public TimeSpan ClusterManagerTimeout set => Q("cluster_manager_timeout", value); } - /// Return local information, do not retrieve the state from cluster-manager node (default: false). + /// Return local information, do not retrieve the state from cluster-manager node. public bool? Local { get => Q("local"); diff --git a/src/OpenSearch.Net/_Generated/OpenSearchLowLevelClient.Cat.cs b/src/OpenSearch.Net/_Generated/OpenSearchLowLevelClient.Cat.cs index 6bc1286dae..a5919446ba 100644 --- a/src/OpenSearch.Net/_Generated/OpenSearchLowLevelClient.Cat.cs +++ b/src/OpenSearch.Net/_Generated/OpenSearchLowLevelClient.Cat.cs @@ -880,7 +880,7 @@ public Task SnapshotsAsync( ); /// GET on /_cat/snapshots/{repository} https://opensearch.org/docs/latest/api-reference/cat/cat-snapshots/ - /// A comma-separated list of snapshot repositories used to limit the request. Accepts wildcard expressions. `_all` returns all repositories. If any repository fails during the request, Opensearch returns an error. + /// A comma-separated list of snapshot repositories used to limit the request. Accepts wildcard expressions. `_all` returns all repositories. If any repository fails during the request, OpenSearch returns an error. /// Request specific configuration such as querystring parameters & request specific connection settings. public TResponse Snapshots( string repository, @@ -895,7 +895,7 @@ public TResponse Snapshots( ); /// GET on /_cat/snapshots/{repository} https://opensearch.org/docs/latest/api-reference/cat/cat-snapshots/ - /// A comma-separated list of snapshot repositories used to limit the request. Accepts wildcard expressions. `_all` returns all repositories. If any repository fails during the request, Opensearch returns an error. + /// A comma-separated list of snapshot repositories used to limit the request. Accepts wildcard expressions. `_all` returns all repositories. If any repository fails during the request, OpenSearch returns an error. /// Request specific configuration such as querystring parameters & request specific connection settings. [MapsApi("cat.snapshots", "repository")] public Task SnapshotsAsync( diff --git a/src/OpenSearch.Net/_Generated/OpenSearchLowLevelClient.Cluster.cs b/src/OpenSearch.Net/_Generated/OpenSearchLowLevelClient.Cluster.cs index 0dcec53109..faefa62ca2 100644 --- a/src/OpenSearch.Net/_Generated/OpenSearchLowLevelClient.Cluster.cs +++ b/src/OpenSearch.Net/_Generated/OpenSearchLowLevelClient.Cluster.cs @@ -434,7 +434,7 @@ public Task HealthAsync( ); /// GET on /_cluster/health/{index} https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-health/ - /// 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, 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 `*`. /// Request specific configuration such as querystring parameters & request specific connection settings. public TResponse Health( string index, @@ -449,7 +449,7 @@ public TResponse Health( ); /// GET on /_cluster/health/{index} https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-health/ - /// 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, 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 `*`. /// Request specific configuration such as querystring parameters & request specific connection settings. [MapsApi("cluster.health", "index")] public Task HealthAsync( @@ -524,8 +524,8 @@ public Task PostVotingConfigExclusionsAsync( RequestParams(requestParameters) ); - /// PUT on /_component_template/{name} - /// 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. 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. + /// PUT on /_component_template/{name} https://opensearch.org/docs/latest/im-plugin/index-templates/#use-component-templates-to-create-an-index-template + /// 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. 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. /// The template definition. /// Request specific configuration such as querystring parameters & request specific connection settings. public TResponse PutComponentTemplate( @@ -541,8 +541,8 @@ public TResponse PutComponentTemplate( RequestParams(requestParameters) ); - /// PUT on /_component_template/{name} - /// 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. 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. + /// PUT on /_component_template/{name} https://opensearch.org/docs/latest/im-plugin/index-templates/#use-component-templates-to-create-an-index-template + /// 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. 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. /// The template definition. /// Request specific configuration such as querystring parameters & request specific connection settings. [MapsApi("cluster.put_component_template", "name, body")] diff --git a/src/OpenSearch.Net/_Generated/OpenSearchLowLevelClient.Indices.cs b/src/OpenSearch.Net/_Generated/OpenSearchLowLevelClient.Indices.cs index a09ffb1b32..a9a60148f7 100644 --- a/src/OpenSearch.Net/_Generated/OpenSearchLowLevelClient.Indices.cs +++ b/src/OpenSearch.Net/_Generated/OpenSearchLowLevelClient.Indices.cs @@ -192,7 +192,7 @@ public Task GetComposableTemplateForAllAsync( RequestParams(requestParameters) ); - /// PUT on /_index_template/{name} + /// PUT on /_index_template/{name} https://opensearch.org/docs/latest/im-plugin/index-templates/ /// Index or template name. /// The template definition. /// Request specific configuration such as querystring parameters & request specific connection settings. @@ -209,7 +209,7 @@ public TResponse PutComposableTemplateForAll( RequestParams(requestParameters) ); - /// PUT on /_index_template/{name} + /// PUT on /_index_template/{name} https://opensearch.org/docs/latest/im-plugin/index-templates/ /// Index or template name. /// The template definition. /// Request specific configuration such as querystring parameters & request specific connection settings. diff --git a/src/OpenSearch.Net/_Generated/OpenSearchLowLevelClient.Ingest.cs b/src/OpenSearch.Net/_Generated/OpenSearchLowLevelClient.Ingest.cs index 7f538dc0eb..5c6b223dea 100644 --- a/src/OpenSearch.Net/_Generated/OpenSearchLowLevelClient.Ingest.cs +++ b/src/OpenSearch.Net/_Generated/OpenSearchLowLevelClient.Ingest.cs @@ -259,7 +259,7 @@ public Task SimulatePipelineAsync( ); /// POST on /_ingest/pipeline/{id}/_simulate https://opensearch.org/docs/latest/api-reference/ingest-apis/simulate-ingest/ - /// Pipeline to test. If you don’t specify a `pipeline` in the request body, this parameter is required. + /// Pipeline to test. If you don't specify a `pipeline` in the request body, this parameter is required. /// The simulate definition. /// Request specific configuration such as querystring parameters & request specific connection settings. public TResponse SimulatePipeline( @@ -276,7 +276,7 @@ public TResponse SimulatePipeline( ); /// POST on /_ingest/pipeline/{id}/_simulate https://opensearch.org/docs/latest/api-reference/ingest-apis/simulate-ingest/ - /// Pipeline to test. If you don’t specify a `pipeline` in the request body, this parameter is required. + /// Pipeline to test. If you don't specify a `pipeline` in the request body, this parameter is required. /// The simulate definition. /// Request specific configuration such as querystring parameters & request specific connection settings. [MapsApi("ingest.simulate", "id, body")] diff --git a/src/OpenSearch.Net/_Generated/OpenSearchLowLevelClient.Snapshot.cs b/src/OpenSearch.Net/_Generated/OpenSearchLowLevelClient.Snapshot.cs index 896c7c3659..82282b3564 100644 --- a/src/OpenSearch.Net/_Generated/OpenSearchLowLevelClient.Snapshot.cs +++ b/src/OpenSearch.Net/_Generated/OpenSearchLowLevelClient.Snapshot.cs @@ -151,7 +151,7 @@ public Task CloneAsync( RequestParams(requestParameters) ); - /// PUT on /_snapshot/{repository}/{snapshot} + /// PUT on /_snapshot/{repository}/{snapshot} https://opensearch.org/docs/latest/api-reference/snapshots/create-snapshot/ /// Repository for the snapshot. /// Name of the snapshot. Must be unique in the repository. /// The snapshot definition. @@ -170,7 +170,7 @@ public TResponse Snapshot( RequestParams(requestParameters) ); - /// PUT on /_snapshot/{repository}/{snapshot} + /// PUT on /_snapshot/{repository}/{snapshot} https://opensearch.org/docs/latest/api-reference/snapshots/create-snapshot/ /// Repository for the snapshot. /// Name of the snapshot. Must be unique in the repository. /// The snapshot definition. @@ -192,7 +192,7 @@ public Task SnapshotAsync( RequestParams(requestParameters) ); - /// PUT on /_snapshot/{repository} + /// PUT on /_snapshot/{repository} https://opensearch.org/docs/latest/api-reference/snapshots/create-repository/ /// A repository name. /// The repository definition. /// Request specific configuration such as querystring parameters & request specific connection settings. @@ -209,7 +209,7 @@ public TResponse CreateRepository( RequestParams(requestParameters) ); - /// PUT on /_snapshot/{repository} + /// PUT on /_snapshot/{repository} https://opensearch.org/docs/latest/api-reference/snapshots/create-repository/ /// A repository name. /// The repository definition. /// Request specific configuration such as querystring parameters & request specific connection settings. diff --git a/tests/Tests/Cluster/ClusterState/ClusterStateUrlTests.cs b/tests/Tests/Cluster/ClusterState/ClusterStateUrlTests.cs index f2d5f2fef2..e6589c0843 100644 --- a/tests/Tests/Cluster/ClusterState/ClusterStateUrlTests.cs +++ b/tests/Tests/Cluster/ClusterState/ClusterStateUrlTests.cs @@ -44,11 +44,10 @@ await GET("/_cluster/state") .Request(c => c.Cluster.State(new ClusterStateRequest())) .FluentAsync(c => c.Cluster.StateAsync()) .RequestAsync(c => c.Cluster.StateAsync(new ClusterStateRequest())) - ; var metrics = ClusterStateMetric.ClusterManagerNode | ClusterStateMetric.Metadata; - await GET("/_cluster/state/metadata%2Ccluster_manager_node") + await GET("/_cluster/state/cluster_manager_node%2Cmetadata") .Fluent(c => c.Cluster.State(null, p => p.Metric(metrics))) .Request(c => c.Cluster.State(new ClusterStateRequest(metrics))) .FluentAsync(c => c.Cluster.StateAsync(null, p => p.Metric(metrics))) diff --git a/tests/Tests/Cluster/NodesInfo/NodesInfoUrlTests.cs b/tests/Tests/Cluster/NodesInfo/NodesInfoUrlTests.cs index a550d4d685..dc053210c8 100644 --- a/tests/Tests/Cluster/NodesInfo/NodesInfoUrlTests.cs +++ b/tests/Tests/Cluster/NodesInfo/NodesInfoUrlTests.cs @@ -54,14 +54,14 @@ await GET("/_nodes/foo") ; var metrics = NodesInfoMetric.Http | NodesInfoMetric.Jvm; - await GET("/_nodes/jvm%2Chttp") + await GET("/_nodes/http%2Cjvm") .Fluent(c => c.Nodes.Info(p => p.Metric(metrics))) .Request(c => c.Nodes.Info(new NodesInfoRequest(metrics))) .FluentAsync(c => c.Nodes.InfoAsync(p => p.Metric(metrics))) .RequestAsync(c => c.Nodes.InfoAsync(new NodesInfoRequest(metrics))) ; - await GET("/_nodes/foo/jvm%2Chttp") + await GET("/_nodes/foo/http%2Cjvm") .Fluent(c => c.Nodes.Info(n => n.NodeId("foo").Metric(metrics))) .Request(c => c.Nodes.Info(new NodesInfoRequest("foo", metrics))) .FluentAsync(c => c.Nodes.InfoAsync(n => n.NodeId("foo").Metric(metrics))) diff --git a/tests/Tests/Cluster/NodesStats/NodesStatsUrlTests.cs b/tests/Tests/Cluster/NodesStats/NodesStatsUrlTests.cs index 18a7cd7577..3d860cfd51 100644 --- a/tests/Tests/Cluster/NodesStats/NodesStatsUrlTests.cs +++ b/tests/Tests/Cluster/NodesStats/NodesStatsUrlTests.cs @@ -69,14 +69,14 @@ await GET("/_nodes/foo/stats/fs%2Cjvm") ; var indexMetrics = NodesStatsIndexMetric.Fielddata | NodesStatsIndexMetric.Merge; - await GET("/_nodes/stats/fs%2Cjvm/merge%2Cfielddata") + await GET("/_nodes/stats/fs%2Cjvm/fielddata%2Cmerge") .Fluent(c => c.Nodes.Stats(p => p.Metric(metrics).IndexMetric(indexMetrics))) .Request(c => c.Nodes.Stats(new NodesStatsRequest(metrics, indexMetrics))) .FluentAsync(c => c.Nodes.StatsAsync(p => p.Metric(metrics).IndexMetric(indexMetrics))) .RequestAsync(c => c.Nodes.StatsAsync(new NodesStatsRequest(metrics, indexMetrics))) ; - await GET("/_nodes/foo/stats/fs%2Cjvm/merge%2Cfielddata") + await GET("/_nodes/foo/stats/fs%2Cjvm/fielddata%2Cmerge") .Fluent(c => c.Nodes.Stats(p => p.NodeId("foo").Metric(metrics).IndexMetric(indexMetrics))) .Request(c => c.Nodes.Stats(new NodesStatsRequest("foo", metrics, indexMetrics))) .FluentAsync(c => c.Nodes.StatsAsync(p => p.NodeId("foo").Metric(metrics).IndexMetric(indexMetrics)))