From 65ac1160b994346335f91df87c75c8c76135e902 Mon Sep 17 00:00:00 2001 From: Thomas Farr Date: Wed, 23 Aug 2023 11:56:06 +1200 Subject: [PATCH] Re-generate tasks namespace (#320) Signed-off-by: Thomas Farr --- src/ApiGenerator/ApiGenerator.csproj | 2 +- .../Configuration/CodeConfiguration.cs | 1 + .../Generator/Razor/RazorGeneratorBase.cs | 46 +- src/ApiGenerator/OpenSearch.openapi.json | 21775 +++++++++------- .../OpenSearchClient.Namespace.cshtml | 2 +- .../HighLevel/Descriptors/Descriptors.cshtml | 2 +- .../Views/HighLevel/Requests/Requests.cshtml | 2 +- src/OpenSearch.Client/ApiUrlsLookup.cs | 3 - src/OpenSearch.Client/Descriptors.Tasks.cs | 136 - .../IOpenSearchClient.Generated.cs | 6 - .../OpenSearchClient.NoNamespace.cs | 8 - .../OpenSearchClient.Tasks.cs | 139 - src/OpenSearch.Client/Requests.Tasks.cs | 236 - .../_Generated/ApiUrlsLookup.cs | 23 +- .../_Generated/Descriptors.Tasks.cs | 165 + .../_Generated/Descriptors.cs | 16 +- .../_Generated/IOpenSearchClient.cs | 25 +- .../OpenSearchClient.NoNamespace.cs | 33 +- .../_Generated/OpenSearchClient.Tasks.cs | 193 + .../_Generated/Requests.Tasks.cs | 233 + src/OpenSearch.Client/_Generated/Requests.cs | 15 +- src/OpenSearch.Net/Api/Enums.cs | 29 +- .../RequestParameters.Tasks.cs | 168 - .../IOpenSearchLowLevelClient.Generated.cs | 14 +- .../OpenSearchLowLevelClient.NoNamespace.cs | 15 +- .../OpenSearchLowLevelClient.Tasks.cs | 122 - src/OpenSearch.Net/_Generated/Api/Enums.cs | 52 +- .../RequestParameters.Tasks.cs | 173 + .../_Generated/IOpenSearchLowLevelClient.cs | 25 +- .../OpenSearchLowLevelClient.NoNamespace.cs | 32 +- .../OpenSearchLowLevelClient.Tasks.cs | 176 + 31 files changed, 13325 insertions(+), 10542 deletions(-) delete mode 100644 src/OpenSearch.Client/Descriptors.Tasks.cs delete mode 100644 src/OpenSearch.Client/OpenSearchClient.Tasks.cs delete mode 100644 src/OpenSearch.Client/Requests.Tasks.cs create mode 100644 src/OpenSearch.Client/_Generated/Descriptors.Tasks.cs create mode 100644 src/OpenSearch.Client/_Generated/OpenSearchClient.Tasks.cs create mode 100644 src/OpenSearch.Client/_Generated/Requests.Tasks.cs delete mode 100644 src/OpenSearch.Net/Api/RequestParameters/RequestParameters.Tasks.cs delete mode 100644 src/OpenSearch.Net/OpenSearchLowLevelClient.Tasks.cs create mode 100644 src/OpenSearch.Net/_Generated/Api/RequestParameters/RequestParameters.Tasks.cs create mode 100644 src/OpenSearch.Net/_Generated/OpenSearchLowLevelClient.Tasks.cs diff --git a/src/ApiGenerator/ApiGenerator.csproj b/src/ApiGenerator/ApiGenerator.csproj index 753f44290e..65c2ca0f24 100644 --- a/src/ApiGenerator/ApiGenerator.csproj +++ b/src/ApiGenerator/ApiGenerator.csproj @@ -9,8 +9,8 @@ true + - diff --git a/src/ApiGenerator/Configuration/CodeConfiguration.cs b/src/ApiGenerator/Configuration/CodeConfiguration.cs index 2a6db3f9d4..e238dce547 100644 --- a/src/ApiGenerator/Configuration/CodeConfiguration.cs +++ b/src/ApiGenerator/Configuration/CodeConfiguration.cs @@ -40,6 +40,7 @@ public static class CodeConfiguration private static readonly Glob[] OperationsToInclude = { // e.g. new Glob("nodes.*"), + new("tasks.*") }; public static bool IncludeOperation(string name) => OperationsToInclude.Any(g => g.IsMatch(name)); diff --git a/src/ApiGenerator/Generator/Razor/RazorGeneratorBase.cs b/src/ApiGenerator/Generator/Razor/RazorGeneratorBase.cs index 26696a8e8a..4d40ca84e4 100644 --- a/src/ApiGenerator/Generator/Razor/RazorGeneratorBase.cs +++ b/src/ApiGenerator/Generator/Razor/RazorGeneratorBase.cs @@ -31,10 +31,8 @@ using System.IO; using System.Threading; using System.Threading.Tasks; -using ApiGenerator.Configuration; using ApiGenerator.Domain; -using Microsoft.CodeAnalysis; -using Microsoft.CodeAnalysis.CSharp; +using CSharpier; using RazorLight; using RazorLight.Generation; using RazorLight.Razor; @@ -51,13 +49,13 @@ public abstract class RazorGeneratorBase .EnableDebugMode() .Build(); - protected async Task DoRazor(TModel model, string viewLocation, string targetLocation, CancellationToken token) + protected static async Task DoRazor(TModel model, string viewLocation, string targetLocation, CancellationToken token) { try { token.ThrowIfCancellationRequested(); var generated = await Engine.CompileRenderAsync(viewLocation, model); - WriteFormattedCsharpFile(targetLocation, generated); + await WriteFormattedCsharpFile(targetLocation, generated); } catch (TemplateGenerationException e) { @@ -71,32 +69,28 @@ protected async Task DoRazorDependantFiles( Func identifier, Func target, CancellationToken token ) - { - using (var c = pbar.Spawn(items.Count, "Generating namespaces", new ProgressBarOptions - { - ProgressCharacter = '─', - ForegroundColor = ConsoleColor.Yellow - })) - { - foreach (var item in items) - { - var id = identifier(item); - var targetLocation = target(id); - await DoRazor(item, viewLocation, targetLocation, token); - c.Tick($"{Title}: {id}"); - } - } - } + { + using var c = pbar.Spawn(items.Count, "Generating namespaces", new ProgressBarOptions + { + ProgressCharacter = '─', + ForegroundColor = ConsoleColor.Yellow + }); + foreach (var item in items) + { + var id = identifier(item); + var targetLocation = target(id); + await DoRazor(item, viewLocation, targetLocation, token); + c.Tick($"{Title}: {id}"); + } + } - protected static void WriteFormattedCsharpFile(string path, string contents) + private static async Task WriteFormattedCsharpFile(string path, string contents) { - var tree = CSharpSyntaxTree.ParseText(contents); - var root = tree.GetRoot().NormalizeWhitespace(indentation:"\t", "\n"); - contents = root.ToFullString(); + contents = (await CodeFormatter.FormatAsync(contents)).Code; if (Directory.GetParent(path) is { Exists: false } dir) dir.Create(); - File.WriteAllText(path, contents); + await File.WriteAllTextAsync(path, contents); } public abstract string Title { get; } diff --git a/src/ApiGenerator/OpenSearch.openapi.json b/src/ApiGenerator/OpenSearch.openapi.json index dad791663a..f0929abadf 100644 --- a/src/ApiGenerator/OpenSearch.openapi.json +++ b/src/ApiGenerator/OpenSearch.openapi.json @@ -49,7 +49,7 @@ "description": "Returns an alias.", "externalDocs": { "description": "API Reference", - "url": "https://opensearch.org/docs/latest" + "url": "https://opensearch.org/docs/latest/im-plugin/index-alias/" }, "operationId": "IndicesGetAlias", "parameters": [ @@ -110,7 +110,7 @@ "description": "Comma-separated list of alias names.", "schema": { "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", "description": "Comma-separated list of alias names.", "x-data-type": "array" }, @@ -175,7 +175,7 @@ "description": "Comma-separated list of alias names.", "schema": { "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", "description": "Comma-separated list of alias names.", "x-data-type": "array" }, @@ -304,7 +304,7 @@ "description": "Performs the analysis process on a text and return the tokens breakdown of the text.", "externalDocs": { "description": "API Reference", - "url": "https://opensearch.org/docs/latest" + "url": "https://opensearch.org/docs/latest/api-reference/analyze-apis/perform-text-analysis/" }, "operationId": "IndicesAnalyze_Get", "parameters": [ @@ -363,7 +363,7 @@ "description": "Allows to perform multiple index/update/delete operations in a single request.", "externalDocs": { "description": "API Reference", - "url": "https://opensearch.org/docs/latest" + "url": "https://opensearch.org/docs/latest/api-reference/document-apis/bulk/" }, "operationId": "Bulk_Post", "requestBody": { @@ -631,7 +631,7 @@ "description": "Clears all or specific caches for one or more indices.", "externalDocs": { "description": "API Reference", - "url": "https://opensearch.org/docs/latest" + "url": "https://opensearch.org/docs/latest/api-reference/index-apis/clear-index-cache/" }, "operationId": "IndicesClearCache", "parameters": [ @@ -731,7 +731,7 @@ "description": "Returns help for the Cat APIs.", "externalDocs": { "description": "API Reference", - "url": "https://opensearch.org/docs/latest" + "url": "https://opensearch.org/docs/latest/api-reference/cat/index/" }, "operationId": "CatHelp", "parameters": [ @@ -774,7 +774,7 @@ "description": "Shows information about currently configured aliases to indices including filter and routing infos.", "externalDocs": { "description": "API Reference", - "url": "https://opensearch.org/docs/latest" + "url": "https://opensearch.org/docs/latest/api-reference/cat/cat-aliases/" }, "operationId": "CatAliases", "parameters": [ @@ -874,7 +874,7 @@ "description": "Comma-separated list of alias names.", "schema": { "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", "description": "Comma-separated list of alias names.", "x-data-type": "array" }, @@ -970,7 +970,7 @@ "description": "Provides a snapshot of how many shards are allocated to each data node and how much disk space they are using.", "externalDocs": { "description": "API Reference", - "url": "https://opensearch.org/docs/latest" + "url": "https://opensearch.org/docs/latest/api-reference/cat/cat-allocation/" }, "operationId": "CatAllocation", "parameters": [ @@ -1095,7 +1095,7 @@ "description": "Comma-separated list of node IDs or names to limit the returned information.", "schema": { "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", "description": "Comma-separated list of node IDs or names to limit the returned information.", "x-data-type": "array" }, @@ -1216,7 +1216,7 @@ "description": "Returns information about the cluster-manager node.", "externalDocs": { "description": "API Reference", - "url": "https://opensearch.org/docs/latest" + "url": "https://opensearch.org/docs/latest/api-reference/cat/cat-cluster_manager/" }, "operationId": "CatClusterManager", "parameters": [ @@ -1327,7 +1327,7 @@ "description": "Provides quick access to the document count of the entire cluster, or individual indices.", "externalDocs": { "description": "API Reference", - "url": "https://opensearch.org/docs/latest" + "url": "https://opensearch.org/docs/latest/api-reference/cat/cat-count/" }, "operationId": "CatCount", "parameters": [ @@ -1409,7 +1409,7 @@ "description": "Comma-separated list of indices to limit the returned information.", "schema": { "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", "description": "Comma-separated list of indices to limit the returned information.", "x-data-type": "array" }, @@ -1487,7 +1487,7 @@ "description": "Shows how much heap memory is currently being used by fielddata on every data node in the cluster.", "externalDocs": { "description": "API Reference", - "url": "https://opensearch.org/docs/latest" + "url": "https://opensearch.org/docs/latest/api-reference/cat/cat-field-data/" }, "operationId": "CatFielddata", "parameters": [ @@ -1591,7 +1591,7 @@ "description": "Comma-separated list of fields to return the fielddata size.", "schema": { "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", "description": "Comma-separated list of fields to return the fielddata size.", "x-data-type": "array" }, @@ -1691,7 +1691,7 @@ "description": "Returns a concise representation of the cluster health.", "externalDocs": { "description": "API Reference", - "url": "https://opensearch.org/docs/latest" + "url": "https://opensearch.org/docs/latest/api-reference/cat/cat-health/" }, "operationId": "CatHealth", "parameters": [ @@ -1954,7 +1954,7 @@ "description": "Comma-separated list of indices to limit the returned information.", "schema": { "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", "description": "Comma-separated list of indices to limit the returned information.", "x-data-type": "array" }, @@ -2126,7 +2126,7 @@ "description": "Returns information about the cluster-manager node.", "externalDocs": { "description": "API Reference", - "url": "https://opensearch.org/docs/latest" + "url": "https://opensearch.org/docs/latest/api-reference/cat/cat-cluster_manager/" }, "operationId": "CatMaster", "deprecated": true, @@ -2240,7 +2240,7 @@ "description": "Returns information about custom node attributes.", "externalDocs": { "description": "API Reference", - "url": "https://opensearch.org/docs/latest" + "url": "https://opensearch.org/docs/latest/api-reference/cat/cat-nodeattrs/" }, "operationId": "CatNodeattrs", "parameters": [ @@ -2491,7 +2491,7 @@ "description": "Returns a concise representation of the cluster pending tasks.", "externalDocs": { "description": "API Reference", - "url": "https://opensearch.org/docs/latest" + "url": "https://opensearch.org/docs/latest/api-reference/cat/cat-pending-tasks/" }, "operationId": "CatPendingTasks", "parameters": [ @@ -2605,12 +2605,69 @@ "x-version-added": "1.0" } }, + "/_cat/pit_segments": { + "get": { + "description": "List segments for one or several PITs.", + "externalDocs": { + "description": "API Reference", + "url": "https://opensearch.org/docs/latest/search-plugins/point-in-time-api/" + }, + "operationId": "CatPitSegments", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CatPitSegments_BodyParams" + } + } + } + }, + "responses": { + "200": { + "description": "CatPitSegments 200 response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CatPitSegmentsResponseContent" + } + } + } + } + }, + "x-operation-group": "cat.pit_segments", + "x-version-added": "2.4" + } + }, + "/_cat/pit_segments/_all": { + "get": { + "description": "Lists all active point-in-time segments.", + "externalDocs": { + "description": "API Reference", + "url": "https://opensearch.org/docs/latest/search-plugins/point-in-time-api/" + }, + "operationId": "CatAllPitSegments", + "responses": { + "200": { + "description": "CatAllPitSegments 200 response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CatAllPitSegmentsResponseContent" + } + } + } + } + }, + "x-operation-group": "cat.all_pit_segments", + "x-version-added": "2.4" + } + }, "/_cat/plugins": { "get": { "description": "Returns information about installed plugins across nodes node.", "externalDocs": { "description": "API Reference", - "url": "https://opensearch.org/docs/latest" + "url": "https://opensearch.org/docs/latest/api-reference/cat/cat-plugins/" }, "operationId": "CatPlugins", "parameters": [ @@ -2721,7 +2778,7 @@ "description": "Returns information about index shard recoveries, both on-going completed.", "externalDocs": { "description": "API Reference", - "url": "https://opensearch.org/docs/latest" + "url": "https://opensearch.org/docs/latest/api-reference/cat/cat-plugins/" }, "operationId": "CatRecovery", "parameters": [ @@ -2853,7 +2910,7 @@ "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)", + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", "description": "Comma-separated list or wildcard expression of index names to limit the returned information.", "x-data-type": "array" }, @@ -2981,7 +3038,7 @@ "description": "Returns information about snapshot repositories registered in the cluster.", "externalDocs": { "description": "API Reference", - "url": "https://opensearch.org/docs/latest" + "url": "https://opensearch.org/docs/latest/api-reference/cat/cat-repositories/" }, "operationId": "CatRepositories", "parameters": [ @@ -3092,7 +3149,7 @@ "description": "Returns information about both on-going and latest completed Segment Replication events.", "externalDocs": { "description": "API Reference", - "url": "https://opensearch.org/docs/latest" + "url": "https://opensearch.org/docs/latest/api-reference/cat/cat-segment-replication/" }, "operationId": "CatSegmentReplication", "parameters": [ @@ -3248,7 +3305,7 @@ "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)", + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", "description": "Comma-separated list or wildcard expression of index names to limit the returned information.", "x-data-type": "array" }, @@ -3400,7 +3457,7 @@ "description": "Provides low-level information about the segments in the shards of an index.", "externalDocs": { "description": "API Reference", - "url": "https://opensearch.org/docs/latest" + "url": "https://opensearch.org/docs/latest/api-reference/cat/cat-segments/" }, "operationId": "CatSegments", "parameters": [ @@ -3515,7 +3572,7 @@ "description": "Comma-separated list of indices to limit the returned information.", "schema": { "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", "description": "Comma-separated list of indices to limit the returned information.", "x-data-type": "array" }, @@ -3626,7 +3683,7 @@ "description": "Provides a detailed view of shard allocation on nodes.", "externalDocs": { "description": "API Reference", - "url": "https://opensearch.org/docs/latest" + "url": "https://opensearch.org/docs/latest/api-reference/cat/cat-shards/" }, "operationId": "CatShards", "parameters": [ @@ -3759,7 +3816,7 @@ "description": "Comma-separated list of indices to limit the returned information.", "schema": { "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", "description": "Comma-separated list of indices to limit the returned information.", "x-data-type": "array" }, @@ -3888,7 +3945,7 @@ "description": "Returns all snapshots in a specific repository.", "externalDocs": { "description": "API Reference", - "url": "https://opensearch.org/docs/latest" + "url": "https://opensearch.org/docs/latest/api-reference/cat/cat-snapshots/" }, "operationId": "CatSnapshots", "parameters": [ @@ -4013,7 +4070,7 @@ "description": "Comma-separated list of repository names.", "schema": { "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", "description": "Comma-separated list of repository names.", "x-data-type": "array" }, @@ -4134,7 +4191,7 @@ "description": "Returns information about the tasks currently executing on one or more nodes in the cluster.", "externalDocs": { "description": "API Reference", - "url": "https://opensearch.org/docs/latest" + "url": "https://opensearch.org/docs/latest/api-reference/cat/cat-tasks/" }, "operationId": "CatTasks", "parameters": [ @@ -4265,7 +4322,7 @@ "description": "Returns information about existing templates.", "externalDocs": { "description": "API Reference", - "url": "https://opensearch.org/docs/latest" + "url": "https://opensearch.org/docs/latest/api-reference/cat/cat-templates/" }, "operationId": "CatTemplates", "parameters": [ @@ -4382,7 +4439,7 @@ "description": "The name of the template.", "schema": { "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", "description": "The name of the template." }, "required": true @@ -4494,7 +4551,7 @@ "description": "Returns cluster-wide thread pool statistics per node.\nBy default the active, queue and rejected statistics are returned for all thread pools.", "externalDocs": { "description": "API Reference", - "url": "https://opensearch.org/docs/latest" + "url": "https://opensearch.org/docs/latest/api-reference/cat/cat-thread-pool/" }, "operationId": "CatThreadPool", "parameters": [ @@ -4621,7 +4678,7 @@ "description": "Comma-separated list of regular-expressions to filter the thread pools in the output.", "schema": { "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", "description": "Comma-separated list of regular-expressions to filter the thread pools in the output.", "x-data-type": "array" }, @@ -4744,7 +4801,7 @@ "description": "Provides explanations for shard allocations in the cluster.", "externalDocs": { "description": "API Reference", - "url": "https://opensearch.org/docs/latest" + "url": "https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-allocation/" }, "operationId": "ClusterAllocationExplain_Get", "parameters": [ @@ -4825,7 +4882,7 @@ "description": "Delete any existing decommission.", "externalDocs": { "description": "API Reference", - "url": "https://opensearch.org/docs/latest" + "url": "https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-decommission/#example-decommissioning-and-recommissioning-a-zone" }, "operationId": "ClusterDeleteDecommissionAwareness", "responses": { @@ -4842,7 +4899,7 @@ "description": "Get details and status of decommissioned attribute.", "externalDocs": { "description": "API Reference", - "url": "https://opensearch.org/docs/latest" + "url": "https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-decommission/#example-getting-zone-decommission-status" }, "operationId": "ClusterGetDecommissionAwareness", "parameters": [ @@ -4852,7 +4909,7 @@ "description": "Awareness attribute name.", "schema": { "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", "description": "Awareness attribute name." }, "required": true @@ -4872,7 +4929,7 @@ "description": "Decommissions an awareness attribute.", "externalDocs": { "description": "API Reference", - "url": "https://opensearch.org/docs/latest" + "url": "https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-decommission/#example-decommissioning-and-recommissioning-a-zone" }, "operationId": "ClusterPutDecommissionAwareness", "parameters": [ @@ -4882,7 +4939,7 @@ "description": "Awareness attribute name.", "schema": { "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", "description": "Awareness attribute name." }, "required": true @@ -4893,7 +4950,7 @@ "description": "Awareness attribute value.", "schema": { "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", "description": "Awareness attribute value." }, "required": true @@ -4913,7 +4970,7 @@ "description": "Returns basic information about the health of the cluster.", "externalDocs": { "description": "API Reference", - "url": "https://opensearch.org/docs/latest" + "url": "https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-health/" }, "operationId": "ClusterHealth", "parameters": [ @@ -5071,7 +5128,7 @@ "description": "Limit the information returned to specific indicies.", "schema": { "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", "description": "Limit the information returned to specific indicies.", "x-data-type": "array" }, @@ -5225,7 +5282,7 @@ "description": "Returns information about hot threads on each node in the cluster.", "externalDocs": { "description": "API Reference", - "url": "https://opensearch.org/docs/latest" + "url": "https://opensearch.org/docs/latest/api-reference/nodes-apis/nodes-hot-threads/" }, "operationId": "NodesHotThreads_DeprecatedDash", "deprecated": true, @@ -5398,7 +5455,7 @@ "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)", + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", "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" }, @@ -5491,7 +5548,7 @@ "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)", + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", "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" }, @@ -5736,7 +5793,7 @@ "description": "Delete weighted shard routing weights.", "externalDocs": { "description": "API Reference", - "url": "https://opensearch.org/docs/latest" + "url": "https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-awareness/#example-deleting-weights" }, "operationId": "ClusterDeleteWeightedRouting", "responses": { @@ -5753,7 +5810,7 @@ "description": "Fetches weighted shard routing weights.", "externalDocs": { "description": "API Reference", - "url": "https://opensearch.org/docs/latest" + "url": "https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-awareness/#example-getting-weights-for-all-zones" }, "operationId": "ClusterGetWeightedRouting", "parameters": [ @@ -5763,7 +5820,7 @@ "description": "Awareness attribute name.", "schema": { "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", "description": "Awareness attribute name." }, "required": true @@ -5781,7 +5838,7 @@ "description": "Updates weighted shard routing weights.", "externalDocs": { "description": "API Reference", - "url": "https://opensearch.org/docs/latest" + "url": "https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-awareness/#example-weighted-round-robin-search" }, "operationId": "ClusterPutWeightedRouting", "parameters": [ @@ -5791,7 +5848,7 @@ "description": "Awareness attribute name.", "schema": { "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", "description": "Awareness attribute name." }, "required": true @@ -5811,7 +5868,7 @@ "description": "Returns cluster settings.", "externalDocs": { "description": "API Reference", - "url": "https://opensearch.org/docs/latest/api-reference/cluster-settings/" + "url": "https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-settings/" }, "operationId": "ClusterGetSettings", "parameters": [ @@ -6104,7 +6161,7 @@ "description": "Limit the information returned to the specified metrics.", "schema": { "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", "description": "Limit the information returned to the specified metrics.", "x-enum-options": [ "_all", @@ -6234,7 +6291,7 @@ "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)", + "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" }, @@ -6246,7 +6303,7 @@ "description": "Limit the information returned to the specified metrics.", "schema": { "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", "description": "Limit the information returned to the specified metrics.", "x-enum-options": [ "_all", @@ -6370,7 +6427,7 @@ "description": "Returns high-level overview of cluster statistics.", "externalDocs": { "description": "API Reference", - "url": "https://opensearch.org/docs/latest" + "url": "https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-stats/" }, "operationId": "ClusterStats", "parameters": [ @@ -6416,7 +6473,7 @@ "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)", + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", "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" }, @@ -6597,7 +6654,7 @@ "description": "The name of the template.", "schema": { "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", "description": "The name of the template." }, "required": true @@ -6657,7 +6714,7 @@ "description": "The Comma-separated names of the component templates.", "schema": { "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", "description": "The Comma-separated names of the component templates.", "x-data-type": "array" }, @@ -6721,7 +6778,7 @@ "description": "The name of the template.", "schema": { "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", "description": "The name of the template." }, "required": true @@ -6779,7 +6836,7 @@ "description": "The name of the template.", "schema": { "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", "description": "The name of the template." }, "required": true @@ -6843,7 +6900,7 @@ "description": "Creates or updates a component template.", "externalDocs": { "description": "API Reference", - "url": "https://opensearch.org/docs/latest" + "url": "https://opensearch.org/docs/latest/im-plugin/index-templates/#use-component-templates-to-create-an-index-template" }, "operationId": "ClusterPutComponentTemplate_Put", "requestBody": { @@ -6863,7 +6920,7 @@ "description": "The name of the template.", "schema": { "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", "description": "The name of the template." }, "required": true @@ -7075,7 +7132,7 @@ "description": "Returns number of documents matching a query.", "externalDocs": { "description": "API Reference", - "url": "https://opensearch.org/docs/latest" + "url": "https://opensearch.org/docs/latest/api-reference/count/" }, "operationId": "Count_Post", "requestBody": { @@ -7236,7 +7293,7 @@ "description": "Returns all dangling indices.", "externalDocs": { "description": "API Reference", - "url": "https://opensearch.org/docs/latest" + "url": "https://opensearch.org/docs/latest/api-reference/index-apis/dangling-index/" }, "operationId": "DanglingIndicesListDanglingIndices", "responses": { @@ -7253,7 +7310,7 @@ "description": "Deletes the specified dangling index.", "externalDocs": { "description": "API Reference", - "url": "https://opensearch.org/docs/latest" + "url": "https://opensearch.org/docs/latest/api-reference/index-apis/dangling-index/" }, "operationId": "DanglingIndicesDeleteDanglingIndex", "parameters": [ @@ -7263,7 +7320,7 @@ "description": "The UUID of the dangling index.", "schema": { "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", "description": "The UUID of the dangling index." }, "required": true @@ -7326,7 +7383,7 @@ "description": "Imports the specified dangling index.", "externalDocs": { "description": "API Reference", - "url": "https://opensearch.org/docs/latest" + "url": "https://opensearch.org/docs/latest/api-reference/index-apis/dangling-index/" }, "operationId": "DanglingIndicesImportDanglingIndex", "parameters": [ @@ -7336,7 +7393,7 @@ "description": "The UUID of the dangling index.", "schema": { "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", "description": "The UUID of the dangling index." }, "required": true @@ -7401,12 +7458,19 @@ "description": "Returns data streams.", "externalDocs": { "description": "API Reference", - "url": "https://opensearch.org/docs/latest" + "url": "https://opensearch.org/docs/latest/im-plugin/data-streams/" }, "operationId": "IndicesGetDataStream", "responses": { "200": { - "description": "IndicesGetDataStream 200 response" + "description": "IndicesGetDataStream 200 response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IndicesGetDataStreamResponseContent" + } + } + } } }, "x-operation-group": "indices.get_data_stream", @@ -7418,7 +7482,7 @@ "description": "Provides statistics on operations happening in a data stream.", "externalDocs": { "description": "API Reference", - "url": "https://opensearch.org/docs/latest" + "url": "https://opensearch.org/docs/latest/im-plugin/data-streams/" }, "operationId": "IndicesDataStreamsStats", "responses": { @@ -7435,7 +7499,7 @@ "description": "Deletes a data stream.", "externalDocs": { "description": "API Reference", - "url": "https://opensearch.org/docs/latest" + "url": "https://opensearch.org/docs/latest/im-plugin/data-streams/" }, "operationId": "IndicesDeleteDataStream", "parameters": [ @@ -7445,7 +7509,7 @@ "description": "Comma-separated list of data streams; use `_all` or empty string to perform the operation on all data streams.", "schema": { "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", "description": "Comma-separated list of data streams; use `_all` or empty string to perform the operation on all data streams.", "x-data-type": "array" }, @@ -7454,7 +7518,14 @@ ], "responses": { "200": { - "description": "IndicesDeleteDataStream 200 response" + "description": "IndicesDeleteDataStream 200 response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IndicesDeleteDataStreamResponseContent" + } + } + } } }, "x-operation-group": "indices.delete_data_stream", @@ -7470,7 +7541,7 @@ "description": "Comma-separated list of data streams; use `_all` or empty string to perform the operation on all data streams.", "schema": { "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", "description": "Comma-separated list of data streams; use `_all` or empty string to perform the operation on all data streams.", "x-data-type": "array" }, @@ -7479,7 +7550,14 @@ ], "responses": { "200": { - "description": "IndicesGetDataStream_WithName 200 response" + "description": "IndicesGetDataStream_WithName 200 response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IndicesGetDataStream_WithNameResponseContent" + } + } + } } }, "x-operation-group": "indices.get_data_stream", @@ -7489,7 +7567,7 @@ "description": "Creates or updates a data stream.", "externalDocs": { "description": "API Reference", - "url": "https://opensearch.org/docs/latest" + "url": "https://opensearch.org/docs/latest/im-plugin/data-streams/" }, "operationId": "IndicesCreateDataStream", "requestBody": { @@ -7508,7 +7586,7 @@ "description": "The name of the data stream.", "schema": { "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", "description": "The name of the data stream." }, "required": true @@ -7516,7 +7594,14 @@ ], "responses": { "200": { - "description": "IndicesCreateDataStream 200 response" + "description": "IndicesCreateDataStream 200 response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IndicesCreateDataStreamResponseContent" + } + } + } } }, "x-operation-group": "indices.create_data_stream", @@ -7534,7 +7619,7 @@ "description": "Comma-separated list of data streams; use `_all` or empty string to perform the operation on all data streams.", "schema": { "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", "description": "Comma-separated list of data streams; use `_all` or empty string to perform the operation on all data streams.", "x-data-type": "array" }, @@ -7565,7 +7650,7 @@ "description": "The task id to rethrottle.", "schema": { "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", "description": "The task id to rethrottle." }, "required": true @@ -7596,7 +7681,7 @@ "description": "Returns the information about the capabilities of fields among multiple indices.", "externalDocs": { "description": "API Reference", - "url": "https://opensearch.org/docs/latest" + "url": "https://opensearch.org/docs/latest/field-types/supported-field-types/alias/#using-aliases-in-field-capabilities-api-operations" }, "operationId": "FieldCaps_Get", "parameters": [ @@ -7933,7 +8018,7 @@ "description": "Returns an index template.", "externalDocs": { "description": "API Reference", - "url": "https://opensearch.org/docs/latest" + "url": "https://opensearch.org/docs/latest/im-plugin/index-templates/" }, "operationId": "IndicesGetIndexTemplate", "parameters": [ @@ -8085,7 +8170,7 @@ "description": "The name of the template.", "schema": { "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", "description": "The name of the template." }, "required": true @@ -8169,7 +8254,7 @@ "description": "The name of the index (it must be a concrete index name).", "schema": { "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", "description": "The name of the index (it must be a concrete index name)." }, "required": true @@ -8234,7 +8319,7 @@ "description": "Deletes an index template.", "externalDocs": { "description": "API Reference", - "url": "https://opensearch.org/docs/latest" + "url": "https://opensearch.org/docs/latest/im-plugin/index-templates/#delete-a-template" }, "operationId": "IndicesDeleteIndexTemplate", "parameters": [ @@ -8244,7 +8329,7 @@ "description": "The name of the template.", "schema": { "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", "description": "The name of the template." }, "required": true @@ -8304,7 +8389,7 @@ "description": "Comma-separated names of the index templates.", "schema": { "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", "description": "Comma-separated names of the index templates.", "x-data-type": "array" }, @@ -8368,7 +8453,7 @@ "description": "Returns information about whether a particular index template exists.", "externalDocs": { "description": "API Reference", - "url": "https://opensearch.org/docs/latest" + "url": "https://opensearch.org/docs/latest/im-plugin/index-templates/" }, "operationId": "IndicesExistsIndexTemplate", "parameters": [ @@ -8378,7 +8463,7 @@ "description": "The name of the template.", "schema": { "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", "description": "The name of the template." }, "required": true @@ -8446,7 +8531,7 @@ "description": "The name of the template.", "schema": { "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", "description": "The name of the template." }, "required": true @@ -8509,7 +8594,7 @@ "description": "Creates or updates an index template.", "externalDocs": { "description": "API Reference", - "url": "https://opensearch.org/docs/latest" + "url": "https://opensearch.org/docs/latest/im-plugin/index-templates/" }, "operationId": "IndicesPutIndexTemplate_Put", "requestBody": { @@ -8529,7 +8614,7 @@ "description": "The name of the template.", "schema": { "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", "description": "The name of the template." }, "required": true @@ -8594,7 +8679,7 @@ "description": "Returns a pipeline.", "externalDocs": { "description": "API Reference", - "url": "https://opensearch.org/docs/latest" + "url": "https://opensearch.org/docs/latest/api-reference/ingest-apis/get-ingest/" }, "operationId": "IngestGetPipeline", "parameters": [ @@ -8638,7 +8723,7 @@ "description": "Allows to simulate a pipeline with example documents.", "externalDocs": { "description": "API Reference", - "url": "https://opensearch.org/docs/latest" + "url": "https://opensearch.org/docs/latest/api-reference/ingest-apis/simulate-ingest/" }, "operationId": "IngestSimulate_Get", "parameters": [ @@ -8700,7 +8785,7 @@ "description": "Deletes a pipeline.", "externalDocs": { "description": "API Reference", - "url": "https://opensearch.org/docs/latest" + "url": "https://opensearch.org/docs/latest/api-reference/ingest-apis/delete-ingest/" }, "operationId": "IngestDeletePipeline", "parameters": [ @@ -8710,7 +8795,7 @@ "description": "Pipeline ID.", "schema": { "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", "description": "Pipeline ID." }, "required": true @@ -8770,7 +8855,7 @@ "description": "Comma-separated list of pipeline ids. Wildcards supported.", "schema": { "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", "description": "Comma-separated list of pipeline ids. Wildcards supported.", "x-data-type": "array" }, @@ -8814,7 +8899,7 @@ "description": "Creates or updates a pipeline.", "externalDocs": { "description": "API Reference", - "url": "https://opensearch.org/docs/latest" + "url": "https://opensearch.org/docs/latest/api-reference/ingest-apis/create-update-ingest/" }, "operationId": "IngestPutPipeline", "requestBody": { @@ -8834,7 +8919,7 @@ "description": "Pipeline ID.", "schema": { "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", "description": "Pipeline ID." }, "required": true @@ -8896,7 +8981,7 @@ "description": "Pipeline ID.", "schema": { "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", "description": "Pipeline ID." }, "required": true @@ -8940,7 +9025,7 @@ "description": "Pipeline ID.", "schema": { "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", "description": "Pipeline ID." }, "required": true @@ -8987,7 +9072,7 @@ "description": "Returns mappings for one or more indices.", "externalDocs": { "description": "API Reference", - "url": "https://opensearch.org/docs/latest" + "url": "https://opensearch.org/docs/latest/field-types/index/#get-a-mapping" }, "operationId": "IndicesGetMapping", "parameters": [ @@ -9070,7 +9155,7 @@ "description": "Returns mapping for one or more fields.", "externalDocs": { "description": "API Reference", - "url": "https://opensearch.org/docs/latest" + "url": "https://opensearch.org/docs/latest/field-types/index/" }, "operationId": "IndicesGetFieldMapping", "parameters": [ @@ -9080,7 +9165,7 @@ "description": "Comma-separated list of fields.", "schema": { "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", "description": "Comma-separated list of fields.", "x-data-type": "array" }, @@ -9146,7 +9231,7 @@ "description": "Allows to get multiple documents in one request.", "externalDocs": { "description": "API Reference", - "url": "https://opensearch.org/docs/latest" + "url": "https://opensearch.org/docs/latest/api-reference/document-apis/multi-get/" }, "operationId": "Mget_Get", "parameters": [ @@ -9374,7 +9459,7 @@ "description": "Allows to execute several search operations in one request.", "externalDocs": { "description": "API Reference", - "url": "https://opensearch.org/docs/latest" + "url": "https://opensearch.org/docs/latest/api-reference/multi-search/" }, "operationId": "Msearch_Get", "parameters": [ @@ -9552,7 +9637,7 @@ "description": "Allows to execute several search template operations in one request.", "externalDocs": { "description": "API Reference", - "url": "https://opensearch.org/docs/latest" + "url": "https://opensearch.org/docs/latest/search-plugins/search-template/" }, "operationId": "MsearchTemplate_Get", "parameters": [ @@ -9979,7 +10064,7 @@ "description": "Returns information about nodes in the cluster.", "externalDocs": { "description": "API Reference", - "url": "https://opensearch.org/docs/latest" + "url": "https://opensearch.org/docs/latest/api-reference/nodes-apis/nodes-info/" }, "operationId": "NodesInfo", "parameters": [ @@ -10177,7 +10262,7 @@ "description": "Reloads secure settings.", "externalDocs": { "description": "API Reference", - "url": "https://opensearch.org/docs/latest" + "url": "https://opensearch.org/docs/latest/api-reference/nodes-apis/nodes-reload-secure/" }, "operationId": "NodesReloadSecureSettings", "requestBody": { @@ -10216,7 +10301,7 @@ "description": "Returns statistical information about nodes in the cluster.", "externalDocs": { "description": "API Reference", - "url": "https://opensearch.org/docs/latest" + "url": "https://opensearch.org/docs/latest/api-reference/nodes-apis/nodes-usage/" }, "operationId": "NodesStats", "parameters": [ @@ -10340,7 +10425,7 @@ "description": "Limit the information returned to the specified metrics.", "schema": { "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", "description": "Limit the information returned to the specified metrics.", "x-enum-options": [ "_all", @@ -10480,7 +10565,7 @@ "description": "Limit the information returned to the specified metrics.", "schema": { "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", "description": "Limit the information returned to the specified metrics.", "x-enum-options": [ "_all", @@ -10506,7 +10591,7 @@ "description": "Limit the information returned for `indices` metric to the specific index metrics. Isn't used if `indices` (or `all`) metric isn't specified.", "schema": { "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", "description": "Limit the information returned for `indices` metric to the specific index metrics. Isn't used if `indices` (or `all`) metric isn't specified.", "x-enum-options": [ "_all", @@ -10680,7 +10765,7 @@ "description": "Limit the information returned to the specified metrics.", "schema": { "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", "description": "Limit the information returned to the specified metrics.", "x-enum-options": [ "_all", @@ -10722,7 +10807,7 @@ "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)", + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", "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-overloaded-param": "metric", "x-data-type": "array" @@ -10771,7 +10856,7 @@ "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)", + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", "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" }, @@ -10861,7 +10946,7 @@ "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)", + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", "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" }, @@ -10962,7 +11047,7 @@ "description": "Comma-separated list of node IDs to span the reload/reinit call. Should stay empty because reloading usually involves all cluster nodes.", "schema": { "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", "description": "Comma-separated list of node IDs to span the reload/reinit call. Should stay empty because reloading usually involves all cluster nodes.", "x-data-type": "array" }, @@ -11000,7 +11085,7 @@ "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)", + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", "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" }, @@ -11126,7 +11211,7 @@ "description": "Limit the information returned to the specified metrics.", "schema": { "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", "description": "Limit the information returned to the specified metrics.", "x-enum-options": [ "_all", @@ -11152,7 +11237,7 @@ "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)", + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", "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" }, @@ -11278,7 +11363,7 @@ "description": "Limit the information returned to the specified metrics.", "schema": { "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", "description": "Limit the information returned to the specified metrics.", "x-enum-options": [ "_all", @@ -11304,7 +11389,7 @@ "description": "Limit the information returned for `indices` metric to the specific index metrics. Isn't used if `indices` (or `all`) metric isn't specified.", "schema": { "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", "description": "Limit the information returned for `indices` metric to the specific index metrics. Isn't used if `indices` (or `all`) metric isn't specified.", "x-enum-options": [ "_all", @@ -11334,7 +11419,7 @@ "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)", + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", "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" }, @@ -11460,7 +11545,7 @@ "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)", + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", "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" }, @@ -11498,7 +11583,7 @@ "description": "Limit the information returned to the specified metrics.", "schema": { "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", "description": "Limit the information returned to the specified metrics.", "x-enum-options": [ "_all", @@ -11514,7 +11599,7 @@ "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)", + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", "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" }, @@ -11552,7 +11637,7 @@ "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)", + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", "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" }, @@ -11564,7 +11649,7 @@ "description": "Comma-separated list of metrics you wish returned. Leave empty to return all.", "schema": { "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", "description": "Comma-separated list of metrics you wish returned. Leave empty to return all.", "x-enum-options": [ "settings", @@ -11612,145 +11697,207 @@ "x-version-added": "1.0" } }, - "/_plugins/_security/api/tenants/": { + "/_plugins/_security/api/account": { "get": { - "description": "Retrieves all tenants.", + "description": "Returns account details for the current user.", "externalDocs": { "description": "API Reference", - "url": "https://opensearch.org/docs/2.7/security/access-control/api/#get-tenants" + "url": "https://opensearch.org/docs/latest/security/access-control/api/#get-account-details" }, - "operationId": "GetTenants", + "operationId": "GetAccountDetails", "responses": { "200": { - "description": "GetTenants 200 response", + "description": "GetAccountDetails 200 response", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GetTenantsResponseContent" + "$ref": "#/components/schemas/AccountDetails" } } } } }, - "x-operation-group": "security.get_tenants", + "x-operation-group": "security.get_account_details", "x-version-added": "1.0" }, + "put": { + "description": "Changes the password for the current user.", + "externalDocs": { + "description": "API Reference", + "url": "https://opensearch.org/docs/latest/security/access-control/api/#change-password" + }, + "operationId": "ChangePassword", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ChangePasswordRequestContent" + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "ChangePassword 200 response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ChangePasswordResponseContent" + } + } + } + } + }, + "x-operation-group": "security.change_password", + "x-version-added": "1.0" + } + }, + "/_plugins/_security/api/actiongroups": { "patch": { - "description": "Add, delete, or modify multiple tenants in a single call.", + "description": "Creates, updates, or deletes multiple action groups in a single call.", "externalDocs": { "description": "API Reference", - "url": "https://opensearch.org/docs/2.7/security/access-control/api/#patch-tenants" + "url": "https://opensearch.org/docs/latest/security/access-control/api/#patch-action-groups" }, - "operationId": "PatchTenants", + "operationId": "PatchActionGroups", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/PatchTenantsParams" + "$ref": "#/components/schemas/PatchActionGroupsInputPayload" } } } }, "responses": { "200": { - "description": "PatchTenants 200 response", + "description": "PatchActionGroups 200 response", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/PatchTenantsResponseContent" + "$ref": "#/components/schemas/PatchActionGroupsResponseContent" } } } } }, - "x-operation-group": "security.patch_tenants", + "x-operation-group": "security.patch_action_groups", "x-version-added": "1.0" } }, - "/_plugins/_security/api/tenants/{tenant}": { + "/_plugins/_security/api/actiongroups/": { + "get": { + "description": "Retrieves all action groups.", + "externalDocs": { + "description": "API Reference", + "url": "https://opensearch.org/docs/latest/security/access-control/api/#get-action-groups" + }, + "operationId": "GetActionGroups", + "responses": { + "200": { + "description": "GetActionGroups 200 response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ActionGroupsMap" + } + } + } + } + }, + "x-operation-group": "security.get_action_groups", + "x-version-added": "1.0" + } + }, + "/_plugins/_security/api/actiongroups/{action_group}": { "delete": { - "description": "Delete the specified tenant.", + "description": "Delete a specified action group.", "externalDocs": { "description": "API Reference", "url": "https://opensearch.org/docs/latest/security/access-control/api/#delete-action-group" }, - "operationId": "DeleteTenant", + "operationId": "DeleteActionGroup", "parameters": [ { - "name": "tenant", + "name": "action_group", "in": "path", + "description": "Action group to delete.", "schema": { - "type": "string" + "type": "string", + "description": "Action group to delete." }, "required": true } ], "responses": { "200": { - "description": "DeleteTenant 200 response", + "description": "DeleteActionGroup 200 response", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/DeleteTenantResponseContent" + "$ref": "#/components/schemas/DeleteActionGroupResponseContent" } } } } }, - "x-operation-group": "security.delete_tenant", + "x-operation-group": "security.delete_action_group", "x-version-added": "1.0" }, "get": { - "description": "Retrieves one tenant.", + "description": "Retrieves one action group.", "externalDocs": { "description": "API Reference", - "url": "https://opensearch.org/docs/2.7/security/access-control/api/#get-tenant" + "url": "https://opensearch.org/docs/latest/security/access-control/api/#get-action-group" }, - "operationId": "GetTenant", + "operationId": "GetActionGroup", "parameters": [ { - "name": "tenant", + "name": "action_group", "in": "path", + "description": "Action group to retrieve.", "schema": { - "type": "string" + "type": "string", + "description": "Action group to retrieve." }, "required": true } ], "responses": { "200": { - "description": "GetTenant 200 response", + "description": "GetActionGroup 200 response", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GetTenantResponseContent" + "$ref": "#/components/schemas/ActionGroupsMap" } } } } }, - "x-operation-group": "security.get_tenant", + "x-operation-group": "security.get_action_group", "x-version-added": "1.0" }, "patch": { - "description": "Add, delete, or modify a single tenant.", + "description": "Updates individual attributes of an action group.", "externalDocs": { "description": "API Reference", - "url": "https://opensearch.org/docs/2.7/security/access-control/api/#patch-tenant" + "url": "https://opensearch.org/docs/latest/security/access-control/api/#patch-action-group" }, - "operationId": "PatchTenant", + "operationId": "PatchActionGroup", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/PatchTenantParams" + "$ref": "#/components/schemas/PatchActionGroupInputPayload" } } } }, "parameters": [ { - "name": "tenant", + "name": "action_group", "in": "path", "schema": { "type": "string" @@ -11760,307 +11907,303 @@ ], "responses": { "200": { - "description": "PatchTenant 200 response", + "description": "PatchActionGroup 200 response", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/PatchTenantResponseContent" + "$ref": "#/components/schemas/PatchActionGroupResponseContent" } } } } }, - "x-operation-group": "security.patch_tenant", + "x-operation-group": "security.patch_action_group", "x-version-added": "1.0" }, "put": { - "description": "Creates or replaces the specified tenant.", + "description": "Creates or replaces the specified action group.", "externalDocs": { "description": "API Reference", - "url": "https://opensearch.org/docs/2.7/security/access-control/api/#create-tenant" + "url": "https://opensearch.org/docs/latest/security/access-control/api/#create-action-group" }, - "operationId": "CreateTenant", + "operationId": "CreateActionGroup", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/CreateTenantParams" + "$ref": "#/components/schemas/Action_Group" } } } }, "parameters": [ { - "name": "tenant", + "name": "action_group", "in": "path", + "description": "The name of the action group to create or replace", "schema": { - "type": "string" + "type": "string", + "description": "The name of the action group to create or replace" }, "required": true } ], "responses": { "200": { - "description": "CreateTenant 200 response", + "description": "CreateActionGroup 200 response", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/CreateTenantResponseContent" + "$ref": "#/components/schemas/CreateActionGroupResponseContent" } } } } }, - "x-operation-group": "security.create_tenant", + "x-operation-group": "security.create_action_group", "x-version-added": "1.0" } }, - "/_rank_eval": { + "/_plugins/_security/api/audit": { "get": { - "description": "Allows to evaluate the quality of ranked search results over a set of typical search queries.", + "description": "Retrieves the audit configuration.", "externalDocs": { "description": "API Reference", - "url": "https://opensearch.org/docs/latest" + "url": "https://opensearch.org/docs/latest/security/access-control/api/#audit-logs" }, - "operationId": "RankEval_Get", - "parameters": [ - { - "name": "ignore_unavailable", - "in": "query", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", - "schema": { - "type": "boolean", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." + "operationId": "GetAuditConfiguration", + "responses": { + "200": { + "description": "GetAuditConfiguration 200 response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AuditConfigWithReadOnly" + } + } } - }, - { - "name": "allow_no_indices", - "in": "query", - "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified).", - "schema": { - "type": "boolean", - "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)." + } + }, + "x-operation-group": "security.get_audit_configuration", + "x-version-added": "1.0" + }, + "patch": { + "description": "A PATCH call is used to update specified fields in the audit configuration.", + "externalDocs": { + "description": "API Reference", + "url": "https://opensearch.org/docs/latest/security/access-control/api/#audit-logs" + }, + "operationId": "PatchAuditConfiguration", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PatchAuditConfigurationInputPayload" + } } }, - { - "name": "expand_wildcards", - "in": "query", - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", - "schema": { - "$ref": "#/components/schemas/ExpandWildcards" - } - }, - { - "name": "search_type", - "in": "query", - "description": "Search operation type.", - "schema": { - "$ref": "#/components/schemas/SearchType" - } - } - ], + "required": true + }, "responses": { "200": { - "description": "RankEval_Get 200 response" + "description": "PatchAuditConfiguration 200 response" } }, - "x-operation-group": "rank_eval", + "x-operation-group": "security.patch_audit_configuration", "x-version-added": "1.0" - }, - "post": { - "description": "Allows to evaluate the quality of ranked search results over a set of typical search queries.", - "operationId": "RankEval_Post", + } + }, + "/_plugins/_security/api/audit/config": { + "put": { + "description": "Updates the audit configuration.", + "externalDocs": { + "description": "API Reference", + "url": "https://opensearch.org/docs/latest/security/access-control/api/#audit-logs" + }, + "operationId": "UpdateAuditConfiguration", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/RankEval_BodyParams" + "$ref": "#/components/schemas/AuditConfig" } } }, "required": true }, - "parameters": [ - { - "name": "ignore_unavailable", - "in": "query", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", - "schema": { - "type": "boolean", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." - } - }, - { - "name": "allow_no_indices", - "in": "query", - "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified).", - "schema": { - "type": "boolean", - "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)." - } - }, - { - "name": "expand_wildcards", - "in": "query", - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", - "schema": { - "$ref": "#/components/schemas/ExpandWildcards" - } - }, - { - "name": "search_type", - "in": "query", - "description": "Search operation type.", - "schema": { - "$ref": "#/components/schemas/SearchType" + "responses": { + "200": { + "description": "UpdateAuditConfiguration 200 response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpdateAuditConfigurationResponseContent" + } + } } } - ], + }, + "x-operation-group": "security.update_audit_configuration", + "x-version-added": "1.0" + } + }, + "/_plugins/_security/api/cache": { + "delete": { + "description": "Flushes the Security plugin user, authentication, and authorization cache.", + "externalDocs": { + "description": "API Reference", + "url": "https://opensearch.org/docs/2.7/security/access-control/api/#flush-cache" + }, + "operationId": "FlushCache", "responses": { "200": { - "description": "RankEval_Post 200 response" + "description": "FlushCache 200 response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/FlushCacheResponseContent" + } + } + } } }, - "x-operation-group": "rank_eval", + "x-operation-group": "security.flush_cache", "x-version-added": "1.0" } }, - "/_recovery": { + "/_plugins/_security/api/internalusers": { "get": { - "description": "Returns information about ongoing index shard recoveries.", + "description": "Retrieve all internal users.", "externalDocs": { "description": "API Reference", - "url": "https://opensearch.org/docs/latest" + "url": "https://opensearch.org/docs/latest/security/access-control/api/#get-users" }, - "operationId": "IndicesRecovery", - "parameters": [ - { - "name": "detailed", - "in": "query", - "description": "Whether to display detailed information about shard recovery.", - "schema": { - "type": "boolean", - "default": false, - "description": "Whether to display detailed information about shard recovery." - } - }, - { - "name": "active_only", - "in": "query", - "description": "Display only those recoveries that are currently on-going.", - "schema": { - "type": "boolean", - "default": false, - "description": "Display only those recoveries that are currently on-going." + "operationId": "GetUsers", + "responses": { + "200": { + "description": "GetUsers 200 response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UsersMap" + } + } } } - ], + }, + "x-operation-group": "security.get_users", + "x-version-added": "1.0" + }, + "patch": { + "description": "Creates, updates, or deletes multiple internal users in a single call.", + "externalDocs": { + "description": "API Reference", + "url": "https://opensearch.org/docs/latest/security/access-control/api/#patch-users" + }, + "operationId": "PatchUsers", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PatchUsersInputPayload" + } + } + }, + "required": true + }, "responses": { "200": { - "description": "IndicesRecovery 200 response" + "description": "PatchUsers 200 response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PatchUsersResponseContent" + } + } + } } }, - "x-operation-group": "indices.recovery", + "x-operation-group": "security.patch_users", "x-version-added": "1.0" } }, - "/_refresh": { - "get": { - "description": "Performs the refresh operation in one or more indices.", - "operationId": "IndicesRefresh_Get", + "/_plugins/_security/api/internalusers/{username}": { + "delete": { + "description": "Delete the specified user.", + "externalDocs": { + "description": "API Reference", + "url": "https://opensearch.org/docs/latest/security/access-control/api/#delete-user" + }, + "operationId": "DeleteUser", "parameters": [ { - "name": "ignore_unavailable", - "in": "query", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", - "schema": { - "type": "boolean", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." - } - }, - { - "name": "allow_no_indices", - "in": "query", - "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified).", - "schema": { - "type": "boolean", - "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)." - } - }, - { - "name": "expand_wildcards", - "in": "query", - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", + "name": "username", + "in": "path", "schema": { - "$ref": "#/components/schemas/ExpandWildcards" - } + "type": "string" + }, + "required": true } ], "responses": { "200": { - "description": "IndicesRefresh_Get 200 response" + "description": "DeleteUser 200 response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DeleteUserResponseContent" + } + } + } } }, - "x-operation-group": "indices.refresh", + "x-operation-group": "security.delete_user", "x-version-added": "1.0" }, - "post": { - "description": "Performs the refresh operation in one or more indices.", + "get": { + "description": "Retrieve one internal user.", "externalDocs": { "description": "API Reference", - "url": "https://opensearch.org/docs/latest" + "url": "https://opensearch.org/docs/latest/security/access-control/api/#get-user" }, - "operationId": "IndicesRefresh_Post", + "operationId": "GetUser", "parameters": [ { - "name": "ignore_unavailable", - "in": "query", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", - "schema": { - "type": "boolean", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." - } - }, - { - "name": "allow_no_indices", - "in": "query", - "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified).", - "schema": { - "type": "boolean", - "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)." - } - }, - { - "name": "expand_wildcards", - "in": "query", - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", + "name": "username", + "in": "path", "schema": { - "$ref": "#/components/schemas/ExpandWildcards" - } + "type": "string" + }, + "required": true } ], "responses": { "200": { - "description": "IndicesRefresh_Post 200 response" + "description": "GetUser 200 response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UsersMap" + } + } + } } }, - "x-operation-group": "indices.refresh", + "x-operation-group": "security.get_user", "x-version-added": "1.0" - } - }, - "/_reindex": { - "post": { - "description": "Allows to copy documents from one index to another, optionally filtering the source\ndocuments by a query, changing the destination index settings, or fetching the\ndocuments from a remote cluster.", + }, + "patch": { + "description": "Updates individual attributes of an internal user.", "externalDocs": { "description": "API Reference", - "url": "https://opensearch.org/docs/latest" + "url": "https://opensearch.org/docs/latest/security/access-control/api/#patch-user" }, - "operationId": "Reindex", + "operationId": "PatchUser", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Reindex_BodyParams" + "$ref": "#/components/schemas/PatchUserInputPayload" } } }, @@ -12068,574 +12211,408 @@ }, "parameters": [ { - "name": "refresh", - "in": "query", - "description": "Should the affected indexes be refreshed?.", + "name": "username", + "in": "path", "schema": { - "type": "boolean", - "description": "Should the affected indexes be refreshed?." + "type": "string" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "PatchUser 200 response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PatchUserResponseContent" + } + } } - }, - { - "name": "timeout", - "in": "query", - "description": "Time each individual bulk request should wait for shards that are unavailable.", - "schema": { - "type": "string", - "default": "1m", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Time each individual bulk request should wait for shards that are unavailable.", - "x-data-type": "time" - } - }, - { - "name": "wait_for_active_shards", - "in": "query", - "description": "Sets the number of shard copies that must be active before proceeding with the operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1).", - "schema": { - "type": "string", - "default": "1", - "description": "Sets the number of shard copies that must be active before proceeding with the operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1)." - } - }, - { - "name": "wait_for_completion", - "in": "query", - "description": "Should this request wait until the operation has completed before returning.", - "schema": { - "type": "boolean", - "default": true, - "description": "Should this request wait until the operation has completed before returning." - } - }, - { - "name": "requests_per_second", - "in": "query", - "description": "The throttle for this request in sub-requests per second. -1 means no throttle.", - "schema": { - "type": "integer", - "default": 0, - "description": "The throttle for this request in sub-requests per second. -1 means no throttle.", - "format": "int32" - } - }, - { - "name": "scroll", - "in": "query", - "description": "Specify how long a consistent view of the index should be maintained for scrolled search.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Specify how long a consistent view of the index should be maintained for scrolled search.", - "x-data-type": "time" - } - }, - { - "name": "slices", - "in": "query", - "description": "The number of slices this task should be divided into. Defaults to 1, meaning the task isn't sliced into subtasks. Can be set to `auto`.", - "schema": { - "type": "string", - "default": "1", - "description": "The number of slices this task should be divided into. Defaults to 1, meaning the task isn't sliced into subtasks. Can be set to `auto`." - } - }, - { - "name": "max_docs", - "in": "query", - "description": "Maximum number of documents to process (default: all documents).", - "schema": { - "type": "integer", - "description": "Maximum number of documents to process (default: all documents).", - "format": "int32" - } - } - ], - "responses": { - "200": { - "description": "Reindex 200 response" } }, - "x-operation-group": "reindex", + "x-operation-group": "security.patch_user", "x-version-added": "1.0" - } - }, - "/_reindex/{task_id}/_rethrottle": { - "post": { - "description": "Changes the number of requests per second for a particular Reindex operation.", + }, + "put": { + "description": "Creates or replaces the specified user.", "externalDocs": { "description": "API Reference", - "url": "https://opensearch.org/docs/latest" + "url": "https://opensearch.org/docs/latest/security/access-control/api/#create-user" + }, + "operationId": "CreateUser", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/User" + } + } + }, + "required": true }, - "operationId": "ReindexRethrottle", "parameters": [ { - "name": "task_id", + "name": "username", "in": "path", - "description": "The task id to rethrottle.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", - "description": "The task id to rethrottle." - }, - "required": true - }, - { - "name": "requests_per_second", - "in": "query", - "description": "The throttle for this request in sub-requests per second. -1 means no throttle.", "schema": { - "type": "integer", - "description": "The throttle for this request in sub-requests per second. -1 means no throttle.", - "format": "int32" + "type": "string" }, "required": true } ], "responses": { "200": { - "description": "ReindexRethrottle 200 response" + "description": "CreateUser 200 response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateUserResponseContent" + } + } + } } }, - "x-operation-group": "reindex_rethrottle", + "x-operation-group": "security.create_user", "x-version-added": "1.0" } }, - "/_remote/info": { + "/_plugins/_security/api/nodesdn": { "get": { - "description": "Returns the information about configured remote clusters.", + "description": "Retrieves all distinguished names in the allow list.", "externalDocs": { "description": "API Reference", - "url": "https://opensearch.org/docs/latest" + "url": "https://opensearch.org/docs/latest/security/access-control/api/#get-distinguished-names" }, - "operationId": "ClusterRemoteInfo", + "operationId": "GetDistinguishedNames", "responses": { "200": { - "description": "ClusterRemoteInfo 200 response" + "description": "GetDistinguishedNames 200 response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DistinguishedNamesMap" + } + } + } } }, - "x-operation-group": "cluster.remote_info", + "x-operation-group": "security.get_distinguished_names", "x-version-added": "1.0" - } - }, - "/_remotestore/_restore": { - "post": { - "description": "Restores from remote store.", + }, + "patch": { + "description": "Bulk update of distinguished names.", "externalDocs": { "description": "API Reference", - "url": "https://opensearch.org/docs/latest/opensearch/remote/#restoring-from-a-backup" + "url": "https://opensearch.org/docs/latest/security/access-control/api/#update-all-distinguished-names" }, - "operationId": "RemoteStoreRestore", + "operationId": "PatchDistinguishedNames", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/RemoteStoreRestore_BodyParams" - }, - "examples": { - "RemoteStoreRestore_example1": { - "summary": "Examples for Post Remote Storage Restore Operation.", - "description": "", - "value": { - "indices": [ - "books" - ] - } - } + "$ref": "#/components/schemas/PatchDistinguishedNamesInputPayload" } } }, "required": true }, - "parameters": [ - { - "name": "cluster_manager_timeout", - "in": "query", - "description": "Operation timeout for connection to cluster-manager node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to cluster-manager node.", - "x-data-type": "time" - } - }, - { - "name": "wait_for_completion", - "in": "query", - "description": "Should this request wait until the operation has completed before returning.", - "schema": { - "type": "boolean", - "default": false, - "description": "Should this request wait until the operation has completed before returning." - } - } - ], "responses": { "200": { - "description": "RemoteStoreRestore 200 response", + "description": "PatchDistinguishedNames 200 response", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/RemoteStoreRestoreResponseContent" - }, - "examples": { - "RemoteStoreRestore_example1": { - "summary": "Examples for Post Remote Storage Restore Operation.", - "description": "", - "value": { - "remote_store": { - "indices": [ - "books" - ], - "shards": { - "total": 1, - "failed": 0, - "successful": 1 - } - } - } - } + "$ref": "#/components/schemas/PatchDistinguishedNamesResponseContent" } } } } }, - "x-operation-group": "remote_store.restore", + "x-operation-group": "security.patch_distinguished_names", "x-version-added": "1.0" } }, - "/_render/template": { - "get": { - "description": "Allows to use the Mustache language to pre-render a search definition.", + "/_plugins/_security/api/nodesdn/{cluster_name}": { + "delete": { + "description": "Deletes all distinguished names in the specified cluster’s or node’s allow list.", "externalDocs": { "description": "API Reference", - "url": "https://opensearch.org/docs/latest" + "url": "https://opensearch.org/docs/latest/security/access-control/api/#delete-distinguished-names" }, - "operationId": "RenderSearchTemplate_Get", + "operationId": "DeleteDistinguishedNames", + "parameters": [ + { + "name": "cluster_name", + "in": "path", + "schema": { + "type": "string" + }, + "required": true + } + ], "responses": { "200": { - "description": "RenderSearchTemplate_Get 200 response" - } - }, - "x-operation-group": "render_search_template", - "x-version-added": "1.0" - }, - "post": { - "description": "Allows to use the Mustache language to pre-render a search definition.", - "operationId": "RenderSearchTemplate_Post", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/RenderSearchTemplate_BodyParams" + "description": "DeleteDistinguishedNames 200 response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DeleteDistinguishedNamesResponseContent" + } } } } }, - "responses": { - "200": { - "description": "RenderSearchTemplate_Post 200 response" - } - }, - "x-operation-group": "render_search_template", + "x-operation-group": "security.delete_distinguished_names", "x-version-added": "1.0" - } - }, - "/_render/template/{id}": { + }, "get": { - "description": "Allows to use the Mustache language to pre-render a search definition.", - "operationId": "RenderSearchTemplate_Get_WithId", + "description": "Retrieve distinguished names of a specified cluster.", + "operationId": "GetDistinguishedNamesWithClusterName", "parameters": [ { - "name": "id", + "name": "cluster_name", "in": "path", - "description": "The id of the stored search template.", "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", - "description": "The id of the stored search template." + "type": "string" }, "required": true } ], "responses": { "200": { - "description": "RenderSearchTemplate_Get_WithId 200 response" + "description": "GetDistinguishedNamesWithClusterName 200 response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DistinguishedNamesMap" + } + } + } } }, - "x-operation-group": "render_search_template", + "x-operation-group": "security.get_distinguished_names", "x-version-added": "1.0" }, - "post": { - "description": "Allows to use the Mustache language to pre-render a search definition.", - "operationId": "RenderSearchTemplate_Post_WithId", + "put": { + "description": "Adds or updates the specified distinguished names in the cluster’s or node’s allow list.", + "externalDocs": { + "description": "API Reference", + "url": "https://opensearch.org/docs/latest/security/access-control/api/#update-distinguished-names" + }, + "operationId": "UpdateDistinguishedNames", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/RenderSearchTemplate_BodyParams" + "$ref": "#/components/schemas/DistinguishedNames" } } } }, "parameters": [ { - "name": "id", + "name": "cluster_name", "in": "path", - "description": "The id of the stored search template.", "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", - "description": "The id of the stored search template." + "type": "string" }, "required": true } ], "responses": { "200": { - "description": "RenderSearchTemplate_Post_WithId 200 response" + "description": "UpdateDistinguishedNames 200 response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpdateDistinguishedNamesResponseContent" + } + } + } } }, - "x-operation-group": "render_search_template", + "x-operation-group": "security.update_distinguished_names", "x-version-added": "1.0" } }, - "/_resolve/index/{name}": { - "get": { - "description": "Returns information about any matching indices, aliases, and data streams.", + "/_plugins/_security/api/roles": { + "patch": { + "description": "Creates, updates, or deletes multiple roles in a single call.", "externalDocs": { "description": "API Reference", - "url": "https://opensearch.org/docs/latest" + "url": "https://opensearch.org/docs/latest/security/access-control/api/#patch-roles" }, - "operationId": "IndicesResolveIndex", - "parameters": [ - { - "name": "name", - "in": "path", - "description": "Comma-separated list of names or wildcard expressions.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", - "description": "Comma-separated list of names or wildcard expressions.", - "x-data-type": "array" - }, - "required": true - }, - { - "name": "expand_wildcards", - "in": "query", - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", - "schema": { - "$ref": "#/components/schemas/ExpandWildcards" + "operationId": "PatchRoles", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PatchRolesInputPayload" + } } - } - ], - "responses": { - "200": { - "description": "IndicesResolveIndex 200 response" - } - }, - "x-operation-group": "indices.resolve_index", - "x-version-added": "1.0" - } - }, - "/_script_context": { - "get": { - "description": "Returns all script contexts.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest" + }, + "required": true }, - "operationId": "GetScriptContext", "responses": { "200": { - "description": "GetScriptContext 200 response" + "description": "PatchRoles 200 response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PatchRolesResponseContent" + } + } + } } }, - "x-operation-group": "get_script_context", + "x-operation-group": "security.patch_roles", "x-version-added": "1.0" } }, - "/_script_language": { + "/_plugins/_security/api/roles/": { "get": { - "description": "Returns available script types, languages and contexts.", + "description": "Retrieves all roles.", "externalDocs": { "description": "API Reference", - "url": "https://opensearch.org/docs/latest" + "url": "https://opensearch.org/docs/latest/security/access-control/api/#get-roles" }, - "operationId": "GetScriptLanguages", + "operationId": "GetRoles", "responses": { "200": { - "description": "GetScriptLanguages 200 response" + "description": "GetRoles 200 response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RolesMap" + } + } + } } }, - "x-operation-group": "get_script_languages", + "x-operation-group": "security.get_roles", "x-version-added": "1.0" } }, - "/_scripts/painless/_execute": { - "get": { - "description": "Allows an arbitrary script to be executed and a result to be returned.", + "/_plugins/_security/api/roles/{role}": { + "delete": { + "description": "Delete the specified role.", "externalDocs": { "description": "API Reference", - "url": "https://opensearch.org/docs/latest" + "url": "https://opensearch.org/docs/latest/security/access-control/api/#delete-role" }, - "operationId": "ScriptsPainlessExecute_Get", + "operationId": "DeleteRole", + "parameters": [ + { + "name": "role", + "in": "path", + "schema": { + "type": "string" + }, + "required": true + } + ], "responses": { "200": { - "description": "ScriptsPainlessExecute_Get 200 response" - } - }, - "x-operation-group": "scripts_painless_execute", - "x-version-added": "1.0" - }, - "post": { - "description": "Allows an arbitrary script to be executed and a result to be returned.", - "operationId": "ScriptsPainlessExecute_Post", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ScriptsPainlessExecute_BodyParams" + "description": "DeleteRole 200 response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DeleteRoleResponseContent" + } } } } }, - "responses": { - "200": { - "description": "ScriptsPainlessExecute_Post 200 response" - } - }, - "x-operation-group": "scripts_painless_execute", + "x-operation-group": "security.delete_role", "x-version-added": "1.0" - } - }, - "/_scripts/{id}": { - "delete": { - "description": "Deletes a script.", + }, + "get": { + "description": "Retrieves one role.", "externalDocs": { "description": "API Reference", - "url": "https://opensearch.org/docs/latest" + "url": "https://opensearch.org/docs/latest/security/access-control/api/#get-role" }, - "operationId": "DeleteScript", + "operationId": "GetRole", "parameters": [ { - "name": "id", + "name": "role", "in": "path", - "description": "Script ID.", "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", - "description": "Script ID." + "type": "string" }, "required": true - }, - { - "name": "timeout", - "in": "query", - "description": "Operation timeout.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout.", - "x-data-type": "time" - } - }, - { - "name": "master_timeout", - "in": "query", - "description": "Operation timeout for connection to master node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to master node.", - "x-version-deprecated": "2.0.0", - "x-data-type": "time", - "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", - "deprecated": true - } - }, - { - "name": "cluster_manager_timeout", - "in": "query", - "description": "Operation timeout for connection to cluster-manager node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to cluster-manager node.", - "x-data-type": "time" - } } ], "responses": { "200": { - "description": "DeleteScript 200 response" + "description": "GetRole 200 response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RolesMap" + } + } + } } }, - "x-operation-group": "delete_script", + "x-operation-group": "security.get_role", "x-version-added": "1.0" }, - "get": { - "description": "Returns a script.", + "patch": { + "description": "Updates individual attributes of a role.", "externalDocs": { "description": "API Reference", - "url": "https://opensearch.org/docs/latest" + "url": "https://opensearch.org/docs/latest/security/access-control/api/#patch-role" + }, + "operationId": "PatchRole", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PatchRoleInputPayload" + } + } + }, + "required": true }, - "operationId": "GetScript", "parameters": [ { - "name": "id", + "name": "role", "in": "path", - "description": "Script ID.", "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", - "description": "Script ID." + "type": "string" }, "required": true - }, - { - "name": "master_timeout", - "in": "query", - "description": "Operation timeout for connection to master node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to master node.", - "x-version-deprecated": "2.0.0", - "x-data-type": "time", - "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", - "deprecated": true - } - }, - { - "name": "cluster_manager_timeout", - "in": "query", - "description": "Operation timeout for connection to cluster-manager node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to cluster-manager node.", - "x-data-type": "time" - } } ], "responses": { "200": { - "description": "GetScript 200 response" + "description": "PatchRole 200 response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PatchRoleResponseContent" + } + } + } } }, - "x-operation-group": "get_script", + "x-operation-group": "security.patch_role", "x-version-added": "1.0" }, - "post": { - "description": "Creates or updates a script.", - "operationId": "PutScript_Post", + "put": { + "description": "Creates or replaces the specified role.", + "externalDocs": { + "description": "API Reference", + "url": "https://opensearch.org/docs/latest/security/access-control/api/#create-role" + }, + "operationId": "CreateRole", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/PutScript_BodyParams" + "$ref": "#/components/schemas/Role" } } }, @@ -12643,145 +12620,163 @@ }, "parameters": [ { - "name": "id", + "name": "role", "in": "path", - "description": "Script ID.", "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", - "description": "Script ID." + "type": "string" }, "required": true - }, - { - "name": "timeout", - "in": "query", - "description": "Operation timeout.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout.", - "x-data-type": "time" - } - }, - { - "name": "master_timeout", - "in": "query", - "description": "Operation timeout for connection to master node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to master node.", - "x-version-deprecated": "2.0.0", - "x-data-type": "time", - "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", - "deprecated": true - } - }, - { - "name": "cluster_manager_timeout", - "in": "query", - "description": "Operation timeout for connection to cluster-manager node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to cluster-manager node.", - "x-data-type": "time" - } } ], "responses": { "200": { - "description": "PutScript_Post 200 response" + "description": "CreateRole 200 response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateRoleResponseContent" + } + } + } } }, - "x-operation-group": "put_script", + "x-operation-group": "security.create_role", + "x-version-added": "1.0" + } + }, + "/_plugins/_security/api/rolesmapping": { + "get": { + "description": "Retrieves all role mappings.", + "externalDocs": { + "description": "API Reference", + "url": "https://opensearch.org/docs/latest/security/access-control/api/#get-role-mappings" + }, + "operationId": "GetRoleMappings", + "responses": { + "200": { + "description": "GetRoleMappings 200 response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RoleMappings" + } + } + } + } + }, + "x-operation-group": "security.get_role_mappings", "x-version-added": "1.0" }, - "put": { - "description": "Creates or updates a script.", + "patch": { + "description": "Creates or updates multiple role mappings in a single call.", "externalDocs": { "description": "API Reference", - "url": "https://opensearch.org/docs/latest" + "url": "https://opensearch.org/docs/latest/security/access-control/api/#patch-role-mappings" }, - "operationId": "PutScript_Put", + "operationId": "PatchRoleMappings", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/PutScript_BodyParams" + "$ref": "#/components/schemas/PatchRoleMappingsInputPayload" } } }, "required": true }, + "responses": { + "200": { + "description": "PatchRoleMappings 200 response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PatchRoleMappingsResponseContent" + } + } + } + } + }, + "x-operation-group": "security.patch_role_mappings", + "x-version-added": "1.0" + } + }, + "/_plugins/_security/api/rolesmapping/{role}": { + "delete": { + "description": "Deletes the specified role mapping.", + "externalDocs": { + "description": "API Reference", + "url": "https://opensearch.org/docs/latest/security/access-control/api/#delete-role-mapping" + }, + "operationId": "DeleteRoleMapping", "parameters": [ { - "name": "id", + "name": "role", "in": "path", - "description": "Script ID.", "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", - "description": "Script ID." + "type": "string" }, "required": true - }, - { - "name": "timeout", - "in": "query", - "description": "Operation timeout.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout.", - "x-data-type": "time" - } - }, - { - "name": "master_timeout", - "in": "query", - "description": "Operation timeout for connection to master node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to master node.", - "x-version-deprecated": "2.0.0", - "x-data-type": "time", - "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", - "deprecated": true + } + ], + "responses": { + "200": { + "description": "DeleteRoleMapping 200 response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DeleteRoleMappingResponseContent" + } + } } - }, + } + }, + "x-operation-group": "security.delete_role_mapping", + "x-version-added": "1.0" + }, + "get": { + "description": "Retrieves one role mapping.", + "externalDocs": { + "description": "API Reference", + "url": "https://opensearch.org/docs/latest/security/access-control/api/#get-role-mapping" + }, + "operationId": "GetRoleMapping", + "parameters": [ { - "name": "cluster_manager_timeout", - "in": "query", - "description": "Operation timeout for connection to cluster-manager node.", + "name": "role", + "in": "path", "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to cluster-manager node.", - "x-data-type": "time" - } + "type": "string" + }, + "required": true } ], "responses": { "200": { - "description": "PutScript_Put 200 response" + "description": "GetRoleMapping 200 response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RoleMappings" + } + } + } } }, - "x-operation-group": "put_script", + "x-operation-group": "security.get_role_mapping", "x-version-added": "1.0" - } - }, - "/_scripts/{id}/{context}": { - "post": { - "description": "Creates or updates a script.", - "operationId": "PutScript_Post_WithContext", + }, + "patch": { + "description": "Updates individual attributes of a role mapping.", + "externalDocs": { + "description": "API Reference", + "url": "https://opensearch.org/docs/latest/security/access-control/api/#patch-role-mapping" + }, + "operationId": "PatchRoleMapping", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/PutScript_BodyParams" + "$ref": "#/components/schemas/PatchRoleMappingInputPayload" } } }, @@ -12789,80 +12784,41 @@ }, "parameters": [ { - "name": "id", - "in": "path", - "description": "Script ID.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", - "description": "Script ID." - }, - "required": true - }, - { - "name": "context", + "name": "role", "in": "path", - "description": "Script context.", "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", - "description": "Script context." + "type": "string" }, "required": true - }, - { - "name": "timeout", - "in": "query", - "description": "Operation timeout.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout.", - "x-data-type": "time" - } - }, - { - "name": "master_timeout", - "in": "query", - "description": "Operation timeout for connection to master node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to master node.", - "x-version-deprecated": "2.0.0", - "x-data-type": "time", - "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", - "deprecated": true - } - }, - { - "name": "cluster_manager_timeout", - "in": "query", - "description": "Operation timeout for connection to cluster-manager node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to cluster-manager node.", - "x-data-type": "time" - } } ], "responses": { "200": { - "description": "PutScript_Post_WithContext 200 response" + "description": "PatchRoleMapping 200 response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PatchRoleMappingResponseContent" + } + } + } } }, - "x-operation-group": "put_script", + "x-operation-group": "security.patch_role_mapping", "x-version-added": "1.0" }, "put": { - "description": "Creates or updates a script.", - "operationId": "PutScript_Put_WithContext", + "description": "Creates or replaces the specified role mapping.", + "externalDocs": { + "description": "API Reference", + "url": "https://opensearch.org/docs/latest/security/access-control/api/#create-role-mapping" + }, + "operationId": "CreateRoleMapping", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/PutScript_BodyParams" + "$ref": "#/components/schemas/RoleMapping" } } }, @@ -12870,262 +12826,454 @@ }, "parameters": [ { - "name": "id", - "in": "path", - "description": "Script ID.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", - "description": "Script ID." - }, - "required": true - }, - { - "name": "context", + "name": "role", "in": "path", - "description": "Script context.", "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", - "description": "Script context." + "type": "string" }, "required": true - }, - { - "name": "timeout", - "in": "query", - "description": "Operation timeout.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout.", - "x-data-type": "time" - } - }, - { - "name": "master_timeout", - "in": "query", - "description": "Operation timeout for connection to master node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to master node.", - "x-version-deprecated": "2.0.0", - "x-data-type": "time", - "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", - "deprecated": true - } - }, - { - "name": "cluster_manager_timeout", - "in": "query", - "description": "Operation timeout for connection to cluster-manager node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to cluster-manager node.", - "x-data-type": "time" - } } ], "responses": { "200": { - "description": "PutScript_Put_WithContext 200 response" + "description": "CreateRoleMapping 200 response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateRoleMappingResponseContent" + } + } + } } }, - "x-operation-group": "put_script", + "x-operation-group": "security.create_role_mapping", "x-version-added": "1.0" } }, - "/_search": { + "/_plugins/_security/api/securityconfig": { "get": { - "description": "Returns results matching a query.", + "description": "Returns the current Security plugin configuration in JSON format.", "externalDocs": { "description": "API Reference", - "url": "https://opensearch.org/docs/latest/api-reference/search/" + "url": "https://opensearch.org/docs/2.7/security/access-control/api/#get-configuration" }, - "operationId": "Search_Get", - "parameters": [ - { - "name": "analyzer", - "in": "query", - "description": "The analyzer to use for the query string.", - "schema": { - "type": "string", - "description": "The analyzer to use for the query string." + "operationId": "GetConfiguration", + "responses": { + "200": { + "description": "GetConfiguration 200 response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DynamicConfig" + } + } } - }, - { - "name": "analyze_wildcard", - "in": "query", - "description": "Specify whether wildcard and prefix queries should be analyzed.", - "schema": { - "type": "boolean", - "default": false, - "description": "Specify whether wildcard and prefix queries should be analyzed." + } + }, + "x-operation-group": "security.get_configuration", + "x-version-added": "1.0" + }, + "patch": { + "description": "A PATCH call is used to update the existing configuration using the REST API.", + "externalDocs": { + "description": "API Reference", + "url": "https://opensearch.org/docs/2.7/security/access-control/api/#patch-configuration" + }, + "operationId": "PatchConfiguration", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PatchConfigurationInputPayload" + } } }, - { - "name": "ccs_minimize_roundtrips", - "in": "query", - "description": "Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution.", - "schema": { - "type": "boolean", - "default": true, - "description": "Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution." + "required": true + }, + "responses": { + "200": { + "description": "PatchConfiguration 200 response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PatchConfigurationResponseContent" + } + } } - }, - { - "name": "default_operator", - "in": "query", - "description": "The default operator for query string query (AND or OR).", - "schema": { - "$ref": "#/components/schemas/DefaultOperator" + } + }, + "x-operation-group": "security.patch_configuration", + "x-version-added": "1.0" + } + }, + "/_plugins/_security/api/securityconfig/config": { + "put": { + "description": "Adds or updates the existing configuration using the REST API.", + "externalDocs": { + "description": "API Reference", + "url": "https://opensearch.org/docs/2.7/security/access-control/api/#update-configuration" + }, + "operationId": "UpdateConfiguration", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DynamicConfig" + } } }, - { - "name": "df", - "in": "query", - "description": "The field to use as default where no field prefix is given in the query string.", - "schema": { - "type": "string", - "description": "The field to use as default where no field prefix is given in the query string." + "required": true + }, + "responses": { + "200": { + "description": "UpdateConfiguration 200 response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpdateConfigurationResponseContent" + } + } } - }, - { - "name": "explain", - "in": "query", - "description": "Specify whether to return detailed information about score computation as part of a hit.", - "schema": { - "type": "boolean", - "description": "Specify whether to return detailed information about score computation as part of a hit." + } + }, + "x-operation-group": "security.update_configuration", + "x-version-added": "1.0" + } + }, + "/_plugins/_security/api/ssl/certs": { + "get": { + "description": "Retrieves the cluster’s security certificates.", + "externalDocs": { + "description": "API Reference", + "url": "https://opensearch.org/docs/latest/security/access-control/api/#get-certificates" + }, + "operationId": "GetCertificates", + "responses": { + "200": { + "description": "GetCertificates 200 response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GetCertificatesResponseContent" + } + } } - }, - { - "name": "stored_fields", - "in": "query", - "description": "Comma-separated list of stored fields to return.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of stored fields to return." - }, - "explode": true - }, - { - "name": "docvalue_fields", - "in": "query", - "description": "Comma-separated list of fields to return as the docvalue representation of a field for each hit.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of fields to return as the docvalue representation of a field for each hit." - }, - "explode": true - }, - { - "name": "from", - "in": "query", - "description": "Starting offset.", - "schema": { - "type": "integer", - "default": 0, - "description": "Starting offset.", - "format": "int32" + } + }, + "x-operation-group": "security.get_certificates", + "x-version-added": "1.0" + } + }, + "/_plugins/_security/api/ssl/http/reloadcerts": { + "put": { + "description": "Reload HTTP layer communication certificates.", + "externalDocs": { + "description": "API Reference", + "url": "https://opensearch.org/docs/latest/security/access-control/api/#reload-http-certificates" + }, + "operationId": "ReloadHttpCertificates", + "responses": { + "200": { + "description": "ReloadHttpCertificates 200 response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ReloadHttpCertificatesResponseContent" + } + } } - }, - { - "name": "ignore_unavailable", - "in": "query", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", - "schema": { - "type": "boolean", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." + } + }, + "x-operation-group": "security.reload_http_certificates", + "x-version-added": "1.0" + } + }, + "/_plugins/_security/api/ssl/transport/reloadcerts": { + "put": { + "description": "Reload transport layer communication certificates.", + "externalDocs": { + "description": "API Reference", + "url": "https://opensearch.org/docs/latest/security/access-control/api/#reload-transport-certificates" + }, + "operationId": "ReloadTransportCertificates", + "responses": { + "200": { + "description": "ReloadTransportCertificates 200 response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ReloadTransportCertificatesResponseContent" + } + } } - }, - { - "name": "ignore_throttled", - "in": "query", - "description": "Whether specified concrete, expanded or aliased indices should be ignored when throttled.", - "schema": { - "type": "boolean", - "description": "Whether specified concrete, expanded or aliased indices should be ignored when throttled." + } + }, + "x-operation-group": "security.reload_transport_certificates", + "x-version-added": "1.0" + } + }, + "/_plugins/_security/api/tenants/": { + "get": { + "description": "Retrieves all tenants.", + "externalDocs": { + "description": "API Reference", + "url": "https://opensearch.org/docs/2.7/security/access-control/api/#get-tenants" + }, + "operationId": "GetTenants", + "responses": { + "200": { + "description": "GetTenants 200 response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TenantsMap" + } + } } - }, - { - "name": "allow_no_indices", - "in": "query", - "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified).", - "schema": { - "type": "boolean", - "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)." + } + }, + "x-operation-group": "security.get_tenants", + "x-version-added": "1.0" + }, + "patch": { + "description": "Add, delete, or modify multiple tenants in a single call.", + "externalDocs": { + "description": "API Reference", + "url": "https://opensearch.org/docs/2.7/security/access-control/api/#patch-tenants" + }, + "operationId": "PatchTenants", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PatchTenantsInputPayload" + } } }, + "required": true + }, + "responses": { + "200": { + "description": "PatchTenants 200 response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PatchTenantsResponseContent" + } + } + } + } + }, + "x-operation-group": "security.patch_tenants", + "x-version-added": "1.0" + } + }, + "/_plugins/_security/api/tenants/{tenant}": { + "delete": { + "description": "Delete the specified tenant.", + "externalDocs": { + "description": "API Reference", + "url": "https://opensearch.org/docs/latest/security/access-control/api/#delete-action-group" + }, + "operationId": "DeleteTenant", + "parameters": [ { - "name": "expand_wildcards", - "in": "query", - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", + "name": "tenant", + "in": "path", "schema": { - "$ref": "#/components/schemas/ExpandWildcards" + "type": "string" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "DeleteTenant 200 response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DeleteTenantResponseContent" + } + } } - }, + } + }, + "x-operation-group": "security.delete_tenant", + "x-version-added": "1.0" + }, + "get": { + "description": "Retrieves one tenant.", + "externalDocs": { + "description": "API Reference", + "url": "https://opensearch.org/docs/2.7/security/access-control/api/#get-tenant" + }, + "operationId": "GetTenant", + "parameters": [ { - "name": "lenient", - "in": "query", - "description": "Specify whether format-based query failures (such as providing text to a numeric field) should be ignored.", + "name": "tenant", + "in": "path", "schema": { - "type": "boolean", - "description": "Specify whether format-based query failures (such as providing text to a numeric field) should be ignored." + "type": "string" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "GetTenant 200 response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TenantsMap" + } + } + } + } + }, + "x-operation-group": "security.get_tenant", + "x-version-added": "1.0" + }, + "patch": { + "description": "Add, delete, or modify a single tenant.", + "externalDocs": { + "description": "API Reference", + "url": "https://opensearch.org/docs/2.7/security/access-control/api/#patch-tenant" + }, + "operationId": "PatchTenant", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PatchTenantInputPayload" + } } }, + "required": true + }, + "parameters": [ { - "name": "preference", - "in": "query", - "description": "Specify the node or shard the operation should be performed on.", + "name": "tenant", + "in": "path", "schema": { - "type": "string", - "default": "random", - "description": "Specify the node or shard the operation should be performed on." + "type": "string" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "PatchTenant 200 response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PatchTenantResponseContent" + } + } } - }, + } + }, + "x-operation-group": "security.patch_tenant", + "x-version-added": "1.0" + }, + "put": { + "description": "Creates or replaces the specified tenant.", + "externalDocs": { + "description": "API Reference", + "url": "https://opensearch.org/docs/2.7/security/access-control/api/#create-tenant" + }, + "operationId": "CreateTenant", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateTenantParams" + } + } + } + }, + "parameters": [ { - "name": "q", + "name": "tenant", + "in": "path", + "schema": { + "type": "string" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "CreateTenant 200 response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateTenantResponseContent" + } + } + } + } + }, + "x-operation-group": "security.create_tenant", + "x-version-added": "1.0" + } + }, + "/_plugins/_security/health": { + "get": { + "description": "Checks to see if the Security plugin is up and running.", + "externalDocs": { + "description": "API Reference", + "url": "https://opensearch.org/docs/latest/security/access-control/api/#health-check" + }, + "operationId": "SecurityHealth", + "responses": { + "200": { + "description": "SecurityHealth 200 response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SecurityHealthResponseContent" + } + } + } + } + }, + "x-operation-group": "security.health", + "x-version-added": "1.0" + } + }, + "/_rank_eval": { + "get": { + "description": "Allows to evaluate the quality of ranked search results over a set of typical search queries.", + "externalDocs": { + "description": "API Reference", + "url": "https://opensearch.org/docs/latest/api-reference/rank-eval/" + }, + "operationId": "RankEval_Get", + "parameters": [ + { + "name": "ignore_unavailable", "in": "query", - "description": "Query in the Lucene query string syntax.", + "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", "schema": { - "type": "string", - "description": "Query in the Lucene query string syntax." + "type": "boolean", + "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." } }, { - "name": "routing", + "name": "allow_no_indices", "in": "query", - "description": "Comma-separated list of specific routing values.", - "style": "form", + "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified).", "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of specific routing values." - }, - "explode": true + "type": "boolean", + "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)." + } }, { - "name": "scroll", + "name": "expand_wildcards", "in": "query", - "description": "Specify how long a consistent view of the index should be maintained for scrolled search.", + "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Specify how long a consistent view of the index should be maintained for scrolled search.", - "x-data-type": "time" + "$ref": "#/components/schemas/ExpandWildcards" } }, { @@ -13135,618 +13283,1040 @@ "schema": { "$ref": "#/components/schemas/SearchType" } - }, - { - "name": "size", - "in": "query", - "description": "Number of hits to return.", - "schema": { - "type": "integer", - "default": 10, - "description": "Number of hits to return.", - "format": "int32" + } + ], + "responses": { + "200": { + "description": "RankEval_Get 200 response" + } + }, + "x-operation-group": "rank_eval", + "x-version-added": "1.0" + }, + "post": { + "description": "Allows to evaluate the quality of ranked search results over a set of typical search queries.", + "operationId": "RankEval_Post", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RankEval_BodyParams" + } } }, + "required": true + }, + "parameters": [ { - "name": "sort", - "in": "query", - "description": "Comma-separated list of : pairs.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of : pairs." - }, - "explode": true - }, - { - "name": "_source", + "name": "ignore_unavailable", "in": "query", - "description": "True or false to return the _source field or not, or a list of fields to return.", - "style": "form", + "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "True or false to return the _source field or not, or a list of fields to return." - }, - "explode": true + "type": "boolean", + "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." + } }, { - "name": "_source_excludes", + "name": "allow_no_indices", "in": "query", - "description": "List of fields to exclude from the returned _source field.", - "style": "form", + "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified).", "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "List of fields to exclude from the returned _source field." - }, - "explode": true + "type": "boolean", + "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)." + } }, { - "name": "_source_includes", + "name": "expand_wildcards", "in": "query", - "description": "List of fields to extract and return from the _source field.", - "style": "form", + "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "List of fields to extract and return from the _source field." - }, - "explode": true + "$ref": "#/components/schemas/ExpandWildcards" + } }, { - "name": "terminate_after", + "name": "search_type", "in": "query", - "description": "The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early.", + "description": "Search operation type.", "schema": { - "type": "integer", - "description": "The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early.", - "format": "int32" + "$ref": "#/components/schemas/SearchType" } - }, + } + ], + "responses": { + "200": { + "description": "RankEval_Post 200 response" + } + }, + "x-operation-group": "rank_eval", + "x-version-added": "1.0" + } + }, + "/_recovery": { + "get": { + "description": "Returns information about ongoing index shard recoveries.", + "externalDocs": { + "description": "API Reference", + "url": "https://opensearch.org/docs/latest" + }, + "operationId": "IndicesRecovery", + "parameters": [ { - "name": "stats", + "name": "detailed", "in": "query", - "description": "Specific 'tag' of the request for logging and statistical purposes.", - "style": "form", + "description": "Whether to display detailed information about shard recovery.", "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Specific 'tag' of the request for logging and statistical purposes." - }, - "explode": true + "type": "boolean", + "default": false, + "description": "Whether to display detailed information about shard recovery." + } }, { - "name": "suggest_field", + "name": "active_only", "in": "query", - "description": "Specify which field to use for suggestions.", + "description": "Display only those recoveries that are currently on-going.", "schema": { - "type": "string", - "description": "Specify which field to use for suggestions." + "type": "boolean", + "default": false, + "description": "Display only those recoveries that are currently on-going." } - }, + } + ], + "responses": { + "200": { + "description": "IndicesRecovery 200 response" + } + }, + "x-operation-group": "indices.recovery", + "x-version-added": "1.0" + } + }, + "/_refresh": { + "get": { + "description": "Performs the refresh operation in one or more indices.", + "operationId": "IndicesRefresh_Get", + "parameters": [ { - "name": "suggest_mode", + "name": "ignore_unavailable", "in": "query", - "description": "Specify suggest mode.", + "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", "schema": { - "$ref": "#/components/schemas/SuggestMode" + "type": "boolean", + "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." } }, { - "name": "suggest_size", + "name": "allow_no_indices", "in": "query", - "description": "How many suggestions to return in response.", + "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified).", "schema": { - "type": "integer", - "description": "How many suggestions to return in response.", - "format": "int32" + "type": "boolean", + "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)." } }, { - "name": "suggest_text", + "name": "expand_wildcards", "in": "query", - "description": "The source text for which the suggestions should be returned.", + "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", "schema": { - "type": "string", - "description": "The source text for which the suggestions should be returned." + "$ref": "#/components/schemas/ExpandWildcards" } - }, + } + ], + "responses": { + "200": { + "description": "IndicesRefresh_Get 200 response" + } + }, + "x-operation-group": "indices.refresh", + "x-version-added": "1.0" + }, + "post": { + "description": "Performs the refresh operation in one or more indices.", + "externalDocs": { + "description": "API Reference", + "url": "https://opensearch.org/docs/latest/tuning-your-cluster/availability-and-recovery/remote-store/index/#refresh-level-and-request-level-durability" + }, + "operationId": "IndicesRefresh_Post", + "parameters": [ { - "name": "timeout", + "name": "ignore_unavailable", "in": "query", - "description": "Operation timeout.", + "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout.", - "x-data-type": "time" + "type": "boolean", + "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." } }, { - "name": "track_scores", + "name": "allow_no_indices", "in": "query", - "description": "Whether to calculate and return scores even if they are not used for sorting.", + "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified).", "schema": { "type": "boolean", - "description": "Whether to calculate and return scores even if they are not used for sorting." + "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)." } }, { - "name": "track_total_hits", + "name": "expand_wildcards", "in": "query", - "description": "Indicate if the number of documents that match the query should be tracked.", + "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", "schema": { - "type": "boolean", - "description": "Indicate if the number of documents that match the query should be tracked." + "$ref": "#/components/schemas/ExpandWildcards" + } + } + ], + "responses": { + "200": { + "description": "IndicesRefresh_Post 200 response" + } + }, + "x-operation-group": "indices.refresh", + "x-version-added": "1.0" + } + }, + "/_reindex": { + "post": { + "description": "Allows to copy documents from one index to another, optionally filtering the source\ndocuments by a query, changing the destination index settings, or fetching the\ndocuments from a remote cluster.", + "externalDocs": { + "description": "API Reference", + "url": "https://opensearch.org/docs/latest/im-plugin/reindex-data/" + }, + "operationId": "Reindex", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Reindex_BodyParams" + } } }, + "required": true + }, + "parameters": [ { - "name": "allow_partial_search_results", + "name": "refresh", "in": "query", - "description": "Indicate if an error should be returned if there is a partial search failure or timeout.", + "description": "Should the affected indexes be refreshed?.", "schema": { "type": "boolean", - "default": true, - "description": "Indicate if an error should be returned if there is a partial search failure or timeout." + "description": "Should the affected indexes be refreshed?." } }, { - "name": "typed_keys", + "name": "timeout", "in": "query", - "description": "Specify whether aggregation and suggester names should be prefixed by their respective types in the response.", + "description": "Time each individual bulk request should wait for shards that are unavailable.", "schema": { - "type": "boolean", - "description": "Specify whether aggregation and suggester names should be prefixed by their respective types in the response." + "type": "string", + "default": "1m", + "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", + "description": "Time each individual bulk request should wait for shards that are unavailable.", + "x-data-type": "time" } }, { - "name": "version", + "name": "wait_for_active_shards", "in": "query", - "description": "Whether to return document version as part of a hit.", + "description": "Sets the number of shard copies that must be active before proceeding with the operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1).", "schema": { - "type": "boolean", - "description": "Whether to return document version as part of a hit." + "type": "string", + "default": "1", + "description": "Sets the number of shard copies that must be active before proceeding with the operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1)." } }, { - "name": "seq_no_primary_term", + "name": "wait_for_completion", "in": "query", - "description": "Specify whether to return sequence number and primary term of the last modification of each hit.", + "description": "Should this request wait until the operation has completed before returning.", "schema": { "type": "boolean", - "description": "Specify whether to return sequence number and primary term of the last modification of each hit." + "default": true, + "description": "Should this request wait until the operation has completed before returning." } }, { - "name": "request_cache", + "name": "requests_per_second", "in": "query", - "description": "Specify if request cache should be used for this request or not, defaults to index level setting.", + "description": "The throttle for this request in sub-requests per second. -1 means no throttle.", "schema": { - "type": "boolean", - "description": "Specify if request cache should be used for this request or not, defaults to index level setting." + "type": "integer", + "default": 0, + "description": "The throttle for this request in sub-requests per second. -1 means no throttle.", + "format": "int32" } }, { - "name": "batched_reduce_size", + "name": "scroll", "in": "query", - "description": "The number of shard results that should be reduced at once on the coordinating node. This value should be used as a protection mechanism to reduce the memory overhead per search request if the potential number of shards in the request can be large.", + "description": "Specify how long a consistent view of the index should be maintained for scrolled search.", "schema": { - "type": "integer", - "default": 512, - "description": "The number of shard results that should be reduced at once on the coordinating node. This value should be used as a protection mechanism to reduce the memory overhead per search request if the potential number of shards in the request can be large.", - "format": "int32" + "type": "string", + "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", + "description": "Specify how long a consistent view of the index should be maintained for scrolled search.", + "x-data-type": "time" } }, { - "name": "max_concurrent_shard_requests", + "name": "slices", "in": "query", - "description": "The number of concurrent shard requests per node this search executes concurrently. This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests.", + "description": "The number of slices this task should be divided into. Defaults to 1, meaning the task isn't sliced into subtasks. Can be set to `auto`.", "schema": { - "type": "integer", - "default": 5, - "description": "The number of concurrent shard requests per node this search executes concurrently. This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests.", - "format": "int32" + "type": "string", + "default": "1", + "description": "The number of slices this task should be divided into. Defaults to 1, meaning the task isn't sliced into subtasks. Can be set to `auto`." } }, { - "name": "pre_filter_shard_size", + "name": "max_docs", "in": "query", - "description": "Threshold that enforces a pre-filter round-trip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter round-trip can limit the number of shards significantly if for instance a shard can not match any documents based on its rewrite method ie. if date filters are mandatory to match but the shard bounds and the query are disjoint.", + "description": "Maximum number of documents to process (default: all documents).", "schema": { "type": "integer", - "description": "Threshold that enforces a pre-filter round-trip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter round-trip can limit the number of shards significantly if for instance a shard can not match any documents based on its rewrite method ie. if date filters are mandatory to match but the shard bounds and the query are disjoint.", + "description": "Maximum number of documents to process (default: all documents).", "format": "int32" } + } + ], + "responses": { + "200": { + "description": "Reindex 200 response" + } + }, + "x-operation-group": "reindex", + "x-version-added": "1.0" + } + }, + "/_reindex/{task_id}/_rethrottle": { + "post": { + "description": "Changes the number of requests per second for a particular Reindex operation.", + "externalDocs": { + "description": "API Reference", + "url": "https://opensearch.org/docs/latest" + }, + "operationId": "ReindexRethrottle", + "parameters": [ + { + "name": "task_id", + "in": "path", + "description": "The task id to rethrottle.", + "schema": { + "type": "string", + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", + "description": "The task id to rethrottle." + }, + "required": true }, { - "name": "rest_total_hits_as_int", + "name": "requests_per_second", "in": "query", - "description": "Indicates whether hits.total should be rendered as an integer or an object in the rest search response.", + "description": "The throttle for this request in sub-requests per second. -1 means no throttle.", "schema": { - "type": "boolean", - "default": false, - "description": "Indicates whether hits.total should be rendered as an integer or an object in the rest search response." - } + "type": "integer", + "description": "The throttle for this request in sub-requests per second. -1 means no throttle.", + "format": "int32" + }, + "required": true } ], "responses": { "200": { - "description": "Search_Get 200 response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Search_GetResponseContent" - } - } - } + "description": "ReindexRethrottle 200 response" } }, - "x-operation-group": "search", + "x-operation-group": "reindex_rethrottle", "x-version-added": "1.0" - }, + } + }, + "/_remote/info": { + "get": { + "description": "Returns the information about configured remote clusters.", + "externalDocs": { + "description": "API Reference", + "url": "https://opensearch.org/docs/latest/api-reference/remote-info/" + }, + "operationId": "ClusterRemoteInfo", + "responses": { + "200": { + "description": "ClusterRemoteInfo 200 response" + } + }, + "x-operation-group": "cluster.remote_info", + "x-version-added": "1.0" + } + }, + "/_remotestore/_restore": { "post": { - "description": "Returns results matching a query.", - "operationId": "Search_Post", + "description": "Restores from remote store.", + "externalDocs": { + "description": "API Reference", + "url": "https://opensearch.org/docs/latest/opensearch/remote/#restoring-from-a-backup" + }, + "operationId": "RemoteStoreRestore", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Search_BodyParams" + "$ref": "#/components/schemas/RemoteStoreRestore_BodyParams" }, "examples": { - "Search_Post_example1": { - "summary": "Examples for Post Search Operation.", + "RemoteStoreRestore_example1": { + "summary": "Examples for Post Remote Storage Restore Operation.", "description": "", "value": { - "query": { - "match_all": {} - }, - "fields": [ - "*" + "indices": [ + "books" ] } } } } - } + }, + "required": true }, "parameters": [ { - "name": "analyzer", + "name": "cluster_manager_timeout", "in": "query", - "description": "The analyzer to use for the query string.", + "description": "Operation timeout for connection to cluster-manager node.", "schema": { "type": "string", - "description": "The analyzer to use for the query string." + "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", + "description": "Operation timeout for connection to cluster-manager node.", + "x-data-type": "time" } }, { - "name": "analyze_wildcard", + "name": "wait_for_completion", "in": "query", - "description": "Specify whether wildcard and prefix queries should be analyzed.", + "description": "Should this request wait until the operation has completed before returning.", "schema": { "type": "boolean", "default": false, - "description": "Specify whether wildcard and prefix queries should be analyzed." + "description": "Should this request wait until the operation has completed before returning." } - }, - { - "name": "ccs_minimize_roundtrips", - "in": "query", - "description": "Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution.", - "schema": { - "type": "boolean", - "default": true, - "description": "Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution." + } + ], + "responses": { + "200": { + "description": "RemoteStoreRestore 200 response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RemoteStoreRestoreResponseContent" + }, + "examples": { + "RemoteStoreRestore_example1": { + "summary": "Examples for Post Remote Storage Restore Operation.", + "description": "", + "value": { + "remote_store": { + "indices": [ + "books" + ], + "shards": { + "total": 1, + "failed": 0, + "successful": 1 + } + } + } + } + } + } } - }, - { - "name": "default_operator", - "in": "query", - "description": "The default operator for query string query (AND or OR).", - "schema": { - "$ref": "#/components/schemas/DefaultOperator" + } + }, + "x-operation-group": "remote_store.restore", + "x-version-added": "1.0" + } + }, + "/_render/template": { + "get": { + "description": "Allows to use the Mustache language to pre-render a search definition.", + "externalDocs": { + "description": "API Reference", + "url": "https://opensearch.org/docs/latest/search-plugins/search-template/" + }, + "operationId": "RenderSearchTemplate_Get", + "responses": { + "200": { + "description": "RenderSearchTemplate_Get 200 response" + } + }, + "x-operation-group": "render_search_template", + "x-version-added": "1.0" + }, + "post": { + "description": "Allows to use the Mustache language to pre-render a search definition.", + "operationId": "RenderSearchTemplate_Post", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RenderSearchTemplate_BodyParams" + } } - }, - { - "name": "df", - "in": "query", - "description": "The field to use as default where no field prefix is given in the query string.", - "schema": { - "type": "string", - "description": "The field to use as default where no field prefix is given in the query string." - } - }, + } + }, + "responses": { + "200": { + "description": "RenderSearchTemplate_Post 200 response" + } + }, + "x-operation-group": "render_search_template", + "x-version-added": "1.0" + } + }, + "/_render/template/{id}": { + "get": { + "description": "Allows to use the Mustache language to pre-render a search definition.", + "operationId": "RenderSearchTemplate_Get_WithId", + "parameters": [ { - "name": "explain", - "in": "query", - "description": "Specify whether to return detailed information about score computation as part of a hit.", + "name": "id", + "in": "path", + "description": "The id of the stored search template.", "schema": { - "type": "boolean", - "description": "Specify whether to return detailed information about score computation as part of a hit." + "type": "string", + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", + "description": "The id of the stored search template." + }, + "required": true + } + ], + "responses": { + "200": { + "description": "RenderSearchTemplate_Get_WithId 200 response" + } + }, + "x-operation-group": "render_search_template", + "x-version-added": "1.0" + }, + "post": { + "description": "Allows to use the Mustache language to pre-render a search definition.", + "operationId": "RenderSearchTemplate_Post_WithId", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RenderSearchTemplate_BodyParams" + } } - }, + } + }, + "parameters": [ { - "name": "stored_fields", - "in": "query", - "description": "Comma-separated list of stored fields to return.", - "style": "form", + "name": "id", + "in": "path", + "description": "The id of the stored search template.", "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of stored fields to return." + "type": "string", + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", + "description": "The id of the stored search template." }, - "explode": true - }, + "required": true + } + ], + "responses": { + "200": { + "description": "RenderSearchTemplate_Post_WithId 200 response" + } + }, + "x-operation-group": "render_search_template", + "x-version-added": "1.0" + } + }, + "/_resolve/index/{name}": { + "get": { + "description": "Returns information about any matching indices, aliases, and data streams.", + "externalDocs": { + "description": "API Reference", + "url": "https://opensearch.org/docs/latest" + }, + "operationId": "IndicesResolveIndex", + "parameters": [ { - "name": "docvalue_fields", - "in": "query", - "description": "Comma-separated list of fields to return as the docvalue representation of a field for each hit.", - "style": "form", + "name": "name", + "in": "path", + "description": "Comma-separated list of names or wildcard expressions.", "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of fields to return as the docvalue representation of a field for each hit." + "type": "string", + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", + "description": "Comma-separated list of names or wildcard expressions.", + "x-data-type": "array" }, - "explode": true + "required": true }, { - "name": "from", + "name": "expand_wildcards", "in": "query", - "description": "Starting offset.", + "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", "schema": { - "type": "integer", - "default": 0, - "description": "Starting offset.", - "format": "int32" + "$ref": "#/components/schemas/ExpandWildcards" } - }, - { - "name": "ignore_unavailable", - "in": "query", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", - "schema": { - "type": "boolean", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." + } + ], + "responses": { + "200": { + "description": "IndicesResolveIndex 200 response" + } + }, + "x-operation-group": "indices.resolve_index", + "x-version-added": "1.0" + } + }, + "/_script_context": { + "get": { + "description": "Returns all script contexts.", + "externalDocs": { + "description": "API Reference", + "url": "https://opensearch.org/docs/latest/api-reference/script-apis/get-script-contexts/" + }, + "operationId": "GetScriptContext", + "responses": { + "200": { + "description": "GetScriptContext 200 response" + } + }, + "x-operation-group": "get_script_context", + "x-version-added": "1.0" + } + }, + "/_script_language": { + "get": { + "description": "Returns available script types, languages and contexts.", + "externalDocs": { + "description": "API Reference", + "url": "https://opensearch.org/docs/latest/api-reference/script-apis/get-script-language/" + }, + "operationId": "GetScriptLanguages", + "responses": { + "200": { + "description": "GetScriptLanguages 200 response" + } + }, + "x-operation-group": "get_script_languages", + "x-version-added": "1.0" + } + }, + "/_scripts/painless/_execute": { + "get": { + "description": "Allows an arbitrary script to be executed and a result to be returned.", + "externalDocs": { + "description": "API Reference", + "url": "https://opensearch.org/docs/latest/api-reference/script-apis/exec-script/" + }, + "operationId": "ScriptsPainlessExecute_Get", + "responses": { + "200": { + "description": "ScriptsPainlessExecute_Get 200 response" + } + }, + "x-operation-group": "scripts_painless_execute", + "x-version-added": "1.0" + }, + "post": { + "description": "Allows an arbitrary script to be executed and a result to be returned.", + "operationId": "ScriptsPainlessExecute_Post", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ScriptsPainlessExecute_BodyParams" + } } - }, + } + }, + "responses": { + "200": { + "description": "ScriptsPainlessExecute_Post 200 response" + } + }, + "x-operation-group": "scripts_painless_execute", + "x-version-added": "1.0" + } + }, + "/_scripts/{id}": { + "delete": { + "description": "Deletes a script.", + "externalDocs": { + "description": "API Reference", + "url": "https://opensearch.org/docs/latest/api-reference/script-apis/delete-script/" + }, + "operationId": "DeleteScript", + "parameters": [ { - "name": "ignore_throttled", - "in": "query", - "description": "Whether specified concrete, expanded or aliased indices should be ignored when throttled.", + "name": "id", + "in": "path", + "description": "Script ID.", "schema": { - "type": "boolean", - "description": "Whether specified concrete, expanded or aliased indices should be ignored when throttled." - } + "type": "string", + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", + "description": "Script ID." + }, + "required": true }, { - "name": "allow_no_indices", + "name": "timeout", "in": "query", - "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified).", + "description": "Operation timeout.", "schema": { - "type": "boolean", - "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)." + "type": "string", + "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", + "description": "Operation timeout.", + "x-data-type": "time" } }, { - "name": "expand_wildcards", + "name": "master_timeout", "in": "query", - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", + "description": "Operation timeout for connection to master node.", "schema": { - "$ref": "#/components/schemas/ExpandWildcards" + "type": "string", + "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", + "description": "Operation timeout for connection to master node.", + "x-version-deprecated": "2.0.0", + "x-data-type": "time", + "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", + "deprecated": true } }, { - "name": "lenient", + "name": "cluster_manager_timeout", "in": "query", - "description": "Specify whether format-based query failures (such as providing text to a numeric field) should be ignored.", - "schema": { - "type": "boolean", - "description": "Specify whether format-based query failures (such as providing text to a numeric field) should be ignored." - } - }, - { - "name": "preference", - "in": "query", - "description": "Specify the node or shard the operation should be performed on.", + "description": "Operation timeout for connection to cluster-manager node.", "schema": { "type": "string", - "default": "random", - "description": "Specify the node or shard the operation should be performed on." + "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", + "description": "Operation timeout for connection to cluster-manager node.", + "x-data-type": "time" } - }, + } + ], + "responses": { + "200": { + "description": "DeleteScript 200 response" + } + }, + "x-operation-group": "delete_script", + "x-version-added": "1.0" + }, + "get": { + "description": "Returns a script.", + "externalDocs": { + "description": "API Reference", + "url": "https://opensearch.org/docs/latest/api-reference/script-apis/get-stored-script/" + }, + "operationId": "GetScript", + "parameters": [ { - "name": "q", - "in": "query", - "description": "Query in the Lucene query string syntax.", + "name": "id", + "in": "path", + "description": "Script ID.", "schema": { "type": "string", - "description": "Query in the Lucene query string syntax." - } - }, - { - "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." + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", + "description": "Script ID." }, - "explode": true + "required": true }, { - "name": "scroll", + "name": "master_timeout", "in": "query", - "description": "Specify how long a consistent view of the index should be maintained for scrolled search.", + "description": "Operation timeout for connection to master node.", "schema": { "type": "string", "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Specify how long a consistent view of the index should be maintained for scrolled search.", - "x-data-type": "time" - }, - "examples": { - "Search_Post_example1": { - "summary": "Examples for Post Search Operation.", - "description": "", - "value": "1d" - } + "description": "Operation timeout for connection to master node.", + "x-version-deprecated": "2.0.0", + "x-data-type": "time", + "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", + "deprecated": true } }, { - "name": "search_type", + "name": "cluster_manager_timeout", "in": "query", - "description": "Search operation type.", + "description": "Operation timeout for connection to cluster-manager node.", "schema": { - "$ref": "#/components/schemas/SearchType" + "type": "string", + "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", + "description": "Operation timeout for connection to cluster-manager node.", + "x-data-type": "time" } - }, - { - "name": "size", - "in": "query", - "description": "Number of hits to return.", - "schema": { - "type": "integer", - "default": 10, - "description": "Number of hits to return.", - "format": "int32" + } + ], + "responses": { + "200": { + "description": "GetScript 200 response" + } + }, + "x-operation-group": "get_script", + "x-version-added": "1.0" + }, + "post": { + "description": "Creates or updates a script.", + "operationId": "PutScript_Post", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PutScript_BodyParams" + } } }, + "required": true + }, + "parameters": [ { - "name": "sort", - "in": "query", - "description": "Comma-separated list of : pairs.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of : pairs." - }, - "explode": true - }, - { - "name": "_source", - "in": "query", - "description": "True or false to return the _source field or not, or a list of fields to return.", - "style": "form", + "name": "id", + "in": "path", + "description": "Script ID.", "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "True or false to return the _source field or not, or a list of fields to return." + "type": "string", + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", + "description": "Script ID." }, - "explode": true + "required": true }, { - "name": "_source_excludes", + "name": "timeout", "in": "query", - "description": "List of fields to exclude from the returned _source field.", - "style": "form", + "description": "Operation timeout.", "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "List of fields to exclude from the returned _source field." - }, - "explode": true + "type": "string", + "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", + "description": "Operation timeout.", + "x-data-type": "time" + } }, { - "name": "_source_includes", + "name": "master_timeout", "in": "query", - "description": "List of fields to extract and return from the _source field.", - "style": "form", + "description": "Operation timeout for connection to master node.", "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "List of fields to extract and return from the _source field." - }, - "explode": true + "type": "string", + "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", + "description": "Operation timeout for connection to master node.", + "x-version-deprecated": "2.0.0", + "x-data-type": "time", + "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", + "deprecated": true + } }, { - "name": "terminate_after", + "name": "cluster_manager_timeout", "in": "query", - "description": "The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early.", + "description": "Operation timeout for connection to cluster-manager node.", "schema": { - "type": "integer", - "description": "The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early.", - "format": "int32" + "type": "string", + "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", + "description": "Operation timeout for connection to cluster-manager node.", + "x-data-type": "time" + } + } + ], + "responses": { + "200": { + "description": "PutScript_Post 200 response" + } + }, + "x-operation-group": "put_script", + "x-version-added": "1.0" + }, + "put": { + "description": "Creates or updates a script.", + "externalDocs": { + "description": "API Reference", + "url": "https://opensearch.org/docs/latest/api-reference/script-apis/create-stored-script/" + }, + "operationId": "PutScript_Put", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PutScript_BodyParams" + } } }, + "required": true + }, + "parameters": [ { - "name": "stats", - "in": "query", - "description": "Specific 'tag' of the request for logging and statistical purposes.", - "style": "form", + "name": "id", + "in": "path", + "description": "Script ID.", "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Specific 'tag' of the request for logging and statistical purposes." + "type": "string", + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", + "description": "Script ID." }, - "explode": true + "required": true }, { - "name": "suggest_field", + "name": "timeout", "in": "query", - "description": "Specify which field to use for suggestions.", + "description": "Operation timeout.", "schema": { "type": "string", - "description": "Specify which field to use for suggestions." + "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", + "description": "Operation timeout.", + "x-data-type": "time" } }, { - "name": "suggest_mode", + "name": "master_timeout", "in": "query", - "description": "Specify suggest mode.", + "description": "Operation timeout for connection to master node.", "schema": { - "$ref": "#/components/schemas/SuggestMode" + "type": "string", + "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", + "description": "Operation timeout for connection to master node.", + "x-version-deprecated": "2.0.0", + "x-data-type": "time", + "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", + "deprecated": true } }, { - "name": "suggest_size", + "name": "cluster_manager_timeout", "in": "query", - "description": "How many suggestions to return in response.", + "description": "Operation timeout for connection to cluster-manager node.", "schema": { - "type": "integer", - "description": "How many suggestions to return in response.", - "format": "int32" + "type": "string", + "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", + "description": "Operation timeout for connection to cluster-manager node.", + "x-data-type": "time" + } + } + ], + "responses": { + "200": { + "description": "PutScript_Put 200 response" + } + }, + "x-operation-group": "put_script", + "x-version-added": "1.0" + } + }, + "/_scripts/{id}/{context}": { + "post": { + "description": "Creates or updates a script.", + "operationId": "PutScript_Post_WithContext", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PutScript_BodyParams" + } } }, + "required": true + }, + "parameters": [ { - "name": "suggest_text", + "name": "id", + "in": "path", + "description": "Script ID.", + "schema": { + "type": "string", + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", + "description": "Script ID." + }, + "required": true + }, + { + "name": "context", + "in": "path", + "description": "Script context.", + "schema": { + "type": "string", + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", + "description": "Script context." + }, + "required": true + }, + { + "name": "timeout", "in": "query", - "description": "The source text for which the suggestions should be returned.", + "description": "Operation timeout.", "schema": { "type": "string", - "description": "The source text for which the suggestions should be returned." + "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", + "description": "Operation timeout.", + "x-data-type": "time" + } + }, + { + "name": "master_timeout", + "in": "query", + "description": "Operation timeout for connection to master node.", + "schema": { + "type": "string", + "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", + "description": "Operation timeout for connection to master node.", + "x-version-deprecated": "2.0.0", + "x-data-type": "time", + "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", + "deprecated": true + } + }, + { + "name": "cluster_manager_timeout", + "in": "query", + "description": "Operation timeout for connection to cluster-manager node.", + "schema": { + "type": "string", + "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", + "description": "Operation timeout for connection to cluster-manager node.", + "x-data-type": "time" + } + } + ], + "responses": { + "200": { + "description": "PutScript_Post_WithContext 200 response" + } + }, + "x-operation-group": "put_script", + "x-version-added": "1.0" + }, + "put": { + "description": "Creates or updates a script.", + "operationId": "PutScript_Put_WithContext", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PutScript_BodyParams" + } } }, + "required": true + }, + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Script ID.", + "schema": { + "type": "string", + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", + "description": "Script ID." + }, + "required": true + }, + { + "name": "context", + "in": "path", + "description": "Script context.", + "schema": { + "type": "string", + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", + "description": "Script context." + }, + "required": true + }, { "name": "timeout", "in": "query", @@ -13759,294 +14329,220 @@ } }, { - "name": "track_scores", + "name": "master_timeout", "in": "query", - "description": "Whether to calculate and return scores even if they are not used for sorting.", + "description": "Operation timeout for connection to master node.", "schema": { - "type": "boolean", - "description": "Whether to calculate and return scores even if they are not used for sorting." + "type": "string", + "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", + "description": "Operation timeout for connection to master node.", + "x-version-deprecated": "2.0.0", + "x-data-type": "time", + "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", + "deprecated": true } }, { - "name": "track_total_hits", + "name": "cluster_manager_timeout", "in": "query", - "description": "Indicate if the number of documents that match the query should be tracked.", + "description": "Operation timeout for connection to cluster-manager node.", "schema": { - "type": "boolean", - "description": "Indicate if the number of documents that match the query should be tracked." + "type": "string", + "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", + "description": "Operation timeout for connection to cluster-manager node.", + "x-data-type": "time" + } + } + ], + "responses": { + "200": { + "description": "PutScript_Put_WithContext 200 response" + } + }, + "x-operation-group": "put_script", + "x-version-added": "1.0" + } + }, + "/_search": { + "get": { + "description": "Returns results matching a query.", + "externalDocs": { + "description": "API Reference", + "url": "https://opensearch.org/docs/latest/api-reference/search/" + }, + "operationId": "Search_Get", + "parameters": [ + { + "name": "analyzer", + "in": "query", + "description": "The analyzer to use for the query string.", + "schema": { + "type": "string", + "description": "The analyzer to use for the query string." } }, { - "name": "allow_partial_search_results", + "name": "analyze_wildcard", "in": "query", - "description": "Indicate if an error should be returned if there is a partial search failure or timeout.", + "description": "Specify whether wildcard and prefix queries should be analyzed.", "schema": { "type": "boolean", - "default": true, - "description": "Indicate if an error should be returned if there is a partial search failure or timeout." + "default": false, + "description": "Specify whether wildcard and prefix queries should be analyzed." } }, { - "name": "typed_keys", + "name": "ccs_minimize_roundtrips", "in": "query", - "description": "Specify whether aggregation and suggester names should be prefixed by their respective types in the response.", + "description": "Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution.", "schema": { "type": "boolean", - "description": "Specify whether aggregation and suggester names should be prefixed by their respective types in the response." + "default": true, + "description": "Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution." } }, { - "name": "version", + "name": "default_operator", "in": "query", - "description": "Whether to return document version as part of a hit.", + "description": "The default operator for query string query (AND or OR).", "schema": { - "type": "boolean", - "description": "Whether to return document version as part of a hit." + "$ref": "#/components/schemas/DefaultOperator" } }, { - "name": "seq_no_primary_term", + "name": "df", "in": "query", - "description": "Specify whether to return sequence number and primary term of the last modification of each hit.", + "description": "The field to use as default where no field prefix is given in the query string.", "schema": { - "type": "boolean", - "description": "Specify whether to return sequence number and primary term of the last modification of each hit." + "type": "string", + "description": "The field to use as default where no field prefix is given in the query string." } }, { - "name": "request_cache", + "name": "explain", "in": "query", - "description": "Specify if request cache should be used for this request or not, defaults to index level setting.", + "description": "Specify whether to return detailed information about score computation as part of a hit.", "schema": { "type": "boolean", - "description": "Specify if request cache should be used for this request or not, defaults to index level setting." + "description": "Specify whether to return detailed information about score computation as part of a hit." } }, { - "name": "batched_reduce_size", + "name": "stored_fields", "in": "query", - "description": "The number of shard results that should be reduced at once on the coordinating node. This value should be used as a protection mechanism to reduce the memory overhead per search request if the potential number of shards in the request can be large.", + "description": "Comma-separated list of stored fields to return.", + "style": "form", "schema": { - "type": "integer", - "default": 512, - "description": "The number of shard results that should be reduced at once on the coordinating node. This value should be used as a protection mechanism to reduce the memory overhead per search request if the potential number of shards in the request can be large.", - "format": "int32" - } + "type": "array", + "items": { + "type": "string" + }, + "description": "Comma-separated list of stored fields to return." + }, + "explode": true }, { - "name": "max_concurrent_shard_requests", + "name": "docvalue_fields", "in": "query", - "description": "The number of concurrent shard requests per node this search executes concurrently. This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests.", + "description": "Comma-separated list of fields to return as the docvalue representation of a field for each hit.", + "style": "form", "schema": { - "type": "integer", - "default": 5, - "description": "The number of concurrent shard requests per node this search executes concurrently. This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests.", - "format": "int32" - } + "type": "array", + "items": { + "type": "string" + }, + "description": "Comma-separated list of fields to return as the docvalue representation of a field for each hit." + }, + "explode": true }, { - "name": "pre_filter_shard_size", + "name": "from", "in": "query", - "description": "Threshold that enforces a pre-filter round-trip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter round-trip can limit the number of shards significantly if for instance a shard can not match any documents based on its rewrite method ie. if date filters are mandatory to match but the shard bounds and the query are disjoint.", + "description": "Starting offset.", "schema": { "type": "integer", - "description": "Threshold that enforces a pre-filter round-trip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter round-trip can limit the number of shards significantly if for instance a shard can not match any documents based on its rewrite method ie. if date filters are mandatory to match but the shard bounds and the query are disjoint.", + "default": 0, + "description": "Starting offset.", "format": "int32" } }, { - "name": "rest_total_hits_as_int", + "name": "ignore_unavailable", "in": "query", - "description": "Indicates whether hits.total should be rendered as an integer or an object in the rest search response.", + "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", "schema": { "type": "boolean", - "default": false, - "description": "Indicates whether hits.total should be rendered as an integer or an object in the rest search response." + "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." } - } - ], - "responses": { - "200": { - "description": "Search_Post 200 response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Search_PostResponseContent" - }, - "examples": { - "Search_Post_example1": { - "summary": "Examples for Post Search Operation.", - "description": "", - "value": { - "timed_out": false, - "_shards": { - "total": 1, - "successful": 1, - "skipped": 0, - "failed": 0 - }, - "hits": { - "total": { - "value": 0, - "relation": "eq" - }, - "hits": [] - } - } - } - } - } + }, + { + "name": "ignore_throttled", + "in": "query", + "description": "Whether specified concrete, expanded or aliased indices should be ignored when throttled.", + "schema": { + "type": "boolean", + "description": "Whether specified concrete, expanded or aliased indices should be ignored when throttled." } - } - }, - "x-operation-group": "search", - "x-version-added": "1.0" - } - }, - "/_search/point_in_time": { - "delete": { - "description": "Deletes one or more point in time searches based on the IDs passed.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest" - }, - "operationId": "DeletePit", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DeletePit_BodyParams" - } + }, + { + "name": "allow_no_indices", + "in": "query", + "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified).", + "schema": { + "type": "boolean", + "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)." } }, - "required": true - }, - "responses": { - "200": { - "description": "DeletePit 200 response" - } - }, - "x-operation-group": "delete_pit", - "x-version-added": "1.0" - } - }, - "/_search/point_in_time/_all": { - "delete": { - "description": "Deletes all active point in time searches.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest" - }, - "operationId": "DeleteAllPits", - "responses": { - "200": { - "description": "DeleteAllPits 200 response" - } - }, - "x-operation-group": "delete_all_pits", - "x-version-added": "1.0" - }, - "get": { - "description": "Lists all active point in time searches.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest" - }, - "operationId": "GetAllPits", - "responses": { - "200": { - "description": "GetAllPits 200 response" - } - }, - "x-operation-group": "get_all_pits", - "x-version-added": "1.0" - } - }, - "/_search/scroll": { - "delete": { - "description": "Explicitly clears the search context for a scroll.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest" - }, - "operationId": "ClearScroll", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ClearScroll_BodyParams" - } + { + "name": "expand_wildcards", + "in": "query", + "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", + "schema": { + "$ref": "#/components/schemas/ExpandWildcards" } - } - }, - "responses": { - "200": { - "description": "ClearScroll 200 response" - } - }, - "x-operation-group": "clear_scroll", - "x-version-added": "1.0" - }, - "get": { - "description": "Allows to retrieve a large numbers of results from a single search request.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest" - }, - "operationId": "Scroll_Get", - "parameters": [ + }, { - "name": "scroll", + "name": "lenient", "in": "query", - "description": "Specify how long a consistent view of the index should be maintained for scrolled search.", + "description": "Specify whether format-based query failures (such as providing text to a numeric field) should be ignored.", "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Specify how long a consistent view of the index should be maintained for scrolled search.", - "x-data-type": "time" + "type": "boolean", + "description": "Specify whether format-based query failures (such as providing text to a numeric field) should be ignored." } }, { - "name": "scroll_id", + "name": "preference", "in": "query", - "description": "Scroll ID.", + "description": "Specify the node or shard the operation should be performed on.", "schema": { "type": "string", - "description": "Scroll ID." + "default": "random", + "description": "Specify the node or shard the operation should be performed on." } }, { - "name": "rest_total_hits_as_int", + "name": "q", "in": "query", - "description": "Indicates whether hits.total should be rendered as an integer or an object in the rest search response.", + "description": "Query in the Lucene query string syntax.", "schema": { - "type": "boolean", - "default": false, - "description": "Indicates whether hits.total should be rendered as an integer or an object in the rest search response." - } - } - ], - "responses": { - "200": { - "description": "Scroll_Get 200 response" - } - }, - "x-operation-group": "scroll", - "x-version-added": "1.0" - }, - "post": { - "description": "Allows to retrieve a large numbers of results from a single search request.", - "operationId": "Scroll_Post", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Scroll_BodyParams" - } + "type": "string", + "description": "Query in the Lucene query string syntax." } - } - }, - "parameters": [ + }, + { + "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 + }, { "name": "scroll", "in": "query", @@ -14059,309 +14555,245 @@ } }, { - "name": "scroll_id", + "name": "search_type", "in": "query", - "description": "Scroll ID.", + "description": "Search operation type.", "schema": { - "type": "string", - "description": "Scroll ID." + "$ref": "#/components/schemas/SearchType" } }, { - "name": "rest_total_hits_as_int", + "name": "size", "in": "query", - "description": "Indicates whether hits.total should be rendered as an integer or an object in the rest search response.", + "description": "Number of hits to return.", "schema": { - "type": "boolean", - "default": false, - "description": "Indicates whether hits.total should be rendered as an integer or an object in the rest search response." + "type": "integer", + "default": 10, + "description": "Number of hits to return.", + "format": "int32" } - } - ], - "responses": { - "200": { - "description": "Scroll_Post 200 response" - } - }, - "x-operation-group": "scroll", - "x-version-added": "1.0" - } - }, - "/_search/scroll/{scroll_id}": { - "delete": { - "description": "Explicitly clears the search context for a scroll.", - "operationId": "ClearScroll_WithScrollId", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ClearScroll_BodyParams" - } - } - } - }, - "deprecated": true, - "parameters": [ + }, { - "name": "scroll_id", - "in": "path", - "description": "Comma-separated list of scroll IDs to clear.", + "name": "sort", + "in": "query", + "description": "Comma-separated list of : pairs.", + "style": "form", "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", - "description": "Comma-separated list of scroll IDs to clear.", - "deprecated": true, - "x-data-type": "array" + "type": "array", + "items": { + "type": "string" + }, + "description": "Comma-separated list of : pairs." }, - "required": true - } - ], - "responses": { - "200": { - "description": "ClearScroll_WithScrollId 200 response" - } - }, - "x-deprecation-message": "A scroll id can be quite large and should be specified as part of the body", - "x-operation-group": "clear_scroll", - "x-version-added": "1.0", - "x-version-deprecated": "1.0" - }, - "get": { - "description": "Allows to retrieve a large numbers of results from a single search request.", - "operationId": "Scroll_Get_WithScrollId", - "deprecated": true, - "parameters": [ + "explode": true + }, { - "name": "scroll_id", - "in": "path", - "description": "Scroll ID.", + "name": "_source", + "in": "query", + "description": "True or false to return the _source field or not, or a list of fields to return.", + "style": "form", "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", - "description": "Scroll ID." + "type": "array", + "items": { + "type": "string" + }, + "description": "True or false to return the _source field or not, or a list of fields to return." }, - "required": true + "explode": true }, { - "name": "scroll", + "name": "_source_excludes", "in": "query", - "description": "Specify how long a consistent view of the index should be maintained for scrolled search.", + "description": "List of fields to exclude from the returned _source field.", + "style": "form", "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Specify how long a consistent view of the index should be maintained for scrolled search.", - "x-data-type": "time" + "type": "array", + "items": { + "type": "string" + }, + "description": "List of fields to exclude from the returned _source field." + }, + "explode": true + }, + { + "name": "_source_includes", + "in": "query", + "description": "List of fields to extract and return from the _source field.", + "style": "form", + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of fields to extract and return from the _source field." + }, + "explode": true + }, + { + "name": "terminate_after", + "in": "query", + "description": "The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early.", + "schema": { + "type": "integer", + "description": "The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early.", + "format": "int32" } }, { - "name": "scroll_id", + "name": "stats", "in": "query", - "description": "Scroll ID.", + "description": "Specific 'tag' of the request for logging and statistical purposes.", + "style": "form", + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Specific 'tag' of the request for logging and statistical purposes." + }, + "explode": true + }, + { + "name": "suggest_field", + "in": "query", + "description": "Specify which field to use for suggestions.", "schema": { "type": "string", - "description": "Scroll ID." + "description": "Specify which field to use for suggestions." } }, { - "name": "rest_total_hits_as_int", + "name": "suggest_mode", "in": "query", - "description": "Indicates whether hits.total should be rendered as an integer or an object in the rest search response.", + "description": "Specify suggest mode.", "schema": { - "type": "boolean", - "default": false, - "description": "Indicates whether hits.total should be rendered as an integer or an object in the rest search response." + "$ref": "#/components/schemas/SuggestMode" } - } - ], - "responses": { - "200": { - "description": "Scroll_Get_WithScrollId 200 response" - } - }, - "x-deprecation-message": "A scroll id can be quite large and should be specified as part of the body", - "x-operation-group": "scroll", - "x-version-added": "1.0", - "x-version-deprecated": "1.0" - }, - "post": { - "description": "Allows to retrieve a large numbers of results from a single search request.", - "operationId": "Scroll_Post_WithScrollId", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Scroll_BodyParams" - } + }, + { + "name": "suggest_size", + "in": "query", + "description": "How many suggestions to return in response.", + "schema": { + "type": "integer", + "description": "How many suggestions to return in response.", + "format": "int32" } - } - }, - "deprecated": true, - "parameters": [ + }, { - "name": "scroll_id", - "in": "path", - "description": "Scroll ID.", + "name": "suggest_text", + "in": "query", + "description": "The source text for which the suggestions should be returned.", "schema": { "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", - "description": "Scroll ID." - }, - "required": true + "description": "The source text for which the suggestions should be returned." + } }, { - "name": "scroll", + "name": "timeout", "in": "query", - "description": "Specify how long a consistent view of the index should be maintained for scrolled search.", + "description": "Operation timeout.", "schema": { "type": "string", "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Specify how long a consistent view of the index should be maintained for scrolled search.", + "description": "Operation timeout.", "x-data-type": "time" } }, { - "name": "scroll_id", + "name": "track_scores", "in": "query", - "description": "Scroll ID.", + "description": "Whether to calculate and return scores even if they are not used for sorting.", "schema": { - "type": "string", - "description": "Scroll ID." + "type": "boolean", + "description": "Whether to calculate and return scores even if they are not used for sorting." } }, { - "name": "rest_total_hits_as_int", + "name": "track_total_hits", "in": "query", - "description": "Indicates whether hits.total should be rendered as an integer or an object in the rest search response.", + "description": "Indicate if the number of documents that match the query should be tracked.", "schema": { "type": "boolean", - "default": false, - "description": "Indicates whether hits.total should be rendered as an integer or an object in the rest search response." + "description": "Indicate if the number of documents that match the query should be tracked." } - } - ], - "responses": { - "200": { - "description": "Scroll_Post_WithScrollId 200 response" - } - }, - "x-deprecation-message": "A scroll id can be quite large and should be specified as part of the body", - "x-operation-group": "scroll", - "x-version-added": "1.0", - "x-version-deprecated": "1.0" - } - }, - "/_search/template": { - "get": { - "description": "Allows to use the Mustache language to pre-render a search definition.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest" - }, - "operationId": "SearchTemplate_Get", - "parameters": [ + }, { - "name": "ignore_unavailable", + "name": "allow_partial_search_results", "in": "query", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", + "description": "Indicate if an error should be returned if there is a partial search failure or timeout.", "schema": { "type": "boolean", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." + "default": true, + "description": "Indicate if an error should be returned if there is a partial search failure or timeout." } }, { - "name": "ignore_throttled", + "name": "typed_keys", "in": "query", - "description": "Whether specified concrete, expanded or aliased indices should be ignored when throttled.", + "description": "Specify whether aggregation and suggester names should be prefixed by their respective types in the response.", "schema": { "type": "boolean", - "description": "Whether specified concrete, expanded or aliased indices should be ignored when throttled." + "description": "Specify whether aggregation and suggester names should be prefixed by their respective types in the response." } }, { - "name": "allow_no_indices", + "name": "version", "in": "query", - "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified).", + "description": "Whether to return document version as part of a hit.", "schema": { "type": "boolean", - "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)." + "description": "Whether to return document version as part of a hit." } }, { - "name": "expand_wildcards", + "name": "seq_no_primary_term", "in": "query", - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", + "description": "Specify whether to return sequence number and primary term of the last modification of each hit.", "schema": { - "$ref": "#/components/schemas/ExpandWildcards" + "type": "boolean", + "description": "Specify whether to return sequence number and primary term of the last modification of each hit." } }, { - "name": "preference", + "name": "request_cache", "in": "query", - "description": "Specify the node or shard the operation should be performed on.", + "description": "Specify if request cache should be used for this request or not, defaults to index level setting.", "schema": { - "type": "string", - "default": "random", - "description": "Specify the node or shard the operation should be performed on." + "type": "boolean", + "description": "Specify if request cache should be used for this request or not, defaults to index level setting." } }, { - "name": "routing", + "name": "batched_reduce_size", "in": "query", - "description": "Comma-separated list of specific routing values.", - "style": "form", + "description": "The number of shard results that should be reduced at once on the coordinating node. This value should be used as a protection mechanism to reduce the memory overhead per search request if the potential number of shards in the request can be large.", "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of specific routing values." - }, - "explode": true - }, - { - "name": "scroll", - "in": "query", - "description": "Specify how long a consistent view of the index should be maintained for scrolled search.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Specify how long a consistent view of the index should be maintained for scrolled search.", - "x-data-type": "time" - } - }, - { - "name": "search_type", - "in": "query", - "description": "Search operation type.", - "schema": { - "$ref": "#/components/schemas/SearchTypeMulti" - } - }, - { - "name": "explain", - "in": "query", - "description": "Specify whether to return detailed information about score computation as part of a hit.", - "schema": { - "type": "boolean", - "description": "Specify whether to return detailed information about score computation as part of a hit." + "type": "integer", + "default": 512, + "description": "The number of shard results that should be reduced at once on the coordinating node. This value should be used as a protection mechanism to reduce the memory overhead per search request if the potential number of shards in the request can be large.", + "format": "int32" } }, { - "name": "profile", + "name": "max_concurrent_shard_requests", "in": "query", - "description": "Specify whether to profile the query execution.", + "description": "The number of concurrent shard requests per node this search executes concurrently. This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests.", "schema": { - "type": "boolean", - "description": "Specify whether to profile the query execution." + "type": "integer", + "default": 5, + "description": "The number of concurrent shard requests per node this search executes concurrently. This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests.", + "format": "int32" } }, { - "name": "typed_keys", + "name": "pre_filter_shard_size", "in": "query", - "description": "Specify whether aggregation and suggester names should be prefixed by their respective types in the response.", + "description": "Threshold that enforces a pre-filter round-trip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter round-trip can limit the number of shards significantly if for instance a shard can not match any documents based on its rewrite method ie. if date filters are mandatory to match but the shard bounds and the query are disjoint.", "schema": { - "type": "boolean", - "description": "Specify whether aggregation and suggester names should be prefixed by their respective types in the response." + "type": "integer", + "description": "Threshold that enforces a pre-filter round-trip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter round-trip can limit the number of shards significantly if for instance a shard can not match any documents based on its rewrite method ie. if date filters are mandatory to match but the shard bounds and the query are disjoint.", + "format": "int32" } }, { @@ -14373,184 +14805,188 @@ "default": false, "description": "Indicates whether hits.total should be rendered as an integer or an object in the rest search response." } - }, - { - "name": "ccs_minimize_roundtrips", - "in": "query", - "description": "Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution.", - "schema": { - "type": "boolean", - "default": true, - "description": "Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution." - } } ], "responses": { "200": { - "description": "SearchTemplate_Get 200 response" + "description": "Search_Get 200 response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Search_GetResponseContent" + } + } + } } }, - "x-operation-group": "search_template", + "x-operation-group": "search", "x-version-added": "1.0" }, "post": { - "description": "Allows to use the Mustache language to pre-render a search definition.", - "operationId": "SearchTemplate_Post", + "description": "Returns results matching a query.", + "operationId": "Search_Post", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SearchTemplate_BodyParams" + "$ref": "#/components/schemas/Search_BodyParams" + }, + "examples": { + "Search_Post_example1": { + "summary": "Examples for Post Search Operation.", + "description": "", + "value": { + "query": { + "match_all": {} + }, + "fields": [ + "*" + ] + } + } } } - }, - "required": true + } }, "parameters": [ { - "name": "ignore_unavailable", + "name": "analyzer", "in": "query", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", + "description": "The analyzer to use for the query string.", "schema": { - "type": "boolean", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." + "type": "string", + "description": "The analyzer to use for the query string." } }, { - "name": "ignore_throttled", + "name": "analyze_wildcard", "in": "query", - "description": "Whether specified concrete, expanded or aliased indices should be ignored when throttled.", + "description": "Specify whether wildcard and prefix queries should be analyzed.", "schema": { "type": "boolean", - "description": "Whether specified concrete, expanded or aliased indices should be ignored when throttled." + "default": false, + "description": "Specify whether wildcard and prefix queries should be analyzed." } }, { - "name": "allow_no_indices", + "name": "ccs_minimize_roundtrips", "in": "query", - "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified).", + "description": "Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution.", "schema": { "type": "boolean", - "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)." + "default": true, + "description": "Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution." } }, { - "name": "expand_wildcards", + "name": "default_operator", "in": "query", - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", + "description": "The default operator for query string query (AND or OR).", "schema": { - "$ref": "#/components/schemas/ExpandWildcards" + "$ref": "#/components/schemas/DefaultOperator" } }, { - "name": "preference", + "name": "df", "in": "query", - "description": "Specify the node or shard the operation should be performed on.", + "description": "The field to use as default where no field prefix is given in the query string.", "schema": { "type": "string", - "default": "random", - "description": "Specify the node or shard the operation should be performed on." + "description": "The field to use as default where no field prefix is given in the query string." } }, { - "name": "routing", + "name": "explain", "in": "query", - "description": "Comma-separated list of specific routing values.", + "description": "Specify whether to return detailed information about score computation as part of a hit.", + "schema": { + "type": "boolean", + "description": "Specify whether to return detailed information about score computation as part of a hit." + } + }, + { + "name": "stored_fields", + "in": "query", + "description": "Comma-separated list of stored fields to return.", "style": "form", "schema": { "type": "array", "items": { "type": "string" }, - "description": "Comma-separated list of specific routing values." + "description": "Comma-separated list of stored fields to return." }, "explode": true }, { - "name": "scroll", + "name": "docvalue_fields", "in": "query", - "description": "Specify how long a consistent view of the index should be maintained for scrolled search.", + "description": "Comma-separated list of fields to return as the docvalue representation of a field for each hit.", + "style": "form", "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Specify how long a consistent view of the index should be maintained for scrolled search.", - "x-data-type": "time" - } + "type": "array", + "items": { + "type": "string" + }, + "description": "Comma-separated list of fields to return as the docvalue representation of a field for each hit." + }, + "explode": true }, { - "name": "search_type", + "name": "from", "in": "query", - "description": "Search operation type.", + "description": "Starting offset.", "schema": { - "$ref": "#/components/schemas/SearchTypeMulti" + "type": "integer", + "default": 0, + "description": "Starting offset.", + "format": "int32" } }, { - "name": "explain", + "name": "ignore_unavailable", "in": "query", - "description": "Specify whether to return detailed information about score computation as part of a hit.", + "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", "schema": { "type": "boolean", - "description": "Specify whether to return detailed information about score computation as part of a hit." + "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." } }, { - "name": "profile", + "name": "ignore_throttled", "in": "query", - "description": "Specify whether to profile the query execution.", + "description": "Whether specified concrete, expanded or aliased indices should be ignored when throttled.", "schema": { "type": "boolean", - "description": "Specify whether to profile the query execution." + "description": "Whether specified concrete, expanded or aliased indices should be ignored when throttled." } }, { - "name": "typed_keys", + "name": "allow_no_indices", "in": "query", - "description": "Specify whether aggregation and suggester names should be prefixed by their respective types in the response.", + "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified).", "schema": { "type": "boolean", - "description": "Specify whether aggregation and suggester names should be prefixed by their respective types in the response." + "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)." } }, { - "name": "rest_total_hits_as_int", + "name": "expand_wildcards", "in": "query", - "description": "Indicates whether hits.total should be rendered as an integer or an object in the rest search response.", + "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", "schema": { - "type": "boolean", - "default": false, - "description": "Indicates whether hits.total should be rendered as an integer or an object in the rest search response." + "$ref": "#/components/schemas/ExpandWildcards" } }, { - "name": "ccs_minimize_roundtrips", + "name": "lenient", "in": "query", - "description": "Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution.", + "description": "Specify whether format-based query failures (such as providing text to a numeric field) should be ignored.", "schema": { "type": "boolean", - "default": true, - "description": "Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution." + "description": "Specify whether format-based query failures (such as providing text to a numeric field) should be ignored." } - } - ], - "responses": { - "200": { - "description": "SearchTemplate_Post 200 response" - } - }, - "x-operation-group": "search_template", - "x-version-added": "1.0" - } - }, - "/_search_shards": { - "get": { - "description": "Returns information about the indices and shards that a search request would be executed against.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest" - }, - "operationId": "SearchShards_Get", - "parameters": [ + }, { "name": "preference", "in": "query", @@ -14562,530 +14998,729 @@ } }, { - "name": "routing", + "name": "q", "in": "query", - "description": "Routing value.", + "description": "Query in the Lucene query string syntax.", "schema": { "type": "string", - "description": "Routing value." + "description": "Query in the Lucene query string syntax." } }, { - "name": "local", + "name": "routing", "in": "query", - "description": "Return local information, do not retrieve the state from cluster-manager node.", + "description": "Comma-separated list of specific routing values.", + "style": "form", "schema": { - "type": "boolean", - "default": false, - "description": "Return local information, do not retrieve the state from cluster-manager node." - } + "type": "array", + "items": { + "type": "string" + }, + "description": "Comma-separated list of specific routing values." + }, + "explode": true }, { - "name": "ignore_unavailable", + "name": "scroll", "in": "query", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", + "description": "Specify how long a consistent view of the index should be maintained for scrolled search.", "schema": { - "type": "boolean", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." + "type": "string", + "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", + "description": "Specify how long a consistent view of the index should be maintained for scrolled search.", + "x-data-type": "time" + }, + "examples": { + "Search_Post_example1": { + "summary": "Examples for Post Search Operation.", + "description": "", + "value": "1d" + } } }, { - "name": "allow_no_indices", + "name": "search_type", "in": "query", - "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified).", + "description": "Search operation type.", "schema": { - "type": "boolean", - "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)." + "$ref": "#/components/schemas/SearchType" } }, { - "name": "expand_wildcards", - "in": "query", - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", - "schema": { - "$ref": "#/components/schemas/ExpandWildcards" - } - } - ], - "responses": { - "200": { - "description": "SearchShards_Get 200 response" - } - }, - "x-operation-group": "search_shards", - "x-version-added": "1.0" - }, - "post": { - "description": "Returns information about the indices and shards that a search request would be executed against.", - "operationId": "SearchShards_Post", - "parameters": [ - { - "name": "preference", + "name": "size", "in": "query", - "description": "Specify the node or shard the operation should be performed on.", + "description": "Number of hits to return.", "schema": { - "type": "string", - "default": "random", - "description": "Specify the node or shard the operation should be performed on." + "type": "integer", + "default": 10, + "description": "Number of hits to return.", + "format": "int32" } }, { - "name": "routing", + "name": "sort", "in": "query", - "description": "Routing value.", + "description": "Comma-separated list of : pairs.", + "style": "form", "schema": { - "type": "string", - "description": "Routing value." - } + "type": "array", + "items": { + "type": "string" + }, + "description": "Comma-separated list of : pairs." + }, + "explode": true }, { - "name": "local", + "name": "_source", "in": "query", - "description": "Return local information, do not retrieve the state from cluster-manager node.", + "description": "True or false to return the _source field or not, or a list of fields to return.", + "style": "form", "schema": { - "type": "boolean", - "default": false, - "description": "Return local information, do not retrieve the state from cluster-manager node." - } + "type": "array", + "items": { + "type": "string" + }, + "description": "True or false to return the _source field or not, or a list of fields to return." + }, + "explode": true }, { - "name": "ignore_unavailable", + "name": "_source_excludes", "in": "query", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", + "description": "List of fields to exclude from the returned _source field.", + "style": "form", "schema": { - "type": "boolean", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." - } + "type": "array", + "items": { + "type": "string" + }, + "description": "List of fields to exclude from the returned _source field." + }, + "explode": true }, { - "name": "allow_no_indices", + "name": "_source_includes", "in": "query", - "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified).", + "description": "List of fields to extract and return from the _source field.", + "style": "form", "schema": { - "type": "boolean", - "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)." - } + "type": "array", + "items": { + "type": "string" + }, + "description": "List of fields to extract and return from the _source field." + }, + "explode": true }, { - "name": "expand_wildcards", + "name": "terminate_after", "in": "query", - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", + "description": "The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early.", "schema": { - "$ref": "#/components/schemas/ExpandWildcards" + "type": "integer", + "description": "The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early.", + "format": "int32" } - } - ], - "responses": { - "200": { - "description": "SearchShards_Post 200 response" - } - }, - "x-operation-group": "search_shards", - "x-version-added": "1.0" - } - }, - "/_segments": { - "get": { - "description": "Provides low-level information about segments in a Lucene index.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest" - }, - "operationId": "IndicesSegments", - "parameters": [ + }, { - "name": "ignore_unavailable", + "name": "stats", "in": "query", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", + "description": "Specific 'tag' of the request for logging and statistical purposes.", + "style": "form", "schema": { - "type": "boolean", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." - } + "type": "array", + "items": { + "type": "string" + }, + "description": "Specific 'tag' of the request for logging and statistical purposes." + }, + "explode": true }, { - "name": "allow_no_indices", + "name": "suggest_field", "in": "query", - "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified).", + "description": "Specify which field to use for suggestions.", "schema": { - "type": "boolean", - "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)." + "type": "string", + "description": "Specify which field to use for suggestions." } }, { - "name": "expand_wildcards", + "name": "suggest_mode", "in": "query", - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", + "description": "Specify suggest mode.", "schema": { - "$ref": "#/components/schemas/ExpandWildcards" + "$ref": "#/components/schemas/SuggestMode" } }, { - "name": "verbose", + "name": "suggest_size", "in": "query", - "description": "Includes detailed memory usage by Lucene.", + "description": "How many suggestions to return in response.", "schema": { - "type": "boolean", - "default": false, - "description": "Includes detailed memory usage by Lucene." + "type": "integer", + "description": "How many suggestions to return in response.", + "format": "int32" } - } - ], - "responses": { - "200": { - "description": "IndicesSegments 200 response" - } - }, - "x-operation-group": "indices.segments", - "x-version-added": "1.0" - } - }, - "/_settings": { - "get": { - "description": "Returns settings for one or more indices.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/api-reference/index-apis/get-settings/" - }, - "operationId": "IndicesGetSettings", - "parameters": [ + }, { - "name": "master_timeout", + "name": "suggest_text", "in": "query", - "description": "Operation timeout for connection to master node.", + "description": "The source text for which the suggestions should be returned.", "schema": { "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to master node.", - "x-version-deprecated": "2.0.0", - "x-data-type": "time", - "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", - "deprecated": true + "description": "The source text for which the suggestions should be returned." } }, { - "name": "cluster_manager_timeout", + "name": "timeout", "in": "query", - "description": "Operation timeout for connection to cluster-manager node.", + "description": "Operation timeout.", "schema": { "type": "string", "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to cluster-manager node.", + "description": "Operation timeout.", "x-data-type": "time" } }, { - "name": "ignore_unavailable", + "name": "track_scores", "in": "query", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", + "description": "Whether to calculate and return scores even if they are not used for sorting.", "schema": { "type": "boolean", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." + "description": "Whether to calculate and return scores even if they are not used for sorting." } }, { - "name": "allow_no_indices", + "name": "track_total_hits", "in": "query", - "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified).", + "description": "Indicate if the number of documents that match the query should be tracked.", "schema": { "type": "boolean", - "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)." + "description": "Indicate if the number of documents that match the query should be tracked." } }, { - "name": "expand_wildcards", + "name": "allow_partial_search_results", "in": "query", - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", + "description": "Indicate if an error should be returned if there is a partial search failure or timeout.", "schema": { - "$ref": "#/components/schemas/ExpandWildcards" + "type": "boolean", + "default": true, + "description": "Indicate if an error should be returned if there is a partial search failure or timeout." } }, { - "name": "flat_settings", + "name": "typed_keys", "in": "query", - "description": "Return settings in flat format.", + "description": "Specify whether aggregation and suggester names should be prefixed by their respective types in the response.", "schema": { "type": "boolean", - "default": false, - "description": "Return settings in flat format." + "description": "Specify whether aggregation and suggester names should be prefixed by their respective types in the response." } }, { - "name": "local", + "name": "version", "in": "query", - "description": "Return local information, do not retrieve the state from cluster-manager node.", + "description": "Whether to return document version as part of a hit.", "schema": { "type": "boolean", - "default": false, - "description": "Return local information, do not retrieve the state from cluster-manager node." + "description": "Whether to return document version as part of a hit." } }, { - "name": "include_defaults", + "name": "seq_no_primary_term", "in": "query", - "description": "Whether to return all default setting for each of the indices.", + "description": "Specify whether to return sequence number and primary term of the last modification of each hit.", + "schema": { + "type": "boolean", + "description": "Specify whether to return sequence number and primary term of the last modification of each hit." + } + }, + { + "name": "request_cache", + "in": "query", + "description": "Specify if request cache should be used for this request or not, defaults to index level setting.", + "schema": { + "type": "boolean", + "description": "Specify if request cache should be used for this request or not, defaults to index level setting." + } + }, + { + "name": "batched_reduce_size", + "in": "query", + "description": "The number of shard results that should be reduced at once on the coordinating node. This value should be used as a protection mechanism to reduce the memory overhead per search request if the potential number of shards in the request can be large.", + "schema": { + "type": "integer", + "default": 512, + "description": "The number of shard results that should be reduced at once on the coordinating node. This value should be used as a protection mechanism to reduce the memory overhead per search request if the potential number of shards in the request can be large.", + "format": "int32" + } + }, + { + "name": "max_concurrent_shard_requests", + "in": "query", + "description": "The number of concurrent shard requests per node this search executes concurrently. This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests.", + "schema": { + "type": "integer", + "default": 5, + "description": "The number of concurrent shard requests per node this search executes concurrently. This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests.", + "format": "int32" + } + }, + { + "name": "pre_filter_shard_size", + "in": "query", + "description": "Threshold that enforces a pre-filter round-trip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter round-trip can limit the number of shards significantly if for instance a shard can not match any documents based on its rewrite method ie. if date filters are mandatory to match but the shard bounds and the query are disjoint.", + "schema": { + "type": "integer", + "description": "Threshold that enforces a pre-filter round-trip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter round-trip can limit the number of shards significantly if for instance a shard can not match any documents based on its rewrite method ie. if date filters are mandatory to match but the shard bounds and the query are disjoint.", + "format": "int32" + } + }, + { + "name": "rest_total_hits_as_int", + "in": "query", + "description": "Indicates whether hits.total should be rendered as an integer or an object in the rest search response.", "schema": { "type": "boolean", "default": false, - "description": "Whether to return all default setting for each of the indices." + "description": "Indicates whether hits.total should be rendered as an integer or an object in the rest search response." } } ], "responses": { "200": { - "description": "IndicesGetSettings 200 response" + "description": "Search_Post 200 response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Search_PostResponseContent" + }, + "examples": { + "Search_Post_example1": { + "summary": "Examples for Post Search Operation.", + "description": "", + "value": { + "timed_out": false, + "_shards": { + "total": 1, + "successful": 1, + "skipped": 0, + "failed": 0 + }, + "hits": { + "total": { + "value": 0, + "relation": "eq" + }, + "hits": [] + } + } + } + } + } + } } }, - "x-operation-group": "indices.get_settings", + "x-operation-group": "search", "x-version-added": "1.0" + } + }, + "/_search/point_in_time": { + "delete": { + "description": "Deletes one or more point in time searches based on the IDs passed.", + "externalDocs": { + "description": "API Reference", + "url": "https://opensearch.org/docs/latest/search-plugins/point-in-time-api/#delete-pits" + }, + "operationId": "DeletePit", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DeletePit_BodyParams" + } + } + } + }, + "responses": { + "200": { + "description": "DeletePit 200 response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DeletePitResponseContent" + } + } + } + } + }, + "x-operation-group": "delete_pit", + "x-version-added": "2.4" + } + }, + "/_search/point_in_time/_all": { + "delete": { + "description": "Deletes all active point in time searches.", + "externalDocs": { + "description": "API Reference", + "url": "https://opensearch.org/docs/latest/search-plugins/point-in-time-api/#delete-pits" + }, + "operationId": "DeleteAllPits", + "responses": { + "200": { + "description": "DeleteAllPits 200 response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DeleteAllPitsResponseContent" + } + } + } + } + }, + "x-operation-group": "delete_all_pits", + "x-version-added": "2.4" }, - "put": { - "description": "Updates the index settings.", + "get": { + "description": "Lists all active point in time searches.", "externalDocs": { "description": "API Reference", - "url": "https://opensearch.org/docs/latest" + "url": "https://opensearch.org/docs/latest/search-plugins/point-in-time-api/#list-all-pits" }, - "operationId": "IndicesPutSettings", + "operationId": "GetAllPits", + "responses": { + "200": { + "description": "GetAllPits 200 response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GetAllPitsResponseContent" + } + } + } + } + }, + "x-operation-group": "get_all_pits", + "x-version-added": "2.4" + } + }, + "/_search/scroll": { + "delete": { + "description": "Explicitly clears the search context for a scroll.", + "externalDocs": { + "description": "API Reference", + "url": "https://opensearch.org/docs/latest/api-reference/scroll/" + }, + "operationId": "ClearScroll", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/IndicesPutSettings_BodyParams" + "$ref": "#/components/schemas/ClearScroll_BodyParams" } } - }, - "required": true + } + }, + "responses": { + "200": { + "description": "ClearScroll 200 response" + } + }, + "x-operation-group": "clear_scroll", + "x-version-added": "1.0" + }, + "get": { + "description": "Allows to retrieve a large numbers of results from a single search request.", + "externalDocs": { + "description": "API Reference", + "url": "https://opensearch.org/docs/latest/api-reference/scroll/#path-and-http-methods" }, + "operationId": "Scroll_Get", "parameters": [ { - "name": "master_timeout", + "name": "scroll", "in": "query", - "description": "Operation timeout for connection to master node.", + "description": "Specify how long a consistent view of the index should be maintained for scrolled search.", "schema": { "type": "string", "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to master node.", - "x-version-deprecated": "2.0.0", - "x-data-type": "time", - "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", - "deprecated": true + "description": "Specify how long a consistent view of the index should be maintained for scrolled search.", + "x-data-type": "time" } }, { - "name": "cluster_manager_timeout", + "name": "scroll_id", "in": "query", - "description": "Operation timeout for connection to cluster-manager node.", + "description": "Scroll ID.", "schema": { "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to cluster-manager node.", - "x-data-type": "time" + "description": "Scroll ID." } }, { - "name": "timeout", + "name": "rest_total_hits_as_int", "in": "query", - "description": "Operation timeout.", + "description": "Indicates whether hits.total should be rendered as an integer or an object in the rest search response.", + "schema": { + "type": "boolean", + "default": false, + "description": "Indicates whether hits.total should be rendered as an integer or an object in the rest search response." + } + } + ], + "responses": { + "200": { + "description": "Scroll_Get 200 response" + } + }, + "x-operation-group": "scroll", + "x-version-added": "1.0" + }, + "post": { + "description": "Allows to retrieve a large numbers of results from a single search request.", + "operationId": "Scroll_Post", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Scroll_BodyParams" + } + } + } + }, + "parameters": [ + { + "name": "scroll", + "in": "query", + "description": "Specify how long a consistent view of the index should be maintained for scrolled search.", "schema": { "type": "string", "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout.", + "description": "Specify how long a consistent view of the index should be maintained for scrolled search.", "x-data-type": "time" } }, { - "name": "preserve_existing", + "name": "scroll_id", "in": "query", - "description": "Whether to update existing settings. If set to `true` existing settings on an index remain unchanged.", + "description": "Scroll ID.", "schema": { - "type": "boolean", - "default": false, - "description": "Whether to update existing settings. If set to `true` existing settings on an index remain unchanged." + "type": "string", + "description": "Scroll ID." } }, { - "name": "ignore_unavailable", + "name": "rest_total_hits_as_int", "in": "query", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", + "description": "Indicates whether hits.total should be rendered as an integer or an object in the rest search response.", "schema": { "type": "boolean", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." - } - }, - { - "name": "allow_no_indices", - "in": "query", - "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified).", - "schema": { - "type": "boolean", - "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)." - } - }, - { - "name": "expand_wildcards", - "in": "query", - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", - "schema": { - "$ref": "#/components/schemas/ExpandWildcards" - } - }, - { - "name": "flat_settings", - "in": "query", - "description": "Return settings in flat format.", - "schema": { - "type": "boolean", - "default": false, - "description": "Return settings in flat format." + "default": false, + "description": "Indicates whether hits.total should be rendered as an integer or an object in the rest search response." } } ], "responses": { "200": { - "description": "IndicesPutSettings 200 response" + "description": "Scroll_Post 200 response" } }, - "x-operation-group": "indices.put_settings", + "x-operation-group": "scroll", "x-version-added": "1.0" } }, - "/_settings/{name}": { - "get": { - "description": "Returns settings for one or more indices.", - "operationId": "IndicesGetSettings_WithName", + "/_search/scroll/{scroll_id}": { + "delete": { + "description": "Explicitly clears the search context for a scroll.", + "operationId": "ClearScroll_WithScrollId", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClearScroll_BodyParams" + } + } + } + }, + "deprecated": true, "parameters": [ { - "name": "name", + "name": "scroll_id", "in": "path", - "description": "Comma-separated list of settings.", + "description": "Comma-separated list of scroll IDs to clear.", "schema": { "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", - "description": "Comma-separated list of settings.", + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", + "description": "Comma-separated list of scroll IDs to clear.", + "deprecated": true, "x-data-type": "array" }, "required": true - }, + } + ], + "responses": { + "200": { + "description": "ClearScroll_WithScrollId 200 response" + } + }, + "x-deprecation-message": "A scroll id can be quite large and should be specified as part of the body", + "x-operation-group": "clear_scroll", + "x-version-added": "1.0", + "x-version-deprecated": "1.0" + }, + "get": { + "description": "Allows to retrieve a large numbers of results from a single search request.", + "operationId": "Scroll_Get_WithScrollId", + "deprecated": true, + "parameters": [ { - "name": "master_timeout", - "in": "query", - "description": "Operation timeout for connection to master node.", + "name": "scroll_id", + "in": "path", + "description": "Scroll ID.", "schema": { "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to master node.", - "x-version-deprecated": "2.0.0", - "x-data-type": "time", - "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", - "deprecated": true - } + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", + "description": "Scroll ID." + }, + "required": true }, { - "name": "cluster_manager_timeout", + "name": "scroll", "in": "query", - "description": "Operation timeout for connection to cluster-manager node.", + "description": "Specify how long a consistent view of the index should be maintained for scrolled search.", "schema": { "type": "string", "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to cluster-manager node.", + "description": "Specify how long a consistent view of the index should be maintained for scrolled search.", "x-data-type": "time" } }, { - "name": "ignore_unavailable", + "name": "scroll_id", "in": "query", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", + "description": "Scroll ID.", "schema": { - "type": "boolean", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." + "type": "string", + "description": "Scroll ID." } }, { - "name": "allow_no_indices", + "name": "rest_total_hits_as_int", "in": "query", - "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified).", + "description": "Indicates whether hits.total should be rendered as an integer or an object in the rest search response.", "schema": { "type": "boolean", - "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)." + "default": false, + "description": "Indicates whether hits.total should be rendered as an integer or an object in the rest search response." } - }, + } + ], + "responses": { + "200": { + "description": "Scroll_Get_WithScrollId 200 response" + } + }, + "x-deprecation-message": "A scroll id can be quite large and should be specified as part of the body", + "x-operation-group": "scroll", + "x-version-added": "1.0", + "x-version-deprecated": "1.0" + }, + "post": { + "description": "Allows to retrieve a large numbers of results from a single search request.", + "operationId": "Scroll_Post_WithScrollId", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Scroll_BodyParams" + } + } + } + }, + "deprecated": true, + "parameters": [ { - "name": "expand_wildcards", - "in": "query", - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", + "name": "scroll_id", + "in": "path", + "description": "Scroll ID.", "schema": { - "$ref": "#/components/schemas/ExpandWildcards" - } + "type": "string", + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", + "description": "Scroll ID." + }, + "required": true }, { - "name": "flat_settings", + "name": "scroll", "in": "query", - "description": "Return settings in flat format.", + "description": "Specify how long a consistent view of the index should be maintained for scrolled search.", "schema": { - "type": "boolean", - "default": false, - "description": "Return settings in flat format." + "type": "string", + "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", + "description": "Specify how long a consistent view of the index should be maintained for scrolled search.", + "x-data-type": "time" } }, { - "name": "local", + "name": "scroll_id", "in": "query", - "description": "Return local information, do not retrieve the state from cluster-manager node.", + "description": "Scroll ID.", "schema": { - "type": "boolean", - "default": false, - "description": "Return local information, do not retrieve the state from cluster-manager node." + "type": "string", + "description": "Scroll ID." } }, { - "name": "include_defaults", + "name": "rest_total_hits_as_int", "in": "query", - "description": "Whether to return all default setting for each of the indices.", + "description": "Indicates whether hits.total should be rendered as an integer or an object in the rest search response.", "schema": { "type": "boolean", "default": false, - "description": "Whether to return all default setting for each of the indices." + "description": "Indicates whether hits.total should be rendered as an integer or an object in the rest search response." } } ], "responses": { "200": { - "description": "IndicesGetSettings_WithName 200 response" + "description": "Scroll_Post_WithScrollId 200 response" } }, - "x-operation-group": "indices.get_settings", - "x-version-added": "1.0" + "x-deprecation-message": "A scroll id can be quite large and should be specified as part of the body", + "x-operation-group": "scroll", + "x-version-added": "1.0", + "x-version-deprecated": "1.0" } }, - "/_shard_stores": { + "/_search/template": { "get": { - "description": "Provides store information for shard copies of indices.", + "description": "Allows to use the Mustache language to pre-render a search definition.", "externalDocs": { "description": "API Reference", - "url": "https://opensearch.org/docs/latest" + "url": "https://opensearch.org/docs/latest/search-plugins/search-template/" }, - "operationId": "IndicesShardStores", + "operationId": "SearchTemplate_Get", "parameters": [ { - "name": "status", + "name": "ignore_unavailable", "in": "query", - "description": "Comma-separated list of statuses used to filter on shards to get store information for.", - "style": "form", + "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Status_Member" - }, - "description": "Comma-separated list of statuses used to filter on shards to get store information for." - }, - "explode": true + "type": "boolean", + "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." + } }, { - "name": "ignore_unavailable", + "name": "ignore_throttled", "in": "query", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", + "description": "Whether specified concrete, expanded or aliased indices should be ignored when throttled.", "schema": { "type": "boolean", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." + "description": "Whether specified concrete, expanded or aliased indices should be ignored when throttled." } }, { @@ -15104,259 +15739,114 @@ "schema": { "$ref": "#/components/schemas/ExpandWildcards" } - } - ], - "responses": { - "200": { - "description": "IndicesShardStores 200 response" - } - }, - "x-operation-group": "indices.shard_stores", - "x-version-added": "1.0" - } - }, - "/_snapshot": { - "get": { - "description": "Returns information about a repository.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest" - }, - "operationId": "SnapshotGetRepository", - "parameters": [ - { - "name": "master_timeout", - "in": "query", - "description": "Operation timeout for connection to master node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to master node.", - "x-version-deprecated": "2.0.0", - "x-data-type": "time", - "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", - "deprecated": true - } }, { - "name": "cluster_manager_timeout", + "name": "preference", "in": "query", - "description": "Operation timeout for connection to cluster-manager node.", + "description": "Specify the node or shard the operation should be performed on.", "schema": { "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to cluster-manager node.", - "x-data-type": "time" + "default": "random", + "description": "Specify the node or shard the operation should be performed on." } }, { - "name": "local", + "name": "routing", "in": "query", - "description": "Return local information, do not retrieve the state from cluster-manager node.", - "schema": { - "type": "boolean", - "default": false, - "description": "Return local information, do not retrieve the state from cluster-manager node." - } - } - ], - "responses": { - "200": { - "description": "SnapshotGetRepository 200 response" - } - }, - "x-operation-group": "snapshot.get_repository", - "x-version-added": "1.0" - } - }, - "/_snapshot/_status": { - "get": { - "description": "Returns information about the status of a snapshot.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest" - }, - "operationId": "SnapshotStatus", - "parameters": [ - { - "name": "master_timeout", - "in": "query", - "description": "Operation timeout for connection to master node.", + "description": "Comma-separated list of specific routing values.", + "style": "form", "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to master node.", - "x-version-deprecated": "2.0.0", - "x-data-type": "time", - "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", - "deprecated": true - } + "type": "array", + "items": { + "type": "string" + }, + "description": "Comma-separated list of specific routing values." + }, + "explode": true }, { - "name": "cluster_manager_timeout", + "name": "scroll", "in": "query", - "description": "Operation timeout for connection to cluster-manager node.", + "description": "Specify how long a consistent view of the index should be maintained for scrolled search.", "schema": { "type": "string", "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to cluster-manager node.", + "description": "Specify how long a consistent view of the index should be maintained for scrolled search.", "x-data-type": "time" } }, { - "name": "ignore_unavailable", - "in": "query", - "description": "Whether to ignore unavailable snapshots, defaults to false which means a SnapshotMissingException is thrown.", - "schema": { - "type": "boolean", - "default": false, - "description": "Whether to ignore unavailable snapshots, defaults to false which means a SnapshotMissingException is thrown." - } - } - ], - "responses": { - "200": { - "description": "SnapshotStatus 200 response" - } - }, - "x-operation-group": "snapshot.status", - "x-version-added": "1.0" - } - }, - "/_snapshot/{repository}": { - "delete": { - "description": "Deletes a repository.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest" - }, - "operationId": "SnapshotDeleteRepository", - "parameters": [ - { - "name": "repository", - "in": "path", - "description": "Name of the snapshot repository to unregister. Wildcard (`*`) patterns are supported.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", - "description": "Name of the snapshot repository to unregister. Wildcard (`*`) patterns are supported.", - "x-data-type": "array" - }, - "required": true - }, - { - "name": "master_timeout", + "name": "search_type", "in": "query", - "description": "Operation timeout for connection to master node.", + "description": "Search operation type.", "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to master node.", - "x-version-deprecated": "2.0.0", - "x-data-type": "time", - "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", - "deprecated": true + "$ref": "#/components/schemas/SearchTypeMulti" } }, { - "name": "cluster_manager_timeout", + "name": "explain", "in": "query", - "description": "Operation timeout for connection to cluster-manager node.", + "description": "Specify whether to return detailed information about score computation as part of a hit.", "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to cluster-manager node.", - "x-data-type": "time" + "type": "boolean", + "description": "Specify whether to return detailed information about score computation as part of a hit." } }, { - "name": "timeout", + "name": "profile", "in": "query", - "description": "Operation timeout.", + "description": "Specify whether to profile the query execution.", "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout.", - "x-data-type": "time" + "type": "boolean", + "description": "Specify whether to profile the query execution." } - } - ], - "responses": { - "200": { - "description": "SnapshotDeleteRepository 200 response" - } - }, - "x-operation-group": "snapshot.delete_repository", - "x-version-added": "1.0" - }, - "get": { - "description": "Returns information about a repository.", - "operationId": "SnapshotGetRepository_WithRepository", - "parameters": [ - { - "name": "repository", - "in": "path", - "description": "Comma-separated list of repository names.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", - "description": "Comma-separated list of repository names.", - "x-data-type": "array" - }, - "required": true }, { - "name": "master_timeout", + "name": "typed_keys", "in": "query", - "description": "Operation timeout for connection to master node.", + "description": "Specify whether aggregation and suggester names should be prefixed by their respective types in the response.", "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to master node.", - "x-version-deprecated": "2.0.0", - "x-data-type": "time", - "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", - "deprecated": true + "type": "boolean", + "description": "Specify whether aggregation and suggester names should be prefixed by their respective types in the response." } }, { - "name": "cluster_manager_timeout", + "name": "rest_total_hits_as_int", "in": "query", - "description": "Operation timeout for connection to cluster-manager node.", + "description": "Indicates whether hits.total should be rendered as an integer or an object in the rest search response.", "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to cluster-manager node.", - "x-data-type": "time" + "type": "boolean", + "default": false, + "description": "Indicates whether hits.total should be rendered as an integer or an object in the rest search response." } }, { - "name": "local", + "name": "ccs_minimize_roundtrips", "in": "query", - "description": "Return local information, do not retrieve the state from cluster-manager node.", + "description": "Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution.", "schema": { "type": "boolean", - "default": false, - "description": "Return local information, do not retrieve the state from cluster-manager node." + "default": true, + "description": "Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution." } } ], "responses": { "200": { - "description": "SnapshotGetRepository_WithRepository 200 response" + "description": "SearchTemplate_Get 200 response" } }, - "x-operation-group": "snapshot.get_repository", + "x-operation-group": "search_template", "x-version-added": "1.0" }, "post": { - "description": "Creates a repository.", - "operationId": "SnapshotCreateRepository_Post", + "description": "Allows to use the Mustache language to pre-render a search definition.", + "operationId": "SearchTemplate_Post", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SnapshotCreateRepository_BodyParams" + "$ref": "#/components/schemas/SearchTemplate_BodyParams" } } }, @@ -15364,378 +15854,346 @@ }, "parameters": [ { - "name": "repository", - "in": "path", - "description": "Repository name.", + "name": "ignore_unavailable", + "in": "query", + "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", - "description": "Repository name." - }, - "required": true + "type": "boolean", + "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." + } }, { - "name": "master_timeout", + "name": "ignore_throttled", "in": "query", - "description": "Operation timeout for connection to master node.", + "description": "Whether specified concrete, expanded or aliased indices should be ignored when throttled.", "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to master node.", - "x-version-deprecated": "2.0.0", - "x-data-type": "time", - "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", - "deprecated": true + "type": "boolean", + "description": "Whether specified concrete, expanded or aliased indices should be ignored when throttled." } }, { - "name": "cluster_manager_timeout", + "name": "allow_no_indices", "in": "query", - "description": "Operation timeout for connection to cluster-manager node.", + "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified).", "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to cluster-manager node.", - "x-data-type": "time" + "type": "boolean", + "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)." } }, { - "name": "timeout", + "name": "expand_wildcards", "in": "query", - "description": "Operation timeout.", + "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout.", - "x-data-type": "time" + "$ref": "#/components/schemas/ExpandWildcards" } }, { - "name": "verify", + "name": "preference", "in": "query", - "description": "Whether to verify the repository after creation.", + "description": "Specify the node or shard the operation should be performed on.", "schema": { - "type": "boolean", - "description": "Whether to verify the repository after creation." - } - } - ], - "responses": { - "200": { - "description": "SnapshotCreateRepository_Post 200 response" - } - }, - "x-operation-group": "snapshot.create_repository", - "x-version-added": "1.0" - }, - "put": { - "description": "Creates a repository.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest" - }, - "operationId": "SnapshotCreateRepository_Put", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SnapshotCreateRepository_BodyParams" - } + "type": "string", + "default": "random", + "description": "Specify the node or shard the operation should be performed on." } }, - "required": true - }, - "parameters": [ { - "name": "repository", - "in": "path", - "description": "Repository name.", + "name": "routing", + "in": "query", + "description": "Comma-separated list of specific routing values.", + "style": "form", "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", - "description": "Repository name." + "type": "array", + "items": { + "type": "string" + }, + "description": "Comma-separated list of specific routing values." }, - "required": true + "explode": true }, { - "name": "master_timeout", + "name": "scroll", "in": "query", - "description": "Operation timeout for connection to master node.", + "description": "Specify how long a consistent view of the index should be maintained for scrolled search.", "schema": { "type": "string", "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to master node.", - "x-version-deprecated": "2.0.0", - "x-data-type": "time", - "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", - "deprecated": true + "description": "Specify how long a consistent view of the index should be maintained for scrolled search.", + "x-data-type": "time" } }, { - "name": "cluster_manager_timeout", + "name": "search_type", "in": "query", - "description": "Operation timeout for connection to cluster-manager node.", + "description": "Search operation type.", "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to cluster-manager node.", - "x-data-type": "time" + "$ref": "#/components/schemas/SearchTypeMulti" } }, { - "name": "timeout", + "name": "explain", "in": "query", - "description": "Operation timeout.", + "description": "Specify whether to return detailed information about score computation as part of a hit.", "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout.", - "x-data-type": "time" + "type": "boolean", + "description": "Specify whether to return detailed information about score computation as part of a hit." } }, { - "name": "verify", + "name": "profile", "in": "query", - "description": "Whether to verify the repository after creation.", + "description": "Specify whether to profile the query execution.", "schema": { "type": "boolean", - "description": "Whether to verify the repository after creation." + "description": "Specify whether to profile the query execution." + } + }, + { + "name": "typed_keys", + "in": "query", + "description": "Specify whether aggregation and suggester names should be prefixed by their respective types in the response.", + "schema": { + "type": "boolean", + "description": "Specify whether aggregation and suggester names should be prefixed by their respective types in the response." + } + }, + { + "name": "rest_total_hits_as_int", + "in": "query", + "description": "Indicates whether hits.total should be rendered as an integer or an object in the rest search response.", + "schema": { + "type": "boolean", + "default": false, + "description": "Indicates whether hits.total should be rendered as an integer or an object in the rest search response." + } + }, + { + "name": "ccs_minimize_roundtrips", + "in": "query", + "description": "Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution.", + "schema": { + "type": "boolean", + "default": true, + "description": "Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution." } } ], "responses": { "200": { - "description": "SnapshotCreateRepository_Put 200 response" + "description": "SearchTemplate_Post 200 response" } }, - "x-operation-group": "snapshot.create_repository", + "x-operation-group": "search_template", "x-version-added": "1.0" } }, - "/_snapshot/{repository}/_cleanup": { - "post": { - "description": "Removes stale data from repository.", + "/_search_shards": { + "get": { + "description": "Returns information about the indices and shards that a search request would be executed against.", "externalDocs": { "description": "API Reference", "url": "https://opensearch.org/docs/latest" }, - "operationId": "SnapshotCleanupRepository", + "operationId": "SearchShards_Get", "parameters": [ { - "name": "repository", - "in": "path", - "description": "Repository name.", + "name": "preference", + "in": "query", + "description": "Specify the node or shard the operation should be performed on.", "schema": { "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", - "description": "Repository name." - }, - "required": true + "default": "random", + "description": "Specify the node or shard the operation should be performed on." + } }, { - "name": "master_timeout", + "name": "routing", "in": "query", - "description": "Operation timeout for connection to master node.", + "description": "Routing value.", "schema": { "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to master node.", - "x-version-deprecated": "2.0.0", - "x-data-type": "time", - "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", - "deprecated": true + "description": "Routing value." } }, { - "name": "cluster_manager_timeout", + "name": "local", "in": "query", - "description": "Operation timeout for connection to cluster-manager node.", + "description": "Return local information, do not retrieve the state from cluster-manager node.", "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to cluster-manager node.", - "x-data-type": "time" + "type": "boolean", + "default": false, + "description": "Return local information, do not retrieve the state from cluster-manager node." } }, { - "name": "timeout", + "name": "ignore_unavailable", "in": "query", - "description": "Operation timeout.", + "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout.", - "x-data-type": "time" + "type": "boolean", + "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." + } + }, + { + "name": "allow_no_indices", + "in": "query", + "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified).", + "schema": { + "type": "boolean", + "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)." + } + }, + { + "name": "expand_wildcards", + "in": "query", + "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", + "schema": { + "$ref": "#/components/schemas/ExpandWildcards" } } ], "responses": { "200": { - "description": "SnapshotCleanupRepository 200 response" + "description": "SearchShards_Get 200 response" } }, - "x-operation-group": "snapshot.cleanup_repository", + "x-operation-group": "search_shards", "x-version-added": "1.0" - } - }, - "/_snapshot/{repository}/_status": { - "get": { - "description": "Returns information about the status of a snapshot.", - "operationId": "SnapshotStatus_WithRepository", + }, + "post": { + "description": "Returns information about the indices and shards that a search request would be executed against.", + "operationId": "SearchShards_Post", "parameters": [ { - "name": "repository", - "in": "path", - "description": "Repository name.", + "name": "preference", + "in": "query", + "description": "Specify the node or shard the operation should be performed on.", "schema": { "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", - "description": "Repository name." - }, - "required": true + "default": "random", + "description": "Specify the node or shard the operation should be performed on." + } }, { - "name": "master_timeout", + "name": "routing", "in": "query", - "description": "Operation timeout for connection to master node.", + "description": "Routing value.", "schema": { "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to master node.", - "x-version-deprecated": "2.0.0", - "x-data-type": "time", - "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", - "deprecated": true + "description": "Routing value." } }, { - "name": "cluster_manager_timeout", + "name": "local", "in": "query", - "description": "Operation timeout for connection to cluster-manager node.", + "description": "Return local information, do not retrieve the state from cluster-manager node.", "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to cluster-manager node.", - "x-data-type": "time" + "type": "boolean", + "default": false, + "description": "Return local information, do not retrieve the state from cluster-manager node." } }, { "name": "ignore_unavailable", "in": "query", - "description": "Whether to ignore unavailable snapshots, defaults to false which means a SnapshotMissingException is thrown.", + "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", "schema": { "type": "boolean", - "default": false, - "description": "Whether to ignore unavailable snapshots, defaults to false which means a SnapshotMissingException is thrown." + "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." + } + }, + { + "name": "allow_no_indices", + "in": "query", + "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified).", + "schema": { + "type": "boolean", + "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)." + } + }, + { + "name": "expand_wildcards", + "in": "query", + "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", + "schema": { + "$ref": "#/components/schemas/ExpandWildcards" } } ], "responses": { "200": { - "description": "SnapshotStatus_WithRepository 200 response" + "description": "SearchShards_Post 200 response" } }, - "x-operation-group": "snapshot.status", + "x-operation-group": "search_shards", "x-version-added": "1.0" } }, - "/_snapshot/{repository}/_verify": { - "post": { - "description": "Verifies a repository.", + "/_segments": { + "get": { + "description": "Provides low-level information about segments in a Lucene index.", "externalDocs": { "description": "API Reference", "url": "https://opensearch.org/docs/latest" }, - "operationId": "SnapshotVerifyRepository", + "operationId": "IndicesSegments", "parameters": [ { - "name": "repository", - "in": "path", - "description": "Repository name.", + "name": "ignore_unavailable", + "in": "query", + "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", - "description": "Repository name." - }, - "required": true + "type": "boolean", + "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." + } }, { - "name": "master_timeout", + "name": "allow_no_indices", "in": "query", - "description": "Operation timeout for connection to master node.", + "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified).", "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to master node.", - "x-version-deprecated": "2.0.0", - "x-data-type": "time", - "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", - "deprecated": true + "type": "boolean", + "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)." } }, { - "name": "cluster_manager_timeout", + "name": "expand_wildcards", "in": "query", - "description": "Operation timeout for connection to cluster-manager node.", + "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to cluster-manager node.", - "x-data-type": "time" + "$ref": "#/components/schemas/ExpandWildcards" } }, { - "name": "timeout", + "name": "verbose", "in": "query", - "description": "Operation timeout.", + "description": "Includes detailed memory usage by Lucene.", "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout.", - "x-data-type": "time" + "type": "boolean", + "default": false, + "description": "Includes detailed memory usage by Lucene." } } ], "responses": { "200": { - "description": "SnapshotVerifyRepository 200 response" + "description": "IndicesSegments 200 response" } }, - "x-operation-group": "snapshot.verify_repository", + "x-operation-group": "indices.segments", "x-version-added": "1.0" } }, - "/_snapshot/{repository}/{snapshot}": { - "delete": { - "description": "Deletes a snapshot.", + "/_settings": { + "get": { + "description": "Returns settings for one or more indices.", "externalDocs": { "description": "API Reference", - "url": "https://opensearch.org/docs/latest" + "url": "https://opensearch.org/docs/latest/api-reference/index-apis/get-settings/" }, - "operationId": "SnapshotDelete", + "operationId": "IndicesGetSettings", "parameters": [ - { - "name": "repository", - "in": "path", - "description": "Repository name.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", - "description": "Repository name." - }, - "required": true - }, - { - "name": "snapshot", - "in": "path", - "description": "Snapshot name.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", - "description": "Snapshot name." - }, - "required": true - }, { "name": "master_timeout", "in": "query", @@ -15760,135 +16218,90 @@ "description": "Operation timeout for connection to cluster-manager node.", "x-data-type": "time" } - } - ], - "responses": { - "200": { - "description": "SnapshotDelete 200 response" - } - }, - "x-operation-group": "snapshot.delete", - "x-version-added": "1.0" - }, - "get": { - "description": "Returns information about a snapshot.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest" - }, - "operationId": "SnapshotGet", - "parameters": [ + }, { - "name": "repository", - "in": "path", - "description": "Repository name.", + "name": "ignore_unavailable", + "in": "query", + "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", - "description": "Repository name." - }, - "required": true + "type": "boolean", + "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." + } }, { - "name": "snapshot", - "in": "path", - "description": "Comma-separated list of snapshot names.", + "name": "allow_no_indices", + "in": "query", + "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified).", "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", - "description": "Comma-separated list of snapshot names.", - "x-data-type": "array" - }, - "required": true + "type": "boolean", + "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)." + } }, { - "name": "master_timeout", + "name": "expand_wildcards", "in": "query", - "description": "Operation timeout for connection to master node.", + "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to master node.", - "x-version-deprecated": "2.0.0", - "x-data-type": "time", - "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", - "deprecated": true + "$ref": "#/components/schemas/ExpandWildcards" } }, { - "name": "cluster_manager_timeout", + "name": "flat_settings", "in": "query", - "description": "Operation timeout for connection to cluster-manager node.", + "description": "Return settings in flat format.", "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to cluster-manager node.", - "x-data-type": "time" + "type": "boolean", + "default": false, + "description": "Return settings in flat format." } }, { - "name": "ignore_unavailable", + "name": "local", "in": "query", - "description": "Whether to ignore unavailable snapshots, defaults to false which means a SnapshotMissingException is thrown.", + "description": "Return local information, do not retrieve the state from cluster-manager node.", "schema": { "type": "boolean", "default": false, - "description": "Whether to ignore unavailable snapshots, defaults to false which means a SnapshotMissingException is thrown." + "description": "Return local information, do not retrieve the state from cluster-manager node." } }, { - "name": "verbose", + "name": "include_defaults", "in": "query", - "description": "Whether to show verbose snapshot info or only show the basic info found in the repository index blob.", + "description": "Whether to return all default setting for each of the indices.", "schema": { "type": "boolean", - "description": "Whether to show verbose snapshot info or only show the basic info found in the repository index blob." + "default": false, + "description": "Whether to return all default setting for each of the indices." } } ], "responses": { "200": { - "description": "SnapshotGet 200 response" + "description": "IndicesGetSettings 200 response" } }, - "x-operation-group": "snapshot.get", + "x-operation-group": "indices.get_settings", "x-version-added": "1.0" }, - "post": { - "description": "Creates a snapshot in a repository.", - "operationId": "SnapshotCreate_Post", + "put": { + "description": "Updates the index settings.", + "externalDocs": { + "description": "API Reference", + "url": "https://opensearch.org/docs/latest/api-reference/index-apis/update-settings/" + }, + "operationId": "IndicesPutSettings", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SnapshotCreate_BodyParams" + "$ref": "#/components/schemas/IndicesPutSettings_BodyParams" } } - } + }, + "required": true }, "parameters": [ - { - "name": "repository", - "in": "path", - "description": "Repository name.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", - "description": "Repository name." - }, - "required": true - }, - { - "name": "snapshot", - "in": "path", - "description": "Snapshot name.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", - "description": "Snapshot name." - }, - "required": true - }, { "name": "master_timeout", "in": "query", @@ -15915,60 +16328,86 @@ } }, { - "name": "wait_for_completion", + "name": "timeout", "in": "query", - "description": "Should this request wait until the operation has completed before returning.", + "description": "Operation timeout.", + "schema": { + "type": "string", + "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", + "description": "Operation timeout.", + "x-data-type": "time" + } + }, + { + "name": "preserve_existing", + "in": "query", + "description": "Whether to update existing settings. If set to `true` existing settings on an index remain unchanged.", "schema": { "type": "boolean", "default": false, - "description": "Should this request wait until the operation has completed before returning." + "description": "Whether to update existing settings. If set to `true` existing settings on an index remain unchanged." + } + }, + { + "name": "ignore_unavailable", + "in": "query", + "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", + "schema": { + "type": "boolean", + "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." + } + }, + { + "name": "allow_no_indices", + "in": "query", + "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified).", + "schema": { + "type": "boolean", + "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)." + } + }, + { + "name": "expand_wildcards", + "in": "query", + "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", + "schema": { + "$ref": "#/components/schemas/ExpandWildcards" + } + }, + { + "name": "flat_settings", + "in": "query", + "description": "Return settings in flat format.", + "schema": { + "type": "boolean", + "default": false, + "description": "Return settings in flat format." } } ], "responses": { "200": { - "description": "SnapshotCreate_Post 200 response" + "description": "IndicesPutSettings 200 response" } }, - "x-operation-group": "snapshot.create", + "x-operation-group": "indices.put_settings", "x-version-added": "1.0" - }, - "put": { - "description": "Creates a snapshot in a repository.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest" - }, - "operationId": "SnapshotCreate_Put", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SnapshotCreate_BodyParams" - } - } - } - }, + } + }, + "/_settings/{name}": { + "get": { + "description": "Returns settings for one or more indices.", + "operationId": "IndicesGetSettings_WithName", "parameters": [ { - "name": "repository", - "in": "path", - "description": "Repository name.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", - "description": "Repository name." - }, - "required": true - }, - { - "name": "snapshot", + "name": "name", "in": "path", - "description": "Snapshot name.", + "description": "Comma-separated list of settings.", "schema": { "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", - "description": "Snapshot name." + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", + "description": "Comma-separated list of settings.", + "x-data-type": "array" }, "required": true }, @@ -15998,152 +16437,139 @@ } }, { - "name": "wait_for_completion", + "name": "ignore_unavailable", "in": "query", - "description": "Should this request wait until the operation has completed before returning.", + "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", + "schema": { + "type": "boolean", + "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." + } + }, + { + "name": "allow_no_indices", + "in": "query", + "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified).", + "schema": { + "type": "boolean", + "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)." + } + }, + { + "name": "expand_wildcards", + "in": "query", + "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", + "schema": { + "$ref": "#/components/schemas/ExpandWildcards" + } + }, + { + "name": "flat_settings", + "in": "query", + "description": "Return settings in flat format.", "schema": { "type": "boolean", "default": false, - "description": "Should this request wait until the operation has completed before returning." + "description": "Return settings in flat format." + } + }, + { + "name": "local", + "in": "query", + "description": "Return local information, do not retrieve the state from cluster-manager node.", + "schema": { + "type": "boolean", + "default": false, + "description": "Return local information, do not retrieve the state from cluster-manager node." + } + }, + { + "name": "include_defaults", + "in": "query", + "description": "Whether to return all default setting for each of the indices.", + "schema": { + "type": "boolean", + "default": false, + "description": "Whether to return all default setting for each of the indices." } } ], "responses": { "200": { - "description": "SnapshotCreate_Put 200 response" + "description": "IndicesGetSettings_WithName 200 response" } }, - "x-operation-group": "snapshot.create", + "x-operation-group": "indices.get_settings", "x-version-added": "1.0" } }, - "/_snapshot/{repository}/{snapshot}/_clone/{target_snapshot}": { - "put": { - "description": "Clones indices from one snapshot into another snapshot in the same repository.", + "/_shard_stores": { + "get": { + "description": "Provides store information for shard copies of indices.", "externalDocs": { "description": "API Reference", "url": "https://opensearch.org/docs/latest" }, - "operationId": "SnapshotClone", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SnapshotClone_BodyParams" - } - } - }, - "required": true - }, + "operationId": "IndicesShardStores", "parameters": [ { - "name": "repository", - "in": "path", - "description": "Repository name.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", - "description": "Repository name." - }, - "required": true - }, - { - "name": "snapshot", - "in": "path", - "description": "Snapshot name.", + "name": "status", + "in": "query", + "description": "Comma-separated list of statuses used to filter on shards to get store information for.", + "style": "form", "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", - "description": "Snapshot name." + "type": "array", + "items": { + "$ref": "#/components/schemas/Status_Member" + }, + "description": "Comma-separated list of statuses used to filter on shards to get store information for." }, - "required": true + "explode": true }, { - "name": "target_snapshot", - "in": "path", - "description": "The name of the cloned snapshot to create.", + "name": "ignore_unavailable", + "in": "query", + "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", - "description": "The name of the cloned snapshot to create." - }, - "required": true + "type": "boolean", + "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." + } }, { - "name": "master_timeout", + "name": "allow_no_indices", "in": "query", - "description": "Operation timeout for connection to master node.", + "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified).", "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to master node.", - "x-version-deprecated": "2.0.0", - "x-data-type": "time", - "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", - "deprecated": true + "type": "boolean", + "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)." } }, { - "name": "cluster_manager_timeout", + "name": "expand_wildcards", "in": "query", - "description": "Operation timeout for connection to cluster-manager node.", + "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to cluster-manager node.", - "x-data-type": "time" + "$ref": "#/components/schemas/ExpandWildcards" } } ], "responses": { "200": { - "description": "SnapshotClone 200 response" + "description": "IndicesShardStores 200 response" } }, - "x-operation-group": "snapshot.clone", + "x-operation-group": "indices.shard_stores", "x-version-added": "1.0" } }, - "/_snapshot/{repository}/{snapshot}/_restore": { - "post": { - "description": "Restores a snapshot.", + "/_snapshot": { + "get": { + "description": "Returns information about a repository.", "externalDocs": { "description": "API Reference", - "url": "https://opensearch.org/docs/latest" - }, - "operationId": "SnapshotRestore", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SnapshotRestore_BodyParams" - } - } - } + "url": "https://opensearch.org/docs/latest/api-reference/snapshots/get-snapshot-repository/" }, + "operationId": "SnapshotGetRepository", "parameters": [ - { - "name": "repository", - "in": "path", - "description": "Repository name.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", - "description": "Repository name." - }, - "required": true - }, - { - "name": "snapshot", - "in": "path", - "description": "Snapshot name.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", - "description": "Snapshot name." - }, - "required": true - }, { "name": "master_timeout", "in": "query", @@ -16170,53 +16596,34 @@ } }, { - "name": "wait_for_completion", + "name": "local", "in": "query", - "description": "Should this request wait until the operation has completed before returning.", + "description": "Return local information, do not retrieve the state from cluster-manager node.", "schema": { "type": "boolean", "default": false, - "description": "Should this request wait until the operation has completed before returning." + "description": "Return local information, do not retrieve the state from cluster-manager node." } } ], "responses": { "200": { - "description": "SnapshotRestore 200 response" + "description": "SnapshotGetRepository 200 response" } }, - "x-operation-group": "snapshot.restore", + "x-operation-group": "snapshot.get_repository", "x-version-added": "1.0" } }, - "/_snapshot/{repository}/{snapshot}/_status": { + "/_snapshot/_status": { "get": { "description": "Returns information about the status of a snapshot.", - "operationId": "SnapshotStatus_WithRepositorySnapshot", + "externalDocs": { + "description": "API Reference", + "url": "https://opensearch.org/docs/latest/api-reference/snapshots/get-snapshot-status/" + }, + "operationId": "SnapshotStatus", "parameters": [ - { - "name": "repository", - "in": "path", - "description": "Repository name.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", - "description": "Repository name." - }, - "required": true - }, - { - "name": "snapshot", - "in": "path", - "description": "Comma-separated list of snapshot names.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", - "description": "Comma-separated list of snapshot names.", - "x-data-type": "array" - }, - "required": true - }, { "name": "master_timeout", "in": "query", @@ -16255,353 +16662,345 @@ ], "responses": { "200": { - "description": "SnapshotStatus_WithRepositorySnapshot 200 response" + "description": "SnapshotStatus 200 response" } }, "x-operation-group": "snapshot.status", "x-version-added": "1.0" } }, - "/_stats": { - "get": { - "description": "Provides statistics on operations happening in an index.", - "externalDocs": { + "/_snapshot/{repository}": { + "delete": { + "description": "Deletes a repository.", + "externalDocs": { "description": "API Reference", - "url": "https://opensearch.org/docs/latest" + "url": "https://opensearch.org/docs/latest/api-reference/snapshots/delete-snapshot-repository/" }, - "operationId": "IndicesStats", + "operationId": "SnapshotDeleteRepository", "parameters": [ { - "name": "completion_fields", - "in": "query", - "description": "Comma-separated list of fields for `fielddata` and `suggest` index metric (supports wildcards).", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of fields for `fielddata` and `suggest` index metric (supports wildcards)." - }, - "explode": true - }, - { - "name": "fielddata_fields", - "in": "query", - "description": "Comma-separated list of fields for `fielddata` index metric (supports wildcards).", - "style": "form", + "name": "repository", + "in": "path", + "description": "Name of the snapshot repository to unregister. Wildcard (`*`) patterns are supported.", "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of fields for `fielddata` index metric (supports wildcards)." + "type": "string", + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", + "description": "Name of the snapshot repository to unregister. Wildcard (`*`) patterns are supported.", + "x-data-type": "array" }, - "explode": true + "required": true }, { - "name": "fields", + "name": "master_timeout", "in": "query", - "description": "Comma-separated list of fields for `fielddata` and `completion` index metric (supports wildcards).", - "style": "form", + "description": "Operation timeout for connection to master node.", "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of fields for `fielddata` and `completion` index metric (supports wildcards)." - }, - "explode": true + "type": "string", + "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", + "description": "Operation timeout for connection to master node.", + "x-version-deprecated": "2.0.0", + "x-data-type": "time", + "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", + "deprecated": true + } }, { - "name": "groups", + "name": "cluster_manager_timeout", "in": "query", - "description": "Comma-separated list of search groups for `search` index metric.", - "style": "form", + "description": "Operation timeout for connection to cluster-manager node.", "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of search groups for `search` index metric." - }, - "explode": true + "type": "string", + "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", + "description": "Operation timeout for connection to cluster-manager node.", + "x-data-type": "time" + } }, { - "name": "level", + "name": "timeout", "in": "query", - "description": "Return stats aggregated at cluster, index or shard level.", + "description": "Operation timeout.", "schema": { - "$ref": "#/components/schemas/IndiciesStatLevel" + "type": "string", + "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", + "description": "Operation timeout.", + "x-data-type": "time" } - }, + } + ], + "responses": { + "200": { + "description": "SnapshotDeleteRepository 200 response" + } + }, + "x-operation-group": "snapshot.delete_repository", + "x-version-added": "1.0" + }, + "get": { + "description": "Returns information about a repository.", + "operationId": "SnapshotGetRepository_WithRepository", + "parameters": [ { - "name": "include_segment_file_sizes", - "in": "query", - "description": "Whether to report the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested).", + "name": "repository", + "in": "path", + "description": "Comma-separated list of repository names.", "schema": { - "type": "boolean", - "default": false, - "description": "Whether to report the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested)." - } + "type": "string", + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", + "description": "Comma-separated list of repository names.", + "x-data-type": "array" + }, + "required": true }, { - "name": "include_unloaded_segments", + "name": "master_timeout", "in": "query", - "description": "If set to true segment stats will include stats for segments that are not currently loaded into memory.", + "description": "Operation timeout for connection to master node.", "schema": { - "type": "boolean", - "default": false, - "description": "If set to true segment stats will include stats for segments that are not currently loaded into memory." + "type": "string", + "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", + "description": "Operation timeout for connection to master node.", + "x-version-deprecated": "2.0.0", + "x-data-type": "time", + "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", + "deprecated": true } }, { - "name": "expand_wildcards", + "name": "cluster_manager_timeout", "in": "query", - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", + "description": "Operation timeout for connection to cluster-manager node.", "schema": { - "$ref": "#/components/schemas/ExpandWildcards" + "type": "string", + "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", + "description": "Operation timeout for connection to cluster-manager node.", + "x-data-type": "time" } }, { - "name": "forbid_closed_indices", + "name": "local", "in": "query", - "description": "If set to false stats will also collected from closed indices if explicitly specified or if expand_wildcards expands to closed indices.", + "description": "Return local information, do not retrieve the state from cluster-manager node.", "schema": { "type": "boolean", - "default": true, - "description": "If set to false stats will also collected from closed indices if explicitly specified or if expand_wildcards expands to closed indices." + "default": false, + "description": "Return local information, do not retrieve the state from cluster-manager node." } } ], "responses": { "200": { - "description": "IndicesStats 200 response" + "description": "SnapshotGetRepository_WithRepository 200 response" } }, - "x-operation-group": "indices.stats", + "x-operation-group": "snapshot.get_repository", "x-version-added": "1.0" - } - }, - "/_stats/{metric}": { - "get": { - "description": "Provides statistics on operations happening in an index.", - "operationId": "IndicesStats_WithMetric", + }, + "post": { + "description": "Creates a repository.", + "operationId": "SnapshotCreateRepository_Post", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SnapshotCreateRepository_BodyParams" + } + } + }, + "required": true + }, "parameters": [ { - "name": "metric", + "name": "repository", "in": "path", - "description": "Limit the information returned the specific metrics.", + "description": "Repository name.", "schema": { "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", - "description": "Limit the information returned the specific metrics.", - "x-enum-options": [ - "_all", - "completion", - "docs", - "fielddata", - "query_cache", - "flush", - "get", - "indexing", - "merge", - "request_cache", - "refresh", - "search", - "segments", - "store", - "warmer", - "suggest" - ], - "x-data-type": "array" + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", + "description": "Repository name." }, "required": true }, { - "name": "completion_fields", + "name": "master_timeout", "in": "query", - "description": "Comma-separated list of fields for `fielddata` and `suggest` index metric (supports wildcards).", - "style": "form", + "description": "Operation timeout for connection to master node.", "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of fields for `fielddata` and `suggest` index metric (supports wildcards)." - }, - "explode": true + "type": "string", + "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", + "description": "Operation timeout for connection to master node.", + "x-version-deprecated": "2.0.0", + "x-data-type": "time", + "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", + "deprecated": true + } }, { - "name": "fielddata_fields", + "name": "cluster_manager_timeout", "in": "query", - "description": "Comma-separated list of fields for `fielddata` index metric (supports wildcards).", - "style": "form", + "description": "Operation timeout for connection to cluster-manager node.", "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of fields for `fielddata` index metric (supports wildcards)." - }, - "explode": true + "type": "string", + "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", + "description": "Operation timeout for connection to cluster-manager node.", + "x-data-type": "time" + } }, { - "name": "fields", + "name": "timeout", "in": "query", - "description": "Comma-separated list of fields for `fielddata` and `completion` index metric (supports wildcards).", - "style": "form", + "description": "Operation timeout.", "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of fields for `fielddata` and `completion` index metric (supports wildcards)." - }, - "explode": true + "type": "string", + "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", + "description": "Operation timeout.", + "x-data-type": "time" + } }, { - "name": "groups", + "name": "verify", "in": "query", - "description": "Comma-separated list of search groups for `search` index metric.", - "style": "form", + "description": "Whether to verify the repository after creation.", "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of search groups for `search` index metric." - }, - "explode": true + "type": "boolean", + "description": "Whether to verify the repository after creation." + } + } + ], + "responses": { + "200": { + "description": "SnapshotCreateRepository_Post 200 response" + } + }, + "x-operation-group": "snapshot.create_repository", + "x-version-added": "1.0" + }, + "put": { + "description": "Creates a repository.", + "externalDocs": { + "description": "API Reference", + "url": "https://opensearch.org/docs/latest/api-reference/snapshots/create-repository/" + }, + "operationId": "SnapshotCreateRepository_Put", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SnapshotCreateRepository_BodyParams" + } + } }, + "required": true + }, + "parameters": [ { - "name": "level", - "in": "query", - "description": "Return stats aggregated at cluster, index or shard level.", + "name": "repository", + "in": "path", + "description": "Repository name.", "schema": { - "$ref": "#/components/schemas/IndiciesStatLevel" - } + "type": "string", + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", + "description": "Repository name." + }, + "required": true }, { - "name": "include_segment_file_sizes", + "name": "master_timeout", "in": "query", - "description": "Whether to report the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested).", + "description": "Operation timeout for connection to master node.", "schema": { - "type": "boolean", - "default": false, - "description": "Whether to report the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested)." + "type": "string", + "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", + "description": "Operation timeout for connection to master node.", + "x-version-deprecated": "2.0.0", + "x-data-type": "time", + "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", + "deprecated": true } }, { - "name": "include_unloaded_segments", + "name": "cluster_manager_timeout", "in": "query", - "description": "If set to true segment stats will include stats for segments that are not currently loaded into memory.", + "description": "Operation timeout for connection to cluster-manager node.", "schema": { - "type": "boolean", - "default": false, - "description": "If set to true segment stats will include stats for segments that are not currently loaded into memory." + "type": "string", + "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", + "description": "Operation timeout for connection to cluster-manager node.", + "x-data-type": "time" } }, { - "name": "expand_wildcards", + "name": "timeout", "in": "query", - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", + "description": "Operation timeout.", "schema": { - "$ref": "#/components/schemas/ExpandWildcards" + "type": "string", + "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", + "description": "Operation timeout.", + "x-data-type": "time" } }, { - "name": "forbid_closed_indices", + "name": "verify", "in": "query", - "description": "If set to false stats will also collected from closed indices if explicitly specified or if expand_wildcards expands to closed indices.", + "description": "Whether to verify the repository after creation.", "schema": { "type": "boolean", - "default": true, - "description": "If set to false stats will also collected from closed indices if explicitly specified or if expand_wildcards expands to closed indices." + "description": "Whether to verify the repository after creation." } } ], "responses": { "200": { - "description": "IndicesStats_WithMetric 200 response" + "description": "SnapshotCreateRepository_Put 200 response" } }, - "x-operation-group": "indices.stats", + "x-operation-group": "snapshot.create_repository", "x-version-added": "1.0" } }, - "/_tasks": { - "get": { - "description": "Returns a list of tasks.", + "/_snapshot/{repository}/_cleanup": { + "post": { + "description": "Removes stale data from repository.", "externalDocs": { "description": "API Reference", "url": "https://opensearch.org/docs/latest" }, - "operationId": "TasksList", + "operationId": "SnapshotCleanupRepository", "parameters": [ { - "name": "nodes", - "in": "query", - "description": "Comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes." - }, - "explode": true - }, - { - "name": "actions", - "in": "query", - "description": "Comma-separated list of actions that should be returned. Leave empty to return all.", - "style": "form", + "name": "repository", + "in": "path", + "description": "Repository name.", "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of actions that should be returned. Leave empty to return all." + "type": "string", + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", + "description": "Repository name." }, - "explode": true - }, - { - "name": "detailed", - "in": "query", - "description": "Return detailed task information.", - "schema": { - "type": "boolean", - "default": false, - "description": "Return detailed task information." - } + "required": true }, { - "name": "parent_task_id", + "name": "master_timeout", "in": "query", - "description": "Return tasks with specified parent task id (node_id:task_number). Set to -1 to return all.", + "description": "Operation timeout for connection to master node.", "schema": { "type": "string", - "description": "Return tasks with specified parent task id (node_id:task_number). Set to -1 to return all." - } - }, - { - "name": "wait_for_completion", - "in": "query", - "description": "Should this request wait until the operation has completed before returning.", - "schema": { - "type": "boolean", - "default": false, - "description": "Should this request wait until the operation has completed before returning." + "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", + "description": "Operation timeout for connection to master node.", + "x-version-deprecated": "2.0.0", + "x-data-type": "time", + "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", + "deprecated": true } }, { - "name": "group_by", + "name": "cluster_manager_timeout", "in": "query", - "description": "Group tasks by nodes or parent/child relationships.", + "description": "Operation timeout for connection to cluster-manager node.", "schema": { - "$ref": "#/components/schemas/GroupBy" + "type": "string", + "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", + "description": "Operation timeout for connection to cluster-manager node.", + "x-data-type": "time" } }, { @@ -16618,107 +17017,117 @@ ], "responses": { "200": { - "description": "TasksList 200 response" + "description": "SnapshotCleanupRepository 200 response" } }, - "x-operation-group": "tasks.list", + "x-operation-group": "snapshot.cleanup_repository", "x-version-added": "1.0" } }, - "/_tasks/_cancel": { - "post": { - "description": "Cancels a task, if it can be cancelled through an API.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest" - }, - "operationId": "TasksCancel", + "/_snapshot/{repository}/_status": { + "get": { + "description": "Returns information about the status of a snapshot.", + "operationId": "SnapshotStatus_WithRepository", "parameters": [ { - "name": "nodes", - "in": "query", - "description": "Comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes.", - "style": "form", + "name": "repository", + "in": "path", + "description": "Repository name.", "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes." + "type": "string", + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", + "description": "Repository name." }, - "explode": true + "required": true }, { - "name": "actions", + "name": "master_timeout", "in": "query", - "description": "Comma-separated list of actions that should be cancelled. Leave empty to cancel all.", - "style": "form", + "description": "Operation timeout for connection to master node.", "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of actions that should be cancelled. Leave empty to cancel all." - }, - "explode": true + "type": "string", + "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", + "description": "Operation timeout for connection to master node.", + "x-version-deprecated": "2.0.0", + "x-data-type": "time", + "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", + "deprecated": true + } }, { - "name": "parent_task_id", + "name": "cluster_manager_timeout", "in": "query", - "description": "Cancel tasks with specified parent task id (node_id:task_number). Set to -1 to cancel all.", + "description": "Operation timeout for connection to cluster-manager node.", "schema": { "type": "string", - "description": "Cancel tasks with specified parent task id (node_id:task_number). Set to -1 to cancel all." + "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", + "description": "Operation timeout for connection to cluster-manager node.", + "x-data-type": "time" } }, { - "name": "wait_for_completion", + "name": "ignore_unavailable", "in": "query", - "description": "Should this request wait until the operation has completed before returning.", + "description": "Whether to ignore unavailable snapshots, defaults to false which means a SnapshotMissingException is thrown.", "schema": { "type": "boolean", "default": false, - "description": "Should this request wait until the operation has completed before returning." + "description": "Whether to ignore unavailable snapshots, defaults to false which means a SnapshotMissingException is thrown." } } ], "responses": { "200": { - "description": "TasksCancel 200 response" + "description": "SnapshotStatus_WithRepository 200 response" } }, - "x-operation-group": "tasks.cancel", + "x-operation-group": "snapshot.status", "x-version-added": "1.0" } }, - "/_tasks/{task_id}": { - "get": { - "description": "Returns information about a task.", + "/_snapshot/{repository}/_verify": { + "post": { + "description": "Verifies a repository.", "externalDocs": { "description": "API Reference", - "url": "https://opensearch.org/docs/latest" + "url": "https://opensearch.org/docs/latest/api-reference/snapshots/verify-snapshot-repository/" }, - "operationId": "TasksGet", + "operationId": "SnapshotVerifyRepository", "parameters": [ { - "name": "task_id", + "name": "repository", "in": "path", - "description": "Return the task with specified id (node_id:task_number).", + "description": "Repository name.", "schema": { "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", - "description": "Return the task with specified id (node_id:task_number)." + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", + "description": "Repository name." }, "required": true }, { - "name": "wait_for_completion", + "name": "master_timeout", "in": "query", - "description": "Should this request wait until the operation has completed before returning.", + "description": "Operation timeout for connection to master node.", "schema": { - "type": "boolean", - "default": false, - "description": "Should this request wait until the operation has completed before returning." + "type": "string", + "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", + "description": "Operation timeout for connection to master node.", + "x-version-deprecated": "2.0.0", + "x-data-type": "time", + "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", + "deprecated": true + } + }, + { + "name": "cluster_manager_timeout", + "in": "query", + "description": "Operation timeout for connection to cluster-manager node.", + "schema": { + "type": "string", + "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", + "description": "Operation timeout for connection to cluster-manager node.", + "x-data-type": "time" } }, { @@ -16735,104 +17144,108 @@ ], "responses": { "200": { - "description": "TasksGet 200 response" + "description": "SnapshotVerifyRepository 200 response" } }, - "x-operation-group": "tasks.get", + "x-operation-group": "snapshot.verify_repository", "x-version-added": "1.0" } }, - "/_tasks/{task_id}/_cancel": { - "post": { - "description": "Cancels a task, if it can be cancelled through an API.", - "operationId": "TasksCancel_WithTaskId", + "/_snapshot/{repository}/{snapshot}": { + "delete": { + "description": "Deletes a snapshot.", + "externalDocs": { + "description": "API Reference", + "url": "https://opensearch.org/docs/latest/api-reference/snapshots/delete-snapshot/" + }, + "operationId": "SnapshotDelete", "parameters": [ { - "name": "task_id", + "name": "repository", "in": "path", - "description": "Cancel the task with specified task id (node_id:task_number).", + "description": "Repository name.", "schema": { "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", - "description": "Cancel the task with specified task id (node_id:task_number)." + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", + "description": "Repository name." }, "required": true }, { - "name": "nodes", - "in": "query", - "description": "Comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes." - }, - "explode": true - }, - { - "name": "actions", - "in": "query", - "description": "Comma-separated list of actions that should be cancelled. Leave empty to cancel all.", - "style": "form", + "name": "snapshot", + "in": "path", + "description": "Snapshot name.", "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of actions that should be cancelled. Leave empty to cancel all." + "type": "string", + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", + "description": "Snapshot name." }, - "explode": true + "required": true }, { - "name": "parent_task_id", + "name": "master_timeout", "in": "query", - "description": "Cancel tasks with specified parent task id (node_id:task_number). Set to -1 to cancel all.", + "description": "Operation timeout for connection to master node.", "schema": { "type": "string", - "description": "Cancel tasks with specified parent task id (node_id:task_number). Set to -1 to cancel all." + "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", + "description": "Operation timeout for connection to master node.", + "x-version-deprecated": "2.0.0", + "x-data-type": "time", + "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", + "deprecated": true } }, { - "name": "wait_for_completion", + "name": "cluster_manager_timeout", "in": "query", - "description": "Should this request wait until the operation has completed before returning.", + "description": "Operation timeout for connection to cluster-manager node.", "schema": { - "type": "boolean", - "default": false, - "description": "Should this request wait until the operation has completed before returning." + "type": "string", + "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", + "description": "Operation timeout for connection to cluster-manager node.", + "x-data-type": "time" } } ], "responses": { "200": { - "description": "TasksCancel_WithTaskId 200 response" + "description": "SnapshotDelete 200 response" } }, - "x-operation-group": "tasks.cancel", + "x-operation-group": "snapshot.delete", "x-version-added": "1.0" - } - }, - "/_template": { + }, "get": { - "description": "Returns an index template.", + "description": "Returns information about a snapshot.", "externalDocs": { "description": "API Reference", "url": "https://opensearch.org/docs/latest" }, - "operationId": "IndicesGetTemplate", + "operationId": "SnapshotGet", "parameters": [ { - "name": "flat_settings", - "in": "query", - "description": "Return settings in flat format.", + "name": "repository", + "in": "path", + "description": "Repository name.", "schema": { - "type": "boolean", - "default": false, - "description": "Return settings in flat format." - } + "type": "string", + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", + "description": "Repository name." + }, + "required": true + }, + { + "name": "snapshot", + "in": "path", + "description": "Comma-separated list of snapshot names.", + "schema": { + "type": "string", + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", + "description": "Comma-separated list of snapshot names.", + "x-data-type": "array" + }, + "required": true }, { "name": "master_timeout", @@ -16860,55 +17273,67 @@ } }, { - "name": "local", + "name": "ignore_unavailable", "in": "query", - "description": "Return local information, do not retrieve the state from cluster-manager node.", + "description": "Whether to ignore unavailable snapshots, defaults to false which means a SnapshotMissingException is thrown.", "schema": { "type": "boolean", "default": false, - "description": "Return local information, do not retrieve the state from cluster-manager node." + "description": "Whether to ignore unavailable snapshots, defaults to false which means a SnapshotMissingException is thrown." + } + }, + { + "name": "verbose", + "in": "query", + "description": "Whether to show verbose snapshot info or only show the basic info found in the repository index blob.", + "schema": { + "type": "boolean", + "description": "Whether to show verbose snapshot info or only show the basic info found in the repository index blob." } } ], "responses": { "200": { - "description": "IndicesGetTemplate 200 response" + "description": "SnapshotGet 200 response" } }, - "x-operation-group": "indices.get_template", + "x-operation-group": "snapshot.get", "x-version-added": "1.0" - } - }, - "/_template/{name}": { - "delete": { - "description": "Deletes an index template.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest" + }, + "post": { + "description": "Creates a snapshot in a repository.", + "operationId": "SnapshotCreate_Post", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SnapshotCreate_BodyParams" + } + } + } }, - "operationId": "IndicesDeleteTemplate", "parameters": [ { - "name": "name", + "name": "repository", "in": "path", - "description": "The name of the template.", + "description": "Repository name.", "schema": { "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", - "description": "The name of the template." + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", + "description": "Repository name." }, "required": true }, { - "name": "timeout", - "in": "query", - "description": "Operation timeout.", + "name": "snapshot", + "in": "path", + "description": "Snapshot name.", "schema": { "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout.", - "x-data-type": "time" - } + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", + "description": "Snapshot name." + }, + "required": true }, { "name": "master_timeout", @@ -16934,41 +17359,64 @@ "description": "Operation timeout for connection to cluster-manager node.", "x-data-type": "time" } + }, + { + "name": "wait_for_completion", + "in": "query", + "description": "Should this request wait until the operation has completed before returning.", + "schema": { + "type": "boolean", + "default": false, + "description": "Should this request wait until the operation has completed before returning." + } } ], "responses": { "200": { - "description": "IndicesDeleteTemplate 200 response" + "description": "SnapshotCreate_Post 200 response" } }, - "x-operation-group": "indices.delete_template", + "x-operation-group": "snapshot.create", "x-version-added": "1.0" }, - "get": { - "description": "Returns an index template.", - "operationId": "IndicesGetTemplate_WithName", + "put": { + "description": "Creates a snapshot in a repository.", + "externalDocs": { + "description": "API Reference", + "url": "https://opensearch.org/docs/latest/api-reference/snapshots/create-snapshot/" + }, + "operationId": "SnapshotCreate_Put", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SnapshotCreate_BodyParams" + } + } + } + }, "parameters": [ { - "name": "name", + "name": "repository", "in": "path", - "description": "Comma-separated names of the index templates.", + "description": "Repository name.", "schema": { "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", - "description": "Comma-separated names of the index templates.", - "x-data-type": "array" + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", + "description": "Repository name." }, "required": true }, { - "name": "flat_settings", - "in": "query", - "description": "Return settings in flat format.", + "name": "snapshot", + "in": "path", + "description": "Snapshot name.", "schema": { - "type": "boolean", - "default": false, - "description": "Return settings in flat format." - } + "type": "string", + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", + "description": "Snapshot name." + }, + "required": true }, { "name": "master_timeout", @@ -16996,53 +17444,76 @@ } }, { - "name": "local", + "name": "wait_for_completion", "in": "query", - "description": "Return local information, do not retrieve the state from cluster-manager node.", + "description": "Should this request wait until the operation has completed before returning.", "schema": { "type": "boolean", "default": false, - "description": "Return local information, do not retrieve the state from cluster-manager node." + "description": "Should this request wait until the operation has completed before returning." } } ], "responses": { "200": { - "description": "IndicesGetTemplate_WithName 200 response" + "description": "SnapshotCreate_Put 200 response" } }, - "x-operation-group": "indices.get_template", + "x-operation-group": "snapshot.create", "x-version-added": "1.0" - }, - "head": { - "description": "Returns information about whether a particular index template exists.", + } + }, + "/_snapshot/{repository}/{snapshot}/_clone/{target_snapshot}": { + "put": { + "description": "Clones indices from one snapshot into another snapshot in the same repository.", "externalDocs": { "description": "API Reference", "url": "https://opensearch.org/docs/latest" }, - "operationId": "IndicesExistsTemplate", + "operationId": "SnapshotClone", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SnapshotClone_BodyParams" + } + } + }, + "required": true + }, "parameters": [ { - "name": "name", + "name": "repository", "in": "path", - "description": "Comma-separated names of the index templates.", + "description": "Repository name.", "schema": { "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", - "description": "Comma-separated names of the index templates.", - "x-data-type": "array" + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", + "description": "Repository name." }, "required": true }, { - "name": "flat_settings", - "in": "query", - "description": "Return settings in flat format.", + "name": "snapshot", + "in": "path", + "description": "Snapshot name.", "schema": { - "type": "boolean", - "default": false, - "description": "Return settings in flat format." - } + "type": "string", + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", + "description": "Snapshot name." + }, + "required": true + }, + { + "name": "target_snapshot", + "in": "path", + "description": "The name of the cloned snapshot to create.", + "schema": { + "type": "string", + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", + "description": "The name of the cloned snapshot to create." + }, + "required": true }, { "name": "master_timeout", @@ -17059,68 +17530,65 @@ } }, { - "name": "local", + "name": "cluster_manager_timeout", "in": "query", - "description": "Return local information, do not retrieve the state from cluster-manager node.", + "description": "Operation timeout for connection to cluster-manager node.", "schema": { - "type": "boolean", - "default": false, - "description": "Return local information, do not retrieve the state from cluster-manager node." + "type": "string", + "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", + "description": "Operation timeout for connection to cluster-manager node.", + "x-data-type": "time" } } ], "responses": { "200": { - "description": "IndicesExistsTemplate 200 response" + "description": "SnapshotClone 200 response" } }, - "x-operation-group": "indices.exists_template", + "x-operation-group": "snapshot.clone", "x-version-added": "1.0" - }, + } + }, + "/_snapshot/{repository}/{snapshot}/_restore": { "post": { - "description": "Creates or updates an index template.", - "operationId": "IndicesPutTemplate_Post", + "description": "Restores a snapshot.", + "externalDocs": { + "description": "API Reference", + "url": "https://opensearch.org/docs/latest/api-reference/snapshots/restore-snapshot/" + }, + "operationId": "SnapshotRestore", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/IndicesPutTemplate_BodyParams" + "$ref": "#/components/schemas/SnapshotRestore_BodyParams" } } - }, - "required": true + } }, "parameters": [ { - "name": "name", + "name": "repository", "in": "path", - "description": "The name of the template.", + "description": "Repository name.", "schema": { "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", - "description": "The name of the template." + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", + "description": "Repository name." }, "required": true }, { - "name": "order", - "in": "query", - "description": "The order for this template when merging multiple matching ones (higher numbers are merged later, overriding the lower numbers).", - "schema": { - "type": "integer", - "description": "The order for this template when merging multiple matching ones (higher numbers are merged later, overriding the lower numbers).", - "format": "int32" - } - }, - { - "name": "create", - "in": "query", - "description": "Whether the index template should only be added if new or can also replace an existing one.", + "name": "snapshot", + "in": "path", + "description": "Snapshot name.", "schema": { - "type": "boolean", - "default": false, - "description": "Whether the index template should only be added if new or can also replace an existing one." - } + "type": "string", + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", + "description": "Snapshot name." + }, + "required": true }, { "name": "master_timeout", @@ -17146,64 +17614,54 @@ "description": "Operation timeout for connection to cluster-manager node.", "x-data-type": "time" } + }, + { + "name": "wait_for_completion", + "in": "query", + "description": "Should this request wait until the operation has completed before returning.", + "schema": { + "type": "boolean", + "default": false, + "description": "Should this request wait until the operation has completed before returning." + } } ], "responses": { "200": { - "description": "IndicesPutTemplate_Post 200 response" + "description": "SnapshotRestore 200 response" } }, - "x-operation-group": "indices.put_template", + "x-operation-group": "snapshot.restore", "x-version-added": "1.0" - }, - "put": { - "description": "Creates or updates an index template.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest" - }, - "operationId": "IndicesPutTemplate_Put", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IndicesPutTemplate_BodyParams" - } - } - }, - "required": true - }, + } + }, + "/_snapshot/{repository}/{snapshot}/_status": { + "get": { + "description": "Returns information about the status of a snapshot.", + "operationId": "SnapshotStatus_WithRepositorySnapshot", "parameters": [ { - "name": "name", + "name": "repository", "in": "path", - "description": "The name of the template.", + "description": "Repository name.", "schema": { "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", - "description": "The name of the template." + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", + "description": "Repository name." }, "required": true }, { - "name": "order", - "in": "query", - "description": "The order for this template when merging multiple matching ones (higher numbers are merged later, overriding the lower numbers).", - "schema": { - "type": "integer", - "description": "The order for this template when merging multiple matching ones (higher numbers are merged later, overriding the lower numbers).", - "format": "int32" - } - }, - { - "name": "create", - "in": "query", - "description": "Whether the index template should only be added if new or can also replace an existing one.", + "name": "snapshot", + "in": "path", + "description": "Comma-separated list of snapshot names.", "schema": { - "type": "boolean", - "default": false, - "description": "Whether the index template should only be added if new or can also replace an existing one." - } + "type": "string", + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", + "description": "Comma-separated list of snapshot names.", + "x-data-type": "array" + }, + "required": true }, { "name": "master_timeout", @@ -17229,569 +17687,597 @@ "description": "Operation timeout for connection to cluster-manager node.", "x-data-type": "time" } - } - ], - "responses": { - "200": { - "description": "IndicesPutTemplate_Put 200 response" - } - }, - "x-operation-group": "indices.put_template", - "x-version-added": "1.0" - } - }, - "/_update_by_query/{task_id}/_rethrottle": { - "post": { - "description": "Changes the number of requests per second for a particular Update By Query operation.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest" - }, - "operationId": "UpdateByQueryRethrottle", - "parameters": [ - { - "name": "task_id", - "in": "path", - "description": "The task id to rethrottle.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", - "description": "The task id to rethrottle." - }, - "required": true }, { - "name": "requests_per_second", + "name": "ignore_unavailable", "in": "query", - "description": "The throttle for this request in sub-requests per second. -1 means no throttle.", + "description": "Whether to ignore unavailable snapshots, defaults to false which means a SnapshotMissingException is thrown.", "schema": { - "type": "integer", - "description": "The throttle for this request in sub-requests per second. -1 means no throttle.", - "format": "int32" - }, - "required": true + "type": "boolean", + "default": false, + "description": "Whether to ignore unavailable snapshots, defaults to false which means a SnapshotMissingException is thrown." + } } ], "responses": { "200": { - "description": "UpdateByQueryRethrottle 200 response" + "description": "SnapshotStatus_WithRepositorySnapshot 200 response" } }, - "x-operation-group": "update_by_query_rethrottle", + "x-operation-group": "snapshot.status", "x-version-added": "1.0" } }, - "/_upgrade": { + "/_stats": { "get": { - "description": "The _upgrade API is no longer useful and will be removed.", + "description": "Provides statistics on operations happening in an index.", "externalDocs": { "description": "API Reference", "url": "https://opensearch.org/docs/latest" }, - "operationId": "IndicesGetUpgrade", + "operationId": "IndicesStats", "parameters": [ { - "name": "ignore_unavailable", + "name": "completion_fields", "in": "query", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", + "description": "Comma-separated list of fields for `fielddata` and `suggest` index metric (supports wildcards).", + "style": "form", "schema": { - "type": "boolean", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." - } + "type": "array", + "items": { + "type": "string" + }, + "description": "Comma-separated list of fields for `fielddata` and `suggest` index metric (supports wildcards)." + }, + "explode": true }, { - "name": "allow_no_indices", + "name": "fielddata_fields", "in": "query", - "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified).", + "description": "Comma-separated list of fields for `fielddata` index metric (supports wildcards).", + "style": "form", "schema": { - "type": "boolean", - "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)." - } - }, - { - "name": "expand_wildcards", + "type": "array", + "items": { + "type": "string" + }, + "description": "Comma-separated list of fields for `fielddata` index metric (supports wildcards)." + }, + "explode": true + }, + { + "name": "fields", "in": "query", - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", + "description": "Comma-separated list of fields for `fielddata` and `completion` index metric (supports wildcards).", + "style": "form", "schema": { - "$ref": "#/components/schemas/ExpandWildcards" - } - } - ], - "responses": { - "200": { - "description": "IndicesGetUpgrade 200 response" - } - }, - "x-operation-group": "indices.get_upgrade", - "x-version-added": "1.0" - }, - "post": { - "description": "The _upgrade API is no longer useful and will be removed.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest" - }, - "operationId": "IndicesUpgrade", - "parameters": [ + "type": "array", + "items": { + "type": "string" + }, + "description": "Comma-separated list of fields for `fielddata` and `completion` index metric (supports wildcards)." + }, + "explode": true + }, { - "name": "allow_no_indices", + "name": "groups", "in": "query", - "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified).", + "description": "Comma-separated list of search groups for `search` index metric.", + "style": "form", "schema": { - "type": "boolean", - "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)." - } + "type": "array", + "items": { + "type": "string" + }, + "description": "Comma-separated list of search groups for `search` index metric." + }, + "explode": true }, { - "name": "expand_wildcards", + "name": "level", "in": "query", - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", + "description": "Return stats aggregated at cluster, index or shard level.", "schema": { - "$ref": "#/components/schemas/ExpandWildcards" + "$ref": "#/components/schemas/IndiciesStatLevel" } }, { - "name": "ignore_unavailable", + "name": "include_segment_file_sizes", "in": "query", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", + "description": "Whether to report the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested).", "schema": { "type": "boolean", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." + "default": false, + "description": "Whether to report the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested)." } }, { - "name": "wait_for_completion", + "name": "include_unloaded_segments", "in": "query", - "description": "Should this request wait until the operation has completed before returning.", + "description": "If set to true segment stats will include stats for segments that are not currently loaded into memory.", "schema": { "type": "boolean", "default": false, - "description": "Should this request wait until the operation has completed before returning." + "description": "If set to true segment stats will include stats for segments that are not currently loaded into memory." } }, { - "name": "only_ancient_segments", + "name": "expand_wildcards", "in": "query", - "description": "If true, only ancient (an older Lucene major release) segments will be upgraded.", + "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", + "schema": { + "$ref": "#/components/schemas/ExpandWildcards" + } + }, + { + "name": "forbid_closed_indices", + "in": "query", + "description": "If set to false stats will also collected from closed indices if explicitly specified or if expand_wildcards expands to closed indices.", "schema": { "type": "boolean", - "description": "If true, only ancient (an older Lucene major release) segments will be upgraded." + "default": true, + "description": "If set to false stats will also collected from closed indices if explicitly specified or if expand_wildcards expands to closed indices." } } ], "responses": { "200": { - "description": "IndicesUpgrade 200 response" + "description": "IndicesStats 200 response" } }, - "x-operation-group": "indices.upgrade", + "x-operation-group": "indices.stats", "x-version-added": "1.0" } }, - "/_validate/query": { + "/_stats/{metric}": { "get": { - "description": "Allows a user to validate a potentially expensive query without executing it.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest" - }, - "operationId": "IndicesValidateQuery_Get", + "description": "Provides statistics on operations happening in an index.", + "operationId": "IndicesStats_WithMetric", "parameters": [ { - "name": "explain", - "in": "query", - "description": "Return detailed information about the error.", + "name": "metric", + "in": "path", + "description": "Limit the information returned the specific metrics.", "schema": { - "type": "boolean", - "description": "Return detailed information about the error." - } + "type": "string", + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", + "description": "Limit the information returned the specific metrics.", + "x-enum-options": [ + "_all", + "completion", + "docs", + "fielddata", + "query_cache", + "flush", + "get", + "indexing", + "merge", + "request_cache", + "refresh", + "search", + "segments", + "store", + "warmer", + "suggest" + ], + "x-data-type": "array" + }, + "required": true }, { - "name": "ignore_unavailable", + "name": "completion_fields", "in": "query", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", + "description": "Comma-separated list of fields for `fielddata` and `suggest` index metric (supports wildcards).", + "style": "form", "schema": { - "type": "boolean", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." - } + "type": "array", + "items": { + "type": "string" + }, + "description": "Comma-separated list of fields for `fielddata` and `suggest` index metric (supports wildcards)." + }, + "explode": true }, { - "name": "allow_no_indices", + "name": "fielddata_fields", "in": "query", - "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified).", + "description": "Comma-separated list of fields for `fielddata` index metric (supports wildcards).", + "style": "form", "schema": { - "type": "boolean", - "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)." - } + "type": "array", + "items": { + "type": "string" + }, + "description": "Comma-separated list of fields for `fielddata` index metric (supports wildcards)." + }, + "explode": true }, { - "name": "expand_wildcards", + "name": "fields", "in": "query", - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", + "description": "Comma-separated list of fields for `fielddata` and `completion` index metric (supports wildcards).", + "style": "form", "schema": { - "$ref": "#/components/schemas/ExpandWildcards" - } + "type": "array", + "items": { + "type": "string" + }, + "description": "Comma-separated list of fields for `fielddata` and `completion` index metric (supports wildcards)." + }, + "explode": true }, { - "name": "q", + "name": "groups", "in": "query", - "description": "Query in the Lucene query string syntax.", + "description": "Comma-separated list of search groups for `search` index metric.", + "style": "form", "schema": { - "type": "string", - "description": "Query in the Lucene query string syntax." - } + "type": "array", + "items": { + "type": "string" + }, + "description": "Comma-separated list of search groups for `search` index metric." + }, + "explode": true }, { - "name": "analyzer", + "name": "level", "in": "query", - "description": "The analyzer to use for the query string.", + "description": "Return stats aggregated at cluster, index or shard level.", "schema": { - "type": "string", - "description": "The analyzer to use for the query string." + "$ref": "#/components/schemas/IndiciesStatLevel" } }, { - "name": "analyze_wildcard", + "name": "include_segment_file_sizes", "in": "query", - "description": "Specify whether wildcard and prefix queries should be analyzed.", + "description": "Whether to report the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested).", "schema": { "type": "boolean", "default": false, - "description": "Specify whether wildcard and prefix queries should be analyzed." - } - }, - { - "name": "default_operator", - "in": "query", - "description": "The default operator for query string query (AND or OR).", - "schema": { - "$ref": "#/components/schemas/DefaultOperator" - } - }, - { - "name": "df", - "in": "query", - "description": "The field to use as default where no field prefix is given in the query string.", - "schema": { - "type": "string", - "description": "The field to use as default where no field prefix is given in the query string." + "description": "Whether to report the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested)." } }, { - "name": "lenient", + "name": "include_unloaded_segments", "in": "query", - "description": "Specify whether format-based query failures (such as providing text to a numeric field) should be ignored.", + "description": "If set to true segment stats will include stats for segments that are not currently loaded into memory.", "schema": { "type": "boolean", - "description": "Specify whether format-based query failures (such as providing text to a numeric field) should be ignored." + "default": false, + "description": "If set to true segment stats will include stats for segments that are not currently loaded into memory." } }, { - "name": "rewrite", + "name": "expand_wildcards", "in": "query", - "description": "Provide a more detailed explanation showing the actual Lucene query that will be executed.", + "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", "schema": { - "type": "boolean", - "description": "Provide a more detailed explanation showing the actual Lucene query that will be executed." + "$ref": "#/components/schemas/ExpandWildcards" } }, { - "name": "all_shards", + "name": "forbid_closed_indices", "in": "query", - "description": "Execute validation on all shards instead of one random shard per index.", + "description": "If set to false stats will also collected from closed indices if explicitly specified or if expand_wildcards expands to closed indices.", "schema": { "type": "boolean", - "description": "Execute validation on all shards instead of one random shard per index." + "default": true, + "description": "If set to false stats will also collected from closed indices if explicitly specified or if expand_wildcards expands to closed indices." } } ], "responses": { "200": { - "description": "IndicesValidateQuery_Get 200 response" + "description": "IndicesStats_WithMetric 200 response" } }, - "x-operation-group": "indices.validate_query", + "x-operation-group": "indices.stats", "x-version-added": "1.0" - }, - "post": { - "description": "Allows a user to validate a potentially expensive query without executing it.", - "operationId": "IndicesValidateQuery_Post", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IndicesValidateQuery_BodyParams" - } - } - } + } + }, + "/_tasks": { + "get": { + "description": "Returns a list of tasks.", + "externalDocs": { + "description": "API Reference", + "url": "https://opensearch.org/docs/latest/api-reference/tasks/" }, + "operationId": "TasksList", "parameters": [ { - "name": "explain", + "name": "nodes", "in": "query", - "description": "Return detailed information about the error.", + "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.", + "style": "form", "schema": { - "type": "boolean", - "description": "Return detailed information about the error." - } + "type": "array", + "items": { + "type": "string" + }, + "description": "Comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes." + }, + "explode": true }, { - "name": "ignore_unavailable", + "name": "actions", "in": "query", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", + "description": "Comma-separated list of actions that should be returned. Leave empty to return all.", + "style": "form", "schema": { - "type": "boolean", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." - } + "type": "array", + "items": { + "type": "string" + }, + "description": "Comma-separated list of actions that should be returned. Leave empty to return all." + }, + "explode": true }, { - "name": "allow_no_indices", + "name": "detailed", "in": "query", - "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified).", + "description": "Return detailed task information.", "schema": { "type": "boolean", - "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)." - } - }, - { - "name": "expand_wildcards", - "in": "query", - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", - "schema": { - "$ref": "#/components/schemas/ExpandWildcards" - } - }, - { - "name": "q", - "in": "query", - "description": "Query in the Lucene query string syntax.", - "schema": { - "type": "string", - "description": "Query in the Lucene query string syntax." + "default": false, + "description": "Return detailed task information." } }, { - "name": "analyzer", + "name": "parent_task_id", "in": "query", - "description": "The analyzer to use for the query string.", + "description": "Return tasks with specified parent task id (node_id:task_number). Set to -1 to return all.", "schema": { "type": "string", - "description": "The analyzer to use for the query string." + "description": "Return tasks with specified parent task id (node_id:task_number). Set to -1 to return all." } }, { - "name": "analyze_wildcard", + "name": "wait_for_completion", "in": "query", - "description": "Specify whether wildcard and prefix queries should be analyzed.", + "description": "Should this request wait until the operation has completed before returning.", "schema": { "type": "boolean", "default": false, - "description": "Specify whether wildcard and prefix queries should be analyzed." + "description": "Should this request wait until the operation has completed before returning." } }, { - "name": "default_operator", + "name": "group_by", "in": "query", - "description": "The default operator for query string query (AND or OR).", + "description": "Group tasks by nodes or parent/child relationships.", "schema": { - "$ref": "#/components/schemas/DefaultOperator" + "$ref": "#/components/schemas/GroupBy" } }, { - "name": "df", + "name": "timeout", "in": "query", - "description": "The field to use as default where no field prefix is given in the query string.", + "description": "Operation timeout.", "schema": { "type": "string", - "description": "The field to use as default where no field prefix is given in the query string." + "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", + "description": "Operation timeout.", + "x-data-type": "time" } + } + ], + "responses": { + "200": { + "description": "TasksList 200 response" + } + }, + "x-operation-group": "tasks.list", + "x-version-added": "1.0" + } + }, + "/_tasks/_cancel": { + "post": { + "description": "Cancels a task, if it can be cancelled through an API.", + "externalDocs": { + "description": "API Reference", + "url": "https://opensearch.org/docs/latest/api-reference/tasks/#task-canceling" + }, + "operationId": "TasksCancel", + "parameters": [ + { + "name": "nodes", + "in": "query", + "description": "Comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes.", + "style": "form", + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes." + }, + "explode": true }, { - "name": "lenient", + "name": "actions", "in": "query", - "description": "Specify whether format-based query failures (such as providing text to a numeric field) should be ignored.", + "description": "Comma-separated list of actions that should be cancelled. Leave empty to cancel all.", + "style": "form", "schema": { - "type": "boolean", - "description": "Specify whether format-based query failures (such as providing text to a numeric field) should be ignored." - } + "type": "array", + "items": { + "type": "string" + }, + "description": "Comma-separated list of actions that should be cancelled. Leave empty to cancel all." + }, + "explode": true }, { - "name": "rewrite", + "name": "parent_task_id", "in": "query", - "description": "Provide a more detailed explanation showing the actual Lucene query that will be executed.", + "description": "Cancel tasks with specified parent task id (node_id:task_number). Set to -1 to cancel all.", "schema": { - "type": "boolean", - "description": "Provide a more detailed explanation showing the actual Lucene query that will be executed." + "type": "string", + "description": "Cancel tasks with specified parent task id (node_id:task_number). Set to -1 to cancel all." } }, { - "name": "all_shards", + "name": "wait_for_completion", "in": "query", - "description": "Execute validation on all shards instead of one random shard per index.", + "description": "Should this request wait until the operation has completed before returning.", "schema": { "type": "boolean", - "description": "Execute validation on all shards instead of one random shard per index." + "default": false, + "description": "Should this request wait until the operation has completed before returning." } } ], "responses": { "200": { - "description": "IndicesValidateQuery_Post 200 response" + "description": "TasksCancel 200 response" } }, - "x-operation-group": "indices.validate_query", + "x-operation-group": "tasks.cancel", "x-version-added": "1.0" } }, - "/{alias}/_rollover": { - "post": { - "description": "Updates an alias to point to a new index when the existing index\nis considered to be too large or too old.", + "/_tasks/{task_id}": { + "get": { + "description": "Returns information about a task.", "externalDocs": { "description": "API Reference", - "url": "https://opensearch.org/docs/latest" - }, - "operationId": "IndicesRollover", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IndicesRollover_BodyParams" - } - } - } + "url": "https://opensearch.org/docs/latest/api-reference/tasks/" }, + "operationId": "TasksGet", "parameters": [ { - "name": "alias", + "name": "task_id", "in": "path", - "description": "The name of the alias to rollover.", + "description": "Return the task with specified id (node_id:task_number).", "schema": { "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", - "description": "The name of the alias to rollover." + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", + "description": "Return the task with specified id (node_id:task_number)." }, "required": true }, { - "name": "timeout", - "in": "query", - "description": "Operation timeout.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout.", - "x-data-type": "time" - } - }, - { - "name": "dry_run", + "name": "wait_for_completion", "in": "query", - "description": "If set to true the rollover action will only be validated but not actually performed even if a condition matches.", + "description": "Should this request wait until the operation has completed before returning.", "schema": { "type": "boolean", "default": false, - "description": "If set to true the rollover action will only be validated but not actually performed even if a condition matches." - } - }, - { - "name": "master_timeout", - "in": "query", - "description": "Operation timeout for connection to master node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to master node.", - "x-version-deprecated": "2.0.0", - "x-data-type": "time", - "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", - "deprecated": true + "description": "Should this request wait until the operation has completed before returning." } }, { - "name": "cluster_manager_timeout", + "name": "timeout", "in": "query", - "description": "Operation timeout for connection to cluster-manager node.", + "description": "Operation timeout.", "schema": { "type": "string", "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to cluster-manager node.", + "description": "Operation timeout.", "x-data-type": "time" } - }, - { - "name": "wait_for_active_shards", - "in": "query", - "description": "Set the number of active shards to wait for on the newly created rollover index before the operation returns.", - "schema": { - "type": "string", - "description": "Set the number of active shards to wait for on the newly created rollover index before the operation returns." - } } ], "responses": { "200": { - "description": "IndicesRollover 200 response" + "description": "TasksGet 200 response" } }, - "x-operation-group": "indices.rollover", + "x-operation-group": "tasks.get", "x-version-added": "1.0" } }, - "/{alias}/_rollover/{new_index}": { + "/_tasks/{task_id}/_cancel": { "post": { - "description": "Updates an alias to point to a new index when the existing index\nis considered to be too large or too old.", - "operationId": "IndicesRollover_WithNewIndex", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IndicesRollover_BodyParams" - } - } - } - }, + "description": "Cancels a task, if it can be cancelled through an API.", + "operationId": "TasksCancel_WithTaskId", "parameters": [ { - "name": "alias", + "name": "task_id", "in": "path", - "description": "The name of the alias to rollover.", + "description": "Cancel the task with specified task id (node_id:task_number).", "schema": { "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", - "description": "The name of the alias to rollover." + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", + "description": "Cancel the task with specified task id (node_id:task_number)." }, "required": true }, { - "name": "new_index", - "in": "path", - "description": "The name of the rollover index.", + "name": "nodes", + "in": "query", + "description": "Comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes.", + "style": "form", "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", - "description": "The name of the rollover index." + "type": "array", + "items": { + "type": "string" + }, + "description": "Comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes." }, - "required": true + "explode": true }, { - "name": "timeout", + "name": "actions", "in": "query", - "description": "Operation timeout.", + "description": "Comma-separated list of actions that should be cancelled. Leave empty to cancel all.", + "style": "form", + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Comma-separated list of actions that should be cancelled. Leave empty to cancel all." + }, + "explode": true + }, + { + "name": "parent_task_id", + "in": "query", + "description": "Cancel tasks with specified parent task id (node_id:task_number). Set to -1 to cancel all.", "schema": { "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout.", - "x-data-type": "time" + "description": "Cancel tasks with specified parent task id (node_id:task_number). Set to -1 to cancel all." } }, { - "name": "dry_run", + "name": "wait_for_completion", "in": "query", - "description": "If set to true the rollover action will only be validated but not actually performed even if a condition matches.", + "description": "Should this request wait until the operation has completed before returning.", "schema": { "type": "boolean", "default": false, - "description": "If set to true the rollover action will only be validated but not actually performed even if a condition matches." + "description": "Should this request wait until the operation has completed before returning." + } + } + ], + "responses": { + "200": { + "description": "TasksCancel_WithTaskId 200 response" + } + }, + "x-operation-group": "tasks.cancel", + "x-version-added": "1.0" + } + }, + "/_template": { + "get": { + "description": "Returns an index template.", + "externalDocs": { + "description": "API Reference", + "url": "https://opensearch.org/docs/latest" + }, + "operationId": "IndicesGetTemplate", + "parameters": [ + { + "name": "flat_settings", + "in": "query", + "description": "Return settings in flat format.", + "schema": { + "type": "boolean", + "default": false, + "description": "Return settings in flat format." } }, { @@ -17820,51 +18306,44 @@ } }, { - "name": "wait_for_active_shards", + "name": "local", "in": "query", - "description": "Set the number of active shards to wait for on the newly created rollover index before the operation returns.", + "description": "Return local information, do not retrieve the state from cluster-manager node.", "schema": { - "type": "string", - "description": "Set the number of active shards to wait for on the newly created rollover index before the operation returns." + "type": "boolean", + "default": false, + "description": "Return local information, do not retrieve the state from cluster-manager node." } } ], "responses": { "200": { - "description": "IndicesRollover_WithNewIndex 200 response" + "description": "IndicesGetTemplate 200 response" } }, - "x-operation-group": "indices.rollover", + "x-operation-group": "indices.get_template", "x-version-added": "1.0" } }, - "/{index}": { + "/_template/{name}": { "delete": { - "description": "Deletes an index.", + "description": "Deletes an index template.", "externalDocs": { "description": "API Reference", - "url": "https://opensearch.org/docs/latest/api-reference/index-apis/delete-index/" + "url": "https://opensearch.org/docs/latest" }, - "operationId": "IndicesDelete", + "operationId": "IndicesDeleteTemplate", "parameters": [ { - "name": "index", + "name": "name", "in": "path", - "description": "Comma-separated list of indices to delete; use `_all` or `*` string to delete all indices.", + "description": "The name of the template.", "schema": { "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", - "description": "Comma-separated list of indices to delete; use `_all` or `*` string to delete all indices.", - "x-data-type": "array" + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", + "description": "The name of the template." }, - "required": true, - "examples": { - "IndicesDelete_example1": { - "summary": "Examples for Delete Index Operation.", - "description": "", - "value": "books" - } - } + "required": true }, { "name": "timeout", @@ -17892,116 +18371,41 @@ } }, { - "name": "ignore_unavailable", - "in": "query", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", - "schema": { - "type": "boolean", - "default": false, - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." - } - }, - { - "name": "allow_no_indices", - "in": "query", - "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified).", - "schema": { - "type": "boolean", - "default": false, - "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)." - } - }, - { - "name": "expand_wildcards", + "name": "cluster_manager_timeout", "in": "query", - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", + "description": "Operation timeout for connection to cluster-manager node.", "schema": { - "$ref": "#/components/schemas/ExpandWildcards" + "type": "string", + "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", + "description": "Operation timeout for connection to cluster-manager node.", + "x-data-type": "time" } } ], "responses": { "200": { - "description": "IndicesDelete 200 response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IndicesDeleteResponseContent" - }, - "examples": { - "IndicesDelete_example1": { - "summary": "Examples for Delete Index Operation.", - "description": "", - "value": { - "acknowledged": true - } - } - } - } - } + "description": "IndicesDeleteTemplate 200 response" } }, - "x-operation-group": "indices.delete", + "x-operation-group": "indices.delete_template", "x-version-added": "1.0" }, "get": { - "description": "Returns information about one or more indices.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest" - }, - "operationId": "IndicesGet", + "description": "Returns an index template.", + "operationId": "IndicesGetTemplate_WithName", "parameters": [ { - "name": "index", + "name": "name", "in": "path", - "description": "Comma-separated list of indices.", + "description": "Comma-separated names of the index templates.", "schema": { "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", - "description": "Comma-separated list of indices.", + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", + "description": "Comma-separated names of the index templates.", "x-data-type": "array" }, "required": true }, - { - "name": "local", - "in": "query", - "description": "Return local information, do not retrieve the state from cluster-manager node.", - "schema": { - "type": "boolean", - "default": false, - "description": "Return local information, do not retrieve the state from cluster-manager node." - } - }, - { - "name": "ignore_unavailable", - "in": "query", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", - "schema": { - "type": "boolean", - "default": false, - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." - } - }, - { - "name": "allow_no_indices", - "in": "query", - "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified).", - "schema": { - "type": "boolean", - "default": false, - "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)." - } - }, - { - "name": "expand_wildcards", - "in": "query", - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", - "schema": { - "$ref": "#/components/schemas/ExpandWildcards" - } - }, { "name": "flat_settings", "in": "query", @@ -18012,16 +18416,6 @@ "description": "Return settings in flat format." } }, - { - "name": "include_defaults", - "in": "query", - "description": "Whether to return all default setting for each of the indices.", - "schema": { - "type": "boolean", - "default": false, - "description": "Whether to return all default setting for each of the indices." - } - }, { "name": "master_timeout", "in": "query", @@ -18046,156 +18440,215 @@ "description": "Operation timeout for connection to cluster-manager node.", "x-data-type": "time" } + }, + { + "name": "local", + "in": "query", + "description": "Return local information, do not retrieve the state from cluster-manager node.", + "schema": { + "type": "boolean", + "default": false, + "description": "Return local information, do not retrieve the state from cluster-manager node." + } } ], "responses": { "200": { - "description": "IndicesGet 200 response" + "description": "IndicesGetTemplate_WithName 200 response" } }, - "x-operation-group": "indices.get", + "x-operation-group": "indices.get_template", "x-version-added": "1.0" }, "head": { - "description": "Returns information about whether a particular index exists.", + "description": "Returns information about whether a particular index template exists.", "externalDocs": { "description": "API Reference", "url": "https://opensearch.org/docs/latest" }, - "operationId": "IndicesExists", + "operationId": "IndicesExistsTemplate", "parameters": [ { - "name": "index", + "name": "name", "in": "path", - "description": "Comma-separated list of indices.", + "description": "Comma-separated names of the index templates.", "schema": { "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", - "description": "Comma-separated list of indices.", + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", + "description": "Comma-separated names of the index templates.", "x-data-type": "array" }, "required": true }, { - "name": "local", + "name": "flat_settings", "in": "query", - "description": "Return local information, do not retrieve the state from cluster-manager node.", + "description": "Return settings in flat format.", "schema": { "type": "boolean", "default": false, - "description": "Return local information, do not retrieve the state from cluster-manager node." + "description": "Return settings in flat format." } }, { - "name": "ignore_unavailable", + "name": "master_timeout", "in": "query", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", + "description": "Operation timeout for connection to master node.", "schema": { - "type": "boolean", - "default": false, - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." + "type": "string", + "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", + "description": "Operation timeout for connection to master node.", + "x-version-deprecated": "2.0.0", + "x-data-type": "time", + "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", + "deprecated": true } }, { - "name": "allow_no_indices", + "name": "local", "in": "query", - "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified).", + "description": "Return local information, do not retrieve the state from cluster-manager node.", "schema": { "type": "boolean", "default": false, - "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)." + "description": "Return local information, do not retrieve the state from cluster-manager node." + } + } + ], + "responses": { + "200": { + "description": "IndicesExistsTemplate 200 response" + } + }, + "x-operation-group": "indices.exists_template", + "x-version-added": "1.0" + }, + "post": { + "description": "Creates or updates an index template.", + "operationId": "IndicesPutTemplate_Post", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IndicesPutTemplate_BodyParams" + } } }, + "required": true + }, + "parameters": [ { - "name": "expand_wildcards", + "name": "name", + "in": "path", + "description": "The name of the template.", + "schema": { + "type": "string", + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", + "description": "The name of the template." + }, + "required": true + }, + { + "name": "order", "in": "query", - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", + "description": "The order for this template when merging multiple matching ones (higher numbers are merged later, overriding the lower numbers).", "schema": { - "$ref": "#/components/schemas/ExpandWildcards" + "type": "integer", + "description": "The order for this template when merging multiple matching ones (higher numbers are merged later, overriding the lower numbers).", + "format": "int32" } }, { - "name": "flat_settings", + "name": "create", "in": "query", - "description": "Return settings in flat format.", + "description": "Whether the index template should only be added if new or can also replace an existing one.", "schema": { "type": "boolean", "default": false, - "description": "Return settings in flat format." + "description": "Whether the index template should only be added if new or can also replace an existing one." } }, { - "name": "include_defaults", + "name": "master_timeout", "in": "query", - "description": "Whether to return all default setting for each of the indices.", + "description": "Operation timeout for connection to master node.", "schema": { - "type": "boolean", - "default": false, - "description": "Whether to return all default setting for each of the indices." + "type": "string", + "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", + "description": "Operation timeout for connection to master node.", + "x-version-deprecated": "2.0.0", + "x-data-type": "time", + "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", + "deprecated": true + } + }, + { + "name": "cluster_manager_timeout", + "in": "query", + "description": "Operation timeout for connection to cluster-manager node.", + "schema": { + "type": "string", + "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", + "description": "Operation timeout for connection to cluster-manager node.", + "x-data-type": "time" } } ], "responses": { "200": { - "description": "IndicesExists 200 response" + "description": "IndicesPutTemplate_Post 200 response" } }, - "x-operation-group": "indices.exists", + "x-operation-group": "indices.put_template", "x-version-added": "1.0" }, "put": { - "description": "Creates an index with optional settings and mappings.", + "description": "Creates or updates an index template.", "externalDocs": { "description": "API Reference", - "url": "https://opensearch.org/docs/latest/api-reference/index-apis/create-index/" + "url": "https://opensearch.org/docs/latest/im-plugin/index-templates/" }, - "operationId": "IndicesCreate", + "operationId": "IndicesPutTemplate_Put", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/IndicesCreate_BodyParams" + "$ref": "#/components/schemas/IndicesPutTemplate_BodyParams" } } - } + }, + "required": true }, "parameters": [ { - "name": "index", + "name": "name", "in": "path", - "description": "Index name.", + "description": "The name of the template.", "schema": { "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", - "description": "Index name." + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", + "description": "The name of the template." }, - "required": true, - "examples": { - "IndicesCreate_example1": { - "summary": "Examples for Create Index Operation.", - "description": "", - "value": "books" - } - } + "required": true }, { - "name": "wait_for_active_shards", + "name": "order", "in": "query", - "description": "Set the number of active shards to wait for before the operation returns.", + "description": "The order for this template when merging multiple matching ones (higher numbers are merged later, overriding the lower numbers).", "schema": { - "type": "string", - "description": "Set the number of active shards to wait for before the operation returns." + "type": "integer", + "description": "The order for this template when merging multiple matching ones (higher numbers are merged later, overriding the lower numbers).", + "format": "int32" } }, { - "name": "timeout", + "name": "create", "in": "query", - "description": "Operation timeout.", + "description": "Whether the index template should only be added if new or can also replace an existing one.", "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout.", - "x-data-type": "time" + "type": "boolean", + "default": false, + "description": "Whether the index template should only be added if new or can also replace an existing one." } }, { @@ -18226,48 +18679,63 @@ ], "responses": { "200": { - "description": "IndicesCreate 200 response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IndicesCreateResponseContent" - }, - "examples": { - "IndicesCreate_example1": { - "summary": "Examples for Create Index Operation.", - "description": "", - "value": { - "index": "books", - "shards_acknowledged": true, - "acknowledged": true - } - } - } - } - } + "description": "IndicesPutTemplate_Put 200 response" } }, - "x-operation-group": "indices.create", + "x-operation-group": "indices.put_template", "x-version-added": "1.0" } }, - "/{index}/_alias": { - "get": { - "description": "Returns an alias.", - "operationId": "IndicesGetAlias_WithIndex", + "/_update_by_query/{task_id}/_rethrottle": { + "post": { + "description": "Changes the number of requests per second for a particular Update By Query operation.", + "externalDocs": { + "description": "API Reference", + "url": "https://opensearch.org/docs/latest" + }, + "operationId": "UpdateByQueryRethrottle", "parameters": [ { - "name": "index", + "name": "task_id", "in": "path", - "description": "Comma-separated list of indices to filter aliases.", + "description": "The task id to rethrottle.", "schema": { "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", - "description": "Comma-separated list of indices to filter aliases.", - "x-data-type": "array" + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", + "description": "The task id to rethrottle." }, "required": true }, + { + "name": "requests_per_second", + "in": "query", + "description": "The throttle for this request in sub-requests per second. -1 means no throttle.", + "schema": { + "type": "integer", + "description": "The throttle for this request in sub-requests per second. -1 means no throttle.", + "format": "int32" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "UpdateByQueryRethrottle 200 response" + } + }, + "x-operation-group": "update_by_query_rethrottle", + "x-version-added": "1.0" + } + }, + "/_upgrade": { + "get": { + "description": "The _upgrade API is no longer useful and will be removed.", + "externalDocs": { + "description": "API Reference", + "url": "https://opensearch.org/docs/latest" + }, + "operationId": "IndicesGetUpgrade", + "parameters": [ { "name": "ignore_unavailable", "in": "query", @@ -18293,132 +18761,96 @@ "schema": { "$ref": "#/components/schemas/ExpandWildcards" } - }, - { - "name": "local", - "in": "query", - "description": "Return local information, do not retrieve the state from cluster-manager node.", - "schema": { - "type": "boolean", - "default": false, - "description": "Return local information, do not retrieve the state from cluster-manager node." - } } ], "responses": { "200": { - "description": "IndicesGetAlias_WithIndex 200 response" + "description": "IndicesGetUpgrade 200 response" } }, - "x-operation-group": "indices.get_alias", + "x-operation-group": "indices.get_upgrade", "x-version-added": "1.0" - } - }, - "/{index}/_alias/{name}": { - "delete": { - "description": "Deletes an alias.", + }, + "post": { + "description": "The _upgrade API is no longer useful and will be removed.", "externalDocs": { "description": "API Reference", "url": "https://opensearch.org/docs/latest" }, - "operationId": "IndicesDeleteAlias", + "operationId": "IndicesUpgrade", "parameters": [ { - "name": "index", - "in": "path", - "description": "Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices.", + "name": "allow_no_indices", + "in": "query", + "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified).", "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 + "type": "boolean", + "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)." + } }, { - "name": "name", - "in": "path", - "description": "Comma-separated list of aliases to delete (supports wildcards); use `_all` to delete all aliases for the specified indices.", + "name": "expand_wildcards", + "in": "query", + "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", - "description": "Comma-separated list of aliases to delete (supports wildcards); use `_all` to delete all aliases for the specified indices.", - "x-data-type": "array" - }, - "required": true + "$ref": "#/components/schemas/ExpandWildcards" + } }, { - "name": "timeout", + "name": "ignore_unavailable", "in": "query", - "description": "Operation timeout.", + "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout.", - "x-data-type": "time" + "type": "boolean", + "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." } }, { - "name": "master_timeout", + "name": "wait_for_completion", "in": "query", - "description": "Operation timeout for connection to master node.", + "description": "Should this request wait until the operation has completed before returning.", "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to master node.", - "x-version-deprecated": "2.0.0", - "x-data-type": "time", - "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", - "deprecated": true + "type": "boolean", + "default": false, + "description": "Should this request wait until the operation has completed before returning." } }, { - "name": "cluster_manager_timeout", + "name": "only_ancient_segments", "in": "query", - "description": "Operation timeout for connection to cluster-manager node.", + "description": "If true, only ancient (an older Lucene major release) segments will be upgraded.", "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to cluster-manager node.", - "x-data-type": "time" + "type": "boolean", + "description": "If true, only ancient (an older Lucene major release) segments will be upgraded." } } ], "responses": { "200": { - "description": "IndicesDeleteAlias 200 response" + "description": "IndicesUpgrade 200 response" } }, - "x-operation-group": "indices.delete_alias", + "x-operation-group": "indices.upgrade", "x-version-added": "1.0" - }, + } + }, + "/_validate/query": { "get": { - "description": "Returns an alias.", - "operationId": "IndicesGetAlias_WithIndexName", + "description": "Allows a user to validate a potentially expensive query without executing it.", + "externalDocs": { + "description": "API Reference", + "url": "https://opensearch.org/docs/latest" + }, + "operationId": "IndicesValidateQuery_Get", "parameters": [ { - "name": "index", - "in": "path", - "description": "Comma-separated list of indices to filter aliases.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", - "description": "Comma-separated list of indices to filter aliases.", - "x-data-type": "array" - }, - "required": true - }, - { - "name": "name", - "in": "path", - "description": "Comma-separated list of alias names.", + "name": "explain", + "in": "query", + "description": "Return detailed information about the error.", "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", - "description": "Comma-separated list of alias names.", - "x-data-type": "array" - }, - "required": true + "type": "boolean", + "description": "Return detailed information about the error." + } }, { "name": "ignore_unavailable", @@ -18447,290 +18879,242 @@ } }, { - "name": "local", + "name": "q", "in": "query", - "description": "Return local information, do not retrieve the state from cluster-manager node.", + "description": "Query in the Lucene query string syntax.", "schema": { - "type": "boolean", - "default": false, - "description": "Return local information, do not retrieve the state from cluster-manager node." + "type": "string", + "description": "Query in the Lucene query string syntax." } - } - ], - "responses": { - "200": { - "description": "IndicesGetAlias_WithIndexName 200 response" - } - }, - "x-operation-group": "indices.get_alias", - "x-version-added": "1.0" - }, - "head": { - "description": "Returns information about whether a particular alias exists.", - "operationId": "IndicesExistsAlias_WithIndex", - "parameters": [ + }, { - "name": "index", - "in": "path", - "description": "Comma-separated list of indices to filter aliases.", + "name": "analyzer", + "in": "query", + "description": "The analyzer to use for the query string.", "schema": { "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", - "description": "Comma-separated list of indices to filter aliases.", - "x-data-type": "array" - }, - "required": true + "description": "The analyzer to use for the query string." + } }, { - "name": "name", - "in": "path", - "description": "Comma-separated list of alias names.", + "name": "analyze_wildcard", + "in": "query", + "description": "Specify whether wildcard and prefix queries should be analyzed.", "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", - "description": "Comma-separated list of alias names.", - "x-data-type": "array" - }, - "required": true + "type": "boolean", + "default": false, + "description": "Specify whether wildcard and prefix queries should be analyzed." + } }, { - "name": "ignore_unavailable", + "name": "default_operator", "in": "query", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", + "description": "The default operator for query string query (AND or OR).", "schema": { - "type": "boolean", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." + "$ref": "#/components/schemas/DefaultOperator" } }, { - "name": "allow_no_indices", + "name": "df", "in": "query", - "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified).", + "description": "The field to use as default where no field prefix is given in the query string.", + "schema": { + "type": "string", + "description": "The field to use as default where no field prefix is given in the query string." + } + }, + { + "name": "lenient", + "in": "query", + "description": "Specify whether format-based query failures (such as providing text to a numeric field) should be ignored.", "schema": { "type": "boolean", - "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)." + "description": "Specify whether format-based query failures (such as providing text to a numeric field) should be ignored." } }, { - "name": "expand_wildcards", + "name": "rewrite", "in": "query", - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", + "description": "Provide a more detailed explanation showing the actual Lucene query that will be executed.", "schema": { - "$ref": "#/components/schemas/ExpandWildcards" + "type": "boolean", + "description": "Provide a more detailed explanation showing the actual Lucene query that will be executed." } }, { - "name": "local", + "name": "all_shards", "in": "query", - "description": "Return local information, do not retrieve the state from cluster-manager node.", + "description": "Execute validation on all shards instead of one random shard per index.", "schema": { "type": "boolean", - "default": false, - "description": "Return local information, do not retrieve the state from cluster-manager node." + "description": "Execute validation on all shards instead of one random shard per index." } } ], "responses": { "200": { - "description": "IndicesExistsAlias_WithIndex 200 response" + "description": "IndicesValidateQuery_Get 200 response" } }, - "x-operation-group": "indices.exists_alias", + "x-operation-group": "indices.validate_query", "x-version-added": "1.0" }, "post": { - "description": "Creates or updates an alias.", - "operationId": "IndicesPutAlias_Post", + "description": "Allows a user to validate a potentially expensive query without executing it.", + "operationId": "IndicesValidateQuery_Post", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/IndicesPutAlias_BodyParams" + "$ref": "#/components/schemas/IndicesValidateQuery_BodyParams" } } } }, "parameters": [ { - "name": "index", - "in": "path", - "description": "Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices.", + "name": "explain", + "in": "query", + "description": "Return detailed information about the error.", "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 + "type": "boolean", + "description": "Return detailed information about the error." + } }, { - "name": "name", - "in": "path", - "description": "The name of the alias to be created or updated.", + "name": "ignore_unavailable", + "in": "query", + "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", - "description": "The name of the alias to be created or updated." - }, - "required": true + "type": "boolean", + "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." + } }, { - "name": "timeout", + "name": "allow_no_indices", "in": "query", - "description": "Operation timeout.", + "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified).", "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout.", - "x-data-type": "time" + "type": "boolean", + "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)." } }, { - "name": "master_timeout", + "name": "expand_wildcards", "in": "query", - "description": "Operation timeout for connection to master node.", + "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", + "schema": { + "$ref": "#/components/schemas/ExpandWildcards" + } + }, + { + "name": "q", + "in": "query", + "description": "Query in the Lucene query string syntax.", "schema": { "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to master node.", - "x-version-deprecated": "2.0.0", - "x-data-type": "time", - "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", - "deprecated": true + "description": "Query in the Lucene query string syntax." } }, { - "name": "cluster_manager_timeout", + "name": "analyzer", "in": "query", - "description": "Operation timeout for connection to cluster-manager node.", + "description": "The analyzer to use for the query string.", "schema": { "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to cluster-manager node.", - "x-data-type": "time" + "description": "The analyzer to use for the query string." } - } - ], - "responses": { - "200": { - "description": "IndicesPutAlias_Post 200 response" - } - }, - "x-operation-group": "indices.put_alias", - "x-version-added": "1.0" - }, - "put": { - "description": "Creates or updates an alias.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest" - }, - "operationId": "IndicesPutAlias_Put", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IndicesPutAlias_BodyParams" - } + }, + { + "name": "analyze_wildcard", + "in": "query", + "description": "Specify whether wildcard and prefix queries should be analyzed.", + "schema": { + "type": "boolean", + "default": false, + "description": "Specify whether wildcard and prefix queries should be analyzed." } - } - }, - "parameters": [ + }, { - "name": "index", - "in": "path", - "description": "Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices.", + "name": "default_operator", + "in": "query", + "description": "The default operator for query string query (AND or OR).", "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 + "$ref": "#/components/schemas/DefaultOperator" + } }, { - "name": "name", - "in": "path", - "description": "The name of the alias to be created or updated.", + "name": "df", + "in": "query", + "description": "The field to use as default where no field prefix is given in the query string.", "schema": { "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", - "description": "The name of the alias to be created or updated." - }, - "required": true + "description": "The field to use as default where no field prefix is given in the query string." + } }, { - "name": "timeout", + "name": "lenient", "in": "query", - "description": "Operation timeout.", + "description": "Specify whether format-based query failures (such as providing text to a numeric field) should be ignored.", "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout.", - "x-data-type": "time" + "type": "boolean", + "description": "Specify whether format-based query failures (such as providing text to a numeric field) should be ignored." } }, { - "name": "master_timeout", + "name": "rewrite", "in": "query", - "description": "Operation timeout for connection to master node.", + "description": "Provide a more detailed explanation showing the actual Lucene query that will be executed.", "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to master node.", - "x-version-deprecated": "2.0.0", - "x-data-type": "time", - "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", - "deprecated": true + "type": "boolean", + "description": "Provide a more detailed explanation showing the actual Lucene query that will be executed." } }, { - "name": "cluster_manager_timeout", + "name": "all_shards", "in": "query", - "description": "Operation timeout for connection to cluster-manager node.", + "description": "Execute validation on all shards instead of one random shard per index.", "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to cluster-manager node.", - "x-data-type": "time" + "type": "boolean", + "description": "Execute validation on all shards instead of one random shard per index." } } ], "responses": { "200": { - "description": "IndicesPutAlias_Put 200 response" + "description": "IndicesValidateQuery_Post 200 response" } }, - "x-operation-group": "indices.put_alias", + "x-operation-group": "indices.validate_query", "x-version-added": "1.0" } }, - "/{index}/_aliases/{name}": { - "delete": { - "description": "Deletes an alias.", - "operationId": "IndicesDeleteAlias_Plural", + "/{alias}/_rollover": { + "post": { + "description": "Updates an alias to point to a new index when the existing index\nis considered to be too large or too old.", + "externalDocs": { + "description": "API Reference", + "url": "https://opensearch.org/docs/latest/dashboards/im-dashboards/rollover/" + }, + "operationId": "IndicesRollover", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IndicesRollover_BodyParams" + } + } + } + }, "parameters": [ { - "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 - }, - { - "name": "name", + "name": "alias", "in": "path", - "description": "Comma-separated list of aliases to delete (supports wildcards); use `_all` to delete all aliases for the specified indices.", + "description": "The name of the alias to rollover.", "schema": { "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", - "description": "Comma-separated list of aliases to delete (supports wildcards); use `_all` to delete all aliases for the specified indices.", - "x-data-type": "array" + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", + "description": "The name of the alias to rollover." }, "required": true }, @@ -18745,6 +19129,16 @@ "x-data-type": "time" } }, + { + "name": "dry_run", + "in": "query", + "description": "If set to true the rollover action will only be validated but not actually performed even if a condition matches.", + "schema": { + "type": "boolean", + "default": false, + "description": "If set to true the rollover action will only be validated but not actually performed even if a condition matches." + } + }, { "name": "master_timeout", "in": "query", @@ -18769,49 +19163,59 @@ "description": "Operation timeout for connection to cluster-manager node.", "x-data-type": "time" } + }, + { + "name": "wait_for_active_shards", + "in": "query", + "description": "Set the number of active shards to wait for on the newly created rollover index before the operation returns.", + "schema": { + "type": "string", + "description": "Set the number of active shards to wait for on the newly created rollover index before the operation returns." + } } ], "responses": { "200": { - "description": "IndicesDeleteAlias_Plural 200 response" + "description": "IndicesRollover 200 response" } }, - "x-operation-group": "indices.delete_alias", + "x-operation-group": "indices.rollover", "x-version-added": "1.0" - }, + } + }, + "/{alias}/_rollover/{new_index}": { "post": { - "description": "Creates or updates an alias.", - "operationId": "IndicesPutAlias_Post_Plural", + "description": "Updates an alias to point to a new index when the existing index\nis considered to be too large or too old.", + "operationId": "IndicesRollover_WithNewIndex", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/IndicesPutAlias_BodyParams" + "$ref": "#/components/schemas/IndicesRollover_BodyParams" } } } }, "parameters": [ { - "name": "index", + "name": "alias", "in": "path", - "description": "Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices.", + "description": "The name of the alias to rollover.", "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" + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", + "description": "The name of the alias to rollover." }, "required": true }, { - "name": "name", + "name": "new_index", "in": "path", - "description": "The name of the alias to be created or updated.", + "description": "The name of the rollover index.", "schema": { "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", - "description": "The name of the alias to be created or updated." + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", + "description": "The name of the rollover index." }, "required": true }, @@ -18826,6 +19230,16 @@ "x-data-type": "time" } }, + { + "name": "dry_run", + "in": "query", + "description": "If set to true the rollover action will only be validated but not actually performed even if a condition matches.", + "schema": { + "type": "boolean", + "default": false, + "description": "If set to true the rollover action will only be validated but not actually performed even if a condition matches." + } + }, { "name": "master_timeout", "in": "query", @@ -18850,51 +19264,53 @@ "description": "Operation timeout for connection to cluster-manager node.", "x-data-type": "time" } + }, + { + "name": "wait_for_active_shards", + "in": "query", + "description": "Set the number of active shards to wait for on the newly created rollover index before the operation returns.", + "schema": { + "type": "string", + "description": "Set the number of active shards to wait for on the newly created rollover index before the operation returns." + } } ], "responses": { "200": { - "description": "IndicesPutAlias_Post_Plural 200 response" + "description": "IndicesRollover_WithNewIndex 200 response" } }, - "x-operation-group": "indices.put_alias", + "x-operation-group": "indices.rollover", "x-version-added": "1.0" - }, - "put": { - "description": "Creates or updates an alias.", - "operationId": "IndicesPutAlias_Put_Plural", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IndicesPutAlias_BodyParams" - } - } - } + } + }, + "/{index}": { + "delete": { + "description": "Deletes an index.", + "externalDocs": { + "description": "API Reference", + "url": "https://opensearch.org/docs/latest/api-reference/index-apis/delete-index/" }, + "operationId": "IndicesDelete", "parameters": [ { "name": "index", "in": "path", - "description": "Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices.", + "description": "Comma-separated list of indices to delete; use `_all` or `*` string to delete 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.", + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", + "description": "Comma-separated list of indices to delete; use `_all` or `*` string to delete all indices.", "x-data-type": "array" }, - "required": true - }, - { - "name": "name", - "in": "path", - "description": "The name of the alias to be created or updated.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", - "description": "The name of the alias to be created or updated." - }, - "required": true + "required": true, + "examples": { + "IndicesDelete_example1": { + "summary": "Examples for Delete Index Operation.", + "description": "", + "value": "books" + } + } }, { "name": "timeout", @@ -18922,144 +19338,134 @@ } }, { - "name": "cluster_manager_timeout", + "name": "ignore_unavailable", "in": "query", - "description": "Operation timeout for connection to cluster-manager node.", + "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to cluster-manager node.", - "x-data-type": "time" + "type": "boolean", + "default": false, + "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." } - } - ], - "responses": { - "200": { - "description": "IndicesPutAlias_Put_Plural 200 response" - } - }, - "x-operation-group": "indices.put_alias", - "x-version-added": "1.0" - } - }, - "/{index}/_analyze": { - "get": { - "description": "Performs the analysis process on a text and return the tokens breakdown of the text.", - "operationId": "IndicesAnalyze_Get_WithIndex", - "parameters": [ + }, { - "name": "index", - "in": "path", - "description": "The name of the index to scope the operation.", + "name": "allow_no_indices", + "in": "query", + "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified).", "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", - "description": "The name of the index to scope the operation." - }, - "required": true + "type": "boolean", + "default": false, + "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)." + } }, { - "name": "index", + "name": "expand_wildcards", "in": "query", - "description": "The name of the index to scope the operation.", + "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", "schema": { - "type": "string", - "description": "The name of the index to scope the operation." + "$ref": "#/components/schemas/ExpandWildcards" } } ], "responses": { "200": { - "description": "IndicesAnalyze_Get_WithIndex 200 response" + "description": "IndicesDelete 200 response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IndicesDeleteResponseContent" + }, + "examples": { + "IndicesDelete_example1": { + "summary": "Examples for Delete Index Operation.", + "description": "", + "value": { + "acknowledged": true + } + } + } + } + } } }, - "x-operation-group": "indices.analyze", + "x-operation-group": "indices.delete", "x-version-added": "1.0" }, - "post": { - "description": "Performs the analysis process on a text and return the tokens breakdown of the text.", - "operationId": "IndicesAnalyze_Post_WithIndex", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IndicesAnalyze_BodyParams" - } - } - } + "get": { + "description": "Returns information about one or more indices.", + "externalDocs": { + "description": "API Reference", + "url": "https://opensearch.org/docs/latest/api-reference/index-apis/get-index/" }, + "operationId": "IndicesGet", "parameters": [ { "name": "index", "in": "path", - "description": "The name of the index to scope the operation.", + "description": "Comma-separated list of indices.", "schema": { "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", - "description": "The name of the index to scope the operation." + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", + "description": "Comma-separated list of indices.", + "x-data-type": "array" }, "required": true }, { - "name": "index", + "name": "local", "in": "query", - "description": "The name of the index to scope the operation.", + "description": "Return local information, do not retrieve the state from cluster-manager node.", "schema": { - "type": "string", - "description": "The name of the index to scope the operation." + "type": "boolean", + "default": false, + "description": "Return local information, do not retrieve the state from cluster-manager node." } - } - ], - "responses": { - "200": { - "description": "IndicesAnalyze_Post_WithIndex 200 response" - } - }, - "x-operation-group": "indices.analyze", - "x-version-added": "1.0" - } - }, - "/{index}/_block/{block}": { - "put": { - "description": "Adds a block to an index.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest" - }, - "operationId": "IndicesAddBlock", - "parameters": [ + }, { - "name": "index", - "in": "path", - "description": "Comma-separated list of indices to add a block to.", + "name": "ignore_unavailable", + "in": "query", + "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", - "description": "Comma-separated list of indices to add a block to.", - "x-data-type": "array" - }, - "required": true + "type": "boolean", + "default": false, + "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." + } }, { - "name": "block", - "in": "path", - "description": "The block to add (one of read, write, read_only or metadata).", + "name": "allow_no_indices", + "in": "query", + "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified).", "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", - "description": "The block to add (one of read, write, read_only or metadata)." - }, - "required": true + "type": "boolean", + "default": false, + "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)." + } }, { - "name": "timeout", + "name": "expand_wildcards", "in": "query", - "description": "Operation timeout.", + "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout.", - "x-data-type": "time" + "$ref": "#/components/schemas/ExpandWildcards" + } + }, + { + "name": "flat_settings", + "in": "query", + "description": "Return settings in flat format.", + "schema": { + "type": "boolean", + "default": false, + "description": "Return settings in flat format." + } + }, + { + "name": "include_defaults", + "in": "query", + "description": "Whether to return all default setting for each of the indices.", + "schema": { + "type": "boolean", + "default": false, + "description": "Whether to return all default setting for each of the indices." } }, { @@ -19086,6 +19492,45 @@ "description": "Operation timeout for connection to cluster-manager node.", "x-data-type": "time" } + } + ], + "responses": { + "200": { + "description": "IndicesGet 200 response" + } + }, + "x-operation-group": "indices.get", + "x-version-added": "1.0" + }, + "head": { + "description": "Returns information about whether a particular index exists.", + "externalDocs": { + "description": "API Reference", + "url": "https://opensearch.org/docs/latest/api-reference/index-apis/exists/" + }, + "operationId": "IndicesExists", + "parameters": [ + { + "name": "index", + "in": "path", + "description": "Comma-separated list of indices.", + "schema": { + "type": "string", + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", + "description": "Comma-separated list of indices.", + "x-data-type": "array" + }, + "required": true + }, + { + "name": "local", + "in": "query", + "description": "Return local information, do not retrieve the state from cluster-manager node.", + "schema": { + "type": "boolean", + "default": false, + "description": "Return local information, do not retrieve the state from cluster-manager node." + } }, { "name": "ignore_unavailable", @@ -19093,6 +19538,7 @@ "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", "schema": { "type": "boolean", + "default": false, "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." } }, @@ -19102,6 +19548,7 @@ "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified).", "schema": { "type": "boolean", + "default": false, "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)." } }, @@ -19112,351 +19559,385 @@ "schema": { "$ref": "#/components/schemas/ExpandWildcards" } + }, + { + "name": "flat_settings", + "in": "query", + "description": "Return settings in flat format.", + "schema": { + "type": "boolean", + "default": false, + "description": "Return settings in flat format." + } + }, + { + "name": "include_defaults", + "in": "query", + "description": "Whether to return all default setting for each of the indices.", + "schema": { + "type": "boolean", + "default": false, + "description": "Whether to return all default setting for each of the indices." + } } ], "responses": { "200": { - "description": "IndicesAddBlock 200 response" + "description": "IndicesExists 200 response" } }, - "x-operation-group": "indices.add_block", + "x-operation-group": "indices.exists", "x-version-added": "1.0" - } - }, - "/{index}/_bulk": { - "post": { - "description": "Allows to perform multiple index/update/delete operations in a single request.", - "operationId": "Bulk_Post_WithIndex", + }, + "put": { + "description": "Creates an index with optional settings and mappings.", + "externalDocs": { + "description": "API Reference", + "url": "https://opensearch.org/docs/latest/api-reference/index-apis/create-index/" + }, + "operationId": "IndicesCreate", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Bulk_BodyParams" + "$ref": "#/components/schemas/IndicesCreate_BodyParams" } } - }, - "required": true + } }, "parameters": [ { "name": "index", "in": "path", - "description": "Default index for items which don't provide one.", + "description": "Index name.", "schema": { "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", - "description": "Default index for items which don't provide one." + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", + "description": "Index name." }, - "required": true + "required": true, + "examples": { + "IndicesCreate_example1": { + "summary": "Examples for Create Index Operation.", + "description": "", + "value": "books" + } + } }, { "name": "wait_for_active_shards", "in": "query", - "description": "Sets the number of shard copies that must be active before proceeding with the operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1).", + "description": "Set the number of active shards to wait for before the operation returns.", "schema": { "type": "string", - "default": "1", - "description": "Sets the number of shard copies that must be active before proceeding with the operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1)." + "description": "Set the number of active shards to wait for before the operation returns." } }, { - "name": "refresh", + "name": "timeout", "in": "query", - "description": "If `true` then refresh 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` (the default) then do nothing with refreshes.", + "description": "Operation timeout.", "schema": { - "$ref": "#/components/schemas/RefreshEnum" + "type": "string", + "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", + "description": "Operation timeout.", + "x-data-type": "time" } }, { - "name": "routing", + "name": "master_timeout", "in": "query", - "description": "Routing value.", + "description": "Operation timeout for connection to master node.", "schema": { "type": "string", - "description": "Routing value." + "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", + "description": "Operation timeout for connection to master node.", + "x-version-deprecated": "2.0.0", + "x-data-type": "time", + "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", + "deprecated": true } }, { - "name": "timeout", + "name": "cluster_manager_timeout", "in": "query", - "description": "Operation timeout.", + "description": "Operation timeout for connection to cluster-manager node.", "schema": { "type": "string", "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout.", + "description": "Operation timeout for connection to cluster-manager node.", "x-data-type": "time" } - }, - { - "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." + } + ], + "responses": { + "200": { + "description": "IndicesCreate 200 response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IndicesCreateResponseContent" + }, + "examples": { + "IndicesCreate_example1": { + "summary": "Examples for Create Index Operation.", + "description": "", + "value": { + "index": "books", + "shards_acknowledged": true, + "acknowledged": true + } + } + } + } } - }, + } + }, + "x-operation-group": "indices.create", + "x-version-added": "1.0" + } + }, + "/{index}/_alias": { + "get": { + "description": "Returns an alias.", + "operationId": "IndicesGetAlias_WithIndex", + "parameters": [ { - "name": "_source", - "in": "query", - "description": "True or false to return the _source field or not, or default list of fields to return, can be overridden on each sub-request.", - "style": "form", + "name": "index", + "in": "path", + "description": "Comma-separated list of indices to filter aliases.", "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "True or false to return the _source field or not, or default list of fields to return, can be overridden on each sub-request." + "type": "string", + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", + "description": "Comma-separated list of indices to filter aliases.", + "x-data-type": "array" }, - "explode": true + "required": true }, { - "name": "_source_excludes", + "name": "ignore_unavailable", "in": "query", - "description": "Default list of fields to exclude from the returned _source field, can be overridden on each sub-request.", - "style": "form", + "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Default list of fields to exclude from the returned _source field, can be overridden on each sub-request." - }, - "explode": true + "type": "boolean", + "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." + } }, { - "name": "_source_includes", + "name": "allow_no_indices", "in": "query", - "description": "Default list of fields to extract and return from the _source field, can be overridden on each sub-request.", - "style": "form", + "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified).", "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Default list of fields to extract and return from the _source field, can be overridden on each sub-request." - }, - "explode": true + "type": "boolean", + "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)." + } }, { - "name": "pipeline", + "name": "expand_wildcards", "in": "query", - "description": "The pipeline id to preprocess incoming documents with.", + "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", "schema": { - "type": "string", - "description": "The pipeline id to preprocess incoming documents with." + "$ref": "#/components/schemas/ExpandWildcards" } }, { - "name": "require_alias", + "name": "local", "in": "query", - "description": "Sets require_alias for all incoming documents.", + "description": "Return local information, do not retrieve the state from cluster-manager node.", "schema": { "type": "boolean", "default": false, - "description": "Sets require_alias for all incoming documents." + "description": "Return local information, do not retrieve the state from cluster-manager node." } } ], "responses": { "200": { - "description": "Bulk_Post_WithIndex 200 response" + "description": "IndicesGetAlias_WithIndex 200 response" } }, - "x-operation-group": "bulk", + "x-operation-group": "indices.get_alias", "x-version-added": "1.0" - }, - "put": { - "description": "Allows to perform multiple index/update/delete operations in a single request.", - "operationId": "Bulk_Put_WithIndex", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Bulk_BodyParams" - } - } - }, - "required": true + } + }, + "/{index}/_alias/{name}": { + "delete": { + "description": "Deletes an alias.", + "externalDocs": { + "description": "API Reference", + "url": "https://opensearch.org/docs/latest/im-plugin/index-alias/#delete-aliases" }, + "operationId": "IndicesDeleteAlias", "parameters": [ { "name": "index", "in": "path", - "description": "Default index for items which don't provide one.", + "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": "Default index for items which don't provide one." + "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 }, { - "name": "wait_for_active_shards", - "in": "query", - "description": "Sets the number of shard copies that must be active before proceeding with the operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1).", + "name": "name", + "in": "path", + "description": "Comma-separated list of aliases to delete (supports wildcards); use `_all` to delete all aliases for the specified indices.", "schema": { "type": "string", - "default": "1", - "description": "Sets the number of shard copies that must be active before proceeding with the operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1)." - } + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", + "description": "Comma-separated list of aliases to delete (supports wildcards); use `_all` to delete all aliases for the specified indices.", + "x-data-type": "array" + }, + "required": true }, { - "name": "refresh", + "name": "timeout", "in": "query", - "description": "If `true` then refresh 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` (the default) then do nothing with refreshes.", + "description": "Operation timeout.", "schema": { - "$ref": "#/components/schemas/RefreshEnum" + "type": "string", + "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", + "description": "Operation timeout.", + "x-data-type": "time" } }, { - "name": "routing", + "name": "master_timeout", "in": "query", - "description": "Routing value.", + "description": "Operation timeout for connection to master node.", "schema": { "type": "string", - "description": "Routing value." + "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", + "description": "Operation timeout for connection to master node.", + "x-version-deprecated": "2.0.0", + "x-data-type": "time", + "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", + "deprecated": true } }, { - "name": "timeout", + "name": "cluster_manager_timeout", "in": "query", - "description": "Operation timeout.", + "description": "Operation timeout for connection to cluster-manager node.", "schema": { "type": "string", "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout.", + "description": "Operation timeout for connection to cluster-manager node.", "x-data-type": "time" } - }, + } + ], + "responses": { + "200": { + "description": "IndicesDeleteAlias 200 response" + } + }, + "x-operation-group": "indices.delete_alias", + "x-version-added": "1.0" + }, + "get": { + "description": "Returns an alias.", + "operationId": "IndicesGetAlias_WithIndexName", + "parameters": [ { - "name": "type", - "in": "query", - "description": "Default document type for items which don't provide one.", + "name": "index", + "in": "path", + "description": "Comma-separated list of indices to filter aliases.", "schema": { "type": "string", - "description": "Default document type for items which don't provide one." - } + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", + "description": "Comma-separated list of indices to filter aliases.", + "x-data-type": "array" + }, + "required": true }, { - "name": "_source", - "in": "query", - "description": "True or false to return the _source field or not, or default list of fields to return, can be overridden on each sub-request.", - "style": "form", + "name": "name", + "in": "path", + "description": "Comma-separated list of alias names.", "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "True or false to return the _source field or not, or default list of fields to return, can be overridden on each sub-request." + "type": "string", + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", + "description": "Comma-separated list of alias names.", + "x-data-type": "array" }, - "explode": true + "required": true }, { - "name": "_source_excludes", + "name": "ignore_unavailable", "in": "query", - "description": "Default list of fields to exclude from the returned _source field, can be overridden on each sub-request.", - "style": "form", + "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Default list of fields to exclude from the returned _source field, can be overridden on each sub-request." - }, - "explode": true + "type": "boolean", + "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." + } }, { - "name": "_source_includes", + "name": "allow_no_indices", "in": "query", - "description": "Default list of fields to extract and return from the _source field, can be overridden on each sub-request.", - "style": "form", + "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified).", "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Default list of fields to extract and return from the _source field, can be overridden on each sub-request." - }, - "explode": true + "type": "boolean", + "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)." + } }, { - "name": "pipeline", + "name": "expand_wildcards", "in": "query", - "description": "The pipeline id to preprocess incoming documents with.", + "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", "schema": { - "type": "string", - "description": "The pipeline id to preprocess incoming documents with." + "$ref": "#/components/schemas/ExpandWildcards" } }, { - "name": "require_alias", + "name": "local", "in": "query", - "description": "Sets require_alias for all incoming documents.", + "description": "Return local information, do not retrieve the state from cluster-manager node.", "schema": { "type": "boolean", "default": false, - "description": "Sets require_alias for all incoming documents." + "description": "Return local information, do not retrieve the state from cluster-manager node." } } ], "responses": { "200": { - "description": "Bulk_Put_WithIndex 200 response" + "description": "IndicesGetAlias_WithIndexName 200 response" } }, - "x-operation-group": "bulk", + "x-operation-group": "indices.get_alias", "x-version-added": "1.0" - } - }, - "/{index}/_cache/clear": { - "post": { - "description": "Clears all or specific caches for one or more indices.", - "operationId": "IndicesClearCache_WithIndex", + }, + "head": { + "description": "Returns information about whether a particular alias exists.", + "operationId": "IndicesExistsAlias_WithIndex", "parameters": [ { "name": "index", "in": "path", - "description": "Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices.", + "description": "Comma-separated list of indices to filter aliases.", "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.", + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", + "description": "Comma-separated list of indices to filter aliases.", "x-data-type": "array" }, "required": true }, { - "name": "fielddata", - "in": "query", - "description": "Clear field data.", - "schema": { - "type": "boolean", - "description": "Clear field data." - } - }, - { - "name": "fields", - "in": "query", - "description": "Comma-separated list of fields to clear when using the `fielddata` parameter (default: all).", - "style": "form", + "name": "name", + "in": "path", + "description": "Comma-separated list of alias names.", "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of fields to clear when using the `fielddata` parameter (default: all)." + "type": "string", + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", + "description": "Comma-separated list of alias names.", + "x-data-type": "array" }, - "explode": true - }, - { - "name": "query", - "in": "query", - "description": "Clear query caches.", - "schema": { - "type": "boolean", - "description": "Clear query caches." - } + "required": true }, { "name": "ignore_unavailable", @@ -19485,47 +19966,32 @@ } }, { - "name": "index", - "in": "query", - "description": "Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices." - }, - "explode": true - }, - { - "name": "request", + "name": "local", "in": "query", - "description": "Clear request cache.", + "description": "Return local information, do not retrieve the state from cluster-manager node.", "schema": { "type": "boolean", - "description": "Clear request cache." + "default": false, + "description": "Return local information, do not retrieve the state from cluster-manager node." } } ], "responses": { "200": { - "description": "IndicesClearCache_WithIndex 200 response" + "description": "IndicesExistsAlias_WithIndex 200 response" } }, - "x-operation-group": "indices.clear_cache", + "x-operation-group": "indices.exists_alias", "x-version-added": "1.0" - } - }, - "/{index}/_clone/{target}": { + }, "post": { - "description": "Clones an index.", - "operationId": "IndicesClone_Post", + "description": "Creates or updates an alias.", + "operationId": "IndicesPutAlias_Post", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/IndicesClone_BodyParams" + "$ref": "#/components/schemas/IndicesPutAlias_BodyParams" } } } @@ -19534,22 +20000,23 @@ { "name": "index", "in": "path", - "description": "The name of the source index to clone.", + "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": "The name of the source index to clone." + "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 }, { - "name": "target", + "name": "name", "in": "path", - "description": "The name of the target index.", + "description": "The name of the alias to be created or updated.", "schema": { "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", - "description": "The name of the target index." + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", + "description": "The name of the alias to be created or updated." }, "required": true }, @@ -19588,37 +20055,28 @@ "description": "Operation timeout for connection to cluster-manager node.", "x-data-type": "time" } - }, - { - "name": "wait_for_active_shards", - "in": "query", - "description": "Set the number of active shards to wait for on the cloned index before the operation returns.", - "schema": { - "type": "string", - "description": "Set the number of active shards to wait for on the cloned index before the operation returns." - } } ], "responses": { "200": { - "description": "IndicesClone_Post 200 response" + "description": "IndicesPutAlias_Post 200 response" } }, - "x-operation-group": "indices.clone", + "x-operation-group": "indices.put_alias", "x-version-added": "1.0" }, "put": { - "description": "Clones an index.", + "description": "Creates or updates an alias.", "externalDocs": { "description": "API Reference", - "url": "https://opensearch.org/docs/latest" + "url": "https://opensearch.org/docs/latest/im-plugin/index-alias/#create-aliases" }, - "operationId": "IndicesClone_Put", + "operationId": "IndicesPutAlias_Put", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/IndicesClone_BodyParams" + "$ref": "#/components/schemas/IndicesPutAlias_BodyParams" } } } @@ -19627,22 +20085,23 @@ { "name": "index", "in": "path", - "description": "The name of the source index to clone.", + "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": "The name of the source index to clone." + "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 }, { - "name": "target", + "name": "name", "in": "path", - "description": "The name of the target index.", + "description": "The name of the alias to be created or updated.", "schema": { "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", - "description": "The name of the target index." + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", + "description": "The name of the alias to be created or updated." }, "required": true }, @@ -19681,43 +20140,42 @@ "description": "Operation timeout for connection to cluster-manager node.", "x-data-type": "time" } - }, - { - "name": "wait_for_active_shards", - "in": "query", - "description": "Set the number of active shards to wait for on the cloned index before the operation returns.", - "schema": { - "type": "string", - "description": "Set the number of active shards to wait for on the cloned index before the operation returns." - } } ], "responses": { "200": { - "description": "IndicesClone_Put 200 response" + "description": "IndicesPutAlias_Put 200 response" } }, - "x-operation-group": "indices.clone", + "x-operation-group": "indices.put_alias", "x-version-added": "1.0" } }, - "/{index}/_close": { - "post": { - "description": "Closes an index.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest" - }, - "operationId": "IndicesClose", + "/{index}/_aliases/{name}": { + "delete": { + "description": "Deletes an alias.", + "operationId": "IndicesDeleteAlias_Plural", "parameters": [ { "name": "index", "in": "path", - "description": "Comma-separated list of indices to close.", + "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 to close.", + "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 + }, + { + "name": "name", + "in": "path", + "description": "Comma-separated list of aliases to delete (supports wildcards); use `_all` to delete all aliases for the specified indices.", + "schema": { + "type": "string", + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", + "description": "Comma-separated list of aliases to delete (supports wildcards); use `_all` to delete all aliases for the specified indices.", "x-data-type": "array" }, "required": true @@ -19757,219 +20215,221 @@ "description": "Operation timeout for connection to cluster-manager node.", "x-data-type": "time" } - }, - { - "name": "ignore_unavailable", - "in": "query", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", - "schema": { - "type": "boolean", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." - } - }, - { - "name": "allow_no_indices", - "in": "query", - "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified).", - "schema": { - "type": "boolean", - "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)." - } - }, - { - "name": "expand_wildcards", - "in": "query", - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", - "schema": { - "$ref": "#/components/schemas/ExpandWildcards" - } - }, - { - "name": "wait_for_active_shards", - "in": "query", - "description": "Sets the number of active shards to wait for before the operation returns.", - "schema": { - "type": "string", - "description": "Sets the number of active shards to wait for before the operation returns." - } } ], "responses": { "200": { - "description": "IndicesClose 200 response" + "description": "IndicesDeleteAlias_Plural 200 response" } }, - "x-operation-group": "indices.close", + "x-operation-group": "indices.delete_alias", "x-version-added": "1.0" - } - }, - "/{index}/_count": { - "get": { - "description": "Returns number of documents matching a query.", - "operationId": "Count_Get_WithIndex", + }, + "post": { + "description": "Creates or updates an alias.", + "operationId": "IndicesPutAlias_Post_Plural", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IndicesPutAlias_BodyParams" + } + } + } + }, "parameters": [ { "name": "index", "in": "path", - "description": "Comma-separated list of indices to restrict the results.", + "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 to restrict the results.", + "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 }, { - "name": "ignore_unavailable", - "in": "query", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", + "name": "name", + "in": "path", + "description": "The name of the alias to be created or updated.", "schema": { - "type": "boolean", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." - } + "type": "string", + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", + "description": "The name of the alias to be created or updated." + }, + "required": true }, { - "name": "ignore_throttled", + "name": "timeout", "in": "query", - "description": "Whether specified concrete, expanded or aliased indices should be ignored when throttled.", + "description": "Operation timeout.", "schema": { - "type": "boolean", - "description": "Whether specified concrete, expanded or aliased indices should be ignored when throttled." + "type": "string", + "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", + "description": "Operation timeout.", + "x-data-type": "time" } }, { - "name": "allow_no_indices", + "name": "master_timeout", "in": "query", - "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified).", + "description": "Operation timeout for connection to master node.", "schema": { - "type": "boolean", - "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)." + "type": "string", + "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", + "description": "Operation timeout for connection to master node.", + "x-version-deprecated": "2.0.0", + "x-data-type": "time", + "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", + "deprecated": true } }, { - "name": "expand_wildcards", + "name": "cluster_manager_timeout", "in": "query", - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", + "description": "Operation timeout for connection to cluster-manager node.", "schema": { - "$ref": "#/components/schemas/ExpandWildcards" + "type": "string", + "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", + "description": "Operation timeout for connection to cluster-manager node.", + "x-data-type": "time" } - }, - { - "name": "min_score", - "in": "query", - "description": "Include only documents with a specific `_score` value in the result.", - "schema": { - "type": "integer", - "description": "Include only documents with a specific `_score` value in the result.", - "format": "int32" + } + ], + "responses": { + "200": { + "description": "IndicesPutAlias_Post_Plural 200 response" + } + }, + "x-operation-group": "indices.put_alias", + "x-version-added": "1.0" + }, + "put": { + "description": "Creates or updates an alias.", + "operationId": "IndicesPutAlias_Put_Plural", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IndicesPutAlias_BodyParams" + } } - }, + } + }, + "parameters": [ { - "name": "preference", - "in": "query", - "description": "Specify the node or shard the operation should be performed on.", + "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", - "default": "random", - "description": "Specify the node or shard the operation should be performed on." - } - }, - { - "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." + "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" }, - "explode": true + "required": true }, { - "name": "q", - "in": "query", - "description": "Query in the Lucene query string syntax.", + "name": "name", + "in": "path", + "description": "The name of the alias to be created or updated.", "schema": { "type": "string", - "description": "Query in the Lucene query string syntax." - } + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", + "description": "The name of the alias to be created or updated." + }, + "required": true }, { - "name": "analyzer", + "name": "timeout", "in": "query", - "description": "The analyzer to use for the query string.", + "description": "Operation timeout.", "schema": { "type": "string", - "description": "The analyzer to use for the query string." - } - }, - { - "name": "analyze_wildcard", - "in": "query", - "description": "Specify whether wildcard and prefix queries should be analyzed.", - "schema": { - "type": "boolean", - "default": false, - "description": "Specify whether wildcard and prefix queries should be analyzed." + "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", + "description": "Operation timeout.", + "x-data-type": "time" } }, { - "name": "default_operator", + "name": "master_timeout", "in": "query", - "description": "The default operator for query string query (AND or OR).", + "description": "Operation timeout for connection to master node.", "schema": { - "$ref": "#/components/schemas/DefaultOperator" + "type": "string", + "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", + "description": "Operation timeout for connection to master node.", + "x-version-deprecated": "2.0.0", + "x-data-type": "time", + "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", + "deprecated": true } }, { - "name": "df", + "name": "cluster_manager_timeout", "in": "query", - "description": "The field to use as default where no field prefix is given in the query string.", + "description": "Operation timeout for connection to cluster-manager node.", "schema": { "type": "string", - "description": "The field to use as default where no field prefix is given in the query string." + "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", + "description": "Operation timeout for connection to cluster-manager node.", + "x-data-type": "time" } - }, + } + ], + "responses": { + "200": { + "description": "IndicesPutAlias_Put_Plural 200 response" + } + }, + "x-operation-group": "indices.put_alias", + "x-version-added": "1.0" + } + }, + "/{index}/_analyze": { + "get": { + "description": "Performs the analysis process on a text and return the tokens breakdown of the text.", + "operationId": "IndicesAnalyze_Get_WithIndex", + "parameters": [ { - "name": "lenient", - "in": "query", - "description": "Specify whether format-based query failures (such as providing text to a numeric field) should be ignored.", + "name": "index", + "in": "path", + "description": "The name of the index to scope the operation.", "schema": { - "type": "boolean", - "description": "Specify whether format-based query failures (such as providing text to a numeric field) should be ignored." - } + "type": "string", + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", + "description": "The name of the index to scope the operation." + }, + "required": true }, { - "name": "terminate_after", + "name": "index", "in": "query", - "description": "The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early.", + "description": "The name of the index to scope the operation.", "schema": { - "type": "integer", - "description": "The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early.", - "format": "int32" + "type": "string", + "description": "The name of the index to scope the operation." } } ], "responses": { "200": { - "description": "Count_Get_WithIndex 200 response" + "description": "IndicesAnalyze_Get_WithIndex 200 response" } }, - "x-operation-group": "count", + "x-operation-group": "indices.analyze", "x-version-added": "1.0" }, "post": { - "description": "Returns number of documents matching a query.", - "operationId": "Count_Post_WithIndex", + "description": "Performs the analysis process on a text and return the tokens breakdown of the text.", + "operationId": "IndicesAnalyze_Post_WithIndex", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Count_BodyParams" + "$ref": "#/components/schemas/IndicesAnalyze_BodyParams" } } } @@ -19978,192 +20438,160 @@ { "name": "index", "in": "path", - "description": "Comma-separated list of indices to restrict the results.", + "description": "The name of the index to scope the operation.", "schema": { "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", - "description": "Comma-separated list of indices to restrict the results.", - "x-data-type": "array" + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", + "description": "The name of the index to scope the operation." }, "required": true }, { - "name": "ignore_unavailable", + "name": "index", "in": "query", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", + "description": "The name of the index to scope the operation.", "schema": { - "type": "boolean", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." + "type": "string", + "description": "The name of the index to scope the operation." } - }, + } + ], + "responses": { + "200": { + "description": "IndicesAnalyze_Post_WithIndex 200 response" + } + }, + "x-operation-group": "indices.analyze", + "x-version-added": "1.0" + } + }, + "/{index}/_block/{block}": { + "put": { + "description": "Adds a block to an index.", + "externalDocs": { + "description": "API Reference", + "url": "https://opensearch.org/docs/latest" + }, + "operationId": "IndicesAddBlock", + "parameters": [ { - "name": "ignore_throttled", - "in": "query", - "description": "Whether specified concrete, expanded or aliased indices should be ignored when throttled.", + "name": "index", + "in": "path", + "description": "Comma-separated list of indices to add a block to.", "schema": { - "type": "boolean", - "description": "Whether specified concrete, expanded or aliased indices should be ignored when throttled." - } + "type": "string", + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", + "description": "Comma-separated list of indices to add a block to.", + "x-data-type": "array" + }, + "required": true }, { - "name": "allow_no_indices", - "in": "query", - "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified).", - "schema": { - "type": "boolean", - "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)." - } - }, - { - "name": "expand_wildcards", - "in": "query", - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", - "schema": { - "$ref": "#/components/schemas/ExpandWildcards" - } - }, - { - "name": "min_score", - "in": "query", - "description": "Include only documents with a specific `_score` value in the result.", - "schema": { - "type": "integer", - "description": "Include only documents with a specific `_score` value in the result.", - "format": "int32" - } - }, - { - "name": "preference", - "in": "query", - "description": "Specify the node or shard the operation should be performed on.", + "name": "block", + "in": "path", + "description": "The block to add (one of read, write, read_only or metadata).", "schema": { "type": "string", - "default": "random", - "description": "Specify the node or shard the operation should be performed on." - } - }, - { - "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." + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", + "description": "The block to add (one of read, write, read_only or metadata)." }, - "explode": true + "required": true }, { - "name": "q", + "name": "timeout", "in": "query", - "description": "Query in the Lucene query string syntax.", + "description": "Operation timeout.", "schema": { "type": "string", - "description": "Query in the Lucene query string syntax." + "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", + "description": "Operation timeout.", + "x-data-type": "time" } }, { - "name": "analyzer", + "name": "master_timeout", "in": "query", - "description": "The analyzer to use for the query string.", + "description": "Operation timeout for connection to master node.", "schema": { "type": "string", - "description": "The analyzer to use for the query string." - } - }, - { - "name": "analyze_wildcard", - "in": "query", - "description": "Specify whether wildcard and prefix queries should be analyzed.", - "schema": { - "type": "boolean", - "default": false, - "description": "Specify whether wildcard and prefix queries should be analyzed." + "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", + "description": "Operation timeout for connection to master node.", + "x-version-deprecated": "2.0.0", + "x-data-type": "time", + "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", + "deprecated": true } }, { - "name": "default_operator", + "name": "cluster_manager_timeout", "in": "query", - "description": "The default operator for query string query (AND or OR).", + "description": "Operation timeout for connection to cluster-manager node.", "schema": { - "$ref": "#/components/schemas/DefaultOperator" + "type": "string", + "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", + "description": "Operation timeout for connection to cluster-manager node.", + "x-data-type": "time" } }, { - "name": "df", + "name": "ignore_unavailable", "in": "query", - "description": "The field to use as default where no field prefix is given in the query string.", + "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", "schema": { - "type": "string", - "description": "The field to use as default where no field prefix is given in the query string." + "type": "boolean", + "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." } }, { - "name": "lenient", + "name": "allow_no_indices", "in": "query", - "description": "Specify whether format-based query failures (such as providing text to a numeric field) should be ignored.", + "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified).", "schema": { "type": "boolean", - "description": "Specify whether format-based query failures (such as providing text to a numeric field) should be ignored." + "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)." } }, { - "name": "terminate_after", + "name": "expand_wildcards", "in": "query", - "description": "The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early.", + "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", "schema": { - "type": "integer", - "description": "The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early.", - "format": "int32" + "$ref": "#/components/schemas/ExpandWildcards" } } ], "responses": { "200": { - "description": "Count_Post_WithIndex 200 response" + "description": "IndicesAddBlock 200 response" } }, - "x-operation-group": "count", + "x-operation-group": "indices.add_block", "x-version-added": "1.0" } }, - "/{index}/_create/{id}": { + "/{index}/_bulk": { "post": { - "description": "Creates a new document in the index.\n\nReturns a 409 response when a document with a same ID already exists in the index.", - "operationId": "Create_Post", + "description": "Allows to perform multiple index/update/delete operations in a single request.", + "operationId": "Bulk_Post_WithIndex", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Create_BodyParams" + "$ref": "#/components/schemas/Bulk_BodyParams" } } }, "required": true }, "parameters": [ - { - "name": "id", - "in": "path", - "description": "Document ID.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", - "description": "Document ID." - }, - "required": true - }, { "name": "index", "in": "path", - "description": "Index name.", + "description": "Default index for items which don't provide one.", "schema": { "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", - "description": "Index name." + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", + "description": "Default index for items which don't provide one." }, "required": true }, @@ -20206,22 +20634,55 @@ } }, { - "name": "version", + "name": "type", "in": "query", - "description": "Explicit version number for concurrency control.", + "description": "Default document type for items which don't provide one.", "schema": { - "type": "integer", - "description": "Explicit version number for concurrency control.", - "format": "int32" + "type": "string", + "description": "Default document type for items which don't provide one." } }, { - "name": "version_type", + "name": "_source", "in": "query", - "description": "Specific version type.", + "description": "True or false to return the _source field or not, or default list of fields to return, can be overridden on each sub-request.", + "style": "form", "schema": { - "$ref": "#/components/schemas/VersionType" - } + "type": "array", + "items": { + "type": "string" + }, + "description": "True or false to return the _source field or not, or default list of fields to return, can be overridden on each sub-request." + }, + "explode": true + }, + { + "name": "_source_excludes", + "in": "query", + "description": "Default list of fields to exclude from the returned _source field, can be overridden on each sub-request.", + "style": "form", + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Default list of fields to exclude from the returned _source field, can be overridden on each sub-request." + }, + "explode": true + }, + { + "name": "_source_includes", + "in": "query", + "description": "Default list of fields to extract and return from the _source field, can be overridden on each sub-request.", + "style": "form", + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Default list of fields to extract and return from the _source field, can be overridden on each sub-request." + }, + "explode": true }, { "name": "pipeline", @@ -20231,53 +20692,48 @@ "type": "string", "description": "The pipeline id to preprocess incoming documents with." } + }, + { + "name": "require_alias", + "in": "query", + "description": "Sets require_alias for all incoming documents.", + "schema": { + "type": "boolean", + "default": false, + "description": "Sets require_alias for all incoming documents." + } } ], "responses": { "200": { - "description": "Create_Post 200 response" + "description": "Bulk_Post_WithIndex 200 response" } }, - "x-operation-group": "create", + "x-operation-group": "bulk", "x-version-added": "1.0" }, "put": { - "description": "Creates a new document in the index.\n\nReturns a 409 response when a document with a same ID already exists in the index.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest" - }, - "operationId": "Create_Put", + "description": "Allows to perform multiple index/update/delete operations in a single request.", + "operationId": "Bulk_Put_WithIndex", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Create_BodyParams" + "$ref": "#/components/schemas/Bulk_BodyParams" } } }, "required": true }, "parameters": [ - { - "name": "id", - "in": "path", - "description": "Document ID.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", - "description": "Document ID." - }, - "required": true - }, { "name": "index", "in": "path", - "description": "Index name.", + "description": "Default index for items which don't provide one.", "schema": { "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", - "description": "Index name." + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", + "description": "Default index for items which don't provide one." }, "required": true }, @@ -20320,118 +20776,132 @@ } }, { - "name": "version", + "name": "type", "in": "query", - "description": "Explicit version number for concurrency control.", + "description": "Default document type for items which don't provide one.", "schema": { - "type": "integer", - "description": "Explicit version number for concurrency control.", - "format": "int32" + "type": "string", + "description": "Default document type for items which don't provide one." } }, { - "name": "version_type", + "name": "_source", "in": "query", - "description": "Specific version type.", + "description": "True or false to return the _source field or not, or default list of fields to return, can be overridden on each sub-request.", + "style": "form", "schema": { - "$ref": "#/components/schemas/VersionType" - } + "type": "array", + "items": { + "type": "string" + }, + "description": "True or false to return the _source field or not, or default list of fields to return, can be overridden on each sub-request." + }, + "explode": true }, { - "name": "pipeline", + "name": "_source_excludes", "in": "query", - "description": "The pipeline id to preprocess incoming documents with.", + "description": "Default list of fields to exclude from the returned _source field, can be overridden on each sub-request.", + "style": "form", "schema": { - "type": "string", - "description": "The pipeline id to preprocess incoming documents with." - } - } - ], - "responses": { - "200": { - "description": "Create_Put 200 response" - } - }, - "x-operation-group": "create", - "x-version-added": "1.0" - } - }, - "/{index}/_delete_by_query": { - "post": { - "description": "Deletes documents matching the provided query.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest" - }, - "operationId": "DeleteByQuery", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DeleteByQuery_BodyParams" - } - } + "type": "array", + "items": { + "type": "string" + }, + "description": "Default list of fields to exclude from the returned _source field, can be overridden on each sub-request." + }, + "explode": true }, - "required": true - }, - "parameters": [ { - "name": "index", - "in": "path", - "description": "Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices.", + "name": "_source_includes", + "in": "query", + "description": "Default list of fields to extract and return from the _source field, can be overridden on each sub-request.", + "style": "form", "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" + "type": "array", + "items": { + "type": "string" + }, + "description": "Default list of fields to extract and return from the _source field, can be overridden on each sub-request." }, - "required": true + "explode": true }, { - "name": "analyzer", + "name": "pipeline", "in": "query", - "description": "The analyzer to use for the query string.", + "description": "The pipeline id to preprocess incoming documents with.", "schema": { "type": "string", - "description": "The analyzer to use for the query string." + "description": "The pipeline id to preprocess incoming documents with." } }, { - "name": "analyze_wildcard", + "name": "require_alias", "in": "query", - "description": "Specify whether wildcard and prefix queries should be analyzed.", + "description": "Sets require_alias for all incoming documents.", "schema": { "type": "boolean", "default": false, - "description": "Specify whether wildcard and prefix queries should be analyzed." + "description": "Sets require_alias for all incoming documents." } + } + ], + "responses": { + "200": { + "description": "Bulk_Put_WithIndex 200 response" + } + }, + "x-operation-group": "bulk", + "x-version-added": "1.0" + } + }, + "/{index}/_cache/clear": { + "post": { + "description": "Clears all or specific caches for one or more indices.", + "operationId": "IndicesClearCache_WithIndex", + "parameters": [ + { + "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 }, { - "name": "default_operator", + "name": "fielddata", "in": "query", - "description": "The default operator for query string query (AND or OR).", + "description": "Clear field data.", "schema": { - "$ref": "#/components/schemas/DefaultOperator" + "type": "boolean", + "description": "Clear field data." } }, { - "name": "df", + "name": "fields", "in": "query", - "description": "The field to use as default where no field prefix is given in the query string.", + "description": "Comma-separated list of fields to clear when using the `fielddata` parameter (default: all).", + "style": "form", "schema": { - "type": "string", - "description": "The field to use as default where no field prefix is given in the query string." - } + "type": "array", + "items": { + "type": "string" + }, + "description": "Comma-separated list of fields to clear when using the `fielddata` parameter (default: all)." + }, + "explode": true }, { - "name": "from", + "name": "query", "in": "query", - "description": "Starting offset.", + "description": "Clear query caches.", "schema": { - "type": "integer", - "default": 0, - "description": "Starting offset.", - "format": "int32" + "type": "boolean", + "description": "Clear query caches." } }, { @@ -20452,14 +20922,6 @@ "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)." } }, - { - "name": "conflicts", - "in": "query", - "description": "What to do when the operation encounters version conflicts?.", - "schema": { - "$ref": "#/components/schemas/Conflicts" - } - }, { "name": "expand_wildcards", "in": "query", @@ -20469,673 +20931,725 @@ } }, { - "name": "lenient", + "name": "index", "in": "query", - "description": "Specify whether format-based query failures (such as providing text to a numeric field) should be ignored.", + "description": "Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices.", + "style": "form", "schema": { - "type": "boolean", - "description": "Specify whether format-based query failures (such as providing text to a numeric field) should be ignored." - } + "type": "array", + "items": { + "type": "string" + }, + "description": "Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices." + }, + "explode": true }, { - "name": "preference", + "name": "request", "in": "query", - "description": "Specify the node or shard the operation should be performed on.", + "description": "Clear request cache.", "schema": { - "type": "string", - "default": "random", - "description": "Specify the node or shard the operation should be performed on." + "type": "boolean", + "description": "Clear request cache." } - }, + } + ], + "responses": { + "200": { + "description": "IndicesClearCache_WithIndex 200 response" + } + }, + "x-operation-group": "indices.clear_cache", + "x-version-added": "1.0" + } + }, + "/{index}/_clone/{target}": { + "post": { + "description": "Clones an index.", + "operationId": "IndicesClone_Post", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IndicesClone_BodyParams" + } + } + } + }, + "parameters": [ { - "name": "q", - "in": "query", - "description": "Query in the Lucene query string syntax.", + "name": "index", + "in": "path", + "description": "The name of the source index to clone.", "schema": { "type": "string", - "description": "Query in the Lucene query string syntax." - } + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", + "description": "The name of the source index to clone." + }, + "required": true }, { - "name": "routing", - "in": "query", - "description": "Comma-separated list of specific routing values.", - "style": "form", + "name": "target", + "in": "path", + "description": "The name of the target index.", "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of specific routing values." + "type": "string", + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", + "description": "The name of the target index." }, - "explode": true + "required": true }, { - "name": "scroll", + "name": "timeout", "in": "query", - "description": "Specify how long a consistent view of the index should be maintained for scrolled search.", + "description": "Operation timeout.", "schema": { "type": "string", "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Specify how long a consistent view of the index should be maintained for scrolled search.", + "description": "Operation timeout.", "x-data-type": "time" } }, { - "name": "search_type", + "name": "master_timeout", "in": "query", - "description": "Search operation type.", + "description": "Operation timeout for connection to master node.", "schema": { - "$ref": "#/components/schemas/SearchType" + "type": "string", + "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", + "description": "Operation timeout for connection to master node.", + "x-version-deprecated": "2.0.0", + "x-data-type": "time", + "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", + "deprecated": true } }, { - "name": "search_timeout", + "name": "cluster_manager_timeout", "in": "query", - "description": "Explicit timeout for each search request. Defaults to no timeout.", + "description": "Operation timeout for connection to cluster-manager node.", "schema": { "type": "string", "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Explicit timeout for each search request. Defaults to no timeout.", + "description": "Operation timeout for connection to cluster-manager node.", "x-data-type": "time" } }, { - "name": "size", - "in": "query", - "description": "Deprecated, please use `max_docs` instead.", - "schema": { - "type": "integer", - "description": "Deprecated, please use `max_docs` instead.", - "format": "int32" - } - }, - { - "name": "max_docs", + "name": "wait_for_active_shards", "in": "query", - "description": "Maximum number of documents to process (default: all documents).", + "description": "Set the number of active shards to wait for on the cloned index before the operation returns.", "schema": { - "type": "integer", - "description": "Maximum number of documents to process (default: all documents).", - "format": "int32" + "type": "string", + "description": "Set the number of active shards to wait for on the cloned index before the operation returns." } - }, - { - "name": "sort", - "in": "query", - "description": "Comma-separated list of : pairs.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of : pairs." - }, - "explode": true - }, + } + ], + "responses": { + "200": { + "description": "IndicesClone_Post 200 response" + } + }, + "x-operation-group": "indices.clone", + "x-version-added": "1.0" + }, + "put": { + "description": "Clones an index.", + "externalDocs": { + "description": "API Reference", + "url": "https://opensearch.org/docs/latest/api-reference/index-apis/clone/" + }, + "operationId": "IndicesClone_Put", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IndicesClone_BodyParams" + } + } + } + }, + "parameters": [ { - "name": "_source", - "in": "query", - "description": "True or false to return the _source field or not, or a list of fields to return.", - "style": "form", + "name": "index", + "in": "path", + "description": "The name of the source index to clone.", "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "True or false to return the _source field or not, or a list of fields to return." + "type": "string", + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", + "description": "The name of the source index to clone." }, - "explode": true + "required": true }, { - "name": "_source_excludes", - "in": "query", - "description": "List of fields to exclude from the returned _source field.", - "style": "form", + "name": "target", + "in": "path", + "description": "The name of the target index.", "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "List of fields to exclude from the returned _source field." + "type": "string", + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", + "description": "The name of the target index." }, - "explode": true + "required": true }, { - "name": "_source_includes", + "name": "timeout", "in": "query", - "description": "List of fields to extract and return from the _source field.", - "style": "form", + "description": "Operation timeout.", "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "List of fields to extract and return from the _source field." - }, - "explode": true + "type": "string", + "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", + "description": "Operation timeout.", + "x-data-type": "time" + } }, { - "name": "terminate_after", + "name": "master_timeout", "in": "query", - "description": "The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early.", + "description": "Operation timeout for connection to master node.", "schema": { - "type": "integer", - "description": "The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early.", - "format": "int32" + "type": "string", + "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", + "description": "Operation timeout for connection to master node.", + "x-version-deprecated": "2.0.0", + "x-data-type": "time", + "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", + "deprecated": true } }, { - "name": "stats", + "name": "cluster_manager_timeout", "in": "query", - "description": "Specific 'tag' of the request for logging and statistical purposes.", - "style": "form", + "description": "Operation timeout for connection to cluster-manager node.", "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Specific 'tag' of the request for logging and statistical purposes." - }, - "explode": true + "type": "string", + "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", + "description": "Operation timeout for connection to cluster-manager node.", + "x-data-type": "time" + } }, { - "name": "version", + "name": "wait_for_active_shards", "in": "query", - "description": "Whether to return document version as part of a hit.", + "description": "Set the number of active shards to wait for on the cloned index before the operation returns.", "schema": { - "type": "boolean", - "description": "Whether to return document version as part of a hit." + "type": "string", + "description": "Set the number of active shards to wait for on the cloned index before the operation returns." } - }, + } + ], + "responses": { + "200": { + "description": "IndicesClone_Put 200 response" + } + }, + "x-operation-group": "indices.clone", + "x-version-added": "1.0" + } + }, + "/{index}/_close": { + "post": { + "description": "Closes an index.", + "externalDocs": { + "description": "API Reference", + "url": "https://opensearch.org/docs/latest/api-reference/index-apis/close-index/" + }, + "operationId": "IndicesClose", + "parameters": [ { - "name": "request_cache", - "in": "query", - "description": "Specify if request cache should be used for this request or not, defaults to index level setting.", + "name": "index", + "in": "path", + "description": "Comma-separated list of indices to close.", "schema": { - "type": "boolean", - "description": "Specify if request cache should be used for this request or not, defaults to index level setting." - } + "type": "string", + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", + "description": "Comma-separated list of indices to close.", + "x-data-type": "array" + }, + "required": true }, { - "name": "refresh", + "name": "timeout", "in": "query", - "description": "Refresh the shard containing the document before performing the operation.", + "description": "Operation timeout.", "schema": { - "type": "boolean", - "description": "Refresh the shard containing the document before performing the operation." + "type": "string", + "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", + "description": "Operation timeout.", + "x-data-type": "time" } }, { - "name": "timeout", + "name": "master_timeout", "in": "query", - "description": "Time each individual bulk request should wait for shards that are unavailable.", + "description": "Operation timeout for connection to master node.", "schema": { "type": "string", - "default": "1m", "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Time each individual bulk request should wait for shards that are unavailable.", - "x-data-type": "time" + "description": "Operation timeout for connection to master node.", + "x-version-deprecated": "2.0.0", + "x-data-type": "time", + "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", + "deprecated": true } }, { - "name": "wait_for_active_shards", + "name": "cluster_manager_timeout", "in": "query", - "description": "Sets the number of shard copies that must be active before proceeding with the operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1).", + "description": "Operation timeout for connection to cluster-manager node.", "schema": { "type": "string", - "default": "1", - "description": "Sets the number of shard copies that must be active before proceeding with the operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1)." + "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", + "description": "Operation timeout for connection to cluster-manager node.", + "x-data-type": "time" } }, { - "name": "scroll_size", + "name": "ignore_unavailable", "in": "query", - "description": "Size on the scroll request powering the operation.", + "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", "schema": { - "type": "integer", - "default": 100, - "description": "Size on the scroll request powering the operation.", - "format": "int32" + "type": "boolean", + "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." } }, { - "name": "wait_for_completion", + "name": "allow_no_indices", "in": "query", - "description": "Should this request wait until the operation has completed before returning.", + "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified).", "schema": { "type": "boolean", - "default": true, - "description": "Should this request wait until the operation has completed before returning." + "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)." } }, { - "name": "requests_per_second", + "name": "expand_wildcards", "in": "query", - "description": "The throttle for this request in sub-requests per second. -1 means no throttle.", + "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", "schema": { - "type": "integer", - "default": 0, - "description": "The throttle for this request in sub-requests per second. -1 means no throttle.", - "format": "int32" + "$ref": "#/components/schemas/ExpandWildcards" } }, { - "name": "slices", + "name": "wait_for_active_shards", "in": "query", - "description": "The number of slices this task should be divided into. Defaults to 1, meaning the task isn't sliced into subtasks. Can be set to `auto`.", + "description": "Sets the number of active shards to wait for before the operation returns.", "schema": { "type": "string", - "default": "1", - "description": "The number of slices this task should be divided into. Defaults to 1, meaning the task isn't sliced into subtasks. Can be set to `auto`." + "description": "Sets the number of active shards to wait for before the operation returns." } } ], "responses": { "200": { - "description": "DeleteByQuery 200 response" + "description": "IndicesClose 200 response" } }, - "x-operation-group": "delete_by_query", + "x-operation-group": "indices.close", "x-version-added": "1.0" } }, - "/{index}/_doc": { - "post": { - "description": "Creates or updates a document in an index.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest" - }, - "operationId": "Index_Post", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Index_BodyParams" - } - } - }, - "required": true - }, + "/{index}/_count": { + "get": { + "description": "Returns number of documents matching a query.", + "operationId": "Count_Get_WithIndex", "parameters": [ { "name": "index", "in": "path", - "description": "Index name.", + "description": "Comma-separated list of indices to restrict the results.", "schema": { "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", - "description": "Index name." + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", + "description": "Comma-separated list of indices to restrict the results.", + "x-data-type": "array" }, "required": true }, { - "name": "wait_for_active_shards", + "name": "ignore_unavailable", "in": "query", - "description": "Sets the number of shard copies that must be active before proceeding with the operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1).", + "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", "schema": { - "type": "string", - "default": "1", - "description": "Sets the number of shard copies that must be active before proceeding with the operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1)." + "type": "boolean", + "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." } }, { - "name": "op_type", + "name": "ignore_throttled", "in": "query", - "description": "Explicit operation type. Defaults to `index` for requests with an explicit document ID, and to `create`for requests without an explicit document ID.", + "description": "Whether specified concrete, expanded or aliased indices should be ignored when throttled.", "schema": { - "$ref": "#/components/schemas/OpType" + "type": "boolean", + "description": "Whether specified concrete, expanded or aliased indices should be ignored when throttled." } }, { - "name": "refresh", + "name": "allow_no_indices", "in": "query", - "description": "If `true` then refresh 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` (the default) then do nothing with refreshes.", + "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified).", "schema": { - "$ref": "#/components/schemas/RefreshEnum" + "type": "boolean", + "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)." } }, { - "name": "routing", + "name": "expand_wildcards", "in": "query", - "description": "Routing value.", + "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", "schema": { - "type": "string", - "description": "Routing value." + "$ref": "#/components/schemas/ExpandWildcards" } }, { - "name": "timeout", + "name": "min_score", "in": "query", - "description": "Operation timeout.", + "description": "Include only documents with a specific `_score` value in the result.", + "schema": { + "type": "integer", + "description": "Include only documents with a specific `_score` value in the result.", + "format": "int32" + } + }, + { + "name": "preference", + "in": "query", + "description": "Specify the node or shard the operation should be performed on.", "schema": { "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout.", - "x-data-type": "time" + "default": "random", + "description": "Specify the node or shard the operation should be performed on." } }, { - "name": "version", + "name": "routing", "in": "query", - "description": "Explicit version number for concurrency control.", + "description": "Comma-separated list of specific routing values.", + "style": "form", "schema": { - "type": "integer", - "description": "Explicit version number for concurrency control.", - "format": "int32" + "type": "array", + "items": { + "type": "string" + }, + "description": "Comma-separated list of specific routing values." + }, + "explode": true + }, + { + "name": "q", + "in": "query", + "description": "Query in the Lucene query string syntax.", + "schema": { + "type": "string", + "description": "Query in the Lucene query string syntax." } }, { - "name": "version_type", + "name": "analyzer", "in": "query", - "description": "Specific version type.", + "description": "The analyzer to use for the query string.", "schema": { - "$ref": "#/components/schemas/VersionType" + "type": "string", + "description": "The analyzer to use for the query string." } }, { - "name": "if_seq_no", + "name": "analyze_wildcard", "in": "query", - "description": "only perform the operation if the last operation that has changed the document has the specified sequence number.", + "description": "Specify whether wildcard and prefix queries should be analyzed.", "schema": { - "type": "integer", - "description": "only perform the operation if the last operation that has changed the document has the specified sequence number.", - "format": "int32" + "type": "boolean", + "default": false, + "description": "Specify whether wildcard and prefix queries should be analyzed." } }, { - "name": "if_primary_term", + "name": "default_operator", "in": "query", - "description": "only perform the operation if the last operation that has changed the document has the specified primary term.", + "description": "The default operator for query string query (AND or OR).", "schema": { - "type": "integer", - "description": "only perform the operation if the last operation that has changed the document has the specified primary term.", - "format": "int32" + "$ref": "#/components/schemas/DefaultOperator" } }, { - "name": "pipeline", + "name": "df", "in": "query", - "description": "The pipeline id to preprocess incoming documents with.", + "description": "The field to use as default where no field prefix is given in the query string.", "schema": { "type": "string", - "description": "The pipeline id to preprocess incoming documents with." + "description": "The field to use as default where no field prefix is given in the query string." } }, { - "name": "require_alias", + "name": "lenient", "in": "query", - "description": "When true, requires destination to be an alias.", + "description": "Specify whether format-based query failures (such as providing text to a numeric field) should be ignored.", "schema": { "type": "boolean", - "default": false, - "description": "When true, requires destination to be an alias." + "description": "Specify whether format-based query failures (such as providing text to a numeric field) should be ignored." + } + }, + { + "name": "terminate_after", + "in": "query", + "description": "The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early.", + "schema": { + "type": "integer", + "description": "The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early.", + "format": "int32" } } ], "responses": { "200": { - "description": "Index_Post 200 response" + "description": "Count_Get_WithIndex 200 response" } }, - "x-operation-group": "index", + "x-operation-group": "count", "x-version-added": "1.0" - } - }, - "/{index}/_doc/{id}": { - "delete": { - "description": "Removes a document from the index.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest" + }, + "post": { + "description": "Returns number of documents matching a query.", + "operationId": "Count_Post_WithIndex", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Count_BodyParams" + } + } + } }, - "operationId": "Delete", "parameters": [ - { - "name": "id", - "in": "path", - "description": "Document ID.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", - "description": "Document ID." - }, - "required": true - }, { "name": "index", "in": "path", - "description": "Index name.", + "description": "Comma-separated list of indices to restrict the results.", "schema": { "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", - "description": "Index name." + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", + "description": "Comma-separated list of indices to restrict the results.", + "x-data-type": "array" }, "required": true }, { - "name": "wait_for_active_shards", + "name": "ignore_unavailable", "in": "query", - "description": "Sets the number of shard copies that must be active before proceeding with the operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1).", + "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", "schema": { - "type": "string", - "default": "1", - "description": "Sets the number of shard copies that must be active before proceeding with the operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1)." + "type": "boolean", + "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." } }, { - "name": "refresh", + "name": "ignore_throttled", "in": "query", - "description": "If `true` then refresh 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` (the default) then do nothing with refreshes.", + "description": "Whether specified concrete, expanded or aliased indices should be ignored when throttled.", "schema": { - "$ref": "#/components/schemas/RefreshEnum" + "type": "boolean", + "description": "Whether specified concrete, expanded or aliased indices should be ignored when throttled." } }, { - "name": "routing", + "name": "allow_no_indices", "in": "query", - "description": "Routing value.", + "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified).", "schema": { - "type": "string", - "description": "Routing value." + "type": "boolean", + "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)." } }, { - "name": "timeout", + "name": "expand_wildcards", "in": "query", - "description": "Operation timeout.", + "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout.", - "x-data-type": "time" + "$ref": "#/components/schemas/ExpandWildcards" } }, { - "name": "if_seq_no", + "name": "min_score", "in": "query", - "description": "only perform the operation if the last operation that has changed the document has the specified sequence number.", + "description": "Include only documents with a specific `_score` value in the result.", "schema": { "type": "integer", - "description": "only perform the operation if the last operation that has changed the document has the specified sequence number.", + "description": "Include only documents with a specific `_score` value in the result.", "format": "int32" } }, { - "name": "if_primary_term", + "name": "preference", "in": "query", - "description": "only perform the operation if the last operation that has changed the document has the specified primary term.", + "description": "Specify the node or shard the operation should be performed on.", "schema": { - "type": "integer", - "description": "only perform the operation if the last operation that has changed the document has the specified primary term.", - "format": "int32" + "type": "string", + "default": "random", + "description": "Specify the node or shard the operation should be performed on." } }, { - "name": "version", + "name": "routing", "in": "query", - "description": "Explicit version number for concurrency control.", + "description": "Comma-separated list of specific routing values.", + "style": "form", "schema": { - "type": "integer", - "description": "Explicit version number for concurrency control.", - "format": "int32" - } + "type": "array", + "items": { + "type": "string" + }, + "description": "Comma-separated list of specific routing values." + }, + "explode": true }, { - "name": "version_type", + "name": "q", "in": "query", - "description": "Specific version type.", - "schema": { - "$ref": "#/components/schemas/VersionType" - } - } - ], - "responses": { - "200": { - "description": "Delete 200 response" - } - }, - "x-operation-group": "delete", - "x-version-added": "1.0" - }, - "get": { - "description": "Returns a document.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/api-reference/document-apis/get-documents/" - }, - "operationId": "Get", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Document ID.", + "description": "Query in the Lucene query string syntax.", "schema": { "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", - "description": "Document ID." - }, - "required": true, - "examples": { - "Get_example1": { - "summary": "Examples for Get document doc Operation.", - "description": "", - "value": "1" - } + "description": "Query in the Lucene query string syntax." } }, { - "name": "index", - "in": "path", - "description": "Index name.", + "name": "analyzer", + "in": "query", + "description": "The analyzer to use for the query string.", "schema": { "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", - "description": "Index name." - }, - "required": true, - "examples": { - "Get_example1": { - "summary": "Examples for Get document doc Operation.", - "description": "", - "value": "books" - } + "description": "The analyzer to use for the query string." } }, { - "name": "stored_fields", + "name": "analyze_wildcard", "in": "query", - "description": "Comma-separated list of stored fields to return.", - "style": "form", + "description": "Specify whether wildcard and prefix queries should be analyzed.", "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of stored fields to return." - }, - "explode": true + "type": "boolean", + "default": false, + "description": "Specify whether wildcard and prefix queries should be analyzed." + } }, { - "name": "preference", + "name": "default_operator", "in": "query", - "description": "Specify the node or shard the operation should be performed on.", + "description": "The default operator for query string query (AND or OR).", + "schema": { + "$ref": "#/components/schemas/DefaultOperator" + } + }, + { + "name": "df", + "in": "query", + "description": "The field to use as default where no field prefix is given in the query string.", "schema": { "type": "string", - "default": "random", - "description": "Specify the node or shard the operation should be performed on." + "description": "The field to use as default where no field prefix is given in the query string." } }, { - "name": "realtime", + "name": "lenient", "in": "query", - "description": "Specify whether to perform the operation in realtime or search mode.", + "description": "Specify whether format-based query failures (such as providing text to a numeric field) should be ignored.", "schema": { "type": "boolean", - "description": "Specify whether to perform the operation in realtime or search mode." + "description": "Specify whether format-based query failures (such as providing text to a numeric field) should be ignored." } }, { - "name": "refresh", + "name": "terminate_after", "in": "query", - "description": "Refresh the shard containing the document before performing the operation.", + "description": "The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early.", "schema": { - "type": "boolean", - "description": "Refresh the shard containing the document before performing the operation." + "type": "integer", + "description": "The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early.", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "Count_Post_WithIndex 200 response" + } + }, + "x-operation-group": "count", + "x-version-added": "1.0" + } + }, + "/{index}/_create/{id}": { + "post": { + "description": "Creates a new document in the index.\n\nReturns a 409 response when a document with a same ID already exists in the index.", + "operationId": "Create_Post", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Create_BodyParams" + } } }, + "required": true + }, + "parameters": [ { - "name": "routing", + "name": "id", + "in": "path", + "description": "Document ID.", + "schema": { + "type": "string", + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", + "description": "Document ID." + }, + "required": true + }, + { + "name": "index", + "in": "path", + "description": "Index name.", + "schema": { + "type": "string", + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", + "description": "Index name." + }, + "required": true + }, + { + "name": "wait_for_active_shards", "in": "query", - "description": "Routing value.", + "description": "Sets the number of shard copies that must be active before proceeding with the operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1).", "schema": { "type": "string", - "description": "Routing value." + "default": "1", + "description": "Sets the number of shard copies that must be active before proceeding with the operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1)." } }, { - "name": "_source", + "name": "refresh", "in": "query", - "description": "True or false to return the _source field or not, or a list of fields to return.", - "style": "form", + "description": "If `true` then refresh 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` (the default) then do nothing with refreshes.", "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "True or false to return the _source field or not, or a list of fields to return." - }, - "explode": true + "$ref": "#/components/schemas/RefreshEnum" + } }, { - "name": "_source_excludes", + "name": "routing", "in": "query", - "description": "List of fields to exclude from the returned _source field.", - "style": "form", + "description": "Routing value.", "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "List of fields to exclude from the returned _source field." - }, - "explode": true + "type": "string", + "description": "Routing value." + } }, { - "name": "_source_includes", + "name": "timeout", "in": "query", - "description": "List of fields to extract and return from the _source field.", - "style": "form", + "description": "Operation timeout.", "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "List of fields to extract and return from the _source field." - }, - "explode": true + "type": "string", + "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", + "description": "Operation timeout.", + "x-data-type": "time" + } }, { "name": "version", @@ -21154,41 +21668,42 @@ "schema": { "$ref": "#/components/schemas/VersionType" } + }, + { + "name": "pipeline", + "in": "query", + "description": "The pipeline id to preprocess incoming documents with.", + "schema": { + "type": "string", + "description": "The pipeline id to preprocess incoming documents with." + } } ], "responses": { "200": { - "description": "Get 200 response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GetResponseContent" - }, - "examples": { - "Get_example1": { - "summary": "Examples for Get document doc Operation.", - "description": "", - "value": { - "_index": "books", - "_id": "1", - "found": true - } - } - } - } - } + "description": "Create_Post 200 response" } }, - "x-operation-group": "get", + "x-operation-group": "create", "x-version-added": "1.0" }, - "head": { - "description": "Returns information about whether a document exists in an index.", + "put": { + "description": "Creates a new document in the index.\n\nReturns a 409 response when a document with a same ID already exists in the index.", "externalDocs": { "description": "API Reference", - "url": "https://opensearch.org/docs/latest" + "url": "https://opensearch.org/docs/latest/api-reference/document-apis/index-document/" + }, + "operationId": "Create_Put", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Create_BodyParams" + } + } + }, + "required": true }, - "operationId": "Exists", "parameters": [ { "name": "id", @@ -21196,7 +21711,7 @@ "description": "Document ID.", "schema": { "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", "description": "Document ID." }, "required": true @@ -21207,108 +21722,53 @@ "description": "Index name.", "schema": { "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", "description": "Index name." }, "required": true }, { - "name": "stored_fields", - "in": "query", - "description": "Comma-separated list of stored fields to return.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of stored fields to return." - }, - "explode": true - }, - { - "name": "preference", + "name": "wait_for_active_shards", "in": "query", - "description": "Specify the node or shard the operation should be performed on.", + "description": "Sets the number of shard copies that must be active before proceeding with the operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1).", "schema": { "type": "string", - "default": "random", - "description": "Specify the node or shard the operation should be performed on." + "default": "1", + "description": "Sets the number of shard copies that must be active before proceeding with the operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1)." } }, { - "name": "realtime", + "name": "refresh", "in": "query", - "description": "Specify whether to perform the operation in realtime or search mode.", + "description": "If `true` then refresh 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` (the default) then do nothing with refreshes.", "schema": { - "type": "boolean", - "description": "Specify whether to perform the operation in realtime or search mode." + "$ref": "#/components/schemas/RefreshEnum" } }, { - "name": "refresh", + "name": "routing", "in": "query", - "description": "Refresh the shard containing the document before performing the operation.", + "description": "Routing value.", "schema": { - "type": "boolean", - "description": "Refresh the shard containing the document before performing the operation." + "type": "string", + "description": "Routing value." } }, { - "name": "routing", + "name": "timeout", "in": "query", - "description": "Routing value.", + "description": "Operation timeout.", "schema": { "type": "string", - "description": "Routing value." + "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", + "description": "Operation timeout.", + "x-data-type": "time" } }, { - "name": "_source", + "name": "version", "in": "query", - "description": "True or false to return the _source field or not, or a list of fields to return.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "True or false to return the _source field or not, or a list of fields to return." - }, - "explode": true - }, - { - "name": "_source_excludes", - "in": "query", - "description": "List of fields to exclude from the returned _source field.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "List of fields to exclude from the returned _source field." - }, - "explode": true - }, - { - "name": "_source_includes", - "in": "query", - "description": "List of fields to extract and return from the _source field.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "List of fields to extract and return from the _source field." - }, - "explode": true - }, - { - "name": "version", - "in": "query", - "description": "Explicit version number for concurrency control.", + "description": "Explicit version number for concurrency control.", "schema": { "type": "integer", "description": "Explicit version number for concurrency control.", @@ -21322,432 +21782,244 @@ "schema": { "$ref": "#/components/schemas/VersionType" } + }, + { + "name": "pipeline", + "in": "query", + "description": "The pipeline id to preprocess incoming documents with.", + "schema": { + "type": "string", + "description": "The pipeline id to preprocess incoming documents with." + } } ], "responses": { "200": { - "description": "Exists 200 response" + "description": "Create_Put 200 response" } }, - "x-operation-group": "exists", + "x-operation-group": "create", "x-version-added": "1.0" - }, + } + }, + "/{index}/_delete_by_query": { "post": { - "description": "Creates or updates a document in an index.", - "operationId": "Index_Post_WithId", + "description": "Deletes documents matching the provided query.", + "externalDocs": { + "description": "API Reference", + "url": "https://opensearch.org/docs/latest/api-reference/document-apis/delete-by-query/" + }, + "operationId": "DeleteByQuery", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Index_BodyParams" + "$ref": "#/components/schemas/DeleteByQuery_BodyParams" } } }, "required": true }, "parameters": [ - { - "name": "id", - "in": "path", - "description": "Document ID.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", - "description": "Document ID." - }, - "required": true - }, { "name": "index", "in": "path", - "description": "Index name.", + "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": "Index name." + "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 }, { - "name": "wait_for_active_shards", + "name": "analyzer", "in": "query", - "description": "Sets the number of shard copies that must be active before proceeding with the operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1).", + "description": "The analyzer to use for the query string.", "schema": { "type": "string", - "default": "1", - "description": "Sets the number of shard copies that must be active before proceeding with the operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1)." - } - }, - { - "name": "op_type", - "in": "query", - "description": "Explicit operation type. Defaults to `index` for requests with an explicit document ID, and to `create`for requests without an explicit document ID.", - "schema": { - "$ref": "#/components/schemas/OpType" + "description": "The analyzer to use for the query string." } }, { - "name": "refresh", + "name": "analyze_wildcard", "in": "query", - "description": "If `true` then refresh 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` (the default) then do nothing with refreshes.", + "description": "Specify whether wildcard and prefix queries should be analyzed.", "schema": { - "$ref": "#/components/schemas/RefreshEnum" + "type": "boolean", + "default": false, + "description": "Specify whether wildcard and prefix queries should be analyzed." } }, { - "name": "routing", + "name": "default_operator", "in": "query", - "description": "Routing value.", + "description": "The default operator for query string query (AND or OR).", "schema": { - "type": "string", - "description": "Routing value." + "$ref": "#/components/schemas/DefaultOperator" } }, { - "name": "timeout", + "name": "df", "in": "query", - "description": "Operation timeout.", + "description": "The field to use as default where no field prefix is given in the query string.", "schema": { "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout.", - "x-data-type": "time" + "description": "The field to use as default where no field prefix is given in the query string." } }, { - "name": "version", + "name": "from", "in": "query", - "description": "Explicit version number for concurrency control.", + "description": "Starting offset.", "schema": { "type": "integer", - "description": "Explicit version number for concurrency control.", + "default": 0, + "description": "Starting offset.", "format": "int32" } }, { - "name": "version_type", + "name": "ignore_unavailable", "in": "query", - "description": "Specific version type.", + "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", "schema": { - "$ref": "#/components/schemas/VersionType" + "type": "boolean", + "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." } }, { - "name": "if_seq_no", + "name": "allow_no_indices", "in": "query", - "description": "only perform the operation if the last operation that has changed the document has the specified sequence number.", + "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified).", "schema": { - "type": "integer", - "description": "only perform the operation if the last operation that has changed the document has the specified sequence number.", - "format": "int32" + "type": "boolean", + "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)." } }, { - "name": "if_primary_term", + "name": "conflicts", "in": "query", - "description": "only perform the operation if the last operation that has changed the document has the specified primary term.", + "description": "What to do when the operation encounters version conflicts?.", "schema": { - "type": "integer", - "description": "only perform the operation if the last operation that has changed the document has the specified primary term.", - "format": "int32" + "$ref": "#/components/schemas/Conflicts" } }, { - "name": "pipeline", + "name": "expand_wildcards", "in": "query", - "description": "The pipeline id to preprocess incoming documents with.", + "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", "schema": { - "type": "string", - "description": "The pipeline id to preprocess incoming documents with." + "$ref": "#/components/schemas/ExpandWildcards" } }, { - "name": "require_alias", + "name": "lenient", "in": "query", - "description": "When true, requires destination to be an alias.", + "description": "Specify whether format-based query failures (such as providing text to a numeric field) should be ignored.", "schema": { "type": "boolean", - "default": false, - "description": "When true, requires destination to be an alias." - } - } - ], - "responses": { - "200": { - "description": "Index_Post_WithId 200 response" - } - }, - "x-operation-group": "index", - "x-version-added": "1.0" - }, - "put": { - "description": "Creates or updates a document in an index.", - "operationId": "Index_Put_WithId", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Index_BodyParams" - } + "description": "Specify whether format-based query failures (such as providing text to a numeric field) should be ignored." } }, - "required": true - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Document ID.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", - "description": "Document ID." - }, - "required": true - }, { - "name": "index", - "in": "path", - "description": "Index name.", + "name": "preference", + "in": "query", + "description": "Specify the node or shard the operation should be performed on.", "schema": { "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", - "description": "Index name." - }, - "required": true + "default": "random", + "description": "Specify the node or shard the operation should be performed on." + } }, { - "name": "wait_for_active_shards", + "name": "q", "in": "query", - "description": "Sets the number of shard copies that must be active before proceeding with the operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1).", + "description": "Query in the Lucene query string syntax.", "schema": { "type": "string", - "default": "1", - "description": "Sets the number of shard copies that must be active before proceeding with the operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1)." + "description": "Query in the Lucene query string syntax." } }, { - "name": "op_type", + "name": "routing", "in": "query", - "description": "Explicit operation type. Defaults to `index` for requests with an explicit document ID, and to `create`for requests without an explicit document ID.", + "description": "Comma-separated list of specific routing values.", + "style": "form", "schema": { - "$ref": "#/components/schemas/OpType" - } + "type": "array", + "items": { + "type": "string" + }, + "description": "Comma-separated list of specific routing values." + }, + "explode": true }, { - "name": "refresh", + "name": "scroll", "in": "query", - "description": "If `true` then refresh 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` (the default) then do nothing with refreshes.", + "description": "Specify how long a consistent view of the index should be maintained for scrolled search.", "schema": { - "$ref": "#/components/schemas/RefreshEnum" + "type": "string", + "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", + "description": "Specify how long a consistent view of the index should be maintained for scrolled search.", + "x-data-type": "time" } }, { - "name": "routing", + "name": "search_type", "in": "query", - "description": "Routing value.", + "description": "Search operation type.", "schema": { - "type": "string", - "description": "Routing value." + "$ref": "#/components/schemas/SearchType" } }, { - "name": "timeout", + "name": "search_timeout", "in": "query", - "description": "Operation timeout.", + "description": "Explicit timeout for each search request. Defaults to no timeout.", "schema": { "type": "string", "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout.", + "description": "Explicit timeout for each search request. Defaults to no timeout.", "x-data-type": "time" } }, { - "name": "version", + "name": "size", "in": "query", - "description": "Explicit version number for concurrency control.", - "schema": { - "type": "integer", - "description": "Explicit version number for concurrency control.", - "format": "int32" - } - }, - { - "name": "version_type", - "in": "query", - "description": "Specific version type.", - "schema": { - "$ref": "#/components/schemas/VersionType" - } - }, - { - "name": "if_seq_no", - "in": "query", - "description": "only perform the operation if the last operation that has changed the document has the specified sequence number.", + "description": "Deprecated, please use `max_docs` instead.", "schema": { "type": "integer", - "description": "only perform the operation if the last operation that has changed the document has the specified sequence number.", + "description": "Deprecated, please use `max_docs` instead.", "format": "int32" } }, { - "name": "if_primary_term", + "name": "max_docs", "in": "query", - "description": "only perform the operation if the last operation that has changed the document has the specified primary term.", + "description": "Maximum number of documents to process (default: all documents).", "schema": { "type": "integer", - "description": "only perform the operation if the last operation that has changed the document has the specified primary term.", + "description": "Maximum number of documents to process (default: all documents).", "format": "int32" } }, { - "name": "pipeline", - "in": "query", - "description": "The pipeline id to preprocess incoming documents with.", - "schema": { - "type": "string", - "description": "The pipeline id to preprocess incoming documents with." - } - }, - { - "name": "require_alias", - "in": "query", - "description": "When true, requires destination to be an alias.", - "schema": { - "type": "boolean", - "default": false, - "description": "When true, requires destination to be an alias." - } - } - ], - "responses": { - "200": { - "description": "Index_Put_WithId 200 response" - } - }, - "x-operation-group": "index", - "x-version-added": "1.0" - } - }, - "/{index}/_explain/{id}": { - "get": { - "description": "Returns information about why a specific matches (or doesn't match) a query.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest" - }, - "operationId": "Explain_Get", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Document ID.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", - "description": "Document ID." - }, - "required": true - }, - { - "name": "index", - "in": "path", - "description": "Index name.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", - "description": "Index name." - }, - "required": true - }, - { - "name": "analyze_wildcard", - "in": "query", - "description": "Specify whether wildcards and prefix queries in the query string query should be analyzed.", - "schema": { - "type": "boolean", - "default": false, - "description": "Specify whether wildcards and prefix queries in the query string query should be analyzed." - } - }, - { - "name": "analyzer", - "in": "query", - "description": "The analyzer to use for the query string.", - "schema": { - "type": "string", - "description": "The analyzer to use for the query string." - } - }, - { - "name": "default_operator", - "in": "query", - "description": "The default operator for query string query (AND or OR).", - "schema": { - "$ref": "#/components/schemas/DefaultOperator" - } - }, - { - "name": "df", - "in": "query", - "description": "The default field for query string query.", - "schema": { - "type": "string", - "default": "_all", - "description": "The default field for query string query." - } - }, - { - "name": "stored_fields", + "name": "sort", "in": "query", - "description": "Comma-separated list of stored fields to return.", + "description": "Comma-separated list of : pairs.", "style": "form", "schema": { "type": "array", "items": { "type": "string" }, - "description": "Comma-separated list of stored fields to return." + "description": "Comma-separated list of : pairs." }, "explode": true }, - { - "name": "lenient", - "in": "query", - "description": "Specify whether format-based query failures (such as providing text to a numeric field) should be ignored.", - "schema": { - "type": "boolean", - "description": "Specify whether format-based query failures (such as providing text to a numeric field) should be ignored." - } - }, - { - "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." - } - }, - { - "name": "q", - "in": "query", - "description": "Query in the Lucene query string syntax.", - "schema": { - "type": "string", - "description": "Query in the Lucene query string syntax." - } - }, - { - "name": "routing", - "in": "query", - "description": "Routing value.", - "schema": { - "type": "string", - "description": "Routing value." - } - }, { "name": "_source", "in": "query", @@ -21789,674 +22061,731 @@ "description": "List of fields to extract and return from the _source field." }, "explode": true - } - ], - "responses": { - "200": { - "description": "Explain_Get 200 response" - } - }, - "x-operation-group": "explain", - "x-version-added": "1.0" - }, - "post": { - "description": "Returns information about why a specific matches (or doesn't match) a query.", - "operationId": "Explain_Post", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Explain_BodyParams" - } - } - } - }, - "parameters": [ + }, { - "name": "id", - "in": "path", - "description": "Document ID.", + "name": "terminate_after", + "in": "query", + "description": "The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early.", "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", - "description": "Document ID." - }, - "required": true + "type": "integer", + "description": "The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early.", + "format": "int32" + } }, { - "name": "index", - "in": "path", - "description": "Index name.", + "name": "stats", + "in": "query", + "description": "Specific 'tag' of the request for logging and statistical purposes.", + "style": "form", "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", - "description": "Index name." + "type": "array", + "items": { + "type": "string" + }, + "description": "Specific 'tag' of the request for logging and statistical purposes." }, - "required": true + "explode": true }, { - "name": "analyze_wildcard", + "name": "version", "in": "query", - "description": "Specify whether wildcards and prefix queries in the query string query should be analyzed.", + "description": "Whether to return document version as part of a hit.", "schema": { "type": "boolean", - "default": false, - "description": "Specify whether wildcards and prefix queries in the query string query should be analyzed." + "description": "Whether to return document version as part of a hit." } }, { - "name": "analyzer", + "name": "request_cache", "in": "query", - "description": "The analyzer to use for the query string.", + "description": "Specify if request cache should be used for this request or not, defaults to index level setting.", "schema": { - "type": "string", - "description": "The analyzer to use for the query string." + "type": "boolean", + "description": "Specify if request cache should be used for this request or not, defaults to index level setting." } }, { - "name": "default_operator", + "name": "refresh", "in": "query", - "description": "The default operator for query string query (AND or OR).", + "description": "Refresh the shard containing the document before performing the operation.", "schema": { - "$ref": "#/components/schemas/DefaultOperator" + "type": "boolean", + "description": "Refresh the shard containing the document before performing the operation." } }, { - "name": "df", + "name": "timeout", "in": "query", - "description": "The default field for query string query.", + "description": "Time each individual bulk request should wait for shards that are unavailable.", "schema": { "type": "string", - "default": "_all", - "description": "The default field for query string query." + "default": "1m", + "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", + "description": "Time each individual bulk request should wait for shards that are unavailable.", + "x-data-type": "time" } }, { - "name": "stored_fields", + "name": "wait_for_active_shards", "in": "query", - "description": "Comma-separated list of stored fields to return.", - "style": "form", + "description": "Sets the number of shard copies that must be active before proceeding with the operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1).", "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of stored fields to return." - }, - "explode": true + "type": "string", + "default": "1", + "description": "Sets the number of shard copies that must be active before proceeding with the operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1)." + } }, { - "name": "lenient", + "name": "scroll_size", "in": "query", - "description": "Specify whether format-based query failures (such as providing text to a numeric field) should be ignored.", + "description": "Size on the scroll request powering the operation.", "schema": { - "type": "boolean", - "description": "Specify whether format-based query failures (such as providing text to a numeric field) should be ignored." + "type": "integer", + "default": 100, + "description": "Size on the scroll request powering the operation.", + "format": "int32" } }, { - "name": "preference", + "name": "wait_for_completion", "in": "query", - "description": "Specify the node or shard the operation should be performed on.", + "description": "Should this request wait until the operation has completed before returning.", "schema": { - "type": "string", - "default": "random", - "description": "Specify the node or shard the operation should be performed on." + "type": "boolean", + "default": true, + "description": "Should this request wait until the operation has completed before returning." } }, { - "name": "q", + "name": "requests_per_second", "in": "query", - "description": "Query in the Lucene query string syntax.", + "description": "The throttle for this request in sub-requests per second. -1 means no throttle.", "schema": { - "type": "string", - "description": "Query in the Lucene query string syntax." + "type": "integer", + "default": 0, + "description": "The throttle for this request in sub-requests per second. -1 means no throttle.", + "format": "int32" } }, { - "name": "routing", + "name": "slices", "in": "query", - "description": "Routing value.", + "description": "The number of slices this task should be divided into. Defaults to 1, meaning the task isn't sliced into subtasks. Can be set to `auto`.", "schema": { "type": "string", - "description": "Routing value." + "default": "1", + "description": "The number of slices this task should be divided into. Defaults to 1, meaning the task isn't sliced into subtasks. Can be set to `auto`." } - }, - { - "name": "_source", - "in": "query", - "description": "True or false to return the _source field or not, or a list of fields to return.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "True or false to return the _source field or not, or a list of fields to return." - }, - "explode": true - }, - { - "name": "_source_excludes", - "in": "query", - "description": "List of fields to exclude from the returned _source field.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "List of fields to exclude from the returned _source field." - }, - "explode": true - }, - { - "name": "_source_includes", - "in": "query", - "description": "List of fields to extract and return from the _source field.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "List of fields to extract and return from the _source field." - }, - "explode": true } ], "responses": { "200": { - "description": "Explain_Post 200 response" + "description": "DeleteByQuery 200 response" } }, - "x-operation-group": "explain", + "x-operation-group": "delete_by_query", "x-version-added": "1.0" } }, - "/{index}/_field_caps": { - "get": { - "description": "Returns the information about the capabilities of fields among multiple indices.", - "operationId": "FieldCaps_Get_WithIndex", + "/{index}/_doc": { + "post": { + "description": "Creates or updates a document in an index.", + "externalDocs": { + "description": "API Reference", + "url": "https://opensearch.org/docs/latest/api-reference/document-apis/index-document/" + }, + "operationId": "Index_Post", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Index_BodyParams" + } + } + }, + "required": true + }, "parameters": [ { "name": "index", "in": "path", - "description": "Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices.", + "description": "Index name.", "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" + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", + "description": "Index name." }, "required": true }, { - "name": "fields", + "name": "wait_for_active_shards", "in": "query", - "description": "Comma-separated list of field names.", - "style": "form", + "description": "Sets the number of shard copies that must be active before proceeding with the operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1).", "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of field names." - }, - "explode": true + "type": "string", + "default": "1", + "description": "Sets the number of shard copies that must be active before proceeding with the operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1)." + } }, { - "name": "ignore_unavailable", + "name": "op_type", "in": "query", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", + "description": "Explicit operation type. Defaults to `index` for requests with an explicit document ID, and to `create`for requests without an explicit document ID.", "schema": { - "type": "boolean", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." + "$ref": "#/components/schemas/OpType" } }, { - "name": "allow_no_indices", + "name": "refresh", "in": "query", - "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified).", + "description": "If `true` then refresh 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` (the default) then do nothing with refreshes.", "schema": { - "type": "boolean", - "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)." + "$ref": "#/components/schemas/RefreshEnum" } }, { - "name": "expand_wildcards", + "name": "routing", "in": "query", - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", + "description": "Routing value.", "schema": { - "$ref": "#/components/schemas/ExpandWildcards" + "type": "string", + "description": "Routing value." } }, { - "name": "include_unmapped", + "name": "timeout", "in": "query", - "description": "Indicates whether unmapped fields should be included in the response.", + "description": "Operation timeout.", "schema": { - "type": "boolean", - "default": false, - "description": "Indicates whether unmapped fields should be included in the response." - } - } - ], - "responses": { - "200": { - "description": "FieldCaps_Get_WithIndex 200 response" - } - }, - "x-operation-group": "field_caps", - "x-version-added": "1.0" - }, - "post": { - "description": "Returns the information about the capabilities of fields among multiple indices.", - "operationId": "FieldCaps_Post_WithIndex", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FieldCaps_BodyParams" - } + "type": "string", + "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", + "description": "Operation timeout.", + "x-data-type": "time" } - } - }, - "parameters": [ + }, { - "name": "index", - "in": "path", - "description": "Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices.", + "name": "version", + "in": "query", + "description": "Explicit version number for concurrency control.", "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 + "type": "integer", + "description": "Explicit version number for concurrency control.", + "format": "int32" + } }, { - "name": "fields", + "name": "version_type", "in": "query", - "description": "Comma-separated list of field names.", - "style": "form", + "description": "Specific version type.", "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of field names." - }, - "explode": true + "$ref": "#/components/schemas/VersionType" + } }, { - "name": "ignore_unavailable", + "name": "if_seq_no", "in": "query", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", + "description": "only perform the operation if the last operation that has changed the document has the specified sequence number.", "schema": { - "type": "boolean", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." + "type": "integer", + "description": "only perform the operation if the last operation that has changed the document has the specified sequence number.", + "format": "int32" } }, { - "name": "allow_no_indices", + "name": "if_primary_term", "in": "query", - "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified).", + "description": "only perform the operation if the last operation that has changed the document has the specified primary term.", "schema": { - "type": "boolean", - "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)." + "type": "integer", + "description": "only perform the operation if the last operation that has changed the document has the specified primary term.", + "format": "int32" } }, { - "name": "expand_wildcards", + "name": "pipeline", "in": "query", - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", + "description": "The pipeline id to preprocess incoming documents with.", "schema": { - "$ref": "#/components/schemas/ExpandWildcards" + "type": "string", + "description": "The pipeline id to preprocess incoming documents with." } }, { - "name": "include_unmapped", + "name": "require_alias", "in": "query", - "description": "Indicates whether unmapped fields should be included in the response.", + "description": "When true, requires destination to be an alias.", "schema": { "type": "boolean", "default": false, - "description": "Indicates whether unmapped fields should be included in the response." + "description": "When true, requires destination to be an alias." } } ], "responses": { "200": { - "description": "FieldCaps_Post_WithIndex 200 response" + "description": "Index_Post 200 response" } }, - "x-operation-group": "field_caps", + "x-operation-group": "index", "x-version-added": "1.0" } }, - "/{index}/_flush": { - "get": { - "description": "Performs the flush operation on one or more indices.", - "operationId": "IndicesFlush_Get_WithIndex", + "/{index}/_doc/{id}": { + "delete": { + "description": "Removes a document from the index.", + "externalDocs": { + "description": "API Reference", + "url": "https://opensearch.org/docs/latest/api-reference/document-apis/delete-document/" + }, + "operationId": "Delete", "parameters": [ { - "name": "index", + "name": "id", "in": "path", - "description": "Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices.", + "description": "Document ID.", "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" + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", + "description": "Document ID." }, "required": true }, { - "name": "force", - "in": "query", - "description": "Whether a flush should be forced even if it is not necessarily needed ie. if no changes will be committed to the index. This is useful if transaction log IDs should be incremented even if no uncommitted changes are present. (This setting can be considered as internal).", + "name": "index", + "in": "path", + "description": "Index name.", "schema": { - "type": "boolean", - "description": "Whether a flush should be forced even if it is not necessarily needed ie. if no changes will be committed to the index. This is useful if transaction log IDs should be incremented even if no uncommitted changes are present. (This setting can be considered as internal)." - } + "type": "string", + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", + "description": "Index name." + }, + "required": true }, { - "name": "wait_if_ongoing", + "name": "wait_for_active_shards", "in": "query", - "description": "If set to true the flush operation will block until the flush can be executed if another flush operation is already executing. If set to false the flush will be skipped iff if another flush operation is already running.", + "description": "Sets the number of shard copies that must be active before proceeding with the operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1).", "schema": { - "type": "boolean", - "default": true, - "description": "If set to true the flush operation will block until the flush can be executed if another flush operation is already executing. If set to false the flush will be skipped iff if another flush operation is already running." + "type": "string", + "default": "1", + "description": "Sets the number of shard copies that must be active before proceeding with the operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1)." } }, { - "name": "ignore_unavailable", + "name": "refresh", "in": "query", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", + "description": "If `true` then refresh 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` (the default) then do nothing with refreshes.", "schema": { - "type": "boolean", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." + "$ref": "#/components/schemas/RefreshEnum" } }, { - "name": "allow_no_indices", + "name": "routing", "in": "query", - "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified).", + "description": "Routing value.", "schema": { - "type": "boolean", - "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)." + "type": "string", + "description": "Routing value." } }, { - "name": "expand_wildcards", + "name": "timeout", "in": "query", - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", - "schema": { - "$ref": "#/components/schemas/ExpandWildcards" - } - } - ], - "responses": { - "200": { - "description": "IndicesFlush_Get_WithIndex 200 response" - } - }, - "x-operation-group": "indices.flush", - "x-version-added": "1.0" - }, - "post": { - "description": "Performs the flush operation on one or more indices.", - "operationId": "IndicesFlush_Post_WithIndex", - "parameters": [ - { - "name": "index", - "in": "path", - "description": "Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices.", + "description": "Operation timeout.", "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 - }, - { - "name": "force", - "in": "query", - "description": "Whether a flush should be forced even if it is not necessarily needed ie. if no changes will be committed to the index. This is useful if transaction log IDs should be incremented even if no uncommitted changes are present. (This setting can be considered as internal).", - "schema": { - "type": "boolean", - "description": "Whether a flush should be forced even if it is not necessarily needed ie. if no changes will be committed to the index. This is useful if transaction log IDs should be incremented even if no uncommitted changes are present. (This setting can be considered as internal)." + "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", + "description": "Operation timeout.", + "x-data-type": "time" } }, { - "name": "wait_if_ongoing", + "name": "if_seq_no", "in": "query", - "description": "If set to true the flush operation will block until the flush can be executed if another flush operation is already executing. If set to false the flush will be skipped iff if another flush operation is already running.", + "description": "only perform the operation if the last operation that has changed the document has the specified sequence number.", "schema": { - "type": "boolean", - "default": true, - "description": "If set to true the flush operation will block until the flush can be executed if another flush operation is already executing. If set to false the flush will be skipped iff if another flush operation is already running." + "type": "integer", + "description": "only perform the operation if the last operation that has changed the document has the specified sequence number.", + "format": "int32" } }, { - "name": "ignore_unavailable", + "name": "if_primary_term", "in": "query", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", + "description": "only perform the operation if the last operation that has changed the document has the specified primary term.", "schema": { - "type": "boolean", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." + "type": "integer", + "description": "only perform the operation if the last operation that has changed the document has the specified primary term.", + "format": "int32" } }, { - "name": "allow_no_indices", + "name": "version", "in": "query", - "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified).", + "description": "Explicit version number for concurrency control.", "schema": { - "type": "boolean", - "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)." + "type": "integer", + "description": "Explicit version number for concurrency control.", + "format": "int32" } }, { - "name": "expand_wildcards", + "name": "version_type", "in": "query", - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", + "description": "Specific version type.", "schema": { - "$ref": "#/components/schemas/ExpandWildcards" + "$ref": "#/components/schemas/VersionType" } } ], "responses": { "200": { - "description": "IndicesFlush_Post_WithIndex 200 response" + "description": "Delete 200 response" } }, - "x-operation-group": "indices.flush", + "x-operation-group": "delete", "x-version-added": "1.0" - } - }, - "/{index}/_forcemerge": { - "post": { - "description": "Performs the force merge operation on one or more indices.", - "operationId": "IndicesForcemerge_WithIndex", + }, + "get": { + "description": "Returns a document.", + "externalDocs": { + "description": "API Reference", + "url": "https://opensearch.org/docs/latest/api-reference/document-apis/get-documents/" + }, + "operationId": "Get", "parameters": [ + { + "name": "id", + "in": "path", + "description": "Document ID.", + "schema": { + "type": "string", + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", + "description": "Document ID." + }, + "required": true, + "examples": { + "Get_example1": { + "summary": "Examples for Get document doc Operation.", + "description": "", + "value": "1" + } + } + }, { "name": "index", "in": "path", - "description": "Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices.", + "description": "Index name.", "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" + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", + "description": "Index name." }, - "required": true + "required": true, + "examples": { + "Get_example1": { + "summary": "Examples for Get document doc Operation.", + "description": "", + "value": "books" + } + } }, { - "name": "flush", + "name": "stored_fields", "in": "query", - "description": "Specify whether the index should be flushed after performing the operation.", + "description": "Comma-separated list of stored fields to return.", + "style": "form", "schema": { - "type": "boolean", - "default": true, - "description": "Specify whether the index should be flushed after performing the operation." + "type": "array", + "items": { + "type": "string" + }, + "description": "Comma-separated list of stored fields to return." + }, + "explode": true + }, + { + "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." } }, { - "name": "ignore_unavailable", + "name": "realtime", "in": "query", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", + "description": "Specify whether to perform the operation in realtime or search mode.", "schema": { "type": "boolean", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." + "description": "Specify whether to perform the operation in realtime or search mode." } }, { - "name": "allow_no_indices", + "name": "refresh", "in": "query", - "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified).", + "description": "Refresh the shard containing the document before performing the operation.", "schema": { "type": "boolean", - "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)." + "description": "Refresh the shard containing the document before performing the operation." } }, { - "name": "expand_wildcards", + "name": "routing", "in": "query", - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", + "description": "Routing value.", "schema": { - "$ref": "#/components/schemas/ExpandWildcards" + "type": "string", + "description": "Routing value." } }, { - "name": "max_num_segments", + "name": "_source", "in": "query", - "description": "The number of segments the index should be merged into (default: dynamic).", + "description": "True or false to return the _source field or not, or a list of fields to return.", + "style": "form", "schema": { - "type": "integer", - "description": "The number of segments the index should be merged into (default: dynamic).", - "format": "int32" - } + "type": "array", + "items": { + "type": "string" + }, + "description": "True or false to return the _source field or not, or a list of fields to return." + }, + "explode": true }, { - "name": "only_expunge_deletes", + "name": "_source_excludes", "in": "query", - "description": "Specify whether the operation should only expunge deleted documents.", + "description": "List of fields to exclude from the returned _source field.", + "style": "form", "schema": { - "type": "boolean", - "description": "Specify whether the operation should only expunge deleted documents." - } - } - ], - "responses": { - "200": { - "description": "IndicesForcemerge_WithIndex 200 response" - } - }, - "x-operation-group": "indices.forcemerge", - "x-version-added": "1.0" - } - }, - "/{index}/_mapping": { - "get": { - "description": "Returns mappings for one or more indices.", - "operationId": "IndicesGetMapping_WithIndex", + "type": "array", + "items": { + "type": "string" + }, + "description": "List of fields to exclude from the returned _source field." + }, + "explode": true + }, + { + "name": "_source_includes", + "in": "query", + "description": "List of fields to extract and return from the _source field.", + "style": "form", + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of fields to extract and return from the _source field." + }, + "explode": true + }, + { + "name": "version", + "in": "query", + "description": "Explicit version number for concurrency control.", + "schema": { + "type": "integer", + "description": "Explicit version number for concurrency control.", + "format": "int32" + } + }, + { + "name": "version_type", + "in": "query", + "description": "Specific version type.", + "schema": { + "$ref": "#/components/schemas/VersionType" + } + } + ], + "responses": { + "200": { + "description": "Get 200 response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GetResponseContent" + }, + "examples": { + "Get_example1": { + "summary": "Examples for Get document doc Operation.", + "description": "", + "value": { + "_index": "books", + "_id": "1", + "found": true + } + } + } + } + } + } + }, + "x-operation-group": "get", + "x-version-added": "1.0" + }, + "head": { + "description": "Returns information about whether a document exists in an index.", + "externalDocs": { + "description": "API Reference", + "url": "https://opensearch.org/docs/latest/api-reference/document-apis/get-documents/" + }, + "operationId": "Exists", "parameters": [ + { + "name": "id", + "in": "path", + "description": "Document ID.", + "schema": { + "type": "string", + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", + "description": "Document ID." + }, + "required": true + }, { "name": "index", "in": "path", - "description": "Comma-separated list of indices.", + "description": "Index name.", "schema": { "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", - "description": "Comma-separated list of indices.", - "x-data-type": "array" + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", + "description": "Index name." }, "required": true }, { - "name": "ignore_unavailable", + "name": "stored_fields", "in": "query", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", + "description": "Comma-separated list of stored fields to return.", + "style": "form", "schema": { - "type": "boolean", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." + "type": "array", + "items": { + "type": "string" + }, + "description": "Comma-separated list of stored fields to return." + }, + "explode": true + }, + { + "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." } }, { - "name": "allow_no_indices", + "name": "realtime", "in": "query", - "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified).", + "description": "Specify whether to perform the operation in realtime or search mode.", "schema": { "type": "boolean", - "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)." + "description": "Specify whether to perform the operation in realtime or search mode." } }, { - "name": "expand_wildcards", + "name": "refresh", "in": "query", - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", + "description": "Refresh the shard containing the document before performing the operation.", "schema": { - "$ref": "#/components/schemas/ExpandWildcards" + "type": "boolean", + "description": "Refresh the shard containing the document before performing the operation." } }, { - "name": "master_timeout", + "name": "routing", "in": "query", - "description": "Operation timeout for connection to master node.", + "description": "Routing value.", "schema": { "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to master node.", - "x-version-deprecated": "2.0.0", - "x-data-type": "time", - "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", - "deprecated": true + "description": "Routing value." } }, { - "name": "cluster_manager_timeout", + "name": "_source", "in": "query", - "description": "Operation timeout for connection to cluster-manager node.", + "description": "True or false to return the _source field or not, or a list of fields to return.", + "style": "form", "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to cluster-manager node.", - "x-data-type": "time" + "type": "array", + "items": { + "type": "string" + }, + "description": "True or false to return the _source field or not, or a list of fields to return." + }, + "explode": true + }, + { + "name": "_source_excludes", + "in": "query", + "description": "List of fields to exclude from the returned _source field.", + "style": "form", + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of fields to exclude from the returned _source field." + }, + "explode": true + }, + { + "name": "_source_includes", + "in": "query", + "description": "List of fields to extract and return from the _source field.", + "style": "form", + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of fields to extract and return from the _source field." + }, + "explode": true + }, + { + "name": "version", + "in": "query", + "description": "Explicit version number for concurrency control.", + "schema": { + "type": "integer", + "description": "Explicit version number for concurrency control.", + "format": "int32" } }, { - "name": "local", + "name": "version_type", "in": "query", - "description": "Return local information, do not retrieve the state from cluster-manager node.", + "description": "Specific version type.", "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 is a no-op and field mappings are always retrieved locally.", - "deprecated": true + "$ref": "#/components/schemas/VersionType" } } ], "responses": { "200": { - "description": "IndicesGetMapping_WithIndex 200 response" + "description": "Exists 200 response" } }, - "x-operation-group": "indices.get_mapping", + "x-operation-group": "exists", "x-version-added": "1.0" }, "post": { - "description": "Updates the index mappings.", - "operationId": "IndicesPutMapping_Post", + "description": "Creates or updates a document in an index.", + "operationId": "Index_Post_WithId", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/IndicesPutMapping_BodyParams" + "$ref": "#/components/schemas/Index_BodyParams" } } }, @@ -22464,135 +22793,210 @@ }, "parameters": [ { - "name": "index", + "name": "id", "in": "path", - "description": "Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices.", + "description": "Document ID.", "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" + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", + "description": "Document ID." }, "required": true }, { - "name": "timeout", - "in": "query", - "description": "Operation timeout.", + "name": "index", + "in": "path", + "description": "Index name.", "schema": { "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout.", - "x-data-type": "time" - } + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", + "description": "Index name." + }, + "required": true }, { - "name": "master_timeout", + "name": "wait_for_active_shards", "in": "query", - "description": "Operation timeout for connection to master node.", + "description": "Sets the number of shard copies that must be active before proceeding with the operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1).", "schema": { "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to master node.", - "x-version-deprecated": "2.0.0", - "x-data-type": "time", - "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", - "deprecated": true + "default": "1", + "description": "Sets the number of shard copies that must be active before proceeding with the operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1)." } }, { - "name": "cluster_manager_timeout", + "name": "op_type", "in": "query", - "description": "Operation timeout for connection to cluster-manager node.", + "description": "Explicit operation type. Defaults to `index` for requests with an explicit document ID, and to `create`for requests without an explicit document ID.", "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to cluster-manager node.", - "x-data-type": "time" + "$ref": "#/components/schemas/OpType" } }, { - "name": "ignore_unavailable", + "name": "refresh", "in": "query", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", + "description": "If `true` then refresh 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` (the default) then do nothing with refreshes.", "schema": { - "type": "boolean", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." + "$ref": "#/components/schemas/RefreshEnum" } }, { - "name": "allow_no_indices", + "name": "routing", "in": "query", - "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified).", + "description": "Routing value.", "schema": { - "type": "boolean", - "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)." + "type": "string", + "description": "Routing value." } }, { - "name": "expand_wildcards", + "name": "timeout", "in": "query", - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", + "description": "Operation timeout.", "schema": { - "$ref": "#/components/schemas/ExpandWildcards" + "type": "string", + "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", + "description": "Operation timeout.", + "x-data-type": "time" } }, { - "name": "write_index_only", + "name": "version", "in": "query", - "description": "When true, applies mappings only to the write index of an alias or data stream.", + "description": "Explicit version number for concurrency control.", + "schema": { + "type": "integer", + "description": "Explicit version number for concurrency control.", + "format": "int32" + } + }, + { + "name": "version_type", + "in": "query", + "description": "Specific version type.", + "schema": { + "$ref": "#/components/schemas/VersionType" + } + }, + { + "name": "if_seq_no", + "in": "query", + "description": "only perform the operation if the last operation that has changed the document has the specified sequence number.", + "schema": { + "type": "integer", + "description": "only perform the operation if the last operation that has changed the document has the specified sequence number.", + "format": "int32" + } + }, + { + "name": "if_primary_term", + "in": "query", + "description": "only perform the operation if the last operation that has changed the document has the specified primary term.", + "schema": { + "type": "integer", + "description": "only perform the operation if the last operation that has changed the document has the specified primary term.", + "format": "int32" + } + }, + { + "name": "pipeline", + "in": "query", + "description": "The pipeline id to preprocess incoming documents with.", + "schema": { + "type": "string", + "description": "The pipeline id to preprocess incoming documents with." + } + }, + { + "name": "require_alias", + "in": "query", + "description": "When true, requires destination to be an alias.", "schema": { "type": "boolean", "default": false, - "description": "When true, applies mappings only to the write index of an alias or data stream." + "description": "When true, requires destination to be an alias." } } ], "responses": { "200": { - "description": "IndicesPutMapping_Post 200 response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IndicesPutMapping_PostResponseContent" - } - } - } + "description": "Index_Post_WithId 200 response" } }, - "x-operation-group": "indices.put_mapping", + "x-operation-group": "index", "x-version-added": "1.0" }, "put": { - "description": "Updates the index mappings.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/api-reference/index-apis/put-mapping/" - }, - "operationId": "IndicesPutMapping_Put", + "description": "Creates or updates a document in an index.", + "operationId": "Index_Put_WithId", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/IndicesPutMapping_BodyParams" + "$ref": "#/components/schemas/Index_BodyParams" } } }, "required": true }, "parameters": [ + { + "name": "id", + "in": "path", + "description": "Document ID.", + "schema": { + "type": "string", + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", + "description": "Document ID." + }, + "required": true + }, { "name": "index", "in": "path", - "description": "Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices.", + "description": "Index name.", "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" + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", + "description": "Index name." }, "required": true }, + { + "name": "wait_for_active_shards", + "in": "query", + "description": "Sets the number of shard copies that must be active before proceeding with the operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1).", + "schema": { + "type": "string", + "default": "1", + "description": "Sets the number of shard copies that must be active before proceeding with the operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1)." + } + }, + { + "name": "op_type", + "in": "query", + "description": "Explicit operation type. Defaults to `index` for requests with an explicit document ID, and to `create`for requests without an explicit document ID.", + "schema": { + "$ref": "#/components/schemas/OpType" + } + }, + { + "name": "refresh", + "in": "query", + "description": "If `true` then refresh 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` (the default) then do nothing with refreshes.", + "schema": { + "$ref": "#/components/schemas/RefreshEnum" + } + }, + { + "name": "routing", + "in": "query", + "description": "Routing value.", + "schema": { + "type": "string", + "description": "Routing value." + } + }, { "name": "timeout", "in": "query", @@ -22605,182 +23009,139 @@ } }, { - "name": "master_timeout", + "name": "version", "in": "query", - "description": "Operation timeout for connection to master node.", + "description": "Explicit version number for concurrency control.", "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to master node.", - "x-version-deprecated": "2.0.0", - "x-data-type": "time", - "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", - "deprecated": true + "type": "integer", + "description": "Explicit version number for concurrency control.", + "format": "int32" } }, { - "name": "cluster_manager_timeout", + "name": "version_type", "in": "query", - "description": "Operation timeout for connection to cluster-manager node.", + "description": "Specific version type.", "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to cluster-manager node.", - "x-data-type": "time" + "$ref": "#/components/schemas/VersionType" } }, { - "name": "ignore_unavailable", + "name": "if_seq_no", "in": "query", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", + "description": "only perform the operation if the last operation that has changed the document has the specified sequence number.", "schema": { - "type": "boolean", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." + "type": "integer", + "description": "only perform the operation if the last operation that has changed the document has the specified sequence number.", + "format": "int32" } }, { - "name": "allow_no_indices", + "name": "if_primary_term", "in": "query", - "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified).", + "description": "only perform the operation if the last operation that has changed the document has the specified primary term.", "schema": { - "type": "boolean", - "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)." + "type": "integer", + "description": "only perform the operation if the last operation that has changed the document has the specified primary term.", + "format": "int32" } }, { - "name": "expand_wildcards", + "name": "pipeline", "in": "query", - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", + "description": "The pipeline id to preprocess incoming documents with.", "schema": { - "$ref": "#/components/schemas/ExpandWildcards" + "type": "string", + "description": "The pipeline id to preprocess incoming documents with." } }, { - "name": "write_index_only", + "name": "require_alias", "in": "query", - "description": "When true, applies mappings only to the write index of an alias or data stream.", + "description": "When true, requires destination to be an alias.", "schema": { "type": "boolean", "default": false, - "description": "When true, applies mappings only to the write index of an alias or data stream." + "description": "When true, requires destination to be an alias." } } ], "responses": { "200": { - "description": "IndicesPutMapping_Put 200 response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IndicesPutMapping_PutResponseContent" - } - } - } + "description": "Index_Put_WithId 200 response" } }, - "x-operation-group": "indices.put_mapping", + "x-operation-group": "index", "x-version-added": "1.0" } }, - "/{index}/_mapping/field/{fields}": { + "/{index}/_explain/{id}": { "get": { - "description": "Returns mapping for one or more fields.", - "operationId": "IndicesGetFieldMapping_WithIndex", + "description": "Returns information about why a specific matches (or doesn't match) a query.", + "externalDocs": { + "description": "API Reference", + "url": "https://opensearch.org/docs/latest/api-reference/explain/" + }, + "operationId": "Explain_Get", "parameters": [ { - "name": "index", + "name": "id", "in": "path", - "description": "Comma-separated list of indices.", + "description": "Document ID.", "schema": { "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", - "description": "Comma-separated list of indices.", - "x-data-type": "array" + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", + "description": "Document ID." }, "required": true }, { - "name": "fields", + "name": "index", "in": "path", - "description": "Comma-separated list of fields.", + "description": "Index name.", "schema": { "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", - "description": "Comma-separated list of fields.", - "x-data-type": "array" + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", + "description": "Index name." }, "required": true }, { - "name": "include_defaults", + "name": "analyze_wildcard", "in": "query", - "description": "Whether the default mapping values should be returned as well.", + "description": "Specify whether wildcards and prefix queries in the query string query should be analyzed.", "schema": { "type": "boolean", - "description": "Whether the default mapping values should be returned as well." + "default": false, + "description": "Specify whether wildcards and prefix queries in the query string query should be analyzed." } }, { - "name": "ignore_unavailable", + "name": "analyzer", "in": "query", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", + "description": "The analyzer to use for the query string.", "schema": { - "type": "boolean", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." + "type": "string", + "description": "The analyzer to use for the query string." } }, { - "name": "allow_no_indices", + "name": "default_operator", "in": "query", - "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified).", + "description": "The default operator for query string query (AND or OR).", "schema": { - "type": "boolean", - "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)." - } - }, - { - "name": "expand_wildcards", - "in": "query", - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", - "schema": { - "$ref": "#/components/schemas/ExpandWildcards" + "$ref": "#/components/schemas/DefaultOperator" } }, { - "name": "local", + "name": "df", "in": "query", - "description": "Return local information, do not retrieve the state from cluster-manager node.", - "schema": { - "type": "boolean", - "default": false, - "description": "Return local information, do not retrieve the state from cluster-manager node." - } - } - ], - "responses": { - "200": { - "description": "IndicesGetFieldMapping_WithIndex 200 response" - } - }, - "x-operation-group": "indices.get_field_mapping", - "x-version-added": "1.0" - } - }, - "/{index}/_mget": { - "get": { - "description": "Allows to get multiple documents in one request.", - "operationId": "Mget_Get_WithIndex", - "parameters": [ - { - "name": "index", - "in": "path", - "description": "Index name.", + "description": "The default field for query string query.", "schema": { "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", - "description": "Index name." - }, - "required": true + "default": "_all", + "description": "The default field for query string query." + } }, { "name": "stored_fields", @@ -22797,31 +23158,31 @@ "explode": true }, { - "name": "preference", + "name": "lenient", "in": "query", - "description": "Specify the node or shard the operation should be performed on.", + "description": "Specify whether format-based query failures (such as providing text to a numeric field) should be ignored.", "schema": { - "type": "string", - "default": "random", - "description": "Specify the node or shard the operation should be performed on." + "type": "boolean", + "description": "Specify whether format-based query failures (such as providing text to a numeric field) should be ignored." } }, { - "name": "realtime", + "name": "preference", "in": "query", - "description": "Specify whether to perform the operation in realtime or search mode.", + "description": "Specify the node or shard the operation should be performed on.", "schema": { - "type": "boolean", - "description": "Specify whether to perform the operation in realtime or search mode." + "type": "string", + "default": "random", + "description": "Specify the node or shard the operation should be performed on." } }, { - "name": "refresh", + "name": "q", "in": "query", - "description": "Refresh the shard containing the document before performing the operation.", + "description": "Query in the Lucene query string syntax.", "schema": { - "type": "boolean", - "description": "Refresh the shard containing the document before performing the operation." + "type": "string", + "description": "Query in the Lucene query string syntax." } }, { @@ -22878,37 +23239,84 @@ ], "responses": { "200": { - "description": "Mget_Get_WithIndex 200 response" + "description": "Explain_Get 200 response" } }, - "x-operation-group": "mget", + "x-operation-group": "explain", "x-version-added": "1.0" }, "post": { - "description": "Allows to get multiple documents in one request.", - "operationId": "Mget_Post_WithIndex", + "description": "Returns information about why a specific matches (or doesn't match) a query.", + "operationId": "Explain_Post", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Mget_BodyParams" + "$ref": "#/components/schemas/Explain_BodyParams" } } - }, - "required": true + } }, "parameters": [ + { + "name": "id", + "in": "path", + "description": "Document ID.", + "schema": { + "type": "string", + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", + "description": "Document ID." + }, + "required": true + }, { "name": "index", "in": "path", "description": "Index name.", "schema": { "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", "description": "Index name." }, "required": true }, + { + "name": "analyze_wildcard", + "in": "query", + "description": "Specify whether wildcards and prefix queries in the query string query should be analyzed.", + "schema": { + "type": "boolean", + "default": false, + "description": "Specify whether wildcards and prefix queries in the query string query should be analyzed." + } + }, + { + "name": "analyzer", + "in": "query", + "description": "The analyzer to use for the query string.", + "schema": { + "type": "string", + "description": "The analyzer to use for the query string." + } + }, + { + "name": "default_operator", + "in": "query", + "description": "The default operator for query string query (AND or OR).", + "schema": { + "$ref": "#/components/schemas/DefaultOperator" + } + }, + { + "name": "df", + "in": "query", + "description": "The default field for query string query.", + "schema": { + "type": "string", + "default": "_all", + "description": "The default field for query string query." + } + }, { "name": "stored_fields", "in": "query", @@ -22924,31 +23332,31 @@ "explode": true }, { - "name": "preference", + "name": "lenient", "in": "query", - "description": "Specify the node or shard the operation should be performed on.", + "description": "Specify whether format-based query failures (such as providing text to a numeric field) should be ignored.", "schema": { - "type": "string", - "default": "random", - "description": "Specify the node or shard the operation should be performed on." + "type": "boolean", + "description": "Specify whether format-based query failures (such as providing text to a numeric field) should be ignored." } }, { - "name": "realtime", + "name": "preference", "in": "query", - "description": "Specify whether to perform the operation in realtime or search mode.", + "description": "Specify the node or shard the operation should be performed on.", "schema": { - "type": "boolean", - "description": "Specify whether to perform the operation in realtime or search mode." + "type": "string", + "default": "random", + "description": "Specify the node or shard the operation should be performed on." } }, { - "name": "refresh", + "name": "q", "in": "query", - "description": "Refresh the shard containing the document before performing the operation.", + "description": "Query in the Lucene query string syntax.", "schema": { - "type": "boolean", - "description": "Refresh the shard containing the document before performing the operation." + "type": "string", + "description": "Query in the Lucene query string syntax." } }, { @@ -23005,693 +23413,510 @@ ], "responses": { "200": { - "description": "Mget_Post_WithIndex 200 response" + "description": "Explain_Post 200 response" } }, - "x-operation-group": "mget", + "x-operation-group": "explain", "x-version-added": "1.0" } }, - "/{index}/_msearch": { + "/{index}/_field_caps": { "get": { - "description": "Allows to execute several search operations in one request.", - "operationId": "Msearch_Get_WithIndex", + "description": "Returns the information about the capabilities of fields among multiple indices.", + "operationId": "FieldCaps_Get_WithIndex", "parameters": [ { "name": "index", "in": "path", - "description": "Comma-separated list of indices to use as default.", + "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 to use as default.", + "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 }, { - "name": "search_type", - "in": "query", - "description": "Search operation type.", - "schema": { - "$ref": "#/components/schemas/SearchTypeMulti" - } - }, - { - "name": "max_concurrent_searches", + "name": "fields", "in": "query", - "description": "Controls the maximum number of concurrent searches the multi search api will execute.", + "description": "Comma-separated list of field names.", + "style": "form", "schema": { - "type": "integer", - "description": "Controls the maximum number of concurrent searches the multi search api will execute.", - "format": "int32" - } + "type": "array", + "items": { + "type": "string" + }, + "description": "Comma-separated list of field names." + }, + "explode": true }, { - "name": "typed_keys", + "name": "ignore_unavailable", "in": "query", - "description": "Specify whether aggregation and suggester names should be prefixed by their respective types in the response.", + "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", "schema": { "type": "boolean", - "description": "Specify whether aggregation and suggester names should be prefixed by their respective types in the response." + "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." } }, { - "name": "pre_filter_shard_size", + "name": "allow_no_indices", "in": "query", - "description": "Threshold that enforces a pre-filter round-trip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter round-trip can limit the number of shards significantly if for instance a shard can not match any documents based on its rewrite method ie. if date filters are mandatory to match but the shard bounds and the query are disjoint.", + "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified).", "schema": { - "type": "integer", - "description": "Threshold that enforces a pre-filter round-trip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter round-trip can limit the number of shards significantly if for instance a shard can not match any documents based on its rewrite method ie. if date filters are mandatory to match but the shard bounds and the query are disjoint.", - "format": "int32" + "type": "boolean", + "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)." } }, { - "name": "max_concurrent_shard_requests", + "name": "expand_wildcards", "in": "query", - "description": "The number of concurrent shard requests each sub search executes concurrently per node. 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.", + "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", "schema": { - "type": "integer", - "default": 5, - "description": "The number of concurrent shard requests each sub search executes concurrently per node. This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests.", - "format": "int32" + "$ref": "#/components/schemas/ExpandWildcards" } }, { - "name": "rest_total_hits_as_int", + "name": "include_unmapped", "in": "query", - "description": "Indicates whether hits.total should be rendered as an integer or an object in the rest search response.", + "description": "Indicates whether unmapped fields should be included in the response.", "schema": { "type": "boolean", "default": false, - "description": "Indicates whether hits.total should be rendered as an integer or an object in the rest search response." - } - }, - { - "name": "ccs_minimize_roundtrips", - "in": "query", - "description": "Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution.", - "schema": { - "type": "boolean", - "default": true, - "description": "Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution." + "description": "Indicates whether unmapped fields should be included in the response." } } ], "responses": { "200": { - "description": "Msearch_Get_WithIndex 200 response" + "description": "FieldCaps_Get_WithIndex 200 response" } }, - "x-operation-group": "msearch", + "x-operation-group": "field_caps", "x-version-added": "1.0" }, "post": { - "description": "Allows to execute several search operations in one request.", - "operationId": "Msearch_Post_WithIndex", + "description": "Returns the information about the capabilities of fields among multiple indices.", + "operationId": "FieldCaps_Post_WithIndex", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Msearch_BodyParams" + "$ref": "#/components/schemas/FieldCaps_BodyParams" } } - }, - "required": true + } }, "parameters": [ { "name": "index", "in": "path", - "description": "Comma-separated list of indices to use as default.", + "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 to use as default.", + "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 }, { - "name": "search_type", + "name": "fields", "in": "query", - "description": "Search operation type.", - "schema": { - "$ref": "#/components/schemas/SearchTypeMulti" - } - }, - { - "name": "max_concurrent_searches", - "in": "query", - "description": "Controls the maximum number of concurrent searches the multi search api will execute.", + "description": "Comma-separated list of field names.", + "style": "form", "schema": { - "type": "integer", - "description": "Controls the maximum number of concurrent searches the multi search api will execute.", - "format": "int32" - } + "type": "array", + "items": { + "type": "string" + }, + "description": "Comma-separated list of field names." + }, + "explode": true }, { - "name": "typed_keys", + "name": "ignore_unavailable", "in": "query", - "description": "Specify whether aggregation and suggester names should be prefixed by their respective types in the response.", + "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", "schema": { "type": "boolean", - "description": "Specify whether aggregation and suggester names should be prefixed by their respective types in the response." + "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." } }, { - "name": "pre_filter_shard_size", + "name": "allow_no_indices", "in": "query", - "description": "Threshold that enforces a pre-filter round-trip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter round-trip can limit the number of shards significantly if for instance a shard can not match any documents based on its rewrite method ie. if date filters are mandatory to match but the shard bounds and the query are disjoint.", + "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified).", "schema": { - "type": "integer", - "description": "Threshold that enforces a pre-filter round-trip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter round-trip can limit the number of shards significantly if for instance a shard can not match any documents based on its rewrite method ie. if date filters are mandatory to match but the shard bounds and the query are disjoint.", - "format": "int32" + "type": "boolean", + "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)." } }, { - "name": "max_concurrent_shard_requests", + "name": "expand_wildcards", "in": "query", - "description": "The number of concurrent shard requests each sub search executes concurrently per node. 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.", + "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", "schema": { - "type": "integer", - "default": 5, - "description": "The number of concurrent shard requests each sub search executes concurrently per node. This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests.", - "format": "int32" + "$ref": "#/components/schemas/ExpandWildcards" } }, { - "name": "rest_total_hits_as_int", + "name": "include_unmapped", "in": "query", - "description": "Indicates whether hits.total should be rendered as an integer or an object in the rest search response.", + "description": "Indicates whether unmapped fields should be included in the response.", "schema": { "type": "boolean", "default": false, - "description": "Indicates whether hits.total should be rendered as an integer or an object in the rest search response." - } - }, - { - "name": "ccs_minimize_roundtrips", - "in": "query", - "description": "Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution.", - "schema": { - "type": "boolean", - "default": true, - "description": "Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution." + "description": "Indicates whether unmapped fields should be included in the response." } } ], "responses": { "200": { - "description": "Msearch_Post_WithIndex 200 response" + "description": "FieldCaps_Post_WithIndex 200 response" } }, - "x-operation-group": "msearch", + "x-operation-group": "field_caps", "x-version-added": "1.0" } }, - "/{index}/_msearch/template": { + "/{index}/_flush": { "get": { - "description": "Allows to execute several search template operations in one request.", - "operationId": "MsearchTemplate_Get_WithIndex", + "description": "Performs the flush operation on one or more indices.", + "operationId": "IndicesFlush_Get_WithIndex", "parameters": [ { "name": "index", "in": "path", - "description": "Comma-separated list of indices to use as default.", + "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 to use as default.", + "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 }, { - "name": "search_type", + "name": "force", "in": "query", - "description": "Search operation type.", + "description": "Whether a flush should be forced even if it is not necessarily needed ie. if no changes will be committed to the index. This is useful if transaction log IDs should be incremented even if no uncommitted changes are present. (This setting can be considered as internal).", "schema": { - "$ref": "#/components/schemas/SearchTypeMulti" + "type": "boolean", + "description": "Whether a flush should be forced even if it is not necessarily needed ie. if no changes will be committed to the index. This is useful if transaction log IDs should be incremented even if no uncommitted changes are present. (This setting can be considered as internal)." } }, { - "name": "typed_keys", + "name": "wait_if_ongoing", "in": "query", - "description": "Specify whether aggregation and suggester names should be prefixed by their respective types in the response.", + "description": "If set to true the flush operation will block until the flush can be executed if another flush operation is already executing. If set to false the flush will be skipped iff if another flush operation is already running.", "schema": { "type": "boolean", - "description": "Specify whether aggregation and suggester names should be prefixed by their respective types in the response." + "default": true, + "description": "If set to true the flush operation will block until the flush can be executed if another flush operation is already executing. If set to false the flush will be skipped iff if another flush operation is already running." } }, { - "name": "max_concurrent_searches", + "name": "ignore_unavailable", "in": "query", - "description": "Controls the maximum number of concurrent searches the multi search api will execute.", + "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", "schema": { - "type": "integer", - "description": "Controls the maximum number of concurrent searches the multi search api will execute.", - "format": "int32" + "type": "boolean", + "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." } }, { - "name": "rest_total_hits_as_int", + "name": "allow_no_indices", "in": "query", - "description": "Indicates whether hits.total should be rendered as an integer or an object in the rest search response.", + "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified).", "schema": { "type": "boolean", - "default": false, - "description": "Indicates whether hits.total should be rendered as an integer or an object in the rest search response." + "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)." } }, { - "name": "ccs_minimize_roundtrips", + "name": "expand_wildcards", "in": "query", - "description": "Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution.", + "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", "schema": { - "type": "boolean", - "default": true, - "description": "Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution." + "$ref": "#/components/schemas/ExpandWildcards" } } ], "responses": { "200": { - "description": "MsearchTemplate_Get_WithIndex 200 response" + "description": "IndicesFlush_Get_WithIndex 200 response" } }, - "x-operation-group": "msearch_template", + "x-operation-group": "indices.flush", "x-version-added": "1.0" }, "post": { - "description": "Allows to execute several search template operations in one request.", - "operationId": "MsearchTemplate_Post_WithIndex", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/MsearchTemplate_BodyParams" - } - } - }, - "required": true - }, + "description": "Performs the flush operation on one or more indices.", + "operationId": "IndicesFlush_Post_WithIndex", "parameters": [ { "name": "index", "in": "path", - "description": "Comma-separated list of indices to use as default.", + "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 to use as default.", + "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 }, { - "name": "search_type", + "name": "force", "in": "query", - "description": "Search operation type.", + "description": "Whether a flush should be forced even if it is not necessarily needed ie. if no changes will be committed to the index. This is useful if transaction log IDs should be incremented even if no uncommitted changes are present. (This setting can be considered as internal).", "schema": { - "$ref": "#/components/schemas/SearchTypeMulti" + "type": "boolean", + "description": "Whether a flush should be forced even if it is not necessarily needed ie. if no changes will be committed to the index. This is useful if transaction log IDs should be incremented even if no uncommitted changes are present. (This setting can be considered as internal)." } }, { - "name": "typed_keys", + "name": "wait_if_ongoing", "in": "query", - "description": "Specify whether aggregation and suggester names should be prefixed by their respective types in the response.", + "description": "If set to true the flush operation will block until the flush can be executed if another flush operation is already executing. If set to false the flush will be skipped iff if another flush operation is already running.", "schema": { "type": "boolean", - "description": "Specify whether aggregation and suggester names should be prefixed by their respective types in the response." + "default": true, + "description": "If set to true the flush operation will block until the flush can be executed if another flush operation is already executing. If set to false the flush will be skipped iff if another flush operation is already running." } }, { - "name": "max_concurrent_searches", + "name": "ignore_unavailable", "in": "query", - "description": "Controls the maximum number of concurrent searches the multi search api will execute.", + "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", "schema": { - "type": "integer", - "description": "Controls the maximum number of concurrent searches the multi search api will execute.", - "format": "int32" + "type": "boolean", + "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." } }, { - "name": "rest_total_hits_as_int", + "name": "allow_no_indices", "in": "query", - "description": "Indicates whether hits.total should be rendered as an integer or an object in the rest search response.", + "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified).", "schema": { "type": "boolean", - "default": false, - "description": "Indicates whether hits.total should be rendered as an integer or an object in the rest search response." + "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)." } }, { - "name": "ccs_minimize_roundtrips", + "name": "expand_wildcards", "in": "query", - "description": "Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution.", + "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", "schema": { - "type": "boolean", - "default": true, - "description": "Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution." + "$ref": "#/components/schemas/ExpandWildcards" } } ], "responses": { "200": { - "description": "MsearchTemplate_Post_WithIndex 200 response" + "description": "IndicesFlush_Post_WithIndex 200 response" } }, - "x-operation-group": "msearch_template", + "x-operation-group": "indices.flush", "x-version-added": "1.0" } }, - "/{index}/_mtermvectors": { - "get": { - "description": "Returns multiple termvectors in one request.", - "operationId": "Mtermvectors_Get_WithIndex", + "/{index}/_forcemerge": { + "post": { + "description": "Performs the force merge operation on one or more indices.", + "operationId": "IndicesForcemerge_WithIndex", "parameters": [ { "name": "index", "in": "path", - "description": "The index in which the document resides.", + "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": "The index in which the document resides." + "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 }, { - "name": "ids", - "in": "query", - "description": "Comma-separated list of documents ids. You must define ids as parameter or set 'ids' or 'docs' in the request body.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of documents ids. You must define ids as parameter or set 'ids' or 'docs' in the request body." - }, - "explode": true - }, - { - "name": "term_statistics", + "name": "flush", "in": "query", - "description": "Specifies if total term frequency and document frequency should be returned. Applies to all returned documents unless otherwise specified in body 'params' or 'docs'.", + "description": "Specify whether the index should be flushed after performing the operation.", "schema": { "type": "boolean", - "default": false, - "description": "Specifies if total term frequency and document frequency should be returned. Applies to all returned documents unless otherwise specified in body 'params' or 'docs'." + "default": true, + "description": "Specify whether the index should be flushed after performing the operation." } }, { - "name": "field_statistics", + "name": "ignore_unavailable", "in": "query", - "description": "Specifies if document count, sum of document frequencies and sum of total term frequencies should be returned. Applies to all returned documents unless otherwise specified in body 'params' or 'docs'.", + "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", "schema": { "type": "boolean", - "default": true, - "description": "Specifies if document count, sum of document frequencies and sum of total term frequencies should be returned. Applies to all returned documents unless otherwise specified in body 'params' or 'docs'." + "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." } }, { - "name": "fields", + "name": "allow_no_indices", "in": "query", - "description": "Comma-separated list of fields to return. Applies to all returned documents unless otherwise specified in body 'params' or 'docs'.", - "style": "form", + "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified).", "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of fields to return. Applies to all returned documents unless otherwise specified in body 'params' or 'docs'." - }, - "explode": true + "type": "boolean", + "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)." + } }, { - "name": "offsets", + "name": "expand_wildcards", "in": "query", - "description": "Specifies if term offsets should be returned. Applies to all returned documents unless otherwise specified in body 'params' or 'docs'.", + "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", "schema": { - "type": "boolean", - "default": true, - "description": "Specifies if term offsets should be returned. Applies to all returned documents unless otherwise specified in body 'params' or 'docs'." + "$ref": "#/components/schemas/ExpandWildcards" } }, { - "name": "positions", + "name": "max_num_segments", "in": "query", - "description": "Specifies if term positions should be returned. Applies to all returned documents unless otherwise specified in body 'params' or 'docs'.", + "description": "The number of segments the index should be merged into (default: dynamic).", "schema": { - "type": "boolean", - "default": true, - "description": "Specifies if term positions should be returned. Applies to all returned documents unless otherwise specified in body 'params' or 'docs'." + "type": "integer", + "description": "The number of segments the index should be merged into (default: dynamic).", + "format": "int32" } }, { - "name": "payloads", + "name": "only_expunge_deletes", "in": "query", - "description": "Specifies if term payloads should be returned. Applies to all returned documents unless otherwise specified in body 'params' or 'docs'.", + "description": "Specify whether the operation should only expunge deleted documents.", "schema": { "type": "boolean", - "default": true, - "description": "Specifies if term payloads should be returned. Applies to all returned documents unless otherwise specified in body 'params' or 'docs'." - } - }, - { - "name": "preference", - "in": "query", - "description": "Specify the node or shard the operation should be performed on. Applies to all returned documents unless otherwise specified in body 'params' or 'docs'.", - "schema": { - "type": "string", - "default": "random", - "description": "Specify the node or shard the operation should be performed on. Applies to all returned documents unless otherwise specified in body 'params' or 'docs'." - } - }, - { - "name": "routing", - "in": "query", - "description": "Routing value. Applies to all returned documents unless otherwise specified in body 'params' or 'docs'.", - "schema": { - "type": "string", - "description": "Routing value. Applies to all returned documents unless otherwise specified in body 'params' or 'docs'." - } - }, - { - "name": "realtime", - "in": "query", - "description": "Specifies if requests are real-time as opposed to near-real-time.", - "schema": { - "type": "boolean", - "default": true, - "description": "Specifies if requests are real-time as opposed to near-real-time." - } - }, - { - "name": "version", - "in": "query", - "description": "Explicit version number for concurrency control.", - "schema": { - "type": "integer", - "description": "Explicit version number for concurrency control.", - "format": "int32" - } - }, - { - "name": "version_type", - "in": "query", - "description": "Specific version type.", - "schema": { - "$ref": "#/components/schemas/VersionType" + "description": "Specify whether the operation should only expunge deleted documents." } } ], "responses": { "200": { - "description": "Mtermvectors_Get_WithIndex 200 response" + "description": "IndicesForcemerge_WithIndex 200 response" } }, - "x-operation-group": "mtermvectors", + "x-operation-group": "indices.forcemerge", "x-version-added": "1.0" - }, - "post": { - "description": "Returns multiple termvectors in one request.", - "operationId": "Mtermvectors_Post_WithIndex", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Mtermvectors_BodyParams" - } - } - } - }, + } + }, + "/{index}/_mapping": { + "get": { + "description": "Returns mappings for one or more indices.", + "operationId": "IndicesGetMapping_WithIndex", "parameters": [ { "name": "index", "in": "path", - "description": "The index in which the document resides.", + "description": "Comma-separated list of indices.", "schema": { "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", - "description": "The index in which the document resides." + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", + "description": "Comma-separated list of indices.", + "x-data-type": "array" }, "required": true }, { - "name": "ids", - "in": "query", - "description": "Comma-separated list of documents ids. You must define ids as parameter or set 'ids' or 'docs' in the request body.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of documents ids. You must define ids as parameter or set 'ids' or 'docs' in the request body." - }, - "explode": true - }, - { - "name": "term_statistics", - "in": "query", - "description": "Specifies if total term frequency and document frequency should be returned. Applies to all returned documents unless otherwise specified in body 'params' or 'docs'.", - "schema": { - "type": "boolean", - "default": false, - "description": "Specifies if total term frequency and document frequency should be returned. Applies to all returned documents unless otherwise specified in body 'params' or 'docs'." - } - }, - { - "name": "field_statistics", - "in": "query", - "description": "Specifies if document count, sum of document frequencies and sum of total term frequencies should be returned. Applies to all returned documents unless otherwise specified in body 'params' or 'docs'.", - "schema": { - "type": "boolean", - "default": true, - "description": "Specifies if document count, sum of document frequencies and sum of total term frequencies should be returned. Applies to all returned documents unless otherwise specified in body 'params' or 'docs'." - } - }, - { - "name": "fields", - "in": "query", - "description": "Comma-separated list of fields to return. Applies to all returned documents unless otherwise specified in body 'params' or 'docs'.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of fields to return. Applies to all returned documents unless otherwise specified in body 'params' or 'docs'." - }, - "explode": true - }, - { - "name": "offsets", + "name": "ignore_unavailable", "in": "query", - "description": "Specifies if term offsets should be returned. Applies to all returned documents unless otherwise specified in body 'params' or 'docs'.", + "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", "schema": { "type": "boolean", - "default": true, - "description": "Specifies if term offsets should be returned. Applies to all returned documents unless otherwise specified in body 'params' or 'docs'." + "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." } }, { - "name": "positions", + "name": "allow_no_indices", "in": "query", - "description": "Specifies if term positions should be returned. Applies to all returned documents unless otherwise specified in body 'params' or 'docs'.", + "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified).", "schema": { "type": "boolean", - "default": true, - "description": "Specifies if term positions should be returned. Applies to all returned documents unless otherwise specified in body 'params' or 'docs'." + "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)." } }, { - "name": "payloads", + "name": "expand_wildcards", "in": "query", - "description": "Specifies if term payloads should be returned. Applies to all returned documents unless otherwise specified in body 'params' or 'docs'.", + "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", "schema": { - "type": "boolean", - "default": true, - "description": "Specifies if term payloads should be returned. Applies to all returned documents unless otherwise specified in body 'params' or 'docs'." + "$ref": "#/components/schemas/ExpandWildcards" } }, { - "name": "preference", + "name": "master_timeout", "in": "query", - "description": "Specify the node or shard the operation should be performed on. Applies to all returned documents unless otherwise specified in body 'params' or 'docs'.", + "description": "Operation timeout for connection to master node.", "schema": { "type": "string", - "default": "random", - "description": "Specify the node or shard the operation should be performed on. Applies to all returned documents unless otherwise specified in body 'params' or 'docs'." + "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", + "description": "Operation timeout for connection to master node.", + "x-version-deprecated": "2.0.0", + "x-data-type": "time", + "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", + "deprecated": true } }, { - "name": "routing", + "name": "cluster_manager_timeout", "in": "query", - "description": "Routing value. Applies to all returned documents unless otherwise specified in body 'params' or 'docs'.", + "description": "Operation timeout for connection to cluster-manager node.", "schema": { "type": "string", - "description": "Routing value. Applies to all returned documents unless otherwise specified in body 'params' or 'docs'." + "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", + "description": "Operation timeout for connection to cluster-manager node.", + "x-data-type": "time" } }, { - "name": "realtime", + "name": "local", "in": "query", - "description": "Specifies if requests are real-time as opposed to near-real-time.", + "description": "Return local information, do not retrieve the state from cluster-manager node.", "schema": { "type": "boolean", - "default": true, - "description": "Specifies if requests are real-time as opposed to near-real-time." - } - }, - { - "name": "version", - "in": "query", - "description": "Explicit version number for concurrency control.", - "schema": { - "type": "integer", - "description": "Explicit version number for concurrency control.", - "format": "int32" - } - }, - { - "name": "version_type", - "in": "query", - "description": "Specific version type.", - "schema": { - "$ref": "#/components/schemas/VersionType" + "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 is a no-op and field mappings are always retrieved locally.", + "deprecated": true } } ], "responses": { "200": { - "description": "Mtermvectors_Post_WithIndex 200 response" + "description": "IndicesGetMapping_WithIndex 200 response" } }, - "x-operation-group": "mtermvectors", + "x-operation-group": "indices.get_mapping", "x-version-added": "1.0" - } - }, - "/{index}/_open": { + }, "post": { - "description": "Opens an index.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest" + "description": "Updates the index mappings.", + "operationId": "IndicesPutMapping_Post", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IndicesPutMapping_BodyParams" + } + } + }, + "required": true }, - "operationId": "IndicesOpen", "parameters": [ { "name": "index", "in": "path", - "description": "Comma-separated list of indices to open.", + "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 to open.", + "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 @@ -23721,6 +23946,17 @@ "deprecated": true } }, + { + "name": "cluster_manager_timeout", + "in": "query", + "description": "Operation timeout for connection to cluster-manager node.", + "schema": { + "type": "string", + "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", + "description": "Operation timeout for connection to cluster-manager node.", + "x-data-type": "time" + } + }, { "name": "ignore_unavailable", "in": "query", @@ -23748,28 +23984,48 @@ } }, { - "name": "wait_for_active_shards", + "name": "write_index_only", "in": "query", - "description": "Sets the number of active shards to wait for before the operation returns.", + "description": "When true, applies mappings only to the write index of an alias or data stream.", "schema": { - "type": "string", - "description": "Sets the number of active shards to wait for before the operation returns." + "type": "boolean", + "default": false, + "description": "When true, applies mappings only to the write index of an alias or data stream." } } ], "responses": { "200": { - "description": "IndicesOpen 200 response" + "description": "IndicesPutMapping_Post 200 response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IndicesPutMapping_PostResponseContent" + } + } + } } }, - "x-operation-group": "indices.open", + "x-operation-group": "indices.put_mapping", "x-version-added": "1.0" - } - }, - "/{index}/_rank_eval": { - "get": { - "description": "Allows to evaluate the quality of ranked search results over a set of typical search queries.", - "operationId": "RankEval_Get_WithIndex", + }, + "put": { + "description": "Updates the index mappings.", + "externalDocs": { + "description": "API Reference", + "url": "https://opensearch.org/docs/latest/api-reference/index-apis/put-mapping/" + }, + "operationId": "IndicesPutMapping_Put", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IndicesPutMapping_BodyParams" + } + } + }, + "required": true + }, "parameters": [ { "name": "index", @@ -23777,80 +24033,47 @@ "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)", + "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 }, { - "name": "ignore_unavailable", - "in": "query", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", - "schema": { - "type": "boolean", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." - } - }, - { - "name": "allow_no_indices", + "name": "timeout", "in": "query", - "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified).", + "description": "Operation timeout.", "schema": { - "type": "boolean", - "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)." + "type": "string", + "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", + "description": "Operation timeout.", + "x-data-type": "time" } }, { - "name": "expand_wildcards", + "name": "master_timeout", "in": "query", - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", + "description": "Operation timeout for connection to master node.", "schema": { - "$ref": "#/components/schemas/ExpandWildcards" + "type": "string", + "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", + "description": "Operation timeout for connection to master node.", + "x-version-deprecated": "2.0.0", + "x-data-type": "time", + "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", + "deprecated": true } }, { - "name": "search_type", + "name": "cluster_manager_timeout", "in": "query", - "description": "Search operation type.", - "schema": { - "$ref": "#/components/schemas/SearchType" - } - } - ], - "responses": { - "200": { - "description": "RankEval_Get_WithIndex 200 response" - } - }, - "x-operation-group": "rank_eval", - "x-version-added": "1.0" - }, - "post": { - "description": "Allows to evaluate the quality of ranked search results over a set of typical search queries.", - "operationId": "RankEval_Post_WithIndex", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/RankEval_BodyParams" - } - } - }, - "required": true - }, - "parameters": [ - { - "name": "index", - "in": "path", - "description": "Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices.", + "description": "Operation timeout for connection to cluster-manager node.", "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 + "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", + "description": "Operation timeout for connection to cluster-manager node.", + "x-data-type": "time" + } }, { "name": "ignore_unavailable", @@ -23879,86 +24102,69 @@ } }, { - "name": "search_type", + "name": "write_index_only", "in": "query", - "description": "Search operation type.", + "description": "When true, applies mappings only to the write index of an alias or data stream.", "schema": { - "$ref": "#/components/schemas/SearchType" + "type": "boolean", + "default": false, + "description": "When true, applies mappings only to the write index of an alias or data stream." } } ], "responses": { "200": { - "description": "RankEval_Post_WithIndex 200 response" + "description": "IndicesPutMapping_Put 200 response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IndicesPutMapping_PutResponseContent" + } + } + } } }, - "x-operation-group": "rank_eval", + "x-operation-group": "indices.put_mapping", "x-version-added": "1.0" } }, - "/{index}/_recovery": { + "/{index}/_mapping/field/{fields}": { "get": { - "description": "Returns information about ongoing index shard recoveries.", - "operationId": "IndicesRecovery_WithIndex", + "description": "Returns mapping for one or more fields.", + "operationId": "IndicesGetFieldMapping_WithIndex", "parameters": [ { "name": "index", "in": "path", - "description": "Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices.", + "description": "Comma-separated list of 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.", + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", + "description": "Comma-separated list of indices.", "x-data-type": "array" }, "required": true }, { - "name": "detailed", - "in": "query", - "description": "Whether to display detailed information about shard recovery.", + "name": "fields", + "in": "path", + "description": "Comma-separated list of fields.", "schema": { - "type": "boolean", - "default": false, - "description": "Whether to display detailed information about shard recovery." - } + "type": "string", + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", + "description": "Comma-separated list of fields.", + "x-data-type": "array" + }, + "required": true }, { - "name": "active_only", + "name": "include_defaults", "in": "query", - "description": "Display only those recoveries that are currently on-going.", + "description": "Whether the default mapping values should be returned as well.", "schema": { "type": "boolean", - "default": false, - "description": "Display only those recoveries that are currently on-going." + "description": "Whether the default mapping values should be returned as well." } - } - ], - "responses": { - "200": { - "description": "IndicesRecovery_WithIndex 200 response" - } - }, - "x-operation-group": "indices.recovery", - "x-version-added": "1.0" - } - }, - "/{index}/_refresh": { - "get": { - "description": "Performs the refresh operation in one or more indices.", - "operationId": "IndicesRefresh_Get_WithIndex", - "parameters": [ - { - "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 }, { "name": "ignore_unavailable", @@ -23985,299 +24191,220 @@ "schema": { "$ref": "#/components/schemas/ExpandWildcards" } - } - ], - "responses": { - "200": { - "description": "IndicesRefresh_Get_WithIndex 200 response" - } - }, - "x-operation-group": "indices.refresh", - "x-version-added": "1.0" - }, - "post": { - "description": "Performs the refresh operation in one or more indices.", - "operationId": "IndicesRefresh_Post_WithIndex", - "parameters": [ - { - "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 - }, - { - "name": "ignore_unavailable", - "in": "query", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", - "schema": { - "type": "boolean", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." - } }, { - "name": "allow_no_indices", + "name": "local", "in": "query", - "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified).", + "description": "Return local information, do not retrieve the state from cluster-manager node.", "schema": { "type": "boolean", - "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)." - } - }, - { - "name": "expand_wildcards", - "in": "query", - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", - "schema": { - "$ref": "#/components/schemas/ExpandWildcards" + "default": false, + "description": "Return local information, do not retrieve the state from cluster-manager node." } } ], "responses": { "200": { - "description": "IndicesRefresh_Post_WithIndex 200 response" + "description": "IndicesGetFieldMapping_WithIndex 200 response" } }, - "x-operation-group": "indices.refresh", + "x-operation-group": "indices.get_field_mapping", "x-version-added": "1.0" } }, - "/{index}/_search": { + "/{index}/_mget": { "get": { - "description": "Returns results matching a query.", - "operationId": "Search_Get_WithIndex", + "description": "Allows to get multiple documents in one request.", + "operationId": "Mget_Get_WithIndex", "parameters": [ { "name": "index", "in": "path", - "description": "Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices.", + "description": "Index name.", "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" + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", + "description": "Index name." }, "required": true }, { - "name": "analyzer", + "name": "stored_fields", "in": "query", - "description": "The analyzer to use for the query string.", + "description": "Comma-separated list of stored fields to return.", + "style": "form", "schema": { - "type": "string", - "description": "The analyzer to use for the query string." - } + "type": "array", + "items": { + "type": "string" + }, + "description": "Comma-separated list of stored fields to return." + }, + "explode": true }, { - "name": "analyze_wildcard", + "name": "preference", "in": "query", - "description": "Specify whether wildcard and prefix queries should be analyzed.", + "description": "Specify the node or shard the operation should be performed on.", "schema": { - "type": "boolean", - "default": false, - "description": "Specify whether wildcard and prefix queries should be analyzed." + "type": "string", + "default": "random", + "description": "Specify the node or shard the operation should be performed on." } }, { - "name": "ccs_minimize_roundtrips", + "name": "realtime", "in": "query", - "description": "Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution.", + "description": "Specify whether to perform the operation in realtime or search mode.", "schema": { "type": "boolean", - "default": true, - "description": "Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution." + "description": "Specify whether to perform the operation in realtime or search mode." } }, { - "name": "default_operator", + "name": "refresh", "in": "query", - "description": "The default operator for query string query (AND or OR).", + "description": "Refresh the shard containing the document before performing the operation.", "schema": { - "$ref": "#/components/schemas/DefaultOperator" + "type": "boolean", + "description": "Refresh the shard containing the document before performing the operation." } }, { - "name": "df", + "name": "routing", "in": "query", - "description": "The field to use as default where no field prefix is given in the query string.", + "description": "Routing value.", "schema": { "type": "string", - "description": "The field to use as default where no field prefix is given in the query string." - } - }, - { - "name": "explain", - "in": "query", - "description": "Specify whether to return detailed information about score computation as part of a hit.", - "schema": { - "type": "boolean", - "description": "Specify whether to return detailed information about score computation as part of a hit." + "description": "Routing value." } }, { - "name": "stored_fields", + "name": "_source", "in": "query", - "description": "Comma-separated list of stored fields to return.", + "description": "True or false to return the _source field or not, or a list of fields to return.", "style": "form", "schema": { "type": "array", "items": { "type": "string" }, - "description": "Comma-separated list of stored fields to return." + "description": "True or false to return the _source field or not, or a list of fields to return." }, "explode": true }, { - "name": "docvalue_fields", + "name": "_source_excludes", "in": "query", - "description": "Comma-separated list of fields to return as the docvalue representation of a field for each hit.", + "description": "List of fields to exclude from the returned _source field.", "style": "form", "schema": { "type": "array", "items": { "type": "string" }, - "description": "Comma-separated list of fields to return as the docvalue representation of a field for each hit." + "description": "List of fields to exclude from the returned _source field." }, "explode": true }, { - "name": "from", - "in": "query", - "description": "Starting offset.", - "schema": { - "type": "integer", - "default": 0, - "description": "Starting offset.", - "format": "int32" - } - }, - { - "name": "ignore_unavailable", - "in": "query", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", - "schema": { - "type": "boolean", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." - } - }, - { - "name": "ignore_throttled", - "in": "query", - "description": "Whether specified concrete, expanded or aliased indices should be ignored when throttled.", - "schema": { - "type": "boolean", - "description": "Whether specified concrete, expanded or aliased indices should be ignored when throttled." - } - }, - { - "name": "allow_no_indices", - "in": "query", - "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified).", - "schema": { - "type": "boolean", - "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)." - } - }, - { - "name": "expand_wildcards", - "in": "query", - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", - "schema": { - "$ref": "#/components/schemas/ExpandWildcards" - } - }, - { - "name": "lenient", - "in": "query", - "description": "Specify whether format-based query failures (such as providing text to a numeric field) should be ignored.", - "schema": { - "type": "boolean", - "description": "Specify whether format-based query failures (such as providing text to a numeric field) should be ignored." - } - }, - { - "name": "preference", + "name": "_source_includes", "in": "query", - "description": "Specify the node or shard the operation should be performed on.", + "description": "List of fields to extract and return from the _source field.", + "style": "form", "schema": { - "type": "string", - "default": "random", - "description": "Specify the node or shard the operation should be performed on." + "type": "array", + "items": { + "type": "string" + }, + "description": "List of fields to extract and return from the _source field." + }, + "explode": true + } + ], + "responses": { + "200": { + "description": "Mget_Get_WithIndex 200 response" + } + }, + "x-operation-group": "mget", + "x-version-added": "1.0" + }, + "post": { + "description": "Allows to get multiple documents in one request.", + "operationId": "Mget_Post_WithIndex", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Mget_BodyParams" + } } }, + "required": true + }, + "parameters": [ { - "name": "q", - "in": "query", - "description": "Query in the Lucene query string syntax.", + "name": "index", + "in": "path", + "description": "Index name.", "schema": { "type": "string", - "description": "Query in the Lucene query string syntax." - } + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", + "description": "Index name." + }, + "required": true }, { - "name": "routing", + "name": "stored_fields", "in": "query", - "description": "Comma-separated list of specific routing values.", + "description": "Comma-separated list of stored fields to return.", "style": "form", "schema": { "type": "array", "items": { "type": "string" }, - "description": "Comma-separated list of specific routing values." + "description": "Comma-separated list of stored fields to return." }, "explode": true }, { - "name": "scroll", + "name": "preference", "in": "query", - "description": "Specify how long a consistent view of the index should be maintained for scrolled search.", + "description": "Specify the node or shard the operation should be performed on.", "schema": { "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Specify how long a consistent view of the index should be maintained for scrolled search.", - "x-data-type": "time" + "default": "random", + "description": "Specify the node or shard the operation should be performed on." } }, { - "name": "search_type", + "name": "realtime", "in": "query", - "description": "Search operation type.", + "description": "Specify whether to perform the operation in realtime or search mode.", "schema": { - "$ref": "#/components/schemas/SearchType" + "type": "boolean", + "description": "Specify whether to perform the operation in realtime or search mode." } }, { - "name": "size", + "name": "refresh", "in": "query", - "description": "Number of hits to return.", + "description": "Refresh the shard containing the document before performing the operation.", "schema": { - "type": "integer", - "default": 10, - "description": "Number of hits to return.", - "format": "int32" + "type": "boolean", + "description": "Refresh the shard containing the document before performing the operation." } }, { - "name": "sort", + "name": "routing", "in": "query", - "description": "Comma-separated list of : pairs.", - "style": "form", + "description": "Routing value.", "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of : pairs." - }, - "explode": true + "type": "string", + "description": "Routing value." + } }, { "name": "_source", @@ -24320,104 +24447,153 @@ "description": "List of fields to extract and return from the _source field." }, "explode": true + } + ], + "responses": { + "200": { + "description": "Mget_Post_WithIndex 200 response" + } + }, + "x-operation-group": "mget", + "x-version-added": "1.0" + } + }, + "/{index}/_msearch": { + "get": { + "description": "Allows to execute several search operations in one request.", + "operationId": "Msearch_Get_WithIndex", + "parameters": [ + { + "name": "index", + "in": "path", + "description": "Comma-separated list of indices to use as default.", + "schema": { + "type": "string", + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", + "description": "Comma-separated list of indices to use as default.", + "x-data-type": "array" + }, + "required": true }, { - "name": "terminate_after", + "name": "search_type", "in": "query", - "description": "The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early.", + "description": "Search operation type.", "schema": { - "type": "integer", - "description": "The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early.", - "format": "int32" + "$ref": "#/components/schemas/SearchTypeMulti" } }, { - "name": "stats", + "name": "max_concurrent_searches", "in": "query", - "description": "Specific 'tag' of the request for logging and statistical purposes.", - "style": "form", + "description": "Controls the maximum number of concurrent searches the multi search api will execute.", "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Specific 'tag' of the request for logging and statistical purposes." - }, - "explode": true + "type": "integer", + "description": "Controls the maximum number of concurrent searches the multi search api will execute.", + "format": "int32" + } }, { - "name": "suggest_field", + "name": "typed_keys", "in": "query", - "description": "Specify which field to use for suggestions.", + "description": "Specify whether aggregation and suggester names should be prefixed by their respective types in the response.", "schema": { - "type": "string", - "description": "Specify which field to use for suggestions." + "type": "boolean", + "description": "Specify whether aggregation and suggester names should be prefixed by their respective types in the response." } }, { - "name": "suggest_mode", + "name": "pre_filter_shard_size", "in": "query", - "description": "Specify suggest mode.", + "description": "Threshold that enforces a pre-filter round-trip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter round-trip can limit the number of shards significantly if for instance a shard can not match any documents based on its rewrite method ie. if date filters are mandatory to match but the shard bounds and the query are disjoint.", "schema": { - "$ref": "#/components/schemas/SuggestMode" + "type": "integer", + "description": "Threshold that enforces a pre-filter round-trip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter round-trip can limit the number of shards significantly if for instance a shard can not match any documents based on its rewrite method ie. if date filters are mandatory to match but the shard bounds and the query are disjoint.", + "format": "int32" } }, { - "name": "suggest_size", + "name": "max_concurrent_shard_requests", "in": "query", - "description": "How many suggestions to return in response.", + "description": "The number of concurrent shard requests each sub search executes concurrently per node. 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": "integer", - "description": "How many suggestions to return in response.", + "default": 5, + "description": "The number of concurrent shard requests each sub search executes concurrently per node. This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests.", "format": "int32" } }, { - "name": "suggest_text", + "name": "rest_total_hits_as_int", "in": "query", - "description": "The source text for which the suggestions should be returned.", + "description": "Indicates whether hits.total should be rendered as an integer or an object in the rest search response.", "schema": { - "type": "string", - "description": "The source text for which the suggestions should be returned." + "type": "boolean", + "default": false, + "description": "Indicates whether hits.total should be rendered as an integer or an object in the rest search response." } }, { - "name": "timeout", + "name": "ccs_minimize_roundtrips", "in": "query", - "description": "Operation timeout.", + "description": "Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution.", "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout.", - "x-data-type": "time" + "type": "boolean", + "default": true, + "description": "Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution." + } + } + ], + "responses": { + "200": { + "description": "Msearch_Get_WithIndex 200 response" + } + }, + "x-operation-group": "msearch", + "x-version-added": "1.0" + }, + "post": { + "description": "Allows to execute several search operations in one request.", + "operationId": "Msearch_Post_WithIndex", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Msearch_BodyParams" + } } }, + "required": true + }, + "parameters": [ { - "name": "track_scores", - "in": "query", - "description": "Whether to calculate and return scores even if they are not used for sorting.", + "name": "index", + "in": "path", + "description": "Comma-separated list of indices to use as default.", "schema": { - "type": "boolean", - "description": "Whether to calculate and return scores even if they are not used for sorting." - } + "type": "string", + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", + "description": "Comma-separated list of indices to use as default.", + "x-data-type": "array" + }, + "required": true }, { - "name": "track_total_hits", + "name": "search_type", "in": "query", - "description": "Indicate if the number of documents that match the query should be tracked.", + "description": "Search operation type.", "schema": { - "type": "boolean", - "description": "Indicate if the number of documents that match the query should be tracked." + "$ref": "#/components/schemas/SearchTypeMulti" } }, { - "name": "allow_partial_search_results", + "name": "max_concurrent_searches", "in": "query", - "description": "Indicate if an error should be returned if there is a partial search failure or timeout.", + "description": "Controls the maximum number of concurrent searches the multi search api will execute.", "schema": { - "type": "boolean", - "default": true, - "description": "Indicate if an error should be returned if there is a partial search failure or timeout." + "type": "integer", + "description": "Controls the maximum number of concurrent searches the multi search api will execute.", + "format": "int32" } }, { @@ -24430,61 +24606,97 @@ } }, { - "name": "version", + "name": "pre_filter_shard_size", "in": "query", - "description": "Whether to return document version as part of a hit.", + "description": "Threshold that enforces a pre-filter round-trip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter round-trip can limit the number of shards significantly if for instance a shard can not match any documents based on its rewrite method ie. if date filters are mandatory to match but the shard bounds and the query are disjoint.", "schema": { - "type": "boolean", - "description": "Whether to return document version as part of a hit." + "type": "integer", + "description": "Threshold that enforces a pre-filter round-trip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter round-trip can limit the number of shards significantly if for instance a shard can not match any documents based on its rewrite method ie. if date filters are mandatory to match but the shard bounds and the query are disjoint.", + "format": "int32" } }, { - "name": "seq_no_primary_term", + "name": "max_concurrent_shard_requests", "in": "query", - "description": "Specify whether to return sequence number and primary term of the last modification of each hit.", + "description": "The number of concurrent shard requests each sub search executes concurrently per node. 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": "integer", + "default": 5, + "description": "The number of concurrent shard requests each sub search executes concurrently per node. This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests.", + "format": "int32" + } + }, + { + "name": "rest_total_hits_as_int", + "in": "query", + "description": "Indicates whether hits.total should be rendered as an integer or an object in the rest search response.", "schema": { "type": "boolean", - "description": "Specify whether to return sequence number and primary term of the last modification of each hit." + "default": false, + "description": "Indicates whether hits.total should be rendered as an integer or an object in the rest search response." } }, { - "name": "request_cache", + "name": "ccs_minimize_roundtrips", "in": "query", - "description": "Specify if request cache should be used for this request or not, defaults to index level setting.", + "description": "Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution.", "schema": { "type": "boolean", - "description": "Specify if request cache should be used for this request or not, defaults to index level setting." + "default": true, + "description": "Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution." } + } + ], + "responses": { + "200": { + "description": "Msearch_Post_WithIndex 200 response" + } + }, + "x-operation-group": "msearch", + "x-version-added": "1.0" + } + }, + "/{index}/_msearch/template": { + "get": { + "description": "Allows to execute several search template operations in one request.", + "operationId": "MsearchTemplate_Get_WithIndex", + "parameters": [ + { + "name": "index", + "in": "path", + "description": "Comma-separated list of indices to use as default.", + "schema": { + "type": "string", + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", + "description": "Comma-separated list of indices to use as default.", + "x-data-type": "array" + }, + "required": true }, { - "name": "batched_reduce_size", + "name": "search_type", "in": "query", - "description": "The number of shard results that should be reduced at once on the coordinating node. This value should be used as a protection mechanism to reduce the memory overhead per search request if the potential number of shards in the request can be large.", + "description": "Search operation type.", "schema": { - "type": "integer", - "default": 512, - "description": "The number of shard results that should be reduced at once on the coordinating node. This value should be used as a protection mechanism to reduce the memory overhead per search request if the potential number of shards in the request can be large.", - "format": "int32" + "$ref": "#/components/schemas/SearchTypeMulti" } }, { - "name": "max_concurrent_shard_requests", + "name": "typed_keys", "in": "query", - "description": "The number of concurrent shard requests per node this search executes concurrently. This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests.", + "description": "Specify whether aggregation and suggester names should be prefixed by their respective types in the response.", "schema": { - "type": "integer", - "default": 5, - "description": "The number of concurrent shard requests per node this search executes concurrently. This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests.", - "format": "int32" + "type": "boolean", + "description": "Specify whether aggregation and suggester names should be prefixed by their respective types in the response." } }, { - "name": "pre_filter_shard_size", + "name": "max_concurrent_searches", "in": "query", - "description": "Threshold that enforces a pre-filter round-trip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter round-trip can limit the number of shards significantly if for instance a shard can not match any documents based on its rewrite method ie. if date filters are mandatory to match but the shard bounds and the query are disjoint.", + "description": "Controls the maximum number of concurrent searches the multi search api will execute.", "schema": { "type": "integer", - "description": "Threshold that enforces a pre-filter round-trip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter round-trip can limit the number of shards significantly if for instance a shard can not match any documents based on its rewrite method ie. if date filters are mandatory to match but the shard bounds and the query are disjoint.", + "description": "Controls the maximum number of concurrent searches the multi search api will execute.", "format": "int32" } }, @@ -24497,557 +24709,513 @@ "default": false, "description": "Indicates whether hits.total should be rendered as an integer or an object in the rest search response." } + }, + { + "name": "ccs_minimize_roundtrips", + "in": "query", + "description": "Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution.", + "schema": { + "type": "boolean", + "default": true, + "description": "Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution." + } } ], "responses": { "200": { - "description": "Search_Get_WithIndex 200 response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Search_Get_WithIndexResponseContent" - } - } - } + "description": "MsearchTemplate_Get_WithIndex 200 response" } }, - "x-operation-group": "search", + "x-operation-group": "msearch_template", "x-version-added": "1.0" }, "post": { - "description": "Returns results matching a query.", - "operationId": "Search_Post_WithIndex", + "description": "Allows to execute several search template operations in one request.", + "operationId": "MsearchTemplate_Post_WithIndex", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Search_BodyParams" - }, - "examples": { - "Search_Post_WithIndex_example1": { - "summary": "Examples for Post Search With Index Operation.", - "description": "", - "value": { - "query": { - "match_all": {} - }, - "fields": [ - "*" - ] - } - } + "$ref": "#/components/schemas/MsearchTemplate_BodyParams" } } - } + }, + "required": true }, "parameters": [ { "name": "index", "in": "path", - "description": "Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices.", + "description": "Comma-separated list of indices to use as default.", "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.", + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", + "description": "Comma-separated list of indices to use as default.", "x-data-type": "array" }, - "required": true, - "examples": { - "Search_Post_WithIndex_example1": { - "summary": "Examples for Post Search With Index Operation.", - "description": "", - "value": "books" - } - } + "required": true }, { - "name": "analyzer", + "name": "search_type", "in": "query", - "description": "The analyzer to use for the query string.", + "description": "Search operation type.", "schema": { - "type": "string", - "description": "The analyzer to use for the query string." + "$ref": "#/components/schemas/SearchTypeMulti" } }, { - "name": "analyze_wildcard", + "name": "typed_keys", "in": "query", - "description": "Specify whether wildcard and prefix queries should be analyzed.", + "description": "Specify whether aggregation and suggester names should be prefixed by their respective types in the response.", "schema": { "type": "boolean", - "default": false, - "description": "Specify whether wildcard and prefix queries should be analyzed." + "description": "Specify whether aggregation and suggester names should be prefixed by their respective types in the response." } }, { - "name": "ccs_minimize_roundtrips", + "name": "max_concurrent_searches", "in": "query", - "description": "Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution.", + "description": "Controls the maximum number of concurrent searches the multi search api will execute.", "schema": { - "type": "boolean", - "default": true, - "description": "Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution." + "type": "integer", + "description": "Controls the maximum number of concurrent searches the multi search api will execute.", + "format": "int32" } }, { - "name": "default_operator", + "name": "rest_total_hits_as_int", "in": "query", - "description": "The default operator for query string query (AND or OR).", - "schema": { - "$ref": "#/components/schemas/DefaultOperator" - } - }, - { - "name": "df", - "in": "query", - "description": "The field to use as default where no field prefix is given in the query string.", + "description": "Indicates whether hits.total should be rendered as an integer or an object in the rest search response.", "schema": { - "type": "string", - "description": "The field to use as default where no field prefix is given in the query string." + "type": "boolean", + "default": false, + "description": "Indicates whether hits.total should be rendered as an integer or an object in the rest search response." } }, { - "name": "explain", + "name": "ccs_minimize_roundtrips", "in": "query", - "description": "Specify whether to return detailed information about score computation as part of a hit.", + "description": "Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution.", "schema": { "type": "boolean", - "description": "Specify whether to return detailed information about score computation as part of a hit." + "default": true, + "description": "Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution." } - }, + } + ], + "responses": { + "200": { + "description": "MsearchTemplate_Post_WithIndex 200 response" + } + }, + "x-operation-group": "msearch_template", + "x-version-added": "1.0" + } + }, + "/{index}/_mtermvectors": { + "get": { + "description": "Returns multiple termvectors in one request.", + "operationId": "Mtermvectors_Get_WithIndex", + "parameters": [ { - "name": "stored_fields", - "in": "query", - "description": "Comma-separated list of stored fields to return.", - "style": "form", + "name": "index", + "in": "path", + "description": "The index in which the document resides.", "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of stored fields to return." + "type": "string", + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", + "description": "The index in which the document resides." }, - "explode": true + "required": true }, { - "name": "docvalue_fields", + "name": "ids", "in": "query", - "description": "Comma-separated list of fields to return as the docvalue representation of a field for each hit.", + "description": "Comma-separated list of documents ids. You must define ids as parameter or set 'ids' or 'docs' in the request body.", "style": "form", "schema": { "type": "array", "items": { "type": "string" }, - "description": "Comma-separated list of fields to return as the docvalue representation of a field for each hit." + "description": "Comma-separated list of documents ids. You must define ids as parameter or set 'ids' or 'docs' in the request body." }, "explode": true }, { - "name": "from", + "name": "term_statistics", "in": "query", - "description": "Starting offset.", + "description": "Specifies if total term frequency and document frequency should be returned. Applies to all returned documents unless otherwise specified in body 'params' or 'docs'.", "schema": { - "type": "integer", - "default": 0, - "description": "Starting offset.", - "format": "int32" + "type": "boolean", + "default": false, + "description": "Specifies if total term frequency and document frequency should be returned. Applies to all returned documents unless otherwise specified in body 'params' or 'docs'." } }, { - "name": "ignore_unavailable", + "name": "field_statistics", "in": "query", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", + "description": "Specifies if document count, sum of document frequencies and sum of total term frequencies should be returned. Applies to all returned documents unless otherwise specified in body 'params' or 'docs'.", "schema": { "type": "boolean", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." + "default": true, + "description": "Specifies if document count, sum of document frequencies and sum of total term frequencies should be returned. Applies to all returned documents unless otherwise specified in body 'params' or 'docs'." } }, { - "name": "ignore_throttled", + "name": "fields", "in": "query", - "description": "Whether specified concrete, expanded or aliased indices should be ignored when throttled.", + "description": "Comma-separated list of fields to return. Applies to all returned documents unless otherwise specified in body 'params' or 'docs'.", + "style": "form", "schema": { - "type": "boolean", - "description": "Whether specified concrete, expanded or aliased indices should be ignored when throttled." - } + "type": "array", + "items": { + "type": "string" + }, + "description": "Comma-separated list of fields to return. Applies to all returned documents unless otherwise specified in body 'params' or 'docs'." + }, + "explode": true }, { - "name": "allow_no_indices", + "name": "offsets", "in": "query", - "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified).", + "description": "Specifies if term offsets should be returned. Applies to all returned documents unless otherwise specified in body 'params' or 'docs'.", "schema": { "type": "boolean", - "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)." + "default": true, + "description": "Specifies if term offsets should be returned. Applies to all returned documents unless otherwise specified in body 'params' or 'docs'." } }, { - "name": "expand_wildcards", + "name": "positions", "in": "query", - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", + "description": "Specifies if term positions should be returned. Applies to all returned documents unless otherwise specified in body 'params' or 'docs'.", "schema": { - "$ref": "#/components/schemas/ExpandWildcards" + "type": "boolean", + "default": true, + "description": "Specifies if term positions should be returned. Applies to all returned documents unless otherwise specified in body 'params' or 'docs'." } }, { - "name": "lenient", + "name": "payloads", "in": "query", - "description": "Specify whether format-based query failures (such as providing text to a numeric field) should be ignored.", + "description": "Specifies if term payloads should be returned. Applies to all returned documents unless otherwise specified in body 'params' or 'docs'.", "schema": { "type": "boolean", - "description": "Specify whether format-based query failures (such as providing text to a numeric field) should be ignored." + "default": true, + "description": "Specifies if term payloads should be returned. Applies to all returned documents unless otherwise specified in body 'params' or 'docs'." } }, { "name": "preference", "in": "query", - "description": "Specify the node or shard the operation should be performed on.", + "description": "Specify the node or shard the operation should be performed on. Applies to all returned documents unless otherwise specified in body 'params' or 'docs'.", "schema": { "type": "string", "default": "random", - "description": "Specify the node or shard the operation should be performed on." + "description": "Specify the node or shard the operation should be performed on. Applies to all returned documents unless otherwise specified in body 'params' or 'docs'." } }, { - "name": "q", + "name": "routing", "in": "query", - "description": "Query in the Lucene query string syntax.", + "description": "Routing value. Applies to all returned documents unless otherwise specified in body 'params' or 'docs'.", "schema": { "type": "string", - "description": "Query in the Lucene query string syntax." + "description": "Routing value. Applies to all returned documents unless otherwise specified in body 'params' or 'docs'." } }, { - "name": "routing", + "name": "realtime", "in": "query", - "description": "Comma-separated list of specific routing values.", - "style": "form", + "description": "Specifies if requests are real-time as opposed to near-real-time.", "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of specific routing values." - }, - "explode": true + "type": "boolean", + "default": true, + "description": "Specifies if requests are real-time as opposed to near-real-time." + } }, { - "name": "scroll", + "name": "version", "in": "query", - "description": "Specify how long a consistent view of the index should be maintained for scrolled search.", + "description": "Explicit version number for concurrency control.", "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Specify how long a consistent view of the index should be maintained for scrolled search.", - "x-data-type": "time" - }, - "examples": { - "Search_Post_WithIndex_example1": { - "summary": "Examples for Post Search With Index Operation.", - "description": "", - "value": "1d" - } + "type": "integer", + "description": "Explicit version number for concurrency control.", + "format": "int32" } }, { - "name": "search_type", + "name": "version_type", "in": "query", - "description": "Search operation type.", + "description": "Specific version type.", "schema": { - "$ref": "#/components/schemas/SearchType" + "$ref": "#/components/schemas/VersionType" } - }, + } + ], + "responses": { + "200": { + "description": "Mtermvectors_Get_WithIndex 200 response" + } + }, + "x-operation-group": "mtermvectors", + "x-version-added": "1.0" + }, + "post": { + "description": "Returns multiple termvectors in one request.", + "operationId": "Mtermvectors_Post_WithIndex", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Mtermvectors_BodyParams" + } + } + } + }, + "parameters": [ { - "name": "size", - "in": "query", - "description": "Number of hits to return.", + "name": "index", + "in": "path", + "description": "The index in which the document resides.", "schema": { - "type": "integer", - "default": 10, - "description": "Number of hits to return.", - "format": "int32" - } + "type": "string", + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", + "description": "The index in which the document resides." + }, + "required": true }, { - "name": "sort", + "name": "ids", "in": "query", - "description": "Comma-separated list of : pairs.", + "description": "Comma-separated list of documents ids. You must define ids as parameter or set 'ids' or 'docs' in the request body.", "style": "form", "schema": { "type": "array", "items": { "type": "string" }, - "description": "Comma-separated list of : pairs." + "description": "Comma-separated list of documents ids. You must define ids as parameter or set 'ids' or 'docs' in the request body." }, "explode": true }, { - "name": "_source", + "name": "term_statistics", "in": "query", - "description": "True or false to return the _source field or not, or a list of fields to return.", - "style": "form", + "description": "Specifies if total term frequency and document frequency should be returned. Applies to all returned documents unless otherwise specified in body 'params' or 'docs'.", "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "True or false to return the _source field or not, or a list of fields to return." - }, - "explode": true + "type": "boolean", + "default": false, + "description": "Specifies if total term frequency and document frequency should be returned. Applies to all returned documents unless otherwise specified in body 'params' or 'docs'." + } }, { - "name": "_source_excludes", + "name": "field_statistics", "in": "query", - "description": "List of fields to exclude from the returned _source field.", - "style": "form", + "description": "Specifies if document count, sum of document frequencies and sum of total term frequencies should be returned. Applies to all returned documents unless otherwise specified in body 'params' or 'docs'.", "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "List of fields to exclude from the returned _source field." - }, - "explode": true + "type": "boolean", + "default": true, + "description": "Specifies if document count, sum of document frequencies and sum of total term frequencies should be returned. Applies to all returned documents unless otherwise specified in body 'params' or 'docs'." + } }, { - "name": "_source_includes", + "name": "fields", "in": "query", - "description": "List of fields to extract and return from the _source field.", + "description": "Comma-separated list of fields to return. Applies to all returned documents unless otherwise specified in body 'params' or 'docs'.", "style": "form", "schema": { "type": "array", "items": { "type": "string" }, - "description": "List of fields to extract and return from the _source field." + "description": "Comma-separated list of fields to return. Applies to all returned documents unless otherwise specified in body 'params' or 'docs'." }, "explode": true }, { - "name": "terminate_after", + "name": "offsets", "in": "query", - "description": "The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early.", + "description": "Specifies if term offsets should be returned. Applies to all returned documents unless otherwise specified in body 'params' or 'docs'.", "schema": { - "type": "integer", - "description": "The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early.", - "format": "int32" - } - }, - { - "name": "stats", - "in": "query", - "description": "Specific 'tag' of the request for logging and statistical purposes.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Specific 'tag' of the request for logging and statistical purposes." - }, - "explode": true - }, - { - "name": "suggest_field", - "in": "query", - "description": "Specify which field to use for suggestions.", - "schema": { - "type": "string", - "description": "Specify which field to use for suggestions." + "type": "boolean", + "default": true, + "description": "Specifies if term offsets should be returned. Applies to all returned documents unless otherwise specified in body 'params' or 'docs'." } }, { - "name": "suggest_mode", + "name": "positions", "in": "query", - "description": "Specify suggest mode.", + "description": "Specifies if term positions should be returned. Applies to all returned documents unless otherwise specified in body 'params' or 'docs'.", "schema": { - "$ref": "#/components/schemas/SuggestMode" + "type": "boolean", + "default": true, + "description": "Specifies if term positions should be returned. Applies to all returned documents unless otherwise specified in body 'params' or 'docs'." } }, { - "name": "suggest_size", + "name": "payloads", "in": "query", - "description": "How many suggestions to return in response.", + "description": "Specifies if term payloads should be returned. Applies to all returned documents unless otherwise specified in body 'params' or 'docs'.", "schema": { - "type": "integer", - "description": "How many suggestions to return in response.", - "format": "int32" + "type": "boolean", + "default": true, + "description": "Specifies if term payloads should be returned. Applies to all returned documents unless otherwise specified in body 'params' or 'docs'." } }, { - "name": "suggest_text", + "name": "preference", "in": "query", - "description": "The source text for which the suggestions should be returned.", + "description": "Specify the node or shard the operation should be performed on. Applies to all returned documents unless otherwise specified in body 'params' or 'docs'.", "schema": { "type": "string", - "description": "The source text for which the suggestions should be returned." + "default": "random", + "description": "Specify the node or shard the operation should be performed on. Applies to all returned documents unless otherwise specified in body 'params' or 'docs'." } }, { - "name": "timeout", + "name": "routing", "in": "query", - "description": "Operation timeout.", + "description": "Routing value. Applies to all returned documents unless otherwise specified in body 'params' or 'docs'.", "schema": { "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout.", - "x-data-type": "time" + "description": "Routing value. Applies to all returned documents unless otherwise specified in body 'params' or 'docs'." } }, { - "name": "track_scores", + "name": "realtime", "in": "query", - "description": "Whether to calculate and return scores even if they are not used for sorting.", + "description": "Specifies if requests are real-time as opposed to near-real-time.", "schema": { "type": "boolean", - "description": "Whether to calculate and return scores even if they are not used for sorting." + "default": true, + "description": "Specifies if requests are real-time as opposed to near-real-time." } }, { - "name": "track_total_hits", + "name": "version", "in": "query", - "description": "Indicate if the number of documents that match the query should be tracked.", + "description": "Explicit version number for concurrency control.", "schema": { - "type": "boolean", - "description": "Indicate if the number of documents that match the query should be tracked." + "type": "integer", + "description": "Explicit version number for concurrency control.", + "format": "int32" } }, { - "name": "allow_partial_search_results", + "name": "version_type", "in": "query", - "description": "Indicate if an error should be returned if there is a partial search failure or timeout.", + "description": "Specific version type.", "schema": { - "type": "boolean", - "default": true, - "description": "Indicate if an error should be returned if there is a partial search failure or timeout." + "$ref": "#/components/schemas/VersionType" } - }, + } + ], + "responses": { + "200": { + "description": "Mtermvectors_Post_WithIndex 200 response" + } + }, + "x-operation-group": "mtermvectors", + "x-version-added": "1.0" + } + }, + "/{index}/_open": { + "post": { + "description": "Opens an index.", + "externalDocs": { + "description": "API Reference", + "url": "https://opensearch.org/docs/latest/api-reference/index-apis/open-index/" + }, + "operationId": "IndicesOpen", + "parameters": [ { - "name": "typed_keys", - "in": "query", - "description": "Specify whether aggregation and suggester names should be prefixed by their respective types in the response.", + "name": "index", + "in": "path", + "description": "Comma-separated list of indices to open.", "schema": { - "type": "boolean", - "description": "Specify whether aggregation and suggester names should be prefixed by their respective types in the response." - } + "type": "string", + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", + "description": "Comma-separated list of indices to open.", + "x-data-type": "array" + }, + "required": true }, { - "name": "version", + "name": "timeout", "in": "query", - "description": "Whether to return document version as part of a hit.", + "description": "Operation timeout.", "schema": { - "type": "boolean", - "description": "Whether to return document version as part of a hit." + "type": "string", + "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", + "description": "Operation timeout.", + "x-data-type": "time" } }, { - "name": "seq_no_primary_term", + "name": "master_timeout", "in": "query", - "description": "Specify whether to return sequence number and primary term of the last modification of each hit.", + "description": "Operation timeout for connection to master node.", "schema": { - "type": "boolean", - "description": "Specify whether to return sequence number and primary term of the last modification of each hit." + "type": "string", + "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", + "description": "Operation timeout for connection to master node.", + "x-version-deprecated": "2.0.0", + "x-data-type": "time", + "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", + "deprecated": true } }, { - "name": "request_cache", + "name": "ignore_unavailable", "in": "query", - "description": "Specify if request cache should be used for this request or not, defaults to index level setting.", + "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", "schema": { "type": "boolean", - "description": "Specify if request cache should be used for this request or not, defaults to index level setting." - } - }, - { - "name": "batched_reduce_size", - "in": "query", - "description": "The number of shard results that should be reduced at once on the coordinating node. This value should be used as a protection mechanism to reduce the memory overhead per search request if the potential number of shards in the request can be large.", - "schema": { - "type": "integer", - "default": 512, - "description": "The number of shard results that should be reduced at once on the coordinating node. This value should be used as a protection mechanism to reduce the memory overhead per search request if the potential number of shards in the request can be large.", - "format": "int32" + "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." } }, { - "name": "max_concurrent_shard_requests", + "name": "allow_no_indices", "in": "query", - "description": "The number of concurrent shard requests per node this search executes concurrently. This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests.", + "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified).", "schema": { - "type": "integer", - "default": 5, - "description": "The number of concurrent shard requests per node this search executes concurrently. This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests.", - "format": "int32" + "type": "boolean", + "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)." } }, { - "name": "pre_filter_shard_size", + "name": "expand_wildcards", "in": "query", - "description": "Threshold that enforces a pre-filter round-trip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter round-trip can limit the number of shards significantly if for instance a shard can not match any documents based on its rewrite method ie. if date filters are mandatory to match but the shard bounds and the query are disjoint.", + "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", "schema": { - "type": "integer", - "description": "Threshold that enforces a pre-filter round-trip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter round-trip can limit the number of shards significantly if for instance a shard can not match any documents based on its rewrite method ie. if date filters are mandatory to match but the shard bounds and the query are disjoint.", - "format": "int32" + "$ref": "#/components/schemas/ExpandWildcards" } }, { - "name": "rest_total_hits_as_int", + "name": "wait_for_active_shards", "in": "query", - "description": "Indicates whether hits.total should be rendered as an integer or an object in the rest search response.", + "description": "Sets the number of active shards to wait for before the operation returns.", "schema": { - "type": "boolean", - "default": false, - "description": "Indicates whether hits.total should be rendered as an integer or an object in the rest search response." + "type": "string", + "description": "Sets the number of active shards to wait for before the operation returns." } } ], "responses": { "200": { - "description": "Search_Post_WithIndex 200 response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Search_Post_WithIndexResponseContent" - }, - "examples": { - "Search_Post_WithIndex_example1": { - "summary": "Examples for Post Search With Index Operation.", - "description": "", - "value": { - "timed_out": false, - "_shards": { - "total": 1, - "successful": 1, - "skipped": 0, - "failed": 0 - }, - "hits": { - "total": { - "value": 0, - "relation": "eq" - }, - "hits": [] - } - } - } - } - } - } + "description": "IndicesOpen 200 response" } }, - "x-operation-group": "search", + "x-operation-group": "indices.open", "x-version-added": "1.0" } }, - "/{index}/_search/point_in_time": { - "post": { - "description": "Creates point in time context.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest" - }, - "operationId": "CreatePit", + "/{index}/_rank_eval": { + "get": { + "description": "Allows to evaluate the quality of ranked search results over a set of typical search queries.", + "operationId": "RankEval_Get_WithIndex", "parameters": [ { "name": "index", @@ -25055,68 +25223,68 @@ "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)", + "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 }, { - "name": "allow_partial_pit_creation", + "name": "ignore_unavailable", "in": "query", - "description": "Allow if point in time can be created with partial failures.", + "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", "schema": { "type": "boolean", - "description": "Allow if point in time can be created with partial failures." + "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." } }, { - "name": "keep_alive", + "name": "allow_no_indices", "in": "query", - "description": "Specify the keep alive for point in time.", + "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified).", "schema": { - "type": "string", - "description": "Specify the keep alive for point in time." + "type": "boolean", + "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)." } }, { - "name": "preference", + "name": "expand_wildcards", "in": "query", - "description": "Specify the node or shard the operation should be performed on.", + "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", "schema": { - "type": "string", - "default": "random", - "description": "Specify the node or shard the operation should be performed on." + "$ref": "#/components/schemas/ExpandWildcards" } }, { - "name": "routing", + "name": "search_type", "in": "query", - "description": "Comma-separated list of specific routing values.", - "style": "form", + "description": "Search operation type.", "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of specific routing values." - }, - "explode": true + "$ref": "#/components/schemas/SearchType" + } } ], "responses": { "200": { - "description": "CreatePit 200 response" + "description": "RankEval_Get_WithIndex 200 response" } }, - "x-operation-group": "create_pit", + "x-operation-group": "rank_eval", "x-version-added": "1.0" - } - }, - "/{index}/_search/template": { - "get": { - "description": "Allows to use the Mustache language to pre-render a search definition.", - "operationId": "SearchTemplate_Get_WithIndex", + }, + "post": { + "description": "Allows to evaluate the quality of ranked search results over a set of typical search queries.", + "operationId": "RankEval_Post_WithIndex", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RankEval_BodyParams" + } + } + }, + "required": true + }, "parameters": [ { "name": "index", @@ -25124,7 +25292,7 @@ "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)", + "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" }, @@ -25139,15 +25307,6 @@ "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." } }, - { - "name": "ignore_throttled", - "in": "query", - "description": "Whether specified concrete, expanded or aliased indices should be ignored when throttled.", - "schema": { - "type": "boolean", - "description": "Whether specified concrete, expanded or aliased indices should be ignored when throttled." - } - }, { "name": "allow_no_indices", "in": "query", @@ -25166,117 +25325,125 @@ } }, { - "name": "preference", + "name": "search_type", "in": "query", - "description": "Specify the node or shard the operation should be performed on.", + "description": "Search operation type.", "schema": { - "type": "string", - "default": "random", - "description": "Specify the node or shard the operation should be performed on." + "$ref": "#/components/schemas/SearchType" } - }, - { - "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 - }, + } + ], + "responses": { + "200": { + "description": "RankEval_Post_WithIndex 200 response" + } + }, + "x-operation-group": "rank_eval", + "x-version-added": "1.0" + } + }, + "/{index}/_recovery": { + "get": { + "description": "Returns information about ongoing index shard recoveries.", + "operationId": "IndicesRecovery_WithIndex", + "parameters": [ { - "name": "scroll", - "in": "query", - "description": "Specify how long a consistent view of the index should be maintained for scrolled search.", + "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": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Specify how long a consistent view of the index should be maintained for scrolled search.", - "x-data-type": "time" - } + "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 }, { - "name": "search_type", + "name": "detailed", "in": "query", - "description": "Search operation type.", + "description": "Whether to display detailed information about shard recovery.", "schema": { - "$ref": "#/components/schemas/SearchTypeMulti" + "type": "boolean", + "default": false, + "description": "Whether to display detailed information about shard recovery." } }, { - "name": "explain", + "name": "active_only", "in": "query", - "description": "Specify whether to return detailed information about score computation as part of a hit.", + "description": "Display only those recoveries that are currently on-going.", "schema": { "type": "boolean", - "description": "Specify whether to return detailed information about score computation as part of a hit." + "default": false, + "description": "Display only those recoveries that are currently on-going." } - }, + } + ], + "responses": { + "200": { + "description": "IndicesRecovery_WithIndex 200 response" + } + }, + "x-operation-group": "indices.recovery", + "x-version-added": "1.0" + } + }, + "/{index}/_refresh": { + "get": { + "description": "Performs the refresh operation in one or more indices.", + "operationId": "IndicesRefresh_Get_WithIndex", + "parameters": [ { - "name": "profile", - "in": "query", - "description": "Specify whether to profile the query execution.", + "name": "index", + "in": "path", + "description": "Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices.", "schema": { - "type": "boolean", - "description": "Specify whether to profile the query execution." - } + "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 }, { - "name": "typed_keys", + "name": "ignore_unavailable", "in": "query", - "description": "Specify whether aggregation and suggester names should be prefixed by their respective types in the response.", + "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", "schema": { "type": "boolean", - "description": "Specify whether aggregation and suggester names should be prefixed by their respective types in the response." + "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." } }, { - "name": "rest_total_hits_as_int", + "name": "allow_no_indices", "in": "query", - "description": "Indicates whether hits.total should be rendered as an integer or an object in the rest search response.", + "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified).", "schema": { "type": "boolean", - "default": false, - "description": "Indicates whether hits.total should be rendered as an integer or an object in the rest search response." + "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)." } }, { - "name": "ccs_minimize_roundtrips", + "name": "expand_wildcards", "in": "query", - "description": "Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution.", + "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", "schema": { - "type": "boolean", - "default": true, - "description": "Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution." + "$ref": "#/components/schemas/ExpandWildcards" } } ], "responses": { "200": { - "description": "SearchTemplate_Get_WithIndex 200 response" + "description": "IndicesRefresh_Get_WithIndex 200 response" } }, - "x-operation-group": "search_template", + "x-operation-group": "indices.refresh", "x-version-added": "1.0" }, "post": { - "description": "Allows to use the Mustache language to pre-render a search definition.", - "operationId": "SearchTemplate_Post_WithIndex", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SearchTemplate_BodyParams" - } - } - }, - "required": true - }, + "description": "Performs the refresh operation in one or more indices.", + "operationId": "IndicesRefresh_Post_WithIndex", "parameters": [ { "name": "index", @@ -25284,7 +25451,7 @@ "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)", + "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" }, @@ -25299,15 +25466,6 @@ "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." } }, - { - "name": "ignore_throttled", - "in": "query", - "description": "Whether specified concrete, expanded or aliased indices should be ignored when throttled.", - "schema": { - "type": "boolean", - "description": "Whether specified concrete, expanded or aliased indices should be ignored when throttled." - } - }, { "name": "allow_no_indices", "in": "query", @@ -25324,160 +25482,144 @@ "schema": { "$ref": "#/components/schemas/ExpandWildcards" } - }, + } + ], + "responses": { + "200": { + "description": "IndicesRefresh_Post_WithIndex 200 response" + } + }, + "x-operation-group": "indices.refresh", + "x-version-added": "1.0" + } + }, + "/{index}/_search": { + "get": { + "description": "Returns results matching a query.", + "operationId": "Search_Get_WithIndex", + "parameters": [ { - "name": "preference", - "in": "query", - "description": "Specify the node or shard the operation should be performed on.", + "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", - "default": "random", - "description": "Specify the node or shard the operation should be performed on." - } - }, - { - "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." + "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" }, - "explode": true + "required": true }, { - "name": "scroll", + "name": "analyzer", "in": "query", - "description": "Specify how long a consistent view of the index should be maintained for scrolled search.", + "description": "The analyzer to use for the query string.", "schema": { "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Specify how long a consistent view of the index should be maintained for scrolled search.", - "x-data-type": "time" + "description": "The analyzer to use for the query string." } }, { - "name": "search_type", + "name": "analyze_wildcard", "in": "query", - "description": "Search operation type.", + "description": "Specify whether wildcard and prefix queries should be analyzed.", "schema": { - "$ref": "#/components/schemas/SearchTypeMulti" + "type": "boolean", + "default": false, + "description": "Specify whether wildcard and prefix queries should be analyzed." } }, { - "name": "explain", + "name": "ccs_minimize_roundtrips", "in": "query", - "description": "Specify whether to return detailed information about score computation as part of a hit.", + "description": "Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution.", "schema": { "type": "boolean", - "description": "Specify whether to return detailed information about score computation as part of a hit." + "default": true, + "description": "Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution." } }, { - "name": "profile", + "name": "default_operator", "in": "query", - "description": "Specify whether to profile the query execution.", + "description": "The default operator for query string query (AND or OR).", "schema": { - "type": "boolean", - "description": "Specify whether to profile the query execution." + "$ref": "#/components/schemas/DefaultOperator" } }, { - "name": "typed_keys", + "name": "df", "in": "query", - "description": "Specify whether aggregation and suggester names should be prefixed by their respective types in the response.", + "description": "The field to use as default where no field prefix is given in the query string.", "schema": { - "type": "boolean", - "description": "Specify whether aggregation and suggester names should be prefixed by their respective types in the response." + "type": "string", + "description": "The field to use as default where no field prefix is given in the query string." } }, { - "name": "rest_total_hits_as_int", + "name": "explain", "in": "query", - "description": "Indicates whether hits.total should be rendered as an integer or an object in the rest search response.", + "description": "Specify whether to return detailed information about score computation as part of a hit.", "schema": { "type": "boolean", - "default": false, - "description": "Indicates whether hits.total should be rendered as an integer or an object in the rest search response." + "description": "Specify whether to return detailed information about score computation as part of a hit." } }, { - "name": "ccs_minimize_roundtrips", + "name": "stored_fields", "in": "query", - "description": "Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution.", - "schema": { - "type": "boolean", - "default": true, - "description": "Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution." - } - } - ], - "responses": { - "200": { - "description": "SearchTemplate_Post_WithIndex 200 response" - } - }, - "x-operation-group": "search_template", - "x-version-added": "1.0" - } - }, - "/{index}/_search_shards": { - "get": { - "description": "Returns information about the indices and shards that a search request would be executed against.", - "operationId": "SearchShards_Get_WithIndex", - "parameters": [ - { - "name": "index", - "in": "path", - "description": "Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices.", + "description": "Comma-separated list of stored fields to return.", + "style": "form", "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" + "type": "array", + "items": { + "type": "string" + }, + "description": "Comma-separated list of stored fields to return." }, - "required": true + "explode": true }, { - "name": "preference", + "name": "docvalue_fields", "in": "query", - "description": "Specify the node or shard the operation should be performed on.", + "description": "Comma-separated list of fields to return as the docvalue representation of a field for each hit.", + "style": "form", "schema": { - "type": "string", - "default": "random", - "description": "Specify the node or shard the operation should be performed on." - } + "type": "array", + "items": { + "type": "string" + }, + "description": "Comma-separated list of fields to return as the docvalue representation of a field for each hit." + }, + "explode": true }, { - "name": "routing", + "name": "from", "in": "query", - "description": "Routing value.", + "description": "Starting offset.", "schema": { - "type": "string", - "description": "Routing value." + "type": "integer", + "default": 0, + "description": "Starting offset.", + "format": "int32" } }, { - "name": "local", + "name": "ignore_unavailable", "in": "query", - "description": "Return local information, do not retrieve the state from cluster-manager node.", + "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", "schema": { "type": "boolean", - "default": false, - "description": "Return local information, do not retrieve the state from cluster-manager node." + "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." } }, { - "name": "ignore_unavailable", + "name": "ignore_throttled", "in": "query", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", + "description": "Whether specified concrete, expanded or aliased indices should be ignored when throttled.", "schema": { "type": "boolean", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." + "description": "Whether specified concrete, expanded or aliased indices should be ignored when throttled." } }, { @@ -25496,31 +25638,15 @@ "schema": { "$ref": "#/components/schemas/ExpandWildcards" } - } - ], - "responses": { - "200": { - "description": "SearchShards_Get_WithIndex 200 response" - } - }, - "x-operation-group": "search_shards", - "x-version-added": "1.0" - }, - "post": { - "description": "Returns information about the indices and shards that a search request would be executed against.", - "operationId": "SearchShards_Post_WithIndex", - "parameters": [ + }, { - "name": "index", - "in": "path", - "description": "Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices.", + "name": "lenient", + "in": "query", + "description": "Specify whether format-based query failures (such as providing text to a numeric field) should be ignored.", "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 + "type": "boolean", + "description": "Specify whether format-based query failures (such as providing text to a numeric field) should be ignored." + } }, { "name": "preference", @@ -25533,520 +25659,447 @@ } }, { - "name": "routing", + "name": "q", "in": "query", - "description": "Routing value.", + "description": "Query in the Lucene query string syntax.", "schema": { "type": "string", - "description": "Routing value." + "description": "Query in the Lucene query string syntax." } }, { - "name": "local", + "name": "routing", "in": "query", - "description": "Return local information, do not retrieve the state from cluster-manager node.", + "description": "Comma-separated list of specific routing values.", + "style": "form", "schema": { - "type": "boolean", - "default": false, - "description": "Return local information, do not retrieve the state from cluster-manager node." - } + "type": "array", + "items": { + "type": "string" + }, + "description": "Comma-separated list of specific routing values." + }, + "explode": true }, { - "name": "ignore_unavailable", + "name": "scroll", "in": "query", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", + "description": "Specify how long a consistent view of the index should be maintained for scrolled search.", "schema": { - "type": "boolean", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." + "type": "string", + "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", + "description": "Specify how long a consistent view of the index should be maintained for scrolled search.", + "x-data-type": "time" } }, { - "name": "allow_no_indices", + "name": "search_type", "in": "query", - "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified).", + "description": "Search operation type.", "schema": { - "type": "boolean", - "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)." + "$ref": "#/components/schemas/SearchType" } }, { - "name": "expand_wildcards", + "name": "size", "in": "query", - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", + "description": "Number of hits to return.", "schema": { - "$ref": "#/components/schemas/ExpandWildcards" + "type": "integer", + "default": 10, + "description": "Number of hits to return.", + "format": "int32" } - } - ], - "responses": { - "200": { - "description": "SearchShards_Post_WithIndex 200 response" - } - }, - "x-operation-group": "search_shards", - "x-version-added": "1.0" - } - }, - "/{index}/_segments": { - "get": { - "description": "Provides low-level information about segments in a Lucene index.", - "operationId": "IndicesSegments_WithIndex", - "parameters": [ + }, { - "name": "index", - "in": "path", - "description": "Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices.", + "name": "sort", + "in": "query", + "description": "Comma-separated list of : pairs.", + "style": "form", "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" + "type": "array", + "items": { + "type": "string" + }, + "description": "Comma-separated list of : pairs." }, - "required": true + "explode": true }, { - "name": "ignore_unavailable", + "name": "_source", "in": "query", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", + "description": "True or false to return the _source field or not, or a list of fields to return.", + "style": "form", "schema": { - "type": "boolean", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." - } + "type": "array", + "items": { + "type": "string" + }, + "description": "True or false to return the _source field or not, or a list of fields to return." + }, + "explode": true }, { - "name": "allow_no_indices", + "name": "_source_excludes", "in": "query", - "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified).", + "description": "List of fields to exclude from the returned _source field.", + "style": "form", "schema": { - "type": "boolean", - "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)." - } + "type": "array", + "items": { + "type": "string" + }, + "description": "List of fields to exclude from the returned _source field." + }, + "explode": true }, { - "name": "expand_wildcards", + "name": "_source_includes", "in": "query", - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", + "description": "List of fields to extract and return from the _source field.", + "style": "form", "schema": { - "$ref": "#/components/schemas/ExpandWildcards" - } + "type": "array", + "items": { + "type": "string" + }, + "description": "List of fields to extract and return from the _source field." + }, + "explode": true }, { - "name": "verbose", + "name": "terminate_after", "in": "query", - "description": "Includes detailed memory usage by Lucene.", + "description": "The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early.", "schema": { - "type": "boolean", - "default": false, - "description": "Includes detailed memory usage by Lucene." + "type": "integer", + "description": "The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early.", + "format": "int32" } - } - ], - "responses": { - "200": { - "description": "IndicesSegments_WithIndex 200 response" - } - }, - "x-operation-group": "indices.segments", - "x-version-added": "1.0" - } - }, - "/{index}/_settings": { - "get": { - "description": "Returns settings for one or more indices.", - "operationId": "IndicesGetSettings_WithIndex", - "parameters": [ + }, { - "name": "index", - "in": "path", - "description": "Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices.", + "name": "stats", + "in": "query", + "description": "Specific 'tag' of the request for logging and statistical purposes.", + "style": "form", "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" + "type": "array", + "items": { + "type": "string" + }, + "description": "Specific 'tag' of the request for logging and statistical purposes." }, - "required": true, - "examples": { - "IndicesGetSettings_WithIndex_example1": { - "summary": "Examples for Get settings Index Operation.", - "description": "", - "value": "books" - } - } + "explode": true }, { - "name": "master_timeout", + "name": "suggest_field", "in": "query", - "description": "Operation timeout for connection to master node.", + "description": "Specify which field to use for suggestions.", "schema": { "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to master node.", - "x-version-deprecated": "2.0.0", - "x-data-type": "time", - "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", - "deprecated": true + "description": "Specify which field to use for suggestions." } }, { - "name": "cluster_manager_timeout", + "name": "suggest_mode", "in": "query", - "description": "Operation timeout for connection to cluster-manager node.", + "description": "Specify suggest mode.", "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to cluster-manager node.", - "x-data-type": "time" + "$ref": "#/components/schemas/SuggestMode" } }, { - "name": "ignore_unavailable", + "name": "suggest_size", "in": "query", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", + "description": "How many suggestions to return in response.", "schema": { - "type": "boolean", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." + "type": "integer", + "description": "How many suggestions to return in response.", + "format": "int32" } }, { - "name": "allow_no_indices", + "name": "suggest_text", "in": "query", - "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified).", + "description": "The source text for which the suggestions should be returned.", "schema": { - "type": "boolean", - "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)." + "type": "string", + "description": "The source text for which the suggestions should be returned." } }, { - "name": "expand_wildcards", + "name": "timeout", "in": "query", - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", + "description": "Operation timeout.", "schema": { - "$ref": "#/components/schemas/ExpandWildcards" + "type": "string", + "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", + "description": "Operation timeout.", + "x-data-type": "time" } }, { - "name": "flat_settings", + "name": "track_scores", "in": "query", - "description": "Return settings in flat format.", + "description": "Whether to calculate and return scores even if they are not used for sorting.", "schema": { "type": "boolean", - "default": false, - "description": "Return settings in flat format." + "description": "Whether to calculate and return scores even if they are not used for sorting." } }, { - "name": "local", + "name": "track_total_hits", "in": "query", - "description": "Return local information, do not retrieve the state from cluster-manager node.", + "description": "Indicate if the number of documents that match the query should be tracked.", "schema": { "type": "boolean", - "default": false, - "description": "Return local information, do not retrieve the state from cluster-manager node." + "description": "Indicate if the number of documents that match the query should be tracked." } }, { - "name": "include_defaults", + "name": "allow_partial_search_results", "in": "query", - "description": "Whether to return all default setting for each of the indices.", + "description": "Indicate if an error should be returned if there is a partial search failure or timeout.", "schema": { "type": "boolean", - "default": false, - "description": "Whether to return all default setting for each of the indices." - } - } - ], - "responses": { - "200": { - "description": "IndicesGetSettings_WithIndex 200 response" - } - }, - "x-operation-group": "indices.get_settings", - "x-version-added": "1.0" - }, - "put": { - "description": "Updates the index settings.", - "operationId": "IndicesPutSettings_WithIndex", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IndicesPutSettings_BodyParams" - } + "default": true, + "description": "Indicate if an error should be returned if there is a partial search failure or timeout." } }, - "required": true - }, - "parameters": [ - { - "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 - }, { - "name": "master_timeout", + "name": "typed_keys", "in": "query", - "description": "Operation timeout for connection to master node.", + "description": "Specify whether aggregation and suggester names should be prefixed by their respective types in the response.", "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to master node.", - "x-version-deprecated": "2.0.0", - "x-data-type": "time", - "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", - "deprecated": true + "type": "boolean", + "description": "Specify whether aggregation and suggester names should be prefixed by their respective types in the response." } }, { - "name": "cluster_manager_timeout", + "name": "version", "in": "query", - "description": "Operation timeout for connection to cluster-manager node.", + "description": "Whether to return document version as part of a hit.", "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to cluster-manager node.", - "x-data-type": "time" + "type": "boolean", + "description": "Whether to return document version as part of a hit." } }, { - "name": "timeout", + "name": "seq_no_primary_term", "in": "query", - "description": "Operation timeout.", + "description": "Specify whether to return sequence number and primary term of the last modification of each hit.", "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout.", - "x-data-type": "time" + "type": "boolean", + "description": "Specify whether to return sequence number and primary term of the last modification of each hit." } }, { - "name": "preserve_existing", + "name": "request_cache", "in": "query", - "description": "Whether to update existing settings. If set to `true` existing settings on an index remain unchanged.", + "description": "Specify if request cache should be used for this request or not, defaults to index level setting.", "schema": { "type": "boolean", - "default": false, - "description": "Whether to update existing settings. If set to `true` existing settings on an index remain unchanged." + "description": "Specify if request cache should be used for this request or not, defaults to index level setting." } }, { - "name": "ignore_unavailable", + "name": "batched_reduce_size", "in": "query", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", + "description": "The number of shard results that should be reduced at once on the coordinating node. This value should be used as a protection mechanism to reduce the memory overhead per search request if the potential number of shards in the request can be large.", "schema": { - "type": "boolean", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." + "type": "integer", + "default": 512, + "description": "The number of shard results that should be reduced at once on the coordinating node. This value should be used as a protection mechanism to reduce the memory overhead per search request if the potential number of shards in the request can be large.", + "format": "int32" } }, { - "name": "allow_no_indices", + "name": "max_concurrent_shard_requests", "in": "query", - "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified).", + "description": "The number of concurrent shard requests per node this search executes concurrently. This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests.", "schema": { - "type": "boolean", - "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)." + "type": "integer", + "default": 5, + "description": "The number of concurrent shard requests per node this search executes concurrently. This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests.", + "format": "int32" } }, { - "name": "expand_wildcards", + "name": "pre_filter_shard_size", "in": "query", - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", + "description": "Threshold that enforces a pre-filter round-trip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter round-trip can limit the number of shards significantly if for instance a shard can not match any documents based on its rewrite method ie. if date filters are mandatory to match but the shard bounds and the query are disjoint.", "schema": { - "$ref": "#/components/schemas/ExpandWildcards" + "type": "integer", + "description": "Threshold that enforces a pre-filter round-trip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter round-trip can limit the number of shards significantly if for instance a shard can not match any documents based on its rewrite method ie. if date filters are mandatory to match but the shard bounds and the query are disjoint.", + "format": "int32" } }, { - "name": "flat_settings", + "name": "rest_total_hits_as_int", "in": "query", - "description": "Return settings in flat format.", + "description": "Indicates whether hits.total should be rendered as an integer or an object in the rest search response.", "schema": { "type": "boolean", "default": false, - "description": "Return settings in flat format." + "description": "Indicates whether hits.total should be rendered as an integer or an object in the rest search response." } } ], "responses": { "200": { - "description": "IndicesPutSettings_WithIndex 200 response" + "description": "Search_Get_WithIndex 200 response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Search_Get_WithIndexResponseContent" + } + } + } } }, - "x-operation-group": "indices.put_settings", + "x-operation-group": "search", "x-version-added": "1.0" - } - }, - "/{index}/_settings/{name}": { - "get": { - "description": "Returns settings for one or more indices.", - "operationId": "IndicesGetSettings_WithIndexName", - "parameters": [ - { - "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, - "examples": { - "IndicesGetSettings_WithIndexName_example1": { - "summary": "Examples for Get settings Index-setting Operation.", - "description": "", - "value": "books" + }, + "post": { + "description": "Returns results matching a query.", + "operationId": "Search_Post_WithIndex", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Search_BodyParams" + }, + "examples": { + "Search_Post_WithIndex_example1": { + "summary": "Examples for Post Search With Index Operation.", + "description": "", + "value": { + "query": { + "match_all": {} + }, + "fields": [ + "*" + ] + } + } } } - }, + } + }, + "parameters": [ { - "name": "name", + "name": "index", "in": "path", - "description": "Comma-separated list of settings.", + "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 settings.", + "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, "examples": { - "IndicesGetSettings_WithIndexName_example1": { - "summary": "Examples for Get settings Index-setting Operation.", + "Search_Post_WithIndex_example1": { + "summary": "Examples for Post Search With Index Operation.", "description": "", - "value": "index" + "value": "books" } } }, { - "name": "master_timeout", - "in": "query", - "description": "Operation timeout for connection to master node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to master node.", - "x-version-deprecated": "2.0.0", - "x-data-type": "time", - "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", - "deprecated": true - } - }, - { - "name": "cluster_manager_timeout", + "name": "analyzer", "in": "query", - "description": "Operation timeout for connection to cluster-manager node.", + "description": "The analyzer to use for the query string.", "schema": { "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to cluster-manager node.", - "x-data-type": "time" + "description": "The analyzer to use for the query string." } }, { - "name": "ignore_unavailable", + "name": "analyze_wildcard", "in": "query", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", + "description": "Specify whether wildcard and prefix queries should be analyzed.", "schema": { "type": "boolean", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." + "default": false, + "description": "Specify whether wildcard and prefix queries should be analyzed." } }, { - "name": "allow_no_indices", + "name": "ccs_minimize_roundtrips", "in": "query", - "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified).", + "description": "Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution.", "schema": { "type": "boolean", - "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)." + "default": true, + "description": "Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution." } }, { - "name": "expand_wildcards", + "name": "default_operator", "in": "query", - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", + "description": "The default operator for query string query (AND or OR).", "schema": { - "$ref": "#/components/schemas/ExpandWildcards" + "$ref": "#/components/schemas/DefaultOperator" } }, { - "name": "flat_settings", + "name": "df", "in": "query", - "description": "Return settings in flat format.", + "description": "The field to use as default where no field prefix is given in the query string.", "schema": { - "type": "boolean", - "default": false, - "description": "Return settings in flat format." + "type": "string", + "description": "The field to use as default where no field prefix is given in the query string." } }, { - "name": "local", + "name": "explain", "in": "query", - "description": "Return local information, do not retrieve the state from cluster-manager node.", + "description": "Specify whether to return detailed information about score computation as part of a hit.", "schema": { "type": "boolean", - "default": false, - "description": "Return local information, do not retrieve the state from cluster-manager node." + "description": "Specify whether to return detailed information about score computation as part of a hit." } }, { - "name": "include_defaults", + "name": "stored_fields", "in": "query", - "description": "Whether to return all default setting for each of the indices.", - "schema": { - "type": "boolean", - "default": false, - "description": "Whether to return all default setting for each of the indices." - } - } - ], - "responses": { - "200": { - "description": "IndicesGetSettings_WithIndexName 200 response" - } - }, - "x-operation-group": "indices.get_settings", - "x-version-added": "1.0" - } - }, - "/{index}/_shard_stores": { - "get": { - "description": "Provides store information for shard copies of indices.", - "operationId": "IndicesShardStores_WithIndex", - "parameters": [ - { - "name": "index", - "in": "path", - "description": "Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices.", + "description": "Comma-separated list of stored fields to return.", + "style": "form", "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" + "type": "array", + "items": { + "type": "string" + }, + "description": "Comma-separated list of stored fields to return." }, - "required": true + "explode": true }, { - "name": "status", + "name": "docvalue_fields", "in": "query", - "description": "Comma-separated list of statuses used to filter on shards to get store information for.", + "description": "Comma-separated list of fields to return as the docvalue representation of a field for each hit.", "style": "form", "schema": { "type": "array", "items": { - "$ref": "#/components/schemas/Status_Member" + "type": "string" }, - "description": "Comma-separated list of statuses used to filter on shards to get store information for." + "description": "Comma-separated list of fields to return as the docvalue representation of a field for each hit." }, "explode": true }, + { + "name": "from", + "in": "query", + "description": "Starting offset.", + "schema": { + "type": "integer", + "default": 0, + "description": "Starting offset.", + "format": "int32" + } + }, { "name": "ignore_unavailable", "in": "query", @@ -26056,6 +26109,15 @@ "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." } }, + { + "name": "ignore_throttled", + "in": "query", + "description": "Whether specified concrete, expanded or aliased indices should be ignored when throttled.", + "schema": { + "type": "boolean", + "description": "Whether specified concrete, expanded or aliased indices should be ignored when throttled." + } + }, { "name": "allow_no_indices", "in": "query", @@ -26072,302 +26134,99 @@ "schema": { "$ref": "#/components/schemas/ExpandWildcards" } - } - ], - "responses": { - "200": { - "description": "IndicesShardStores_WithIndex 200 response" - } - }, - "x-operation-group": "indices.shard_stores", - "x-version-added": "1.0" - } - }, - "/{index}/_shrink/{target}": { - "post": { - "description": "Allow to shrink an existing index into a new index with fewer primary shards.", - "operationId": "IndicesShrink_Post", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IndicesShrink_BodyParams" - } - } - } - }, - "parameters": [ - { - "name": "index", - "in": "path", - "description": "The name of the source index to shrink.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", - "description": "The name of the source index to shrink." - }, - "required": true - }, - { - "name": "target", - "in": "path", - "description": "The name of the target index.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", - "description": "The name of the target index." - }, - "required": true }, { - "name": "copy_settings", + "name": "lenient", "in": "query", - "description": "whether or not to copy settings from the source index.", + "description": "Specify whether format-based query failures (such as providing text to a numeric field) should be ignored.", "schema": { "type": "boolean", - "default": false, - "description": "whether or not to copy settings from the source index." + "description": "Specify whether format-based query failures (such as providing text to a numeric field) should be ignored." } }, { - "name": "timeout", + "name": "preference", "in": "query", - "description": "Operation timeout.", + "description": "Specify the node or shard the operation should be performed on.", "schema": { "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout.", - "x-data-type": "time" + "default": "random", + "description": "Specify the node or shard the operation should be performed on." } }, { - "name": "master_timeout", + "name": "q", "in": "query", - "description": "Operation timeout for connection to master node.", + "description": "Query in the Lucene query string syntax.", "schema": { "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to master node.", - "x-version-deprecated": "2.0.0", - "x-data-type": "time", - "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", - "deprecated": true + "description": "Query in the Lucene query string syntax." } }, { - "name": "cluster_manager_timeout", + "name": "routing", "in": "query", - "description": "Operation timeout for connection to cluster-manager node.", + "description": "Comma-separated list of specific routing values.", + "style": "form", "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to cluster-manager node.", - "x-data-type": "time" - } + "type": "array", + "items": { + "type": "string" + }, + "description": "Comma-separated list of specific routing values." + }, + "explode": true }, { - "name": "wait_for_active_shards", + "name": "scroll", "in": "query", - "description": "Set the number of active shards to wait for on the shrunken index before the operation returns.", - "schema": { - "type": "string", - "description": "Set the number of active shards to wait for on the shrunken index before the operation returns." - } - } - ], - "responses": { - "200": { - "description": "IndicesShrink_Post 200 response" - } - }, - "x-operation-group": "indices.shrink", - "x-version-added": "1.0" - }, - "put": { - "description": "Allow to shrink an existing index into a new index with fewer primary shards.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest" - }, - "operationId": "IndicesShrink_Put", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IndicesShrink_BodyParams" - } - } - } - }, - "parameters": [ - { - "name": "index", - "in": "path", - "description": "The name of the source index to shrink.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", - "description": "The name of the source index to shrink." - }, - "required": true - }, - { - "name": "target", - "in": "path", - "description": "The name of the target index.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", - "description": "The name of the target index." - }, - "required": true - }, - { - "name": "copy_settings", - "in": "query", - "description": "whether or not to copy settings from the source index.", - "schema": { - "type": "boolean", - "default": false, - "description": "whether or not to copy settings from the source index." - } - }, - { - "name": "timeout", - "in": "query", - "description": "Operation timeout.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout.", - "x-data-type": "time" - } - }, - { - "name": "master_timeout", - "in": "query", - "description": "Operation timeout for connection to master node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to master node.", - "x-version-deprecated": "2.0.0", - "x-data-type": "time", - "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", - "deprecated": true - } - }, - { - "name": "cluster_manager_timeout", - "in": "query", - "description": "Operation timeout for connection to cluster-manager node.", + "description": "Specify how long a consistent view of the index should be maintained for scrolled search.", "schema": { "type": "string", "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to cluster-manager node.", + "description": "Specify how long a consistent view of the index should be maintained for scrolled search.", "x-data-type": "time" - } - }, - { - "name": "wait_for_active_shards", - "in": "query", - "description": "Set the number of active shards to wait for on the shrunken index before the operation returns.", - "schema": { - "type": "string", - "description": "Set the number of active shards to wait for on the shrunken index before the operation returns." - } - } - ], - "responses": { - "200": { - "description": "IndicesShrink_Put 200 response" - } - }, - "x-operation-group": "indices.shrink", - "x-version-added": "1.0" - } - }, - "/{index}/_source/{id}": { - "get": { - "description": "Returns the source of a document.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/api-reference/document-apis/get-documents/" - }, - "operationId": "GetSource", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Document ID.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", - "description": "Document ID." - }, - "required": true, - "examples": { - "GetSource_example1": { - "summary": "Examples for Get document source Operation.", - "description": "", - "value": "1" - } - } - }, - { - "name": "index", - "in": "path", - "description": "Index name.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", - "description": "Index name." }, - "required": true, "examples": { - "GetSource_example1": { - "summary": "Examples for Get document source Operation.", + "Search_Post_WithIndex_example1": { + "summary": "Examples for Post Search With Index Operation.", "description": "", - "value": "books" + "value": "1d" } } }, { - "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." - } - }, - { - "name": "realtime", + "name": "search_type", "in": "query", - "description": "Specify whether to perform the operation in realtime or search mode.", + "description": "Search operation type.", "schema": { - "type": "boolean", - "description": "Specify whether to perform the operation in realtime or search mode." + "$ref": "#/components/schemas/SearchType" } }, { - "name": "refresh", + "name": "size", "in": "query", - "description": "Refresh the shard containing the document before performing the operation.", + "description": "Number of hits to return.", "schema": { - "type": "boolean", - "description": "Refresh the shard containing the document before performing the operation." + "type": "integer", + "default": 10, + "description": "Number of hits to return.", + "format": "int32" } }, { - "name": "routing", + "name": "sort", "in": "query", - "description": "Routing value.", + "description": "Comma-separated list of : pairs.", + "style": "form", "schema": { - "type": "string", - "description": "Routing value." - } + "type": "array", + "items": { + "type": "string" + }, + "description": "Comma-separated list of : pairs." + }, + "explode": true }, { "name": "_source", @@ -26412,377 +26271,313 @@ "explode": true }, { - "name": "version", + "name": "terminate_after", "in": "query", - "description": "Explicit version number for concurrency control.", + "description": "The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early.", "schema": { "type": "integer", - "description": "Explicit version number for concurrency control.", + "description": "The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early.", "format": "int32" } }, { - "name": "version_type", + "name": "stats", "in": "query", - "description": "Specific version type.", - "schema": { - "$ref": "#/components/schemas/VersionType" - } - } - ], - "responses": { - "200": { - "description": "GetSource 200 response" - } - }, - "x-operation-group": "get_source", - "x-version-added": "1.0" - }, - "head": { - "description": "Returns information about whether a document source exists in an index.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest" - }, - "operationId": "ExistsSource", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Document ID.", + "description": "Specific 'tag' of the request for logging and statistical purposes.", + "style": "form", "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", - "description": "Document ID." + "type": "array", + "items": { + "type": "string" + }, + "description": "Specific 'tag' of the request for logging and statistical purposes." }, - "required": true + "explode": true }, { - "name": "index", - "in": "path", - "description": "Index name.", + "name": "suggest_field", + "in": "query", + "description": "Specify which field to use for suggestions.", "schema": { "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", - "description": "Index name." - }, - "required": true + "description": "Specify which field to use for suggestions." + } }, { - "name": "preference", + "name": "suggest_mode", "in": "query", - "description": "Specify the node or shard the operation should be performed on.", + "description": "Specify suggest mode.", "schema": { - "type": "string", - "default": "random", - "description": "Specify the node or shard the operation should be performed on." + "$ref": "#/components/schemas/SuggestMode" } }, { - "name": "realtime", + "name": "suggest_size", "in": "query", - "description": "Specify whether to perform the operation in realtime or search mode.", + "description": "How many suggestions to return in response.", "schema": { - "type": "boolean", - "description": "Specify whether to perform the operation in realtime or search mode." + "type": "integer", + "description": "How many suggestions to return in response.", + "format": "int32" } }, { - "name": "refresh", + "name": "suggest_text", "in": "query", - "description": "Refresh the shard containing the document before performing the operation.", + "description": "The source text for which the suggestions should be returned.", "schema": { - "type": "boolean", - "description": "Refresh the shard containing the document before performing the operation." + "type": "string", + "description": "The source text for which the suggestions should be returned." } }, { - "name": "routing", + "name": "timeout", "in": "query", - "description": "Routing value.", + "description": "Operation timeout.", "schema": { "type": "string", - "description": "Routing value." + "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", + "description": "Operation timeout.", + "x-data-type": "time" } }, { - "name": "_source", + "name": "track_scores", "in": "query", - "description": "True or false to return the _source field or not, or a list of fields to return.", - "style": "form", + "description": "Whether to calculate and return scores even if they are not used for sorting.", "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "True or false to return the _source field or not, or a list of fields to return." - }, - "explode": true + "type": "boolean", + "description": "Whether to calculate and return scores even if they are not used for sorting." + } }, { - "name": "_source_excludes", + "name": "track_total_hits", "in": "query", - "description": "List of fields to exclude from the returned _source field.", - "style": "form", + "description": "Indicate if the number of documents that match the query should be tracked.", "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "List of fields to exclude from the returned _source field." - }, - "explode": true + "type": "boolean", + "description": "Indicate if the number of documents that match the query should be tracked." + } }, { - "name": "_source_includes", + "name": "allow_partial_search_results", "in": "query", - "description": "List of fields to extract and return from the _source field.", - "style": "form", + "description": "Indicate if an error should be returned if there is a partial search failure or timeout.", "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "List of fields to extract and return from the _source field." - }, - "explode": true + "type": "boolean", + "default": true, + "description": "Indicate if an error should be returned if there is a partial search failure or timeout." + } }, { - "name": "version", + "name": "typed_keys", "in": "query", - "description": "Explicit version number for concurrency control.", + "description": "Specify whether aggregation and suggester names should be prefixed by their respective types in the response.", "schema": { - "type": "integer", - "description": "Explicit version number for concurrency control.", - "format": "int32" + "type": "boolean", + "description": "Specify whether aggregation and suggester names should be prefixed by their respective types in the response." } }, { - "name": "version_type", + "name": "version", "in": "query", - "description": "Specific version type.", + "description": "Whether to return document version as part of a hit.", "schema": { - "$ref": "#/components/schemas/VersionType" - } - } - ], - "responses": { - "200": { - "description": "ExistsSource 200 response" - } - }, - "x-operation-group": "exists_source", - "x-version-added": "1.0" - } - }, - "/{index}/_split/{target}": { - "post": { - "description": "Allows you to split an existing index into a new index with more primary shards.", - "operationId": "IndicesSplit_Post", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IndicesSplit_BodyParams" - } + "type": "boolean", + "description": "Whether to return document version as part of a hit." } - } - }, - "parameters": [ - { - "name": "index", - "in": "path", - "description": "The name of the source index to split.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", - "description": "The name of the source index to split." - }, - "required": true }, { - "name": "target", - "in": "path", - "description": "The name of the target index.", + "name": "seq_no_primary_term", + "in": "query", + "description": "Specify whether to return sequence number and primary term of the last modification of each hit.", "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", - "description": "The name of the target index." - }, - "required": true + "type": "boolean", + "description": "Specify whether to return sequence number and primary term of the last modification of each hit." + } }, { - "name": "copy_settings", + "name": "request_cache", "in": "query", - "description": "whether or not to copy settings from the source index.", + "description": "Specify if request cache should be used for this request or not, defaults to index level setting.", "schema": { "type": "boolean", - "default": false, - "description": "whether or not to copy settings from the source index." + "description": "Specify if request cache should be used for this request or not, defaults to index level setting." } }, { - "name": "timeout", + "name": "batched_reduce_size", "in": "query", - "description": "Operation timeout.", + "description": "The number of shard results that should be reduced at once on the coordinating node. This value should be used as a protection mechanism to reduce the memory overhead per search request if the potential number of shards in the request can be large.", "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout.", - "x-data-type": "time" + "type": "integer", + "default": 512, + "description": "The number of shard results that should be reduced at once on the coordinating node. This value should be used as a protection mechanism to reduce the memory overhead per search request if the potential number of shards in the request can be large.", + "format": "int32" } }, { - "name": "master_timeout", + "name": "max_concurrent_shard_requests", "in": "query", - "description": "Operation timeout for connection to master node.", + "description": "The number of concurrent shard requests per node this search executes concurrently. This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests.", "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to master node.", - "x-version-deprecated": "2.0.0", - "x-data-type": "time", - "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", - "deprecated": true + "type": "integer", + "default": 5, + "description": "The number of concurrent shard requests per node this search executes concurrently. This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests.", + "format": "int32" } }, { - "name": "cluster_manager_timeout", + "name": "pre_filter_shard_size", "in": "query", - "description": "Operation timeout for connection to cluster-manager node.", + "description": "Threshold that enforces a pre-filter round-trip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter round-trip can limit the number of shards significantly if for instance a shard can not match any documents based on its rewrite method ie. if date filters are mandatory to match but the shard bounds and the query are disjoint.", "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to cluster-manager node.", - "x-data-type": "time" + "type": "integer", + "description": "Threshold that enforces a pre-filter round-trip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter round-trip can limit the number of shards significantly if for instance a shard can not match any documents based on its rewrite method ie. if date filters are mandatory to match but the shard bounds and the query are disjoint.", + "format": "int32" } }, { - "name": "wait_for_active_shards", + "name": "rest_total_hits_as_int", "in": "query", - "description": "Set the number of active shards to wait for on the shrunken index before the operation returns.", + "description": "Indicates whether hits.total should be rendered as an integer or an object in the rest search response.", "schema": { - "type": "string", - "description": "Set the number of active shards to wait for on the shrunken index before the operation returns." + "type": "boolean", + "default": false, + "description": "Indicates whether hits.total should be rendered as an integer or an object in the rest search response." } } ], "responses": { "200": { - "description": "IndicesSplit_Post 200 response" + "description": "Search_Post_WithIndex 200 response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Search_Post_WithIndexResponseContent" + }, + "examples": { + "Search_Post_WithIndex_example1": { + "summary": "Examples for Post Search With Index Operation.", + "description": "", + "value": { + "timed_out": false, + "_shards": { + "total": 1, + "successful": 1, + "skipped": 0, + "failed": 0 + }, + "hits": { + "total": { + "value": 0, + "relation": "eq" + }, + "hits": [] + } + } + } + } + } + } } }, - "x-operation-group": "indices.split", + "x-operation-group": "search", "x-version-added": "1.0" - }, - "put": { - "description": "Allows you to split an existing index into a new index with more primary shards.", + } + }, + "/{index}/_search/point_in_time": { + "post": { + "description": "Creates point in time context.", "externalDocs": { "description": "API Reference", - "url": "https://opensearch.org/docs/latest" - }, - "operationId": "IndicesSplit_Put", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IndicesSplit_BodyParams" - } - } - } + "url": "https://opensearch.org/docs/latest/search-plugins/point-in-time-api/#create-a-pit" }, + "operationId": "CreatePit", "parameters": [ { "name": "index", "in": "path", - "description": "The name of the source index to split.", + "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": "The name of the source index to split." + "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 }, { - "name": "target", - "in": "path", - "description": "The name of the target index.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", - "description": "The name of the target index." - }, - "required": true - }, - { - "name": "copy_settings", + "name": "allow_partial_pit_creation", "in": "query", - "description": "whether or not to copy settings from the source index.", + "description": "Allow if point in time can be created with partial failures.", "schema": { "type": "boolean", - "default": false, - "description": "whether or not to copy settings from the source index." + "description": "Allow if point in time can be created with partial failures." } }, { - "name": "timeout", + "name": "keep_alive", "in": "query", - "description": "Operation timeout.", + "description": "Specify the keep alive for point in time.", "schema": { "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout.", - "x-data-type": "time" + "description": "Specify the keep alive for point in time." } }, { - "name": "master_timeout", + "name": "preference", "in": "query", - "description": "Operation timeout for connection to master node.", + "description": "Specify the node or shard the operation should be performed on.", "schema": { "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to master node.", - "x-version-deprecated": "2.0.0", - "x-data-type": "time", - "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", - "deprecated": true + "default": "random", + "description": "Specify the node or shard the operation should be performed on." } }, { - "name": "cluster_manager_timeout", + "name": "routing", "in": "query", - "description": "Operation timeout for connection to cluster-manager node.", + "description": "Comma-separated list of specific routing values.", + "style": "form", "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to cluster-manager node.", - "x-data-type": "time" - } + "type": "array", + "items": { + "type": "string" + }, + "description": "Comma-separated list of specific routing values." + }, + "explode": true }, { - "name": "wait_for_active_shards", + "name": "expand_wildcards", "in": "query", - "description": "Set the number of active shards to wait for on the shrunken index before the operation returns.", + "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", "schema": { - "type": "string", - "description": "Set the number of active shards to wait for on the shrunken index before the operation returns." + "$ref": "#/components/schemas/ExpandWildcards" } } ], "responses": { "200": { - "description": "IndicesSplit_Put 200 response" + "description": "CreatePit 200 response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreatePitResponseContent" + } + } + } } }, - "x-operation-group": "indices.split", - "x-version-added": "1.0" + "x-operation-group": "create_pit", + "x-version-added": "2.4" } }, - "/{index}/_stats": { + "/{index}/_search/template": { "get": { - "description": "Provides statistics on operations happening in an index.", - "operationId": "IndicesStats_WithIndex", + "description": "Allows to use the Mustache language to pre-render a search definition.", + "operationId": "SearchTemplate_Get_WithIndex", "parameters": [ { "name": "index", @@ -26790,128 +26585,159 @@ "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)", + "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 }, { - "name": "completion_fields", + "name": "ignore_unavailable", "in": "query", - "description": "Comma-separated list of fields for `fielddata` and `suggest` index metric (supports wildcards).", - "style": "form", + "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of fields for `fielddata` and `suggest` index metric (supports wildcards)." - }, - "explode": true + "type": "boolean", + "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." + } }, { - "name": "fielddata_fields", + "name": "ignore_throttled", "in": "query", - "description": "Comma-separated list of fields for `fielddata` index metric (supports wildcards).", - "style": "form", + "description": "Whether specified concrete, expanded or aliased indices should be ignored when throttled.", "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of fields for `fielddata` index metric (supports wildcards)." - }, - "explode": true + "type": "boolean", + "description": "Whether specified concrete, expanded or aliased indices should be ignored when throttled." + } }, { - "name": "fields", + "name": "allow_no_indices", "in": "query", - "description": "Comma-separated list of fields for `fielddata` and `completion` index metric (supports wildcards).", - "style": "form", + "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified).", "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of fields for `fielddata` and `completion` index metric (supports wildcards)." - }, - "explode": true + "type": "boolean", + "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)." + } }, { - "name": "groups", + "name": "expand_wildcards", "in": "query", - "description": "Comma-separated list of search groups for `search` index metric.", + "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", + "schema": { + "$ref": "#/components/schemas/ExpandWildcards" + } + }, + { + "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." + } + }, + { + "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 search groups for `search` index metric." + "description": "Comma-separated list of specific routing values." }, "explode": true }, { - "name": "level", + "name": "scroll", "in": "query", - "description": "Return stats aggregated at cluster, index or shard level.", + "description": "Specify how long a consistent view of the index should be maintained for scrolled search.", "schema": { - "$ref": "#/components/schemas/IndiciesStatLevel" + "type": "string", + "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", + "description": "Specify how long a consistent view of the index should be maintained for scrolled search.", + "x-data-type": "time" } }, { - "name": "include_segment_file_sizes", + "name": "search_type", "in": "query", - "description": "Whether to report the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested).", + "description": "Search operation type.", + "schema": { + "$ref": "#/components/schemas/SearchTypeMulti" + } + }, + { + "name": "explain", + "in": "query", + "description": "Specify whether to return detailed information about score computation as part of a hit.", "schema": { "type": "boolean", - "default": false, - "description": "Whether to report the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested)." + "description": "Specify whether to return detailed information about score computation as part of a hit." } }, { - "name": "include_unloaded_segments", + "name": "profile", "in": "query", - "description": "If set to true segment stats will include stats for segments that are not currently loaded into memory.", + "description": "Specify whether to profile the query execution.", "schema": { "type": "boolean", - "default": false, - "description": "If set to true segment stats will include stats for segments that are not currently loaded into memory." + "description": "Specify whether to profile the query execution." } }, { - "name": "expand_wildcards", + "name": "typed_keys", "in": "query", - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", + "description": "Specify whether aggregation and suggester names should be prefixed by their respective types in the response.", "schema": { - "$ref": "#/components/schemas/ExpandWildcards" + "type": "boolean", + "description": "Specify whether aggregation and suggester names should be prefixed by their respective types in the response." } }, { - "name": "forbid_closed_indices", + "name": "rest_total_hits_as_int", "in": "query", - "description": "If set to false stats will also collected from closed indices if explicitly specified or if expand_wildcards expands to closed indices.", + "description": "Indicates whether hits.total should be rendered as an integer or an object in the rest search response.", + "schema": { + "type": "boolean", + "default": false, + "description": "Indicates whether hits.total should be rendered as an integer or an object in the rest search response." + } + }, + { + "name": "ccs_minimize_roundtrips", + "in": "query", + "description": "Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution.", "schema": { "type": "boolean", "default": true, - "description": "If set to false stats will also collected from closed indices if explicitly specified or if expand_wildcards expands to closed indices." + "description": "Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution." } } ], "responses": { "200": { - "description": "IndicesStats_WithIndex 200 response" + "description": "SearchTemplate_Get_WithIndex 200 response" } }, - "x-operation-group": "indices.stats", + "x-operation-group": "search_template", "x-version-added": "1.0" - } - }, - "/{index}/_stats/{metric}": { - "get": { - "description": "Provides statistics on operations happening in an index.", - "operationId": "IndicesStats_WithIndexMetric", + }, + "post": { + "description": "Allows to use the Mustache language to pre-render a search definition.", + "operationId": "SearchTemplate_Post_WithIndex", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SearchTemplate_BodyParams" + } + } + }, + "required": true + }, "parameters": [ { "name": "index", @@ -26919,237 +26745,243 @@ "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)", + "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 }, { - "name": "metric", - "in": "path", - "description": "Limit the information returned the specific metrics.", + "name": "ignore_unavailable", + "in": "query", + "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", - "description": "Limit the information returned the specific metrics.", - "x-enum-options": [ - "_all", - "completion", - "docs", - "fielddata", - "query_cache", - "flush", - "get", - "indexing", - "merge", - "request_cache", - "refresh", - "search", - "segments", - "store", - "warmer", - "suggest" - ], - "x-data-type": "array" - }, - "required": true + "type": "boolean", + "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." + } }, { - "name": "completion_fields", + "name": "ignore_throttled", "in": "query", - "description": "Comma-separated list of fields for `fielddata` and `suggest` index metric (supports wildcards).", - "style": "form", + "description": "Whether specified concrete, expanded or aliased indices should be ignored when throttled.", "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of fields for `fielddata` and `suggest` index metric (supports wildcards)." - }, - "explode": true + "type": "boolean", + "description": "Whether specified concrete, expanded or aliased indices should be ignored when throttled." + } }, { - "name": "fielddata_fields", + "name": "allow_no_indices", "in": "query", - "description": "Comma-separated list of fields for `fielddata` index metric (supports wildcards).", - "style": "form", + "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified).", "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of fields for `fielddata` index metric (supports wildcards)." - }, - "explode": true + "type": "boolean", + "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)." + } }, { - "name": "fields", + "name": "expand_wildcards", "in": "query", - "description": "Comma-separated list of fields for `fielddata` and `completion` index metric (supports wildcards).", - "style": "form", + "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of fields for `fielddata` and `completion` index metric (supports wildcards)." - }, - "explode": true + "$ref": "#/components/schemas/ExpandWildcards" + } }, { - "name": "groups", + "name": "preference", "in": "query", - "description": "Comma-separated list of search groups for `search` index metric.", + "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." + } + }, + { + "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 search groups for `search` index metric." + "description": "Comma-separated list of specific routing values." }, "explode": true }, { - "name": "level", + "name": "scroll", "in": "query", - "description": "Return stats aggregated at cluster, index or shard level.", + "description": "Specify how long a consistent view of the index should be maintained for scrolled search.", "schema": { - "$ref": "#/components/schemas/IndiciesStatLevel" + "type": "string", + "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", + "description": "Specify how long a consistent view of the index should be maintained for scrolled search.", + "x-data-type": "time" } }, { - "name": "include_segment_file_sizes", + "name": "search_type", "in": "query", - "description": "Whether to report the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested).", + "description": "Search operation type.", + "schema": { + "$ref": "#/components/schemas/SearchTypeMulti" + } + }, + { + "name": "explain", + "in": "query", + "description": "Specify whether to return detailed information about score computation as part of a hit.", "schema": { "type": "boolean", - "default": false, - "description": "Whether to report the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested)." + "description": "Specify whether to return detailed information about score computation as part of a hit." } }, { - "name": "include_unloaded_segments", + "name": "profile", "in": "query", - "description": "If set to true segment stats will include stats for segments that are not currently loaded into memory.", + "description": "Specify whether to profile the query execution.", "schema": { "type": "boolean", - "default": false, - "description": "If set to true segment stats will include stats for segments that are not currently loaded into memory." + "description": "Specify whether to profile the query execution." } }, { - "name": "expand_wildcards", + "name": "typed_keys", "in": "query", - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", + "description": "Specify whether aggregation and suggester names should be prefixed by their respective types in the response.", "schema": { - "$ref": "#/components/schemas/ExpandWildcards" + "type": "boolean", + "description": "Specify whether aggregation and suggester names should be prefixed by their respective types in the response." } }, { - "name": "forbid_closed_indices", + "name": "rest_total_hits_as_int", "in": "query", - "description": "If set to false stats will also collected from closed indices if explicitly specified or if expand_wildcards expands to closed indices.", + "description": "Indicates whether hits.total should be rendered as an integer or an object in the rest search response.", + "schema": { + "type": "boolean", + "default": false, + "description": "Indicates whether hits.total should be rendered as an integer or an object in the rest search response." + } + }, + { + "name": "ccs_minimize_roundtrips", + "in": "query", + "description": "Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution.", "schema": { "type": "boolean", "default": true, - "description": "If set to false stats will also collected from closed indices if explicitly specified or if expand_wildcards expands to closed indices." + "description": "Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution." } } ], "responses": { "200": { - "description": "IndicesStats_WithIndexMetric 200 response" + "description": "SearchTemplate_Post_WithIndex 200 response" } }, - "x-operation-group": "indices.stats", + "x-operation-group": "search_template", "x-version-added": "1.0" } }, - "/{index}/_termvectors": { + "/{index}/_search_shards": { "get": { - "description": "Returns information and statistics about terms in the fields of a particular document.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest" - }, - "operationId": "Termvectors_Get", + "description": "Returns information about the indices and shards that a search request would be executed against.", + "operationId": "SearchShards_Get_WithIndex", "parameters": [ { "name": "index", "in": "path", - "description": "The index in which the document resides.", + "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": "The index in which the document resides." + "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 }, { - "name": "term_statistics", + "name": "preference", "in": "query", - "description": "Specifies if total term frequency and document frequency should be returned.", + "description": "Specify the node or shard the operation should be performed on.", "schema": { - "type": "boolean", - "default": false, - "description": "Specifies if total term frequency and document frequency should be returned." + "type": "string", + "default": "random", + "description": "Specify the node or shard the operation should be performed on." } }, { - "name": "field_statistics", + "name": "routing", "in": "query", - "description": "Specifies if document count, sum of document frequencies and sum of total term frequencies should be returned.", + "description": "Routing value.", "schema": { - "type": "boolean", - "default": true, - "description": "Specifies if document count, sum of document frequencies and sum of total term frequencies should be returned." + "type": "string", + "description": "Routing value." } }, { - "name": "fields", + "name": "local", "in": "query", - "description": "Comma-separated list of fields to return.", - "style": "form", + "description": "Return local information, do not retrieve the state from cluster-manager node.", "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of fields to return." - }, - "explode": true + "type": "boolean", + "default": false, + "description": "Return local information, do not retrieve the state from cluster-manager node." + } }, { - "name": "offsets", + "name": "ignore_unavailable", "in": "query", - "description": "Specifies if term offsets should be returned.", + "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", "schema": { "type": "boolean", - "default": true, - "description": "Specifies if term offsets should be returned." + "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." } }, { - "name": "positions", + "name": "allow_no_indices", "in": "query", - "description": "Specifies if term positions should be returned.", + "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified).", "schema": { "type": "boolean", - "default": true, - "description": "Specifies if term positions should be returned." + "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)." } }, { - "name": "payloads", + "name": "expand_wildcards", "in": "query", - "description": "Specifies if term payloads should be returned.", + "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", "schema": { - "type": "boolean", - "default": true, - "description": "Specifies if term payloads should be returned." + "$ref": "#/components/schemas/ExpandWildcards" } + } + ], + "responses": { + "200": { + "description": "SearchShards_Get_WithIndex 200 response" + } + }, + "x-operation-group": "search_shards", + "x-version-added": "1.0" + }, + "post": { + "description": "Returns information about the indices and shards that a search request would be executed against.", + "operationId": "SearchShards_Post_WithIndex", + "parameters": [ + { + "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 }, { "name": "preference", @@ -27171,619 +27003,694 @@ } }, { - "name": "realtime", + "name": "local", "in": "query", - "description": "Specifies if request is real-time as opposed to near-real-time.", + "description": "Return local information, do not retrieve the state from cluster-manager node.", "schema": { "type": "boolean", - "default": true, - "description": "Specifies if request is real-time as opposed to near-real-time." + "default": false, + "description": "Return local information, do not retrieve the state from cluster-manager node." } }, { - "name": "version", + "name": "ignore_unavailable", "in": "query", - "description": "Explicit version number for concurrency control.", + "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", "schema": { - "type": "integer", - "description": "Explicit version number for concurrency control.", - "format": "int32" + "type": "boolean", + "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." } }, { - "name": "version_type", + "name": "allow_no_indices", "in": "query", - "description": "Specific version type.", + "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified).", "schema": { - "$ref": "#/components/schemas/VersionType" + "type": "boolean", + "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)." + } + }, + { + "name": "expand_wildcards", + "in": "query", + "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", + "schema": { + "$ref": "#/components/schemas/ExpandWildcards" } } ], "responses": { "200": { - "description": "Termvectors_Get 200 response" + "description": "SearchShards_Post_WithIndex 200 response" } }, - "x-operation-group": "termvectors", + "x-operation-group": "search_shards", "x-version-added": "1.0" - }, - "post": { - "description": "Returns information and statistics about terms in the fields of a particular document.", - "operationId": "Termvectors_Post", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Termvectors_BodyParams" - } - } - } - }, + } + }, + "/{index}/_segments": { + "get": { + "description": "Provides low-level information about segments in a Lucene index.", + "operationId": "IndicesSegments_WithIndex", "parameters": [ { "name": "index", "in": "path", - "description": "The index in which the document resides.", + "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": "The index in which the document resides." + "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 }, { - "name": "term_statistics", + "name": "ignore_unavailable", "in": "query", - "description": "Specifies if total term frequency and document frequency should be returned.", + "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", "schema": { "type": "boolean", - "default": false, - "description": "Specifies if total term frequency and document frequency should be returned." + "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." } }, { - "name": "field_statistics", + "name": "allow_no_indices", "in": "query", - "description": "Specifies if document count, sum of document frequencies and sum of total term frequencies should be returned.", + "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified).", "schema": { "type": "boolean", - "default": true, - "description": "Specifies if document count, sum of document frequencies and sum of total term frequencies should be returned." + "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)." } }, { - "name": "fields", + "name": "expand_wildcards", "in": "query", - "description": "Comma-separated list of fields to return.", - "style": "form", + "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of fields to return." - }, - "explode": true + "$ref": "#/components/schemas/ExpandWildcards" + } }, { - "name": "offsets", + "name": "verbose", "in": "query", - "description": "Specifies if term offsets should be returned.", + "description": "Includes detailed memory usage by Lucene.", "schema": { "type": "boolean", - "default": true, - "description": "Specifies if term offsets should be returned." + "default": false, + "description": "Includes detailed memory usage by Lucene." + } + } + ], + "responses": { + "200": { + "description": "IndicesSegments_WithIndex 200 response" + } + }, + "x-operation-group": "indices.segments", + "x-version-added": "1.0" + } + }, + "/{index}/_settings": { + "get": { + "description": "Returns settings for one or more indices.", + "operationId": "IndicesGetSettings_WithIndex", + "parameters": [ + { + "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, + "examples": { + "IndicesGetSettings_WithIndex_example1": { + "summary": "Examples for Get settings Index Operation.", + "description": "", + "value": "books" + } } }, { - "name": "positions", + "name": "master_timeout", "in": "query", - "description": "Specifies if term positions should be returned.", + "description": "Operation timeout for connection to master node.", "schema": { - "type": "boolean", - "default": true, - "description": "Specifies if term positions should be returned." + "type": "string", + "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", + "description": "Operation timeout for connection to master node.", + "x-version-deprecated": "2.0.0", + "x-data-type": "time", + "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", + "deprecated": true } }, { - "name": "payloads", + "name": "cluster_manager_timeout", "in": "query", - "description": "Specifies if term payloads should be returned.", + "description": "Operation timeout for connection to cluster-manager node.", + "schema": { + "type": "string", + "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", + "description": "Operation timeout for connection to cluster-manager node.", + "x-data-type": "time" + } + }, + { + "name": "ignore_unavailable", + "in": "query", + "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", "schema": { "type": "boolean", - "default": true, - "description": "Specifies if term payloads should be returned." + "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." } }, { - "name": "preference", + "name": "allow_no_indices", "in": "query", - "description": "Specify the node or shard the operation should be performed on.", + "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified).", "schema": { - "type": "string", - "default": "random", - "description": "Specify the node or shard the operation should be performed on." + "type": "boolean", + "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)." } }, { - "name": "routing", + "name": "expand_wildcards", "in": "query", - "description": "Routing value.", + "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", "schema": { - "type": "string", - "description": "Routing value." + "$ref": "#/components/schemas/ExpandWildcards" } }, { - "name": "realtime", + "name": "flat_settings", "in": "query", - "description": "Specifies if request is real-time as opposed to near-real-time.", + "description": "Return settings in flat format.", "schema": { "type": "boolean", - "default": true, - "description": "Specifies if request is real-time as opposed to near-real-time." + "default": false, + "description": "Return settings in flat format." } }, { - "name": "version", + "name": "local", "in": "query", - "description": "Explicit version number for concurrency control.", + "description": "Return local information, do not retrieve the state from cluster-manager node.", "schema": { - "type": "integer", - "description": "Explicit version number for concurrency control.", - "format": "int32" + "type": "boolean", + "default": false, + "description": "Return local information, do not retrieve the state from cluster-manager node." } }, { - "name": "version_type", + "name": "include_defaults", "in": "query", - "description": "Specific version type.", + "description": "Whether to return all default setting for each of the indices.", "schema": { - "$ref": "#/components/schemas/VersionType" + "type": "boolean", + "default": false, + "description": "Whether to return all default setting for each of the indices." } } ], "responses": { "200": { - "description": "Termvectors_Post 200 response" + "description": "IndicesGetSettings_WithIndex 200 response" } }, - "x-operation-group": "termvectors", + "x-operation-group": "indices.get_settings", "x-version-added": "1.0" - } - }, - "/{index}/_termvectors/{id}": { - "get": { - "description": "Returns information and statistics about terms in the fields of a particular document.", - "operationId": "Termvectors_Get_WithId", + }, + "put": { + "description": "Updates the index settings.", + "operationId": "IndicesPutSettings_WithIndex", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IndicesPutSettings_BodyParams" + } + } + }, + "required": true + }, "parameters": [ { "name": "index", "in": "path", - "description": "The index in which the document resides.", + "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": "The index in which the document resides." + "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 }, { - "name": "id", - "in": "path", - "description": "Document ID. When not specified a doc param should be supplied.", + "name": "master_timeout", + "in": "query", + "description": "Operation timeout for connection to master node.", "schema": { "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", - "description": "Document ID. When not specified a doc param should be supplied." - }, - "required": true + "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", + "description": "Operation timeout for connection to master node.", + "x-version-deprecated": "2.0.0", + "x-data-type": "time", + "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", + "deprecated": true + } }, { - "name": "term_statistics", + "name": "cluster_manager_timeout", "in": "query", - "description": "Specifies if total term frequency and document frequency should be returned.", + "description": "Operation timeout for connection to cluster-manager node.", "schema": { - "type": "boolean", - "default": false, - "description": "Specifies if total term frequency and document frequency should be returned." + "type": "string", + "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", + "description": "Operation timeout for connection to cluster-manager node.", + "x-data-type": "time" } }, { - "name": "field_statistics", + "name": "timeout", "in": "query", - "description": "Specifies if document count, sum of document frequencies and sum of total term frequencies should be returned.", + "description": "Operation timeout.", "schema": { - "type": "boolean", - "default": true, - "description": "Specifies if document count, sum of document frequencies and sum of total term frequencies should be returned." + "type": "string", + "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", + "description": "Operation timeout.", + "x-data-type": "time" } }, { - "name": "fields", + "name": "preserve_existing", "in": "query", - "description": "Comma-separated list of fields to return.", - "style": "form", + "description": "Whether to update existing settings. If set to `true` existing settings on an index remain unchanged.", "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of fields to return." - }, - "explode": true + "type": "boolean", + "default": false, + "description": "Whether to update existing settings. If set to `true` existing settings on an index remain unchanged." + } }, { - "name": "offsets", + "name": "ignore_unavailable", "in": "query", - "description": "Specifies if term offsets should be returned.", + "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", "schema": { "type": "boolean", - "default": true, - "description": "Specifies if term offsets should be returned." + "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." } }, { - "name": "positions", + "name": "allow_no_indices", "in": "query", - "description": "Specifies if term positions should be returned.", + "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified).", "schema": { "type": "boolean", - "default": true, - "description": "Specifies if term positions should be returned." + "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)." } }, { - "name": "payloads", + "name": "expand_wildcards", "in": "query", - "description": "Specifies if term payloads should be returned.", - "schema": { - "type": "boolean", - "default": true, - "description": "Specifies if term payloads should be returned." - } - }, - { - "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." - } - }, - { - "name": "routing", - "in": "query", - "description": "Routing value.", + "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", "schema": { - "type": "string", - "description": "Routing value." + "$ref": "#/components/schemas/ExpandWildcards" } }, { - "name": "realtime", + "name": "flat_settings", "in": "query", - "description": "Specifies if request is real-time as opposed to near-real-time.", + "description": "Return settings in flat format.", "schema": { "type": "boolean", - "default": true, - "description": "Specifies if request is real-time as opposed to near-real-time." - } - }, - { - "name": "version", - "in": "query", - "description": "Explicit version number for concurrency control.", - "schema": { - "type": "integer", - "description": "Explicit version number for concurrency control.", - "format": "int32" - } - }, - { - "name": "version_type", - "in": "query", - "description": "Specific version type.", - "schema": { - "$ref": "#/components/schemas/VersionType" + "default": false, + "description": "Return settings in flat format." } } ], "responses": { "200": { - "description": "Termvectors_Get_WithId 200 response" + "description": "IndicesPutSettings_WithIndex 200 response" } }, - "x-operation-group": "termvectors", + "x-operation-group": "indices.put_settings", "x-version-added": "1.0" - }, - "post": { - "description": "Returns information and statistics about terms in the fields of a particular document.", - "operationId": "Termvectors_Post_WithId", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Termvectors_BodyParams" - } - } - } - }, + } + }, + "/{index}/_settings/{name}": { + "get": { + "description": "Returns settings for one or more indices.", + "operationId": "IndicesGetSettings_WithIndexName", "parameters": [ { "name": "index", "in": "path", - "description": "The index in which the document resides.", + "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": "The index in which the document resides." + "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 + "required": true, + "examples": { + "IndicesGetSettings_WithIndexName_example1": { + "summary": "Examples for Get settings Index-setting Operation.", + "description": "", + "value": "books" + } + } }, { - "name": "id", + "name": "name", "in": "path", - "description": "Document ID. When not specified a doc param should be supplied.", + "description": "Comma-separated list of settings.", "schema": { "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", - "description": "Document ID. When not specified a doc param should be supplied." + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", + "description": "Comma-separated list of settings.", + "x-data-type": "array" }, - "required": true + "required": true, + "examples": { + "IndicesGetSettings_WithIndexName_example1": { + "summary": "Examples for Get settings Index-setting Operation.", + "description": "", + "value": "index" + } + } }, { - "name": "term_statistics", + "name": "master_timeout", "in": "query", - "description": "Specifies if total term frequency and document frequency should be returned.", + "description": "Operation timeout for connection to master node.", "schema": { - "type": "boolean", - "default": false, - "description": "Specifies if total term frequency and document frequency should be returned." + "type": "string", + "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", + "description": "Operation timeout for connection to master node.", + "x-version-deprecated": "2.0.0", + "x-data-type": "time", + "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", + "deprecated": true } }, { - "name": "field_statistics", + "name": "cluster_manager_timeout", "in": "query", - "description": "Specifies if document count, sum of document frequencies and sum of total term frequencies should be returned.", + "description": "Operation timeout for connection to cluster-manager node.", "schema": { - "type": "boolean", - "default": true, - "description": "Specifies if document count, sum of document frequencies and sum of total term frequencies should be returned." + "type": "string", + "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", + "description": "Operation timeout for connection to cluster-manager node.", + "x-data-type": "time" } }, { - "name": "fields", + "name": "ignore_unavailable", "in": "query", - "description": "Comma-separated list of fields to return.", - "style": "form", + "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of fields to return." - }, - "explode": true + "type": "boolean", + "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." + } }, { - "name": "offsets", + "name": "allow_no_indices", "in": "query", - "description": "Specifies if term offsets should be returned.", + "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified).", "schema": { "type": "boolean", - "default": true, - "description": "Specifies if term offsets should be returned." + "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)." } }, { - "name": "positions", + "name": "expand_wildcards", "in": "query", - "description": "Specifies if term positions should be returned.", + "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", "schema": { - "type": "boolean", - "default": true, - "description": "Specifies if term positions should be returned." + "$ref": "#/components/schemas/ExpandWildcards" } }, { - "name": "payloads", + "name": "flat_settings", "in": "query", - "description": "Specifies if term payloads should be returned.", + "description": "Return settings in flat format.", "schema": { "type": "boolean", - "default": true, - "description": "Specifies if term payloads should be returned." + "default": false, + "description": "Return settings in flat format." } }, { - "name": "preference", + "name": "local", "in": "query", - "description": "Specify the node or shard the operation should be performed on.", + "description": "Return local information, do not retrieve the state from cluster-manager node.", "schema": { - "type": "string", - "default": "random", - "description": "Specify the node or shard the operation should be performed on." + "type": "boolean", + "default": false, + "description": "Return local information, do not retrieve the state from cluster-manager node." } }, { - "name": "routing", + "name": "include_defaults", "in": "query", - "description": "Routing value.", + "description": "Whether to return all default setting for each of the indices.", "schema": { - "type": "string", - "description": "Routing value." + "type": "boolean", + "default": false, + "description": "Whether to return all default setting for each of the indices." } + } + ], + "responses": { + "200": { + "description": "IndicesGetSettings_WithIndexName 200 response" + } + }, + "x-operation-group": "indices.get_settings", + "x-version-added": "1.0" + } + }, + "/{index}/_shard_stores": { + "get": { + "description": "Provides store information for shard copies of indices.", + "operationId": "IndicesShardStores_WithIndex", + "parameters": [ + { + "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 }, { - "name": "realtime", + "name": "status", "in": "query", - "description": "Specifies if request is real-time as opposed to near-real-time.", + "description": "Comma-separated list of statuses used to filter on shards to get store information for.", + "style": "form", + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Status_Member" + }, + "description": "Comma-separated list of statuses used to filter on shards to get store information for." + }, + "explode": true + }, + { + "name": "ignore_unavailable", + "in": "query", + "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", "schema": { "type": "boolean", - "default": true, - "description": "Specifies if request is real-time as opposed to near-real-time." + "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." } }, { - "name": "version", + "name": "allow_no_indices", "in": "query", - "description": "Explicit version number for concurrency control.", + "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified).", "schema": { - "type": "integer", - "description": "Explicit version number for concurrency control.", - "format": "int32" + "type": "boolean", + "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)." } }, { - "name": "version_type", + "name": "expand_wildcards", "in": "query", - "description": "Specific version type.", + "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", "schema": { - "$ref": "#/components/schemas/VersionType" + "$ref": "#/components/schemas/ExpandWildcards" } } ], "responses": { "200": { - "description": "Termvectors_Post_WithId 200 response" + "description": "IndicesShardStores_WithIndex 200 response" } }, - "x-operation-group": "termvectors", + "x-operation-group": "indices.shard_stores", "x-version-added": "1.0" } }, - "/{index}/_update/{id}": { + "/{index}/_shrink/{target}": { "post": { - "description": "Updates a document with a script or partial document.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest" - }, - "operationId": "Update", + "description": "Allow to shrink an existing index into a new index with fewer primary shards.", + "operationId": "IndicesShrink_Post", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Update_BodyParams" + "$ref": "#/components/schemas/IndicesShrink_BodyParams" } } - }, - "required": true + } }, "parameters": [ { - "name": "id", + "name": "index", "in": "path", - "description": "Document ID.", + "description": "The name of the source index to shrink.", "schema": { "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", - "description": "Document ID." + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", + "description": "The name of the source index to shrink." }, "required": true }, { - "name": "index", + "name": "target", "in": "path", - "description": "Index name.", + "description": "The name of the target index.", "schema": { "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)", - "description": "Index name." + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", + "description": "The name of the target index." }, "required": true }, { - "name": "wait_for_active_shards", + "name": "copy_settings", "in": "query", - "description": "Sets the number of shard copies that must be active before proceeding with the operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1).", + "description": "whether or not to copy settings from the source index.", "schema": { - "type": "string", - "default": "1", - "description": "Sets the number of shard copies that must be active before proceeding with the operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1)." + "type": "boolean", + "default": false, + "description": "whether or not to copy settings from the source index." } }, { - "name": "_source", + "name": "timeout", "in": "query", - "description": "True or false to return the _source field or not, or a list of fields to return.", - "style": "form", + "description": "Operation timeout.", "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "True or false to return the _source field or not, or a list of fields to return." - }, - "explode": true + "type": "string", + "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", + "description": "Operation timeout.", + "x-data-type": "time" + } }, { - "name": "_source_excludes", + "name": "master_timeout", "in": "query", - "description": "List of fields to exclude from the returned _source field.", - "style": "form", + "description": "Operation timeout for connection to master node.", "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "List of fields to exclude from the returned _source field." - }, - "explode": true + "type": "string", + "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", + "description": "Operation timeout for connection to master node.", + "x-version-deprecated": "2.0.0", + "x-data-type": "time", + "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", + "deprecated": true + } }, { - "name": "_source_includes", + "name": "cluster_manager_timeout", "in": "query", - "description": "List of fields to extract and return from the _source field.", - "style": "form", + "description": "Operation timeout for connection to cluster-manager node.", "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "List of fields to extract and return from the _source field." - }, - "explode": true + "type": "string", + "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", + "description": "Operation timeout for connection to cluster-manager node.", + "x-data-type": "time" + } }, { - "name": "lang", + "name": "wait_for_active_shards", "in": "query", - "description": "The script language.", + "description": "Set the number of active shards to wait for on the shrunken index before the operation returns.", "schema": { "type": "string", - "default": "painless", - "description": "The script language." + "description": "Set the number of active shards to wait for on the shrunken index before the operation returns." } - }, + } + ], + "responses": { + "200": { + "description": "IndicesShrink_Post 200 response" + } + }, + "x-operation-group": "indices.shrink", + "x-version-added": "1.0" + }, + "put": { + "description": "Allow to shrink an existing index into a new index with fewer primary shards.", + "externalDocs": { + "description": "API Reference", + "url": "https://opensearch.org/docs/latest/api-reference/index-apis/shrink-index/" + }, + "operationId": "IndicesShrink_Put", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IndicesShrink_BodyParams" + } + } + } + }, + "parameters": [ { - "name": "refresh", - "in": "query", - "description": "If `true` then refresh 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` (the default) then do nothing with refreshes.", + "name": "index", + "in": "path", + "description": "The name of the source index to shrink.", "schema": { - "$ref": "#/components/schemas/RefreshEnum" - } + "type": "string", + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", + "description": "The name of the source index to shrink." + }, + "required": true }, { - "name": "retry_on_conflict", - "in": "query", - "description": "Specify how many times should the operation be retried when a conflict occurs.", + "name": "target", + "in": "path", + "description": "The name of the target index.", "schema": { - "type": "integer", - "default": 0, - "description": "Specify how many times should the operation be retried when a conflict occurs.", - "format": "int32" - } + "type": "string", + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", + "description": "The name of the target index." + }, + "required": true }, { - "name": "routing", + "name": "copy_settings", "in": "query", - "description": "Routing value.", + "description": "whether or not to copy settings from the source index.", "schema": { - "type": "string", - "description": "Routing value." + "type": "boolean", + "default": false, + "description": "whether or not to copy settings from the source index." } }, { @@ -27798,173 +27705,229 @@ } }, { - "name": "if_seq_no", + "name": "master_timeout", "in": "query", - "description": "only perform the operation if the last operation that has changed the document has the specified sequence number.", + "description": "Operation timeout for connection to master node.", "schema": { - "type": "integer", - "description": "only perform the operation if the last operation that has changed the document has the specified sequence number.", - "format": "int32" + "type": "string", + "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", + "description": "Operation timeout for connection to master node.", + "x-version-deprecated": "2.0.0", + "x-data-type": "time", + "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", + "deprecated": true } }, { - "name": "if_primary_term", + "name": "cluster_manager_timeout", "in": "query", - "description": "only perform the operation if the last operation that has changed the document has the specified primary term.", + "description": "Operation timeout for connection to cluster-manager node.", "schema": { - "type": "integer", - "description": "only perform the operation if the last operation that has changed the document has the specified primary term.", - "format": "int32" + "type": "string", + "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", + "description": "Operation timeout for connection to cluster-manager node.", + "x-data-type": "time" } }, { - "name": "require_alias", + "name": "wait_for_active_shards", "in": "query", - "description": "When true, requires destination to be an alias.", + "description": "Set the number of active shards to wait for on the shrunken index before the operation returns.", "schema": { - "type": "boolean", - "default": false, - "description": "When true, requires destination to be an alias." + "type": "string", + "description": "Set the number of active shards to wait for on the shrunken index before the operation returns." } } ], "responses": { "200": { - "description": "Update 200 response" + "description": "IndicesShrink_Put 200 response" } }, - "x-operation-group": "update", + "x-operation-group": "indices.shrink", "x-version-added": "1.0" } }, - "/{index}/_update_by_query": { - "post": { - "description": "Performs an update on every document in the index without changing the source,\nfor example to pick up a mapping change.", + "/{index}/_source/{id}": { + "get": { + "description": "Returns the source of a document.", "externalDocs": { "description": "API Reference", - "url": "https://opensearch.org/docs/latest" + "url": "https://opensearch.org/docs/latest/api-reference/document-apis/get-documents/" }, - "operationId": "UpdateByQuery", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UpdateByQuery_BodyParams" + "operationId": "GetSource", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Document ID.", + "schema": { + "type": "string", + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", + "description": "Document ID." + }, + "required": true, + "examples": { + "GetSource_example1": { + "summary": "Examples for Get document source Operation.", + "description": "", + "value": "1" } } - } - }, - "parameters": [ + }, { "name": "index", "in": "path", - "description": "Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices.", + "description": "Index name.", "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" + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", + "description": "Index name." }, - "required": true + "required": true, + "examples": { + "GetSource_example1": { + "summary": "Examples for Get document source Operation.", + "description": "", + "value": "books" + } + } }, { - "name": "analyzer", + "name": "preference", "in": "query", - "description": "The analyzer to use for the query string.", + "description": "Specify the node or shard the operation should be performed on.", "schema": { "type": "string", - "description": "The analyzer to use for the query string." + "default": "random", + "description": "Specify the node or shard the operation should be performed on." } }, { - "name": "analyze_wildcard", + "name": "realtime", "in": "query", - "description": "Specify whether wildcard and prefix queries should be analyzed.", + "description": "Specify whether to perform the operation in realtime or search mode.", "schema": { "type": "boolean", - "default": false, - "description": "Specify whether wildcard and prefix queries should be analyzed." + "description": "Specify whether to perform the operation in realtime or search mode." } }, { - "name": "default_operator", + "name": "refresh", "in": "query", - "description": "The default operator for query string query (AND or OR).", + "description": "Refresh the shard containing the document before performing the operation.", "schema": { - "$ref": "#/components/schemas/DefaultOperator" + "type": "boolean", + "description": "Refresh the shard containing the document before performing the operation." } }, { - "name": "df", + "name": "routing", "in": "query", - "description": "The field to use as default where no field prefix is given in the query string.", + "description": "Routing value.", "schema": { "type": "string", - "description": "The field to use as default where no field prefix is given in the query string." + "description": "Routing value." } }, { - "name": "from", + "name": "_source", "in": "query", - "description": "Starting offset.", + "description": "True or false to return the _source field or not, or a list of fields to return.", + "style": "form", "schema": { - "type": "integer", - "default": 0, - "description": "Starting offset.", - "format": "int32" - } + "type": "array", + "items": { + "type": "string" + }, + "description": "True or false to return the _source field or not, or a list of fields to return." + }, + "explode": true }, { - "name": "ignore_unavailable", + "name": "_source_excludes", "in": "query", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", + "description": "List of fields to exclude from the returned _source field.", + "style": "form", "schema": { - "type": "boolean", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." - } + "type": "array", + "items": { + "type": "string" + }, + "description": "List of fields to exclude from the returned _source field." + }, + "explode": true }, { - "name": "allow_no_indices", + "name": "_source_includes", "in": "query", - "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified).", + "description": "List of fields to extract and return from the _source field.", + "style": "form", "schema": { - "type": "boolean", - "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)." - } + "type": "array", + "items": { + "type": "string" + }, + "description": "List of fields to extract and return from the _source field." + }, + "explode": true }, { - "name": "conflicts", + "name": "version", "in": "query", - "description": "What to do when the operation encounters version conflicts?.", + "description": "Explicit version number for concurrency control.", "schema": { - "$ref": "#/components/schemas/Conflicts" + "type": "integer", + "description": "Explicit version number for concurrency control.", + "format": "int32" } }, { - "name": "expand_wildcards", + "name": "version_type", "in": "query", - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", + "description": "Specific version type.", "schema": { - "$ref": "#/components/schemas/ExpandWildcards" + "$ref": "#/components/schemas/VersionType" } - }, + } + ], + "responses": { + "200": { + "description": "GetSource 200 response" + } + }, + "x-operation-group": "get_source", + "x-version-added": "1.0" + }, + "head": { + "description": "Returns information about whether a document source exists in an index.", + "externalDocs": { + "description": "API Reference", + "url": "https://opensearch.org/docs/latest/api-reference/document-apis/get-documents/" + }, + "operationId": "ExistsSource", + "parameters": [ { - "name": "lenient", - "in": "query", - "description": "Specify whether format-based query failures (such as providing text to a numeric field) should be ignored.", + "name": "id", + "in": "path", + "description": "Document ID.", "schema": { - "type": "boolean", - "description": "Specify whether format-based query failures (such as providing text to a numeric field) should be ignored." - } + "type": "string", + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", + "description": "Document ID." + }, + "required": true }, { - "name": "pipeline", - "in": "query", - "description": "The pipeline id to preprocess incoming documents with.", + "name": "index", + "in": "path", + "description": "Index name.", "schema": { "type": "string", - "description": "The pipeline id to preprocess incoming documents with." - } + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", + "description": "Index name." + }, + "required": true }, { "name": "preference", @@ -27977,92 +27940,32 @@ } }, { - "name": "q", - "in": "query", - "description": "Query in the Lucene query string syntax.", - "schema": { - "type": "string", - "description": "Query in the Lucene query string syntax." - } - }, - { - "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 - }, - { - "name": "scroll", + "name": "realtime", "in": "query", - "description": "Specify how long a consistent view of the index should be maintained for scrolled search.", + "description": "Specify whether to perform the operation in realtime or search mode.", "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Specify how long a consistent view of the index should be maintained for scrolled search.", - "x-data-type": "time" + "type": "boolean", + "description": "Specify whether to perform the operation in realtime or search mode." } }, { - "name": "search_type", + "name": "refresh", "in": "query", - "description": "Search operation type.", + "description": "Refresh the shard containing the document before performing the operation.", "schema": { - "$ref": "#/components/schemas/SearchType" + "type": "boolean", + "description": "Refresh the shard containing the document before performing the operation." } }, { - "name": "search_timeout", + "name": "routing", "in": "query", - "description": "Explicit timeout for each search request. Defaults to no timeout.", + "description": "Routing value.", "schema": { "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Explicit timeout for each search request. Defaults to no timeout.", - "x-data-type": "time" - } - }, - { - "name": "size", - "in": "query", - "description": "Deprecated, please use `max_docs` instead.", - "schema": { - "type": "integer", - "description": "Deprecated, please use `max_docs` instead.", - "format": "int32" - } - }, - { - "name": "max_docs", - "in": "query", - "description": "Maximum number of documents to process (default: all documents).", - "schema": { - "type": "integer", - "description": "Maximum number of documents to process (default: all documents).", - "format": "int32" + "description": "Routing value." } }, - { - "name": "sort", - "in": "query", - "description": "Comma-separated list of : pairs.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of : pairs." - }, - "explode": true - }, { "name": "_source", "in": "query", @@ -28106,257 +28009,241 @@ "explode": true }, { - "name": "terminate_after", + "name": "version", "in": "query", - "description": "The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early.", + "description": "Explicit version number for concurrency control.", "schema": { "type": "integer", - "description": "The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early.", + "description": "Explicit version number for concurrency control.", "format": "int32" } }, { - "name": "stats", + "name": "version_type", "in": "query", - "description": "Specific 'tag' of the request for logging and statistical purposes.", - "style": "form", + "description": "Specific version type.", "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Specific 'tag' of the request for logging and statistical purposes." + "$ref": "#/components/schemas/VersionType" + } + } + ], + "responses": { + "200": { + "description": "ExistsSource 200 response" + } + }, + "x-operation-group": "exists_source", + "x-version-added": "1.0" + } + }, + "/{index}/_split/{target}": { + "post": { + "description": "Allows you to split an existing index into a new index with more primary shards.", + "operationId": "IndicesSplit_Post", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IndicesSplit_BodyParams" + } + } + } + }, + "parameters": [ + { + "name": "index", + "in": "path", + "description": "The name of the source index to split.", + "schema": { + "type": "string", + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", + "description": "The name of the source index to split." }, - "explode": true + "required": true }, { - "name": "version", - "in": "query", - "description": "Whether to return document version as part of a hit.", - "schema": { - "type": "boolean", - "description": "Whether to return document version as part of a hit." - } - }, - { - "name": "request_cache", - "in": "query", - "description": "Specify if request cache should be used for this request or not, defaults to index level setting.", + "name": "target", + "in": "path", + "description": "The name of the target index.", "schema": { - "type": "boolean", - "description": "Specify if request cache should be used for this request or not, defaults to index level setting." - } + "type": "string", + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", + "description": "The name of the target index." + }, + "required": true }, { - "name": "refresh", + "name": "copy_settings", "in": "query", - "description": "Should the affected indexes be refreshed?.", + "description": "whether or not to copy settings from the source index.", "schema": { "type": "boolean", - "description": "Should the affected indexes be refreshed?." + "default": false, + "description": "whether or not to copy settings from the source index." } }, { "name": "timeout", "in": "query", - "description": "Time each individual bulk request should wait for shards that are unavailable.", + "description": "Operation timeout.", "schema": { "type": "string", - "default": "1m", "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Time each individual bulk request should wait for shards that are unavailable.", + "description": "Operation timeout.", "x-data-type": "time" } }, { - "name": "wait_for_active_shards", + "name": "master_timeout", "in": "query", - "description": "Sets the number of shard copies that must be active before proceeding with the operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1).", + "description": "Operation timeout for connection to master node.", "schema": { "type": "string", - "default": "1", - "description": "Sets the number of shard copies that must be active before proceeding with the operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1)." - } - }, - { - "name": "scroll_size", - "in": "query", - "description": "Size on the scroll request powering the operation.", - "schema": { - "type": "integer", - "default": 100, - "description": "Size on the scroll request powering the operation.", - "format": "int32" - } - }, - { - "name": "wait_for_completion", - "in": "query", - "description": "Should this request wait until the operation has completed before returning.", - "schema": { - "type": "boolean", - "default": true, - "description": "Should this request wait until the operation has completed before returning." + "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", + "description": "Operation timeout for connection to master node.", + "x-version-deprecated": "2.0.0", + "x-data-type": "time", + "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", + "deprecated": true } }, { - "name": "requests_per_second", + "name": "cluster_manager_timeout", "in": "query", - "description": "The throttle for this request in sub-requests per second. -1 means no throttle.", + "description": "Operation timeout for connection to cluster-manager node.", "schema": { - "type": "integer", - "default": 0, - "description": "The throttle for this request in sub-requests per second. -1 means no throttle.", - "format": "int32" + "type": "string", + "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", + "description": "Operation timeout for connection to cluster-manager node.", + "x-data-type": "time" } }, { - "name": "slices", + "name": "wait_for_active_shards", "in": "query", - "description": "The number of slices this task should be divided into. Defaults to 1, meaning the task isn't sliced into subtasks. Can be set to `auto`.", + "description": "Set the number of active shards to wait for on the shrunken index before the operation returns.", "schema": { "type": "string", - "default": "1", - "description": "The number of slices this task should be divided into. Defaults to 1, meaning the task isn't sliced into subtasks. Can be set to `auto`." + "description": "Set the number of active shards to wait for on the shrunken index before the operation returns." } } ], "responses": { "200": { - "description": "UpdateByQuery 200 response" + "description": "IndicesSplit_Post 200 response" } }, - "x-operation-group": "update_by_query", + "x-operation-group": "indices.split", "x-version-added": "1.0" - } - }, - "/{index}/_upgrade": { - "get": { - "description": "The _upgrade API is no longer useful and will be removed.", - "operationId": "IndicesGetUpgrade_WithIndex", + }, + "put": { + "description": "Allows you to split an existing index into a new index with more primary shards.", + "externalDocs": { + "description": "API Reference", + "url": "https://opensearch.org/docs/latest/api-reference/index-apis/split/" + }, + "operationId": "IndicesSplit_Put", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IndicesSplit_BodyParams" + } + } + } + }, "parameters": [ { "name": "index", "in": "path", - "description": "Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices.", + "description": "The name of the source index to split.", "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" + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", + "description": "The name of the source index to split." }, "required": true }, { - "name": "ignore_unavailable", - "in": "query", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", - "schema": { - "type": "boolean", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." - } - }, - { - "name": "allow_no_indices", - "in": "query", - "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified).", - "schema": { - "type": "boolean", - "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)." - } - }, - { - "name": "expand_wildcards", - "in": "query", - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", - "schema": { - "$ref": "#/components/schemas/ExpandWildcards" - } - } - ], - "responses": { - "200": { - "description": "IndicesGetUpgrade_WithIndex 200 response" - } - }, - "x-operation-group": "indices.get_upgrade", - "x-version-added": "1.0" - }, - "post": { - "description": "The _upgrade API is no longer useful and will be removed.", - "operationId": "IndicesUpgrade_WithIndex", - "parameters": [ - { - "name": "index", + "name": "target", "in": "path", - "description": "Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices.", + "description": "The name of the target index.", "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" + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", + "description": "The name of the target index." }, "required": true }, { - "name": "allow_no_indices", + "name": "copy_settings", "in": "query", - "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified).", + "description": "whether or not to copy settings from the source index.", "schema": { "type": "boolean", - "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)." + "default": false, + "description": "whether or not to copy settings from the source index." } }, { - "name": "expand_wildcards", + "name": "timeout", "in": "query", - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", + "description": "Operation timeout.", "schema": { - "$ref": "#/components/schemas/ExpandWildcards" + "type": "string", + "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", + "description": "Operation timeout.", + "x-data-type": "time" } }, { - "name": "ignore_unavailable", + "name": "master_timeout", "in": "query", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", + "description": "Operation timeout for connection to master node.", "schema": { - "type": "boolean", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." + "type": "string", + "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", + "description": "Operation timeout for connection to master node.", + "x-version-deprecated": "2.0.0", + "x-data-type": "time", + "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", + "deprecated": true } }, { - "name": "wait_for_completion", + "name": "cluster_manager_timeout", "in": "query", - "description": "Should this request wait until the operation has completed before returning.", + "description": "Operation timeout for connection to cluster-manager node.", "schema": { - "type": "boolean", - "default": false, - "description": "Should this request wait until the operation has completed before returning." + "type": "string", + "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", + "description": "Operation timeout for connection to cluster-manager node.", + "x-data-type": "time" } }, { - "name": "only_ancient_segments", + "name": "wait_for_active_shards", "in": "query", - "description": "If true, only ancient (an older Lucene major release) segments will be upgraded.", + "description": "Set the number of active shards to wait for on the shrunken index before the operation returns.", "schema": { - "type": "boolean", - "description": "If true, only ancient (an older Lucene major release) segments will be upgraded." + "type": "string", + "description": "Set the number of active shards to wait for on the shrunken index before the operation returns." } } ], "responses": { "200": { - "description": "IndicesUpgrade_WithIndex 200 response" + "description": "IndicesSplit_Put 200 response" } }, - "x-operation-group": "indices.upgrade", + "x-operation-group": "indices.split", "x-version-added": "1.0" } }, - "/{index}/_validate/query": { + "/{index}/_stats": { "get": { - "description": "Allows a user to validate a potentially expensive query without executing it.", - "operationId": "IndicesValidateQuery_Get_WithIndex", + "description": "Provides statistics on operations happening in an index.", + "operationId": "IndicesStats_WithIndex", "parameters": [ { "name": "index", @@ -28364,140 +28251,128 @@ "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)", + "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 }, { - "name": "explain", + "name": "completion_fields", "in": "query", - "description": "Return detailed information about the error.", + "description": "Comma-separated list of fields for `fielddata` and `suggest` index metric (supports wildcards).", + "style": "form", "schema": { - "type": "boolean", - "description": "Return detailed information about the error." - } + "type": "array", + "items": { + "type": "string" + }, + "description": "Comma-separated list of fields for `fielddata` and `suggest` index metric (supports wildcards)." + }, + "explode": true }, { - "name": "ignore_unavailable", + "name": "fielddata_fields", "in": "query", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", + "description": "Comma-separated list of fields for `fielddata` index metric (supports wildcards).", + "style": "form", "schema": { - "type": "boolean", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." - } + "type": "array", + "items": { + "type": "string" + }, + "description": "Comma-separated list of fields for `fielddata` index metric (supports wildcards)." + }, + "explode": true }, { - "name": "allow_no_indices", + "name": "fields", "in": "query", - "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified).", + "description": "Comma-separated list of fields for `fielddata` and `completion` index metric (supports wildcards).", + "style": "form", "schema": { - "type": "boolean", - "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)." - } - }, - { - "name": "expand_wildcards", - "in": "query", - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", - "schema": { - "$ref": "#/components/schemas/ExpandWildcards" - } + "type": "array", + "items": { + "type": "string" + }, + "description": "Comma-separated list of fields for `fielddata` and `completion` index metric (supports wildcards)." + }, + "explode": true }, { - "name": "q", + "name": "groups", "in": "query", - "description": "Query in the Lucene query string syntax.", + "description": "Comma-separated list of search groups for `search` index metric.", + "style": "form", "schema": { - "type": "string", - "description": "Query in the Lucene query string syntax." - } + "type": "array", + "items": { + "type": "string" + }, + "description": "Comma-separated list of search groups for `search` index metric." + }, + "explode": true }, { - "name": "analyzer", + "name": "level", "in": "query", - "description": "The analyzer to use for the query string.", + "description": "Return stats aggregated at cluster, index or shard level.", "schema": { - "type": "string", - "description": "The analyzer to use for the query string." + "$ref": "#/components/schemas/IndiciesStatLevel" } }, { - "name": "analyze_wildcard", + "name": "include_segment_file_sizes", "in": "query", - "description": "Specify whether wildcard and prefix queries should be analyzed.", + "description": "Whether to report the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested).", "schema": { "type": "boolean", "default": false, - "description": "Specify whether wildcard and prefix queries should be analyzed." - } - }, - { - "name": "default_operator", - "in": "query", - "description": "The default operator for query string query (AND or OR).", - "schema": { - "$ref": "#/components/schemas/DefaultOperator" - } - }, - { - "name": "df", - "in": "query", - "description": "The field to use as default where no field prefix is given in the query string.", - "schema": { - "type": "string", - "description": "The field to use as default where no field prefix is given in the query string." + "description": "Whether to report the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested)." } }, { - "name": "lenient", + "name": "include_unloaded_segments", "in": "query", - "description": "Specify whether format-based query failures (such as providing text to a numeric field) should be ignored.", + "description": "If set to true segment stats will include stats for segments that are not currently loaded into memory.", "schema": { "type": "boolean", - "description": "Specify whether format-based query failures (such as providing text to a numeric field) should be ignored." + "default": false, + "description": "If set to true segment stats will include stats for segments that are not currently loaded into memory." } }, { - "name": "rewrite", + "name": "expand_wildcards", "in": "query", - "description": "Provide a more detailed explanation showing the actual Lucene query that will be executed.", + "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", "schema": { - "type": "boolean", - "description": "Provide a more detailed explanation showing the actual Lucene query that will be executed." + "$ref": "#/components/schemas/ExpandWildcards" } }, { - "name": "all_shards", + "name": "forbid_closed_indices", "in": "query", - "description": "Execute validation on all shards instead of one random shard per index.", + "description": "If set to false stats will also collected from closed indices if explicitly specified or if expand_wildcards expands to closed indices.", "schema": { "type": "boolean", - "description": "Execute validation on all shards instead of one random shard per index." + "default": true, + "description": "If set to false stats will also collected from closed indices if explicitly specified or if expand_wildcards expands to closed indices." } } ], "responses": { "200": { - "description": "IndicesValidateQuery_Get_WithIndex 200 response" + "description": "IndicesStats_WithIndex 200 response" } }, - "x-operation-group": "indices.validate_query", + "x-operation-group": "indices.stats", "x-version-added": "1.0" - }, - "post": { - "description": "Allows a user to validate a potentially expensive query without executing it.", - "operationId": "IndicesValidateQuery_Post_WithIndex", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IndicesValidateQuery_BodyParams" - } - } - } - }, + } + }, + "/{index}/_stats/{metric}": { + "get": { + "description": "Provides statistics on operations happening in an index.", + "operationId": "IndicesStats_WithIndexMetric", "parameters": [ { "name": "index", @@ -28505,326 +28380,2570 @@ "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)", + "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 }, { - "name": "explain", - "in": "query", - "description": "Return detailed information about the error.", + "name": "metric", + "in": "path", + "description": "Limit the information returned the specific metrics.", "schema": { - "type": "boolean", - "description": "Return detailed information about the error." - } + "type": "string", + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", + "description": "Limit the information returned the specific metrics.", + "x-enum-options": [ + "_all", + "completion", + "docs", + "fielddata", + "query_cache", + "flush", + "get", + "indexing", + "merge", + "request_cache", + "refresh", + "search", + "segments", + "store", + "warmer", + "suggest" + ], + "x-data-type": "array" + }, + "required": true }, { - "name": "ignore_unavailable", + "name": "completion_fields", "in": "query", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", + "description": "Comma-separated list of fields for `fielddata` and `suggest` index metric (supports wildcards).", + "style": "form", "schema": { - "type": "boolean", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." - } + "type": "array", + "items": { + "type": "string" + }, + "description": "Comma-separated list of fields for `fielddata` and `suggest` index metric (supports wildcards)." + }, + "explode": true }, { - "name": "allow_no_indices", + "name": "fielddata_fields", "in": "query", - "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified).", + "description": "Comma-separated list of fields for `fielddata` index metric (supports wildcards).", + "style": "form", "schema": { - "type": "boolean", - "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)." - } + "type": "array", + "items": { + "type": "string" + }, + "description": "Comma-separated list of fields for `fielddata` index metric (supports wildcards)." + }, + "explode": true }, { - "name": "expand_wildcards", + "name": "fields", "in": "query", - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", + "description": "Comma-separated list of fields for `fielddata` and `completion` index metric (supports wildcards).", + "style": "form", "schema": { - "$ref": "#/components/schemas/ExpandWildcards" - } + "type": "array", + "items": { + "type": "string" + }, + "description": "Comma-separated list of fields for `fielddata` and `completion` index metric (supports wildcards)." + }, + "explode": true }, { - "name": "q", + "name": "groups", "in": "query", - "description": "Query in the Lucene query string syntax.", + "description": "Comma-separated list of search groups for `search` index metric.", + "style": "form", "schema": { - "type": "string", - "description": "Query in the Lucene query string syntax." - } + "type": "array", + "items": { + "type": "string" + }, + "description": "Comma-separated list of search groups for `search` index metric." + }, + "explode": true }, { - "name": "analyzer", + "name": "level", "in": "query", - "description": "The analyzer to use for the query string.", + "description": "Return stats aggregated at cluster, index or shard level.", "schema": { - "type": "string", - "description": "The analyzer to use for the query string." + "$ref": "#/components/schemas/IndiciesStatLevel" } }, { - "name": "analyze_wildcard", + "name": "include_segment_file_sizes", "in": "query", - "description": "Specify whether wildcard and prefix queries should be analyzed.", + "description": "Whether to report the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested).", "schema": { "type": "boolean", "default": false, - "description": "Specify whether wildcard and prefix queries should be analyzed." + "description": "Whether to report the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested)." } }, { - "name": "default_operator", + "name": "include_unloaded_segments", "in": "query", - "description": "The default operator for query string query (AND or OR).", + "description": "If set to true segment stats will include stats for segments that are not currently loaded into memory.", "schema": { - "$ref": "#/components/schemas/DefaultOperator" + "type": "boolean", + "default": false, + "description": "If set to true segment stats will include stats for segments that are not currently loaded into memory." } }, { - "name": "df", + "name": "expand_wildcards", "in": "query", - "description": "The field to use as default where no field prefix is given in the query string.", + "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", "schema": { - "type": "string", - "description": "The field to use as default where no field prefix is given in the query string." + "$ref": "#/components/schemas/ExpandWildcards" } }, { - "name": "lenient", + "name": "forbid_closed_indices", "in": "query", - "description": "Specify whether format-based query failures (such as providing text to a numeric field) should be ignored.", + "description": "If set to false stats will also collected from closed indices if explicitly specified or if expand_wildcards expands to closed indices.", "schema": { "type": "boolean", - "description": "Specify whether format-based query failures (such as providing text to a numeric field) should be ignored." + "default": true, + "description": "If set to false stats will also collected from closed indices if explicitly specified or if expand_wildcards expands to closed indices." } - }, + } + ], + "responses": { + "200": { + "description": "IndicesStats_WithIndexMetric 200 response" + } + }, + "x-operation-group": "indices.stats", + "x-version-added": "1.0" + } + }, + "/{index}/_termvectors": { + "get": { + "description": "Returns information and statistics about terms in the fields of a particular document.", + "externalDocs": { + "description": "API Reference", + "url": "https://opensearch.org/docs/latest" + }, + "operationId": "Termvectors_Get", + "parameters": [ { - "name": "rewrite", - "in": "query", - "description": "Provide a more detailed explanation showing the actual Lucene query that will be executed.", + "name": "index", + "in": "path", + "description": "The index in which the document resides.", "schema": { - "type": "boolean", + "type": "string", + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", + "description": "The index in which the document resides." + }, + "required": true + }, + { + "name": "term_statistics", + "in": "query", + "description": "Specifies if total term frequency and document frequency should be returned.", + "schema": { + "type": "boolean", + "default": false, + "description": "Specifies if total term frequency and document frequency should be returned." + } + }, + { + "name": "field_statistics", + "in": "query", + "description": "Specifies if document count, sum of document frequencies and sum of total term frequencies should be returned.", + "schema": { + "type": "boolean", + "default": true, + "description": "Specifies if document count, sum of document frequencies and sum of total term frequencies should be returned." + } + }, + { + "name": "fields", + "in": "query", + "description": "Comma-separated list of fields to return.", + "style": "form", + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Comma-separated list of fields to return." + }, + "explode": true + }, + { + "name": "offsets", + "in": "query", + "description": "Specifies if term offsets should be returned.", + "schema": { + "type": "boolean", + "default": true, + "description": "Specifies if term offsets should be returned." + } + }, + { + "name": "positions", + "in": "query", + "description": "Specifies if term positions should be returned.", + "schema": { + "type": "boolean", + "default": true, + "description": "Specifies if term positions should be returned." + } + }, + { + "name": "payloads", + "in": "query", + "description": "Specifies if term payloads should be returned.", + "schema": { + "type": "boolean", + "default": true, + "description": "Specifies if term payloads should be returned." + } + }, + { + "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." + } + }, + { + "name": "routing", + "in": "query", + "description": "Routing value.", + "schema": { + "type": "string", + "description": "Routing value." + } + }, + { + "name": "realtime", + "in": "query", + "description": "Specifies if request is real-time as opposed to near-real-time.", + "schema": { + "type": "boolean", + "default": true, + "description": "Specifies if request is real-time as opposed to near-real-time." + } + }, + { + "name": "version", + "in": "query", + "description": "Explicit version number for concurrency control.", + "schema": { + "type": "integer", + "description": "Explicit version number for concurrency control.", + "format": "int32" + } + }, + { + "name": "version_type", + "in": "query", + "description": "Specific version type.", + "schema": { + "$ref": "#/components/schemas/VersionType" + } + } + ], + "responses": { + "200": { + "description": "Termvectors_Get 200 response" + } + }, + "x-operation-group": "termvectors", + "x-version-added": "1.0" + }, + "post": { + "description": "Returns information and statistics about terms in the fields of a particular document.", + "operationId": "Termvectors_Post", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Termvectors_BodyParams" + } + } + } + }, + "parameters": [ + { + "name": "index", + "in": "path", + "description": "The index in which the document resides.", + "schema": { + "type": "string", + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", + "description": "The index in which the document resides." + }, + "required": true + }, + { + "name": "term_statistics", + "in": "query", + "description": "Specifies if total term frequency and document frequency should be returned.", + "schema": { + "type": "boolean", + "default": false, + "description": "Specifies if total term frequency and document frequency should be returned." + } + }, + { + "name": "field_statistics", + "in": "query", + "description": "Specifies if document count, sum of document frequencies and sum of total term frequencies should be returned.", + "schema": { + "type": "boolean", + "default": true, + "description": "Specifies if document count, sum of document frequencies and sum of total term frequencies should be returned." + } + }, + { + "name": "fields", + "in": "query", + "description": "Comma-separated list of fields to return.", + "style": "form", + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Comma-separated list of fields to return." + }, + "explode": true + }, + { + "name": "offsets", + "in": "query", + "description": "Specifies if term offsets should be returned.", + "schema": { + "type": "boolean", + "default": true, + "description": "Specifies if term offsets should be returned." + } + }, + { + "name": "positions", + "in": "query", + "description": "Specifies if term positions should be returned.", + "schema": { + "type": "boolean", + "default": true, + "description": "Specifies if term positions should be returned." + } + }, + { + "name": "payloads", + "in": "query", + "description": "Specifies if term payloads should be returned.", + "schema": { + "type": "boolean", + "default": true, + "description": "Specifies if term payloads should be returned." + } + }, + { + "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." + } + }, + { + "name": "routing", + "in": "query", + "description": "Routing value.", + "schema": { + "type": "string", + "description": "Routing value." + } + }, + { + "name": "realtime", + "in": "query", + "description": "Specifies if request is real-time as opposed to near-real-time.", + "schema": { + "type": "boolean", + "default": true, + "description": "Specifies if request is real-time as opposed to near-real-time." + } + }, + { + "name": "version", + "in": "query", + "description": "Explicit version number for concurrency control.", + "schema": { + "type": "integer", + "description": "Explicit version number for concurrency control.", + "format": "int32" + } + }, + { + "name": "version_type", + "in": "query", + "description": "Specific version type.", + "schema": { + "$ref": "#/components/schemas/VersionType" + } + } + ], + "responses": { + "200": { + "description": "Termvectors_Post 200 response" + } + }, + "x-operation-group": "termvectors", + "x-version-added": "1.0" + } + }, + "/{index}/_termvectors/{id}": { + "get": { + "description": "Returns information and statistics about terms in the fields of a particular document.", + "operationId": "Termvectors_Get_WithId", + "parameters": [ + { + "name": "index", + "in": "path", + "description": "The index in which the document resides.", + "schema": { + "type": "string", + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", + "description": "The index in which the document resides." + }, + "required": true + }, + { + "name": "id", + "in": "path", + "description": "Document ID. When not specified a doc param should be supplied.", + "schema": { + "type": "string", + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", + "description": "Document ID. When not specified a doc param should be supplied." + }, + "required": true + }, + { + "name": "term_statistics", + "in": "query", + "description": "Specifies if total term frequency and document frequency should be returned.", + "schema": { + "type": "boolean", + "default": false, + "description": "Specifies if total term frequency and document frequency should be returned." + } + }, + { + "name": "field_statistics", + "in": "query", + "description": "Specifies if document count, sum of document frequencies and sum of total term frequencies should be returned.", + "schema": { + "type": "boolean", + "default": true, + "description": "Specifies if document count, sum of document frequencies and sum of total term frequencies should be returned." + } + }, + { + "name": "fields", + "in": "query", + "description": "Comma-separated list of fields to return.", + "style": "form", + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Comma-separated list of fields to return." + }, + "explode": true + }, + { + "name": "offsets", + "in": "query", + "description": "Specifies if term offsets should be returned.", + "schema": { + "type": "boolean", + "default": true, + "description": "Specifies if term offsets should be returned." + } + }, + { + "name": "positions", + "in": "query", + "description": "Specifies if term positions should be returned.", + "schema": { + "type": "boolean", + "default": true, + "description": "Specifies if term positions should be returned." + } + }, + { + "name": "payloads", + "in": "query", + "description": "Specifies if term payloads should be returned.", + "schema": { + "type": "boolean", + "default": true, + "description": "Specifies if term payloads should be returned." + } + }, + { + "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." + } + }, + { + "name": "routing", + "in": "query", + "description": "Routing value.", + "schema": { + "type": "string", + "description": "Routing value." + } + }, + { + "name": "realtime", + "in": "query", + "description": "Specifies if request is real-time as opposed to near-real-time.", + "schema": { + "type": "boolean", + "default": true, + "description": "Specifies if request is real-time as opposed to near-real-time." + } + }, + { + "name": "version", + "in": "query", + "description": "Explicit version number for concurrency control.", + "schema": { + "type": "integer", + "description": "Explicit version number for concurrency control.", + "format": "int32" + } + }, + { + "name": "version_type", + "in": "query", + "description": "Specific version type.", + "schema": { + "$ref": "#/components/schemas/VersionType" + } + } + ], + "responses": { + "200": { + "description": "Termvectors_Get_WithId 200 response" + } + }, + "x-operation-group": "termvectors", + "x-version-added": "1.0" + }, + "post": { + "description": "Returns information and statistics about terms in the fields of a particular document.", + "operationId": "Termvectors_Post_WithId", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Termvectors_BodyParams" + } + } + } + }, + "parameters": [ + { + "name": "index", + "in": "path", + "description": "The index in which the document resides.", + "schema": { + "type": "string", + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", + "description": "The index in which the document resides." + }, + "required": true + }, + { + "name": "id", + "in": "path", + "description": "Document ID. When not specified a doc param should be supplied.", + "schema": { + "type": "string", + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", + "description": "Document ID. When not specified a doc param should be supplied." + }, + "required": true + }, + { + "name": "term_statistics", + "in": "query", + "description": "Specifies if total term frequency and document frequency should be returned.", + "schema": { + "type": "boolean", + "default": false, + "description": "Specifies if total term frequency and document frequency should be returned." + } + }, + { + "name": "field_statistics", + "in": "query", + "description": "Specifies if document count, sum of document frequencies and sum of total term frequencies should be returned.", + "schema": { + "type": "boolean", + "default": true, + "description": "Specifies if document count, sum of document frequencies and sum of total term frequencies should be returned." + } + }, + { + "name": "fields", + "in": "query", + "description": "Comma-separated list of fields to return.", + "style": "form", + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Comma-separated list of fields to return." + }, + "explode": true + }, + { + "name": "offsets", + "in": "query", + "description": "Specifies if term offsets should be returned.", + "schema": { + "type": "boolean", + "default": true, + "description": "Specifies if term offsets should be returned." + } + }, + { + "name": "positions", + "in": "query", + "description": "Specifies if term positions should be returned.", + "schema": { + "type": "boolean", + "default": true, + "description": "Specifies if term positions should be returned." + } + }, + { + "name": "payloads", + "in": "query", + "description": "Specifies if term payloads should be returned.", + "schema": { + "type": "boolean", + "default": true, + "description": "Specifies if term payloads should be returned." + } + }, + { + "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." + } + }, + { + "name": "routing", + "in": "query", + "description": "Routing value.", + "schema": { + "type": "string", + "description": "Routing value." + } + }, + { + "name": "realtime", + "in": "query", + "description": "Specifies if request is real-time as opposed to near-real-time.", + "schema": { + "type": "boolean", + "default": true, + "description": "Specifies if request is real-time as opposed to near-real-time." + } + }, + { + "name": "version", + "in": "query", + "description": "Explicit version number for concurrency control.", + "schema": { + "type": "integer", + "description": "Explicit version number for concurrency control.", + "format": "int32" + } + }, + { + "name": "version_type", + "in": "query", + "description": "Specific version type.", + "schema": { + "$ref": "#/components/schemas/VersionType" + } + } + ], + "responses": { + "200": { + "description": "Termvectors_Post_WithId 200 response" + } + }, + "x-operation-group": "termvectors", + "x-version-added": "1.0" + } + }, + "/{index}/_update/{id}": { + "post": { + "description": "Updates a document with a script or partial document.", + "externalDocs": { + "description": "API Reference", + "url": "https://opensearch.org/docs/latest/api-reference/document-apis/update-document/" + }, + "operationId": "Update", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Update_BodyParams" + } + } + }, + "required": true + }, + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Document ID.", + "schema": { + "type": "string", + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", + "description": "Document ID." + }, + "required": true + }, + { + "name": "index", + "in": "path", + "description": "Index name.", + "schema": { + "type": "string", + "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", + "description": "Index name." + }, + "required": true + }, + { + "name": "wait_for_active_shards", + "in": "query", + "description": "Sets the number of shard copies that must be active before proceeding with the operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1).", + "schema": { + "type": "string", + "default": "1", + "description": "Sets the number of shard copies that must be active before proceeding with the operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1)." + } + }, + { + "name": "_source", + "in": "query", + "description": "True or false to return the _source field or not, or a list of fields to return.", + "style": "form", + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "description": "True or false to return the _source field or not, or a list of fields to return." + }, + "explode": true + }, + { + "name": "_source_excludes", + "in": "query", + "description": "List of fields to exclude from the returned _source field.", + "style": "form", + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of fields to exclude from the returned _source field." + }, + "explode": true + }, + { + "name": "_source_includes", + "in": "query", + "description": "List of fields to extract and return from the _source field.", + "style": "form", + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of fields to extract and return from the _source field." + }, + "explode": true + }, + { + "name": "lang", + "in": "query", + "description": "The script language.", + "schema": { + "type": "string", + "default": "painless", + "description": "The script language." + } + }, + { + "name": "refresh", + "in": "query", + "description": "If `true` then refresh 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` (the default) then do nothing with refreshes.", + "schema": { + "$ref": "#/components/schemas/RefreshEnum" + } + }, + { + "name": "retry_on_conflict", + "in": "query", + "description": "Specify how many times should the operation be retried when a conflict occurs.", + "schema": { + "type": "integer", + "default": 0, + "description": "Specify how many times should the operation be retried when a conflict occurs.", + "format": "int32" + } + }, + { + "name": "routing", + "in": "query", + "description": "Routing value.", + "schema": { + "type": "string", + "description": "Routing value." + } + }, + { + "name": "timeout", + "in": "query", + "description": "Operation timeout.", + "schema": { + "type": "string", + "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", + "description": "Operation timeout.", + "x-data-type": "time" + } + }, + { + "name": "if_seq_no", + "in": "query", + "description": "only perform the operation if the last operation that has changed the document has the specified sequence number.", + "schema": { + "type": "integer", + "description": "only perform the operation if the last operation that has changed the document has the specified sequence number.", + "format": "int32" + } + }, + { + "name": "if_primary_term", + "in": "query", + "description": "only perform the operation if the last operation that has changed the document has the specified primary term.", + "schema": { + "type": "integer", + "description": "only perform the operation if the last operation that has changed the document has the specified primary term.", + "format": "int32" + } + }, + { + "name": "require_alias", + "in": "query", + "description": "When true, requires destination to be an alias.", + "schema": { + "type": "boolean", + "default": false, + "description": "When true, requires destination to be an alias." + } + } + ], + "responses": { + "200": { + "description": "Update 200 response" + } + }, + "x-operation-group": "update", + "x-version-added": "1.0" + } + }, + "/{index}/_update_by_query": { + "post": { + "description": "Performs an update on every document in the index without changing the source,\nfor example to pick up a mapping change.", + "externalDocs": { + "description": "API Reference", + "url": "https://opensearch.org/docs/latest/api-reference/document-apis/update-by-query/" + }, + "operationId": "UpdateByQuery", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpdateByQuery_BodyParams" + } + } + } + }, + "parameters": [ + { + "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 + }, + { + "name": "analyzer", + "in": "query", + "description": "The analyzer to use for the query string.", + "schema": { + "type": "string", + "description": "The analyzer to use for the query string." + } + }, + { + "name": "analyze_wildcard", + "in": "query", + "description": "Specify whether wildcard and prefix queries should be analyzed.", + "schema": { + "type": "boolean", + "default": false, + "description": "Specify whether wildcard and prefix queries should be analyzed." + } + }, + { + "name": "default_operator", + "in": "query", + "description": "The default operator for query string query (AND or OR).", + "schema": { + "$ref": "#/components/schemas/DefaultOperator" + } + }, + { + "name": "df", + "in": "query", + "description": "The field to use as default where no field prefix is given in the query string.", + "schema": { + "type": "string", + "description": "The field to use as default where no field prefix is given in the query string." + } + }, + { + "name": "from", + "in": "query", + "description": "Starting offset.", + "schema": { + "type": "integer", + "default": 0, + "description": "Starting offset.", + "format": "int32" + } + }, + { + "name": "ignore_unavailable", + "in": "query", + "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", + "schema": { + "type": "boolean", + "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." + } + }, + { + "name": "allow_no_indices", + "in": "query", + "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified).", + "schema": { + "type": "boolean", + "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)." + } + }, + { + "name": "conflicts", + "in": "query", + "description": "What to do when the operation encounters version conflicts?.", + "schema": { + "$ref": "#/components/schemas/Conflicts" + } + }, + { + "name": "expand_wildcards", + "in": "query", + "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", + "schema": { + "$ref": "#/components/schemas/ExpandWildcards" + } + }, + { + "name": "lenient", + "in": "query", + "description": "Specify whether format-based query failures (such as providing text to a numeric field) should be ignored.", + "schema": { + "type": "boolean", + "description": "Specify whether format-based query failures (such as providing text to a numeric field) should be ignored." + } + }, + { + "name": "pipeline", + "in": "query", + "description": "The pipeline id to preprocess incoming documents with.", + "schema": { + "type": "string", + "description": "The pipeline id to preprocess incoming documents with." + } + }, + { + "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." + } + }, + { + "name": "q", + "in": "query", + "description": "Query in the Lucene query string syntax.", + "schema": { + "type": "string", + "description": "Query in the Lucene query string syntax." + } + }, + { + "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 + }, + { + "name": "scroll", + "in": "query", + "description": "Specify how long a consistent view of the index should be maintained for scrolled search.", + "schema": { + "type": "string", + "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", + "description": "Specify how long a consistent view of the index should be maintained for scrolled search.", + "x-data-type": "time" + } + }, + { + "name": "search_type", + "in": "query", + "description": "Search operation type.", + "schema": { + "$ref": "#/components/schemas/SearchType" + } + }, + { + "name": "search_timeout", + "in": "query", + "description": "Explicit timeout for each search request. Defaults to no timeout.", + "schema": { + "type": "string", + "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", + "description": "Explicit timeout for each search request. Defaults to no timeout.", + "x-data-type": "time" + } + }, + { + "name": "size", + "in": "query", + "description": "Deprecated, please use `max_docs` instead.", + "schema": { + "type": "integer", + "description": "Deprecated, please use `max_docs` instead.", + "format": "int32" + } + }, + { + "name": "max_docs", + "in": "query", + "description": "Maximum number of documents to process (default: all documents).", + "schema": { + "type": "integer", + "description": "Maximum number of documents to process (default: all documents).", + "format": "int32" + } + }, + { + "name": "sort", + "in": "query", + "description": "Comma-separated list of : pairs.", + "style": "form", + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Comma-separated list of : pairs." + }, + "explode": true + }, + { + "name": "_source", + "in": "query", + "description": "True or false to return the _source field or not, or a list of fields to return.", + "style": "form", + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "description": "True or false to return the _source field or not, or a list of fields to return." + }, + "explode": true + }, + { + "name": "_source_excludes", + "in": "query", + "description": "List of fields to exclude from the returned _source field.", + "style": "form", + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of fields to exclude from the returned _source field." + }, + "explode": true + }, + { + "name": "_source_includes", + "in": "query", + "description": "List of fields to extract and return from the _source field.", + "style": "form", + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of fields to extract and return from the _source field." + }, + "explode": true + }, + { + "name": "terminate_after", + "in": "query", + "description": "The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early.", + "schema": { + "type": "integer", + "description": "The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early.", + "format": "int32" + } + }, + { + "name": "stats", + "in": "query", + "description": "Specific 'tag' of the request for logging and statistical purposes.", + "style": "form", + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Specific 'tag' of the request for logging and statistical purposes." + }, + "explode": true + }, + { + "name": "version", + "in": "query", + "description": "Whether to return document version as part of a hit.", + "schema": { + "type": "boolean", + "description": "Whether to return document version as part of a hit." + } + }, + { + "name": "request_cache", + "in": "query", + "description": "Specify if request cache should be used for this request or not, defaults to index level setting.", + "schema": { + "type": "boolean", + "description": "Specify if request cache should be used for this request or not, defaults to index level setting." + } + }, + { + "name": "refresh", + "in": "query", + "description": "Should the affected indexes be refreshed?.", + "schema": { + "type": "boolean", + "description": "Should the affected indexes be refreshed?." + } + }, + { + "name": "timeout", + "in": "query", + "description": "Time each individual bulk request should wait for shards that are unavailable.", + "schema": { + "type": "string", + "default": "1m", + "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", + "description": "Time each individual bulk request should wait for shards that are unavailable.", + "x-data-type": "time" + } + }, + { + "name": "wait_for_active_shards", + "in": "query", + "description": "Sets the number of shard copies that must be active before proceeding with the operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1).", + "schema": { + "type": "string", + "default": "1", + "description": "Sets the number of shard copies that must be active before proceeding with the operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1)." + } + }, + { + "name": "scroll_size", + "in": "query", + "description": "Size on the scroll request powering the operation.", + "schema": { + "type": "integer", + "default": 100, + "description": "Size on the scroll request powering the operation.", + "format": "int32" + } + }, + { + "name": "wait_for_completion", + "in": "query", + "description": "Should this request wait until the operation has completed before returning.", + "schema": { + "type": "boolean", + "default": true, + "description": "Should this request wait until the operation has completed before returning." + } + }, + { + "name": "requests_per_second", + "in": "query", + "description": "The throttle for this request in sub-requests per second. -1 means no throttle.", + "schema": { + "type": "integer", + "default": 0, + "description": "The throttle for this request in sub-requests per second. -1 means no throttle.", + "format": "int32" + } + }, + { + "name": "slices", + "in": "query", + "description": "The number of slices this task should be divided into. Defaults to 1, meaning the task isn't sliced into subtasks. Can be set to `auto`.", + "schema": { + "type": "string", + "default": "1", + "description": "The number of slices this task should be divided into. Defaults to 1, meaning the task isn't sliced into subtasks. Can be set to `auto`." + } + } + ], + "responses": { + "200": { + "description": "UpdateByQuery 200 response" + } + }, + "x-operation-group": "update_by_query", + "x-version-added": "1.0" + } + }, + "/{index}/_upgrade": { + "get": { + "description": "The _upgrade API is no longer useful and will be removed.", + "operationId": "IndicesGetUpgrade_WithIndex", + "parameters": [ + { + "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 + }, + { + "name": "ignore_unavailable", + "in": "query", + "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", + "schema": { + "type": "boolean", + "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." + } + }, + { + "name": "allow_no_indices", + "in": "query", + "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified).", + "schema": { + "type": "boolean", + "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)." + } + }, + { + "name": "expand_wildcards", + "in": "query", + "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", + "schema": { + "$ref": "#/components/schemas/ExpandWildcards" + } + } + ], + "responses": { + "200": { + "description": "IndicesGetUpgrade_WithIndex 200 response" + } + }, + "x-operation-group": "indices.get_upgrade", + "x-version-added": "1.0" + }, + "post": { + "description": "The _upgrade API is no longer useful and will be removed.", + "operationId": "IndicesUpgrade_WithIndex", + "parameters": [ + { + "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 + }, + { + "name": "allow_no_indices", + "in": "query", + "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified).", + "schema": { + "type": "boolean", + "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)." + } + }, + { + "name": "expand_wildcards", + "in": "query", + "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", + "schema": { + "$ref": "#/components/schemas/ExpandWildcards" + } + }, + { + "name": "ignore_unavailable", + "in": "query", + "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", + "schema": { + "type": "boolean", + "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." + } + }, + { + "name": "wait_for_completion", + "in": "query", + "description": "Should this request wait until the operation has completed before returning.", + "schema": { + "type": "boolean", + "default": false, + "description": "Should this request wait until the operation has completed before returning." + } + }, + { + "name": "only_ancient_segments", + "in": "query", + "description": "If true, only ancient (an older Lucene major release) segments will be upgraded.", + "schema": { + "type": "boolean", + "description": "If true, only ancient (an older Lucene major release) segments will be upgraded." + } + } + ], + "responses": { + "200": { + "description": "IndicesUpgrade_WithIndex 200 response" + } + }, + "x-operation-group": "indices.upgrade", + "x-version-added": "1.0" + } + }, + "/{index}/_validate/query": { + "get": { + "description": "Allows a user to validate a potentially expensive query without executing it.", + "operationId": "IndicesValidateQuery_Get_WithIndex", + "parameters": [ + { + "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 + }, + { + "name": "explain", + "in": "query", + "description": "Return detailed information about the error.", + "schema": { + "type": "boolean", + "description": "Return detailed information about the error." + } + }, + { + "name": "ignore_unavailable", + "in": "query", + "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", + "schema": { + "type": "boolean", + "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." + } + }, + { + "name": "allow_no_indices", + "in": "query", + "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified).", + "schema": { + "type": "boolean", + "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)." + } + }, + { + "name": "expand_wildcards", + "in": "query", + "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", + "schema": { + "$ref": "#/components/schemas/ExpandWildcards" + } + }, + { + "name": "q", + "in": "query", + "description": "Query in the Lucene query string syntax.", + "schema": { + "type": "string", + "description": "Query in the Lucene query string syntax." + } + }, + { + "name": "analyzer", + "in": "query", + "description": "The analyzer to use for the query string.", + "schema": { + "type": "string", + "description": "The analyzer to use for the query string." + } + }, + { + "name": "analyze_wildcard", + "in": "query", + "description": "Specify whether wildcard and prefix queries should be analyzed.", + "schema": { + "type": "boolean", + "default": false, + "description": "Specify whether wildcard and prefix queries should be analyzed." + } + }, + { + "name": "default_operator", + "in": "query", + "description": "The default operator for query string query (AND or OR).", + "schema": { + "$ref": "#/components/schemas/DefaultOperator" + } + }, + { + "name": "df", + "in": "query", + "description": "The field to use as default where no field prefix is given in the query string.", + "schema": { + "type": "string", + "description": "The field to use as default where no field prefix is given in the query string." + } + }, + { + "name": "lenient", + "in": "query", + "description": "Specify whether format-based query failures (such as providing text to a numeric field) should be ignored.", + "schema": { + "type": "boolean", + "description": "Specify whether format-based query failures (such as providing text to a numeric field) should be ignored." + } + }, + { + "name": "rewrite", + "in": "query", + "description": "Provide a more detailed explanation showing the actual Lucene query that will be executed.", + "schema": { + "type": "boolean", + "description": "Provide a more detailed explanation showing the actual Lucene query that will be executed." + } + }, + { + "name": "all_shards", + "in": "query", + "description": "Execute validation on all shards instead of one random shard per index.", + "schema": { + "type": "boolean", + "description": "Execute validation on all shards instead of one random shard per index." + } + } + ], + "responses": { + "200": { + "description": "IndicesValidateQuery_Get_WithIndex 200 response" + } + }, + "x-operation-group": "indices.validate_query", + "x-version-added": "1.0" + }, + "post": { + "description": "Allows a user to validate a potentially expensive query without executing it.", + "operationId": "IndicesValidateQuery_Post_WithIndex", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IndicesValidateQuery_BodyParams" + } + } + } + }, + "parameters": [ + { + "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 + }, + { + "name": "explain", + "in": "query", + "description": "Return detailed information about the error.", + "schema": { + "type": "boolean", + "description": "Return detailed information about the error." + } + }, + { + "name": "ignore_unavailable", + "in": "query", + "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", + "schema": { + "type": "boolean", + "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." + } + }, + { + "name": "allow_no_indices", + "in": "query", + "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified).", + "schema": { + "type": "boolean", + "description": "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)." + } + }, + { + "name": "expand_wildcards", + "in": "query", + "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", + "schema": { + "$ref": "#/components/schemas/ExpandWildcards" + } + }, + { + "name": "q", + "in": "query", + "description": "Query in the Lucene query string syntax.", + "schema": { + "type": "string", + "description": "Query in the Lucene query string syntax." + } + }, + { + "name": "analyzer", + "in": "query", + "description": "The analyzer to use for the query string.", + "schema": { + "type": "string", + "description": "The analyzer to use for the query string." + } + }, + { + "name": "analyze_wildcard", + "in": "query", + "description": "Specify whether wildcard and prefix queries should be analyzed.", + "schema": { + "type": "boolean", + "default": false, + "description": "Specify whether wildcard and prefix queries should be analyzed." + } + }, + { + "name": "default_operator", + "in": "query", + "description": "The default operator for query string query (AND or OR).", + "schema": { + "$ref": "#/components/schemas/DefaultOperator" + } + }, + { + "name": "df", + "in": "query", + "description": "The field to use as default where no field prefix is given in the query string.", + "schema": { + "type": "string", + "description": "The field to use as default where no field prefix is given in the query string." + } + }, + { + "name": "lenient", + "in": "query", + "description": "Specify whether format-based query failures (such as providing text to a numeric field) should be ignored.", + "schema": { + "type": "boolean", + "description": "Specify whether format-based query failures (such as providing text to a numeric field) should be ignored." + } + }, + { + "name": "rewrite", + "in": "query", + "description": "Provide a more detailed explanation showing the actual Lucene query that will be executed.", + "schema": { + "type": "boolean", "description": "Provide a more detailed explanation showing the actual Lucene query that will be executed." } }, - { - "name": "all_shards", - "in": "query", - "description": "Execute validation on all shards instead of one random shard per index.", - "schema": { - "type": "boolean", - "description": "Execute validation on all shards instead of one random shard per index." - } + { + "name": "all_shards", + "in": "query", + "description": "Execute validation on all shards instead of one random shard per index.", + "schema": { + "type": "boolean", + "description": "Execute validation on all shards instead of one random shard per index." + } + } + ], + "responses": { + "200": { + "description": "IndicesValidateQuery_Post_WithIndex 200 response" + } + }, + "x-operation-group": "indices.validate_query", + "x-version-added": "1.0" + } + } + }, + "components": { + "schemas": { + "AccountDetails": { + "type": "object", + "properties": { + "user_name": { + "type": "string" + }, + "is_reserved": { + "type": "boolean" + }, + "is_hidden": { + "type": "boolean" + }, + "is_internal_user": { + "type": "boolean" + }, + "user_requested_tenant": { + "type": "string" + }, + "backend_roles": { + "type": "array", + "items": { + "type": "string" + } + }, + "custom_attribute_names": { + "type": "array", + "items": { + "type": "string" + } + }, + "tenants": { + "$ref": "#/components/schemas/UserTenants" + }, + "roles": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "ActionGroupsMap": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/Action_Group" + } + }, + "ActionObjectStructure": { + "type": "object", + "properties": { + "add": { + "$ref": "#/components/schemas/UserDefinedStructure" + }, + "remove": { + "$ref": "#/components/schemas/UserDefinedStructure" + }, + "remove_index": { + "$ref": "#/components/schemas/UserDefinedStructure" + } + } + }, + "Action_Group": { + "type": "object", + "properties": { + "reserved": { + "type": "boolean" + }, + "hidden": { + "type": "boolean" + }, + "allowed_actions": { + "type": "array", + "items": { + "type": "string" + } + }, + "type": { + "type": "string" + }, + "description": { + "type": "string" + }, + "static": { + "type": "boolean" + } + } + }, + "AuditConfig": { + "type": "object", + "properties": { + "compliance": { + "$ref": "#/components/schemas/ComplianceConfig" + }, + "enabled": { + "type": "boolean" + }, + "audit": { + "$ref": "#/components/schemas/AuditLogsConfig" + } + } + }, + "AuditConfigWithReadOnly": { + "type": "object", + "properties": { + "_readonly": { + "type": "array", + "items": { + "type": "string" + } + }, + "config": { + "$ref": "#/components/schemas/AuditConfig" + } + } + }, + "AuditLogsConfig": { + "type": "object", + "properties": { + "ignore_users": { + "type": "array", + "items": { + "type": "string" + } + }, + "ignore_requests": { + "type": "array", + "items": { + "type": "string" + } + }, + "disabled_rest_categories": { + "type": "array", + "items": { + "type": "string" + } + }, + "disabled_transport_categories": { + "type": "array", + "items": { + "type": "string" + } + }, + "log_request_body": { + "type": "boolean" + }, + "resolve_indices": { + "type": "boolean" + }, + "resolve_bulk_requests": { + "type": "boolean" + }, + "exclude_sensitive_headers": { + "type": "boolean" + }, + "enable_transport": { + "type": "boolean" + }, + "enable_rest": { + "type": "boolean" + } + } + }, + "Bulk_BodyParams": { + "type": "object", + "description": "The operation definition and data (action-data pairs), separated by newlines", + "x-serialize": "bulk" + }, + "Bytes": { + "type": "string", + "description": "The unit in which to display byte values.", + "enum": [ + "b", + "k", + "kb", + "m", + "mb", + "g", + "gb", + "t", + "tb", + "p", + "pb" + ] + }, + "CatAllPitSegmentsResponseContent": { + "type": "object", + "properties": { + "content": { + "$ref": "#/components/schemas/CatPitSegment" + } + } + }, + "CatPitSegment": { + "type": "object", + "properties": { + "index": { + "type": "string" + }, + "shard": { + "type": "integer", + "format": "int32" + }, + "prirep": { + "type": "boolean", + "description": "Set to true to return stats only for primary shards." + }, + "ip": { + "type": "string" + }, + "segment": { + "type": "string" + }, + "generation": { + "type": "integer", + "format": "int32" + }, + "docs_count": { + "type": "integer", + "format": "int32" + }, + "docs_deleted": { + "type": "integer", + "format": "int32" + }, + "size": { + "type": "string" + }, + "size_memory": { + "type": "integer", + "format": "int32" + }, + "committed": { + "type": "boolean" + }, + "searchable": { + "type": "boolean" + }, + "version": { + "type": "string" + }, + "compound": { + "type": "boolean" + } + } + }, + "CatPitSegmentsResponseContent": { + "type": "object", + "properties": { + "content": { + "$ref": "#/components/schemas/CatPitSegment" + } + } + }, + "CatPitSegments_BodyParams": { + "type": "object", + "properties": { + "pit_id": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "required": [ + "pit_id" + ] + }, + "CertificatesDetail": { + "type": "object", + "properties": { + "issuer_dn": { + "type": "string" + }, + "subject_dn": { + "type": "string" + }, + "san": { + "type": "string" + }, + "not_before": { + "type": "string" + }, + "not_after": { + "type": "string" + } + } + }, + "ChangePasswordRequestContent": { + "type": "object", + "properties": { + "current_password": { + "type": "string", + "description": "The current password" + }, + "password": { + "type": "string", + "description": "The new password to set" + } + }, + "required": [ + "current_password", + "password" + ] + }, + "ChangePasswordResponseContent": { + "type": "object", + "properties": { + "status": { + "type": "string", + "description": "Security Operation Status" + }, + "message": { + "type": "string", + "description": "Security Operation Message" + } + } + }, + "ClearScroll_BodyParams": { + "type": "object", + "description": "Comma-separated list of scroll IDs to clear if none was specified via the scroll_id parameter" + }, + "ClusterAllocationExplain_BodyParams": { + "type": "object", + "description": "The index, shard, and primary flag to explain. Empty means 'explain the first unassigned shard'" + }, + "ClusterGetSettingsResponseContent": { + "type": "object", + "properties": { + "persistent": { + "$ref": "#/components/schemas/UserDefinedValueMap" + }, + "transient": { + "$ref": "#/components/schemas/UserDefinedValueMap" + }, + "defaults": { + "$ref": "#/components/schemas/UserDefinedValueMap" + } + } + }, + "ClusterHealthLevel": { + "type": "string", + "description": "Specify the level of detail for returned information.", + "enum": [ + "cluster", + "indices", + "shards", + "awareness_attributes" + ] + }, + "ClusterPutComponentTemplate_BodyParams": { + "type": "object", + "description": "The template definition" + }, + "ClusterPutSettingsResponseContent": { + "type": "object", + "properties": { + "acknowledged": { + "type": "boolean" + }, + "persistent": { + "$ref": "#/components/schemas/UserDefinedValueMap" + }, + "transient": { + "$ref": "#/components/schemas/UserDefinedValueMap" + } + } + }, + "ClusterPutSettings_BodyParams": { + "type": "object", + "description": "The settings to be updated. Can be either `transient` or `persistent` (survives cluster restart).", + "properties": { + "persistent": { + "$ref": "#/components/schemas/UserDefinedValueMap" + }, + "transient": { + "$ref": "#/components/schemas/UserDefinedValueMap" + } + } + }, + "ClusterRerouteMetric_Member": { + "type": "string", + "enum": [ + "_all", + "blocks", + "metadata", + "nodes", + "routing_table", + "master_node", + "cluster_manager_node", + "version" + ] + }, + "ClusterReroute_BodyParams": { + "type": "object", + "description": "The definition of `commands` to perform (`move`, `cancel`, `allocate`)" + }, + "ComplianceConfig": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + }, + "write_log_diffs": { + "type": "boolean" + }, + "read_watched_fields": {}, + "read_ignore_users": { + "type": "array", + "items": { + "type": "string" + } + }, + "write_watched_indices": { + "type": "array", + "items": { + "type": "string" + } + }, + "write_ignore_users": { + "type": "array", + "items": { + "type": "string" + } + }, + "read_metadata_only": { + "type": "boolean" + }, + "write_metadata_only": { + "type": "boolean" + }, + "external_config": { + "type": "boolean" + }, + "internal_config": { + "type": "boolean" + } + } + }, + "Conflicts": { + "type": "string", + "description": "What to do when the operation encounters version conflicts?.", + "enum": [ + "abort", + "proceed" + ] + }, + "Count_BodyParams": { + "type": "object", + "description": "Query to restrict the results specified with the Query DSL (optional)" + }, + "CreateActionGroupResponseContent": { + "type": "object", + "properties": { + "status": { + "type": "string", + "description": "Security Operation Status" + }, + "message": { + "type": "string", + "description": "Security Operation Message" + } + } + }, + "CreatePitResponseContent": { + "type": "object", + "properties": { + "pit_id": { + "type": "string" + }, + "_shard": { + "$ref": "#/components/schemas/ShardStatistics" + }, + "creation_time": { + "type": "integer", + "format": "int64" + } + } + }, + "CreateRoleMappingResponseContent": { + "type": "object", + "properties": { + "status": { + "type": "string", + "description": "Security Operation Status" + }, + "message": { + "type": "string", + "description": "Security Operation Message" + } + } + }, + "CreateRoleResponseContent": { + "type": "object", + "properties": { + "status": { + "type": "string", + "description": "Security Operation Status" + }, + "message": { + "type": "string", + "description": "Security Operation Message" + } + } + }, + "CreateTenantParams": { + "type": "object", + "properties": { + "description": { + "type": "string" + } + } + }, + "CreateTenantResponseContent": { + "type": "object", + "properties": { + "status": { + "type": "string", + "description": "Security Operation Status" + }, + "message": { + "type": "string", + "description": "Security Operation Message" } - ], - "responses": { - "200": { - "description": "IndicesValidateQuery_Post_WithIndex 200 response" + } + }, + "CreateUserResponseContent": { + "type": "object", + "properties": { + "status": { + "type": "string", + "description": "Security Operation Status" + }, + "message": { + "type": "string", + "description": "Security Operation Message" } - }, - "x-operation-group": "indices.validate_query", - "x-version-added": "1.0" - } - } - }, - "components": { - "schemas": { - "ActionObjectStructure": { + } + }, + "Create_BodyParams": { + "type": "object", + "description": "The document" + }, + "DataStream": { "type": "object", "properties": { - "add": { - "$ref": "#/components/schemas/UserDefinedStructure" + "name": { + "type": "string" }, - "remove": { - "$ref": "#/components/schemas/UserDefinedStructure" + "timestamp_field": { + "$ref": "#/components/schemas/DataStreamTimestampField" }, - "remove_index": { - "$ref": "#/components/schemas/UserDefinedStructure" + "indices": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DataStreamIndex" + } + }, + "generation": { + "type": "integer", + "format": "int64" + }, + "status": { + "$ref": "#/components/schemas/DataStreamStatus" + }, + "template": { + "type": "string" } } }, - "AttributeMap": { + "DataStreamIndex": { "type": "object", - "additionalProperties": { - "type": "string" + "properties": { + "index_name": { + "type": "string" + }, + "index_uuid": { + "type": "string" + } } }, - "Bulk_BodyParams": { + "DataStreamStatus": { + "type": "string", + "enum": [ + "green", + "yellow", + "red" + ] + }, + "DataStreamTimestampField": { "type": "object", - "x-serialize": "bulk" + "properties": { + "name": { + "type": "string" + } + } }, - "Bytes": { + "DefaultOperator": { "type": "string", - "description": "The unit in which to display byte values.", + "description": "The default operator for query string query (AND or OR).", "enum": [ - "b", - "k", - "kb", - "m", - "mb", - "g", - "gb", - "t", - "tb", - "p", - "pb" + "AND", + "OR" ] }, - "ClearScroll_BodyParams": { - "type": "object" + "DeleteActionGroupResponseContent": { + "type": "object", + "properties": { + "status": { + "type": "string", + "description": "Security Operation Status" + }, + "message": { + "type": "string", + "description": "Security Operation Message" + } + } }, - "ClusterAllocationExplain_BodyParams": { - "type": "object" + "DeleteAllPitsResponseContent": { + "type": "object", + "properties": { + "pits": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PitsDetailsDeleteAll" + } + } + } }, - "ClusterGetSettingsResponseContent": { + "DeleteByQuery_BodyParams": { + "type": "object", + "description": "The search definition using the Query DSL" + }, + "DeleteDistinguishedNamesResponseContent": { "type": "object", "properties": { - "persistent": { - "$ref": "#/components/schemas/UserDefinedValueMap" - }, - "transient": { - "$ref": "#/components/schemas/UserDefinedValueMap" + "status": { + "type": "string", + "description": "Security Operation Status" }, - "defaults": { - "$ref": "#/components/schemas/UserDefinedValueMap" + "message": { + "type": "string", + "description": "Security Operation Message" } } }, - "ClusterHealthLevel": { - "type": "string", - "description": "Specify the level of detail for returned information.", - "enum": [ - "cluster", - "indices", - "shards", - "awareness_attributes" + "DeletePitResponseContent": { + "type": "object", + "properties": { + "pits": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DeletedPit" + } + } + } + }, + "DeletePit_BodyParams": { + "type": "object", + "properties": { + "pit_id": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "required": [ + "pit_id" ] }, - "ClusterPutComponentTemplate_BodyParams": { - "type": "object" + "DeleteRoleMappingResponseContent": { + "type": "object", + "properties": { + "status": { + "type": "string", + "description": "Security Operation Status" + }, + "message": { + "type": "string", + "description": "Security Operation Message" + } + } }, - "ClusterPutSettingsResponseContent": { + "DeleteRoleResponseContent": { "type": "object", "properties": { - "acknowledged": { - "type": "boolean" + "status": { + "type": "string", + "description": "Security Operation Status" }, - "persistent": { - "$ref": "#/components/schemas/UserDefinedValueMap" + "message": { + "type": "string", + "description": "Security Operation Message" + } + } + }, + "DeleteTenantResponseContent": { + "type": "object", + "properties": { + "status": { + "type": "string", + "description": "Security Operation Status" }, - "transient": { - "$ref": "#/components/schemas/UserDefinedValueMap" + "message": { + "type": "string", + "description": "Security Operation Message" } } }, - "ClusterPutSettings_BodyParams": { + "DeleteUserResponseContent": { "type": "object", "properties": { - "persistent": { - "$ref": "#/components/schemas/UserDefinedValueMap" + "status": { + "type": "string", + "description": "Security Operation Status" }, - "transient": { - "$ref": "#/components/schemas/UserDefinedValueMap" + "message": { + "type": "string", + "description": "Security Operation Message" } } }, - "ClusterRerouteMetric_Member": { - "type": "string", - "enum": [ - "_all", - "blocks", - "metadata", - "nodes", - "routing_table", - "master_node", - "cluster_manager_node", - "version" - ] + "DeletedPit": { + "type": "object", + "properties": { + "successful": { + "type": "boolean" + }, + "pit_id": { + "type": "string" + } + } }, - "ClusterReroute_BodyParams": { - "type": "object" + "DistinguishedNames": { + "type": "object", + "properties": { + "nodes_dn": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "DistinguishedNamesMap": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/DistinguishedNames" + } + }, + "DynamicConfig": { + "type": "object", + "properties": { + "dynamic": { + "$ref": "#/components/schemas/DynamicOptions" + } + } + }, + "DynamicOptions": { + "type": "object", + "properties": { + "filteredAliasMode": { + "type": "string" + }, + "disableRestAuth": { + "type": "boolean" + }, + "disableIntertransportAuth": { + "type": "boolean" + }, + "respectRequestIndicesOptions": { + "type": "boolean" + }, + "kibana": {}, + "http": {}, + "authc": {}, + "authz": {}, + "authFailureListeners": {}, + "doNotFailOnForbidden": { + "type": "boolean" + }, + "multiRolespanEnabled": { + "type": "boolean" + }, + "hostsResolverMode": { + "type": "string" + }, + "doNotFailOnForbiddenEmpty": { + "type": "boolean" + } + } }, - "Conflicts": { + "ExpandWildcards": { "type": "string", - "description": "What to do when the operation encounters version conflicts?.", + "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", "enum": [ - "abort", - "proceed" + "all", + "open", + "closed", + "hidden", + "none" ] }, - "Count_BodyParams": { - "type": "object" + "Explain_BodyParams": { + "type": "object", + "description": "The query definition using the Query DSL" }, - "CreateTenantParams": { + "FieldCaps_BodyParams": { "type": "object", - "properties": { - "description": { - "type": "string" - } - } + "description": "An index filter specified with the Query DSL" }, - "CreateTenantResponseContent": { + "FlushCacheResponseContent": { "type": "object", "properties": { "status": { "type": "string", - "description": "Informing of request's status." + "description": "Security Operation Status" }, "message": { "type": "string", - "description": "The message indicating the information of action of the model." + "description": "Security Operation Message" } } }, - "Create_BodyParams": { - "type": "object" - }, - "DefaultOperator": { - "type": "string", - "description": "The default operator for query string query (AND or OR).", - "enum": [ - "AND", - "OR" - ] - }, - "DeleteByQuery_BodyParams": { - "type": "object" - }, - "DeletePit_BodyParams": { - "type": "object" + "GetAllPitsResponseContent": { + "type": "object", + "properties": { + "pits": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PitDetail" + } + } + } }, - "DeleteTenantResponseContent": { + "GetCertificatesResponseContent": { "type": "object", "properties": { - "status": { - "type": "string", - "description": "Informing of request's status." + "http_certificates_list": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CertificatesDetail" + } }, - "message": { - "type": "string", - "description": "The message indicating the information of action of the model." + "transport_certificates_list": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CertificatesDetail" + } } } }, - "ExpandWildcards": { - "type": "string", - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", - "enum": [ - "all", - "open", - "closed", - "hidden", - "none" - ] - }, - "Explain_BodyParams": { - "type": "object" - }, - "FieldCaps_BodyParams": { - "type": "object" - }, "GetResponseContent": { "type": "object", "properties": { @@ -28868,25 +30987,6 @@ "found" ] }, - "GetTenantResponseContent": { - "type": "object", - "properties": { - "tenant": { - "$ref": "#/components/schemas/Tenant" - } - } - }, - "GetTenantsResponseContent": { - "type": "object", - "properties": { - "tenantlist": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Tenant" - } - } - } - }, "GroupBy": { "type": "string", "description": "Group tasks by nodes or parent/child relationships.", @@ -28943,17 +31043,58 @@ } } }, + "IndexPermission": { + "type": "object", + "properties": { + "index_patterns": { + "type": "array", + "items": { + "type": "string" + } + }, + "fls": { + "type": "array", + "items": { + "type": "string" + } + }, + "masked_fields": { + "type": "array", + "items": { + "type": "string" + } + }, + "allowed_actions": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, "Index_BodyParams": { - "type": "object" + "type": "object", + "description": "The document" }, "IndicesAnalyze_BodyParams": { - "type": "object" + "type": "object", + "description": "Define analyzer/tokenizer parameters and the text on which the analysis should be performed" }, "IndicesClone_BodyParams": { - "type": "object" + "type": "object", + "description": "The configuration for the target index (`settings` and `aliases`)" + }, + "IndicesCreateDataStreamResponseContent": { + "type": "object", + "properties": { + "acknowledged": { + "type": "boolean" + } + } }, "IndicesCreateDataStream_BodyParams": { - "type": "object" + "type": "object", + "description": "The data stream definition" }, "IndicesCreateResponseContent": { "type": "object", @@ -28976,6 +31117,7 @@ }, "IndicesCreate_BodyParams": { "type": "object", + "description": "The configuration for the index (`settings` and `mappings`)", "properties": { "aliases": { "$ref": "#/components/schemas/UserDefinedValueMap" @@ -28988,6 +31130,14 @@ } } }, + "IndicesDeleteDataStreamResponseContent": { + "type": "object", + "properties": { + "acknowledged": { + "type": "boolean" + } + } + }, "IndicesDeleteResponseContent": { "type": "object", "properties": { @@ -28996,14 +31146,39 @@ } } }, + "IndicesGetDataStreamResponseContent": { + "type": "object", + "properties": { + "data_streams": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DataStream" + } + } + } + }, + "IndicesGetDataStream_WithNameResponseContent": { + "type": "object", + "properties": { + "data_streams": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DataStream" + } + } + } + }, "IndicesPutAlias_BodyParams": { - "type": "object" + "type": "object", + "description": "The settings for the alias, such as `routing` or `filter`" }, "IndicesPutIndexTemplate_BodyParams": { - "type": "object" + "type": "object", + "description": "The template definition" }, "IndicesPutMapping_BodyParams": { - "type": "object" + "type": "object", + "description": "The mapping definition" }, "IndicesPutMapping_PostResponseContent": { "type": "object", @@ -29022,25 +31197,32 @@ } }, "IndicesPutSettings_BodyParams": { - "type": "object" + "type": "object", + "description": "The index settings to be updated" }, "IndicesPutTemplate_BodyParams": { - "type": "object" + "type": "object", + "description": "The template definition" }, "IndicesRollover_BodyParams": { - "type": "object" + "type": "object", + "description": "The conditions that needs to be met for executing rollover" }, "IndicesShrink_BodyParams": { - "type": "object" + "type": "object", + "description": "The configuration for the target index (`settings` and `aliases`)" }, "IndicesSimulateIndexTemplate_BodyParams": { - "type": "object" + "type": "object", + "description": "New index template definition, which will be included in the simulation, as if it already exists in the system" }, "IndicesSimulateTemplate_BodyParams": { - "type": "object" + "type": "object", + "description": "New index template definition to be simulated, if no index template name is specified" }, "IndicesSplit_BodyParams": { - "type": "object" + "type": "object", + "description": "The configuration for the target index (`settings` and `aliases`)" }, "IndicesUpdateAliasesResponseContent": { "type": "object", @@ -29055,6 +31237,7 @@ }, "IndicesUpdateAliases_BodyParams": { "type": "object", + "description": "The definition of `actions` to perform", "properties": { "actions": { "$ref": "#/components/schemas/ActionObjectStructure" @@ -29062,7 +31245,8 @@ } }, "IndicesValidateQuery_BodyParams": { - "type": "object" + "type": "object", + "description": "The query definition specified with the Query DSL" }, "IndiciesStatLevel": { "type": "string", @@ -29126,27 +31310,34 @@ } }, "IngestPutPipeline_BodyParams": { - "type": "object" + "type": "object", + "description": "The ingest definition" }, "IngestSimulate_BodyParams": { - "type": "object" + "type": "object", + "description": "The simulate definition" }, "Mget_BodyParams": { - "type": "object" + "type": "object", + "description": "Document identifiers; can be either `docs` (containing full document information) or `ids` (when index is provided in the URL." }, "MsearchTemplate_BodyParams": { "type": "object", + "description": "The request definitions (metadata-search request definition pairs), separated by newlines", "x-serialize": "bulk" }, "Msearch_BodyParams": { "type": "object", + "description": "The request definitions (metadata-search request definition pairs), separated by newlines", "x-serialize": "bulk" }, "Mtermvectors_BodyParams": { - "type": "object" + "type": "object", + "description": "Define ids, documents, parameters or a list of parameters per document here. You must at least provide a list of document ids. See documentation." }, "NodesReloadSecureSettings_BodyParams": { - "type": "object" + "type": "object", + "description": "An object containing the password for the opensearch keystore" }, "NodesStatLevel": { "type": "string", @@ -29165,70 +31356,294 @@ "create" ] }, - "PatchOperation": { + "PatchActionGroupInputPayload": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PatchOperation" + } + }, + "PatchActionGroupResponseContent": { + "type": "object", + "properties": { + "status": { + "type": "string", + "description": "Security Operation Status" + }, + "message": { + "type": "string", + "description": "Security Operation Message" + } + } + }, + "PatchActionGroupsInputPayload": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PatchOperation" + } + }, + "PatchActionGroupsResponseContent": { + "type": "object", + "properties": { + "status": { + "type": "string", + "description": "Security Operation Status" + }, + "message": { + "type": "string", + "description": "Security Operation Message" + } + } + }, + "PatchAuditConfigurationInputPayload": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PatchOperation" + } + }, + "PatchConfigurationInputPayload": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PatchOperation" + } + }, + "PatchConfigurationResponseContent": { + "type": "object", + "properties": { + "status": { + "type": "string", + "description": "Security Operation Status" + }, + "message": { + "type": "string", + "description": "Security Operation Message" + } + } + }, + "PatchDistinguishedNamesInputPayload": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PatchOperation" + } + }, + "PatchDistinguishedNamesResponseContent": { + "type": "object", + "properties": { + "status": { + "type": "string", + "description": "Security Operation Status" + }, + "message": { + "type": "string", + "description": "Security Operation Message" + } + } + }, + "PatchOperation": { + "type": "object", + "properties": { + "op": { + "type": "string", + "description": "The operation to perform. Possible values: remove,add, replace, move, copy, test." + }, + "path": { + "type": "string", + "description": "The path to the resource." + }, + "value": { + "description": "The new values used for the update." + } + }, + "required": [ + "op", + "path" + ] + }, + "PatchRoleInputPayload": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PatchOperation" + } + }, + "PatchRoleMappingInputPayload": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PatchOperation" + } + }, + "PatchRoleMappingResponseContent": { + "type": "object", + "properties": { + "status": { + "type": "string", + "description": "Security Operation Status" + }, + "message": { + "type": "string", + "description": "Security Operation Message" + } + } + }, + "PatchRoleMappingsInputPayload": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PatchOperation" + } + }, + "PatchRoleMappingsResponseContent": { + "type": "object", + "properties": { + "status": { + "type": "string", + "description": "Security Operation Status" + }, + "message": { + "type": "string", + "description": "Security Operation Message" + } + } + }, + "PatchRoleResponseContent": { + "type": "object", + "properties": { + "status": { + "type": "string", + "description": "Security Operation Status" + }, + "message": { + "type": "string", + "description": "Security Operation Message" + } + } + }, + "PatchRolesInputPayload": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PatchOperation" + } + }, + "PatchRolesResponseContent": { "type": "object", "properties": { - "op": { - "type": "string" - }, - "path": { - "type": "string" + "status": { + "type": "string", + "description": "Security Operation Status" }, - "value": { - "$ref": "#/components/schemas/AttributeMap" + "message": { + "type": "string", + "description": "Security Operation Message" } } }, - "PatchTenantParams": { + "PatchTenantInputPayload": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PatchOperation" + } + }, + "PatchTenantResponseContent": { "type": "object", "properties": { - "tenantPatch": { - "$ref": "#/components/schemas/PatchOperation" + "status": { + "type": "string", + "description": "Security Operation Status" + }, + "message": { + "type": "string", + "description": "Security Operation Message" } } }, - "PatchTenantResponseContent": { + "PatchTenantsInputPayload": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PatchOperation" + } + }, + "PatchTenantsResponseContent": { "type": "object", "properties": { "status": { "type": "string", - "description": "Informing of request's status." + "description": "Security Operation Status" }, "message": { "type": "string", - "description": "The message indicating the information of action of the model." + "description": "Security Operation Message" } } }, - "PatchTenantsParams": { + "PatchUserInputPayload": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PatchOperation" + } + }, + "PatchUserResponseContent": { "type": "object", "properties": { - "tenantsPatch": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PatchOperation" - } + "status": { + "type": "string", + "description": "Security Operation Status" + }, + "message": { + "type": "string", + "description": "Security Operation Message" } } }, - "PatchTenantsResponseContent": { + "PatchUsersInputPayload": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PatchOperation" + } + }, + "PatchUsersResponseContent": { "type": "object", "properties": { "status": { "type": "string", - "description": "Informing of request's status." + "description": "Security Operation Status" }, "message": { "type": "string", - "description": "The message indicating the information of action of the model." + "description": "Security Operation Message" + } + } + }, + "PitDetail": { + "type": "object", + "properties": { + "pit_id": { + "type": "string" + }, + "creation_time": { + "type": "integer", + "format": "int64" + }, + "keep_alive": { + "type": "integer", + "format": "int64" + } + } + }, + "PitsDetailsDeleteAll": { + "type": "object", + "properties": { + "successful": { + "type": "boolean" + }, + "pit_id": { + "type": "string" } } }, "PutScript_BodyParams": { - "type": "object" + "type": "object", + "description": "The document" }, "RankEval_BodyParams": { - "type": "object" + "type": "object", + "description": "The ranking evaluation search definition, including search requests, document ratings and ranking metric definition." }, "RefreshEnum": { "type": "string", @@ -29240,7 +31655,8 @@ ] }, "Reindex_BodyParams": { - "type": "object" + "type": "object", + "description": "The search definition using the Query DSL and the prototype for the index request." }, "Relation": { "type": "string", @@ -29249,6 +31665,32 @@ "gte" ] }, + "ReloadHttpCertificatesResponseContent": { + "type": "object", + "properties": { + "status": { + "type": "string", + "description": "Security Operation Status" + }, + "message": { + "type": "string", + "description": "Security Operation Message" + } + } + }, + "ReloadTransportCertificatesResponseContent": { + "type": "object", + "properties": { + "status": { + "type": "string", + "description": "Security Operation Status" + }, + "message": { + "type": "string", + "description": "Security Operation Message" + } + } + }, "RemoteStoreRestoreInfo": { "type": "object", "properties": { @@ -29296,6 +31738,7 @@ }, "RemoteStoreRestore_BodyParams": { "type": "object", + "description": "Comma-separated list of index IDs", "properties": { "indices": { "type": "array", @@ -29309,7 +31752,90 @@ ] }, "RenderSearchTemplate_BodyParams": { - "type": "object" + "type": "object", + "description": "The search definition template and its params" + }, + "Role": { + "type": "object", + "properties": { + "reserved": { + "type": "boolean" + }, + "hidden": { + "type": "boolean" + }, + "description": { + "type": "string" + }, + "cluster_permission": { + "type": "array", + "items": { + "type": "string" + } + }, + "index_permission": { + "$ref": "#/components/schemas/IndexPermission" + }, + "tenant_permissions": { + "type": "array", + "items": { + "type": "string" + } + }, + "static": { + "type": "boolean" + } + } + }, + "RoleMapping": { + "type": "object", + "properties": { + "hosts": { + "type": "array", + "items": { + "type": "string" + } + }, + "users": { + "type": "array", + "items": { + "type": "string" + } + }, + "reserved": { + "type": "boolean" + }, + "hidden": { + "type": "boolean" + }, + "backend_roles": { + "type": "array", + "items": { + "type": "string" + } + }, + "and_backend_roles": { + "type": "array", + "items": { + "type": "string" + } + }, + "description": { + "type": "string" + } + } + }, + "RoleMappings": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/RoleMapping" + } + }, + "RolesMap": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/Role" + } }, "SampleType": { "type": "string", @@ -29321,13 +31847,16 @@ ] }, "ScriptsPainlessExecute_BodyParams": { - "type": "object" + "type": "object", + "description": "The script to execute" }, "Scroll_BodyParams": { - "type": "object" + "type": "object", + "description": "The scroll ID if not passed by URL or query parameter." }, "SearchTemplate_BodyParams": { - "type": "object" + "type": "object", + "description": "The search definition template and its params" }, "SearchType": { "type": "string", @@ -29349,6 +31878,7 @@ }, "Search_BodyParams": { "type": "object", + "description": "The search definition using the Query DSL", "properties": { "docvalue_fields": { "type": "string" @@ -29486,6 +32016,20 @@ } } }, + "SecurityHealthResponseContent": { + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "mode": { + "type": "string" + }, + "status": { + "type": "string" + } + } + }, "ShardStatistics": { "type": "object", "properties": { @@ -29508,16 +32052,20 @@ } }, "SnapshotClone_BodyParams": { - "type": "object" + "type": "object", + "description": "The snapshot clone definition" }, "SnapshotCreateRepository_BodyParams": { - "type": "object" + "type": "object", + "description": "The repository definition" }, "SnapshotCreate_BodyParams": { - "type": "object" + "type": "object", + "description": "The snapshot definition" }, "SnapshotRestore_BodyParams": { - "type": "object" + "type": "object", + "description": "Details of what to restore" }, "Status_Member": { "type": "string", @@ -29554,8 +32102,15 @@ } } }, + "TenantsMap": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/Tenant" + } + }, "Termvectors_BodyParams": { - "type": "object" + "type": "object", + "description": "Define parameters and or supply a document to get termvectors for. See documentation." }, "Time": { "type": "string", @@ -29582,11 +32137,93 @@ } } }, + "UpdateAuditConfigurationResponseContent": { + "type": "object", + "properties": { + "status": { + "type": "string", + "description": "Security Operation Status" + }, + "message": { + "type": "string", + "description": "Security Operation Message" + } + } + }, "UpdateByQuery_BodyParams": { - "type": "object" + "type": "object", + "description": "The search definition using the Query DSL" + }, + "UpdateConfigurationResponseContent": { + "type": "object", + "properties": { + "status": { + "type": "string", + "description": "Security Operation Status" + }, + "message": { + "type": "string", + "description": "Security Operation Message" + } + } + }, + "UpdateDistinguishedNamesResponseContent": { + "type": "object", + "properties": { + "status": { + "type": "string", + "description": "Security Operation Status" + }, + "message": { + "type": "string", + "description": "Security Operation Message" + } + } }, "Update_BodyParams": { - "type": "object" + "type": "object", + "description": "The request definition requires either `script` or partial `doc`" + }, + "User": { + "type": "object", + "properties": { + "hash": { + "type": "string" + }, + "reserved": { + "type": "boolean" + }, + "hidden": { + "type": "boolean" + }, + "backend_roles": { + "type": "array", + "items": { + "type": "string" + } + }, + "attributes": { + "$ref": "#/components/schemas/UserAttributes" + }, + "description": { + "type": "string" + }, + "opendistro_security_roles": { + "type": "array", + "items": { + "type": "string" + } + }, + "static": { + "type": "boolean" + } + } + }, + "UserAttributes": { + "type": "object", + "additionalProperties": { + "type": "string" + } }, "UserDefinedObjectStructure": { "type": "object", @@ -29718,6 +32355,26 @@ "type": "object", "additionalProperties": {} }, + "UserTenants": { + "type": "object", + "properties": { + "global_tenant": { + "type": "boolean" + }, + "admin_tenant": { + "type": "boolean" + }, + "admin": { + "type": "boolean" + } + } + }, + "UsersMap": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/User" + } + }, "VersionType": { "type": "string", "description": "Specific version type.", diff --git a/src/ApiGenerator/Views/HighLevel/Client/Implementation/OpenSearchClient.Namespace.cshtml b/src/ApiGenerator/Views/HighLevel/Client/Implementation/OpenSearchClient.Namespace.cshtml index 7073b4271b..331099fb9b 100644 --- a/src/ApiGenerator/Views/HighLevel/Client/Implementation/OpenSearchClient.Namespace.cshtml +++ b/src/ApiGenerator/Views/HighLevel/Client/Implementation/OpenSearchClient.Namespace.cshtml @@ -24,7 +24,7 @@ namespace OpenSearch.Client.@(CsharpNames.ApiNamespace).@ns@(CsharpNames.ApiName /// on . /// /// - public class @(CsharpNames.HighLevelClientNamespacePrefix)@ns@(CsharpNames.ClientNamespaceSuffix) : NamespacedClientProxy + public partial class @(CsharpNames.HighLevelClientNamespacePrefix)@ns@(CsharpNames.ClientNamespaceSuffix) : NamespacedClientProxy { internal @(CsharpNames.HighLevelClientNamespacePrefix)@ns@(CsharpNames.ClientNamespaceSuffix)(OpenSearchClient client) : base(client) {} @foreach(var e in endpoints) diff --git a/src/ApiGenerator/Views/HighLevel/Descriptors/Descriptors.cshtml b/src/ApiGenerator/Views/HighLevel/Descriptors/Descriptors.cshtml index 84f3949367..ca37a794ec 100644 --- a/src/ApiGenerator/Views/HighLevel/Descriptors/Descriptors.cshtml +++ b/src/ApiGenerator/Views/HighLevel/Descriptors/Descriptors.cshtml @@ -27,7 +27,7 @@ using OpenSearch.Net.Utf8Json; // ReSharper disable UnusedTypeParameter // ReSharper disable PartialMethodWithSinglePart // ReSharper disable RedundantNameQualifier -namespace OpenSearch.Client +namespace OpenSearch.Client@(ns) { @foreach (var endpoint in endpoints) { diff --git a/src/ApiGenerator/Views/HighLevel/Requests/Requests.cshtml b/src/ApiGenerator/Views/HighLevel/Requests/Requests.cshtml index 3263b77c3f..ccf86d4973 100644 --- a/src/ApiGenerator/Views/HighLevel/Requests/Requests.cshtml +++ b/src/ApiGenerator/Views/HighLevel/Requests/Requests.cshtml @@ -27,7 +27,7 @@ using OpenSearch.Net.Utf8Json; // ReSharper disable UnusedTypeParameter // ReSharper disable PartialMethodWithSinglePart // ReSharper disable RedundantNameQualifier -namespace OpenSearch.Client +namespace OpenSearch.Client@(ns) { @foreach (var endpoint in endpoints) { diff --git a/src/OpenSearch.Client/ApiUrlsLookup.cs b/src/OpenSearch.Client/ApiUrlsLookup.cs index 28bd5e11ed..efc812b850 100644 --- a/src/OpenSearch.Client/ApiUrlsLookup.cs +++ b/src/OpenSearch.Client/ApiUrlsLookup.cs @@ -172,9 +172,6 @@ internal static partial class ApiUrlsLookups internal static ApiUrls SnapshotRestore = new ApiUrls(new[]{"_snapshot/{repository}/{snapshot}/_restore"}); internal static ApiUrls SnapshotStatus = new ApiUrls(new[]{"_snapshot/_status", "_snapshot/{repository}/_status", "_snapshot/{repository}/{snapshot}/_status"}); internal static ApiUrls SnapshotVerifyRepository = new ApiUrls(new[]{"_snapshot/{repository}/_verify"}); - internal static ApiUrls TasksCancel = new ApiUrls(new[]{"_tasks/_cancel", "_tasks/{task_id}/_cancel"}); - internal static ApiUrls TasksGetTask = new ApiUrls(new[]{"_tasks/{task_id}"}); - internal static ApiUrls TasksList = new ApiUrls(new[]{"_tasks"}); internal static ApiUrls NoNamespaceTermVectors = new ApiUrls(new[]{"{index}/_termvectors/{id}", "{index}/_termvectors"}); internal static ApiUrls NoNamespaceUpdate = new ApiUrls(new[]{"{index}/_update/{id}"}); internal static ApiUrls NoNamespaceUpdateByQuery = new ApiUrls(new[]{"{index}/_update_by_query"}); diff --git a/src/OpenSearch.Client/Descriptors.Tasks.cs b/src/OpenSearch.Client/Descriptors.Tasks.cs deleted file mode 100644 index 3c93a1bf95..0000000000 --- a/src/OpenSearch.Client/Descriptors.Tasks.cs +++ /dev/null @@ -1,136 +0,0 @@ -/* SPDX-License-Identifier: Apache-2.0 -* -* The OpenSearch Contributors require contributions made to -* this file be licensed under the Apache-2.0 license or a -* compatible open source license. -*/ -/* -* Modifications Copyright OpenSearch Contributors. See -* GitHub history for details. -* -* Licensed to Elasticsearch B.V. under one or more contributor -* license agreements. See the NOTICE file distributed with -* this work for additional information regarding copyright -* ownership. Elasticsearch B.V. licenses this file to you under -* the Apache License, Version 2.0 (the "License"); you may -* not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, -* software distributed under the License is distributed on an -* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -* KIND, either express or implied. See the License for the -* specific language governing permissions and limitations -* under the License. -*/ -// ███╗ ██╗ ██████╗ ████████╗██╗ ██████╗███████╗ -// ████╗ ██║██╔═══██╗╚══██╔══╝██║██╔════╝██╔════╝ -// ██╔██╗ ██║██║ ██║ ██║ ██║██║ █████╗ -// ██║╚██╗██║██║ ██║ ██║ ██║██║ ██╔══╝ -// ██║ ╚████║╚██████╔╝ ██║ ██║╚██████╗███████╗ -// ╚═╝ ╚═══╝ ╚═════╝ ╚═╝ ╚═╝ ╚═════╝╚══════╝ -// ----------------------------------------------- -// -// This file is automatically generated -// Please do not edit these files manually -// Run the following in the root of the repos: -// -// *NIX : ./build.sh codegen -// Windows : build.bat codegen -// -// ----------------------------------------------- -// ReSharper disable RedundantUsingDirective -using System; -using System.Collections.Generic; -using System.Linq; -using System.Text; -using System.Linq.Expressions; -using OpenSearch.Net; -using OpenSearch.Net.Utf8Json; -using OpenSearch.Net.Specification.TasksApi; - -// ReSharper disable RedundantBaseConstructorCall -// ReSharper disable UnusedTypeParameter -// ReSharper disable PartialMethodWithSinglePart -// ReSharper disable RedundantNameQualifier -namespace OpenSearch.Client.Specification.TasksApi -{ - ///Descriptor for Cancel https://opensearch.org/docs/latest/opensearch/rest-api/cat/cat-tasks/ - public partial class CancelTasksDescriptor : RequestDescriptorBase, ICancelTasksRequest - { - internal override ApiUrls ApiUrls => ApiUrlsLookups.TasksCancel; - ////_tasks/_cancel - public CancelTasksDescriptor(): base() - { - } - - ////_tasks/{task_id}/_cancel - ///Optional, accepts null - public CancelTasksDescriptor(TaskId taskId): base(r => r.Optional("task_id", taskId)) - { - } - - // values part of the url path - TaskId ICancelTasksRequest.TaskId => Self.RouteValues.Get("task_id"); - ///Cancel the task with specified task id (node_id:task_number) - public CancelTasksDescriptor TaskId(TaskId taskId) => Assign(taskId, (a, v) => a.RouteValues.Optional("task_id", v)); - // Request parameters - ///A comma-separated list of actions that should be cancelled. Leave empty to cancel all. - public CancelTasksDescriptor Actions(params string[] actions) => Qs("actions", actions); - ///A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes - public CancelTasksDescriptor Nodes(params string[] nodes) => Qs("nodes", nodes); - ///Cancel tasks with specified parent task id (node_id:task_number). Set to -1 to cancel all. - public CancelTasksDescriptor ParentTaskId(string parenttaskid) => Qs("parent_task_id", parenttaskid); - ///Should the request block until the cancellation of the task and its descendant tasks is completed. Defaults to false - public CancelTasksDescriptor WaitForCompletion(bool? waitforcompletion = true) => Qs("wait_for_completion", waitforcompletion); - } - - ///Descriptor for GetTask https://opensearch.org/docs/latest/opensearch/rest-api/cat/cat-tasks/ - public partial class GetTaskDescriptor : RequestDescriptorBase, IGetTaskRequest - { - internal override ApiUrls ApiUrls => ApiUrlsLookups.TasksGetTask; - ////_tasks/{task_id} - ///this parameter is required - public GetTaskDescriptor(TaskId taskId): base(r => r.Required("task_id", taskId)) - { - } - - ///Used for serialization purposes, making sure we have a parameterless constructor - [SerializationConstructor] - protected GetTaskDescriptor(): base() - { - } - - // values part of the url path - TaskId IGetTaskRequest.TaskId => Self.RouteValues.Get("task_id"); - // Request parameters - ///Explicit operation timeout - public GetTaskDescriptor Timeout(Time timeout) => Qs("timeout", timeout); - ///Wait for the matching tasks to complete (default: false) - public GetTaskDescriptor WaitForCompletion(bool? waitforcompletion = true) => Qs("wait_for_completion", waitforcompletion); - } - - ///Descriptor for List https://opensearch.org/docs/latest/opensearch/rest-api/cat/cat-tasks/ - public partial class ListTasksDescriptor : RequestDescriptorBase, IListTasksRequest - { - internal override ApiUrls ApiUrls => ApiUrlsLookups.TasksList; - // values part of the url path - // Request parameters - ///A comma-separated list of actions that should be returned. Leave empty to return all. - public ListTasksDescriptor Actions(params string[] actions) => Qs("actions", actions); - ///Return detailed task information (default: false) - public ListTasksDescriptor Detailed(bool? detailed = true) => Qs("detailed", detailed); - ///Group tasks by nodes or parent/child relationships - public ListTasksDescriptor GroupBy(GroupBy? groupby) => Qs("group_by", groupby); - ///A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes - public ListTasksDescriptor Nodes(params string[] nodes) => Qs("nodes", nodes); - ///Return tasks with specified parent task id (node_id:task_number). Set to -1 to return all. - public ListTasksDescriptor ParentTaskId(string parenttaskid) => Qs("parent_task_id", parenttaskid); - ///Explicit operation timeout - public ListTasksDescriptor Timeout(Time timeout) => Qs("timeout", timeout); - ///Wait for the matching tasks to complete (default: false) - public ListTasksDescriptor WaitForCompletion(bool? waitforcompletion = true) => Qs("wait_for_completion", waitforcompletion); - } -} diff --git a/src/OpenSearch.Client/IOpenSearchClient.Generated.cs b/src/OpenSearch.Client/IOpenSearchClient.Generated.cs index 5a89dd0dae..b0d3b7b52d 100644 --- a/src/OpenSearch.Client/IOpenSearchClient.Generated.cs +++ b/src/OpenSearch.Client/IOpenSearchClient.Generated.cs @@ -1042,11 +1042,5 @@ SnapshotNamespace Snapshot { get; } - - ///Tasks APIs - TasksNamespace Tasks - { - get; - } } } diff --git a/src/OpenSearch.Client/OpenSearchClient.NoNamespace.cs b/src/OpenSearch.Client/OpenSearchClient.NoNamespace.cs index 3339ea442c..b98b2170c5 100644 --- a/src/OpenSearch.Client/OpenSearchClient.NoNamespace.cs +++ b/src/OpenSearch.Client/OpenSearchClient.NoNamespace.cs @@ -112,13 +112,6 @@ public SnapshotNamespace Snapshot private set; } - ///Tasks APIs - public TasksNamespace Tasks - { - get; - private set; - } - partial void SetupNamespaces() { Cat = new CatNamespace(this); @@ -128,7 +121,6 @@ partial void SetupNamespaces() Ingest = new IngestNamespace(this); Nodes = new NodesNamespace(this); Snapshot = new SnapshotNamespace(this); - Tasks = new TasksNamespace(this); } /// diff --git a/src/OpenSearch.Client/OpenSearchClient.Tasks.cs b/src/OpenSearch.Client/OpenSearchClient.Tasks.cs deleted file mode 100644 index b92a7443c6..0000000000 --- a/src/OpenSearch.Client/OpenSearchClient.Tasks.cs +++ /dev/null @@ -1,139 +0,0 @@ -/* SPDX-License-Identifier: Apache-2.0 -* -* The OpenSearch Contributors require contributions made to -* this file be licensed under the Apache-2.0 license or a -* compatible open source license. -*/ -/* -* Modifications Copyright OpenSearch Contributors. See -* GitHub history for details. -* -* Licensed to Elasticsearch B.V. under one or more contributor -* license agreements. See the NOTICE file distributed with -* this work for additional information regarding copyright -* ownership. Elasticsearch B.V. licenses this file to you under -* the Apache License, Version 2.0 (the "License"); you may -* not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, -* software distributed under the License is distributed on an -* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -* KIND, either express or implied. See the License for the -* specific language governing permissions and limitations -* under the License. -*/ -// ███╗ ██╗ ██████╗ ████████╗██╗ ██████╗███████╗ -// ████╗ ██║██╔═══██╗╚══██╔══╝██║██╔════╝██╔════╝ -// ██╔██╗ ██║██║ ██║ ██║ ██║██║ █████╗ -// ██║╚██╗██║██║ ██║ ██║ ██║██║ ██╔══╝ -// ██║ ╚████║╚██████╔╝ ██║ ██║╚██████╗███████╗ -// ╚═╝ ╚═══╝ ╚═════╝ ╚═╝ ╚═╝ ╚═════╝╚══════╝ -// ----------------------------------------------- -// -// This file is automatically generated -// Please do not edit these files manually -// Run the following in the root of the repos: -// -// *NIX : ./build.sh codegen -// Windows : build.bat codegen -// -// ----------------------------------------------- -// ReSharper disable RedundantUsingDirective -using System; -using System.Threading; -using System.Threading.Tasks; -using OpenSearch.Net.Specification.TasksApi; - -// ReSharper disable once CheckNamespace -// ReSharper disable RedundantTypeArgumentsOfMethod -namespace OpenSearch.Client.Specification.TasksApi -{ - /// - /// Tasks APIs. - /// Not intended to be instantiated directly. Use the property - /// on . - /// - /// - public class TasksNamespace : NamespacedClientProxy - { - internal TasksNamespace(OpenSearchClient client): base(client) - { - } - - /// - /// POST request to the tasks.cancel API, read more about this API online: - /// - /// https://opensearch.org/docs/latest/opensearch/rest-api/cat/cat-tasks/ - /// - public CancelTasksResponse Cancel(Func selector = null) => Cancel(selector.InvokeOrDefault(new CancelTasksDescriptor())); - /// - /// POST request to the tasks.cancel API, read more about this API online: - /// - /// https://opensearch.org/docs/latest/opensearch/rest-api/cat/cat-tasks/ - /// - public Task CancelAsync(Func selector = null, CancellationToken ct = default) => CancelAsync(selector.InvokeOrDefault(new CancelTasksDescriptor()), ct); - /// - /// POST request to the tasks.cancel API, read more about this API online: - /// - /// https://opensearch.org/docs/latest/opensearch/rest-api/cat/cat-tasks/ - /// - public CancelTasksResponse Cancel(ICancelTasksRequest request) => DoRequest(request, request.RequestParameters); - /// - /// POST request to the tasks.cancel API, read more about this API online: - /// - /// https://opensearch.org/docs/latest/opensearch/rest-api/cat/cat-tasks/ - /// - public Task CancelAsync(ICancelTasksRequest request, CancellationToken ct = default) => DoRequestAsync(request, request.RequestParameters, ct); - /// - /// GET request to the tasks.get API, read more about this API online: - /// - /// https://opensearch.org/docs/latest/opensearch/rest-api/cat/cat-tasks/ - /// - public GetTaskResponse GetTask(TaskId taskId, Func selector = null) => GetTask(selector.InvokeOrDefault(new GetTaskDescriptor(taskId: taskId))); - /// - /// GET request to the tasks.get API, read more about this API online: - /// - /// https://opensearch.org/docs/latest/opensearch/rest-api/cat/cat-tasks/ - /// - public Task GetTaskAsync(TaskId taskId, Func selector = null, CancellationToken ct = default) => GetTaskAsync(selector.InvokeOrDefault(new GetTaskDescriptor(taskId: taskId)), ct); - /// - /// GET request to the tasks.get API, read more about this API online: - /// - /// https://opensearch.org/docs/latest/opensearch/rest-api/cat/cat-tasks/ - /// - public GetTaskResponse GetTask(IGetTaskRequest request) => DoRequest(request, request.RequestParameters); - /// - /// GET request to the tasks.get API, read more about this API online: - /// - /// https://opensearch.org/docs/latest/opensearch/rest-api/cat/cat-tasks/ - /// - public Task GetTaskAsync(IGetTaskRequest request, CancellationToken ct = default) => DoRequestAsync(request, request.RequestParameters, ct); - /// - /// GET request to the tasks.list API, read more about this API online: - /// - /// https://opensearch.org/docs/latest/opensearch/rest-api/cat/cat-tasks/ - /// - public ListTasksResponse List(Func selector = null) => List(selector.InvokeOrDefault(new ListTasksDescriptor())); - /// - /// GET request to the tasks.list API, read more about this API online: - /// - /// https://opensearch.org/docs/latest/opensearch/rest-api/cat/cat-tasks/ - /// - public Task ListAsync(Func selector = null, CancellationToken ct = default) => ListAsync(selector.InvokeOrDefault(new ListTasksDescriptor()), ct); - /// - /// GET request to the tasks.list API, read more about this API online: - /// - /// https://opensearch.org/docs/latest/opensearch/rest-api/cat/cat-tasks/ - /// - public ListTasksResponse List(IListTasksRequest request) => DoRequest(request, request.RequestParameters); - /// - /// GET request to the tasks.list API, read more about this API online: - /// - /// https://opensearch.org/docs/latest/opensearch/rest-api/cat/cat-tasks/ - /// - public Task ListAsync(IListTasksRequest request, CancellationToken ct = default) => DoRequestAsync(request, request.RequestParameters, ct); - } -} diff --git a/src/OpenSearch.Client/Requests.Tasks.cs b/src/OpenSearch.Client/Requests.Tasks.cs deleted file mode 100644 index 0335882a3b..0000000000 --- a/src/OpenSearch.Client/Requests.Tasks.cs +++ /dev/null @@ -1,236 +0,0 @@ -/* SPDX-License-Identifier: Apache-2.0 -* -* The OpenSearch Contributors require contributions made to -* this file be licensed under the Apache-2.0 license or a -* compatible open source license. -*/ -/* -* Modifications Copyright OpenSearch Contributors. See -* GitHub history for details. -* -* Licensed to Elasticsearch B.V. under one or more contributor -* license agreements. See the NOTICE file distributed with -* this work for additional information regarding copyright -* ownership. Elasticsearch B.V. licenses this file to you under -* the Apache License, Version 2.0 (the "License"); you may -* not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, -* software distributed under the License is distributed on an -* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -* KIND, either express or implied. See the License for the -* specific language governing permissions and limitations -* under the License. -*/ -// ███╗ ██╗ ██████╗ ████████╗██╗ ██████╗███████╗ -// ████╗ ██║██╔═══██╗╚══██╔══╝██║██╔════╝██╔════╝ -// ██╔██╗ ██║██║ ██║ ██║ ██║██║ █████╗ -// ██║╚██╗██║██║ ██║ ██║ ██║██║ ██╔══╝ -// ██║ ╚████║╚██████╔╝ ██║ ██║╚██████╗███████╗ -// ╚═╝ ╚═══╝ ╚═════╝ ╚═╝ ╚═╝ ╚═════╝╚══════╝ -// ----------------------------------------------- -// -// This file is automatically generated -// Please do not edit these files manually -// Run the following in the root of the repos: -// -// *NIX : ./build.sh codegen -// Windows : build.bat codegen -// -// ----------------------------------------------- -// ReSharper disable RedundantUsingDirective -using System; -using System.Collections.Generic; -using System.Linq; -using System.Text; -using System.Linq.Expressions; -using System.Runtime.Serialization; -using OpenSearch.Net; -using OpenSearch.Net.Utf8Json; -using OpenSearch.Net.Specification.TasksApi; - -// ReSharper disable RedundantBaseConstructorCall -// ReSharper disable UnusedTypeParameter -// ReSharper disable PartialMethodWithSinglePart -// ReSharper disable RedundantNameQualifier -namespace OpenSearch.Client.Specification.TasksApi -{ - [InterfaceDataContract] - public partial interface ICancelTasksRequest : IRequest - { - [IgnoreDataMember] - TaskId TaskId - { - get; - } - } - - ///Request for Cancel https://opensearch.org/docs/latest/opensearch/rest-api/cat/cat-tasks/ - ///Note: Experimental within the OpenSearch server, this functionality is experimental and may be changed or removed completely in a future release. OpenSearch will take a best effort approach to fix any issues, but experimental features are not subject to the support SLA of official GA features. - public partial class CancelTasksRequest : PlainRequestBase, ICancelTasksRequest - { - protected ICancelTasksRequest Self => this; - internal override ApiUrls ApiUrls => ApiUrlsLookups.TasksCancel; - ////_tasks/_cancel - public CancelTasksRequest(): base() - { - } - - ////_tasks/{task_id}/_cancel - ///Optional, accepts null - public CancelTasksRequest(TaskId taskId): base(r => r.Optional("task_id", taskId)) - { - } - - // values part of the url path - [IgnoreDataMember] - TaskId ICancelTasksRequest.TaskId => Self.RouteValues.Get("task_id"); - // Request parameters - ///A comma-separated list of actions that should be cancelled. Leave empty to cancel all. - public string[] Actions - { - get => Q("actions"); - set => Q("actions", value); - } - - /// - /// A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're - /// connecting to, leave empty to get information from all nodes - /// - public string[] Nodes - { - get => Q("nodes"); - set => Q("nodes", value); - } - - ///Cancel tasks with specified parent task id (node_id:task_number). Set to -1 to cancel all. - public string ParentTaskId - { - get => Q("parent_task_id"); - set => Q("parent_task_id", value); - } - - ///Should the request block until the cancellation of the task and its descendant tasks is completed. Defaults to false - public bool? WaitForCompletion - { - get => Q("wait_for_completion"); - set => Q("wait_for_completion", value); - } - } - - [InterfaceDataContract] - public partial interface IGetTaskRequest : IRequest - { - [IgnoreDataMember] - TaskId TaskId - { - get; - } - } - - ///Request for GetTask https://opensearch.org/docs/latest/opensearch/rest-api/cat/cat-tasks/ - ///Note: Experimental within the OpenSearch server, this functionality is experimental and may be changed or removed completely in a future release. OpenSearch will take a best effort approach to fix any issues, but experimental features are not subject to the support SLA of official GA features. - public partial class GetTaskRequest : PlainRequestBase, IGetTaskRequest - { - protected IGetTaskRequest Self => this; - internal override ApiUrls ApiUrls => ApiUrlsLookups.TasksGetTask; - ////_tasks/{task_id} - ///this parameter is required - public GetTaskRequest(TaskId taskId): base(r => r.Required("task_id", taskId)) - { - } - - ///Used for serialization purposes, making sure we have a parameterless constructor - [SerializationConstructor] - protected GetTaskRequest(): base() - { - } - - // values part of the url path - [IgnoreDataMember] - TaskId IGetTaskRequest.TaskId => Self.RouteValues.Get("task_id"); - // Request parameters - ///Explicit operation timeout - public Time Timeout - { - get => Q