From 69f77d2d0fb0bf162f2e08b024412248f17eb5ae Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Mon, 12 Aug 2024 00:05:45 +0000 Subject: [PATCH] Re-generate client code using latest OpenSearch API specification (2024-08-12) Signed-off-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> --- .../client/opensearch/_types/ErrorCause.java | 6 +- .../DeleteDanglingIndexRequest.java | 62 +- .../ImportDanglingIndexRequest.java | 62 +- java-codegen/opensearch-openapi.yaml | 843 ++++++++++-------- 4 files changed, 505 insertions(+), 468 deletions(-) diff --git a/java-client/src/generated/java/org/opensearch/client/opensearch/_types/ErrorCause.java b/java-client/src/generated/java/org/opensearch/client/opensearch/_types/ErrorCause.java index 2941b7ea30..4ce2076a0b 100644 --- a/java-client/src/generated/java/org/opensearch/client/opensearch/_types/ErrorCause.java +++ b/java-client/src/generated/java/org/opensearch/client/opensearch/_types/ErrorCause.java @@ -148,7 +148,7 @@ public final String type() { } /** - * Additional details about the error + * Additional details about the error. */ public final Map metadata() { return this.metadata; @@ -355,7 +355,7 @@ public final Builder type(String value) { } /** - * Additional details about the error + * Additional details about the error. */ public final Builder metadata(Map map) { this.metadata = _mapPutAll(this.metadata, map); @@ -363,7 +363,7 @@ public final Builder metadata(Map map) { } /** - * Additional details about the error + * Additional details about the error. */ public final Builder metadata(String key, JsonData value) { this.metadata = _mapPut(this.metadata, key, value); diff --git a/java-client/src/generated/java/org/opensearch/client/opensearch/dangling_indices/DeleteDanglingIndexRequest.java b/java-client/src/generated/java/org/opensearch/client/opensearch/dangling_indices/DeleteDanglingIndexRequest.java index 4f6ea2ac3c..a2d5348f6c 100644 --- a/java-client/src/generated/java/org/opensearch/client/opensearch/dangling_indices/DeleteDanglingIndexRequest.java +++ b/java-client/src/generated/java/org/opensearch/client/opensearch/dangling_indices/DeleteDanglingIndexRequest.java @@ -43,7 +43,6 @@ import javax.annotation.Nullable; import org.opensearch.client.opensearch._types.ErrorResponse; import org.opensearch.client.opensearch._types.RequestBase; -import org.opensearch.client.opensearch._types.Time; import org.opensearch.client.transport.Endpoint; import org.opensearch.client.transport.endpoints.SimpleEndpoint; import org.opensearch.client.util.ApiTypeHelper; @@ -61,16 +60,16 @@ public class DeleteDanglingIndexRequest extends RequestBase { private final boolean acceptDataLoss; @Nullable - private final Time clusterManagerTimeout; + private final String clusterManagerTimeout; private final String indexUuid; @Deprecated @Nullable - private final Time masterTimeout; + private final String masterTimeout; @Nullable - private final Time timeout; + private final String timeout; // --------------------------------------------------------------------------------------------- @@ -105,7 +104,7 @@ public final boolean acceptDataLoss() { *

*/ @Nullable - public final Time clusterManagerTimeout() { + public final String clusterManagerTimeout() { return this.clusterManagerTimeout; } @@ -127,7 +126,7 @@ public final String indexUuid() { */ @Deprecated @Nullable - public final Time masterTimeout() { + public final String masterTimeout() { return this.masterTimeout; } @@ -138,7 +137,7 @@ public final Time masterTimeout() { *

*/ @Nullable - public final Time timeout() { + public final String timeout() { return this.timeout; } @@ -150,12 +149,12 @@ public final Time timeout() { public static class Builder extends ObjectBuilderBase implements ObjectBuilder { private Boolean acceptDataLoss; @Nullable - private Time clusterManagerTimeout; + private String clusterManagerTimeout; private String indexUuid; @Nullable - private Time masterTimeout; + private String masterTimeout; @Nullable - private Time timeout; + private String timeout; /** * Required - Must be set to true in order to delete the dangling index @@ -174,21 +173,11 @@ public final Builder acceptDataLoss(boolean value) { * API name: {@code cluster_manager_timeout} *

*/ - public final Builder clusterManagerTimeout(@Nullable Time value) { + public final Builder clusterManagerTimeout(@Nullable String value) { this.clusterManagerTimeout = value; return this; } - /** - * Operation timeout for connection to cluster-manager node. - *

- * API name: {@code cluster_manager_timeout} - *

- */ - public final Builder clusterManagerTimeout(Function> fn) { - return clusterManagerTimeout(fn.apply(new Time.Builder()).build()); - } - /** * Required - The UUID of the dangling index *

@@ -207,43 +196,22 @@ public final Builder indexUuid(String value) { *

*/ @Deprecated - public final Builder masterTimeout(@Nullable Time value) { + public final Builder masterTimeout(@Nullable String value) { this.masterTimeout = value; return this; } - /** - * Specify timeout for connection to master - *

- * API name: {@code master_timeout} - *

- */ - @Deprecated - public final Builder masterTimeout(Function> fn) { - return masterTimeout(fn.apply(new Time.Builder()).build()); - } - /** * Explicit operation timeout *

* API name: {@code timeout} *

*/ - public final Builder timeout(@Nullable Time value) { + public final Builder timeout(@Nullable String value) { this.timeout = value; return this; } - /** - * Explicit operation timeout - *

- * API name: {@code timeout} - *

- */ - public final Builder timeout(Function> fn) { - return timeout(fn.apply(new Time.Builder()).build()); - } - /** * Builds a {@link DeleteDanglingIndexRequest}. * @@ -276,13 +244,13 @@ public DeleteDanglingIndexRequest build() { Map params = new HashMap<>(); params.put("accept_data_loss", String.valueOf(request.acceptDataLoss)); if (request.clusterManagerTimeout != null) { - params.put("cluster_manager_timeout", request.clusterManagerTimeout._toJsonString()); + params.put("cluster_manager_timeout", request.clusterManagerTimeout); } if (request.masterTimeout != null) { - params.put("master_timeout", request.masterTimeout._toJsonString()); + params.put("master_timeout", request.masterTimeout); } if (request.timeout != null) { - params.put("timeout", request.timeout._toJsonString()); + params.put("timeout", request.timeout); } return params; }, diff --git a/java-client/src/generated/java/org/opensearch/client/opensearch/dangling_indices/ImportDanglingIndexRequest.java b/java-client/src/generated/java/org/opensearch/client/opensearch/dangling_indices/ImportDanglingIndexRequest.java index 4b1440b7eb..2a30af5f8b 100644 --- a/java-client/src/generated/java/org/opensearch/client/opensearch/dangling_indices/ImportDanglingIndexRequest.java +++ b/java-client/src/generated/java/org/opensearch/client/opensearch/dangling_indices/ImportDanglingIndexRequest.java @@ -43,7 +43,6 @@ import javax.annotation.Nullable; import org.opensearch.client.opensearch._types.ErrorResponse; import org.opensearch.client.opensearch._types.RequestBase; -import org.opensearch.client.opensearch._types.Time; import org.opensearch.client.transport.Endpoint; import org.opensearch.client.transport.endpoints.SimpleEndpoint; import org.opensearch.client.util.ApiTypeHelper; @@ -61,16 +60,16 @@ public class ImportDanglingIndexRequest extends RequestBase { private final boolean acceptDataLoss; @Nullable - private final Time clusterManagerTimeout; + private final String clusterManagerTimeout; private final String indexUuid; @Deprecated @Nullable - private final Time masterTimeout; + private final String masterTimeout; @Nullable - private final Time timeout; + private final String timeout; // --------------------------------------------------------------------------------------------- @@ -105,7 +104,7 @@ public final boolean acceptDataLoss() { *

*/ @Nullable - public final Time clusterManagerTimeout() { + public final String clusterManagerTimeout() { return this.clusterManagerTimeout; } @@ -127,7 +126,7 @@ public final String indexUuid() { */ @Deprecated @Nullable - public final Time masterTimeout() { + public final String masterTimeout() { return this.masterTimeout; } @@ -138,7 +137,7 @@ public final Time masterTimeout() { *

*/ @Nullable - public final Time timeout() { + public final String timeout() { return this.timeout; } @@ -150,12 +149,12 @@ public final Time timeout() { public static class Builder extends ObjectBuilderBase implements ObjectBuilder { private Boolean acceptDataLoss; @Nullable - private Time clusterManagerTimeout; + private String clusterManagerTimeout; private String indexUuid; @Nullable - private Time masterTimeout; + private String masterTimeout; @Nullable - private Time timeout; + private String timeout; /** * Required - Must be set to true in order to import the dangling index @@ -174,21 +173,11 @@ public final Builder acceptDataLoss(boolean value) { * API name: {@code cluster_manager_timeout} *

*/ - public final Builder clusterManagerTimeout(@Nullable Time value) { + public final Builder clusterManagerTimeout(@Nullable String value) { this.clusterManagerTimeout = value; return this; } - /** - * Operation timeout for connection to cluster-manager node. - *

- * API name: {@code cluster_manager_timeout} - *

- */ - public final Builder clusterManagerTimeout(Function> fn) { - return clusterManagerTimeout(fn.apply(new Time.Builder()).build()); - } - /** * Required - The UUID of the dangling index *

@@ -207,43 +196,22 @@ public final Builder indexUuid(String value) { *

*/ @Deprecated - public final Builder masterTimeout(@Nullable Time value) { + public final Builder masterTimeout(@Nullable String value) { this.masterTimeout = value; return this; } - /** - * Specify timeout for connection to master - *

- * API name: {@code master_timeout} - *

- */ - @Deprecated - public final Builder masterTimeout(Function> fn) { - return masterTimeout(fn.apply(new Time.Builder()).build()); - } - /** * Explicit operation timeout *

* API name: {@code timeout} *

*/ - public final Builder timeout(@Nullable Time value) { + public final Builder timeout(@Nullable String value) { this.timeout = value; return this; } - /** - * Explicit operation timeout - *

- * API name: {@code timeout} - *

- */ - public final Builder timeout(Function> fn) { - return timeout(fn.apply(new Time.Builder()).build()); - } - /** * Builds a {@link ImportDanglingIndexRequest}. * @@ -276,13 +244,13 @@ public ImportDanglingIndexRequest build() { Map params = new HashMap<>(); params.put("accept_data_loss", String.valueOf(request.acceptDataLoss)); if (request.clusterManagerTimeout != null) { - params.put("cluster_manager_timeout", request.clusterManagerTimeout._toJsonString()); + params.put("cluster_manager_timeout", request.clusterManagerTimeout); } if (request.masterTimeout != null) { - params.put("master_timeout", request.masterTimeout._toJsonString()); + params.put("master_timeout", request.masterTimeout); } if (request.timeout != null) { - params.put("timeout", request.timeout._toJsonString()); + params.put("timeout", request.timeout); } return params; }, diff --git a/java-codegen/opensearch-openapi.yaml b/java-codegen/opensearch-openapi.yaml index fb5695388c..eda71662fd 100644 --- a/java-codegen/opensearch-openapi.yaml +++ b/java-codegen/opensearch-openapi.yaml @@ -2,7 +2,7 @@ openapi: 3.1.0 info: title: OpenSearch API Specification version: 1.0.0 - x-api-version: 2.15.0 + x-api-version: 2.16.0 paths: /: get: @@ -4071,6 +4071,107 @@ paths: - $ref: '#/components/parameters/_global::query.error_trace' - $ref: '#/components/parameters/_global::query.source' - $ref: '#/components/parameters/_global::query.filter_path' + /_plugins/_ppl: + post: + operationId: ppl.query.0 + x-operation-group: ppl.query + x-version-added: '1.0' + description: Send a PPL query to the PPL plugin. + externalDocs: + url: https://opensearch.org/docs/latest/search-plugins/sql/sql-ppl-api/ + parameters: + - $ref: '#/components/parameters/ppl.query::query.format' + - $ref: '#/components/parameters/ppl.query::query.sanitize' + - $ref: '#/components/parameters/_global::query.pretty' + - $ref: '#/components/parameters/_global::query.human' + - $ref: '#/components/parameters/_global::query.error_trace' + - $ref: '#/components/parameters/_global::query.source' + - $ref: '#/components/parameters/_global::query.filter_path' + requestBody: + $ref: '#/components/requestBodies/ppl.query' + responses: + '200': + $ref: '#/components/responses/ppl.query@200' + /_plugins/_ppl/_explain: + post: + operationId: ppl.explain.0 + x-operation-group: ppl.explain + x-version-added: '1.0' + description: Shows how a query is executed against OpenSearch. + externalDocs: + url: https://opensearch.org/docs/latest/search-plugins/sql/sql-ppl-api/ + parameters: + - $ref: '#/components/parameters/ppl.explain::query.format' + - $ref: '#/components/parameters/ppl.explain::query.sanitize' + - $ref: '#/components/parameters/_global::query.pretty' + - $ref: '#/components/parameters/_global::query.human' + - $ref: '#/components/parameters/_global::query.error_trace' + - $ref: '#/components/parameters/_global::query.source' + - $ref: '#/components/parameters/_global::query.filter_path' + requestBody: + $ref: '#/components/requestBodies/ppl.explain' + responses: + '200': + $ref: '#/components/responses/ppl.explain@200' + /_plugins/_ppl/stats: + get: + operationId: ppl.get_stats.0 + x-operation-group: ppl.get_stats + x-version-added: '1.0' + description: Collect metrics for the plugin within the interval. + externalDocs: + url: https://opensearch.org/docs/latest/search-plugins/sql/monitoring/ + parameters: + - $ref: '#/components/parameters/ppl.get_stats::query.format' + - $ref: '#/components/parameters/ppl.get_stats::query.sanitize' + - $ref: '#/components/parameters/_global::query.pretty' + - $ref: '#/components/parameters/_global::query.human' + - $ref: '#/components/parameters/_global::query.error_trace' + - $ref: '#/components/parameters/_global::query.source' + - $ref: '#/components/parameters/_global::query.filter_path' + responses: + '200': + $ref: '#/components/responses/ppl.get_stats@200' + post: + operationId: ppl.post_stats.1 + x-operation-group: ppl.post_stats + x-version-added: '1.0' + description: By a stats endpoint, you are able to collect metrics for the plugin within the interval. + externalDocs: + url: https://opensearch.org/docs/latest/search-plugins/sql/monitoring/ + parameters: + - $ref: '#/components/parameters/ppl.post_stats::query.format' + - $ref: '#/components/parameters/ppl.post_stats::query.sanitize' + - $ref: '#/components/parameters/_global::query.pretty' + - $ref: '#/components/parameters/_global::query.human' + - $ref: '#/components/parameters/_global::query.error_trace' + - $ref: '#/components/parameters/_global::query.source' + - $ref: '#/components/parameters/_global::query.filter_path' + requestBody: + $ref: '#/components/requestBodies/ppl.post_stats' + responses: + '200': + $ref: '#/components/responses/ppl.post_stats@200' + /_plugins/_query/settings: + put: + operationId: sql.settings.0 + x-operation-group: sql.settings + x-version-added: '1.0' + description: Adds SQL settings to the standard OpenSearch cluster settings. + externalDocs: + url: https://opensearch.org/docs/latest/search-plugins/sql/settings/ + parameters: + - $ref: '#/components/parameters/sql.settings::query.format' + - $ref: '#/components/parameters/_global::query.pretty' + - $ref: '#/components/parameters/_global::query.human' + - $ref: '#/components/parameters/_global::query.error_trace' + - $ref: '#/components/parameters/_global::query.source' + - $ref: '#/components/parameters/_global::query.filter_path' + requestBody: + $ref: '#/components/requestBodies/sql.settings' + responses: + '200': + $ref: '#/components/responses/sql.settings@200' /_plugins/_rollup/jobs/{id}: delete: operationId: rollups.delete.0 @@ -5864,7 +5965,7 @@ paths: operationId: transforms.stop.0 x-operation-group: transforms.stop x-version-added: '1.0' - description: stop transform. + description: Stop transform. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/index-transforms/transforms-apis/#stop-a-transform-job parameters: @@ -10343,6 +10444,95 @@ paths: $ref: '#/components/responses/knn.stats@200' deprecated: true x-ignorable: true + /_opendistro/_ppl: + post: + operationId: ppl.query.0_superseded + x-operation-group: ppl.query + x-version-added: '1.0' + description: Send a PPL query to the PPL plugin. + externalDocs: + url: https://opensearch.org/docs/latest/search-plugins/sql/sql-ppl-api/ + parameters: + - $ref: '#/components/parameters/ppl.query::query.format' + - $ref: '#/components/parameters/ppl.query::query.sanitize' + - $ref: '#/components/parameters/_global::query.pretty' + - $ref: '#/components/parameters/_global::query.human' + - $ref: '#/components/parameters/_global::query.error_trace' + - $ref: '#/components/parameters/_global::query.source' + - $ref: '#/components/parameters/_global::query.filter_path' + requestBody: + $ref: '#/components/requestBodies/ppl.query' + responses: + '200': + $ref: '#/components/responses/ppl.query@200' + deprecated: true + x-ignorable: true + /_opendistro/_ppl/_explain: + post: + operationId: ppl.explain.0_superseded + x-operation-group: ppl.explain + x-version-added: '1.0' + description: Shows how a query is executed against OpenSearch. + externalDocs: + url: https://opensearch.org/docs/latest/search-plugins/sql/sql-ppl-api/ + parameters: + - $ref: '#/components/parameters/ppl.explain::query.format' + - $ref: '#/components/parameters/ppl.explain::query.sanitize' + - $ref: '#/components/parameters/_global::query.pretty' + - $ref: '#/components/parameters/_global::query.human' + - $ref: '#/components/parameters/_global::query.error_trace' + - $ref: '#/components/parameters/_global::query.source' + - $ref: '#/components/parameters/_global::query.filter_path' + requestBody: + $ref: '#/components/requestBodies/ppl.explain' + responses: + '200': + $ref: '#/components/responses/ppl.explain@200' + deprecated: true + x-ignorable: true + /_opendistro/_ppl/stats: + get: + operationId: ppl.get_stats.0_superseded + x-operation-group: ppl.get_stats + x-version-added: '1.0' + description: Collect metrics for the plugin within the interval. + externalDocs: + url: https://opensearch.org/docs/latest/search-plugins/sql/monitoring/ + parameters: + - $ref: '#/components/parameters/ppl.get_stats::query.format' + - $ref: '#/components/parameters/ppl.get_stats::query.sanitize' + - $ref: '#/components/parameters/_global::query.pretty' + - $ref: '#/components/parameters/_global::query.human' + - $ref: '#/components/parameters/_global::query.error_trace' + - $ref: '#/components/parameters/_global::query.source' + - $ref: '#/components/parameters/_global::query.filter_path' + responses: + '200': + $ref: '#/components/responses/ppl.get_stats@200' + deprecated: true + x-ignorable: true + post: + operationId: ppl.post_stats.1_superseded + x-operation-group: ppl.post_stats + x-version-added: '1.0' + description: By a stats endpoint, you are able to collect metrics for the plugin within the interval. + externalDocs: + url: https://opensearch.org/docs/latest/search-plugins/sql/monitoring/ + parameters: + - $ref: '#/components/parameters/ppl.post_stats::query.format' + - $ref: '#/components/parameters/ppl.post_stats::query.sanitize' + - $ref: '#/components/parameters/_global::query.pretty' + - $ref: '#/components/parameters/_global::query.human' + - $ref: '#/components/parameters/_global::query.error_trace' + - $ref: '#/components/parameters/_global::query.source' + - $ref: '#/components/parameters/_global::query.filter_path' + requestBody: + $ref: '#/components/requestBodies/ppl.post_stats' + responses: + '200': + $ref: '#/components/responses/ppl.post_stats@200' + deprecated: true + x-ignorable: true /_opendistro/_rollup/jobs/{rollupID}: get: operationId: rollups.get.0_superseded @@ -11774,6 +11964,28 @@ paths: $ref: '#/components/responses/sql.close@200' deprecated: true x-ignorable: true + /_opendistro/_sql/settings: + put: + operationId: sql.settings.0_superseded + x-operation-group: sql.settings + x-version-added: '1.0' + description: Adds SQL settings to the standard OpenSearch cluster settings. + externalDocs: + url: https://opensearch.org/docs/latest/search-plugins/sql/settings/ + parameters: + - $ref: '#/components/parameters/sql.settings::query.format' + - $ref: '#/components/parameters/_global::query.pretty' + - $ref: '#/components/parameters/_global::query.human' + - $ref: '#/components/parameters/_global::query.error_trace' + - $ref: '#/components/parameters/_global::query.source' + - $ref: '#/components/parameters/_global::query.filter_path' + requestBody: + $ref: '#/components/requestBodies/sql.settings' + responses: + '200': + $ref: '#/components/responses/sql.settings@200' + deprecated: true + x-ignorable: true /_opendistro/_sql/stats: get: operationId: sql.get_stats.0_superseded @@ -19689,6 +19901,58 @@ components: schema: type: string required: true + ppl.explain::query.format: + name: format + in: query + description: A short version of the Accept header, e.g. json, yaml. + schema: + type: string + ppl.explain::query.sanitize: + name: sanitize + in: query + description: Specifies whether to escape special characters in the results. + schema: + type: boolean + default: true + ppl.get_stats::query.format: + name: format + in: query + description: A short version of the Accept header, e.g. json, yaml. + schema: + type: string + ppl.get_stats::query.sanitize: + name: sanitize + in: query + description: Specifies whether to escape special characters in the results. + schema: + type: boolean + default: true + ppl.post_stats::query.format: + name: format + in: query + description: A short version of the Accept header, e.g. json, yaml. + schema: + type: string + ppl.post_stats::query.sanitize: + name: sanitize + in: query + description: Specifies whether to escape special characters in the results. + schema: + type: boolean + default: true + ppl.query::query.format: + name: format + in: query + description: A short version of the Accept header, e.g. json, yaml. + schema: + type: string + ppl.query::query.sanitize: + name: sanitize + in: query + description: Specifies whether to escape special characters in the results. + schema: + type: boolean + default: true put_script::path.context: in: path name: context @@ -21290,7 +21554,6 @@ components: description: A short version of the Accept header, e.g. json, yaml. schema: type: string - description: A short version of the Accept header, e.g. json, yaml. sql.close::query.sanitize: name: sanitize in: query @@ -21298,14 +21561,12 @@ components: schema: type: boolean default: true - description: Specifies whether to escape special characters in the results sql.explain::query.format: name: format in: query description: A short version of the Accept header, e.g. json, yaml. schema: type: string - description: A short version of the Accept header, e.g. json, yaml. sql.explain::query.sanitize: name: sanitize in: query @@ -21313,14 +21574,12 @@ components: schema: type: boolean default: true - description: Specifies whether to escape special characters in the results sql.get_stats::query.format: name: format in: query description: A short version of the Accept header, e.g. json, yaml. schema: type: string - description: A short version of the Accept header, e.g. json, yaml. sql.get_stats::query.sanitize: name: sanitize in: query @@ -21328,14 +21587,12 @@ components: schema: type: boolean default: true - description: Specifies whether to escape special characters in the results sql.post_stats::query.format: name: format in: query description: A short version of the Accept header, e.g. json, yaml. schema: type: string - description: A short version of the Accept header, e.g. json, yaml. sql.post_stats::query.sanitize: name: sanitize in: query @@ -21343,14 +21600,12 @@ components: schema: type: boolean default: true - description: Specifies whether to escape special characters in the results sql.query::query.format: name: format in: query description: A short version of the Accept header, e.g. json, yaml. schema: type: string - description: A short version of the Accept header, e.g. json, yaml. sql.query::query.sanitize: name: sanitize in: query @@ -21358,7 +21613,12 @@ components: schema: type: boolean default: true - description: Specifies whether to escape special characters in the results + sql.settings::query.format: + name: format + in: query + description: A short version of the Accept header, e.g. json, yaml. + schema: + type: string tasks.cancel::path.task_id: in: path name: task_id @@ -22887,6 +23147,24 @@ components: schema: $ref: '#/components/schemas/notifications._common:NotificationsConfig' required: true + ppl.explain: + content: + application/json: + schema: + $ref: '#/components/schemas/sql._common:Explain' + required: true + ppl.post_stats: + content: + application/json: + schema: + $ref: '#/components/schemas/sql._common:Stats' + required: true + ppl.query: + content: + application/json: + schema: + $ref: '#/components/schemas/sql._common:Query' + required: true put_script: content: application/json: @@ -22956,7 +23234,6 @@ components: examples: RemoteStoreRestore_example1: summary: Examples for Post Remote Storage Restore Operation. - description: '' value: indices: - books @@ -23500,19 +23777,27 @@ components: content: application/json: schema: - $ref: '#/components/schemas/sql._common:SqlExplain' + $ref: '#/components/schemas/sql._common:Explain' required: true sql.post_stats: content: application/json: schema: - $ref: '#/components/schemas/sql._common:SqlStats' + $ref: '#/components/schemas/sql._common:Stats' required: true sql.query: content: application/json: schema: - $ref: '#/components/schemas/sql._common:SqlQuery' + $ref: '#/components/schemas/sql._common:Query' + required: true + sql.settings: + content: + application/json: + schema: + anyOf: + - $ref: '#/components/schemas/sql._common:SqlSettingsPlain' + - $ref: '#/components/schemas/sql._common:SqlSettings' required: true termvectors: content: @@ -23587,7 +23872,6 @@ components: description: The search definition using the Query DSL responses: bulk@200: - description: '' content: application/json: schema: @@ -23612,7 +23896,6 @@ components: - items - took cat.aliases@200: - description: '' content: text/plain: type: string @@ -23622,7 +23905,6 @@ components: items: $ref: '#/components/schemas/cat.aliases:AliasesRecord' cat.all_pit_segments@200: - description: '' content: text/plain: type: string @@ -23632,7 +23914,6 @@ components: items: $ref: '#/components/schemas/cat._common:CatPitSegmentsRecord' cat.allocation@200: - description: '' content: text/plain: type: string @@ -23642,7 +23923,6 @@ components: items: $ref: '#/components/schemas/cat.allocation:AllocationRecord' cat.cluster_manager@200: - description: '' content: text/plain: type: string @@ -23652,7 +23932,6 @@ components: items: $ref: '#/components/schemas/cat.cluster_manager:ClusterManagerRecord' cat.count@200: - description: '' content: text/plain: type: string @@ -23662,7 +23941,6 @@ components: items: $ref: '#/components/schemas/cat.count:CountRecord' cat.fielddata@200: - description: '' content: text/plain: type: string @@ -23672,7 +23950,6 @@ components: items: $ref: '#/components/schemas/cat.fielddata:FielddataRecord' cat.health@200: - description: '' content: text/plain: type: string @@ -23697,13 +23974,11 @@ components: items: $ref: '#/components/schemas/cat.health:HealthRecord' cat.help@200: - description: '' content: text/plain: schema: type: string cat.indices@200: - description: '' content: text/plain: type: string @@ -23728,7 +24003,6 @@ components: items: $ref: '#/components/schemas/cat.indices:IndicesRecord' cat.master@200: - description: '' content: text/plain: type: string @@ -23738,7 +24012,6 @@ components: items: $ref: '#/components/schemas/cat.master:MasterRecord' cat.nodeattrs@200: - description: '' content: text/plain: type: string @@ -23748,7 +24021,6 @@ components: items: $ref: '#/components/schemas/cat.nodeattrs:NodeAttributesRecord' cat.nodes@200: - description: '' content: text/plain: type: string @@ -23758,7 +24030,6 @@ components: items: $ref: '#/components/schemas/cat.nodes:NodesRecord' cat.pending_tasks@200: - description: '' content: text/plain: type: string @@ -23768,7 +24039,6 @@ components: items: $ref: '#/components/schemas/cat.pending_tasks:PendingTasksRecord' cat.pit_segments@200: - description: '' content: text/plain: type: string @@ -23778,7 +24048,6 @@ components: items: $ref: '#/components/schemas/cat._common:CatPitSegmentsRecord' cat.plugins@200: - description: '' content: text/plain: type: string @@ -23788,7 +24057,6 @@ components: items: $ref: '#/components/schemas/cat.plugins:PluginsRecord' cat.recovery@200: - description: '' content: text/plain: type: string @@ -23798,7 +24066,6 @@ components: items: $ref: '#/components/schemas/cat.recovery:RecoveryRecord' cat.repositories@200: - description: '' content: text/plain: type: string @@ -23808,7 +24075,6 @@ components: items: $ref: '#/components/schemas/cat.repositories:RepositoriesRecord' cat.segment_replication@200: - description: '' content: text/plain: type: string @@ -23818,7 +24084,6 @@ components: items: $ref: '#/components/schemas/cat._common:CatSegmentReplicationRecord' cat.segments@200: - description: '' content: text/plain: type: string @@ -23828,7 +24093,6 @@ components: items: $ref: '#/components/schemas/cat.segments:SegmentsRecord' cat.shards@200: - description: '' content: text/plain: type: string @@ -23838,7 +24102,6 @@ components: items: $ref: '#/components/schemas/cat.shards:ShardsRecord' cat.snapshots@200: - description: '' content: text/plain: type: string @@ -23848,7 +24111,6 @@ components: items: $ref: '#/components/schemas/cat.snapshots:SnapshotsRecord' cat.tasks@200: - description: '' content: text/plain: type: string @@ -23858,7 +24120,6 @@ components: items: $ref: '#/components/schemas/cat.tasks:TasksRecord' cat.templates@200: - description: '' content: text/plain: type: string @@ -23868,7 +24129,6 @@ components: items: $ref: '#/components/schemas/cat.templates:TemplatesRecord' cat.thread_pool@200: - description: '' content: text/plain: type: string @@ -23878,7 +24138,6 @@ components: items: $ref: '#/components/schemas/cat.thread_pool:ThreadPoolRecord' clear_scroll@200: - description: '' content: application/json: schema: @@ -23892,7 +24151,6 @@ components: - num_freed - succeeded cluster.allocation_explain@200: - description: '' content: application/json: schema: @@ -23960,25 +24218,19 @@ components: - primary - shard cluster.delete_component_template@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/_common:AcknowledgedResponseBase' - cluster.delete_decommission_awareness@200: - description: '' + cluster.delete_decommission_awareness@200: {} cluster.delete_voting_config_exclusions@200: - description: '' content: application/json: {} - cluster.delete_weighted_routing@200: - description: '' + cluster.delete_weighted_routing@200: {} cluster.exists_component_template@200: - description: '' content: application/json: {} cluster.get_component_template@200: - description: '' content: application/json: schema: @@ -23990,10 +24242,8 @@ components: $ref: '#/components/schemas/cluster._common:ComponentTemplate' required: - component_templates - cluster.get_decommission_awareness@200: - description: '' + cluster.get_decommission_awareness@200: {} cluster.get_settings@200: - description: '' content: application/json: schema: @@ -24014,16 +24264,13 @@ components: required: - persistent - transient - cluster.get_weighted_routing@200: - description: '' + cluster.get_weighted_routing@200: {} cluster.health@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/cluster.health:HealthResponseBody' cluster.pending_tasks@200: - description: '' content: application/json: schema: @@ -24036,19 +24283,15 @@ components: required: - tasks cluster.post_voting_config_exclusions@200: - description: '' content: application/json: {} cluster.put_component_template@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/_common:AcknowledgedResponseBase' - cluster.put_decommission_awareness@200: - description: '' + cluster.put_decommission_awareness@200: {} cluster.put_settings@200: - description: '' content: application/json: schema: @@ -24066,10 +24309,8 @@ components: - acknowledged - persistent - transient - cluster.put_weighted_routing@200: - description: '' + cluster.put_weighted_routing@200: {} cluster.remote_info@200: - description: '' content: application/json: schema: @@ -24077,7 +24318,6 @@ components: additionalProperties: $ref: '#/components/schemas/cluster.remote_info:ClusterRemoteInfo' cluster.reroute@200: - description: '' content: application/json: schema: @@ -24098,19 +24338,16 @@ components: required: - acknowledged cluster.state@200: - description: '' content: application/json: schema: type: object cluster.stats@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/cluster.stats:StatsResponseBase' count@200: - description: '' content: application/json: schema: @@ -24124,7 +24361,6 @@ components: - _shards - count create_pit@200: - description: '' content: application/json: schema: @@ -24138,25 +24374,21 @@ components: type: integer format: int64 create@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/_common:WriteResponseBase' dangling_indices.delete_dangling_index@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/_common:AcknowledgedResponseBase' dangling_indices.import_dangling_index@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/_common:AcknowledgedResponseBase' dangling_indices.list_dangling_indices@200: - description: '' content: application/json: schema: @@ -24173,7 +24405,6 @@ components: required: - dangling_indices delete_all_pits@200: - description: '' content: application/json: schema: @@ -24184,13 +24415,11 @@ components: items: $ref: '#/components/schemas/_core._common:PitsDetailsDeleteAll' delete_by_query_rethrottle@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/tasks._common:TaskListResponseBase' delete_by_query@200: - description: '' content: application/json: schema: @@ -24231,7 +24460,6 @@ components: version_conflicts: type: number delete_pit@200: - description: '' content: application/json: schema: @@ -24242,27 +24470,22 @@ components: items: $ref: '#/components/schemas/_core._common:DeletedPit' delete_script@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/_common:AcknowledgedResponseBase' delete@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/_common:WriteResponseBase' exists_source@200: - description: '' content: application/json: {} exists@200: - description: '' content: application/json: {} explain@200: - description: '' content: application/json: schema: @@ -24283,7 +24506,6 @@ components: - _index - matched field_caps@200: - description: '' content: application/json: schema: @@ -24301,7 +24523,6 @@ components: - fields - indices get_all_pits@200: - description: '' content: application/json: schema: @@ -24312,7 +24533,6 @@ components: items: $ref: '#/components/schemas/_core._common:PitDetail' get_script_context@200: - description: '' content: application/json: schema: @@ -24325,7 +24545,6 @@ components: required: - contexts get_script_languages@200: - description: '' content: application/json: schema: @@ -24343,7 +24562,6 @@ components: - language_contexts - types_allowed get_script@200: - description: '' content: application/json: schema: @@ -24359,31 +24577,26 @@ components: - _id - found get_source@200: - description: '' content: application/json: schema: type: object get@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/_core.get:GetResult' index@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/_common:WriteResponseBase' index@201: - description: '' content: application/json: schema: $ref: '#/components/schemas/_common:WriteResponseBase' indices.add_block@200: - description: '' content: application/json: schema: @@ -24402,7 +24615,6 @@ components: - indices - shards_acknowledged indices.analyze@200: - description: '' content: application/json: schema: @@ -24415,13 +24627,11 @@ components: items: $ref: '#/components/schemas/indices.analyze:AnalyzeToken' indices.clear_cache@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/_common:ShardsOperationResponseBase' indices.clone@200: - description: '' content: application/json: schema: @@ -24438,7 +24648,6 @@ components: - index - shards_acknowledged indices.close@200: - description: '' content: application/json: schema: @@ -24457,13 +24666,11 @@ components: - indices - shards_acknowledged indices.create_data_stream@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/_common:AcknowledgedResponseBase' indices.create@200: - description: '' content: application/json: schema: @@ -24480,7 +24687,6 @@ components: - index - shards_acknowledged indices.data_streams_stats@200: - description: '' content: application/json: schema: @@ -24511,63 +24717,51 @@ components: - data_streams - total_store_size_bytes indices.delete_alias@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/_common:AcknowledgedResponseBase' indices.delete_data_stream@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/_common:AcknowledgedResponseBase' indices.delete_index_template@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/_common:AcknowledgedResponseBase' indices.delete_template@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/_common:AcknowledgedResponseBase' indices.delete@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/_common:IndicesResponseBase' indices.exists_alias@200: - description: '' content: application/json: {} indices.exists_index_template@200: - description: '' content: application/json: {} indices.exists_template@200: - description: '' content: application/json: {} indices.exists@200: - description: '' content: application/json: {} indices.exists@404: - description: '' content: application/json: {} indices.flush@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/_common:ShardsOperationResponseBase' indices.forcemerge@200: - description: '' content: application/json: schema: @@ -24581,7 +24775,6 @@ components: you can use the task_id to get the status of the task at _tasks/ type: string indices.get_alias@200: - description: '' content: application/json: schema: @@ -24589,7 +24782,6 @@ components: additionalProperties: $ref: '#/components/schemas/indices.get_alias:IndexAliases' indices.get_data_stream@200: - description: '' content: application/json: schema: @@ -24602,7 +24794,6 @@ components: required: - data_streams indices.get_field_mapping@200: - description: '' content: application/json: schema: @@ -24610,7 +24801,6 @@ components: additionalProperties: $ref: '#/components/schemas/indices.get_field_mapping:TypeFieldMappings' indices.get_index_template@200: - description: '' content: application/json: schema: @@ -24623,7 +24813,6 @@ components: required: - index_templates indices.get_mapping@200: - description: '' content: application/json: schema: @@ -24631,7 +24820,6 @@ components: additionalProperties: $ref: '#/components/schemas/indices.get_mapping:IndexMappingRecord' indices.get_settings@200: - description: '' content: application/json: schema: @@ -24639,17 +24827,14 @@ components: additionalProperties: $ref: '#/components/schemas/indices._common:IndexState' indices.get_template@200: - description: '' content: application/json: schema: type: object additionalProperties: $ref: '#/components/schemas/indices._common:TemplateMapping' - indices.get_upgrade@200: - description: '' + indices.get_upgrade@200: {} indices.get@200: - description: '' content: application/json: schema: @@ -24657,7 +24842,6 @@ components: additionalProperties: $ref: '#/components/schemas/indices._common:IndexState' indices.open@200: - description: '' content: application/json: schema: @@ -24678,37 +24862,31 @@ components: - shards_acknowledged additionalProperties: false indices.put_alias@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/_common:AcknowledgedResponseBase' indices.put_index_template@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/_common:AcknowledgedResponseBase' indices.put_mapping@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/_common:IndicesResponseBase' indices.put_settings@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/_common:AcknowledgedResponseBase' indices.put_template@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/_common:AcknowledgedResponseBase' indices.recovery@200: - description: '' content: application/json: schema: @@ -24716,13 +24894,11 @@ components: additionalProperties: $ref: '#/components/schemas/indices.recovery:RecoveryStatus' indices.refresh@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/_common:ShardsOperationResponseBase' indices.resolve_index@200: - description: '' content: application/json: schema: @@ -24745,7 +24921,6 @@ components: - data_streams - indices indices.rollover@200: - description: '' content: application/json: schema: @@ -24776,7 +24951,6 @@ components: - rolled_over - shards_acknowledged indices.segments@200: - description: '' content: application/json: schema: @@ -24792,7 +24966,6 @@ components: - _shards - indices indices.shard_stores@200: - description: '' content: application/json: schema: @@ -24805,7 +24978,6 @@ components: required: - indices indices.shrink@200: - description: '' content: application/json: schema: @@ -24822,13 +24994,11 @@ components: - index - shards_acknowledged indices.simulate_index_template@200: - description: '' content: application/json: schema: type: object indices.simulate_template@200: - description: '' content: application/json: schema: @@ -24843,7 +25013,6 @@ components: required: - template indices.split@200: - description: '' content: application/json: schema: @@ -24860,7 +25029,6 @@ components: - index - shards_acknowledged indices.stats@200: - description: '' content: application/json: schema: @@ -24878,15 +25046,12 @@ components: - _all - _shards indices.update_aliases@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/_common:AcknowledgedResponseBase' - indices.upgrade@200: - description: '' + indices.upgrade@200: {} indices.validate_query@200: - description: '' content: application/json: schema: @@ -24905,7 +25070,6 @@ components: required: - valid info@200: - description: '' content: application/json: schema: @@ -24928,13 +25092,11 @@ components: - tagline - version ingest.delete_pipeline@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/_common:AcknowledgedResponseBase' ingest.get_pipeline@200: - description: '' content: application/json: schema: @@ -24942,7 +25104,6 @@ components: additionalProperties: $ref: '#/components/schemas/ingest._common:Pipeline' ingest.processor_grok@200: - description: '' content: application/json: schema: @@ -24955,13 +25116,11 @@ components: required: - patterns ingest.put_pipeline@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/_common:AcknowledgedResponseBase' ingest.simulate@200: - description: '' content: application/json: schema: @@ -24973,20 +25132,13 @@ components: $ref: '#/components/schemas/ingest.simulate:PipelineSimulation' required: - docs - knn.delete_model@200: - description: '' - knn.get_model@200: - description: '' - knn.search_models@200: - description: '' - knn.stats@200: - description: '' - knn.train_model@200: - description: '' - knn.warmup@200: - description: '' + knn.delete_model@200: {} + knn.get_model@200: {} + knn.search_models@200: {} + knn.stats@200: {} + knn.train_model@200: {} + knn.warmup@200: {} mget@200: - description: '' content: application/json: schema: @@ -25027,19 +25179,16 @@ components: application/json: $ref: '#/components/schemas/ml._common:SearchModelsResponse' msearch_template@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/_core.msearch:MultiSearchResult' msearch@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/_core.msearch:MultiSearchResult' mtermvectors@200: - description: '' content: application/json: schema: @@ -25051,34 +25200,28 @@ components: $ref: '#/components/schemas/_core.mtermvectors:TermVectorsResult' required: - docs - nodes.hot_threads@200: - description: '' + nodes.hot_threads@200: {} nodes.info@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/nodes.info:ResponseBase' nodes.reload_secure_settings@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/nodes.reload_secure_settings:ResponseBase' nodes.stats@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/nodes.stats:ResponseBase' nodes.usage@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/nodes.usage:ResponseBase' notifications.create_config@200: - description: '' content: application/json: schema: @@ -25087,31 +25230,26 @@ components: config_id: type: string notifications.delete_config@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/notifications._common:DeleteConfigsResponse' notifications.delete_configs@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/notifications._common:DeleteConfigsResponse' notifications.get_config@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/notifications._common:GetConfigsResponse' notifications.get_configs@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/notifications._common:GetConfigsResponse' notifications.list_channels@200: - description: '' content: application/json: schema: @@ -25130,7 +25268,6 @@ components: items: $ref: '#/components/schemas/notifications._common:NotificationChannel' notifications.list_features@200: - description: '' content: application/json: schema: @@ -25143,7 +25280,6 @@ components: plugin_features: $ref: '#/components/schemas/notifications._common:NotificationsPluginFeaturesMap' notifications.send_test@200: - description: '' content: application/json: schema: @@ -25156,7 +25292,6 @@ components: items: $ref: '#/components/schemas/notifications._common:EventStatus' notifications.update_config@200: - description: '' content: application/json: schema: @@ -25165,17 +25300,38 @@ components: config_id: type: string ping@200: - description: '' content: application/json: {} - put_script@200: + ppl.explain@200: + content: + application/json: + schema: + $ref: '#/components/schemas/sql._common:ExplainResponse' + required: true + ppl.get_stats@200: + content: + text/plain: + schema: + type: string + required: true + ppl.post_stats@200: + content: + text/plain: + schema: + type: string + required: true + ppl.query@200: description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/sql._common:QueryResponse' + put_script@200: content: application/json: schema: $ref: '#/components/schemas/_common:AcknowledgedResponseBase' rank_eval@200: - description: '' content: application/json: schema: @@ -25198,7 +25354,6 @@ components: - failures - metric_score reindex_rethrottle@200: - description: '' content: application/json: schema: @@ -25211,7 +25366,6 @@ components: required: - nodes reindex@200: - description: '' content: application/json: schema: @@ -25252,7 +25406,6 @@ components: version_conflicts: type: number remote_store.restore@200: - description: '' content: application/json: schema: @@ -25265,7 +25418,6 @@ components: examples: RemoteStoreRestore_example1: summary: Examples for Post Remote Storage Restore Operation. - description: '' value: remote_store: indices: @@ -25275,7 +25427,6 @@ components: failed: 0 successful: 1 render_search_template@200: - description: '' content: application/json: schema: @@ -25287,8 +25438,7 @@ components: type: object required: - template_output - rollups.delete@200: - description: '' + rollups.delete@200: {} rollups.explain@200: content: application/json: @@ -25304,12 +25454,9 @@ components: application/json: schema: $ref: '#/components/schemas/rollups._common:RollupEntity' - rollups.start@200: - description: '' - rollups.stop@200: - description: '' + rollups.start@200: {} + rollups.stop@200: {} scripts_painless_execute@200: - description: '' content: application/json: schema: @@ -25320,13 +25467,11 @@ components: required: - result scroll@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/_core.search:ResponseBody' search_pipeline.delete@200: - description: '' content: application/json: schema: @@ -25335,13 +25480,11 @@ components: acknowledged: type: boolean search_pipeline.get@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/search_pipeline._common:SearchPipelineMap' search_pipeline.put@200: - description: '' content: application/json: schema: @@ -25350,7 +25493,6 @@ components: acknowledged: type: boolean search_shards@200: - description: '' content: application/json: schema: @@ -25375,7 +25517,6 @@ components: - nodes - shards search_template@200: - description: '' content: application/json: schema: @@ -25423,265 +25564,221 @@ components: - timed_out - took search@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/_core.search:ResponseBody' security.authinfo@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:AuthInfo' security.authinfo@500: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:InternalServerError' security.authtoken@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:Ok' security.cache@501: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:MethodNotImplemented' security.change_password@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:Ok' security.config_upgrade_check@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:UpgradeCheck' security.config_upgrade_perform@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:UpgradePerform' security.create_action_group@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:Ok' security.create_allowlist@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:AllowListConfig' security.create_role_mapping@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:Ok' security.create_role@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:Ok' security.create_tenant@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:Ok' security.create_tenant@400: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:BadRequest' security.create_update_tenancy_config@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:MultiTenancyConfig' security.create_update_tenancy_config@400: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:BadRequest' security.create_user_legacy@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:Ok' security.create_user@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:Ok' security.delete_action_group@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:Ok' security.delete_distinguished_name@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:Ok' security.delete_distinguished_name@403: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:Unauthorized' security.delete_role_mapping@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:Ok' security.delete_role@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:Ok' security.delete_tenant@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:Ok' security.delete_tenant@400: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:BadRequest' security.delete_user_legacy@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:Ok' security.delete_user@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:Ok' security.flush_cache@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:Ok' security.generate_obo_token@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:GenerateOBOToken' security.generate_obo_token@400: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:BadRequest' security.generate_user_token_legacy@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:Ok' security.generate_user_token_legacy@400: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:BadRequest' security.generate_user_token@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:Ok' security.generate_user_token@400: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:BadRequest' security.get_account_details@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:AccountDetails' security.get_action_group@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:ActionGroupsMap' security.get_action_groups@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:ActionGroupsMap' security.get_allowlist@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:AllowListConfig' security.get_audit_configuration@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:AuditConfigWithReadOnly' security.get_certificates@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:GetCertificates' security.get_certificates@400: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:BadRequest' security.get_configuration@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:DynamicConfig' security.get_dashboards_info@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:DashboardsInfo' security.get_dashboards_info@500: - description: '' content: application/json: schema: @@ -25693,391 +25790,326 @@ components: schema: $ref: '#/components/schemas/security._common:DistinguishedNames' security.get_distinguished_name@403: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:Unauthorized' security.get_distinguished_names@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:DistinguishedNamesMap' security.get_distinguished_names@403: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:Unauthorized' security.get_permissions_info@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:PermissionsInfo' security.get_permissions_info@500: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:InternalServerError' security.get_role_mapping@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:RoleMappings' security.get_role_mappings@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:RoleMappings' security.get_role@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:RolesMap' security.get_roles@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:RolesMap' security.get_sslinfo@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:SSLInfo' security.get_sslinfo@500: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:InternalServerError' security.get_tenancy_config@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:MultiTenancyConfig' security.get_tenancy_config@400: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:BadRequest' security.get_tenant@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:TenantsMap' security.get_tenants@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:TenantsMap' security.get_tenants@400: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:BadRequest' security.get_user_legacy@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:UsersMap' security.get_user@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:UsersMap' security.get_users_legacy@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:UsersMap' security.get_users@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:UsersMap' security.health@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:HealthInfo' security.migrate@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:Ok' security.migrate@400: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:BadRequest' security.patch_action_group@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:Ok' security.patch_action_groups@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:Ok' security.patch_allowlist@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:AllowListConfig' security.patch_audit_configuration@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:Ok' security.patch_configuration@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:Ok' security.patch_distinguished_name@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:Ok' security.patch_distinguished_name@403: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:Unauthorized' security.patch_distinguished_names@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:Ok' security.patch_distinguished_names@403: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:Unauthorized' security.patch_role_mapping@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:Ok' security.patch_role_mapping@400: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:BadRequest' security.patch_role_mappings@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:Ok' security.patch_role_mappings@400: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:BadRequest' security.patch_role@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:Ok' security.patch_role@400: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:BadRequest' security.patch_roles@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:Ok' security.patch_roles@400: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:BadRequest' security.patch_tenant@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:Ok' security.patch_tenant@400: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:BadRequest' security.patch_tenants@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:Ok' security.patch_tenants@400: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:BadRequest' security.patch_user@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:Ok' security.patch_users@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:Ok' security.post_dashboards_info@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:DashboardsInfo' security.post_dashboards_info@500: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:InternalServerError' security.reload_http_certificates@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:Ok' security.reload_http_certificates@400: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:BadRequest' security.reload_transport_certificates@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:Ok' security.reload_transport_certificates@400: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:BadRequest' security.tenant_info@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:TenantInfo' security.tenant_info@500: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:InternalServerError' security.update_audit_configuration@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:Ok' security.update_configuration@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:Ok' security.update_distinguished_name@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:Ok' security.update_distinguished_name@403: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:Unauthorized' security.validate@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:Ok' security.validate@400: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:BadRequest' security.who_am_i_protected@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:WhoAmI' security.who_am_i_protected@500: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:InternalServerError' security.who_am_i@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:WhoAmI' security.who_am_i@500: - description: '' content: application/json: schema: $ref: '#/components/schemas/security._common:InternalServerError' snapshot.cleanup_repository@200: - description: '' content: application/json: schema: @@ -26088,19 +26120,16 @@ components: required: - results snapshot.clone@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/_common:AcknowledgedResponseBase' snapshot.create_repository@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/_common:AcknowledgedResponseBase' snapshot.create@200: - description: '' content: application/json: schema: @@ -26112,19 +26141,16 @@ components: snapshot: $ref: '#/components/schemas/snapshot._common:SnapshotInfo' snapshot.delete_repository@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/_common:AcknowledgedResponseBase' snapshot.delete@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/_common:AcknowledgedResponseBase' snapshot.get_repository@200: - description: '' content: application/json: schema: @@ -26132,7 +26158,6 @@ components: additionalProperties: $ref: '#/components/schemas/snapshot._common:Repository' snapshot.get@200: - description: '' content: application/json: schema: @@ -26156,7 +26181,6 @@ components: - remaining - total snapshot.restore@200: - description: '' content: application/json: schema: @@ -26167,7 +26191,6 @@ components: required: - snapshot snapshot.status@200: - description: '' content: application/json: schema: @@ -26180,7 +26203,6 @@ components: required: - snapshots snapshot.verify_repository@200: - description: '' content: application/json: schema: @@ -26202,7 +26224,7 @@ components: content: application/json: schema: - $ref: '#/components/schemas/sql._common:SqlExplainResponse' + $ref: '#/components/schemas/sql._common:ExplainResponse' required: true sql.get_stats@200: content: @@ -26217,19 +26239,21 @@ components: type: string required: true sql.query@200: - description: '' content: application/json: schema: - $ref: '#/components/schemas/sql._common:SqlQueryResponse' + $ref: '#/components/schemas/sql._common:QueryResponse' + sql.settings@200: + content: + application/json: + schema: + $ref: '#/components/schemas/sql._common:SqlSettingsResponse' tasks.cancel@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/tasks._common:TaskListResponseBase' tasks.get@200: - description: '' content: application/json: schema: @@ -26247,13 +26271,11 @@ components: - completed - task tasks.list@200: - description: '' content: application/json: schema: $ref: '#/components/schemas/tasks._common:TaskListResponseBase' termvectors@200: - description: '' content: application/json: schema: @@ -26279,8 +26301,7 @@ components: - _version - found - took - transforms.delete@200: - description: '' + transforms.delete@200: {} transforms.explain@200: content: application/json: @@ -26317,7 +26338,6 @@ components: schema: $ref: '#/components/schemas/_common:AcknowledgedResponseBase' update_by_query_rethrottle@200: - description: '' content: application/json: schema: @@ -26330,7 +26350,6 @@ components: required: - nodes update_by_query@200: - description: '' content: application/json: schema: @@ -26371,7 +26390,6 @@ components: throttled_until_millis: $ref: '#/components/schemas/_common:DurationValueUnitMillis' update@200: - description: '' content: application/json: schema: @@ -26661,12 +26679,10 @@ components: description: |- A duration. Units can be `nanos`, `micros`, `ms` (milliseconds), `s` (seconds), `m` (minutes), `h` (hours) and `d` (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value. - pattern: ^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$ + pattern: ^([0-9\.]+)(?:d|h|m|s|ms|micros|nanos)$ type: string _common:DurationLarge: - description: |- - A date histogram interval. Similar to `Duration` with additional units: `w` (week), `M` (month), `q` (quarter) and - `y` (year) + description: 'A date histogram interval. Similar to `Duration` with additional units: `w` (week), `M` (month), `q` (quarter) and `y` (year).' type: string _common:DurationValueUnitMillis: allOf: @@ -26708,7 +26724,7 @@ components: - type additionalProperties: title: metadata - description: Additional details about the error + description: Additional details about the error. _common:ErrorResponseBase: type: object properties: @@ -26808,7 +26824,7 @@ components: - as 4 top/bottom/left/right coordinates - as 2 top_left / bottom_right points - as 2 top_right / bottom_left points - - as a WKT bounding box + - as a WKT bounding box. oneOf: - $ref: '#/components/schemas/_common:CoordsGeoBounds' - $ref: '#/components/schemas/_common:TopLeftBottomRightGeoBounds' @@ -26847,7 +26863,7 @@ components: - type: number - type: string _common:GeoHexCell: - description: A map hex cell (H3) reference + description: A map hex cell (H3) reference. type: string _common:GeoLine: type: object @@ -26871,7 +26887,7 @@ components: - as a `{lat, long}` object - as a geo hash value - as a `[lon, lat]` array - - as a string in `", "` or WKT point formats + - as a string in `", "` or WKT point formats. oneOf: - $ref: '#/components/schemas/_common:LatLonGeoLocation' - $ref: '#/components/schemas/_common:GeoHashLocation' @@ -26887,7 +26903,7 @@ components: - intersects - within _common:GeoTile: - description: A map tile reference, represented as `{zoom}/{x}/{y}` + description: A map tile reference, represented as `{zoom}/{x}/{y}`. type: string _common:GeoTilePrecision: type: number @@ -27206,7 +27222,7 @@ components: items: type: string _common:MinimumShouldMatch: - description: The minimum number of terms that should match as integer, percentage or range + description: The minimum number of terms that should match as integer, percentage or range. oneOf: - type: number - type: string @@ -27287,7 +27303,7 @@ components: - transform - voting_only _common:NodeRoles: - description: '* @doc_id node-roles' + description: Node roles. type: array items: $ref: '#/components/schemas/_common:NodeRole' @@ -28285,7 +28301,7 @@ components: - model_id - model_text _common:TimeOfDay: - description: Time of day, expressed as HH:MM:SS + description: Time of day, expressed as HH:MM:SS. type: string _common:TimeUnit: type: string @@ -28354,14 +28370,14 @@ components: _common:ulong: type: number _common:UnitMillis: - description: Time unit for milliseconds + description: Time unit for milliseconds. type: number format: int64 _common:UnitNanos: - description: Time unit for nanoseconds + description: Time unit for nanoseconds. type: number _common:UnitSeconds: - description: Time unit for seconds + description: Time unit for seconds. type: number _common:Username: type: string @@ -28385,7 +28401,7 @@ components: Although "void" is generally used for the unit type that has only one value, this is to be interpreted as the bottom type that has no value at all. Most languages have a unit type, but few have a bottom type. - See https://en.m.wikipedia.org/wiki/Unit_type and https://en.m.wikipedia.org/wiki/Bottom_type + See https://en.m.wikipedia.org/wiki/Unit_type and https://en.m.wikipedia.org/wiki/Bottom_type. type: object _common:WaitForActiveShardOptions: type: string @@ -36663,7 +36679,7 @@ components: - SLOP - WHITESPACE _common.query_dsl:SimpleQueryStringFlags: - description: Query flags can be either a single flag or a combination of flags, e.g. `OR|AND|PREFIX` + description: Query flags can be either a single flag or a combination of flags, e.g. `OR|AND|PREFIX`. allOf: - $ref: '#/components/schemas/_common:PipeSeparatedFlagsSimpleQueryStringFlag' _common.query_dsl:SimpleQueryStringQuery: @@ -42317,6 +42333,7 @@ components: $ref: '#/components/schemas/_common:Stringifiedboolean' indices._common:IndexSettings: type: object + description: The index settings to be updated. properties: index: $ref: '#/components/schemas/indices._common:IndexSettings' @@ -42447,7 +42464,6 @@ components: store: $ref: '#/components/schemas/indices._common:Storage' additionalProperties: {} - description: The index settings to be updated indices._common:IndexSettingsAnalysis: type: object properties: @@ -42561,7 +42577,7 @@ components: $ref: '#/components/schemas/indices._common:IndexTemplateDataStreamConfiguration' required: - index_patterns - description: New index template definition to be simulated, if no index template name is specified + description: New index template definition to be simulated, if no index template name is specified. indices._common:IndexTemplateDataStreamConfiguration: type: object properties: @@ -46094,6 +46110,9 @@ components: $ref: '#/components/schemas/nodes._common:ShardSearchBackpressureTaskResourceTrackerStats' cancellation_stats: $ref: '#/components/schemas/nodes._common:ShardSearchBackpressureTaskCancellationStats' + completion_count: + x-version-added: '3.0' + type: number nodes._common:ShardSearchPipelineStats: type: object properties: @@ -48861,7 +48880,21 @@ components: $ref: '#/components/schemas/_common:Name' required: - name + sql._common:Cursor: + type: object + properties: + keep_alive: + type: string sql._common:Explain: + type: object + properties: + query: + type: string + filter: + type: object + fetch_size: + type: integer + sql._common:ExplainBody: type: object properties: name: @@ -48871,32 +48904,38 @@ components: children: type: array items: - $ref: '#/components/schemas/sql._common:Explain' - sql._common:SqlClose: + $ref: '#/components/schemas/sql._common:ExplainBody' + sql._common:ExplainResponse: type: object properties: - cursor: - type: string - sql._common:SqlCloseResponse: + root: + $ref: '#/components/schemas/sql._common:ExplainBody' + sql._common:Plugins: type: object properties: - succeeded: - type: boolean - sql._common:SqlExplain: + ppl: + $ref: '#/components/schemas/sql._common:Ppl' + query: + $ref: '#/components/schemas/sql._common:PluginsQuery' + sql: + $ref: '#/components/schemas/sql._common:Sql' + sql._common:PluginsQuery: type: object properties: - query: + memory_limit: type: string - filter: - type: object - fetch_size: - type: integer - sql._common:SqlExplainResponse: + size_limit: + anyOf: + - type: string + - type: integer + sql._common:Ppl: type: object properties: - root: - $ref: '#/components/schemas/sql._common:Explain' - sql._common:SqlQuery: + enabled: + anyOf: + - type: boolean + - type: string + sql._common:Query: type: object properties: query: @@ -48905,7 +48944,7 @@ components: type: object fetch_size: type: integer - sql._common:SqlQueryResponse: + sql._common:QueryResponse: type: object properties: schema: @@ -48924,7 +48963,49 @@ components: type: integer status: type: integer - sql._common:SqlStats: + sql._common:Sql: + type: object + properties: + enabled: + anyOf: + - type: boolean + - type: string + slowlog: + anyOf: + - type: integer + - type: string + cursor: + $ref: '#/components/schemas/sql._common:Cursor' + sql._common:SqlClose: + type: object + properties: + cursor: + type: string + sql._common:SqlCloseResponse: + type: object + properties: + succeeded: + type: boolean + sql._common:SqlSettings: + type: object + properties: + transient: + $ref: '#/components/schemas/sql._common:Transient' + sql._common:SqlSettingsPlain: + type: object + properties: + transient: + $ref: '#/components/schemas/sql._common:TransientPlain' + sql._common:SqlSettingsResponse: + type: object + properties: + acknowledged: + type: boolean + persistent: + type: object + transient: + $ref: '#/components/schemas/sql._common:Transient' + sql._common:Stats: type: object properties: start_time: @@ -48941,6 +49022,26 @@ components: type: object execution_time: type: object + sql._common:Transient: + type: object + properties: + plugins: + $ref: '#/components/schemas/sql._common:Plugins' + sql._common:TransientPlain: + type: object + properties: + plugins.sql.enabled: + type: boolean + plugins.ppl.enabled: + type: boolean + plugins.sql.slowlog: + type: integer + plugins.sql.cursor.keep_alive: + type: string + plugins.query.memory_limit: + type: string + plugins.query.size_limit: + type: integer tasks._common:GroupBy: type: string enum: