diff --git a/java-codegen/opensearch-openapi.yaml b/java-codegen/opensearch-openapi.yaml index 434317d07a..43c7dd003c 100644 --- a/java-codegen/opensearch-openapi.yaml +++ b/java-codegen/opensearch-openapi.yaml @@ -2,6 +2,7 @@ openapi: 3.1.0 info: title: OpenSearch API Specification version: 1.0.0 + x-api-version: 2.15.0 paths: /: get: @@ -57,6 +58,27 @@ paths: responses: '200': $ref: '#/components/responses/indices.get_alias@200' + put: + operationId: indices.put_alias.0 + x-operation-group: indices.put_alias + x-version-added: '1.0' + description: Creates or updates an alias. + externalDocs: + url: https://opensearch.org/docs/latest/im-plugin/index-alias/#create-aliases + parameters: + - $ref: '#/components/parameters/indices.put_alias::query.cluster_manager_timeout' + - $ref: '#/components/parameters/indices.put_alias::query.master_timeout' + - $ref: '#/components/parameters/indices.put_alias::query.timeout' + - $ref: '#/components/parameters/_global::query.pretty' + - $ref: '#/components/parameters/_global::query.human' + - $ref: '#/components/parameters/_global::query.error_trace' + - $ref: '#/components/parameters/_global::query.source' + - $ref: '#/components/parameters/_global::query.filter_path' + requestBody: + $ref: '#/components/requestBodies/indices.put_alias' + responses: + '200': + $ref: '#/components/responses/indices.put_alias@200' /_alias/{name}: get: operationId: indices.get_alias.1 @@ -100,6 +122,50 @@ paths: responses: '200': $ref: '#/components/responses/indices.exists_alias@200' + post: + operationId: indices.put_alias.1 + x-operation-group: indices.put_alias + x-version-added: '1.0' + description: Creates or updates an alias. + externalDocs: + url: https://opensearch.org/docs/latest/im-plugin/index-alias/#create-aliases + parameters: + - $ref: '#/components/parameters/indices.put_alias::path.name' + - $ref: '#/components/parameters/indices.put_alias::query.cluster_manager_timeout' + - $ref: '#/components/parameters/indices.put_alias::query.master_timeout' + - $ref: '#/components/parameters/indices.put_alias::query.timeout' + - $ref: '#/components/parameters/_global::query.pretty' + - $ref: '#/components/parameters/_global::query.human' + - $ref: '#/components/parameters/_global::query.error_trace' + - $ref: '#/components/parameters/_global::query.source' + - $ref: '#/components/parameters/_global::query.filter_path' + requestBody: + $ref: '#/components/requestBodies/indices.put_alias' + responses: + '200': + $ref: '#/components/responses/indices.put_alias@200' + put: + operationId: indices.put_alias.2 + x-operation-group: indices.put_alias + x-version-added: '1.0' + description: Creates or updates an alias. + externalDocs: + url: https://opensearch.org/docs/latest/im-plugin/index-alias/#create-aliases + parameters: + - $ref: '#/components/parameters/indices.put_alias::path.name' + - $ref: '#/components/parameters/indices.put_alias::query.cluster_manager_timeout' + - $ref: '#/components/parameters/indices.put_alias::query.master_timeout' + - $ref: '#/components/parameters/indices.put_alias::query.timeout' + - $ref: '#/components/parameters/_global::query.pretty' + - $ref: '#/components/parameters/_global::query.human' + - $ref: '#/components/parameters/_global::query.error_trace' + - $ref: '#/components/parameters/_global::query.source' + - $ref: '#/components/parameters/_global::query.filter_path' + requestBody: + $ref: '#/components/requestBodies/indices.put_alias' + responses: + '200': + $ref: '#/components/responses/indices.put_alias@200' /_aliases: post: operationId: indices.update_aliases.0 @@ -122,6 +188,51 @@ paths: responses: '200': $ref: '#/components/responses/indices.update_aliases@200' + /_aliases/{name}: + post: + operationId: indices.put_alias.3 + x-operation-group: indices.put_alias + x-version-added: '1.0' + description: Creates or updates an alias. + externalDocs: + url: https://opensearch.org/docs/latest/im-plugin/index-alias/#create-aliases + parameters: + - $ref: '#/components/parameters/indices.put_alias::path.name' + - $ref: '#/components/parameters/indices.put_alias::query.cluster_manager_timeout' + - $ref: '#/components/parameters/indices.put_alias::query.master_timeout' + - $ref: '#/components/parameters/indices.put_alias::query.timeout' + - $ref: '#/components/parameters/_global::query.pretty' + - $ref: '#/components/parameters/_global::query.human' + - $ref: '#/components/parameters/_global::query.error_trace' + - $ref: '#/components/parameters/_global::query.source' + - $ref: '#/components/parameters/_global::query.filter_path' + requestBody: + $ref: '#/components/requestBodies/indices.put_alias' + responses: + '200': + $ref: '#/components/responses/indices.put_alias@200' + put: + operationId: indices.put_alias.4 + x-operation-group: indices.put_alias + x-version-added: '1.0' + description: Creates or updates an alias. + externalDocs: + url: https://opensearch.org/docs/latest/im-plugin/index-alias/#create-aliases + parameters: + - $ref: '#/components/parameters/indices.put_alias::path.name' + - $ref: '#/components/parameters/indices.put_alias::query.cluster_manager_timeout' + - $ref: '#/components/parameters/indices.put_alias::query.master_timeout' + - $ref: '#/components/parameters/indices.put_alias::query.timeout' + - $ref: '#/components/parameters/_global::query.pretty' + - $ref: '#/components/parameters/_global::query.human' + - $ref: '#/components/parameters/_global::query.error_trace' + - $ref: '#/components/parameters/_global::query.source' + - $ref: '#/components/parameters/_global::query.filter_path' + requestBody: + $ref: '#/components/requestBodies/indices.put_alias' + responses: + '200': + $ref: '#/components/responses/indices.put_alias@200' /_analyze: get: operationId: indices.analyze.0 @@ -231,6 +342,7 @@ paths: - $ref: '#/components/parameters/indices.clear_cache::query.expand_wildcards' - $ref: '#/components/parameters/indices.clear_cache::query.fielddata' - $ref: '#/components/parameters/indices.clear_cache::query.fields' + - $ref: '#/components/parameters/indices.clear_cache::query.file' - $ref: '#/components/parameters/indices.clear_cache::query.ignore_unavailable' - $ref: '#/components/parameters/indices.clear_cache::query.index' - $ref: '#/components/parameters/indices.clear_cache::query.query' @@ -832,7 +944,7 @@ paths: get: operationId: cat.segment_replication.0 x-operation-group: cat.segment_replication - x-version-added: 2.6.0 + x-version-added: '2.6' description: Returns information about both on-going and latest completed Segment Replication events. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-segment-replication/ @@ -866,7 +978,7 @@ paths: get: operationId: cat.segment_replication.1 x-operation-group: cat.segment_replication - x-version-added: 2.6.0 + x-version-added: '2.6' description: Returns information about both on-going and latest completed Segment Replication events. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-segment-replication/ @@ -2642,6 +2754,7 @@ paths: - $ref: '#/components/parameters/indices.get_mapping::query.cluster_manager_timeout' - $ref: '#/components/parameters/indices.get_mapping::query.expand_wildcards' - $ref: '#/components/parameters/indices.get_mapping::query.ignore_unavailable' + - $ref: '#/components/parameters/indices.get_mapping::query.index' - $ref: '#/components/parameters/indices.get_mapping::query.local' - $ref: '#/components/parameters/indices.get_mapping::query.master_timeout' - $ref: '#/components/parameters/_global::query.pretty' @@ -2906,7 +3019,7 @@ paths: responses: '200': $ref: '#/components/responses/nodes.info@200' - /_nodes/{metric}: + /_nodes/{node_id_or_metric}: get: operationId: nodes.info.1 x-operation-group: nodes.info @@ -2915,27 +3028,7 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/api-reference/nodes-apis/nodes-info/ parameters: - - $ref: '#/components/parameters/nodes.info::path.metric' - - $ref: '#/components/parameters/nodes.info::query.flat_settings' - - $ref: '#/components/parameters/nodes.info::query.timeout' - - $ref: '#/components/parameters/_global::query.pretty' - - $ref: '#/components/parameters/_global::query.human' - - $ref: '#/components/parameters/_global::query.error_trace' - - $ref: '#/components/parameters/_global::query.source' - - $ref: '#/components/parameters/_global::query.filter_path' - responses: - '200': - $ref: '#/components/responses/nodes.info@200' - /_nodes/{node_id}: - get: - operationId: nodes.info.2 - x-operation-group: nodes.info - x-version-added: '1.0' - description: Returns information about nodes in the cluster. - externalDocs: - url: https://opensearch.org/docs/latest/api-reference/nodes-apis/nodes-info/ - parameters: - - $ref: '#/components/parameters/nodes.info::path.node_id' + - $ref: '#/components/parameters/nodes.info::path.node_id_or_metric' - $ref: '#/components/parameters/nodes.info::query.flat_settings' - $ref: '#/components/parameters/nodes.info::query.timeout' - $ref: '#/components/parameters/_global::query.pretty' @@ -3982,7 +4075,7 @@ paths: delete: operationId: rollups.delete.0 x-operation-group: rollups.delete - x-version-added: 1 + x-version-added: '1.0' description: Delete index rollup. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/index-rollups/rollup-api/#delete-an-index-rollup-job @@ -3999,7 +4092,7 @@ paths: get: operationId: rollups.get.0 x-operation-group: rollups.get - x-version-added: 1 + x-version-added: '1.0' description: Get an index rollup. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/index-rollups/rollup-api/#get-an-index-rollup-job @@ -4016,7 +4109,7 @@ paths: put: operationId: rollups.put.0 x-operation-group: rollups.put - x-version-added: 1 + x-version-added: '1.0' description: Create or update index rollup. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/index-rollups/rollup-api/#create-or-update-an-index-rollup-job @@ -4038,7 +4131,7 @@ paths: get: operationId: rollups.explain.0 x-operation-group: rollups.explain - x-version-added: 1 + x-version-added: '1.0' description: Get a rollup's current status. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/index-rollups/rollup-api/#explain-an-index-rollup-job @@ -4056,7 +4149,7 @@ paths: post: operationId: rollups.start.0 x-operation-group: rollups.start - x-version-added: 1 + x-version-added: '1.0' description: Start rollup. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/index-rollups/rollup-api/#start-or-stop-an-index-rollup-job @@ -4074,7 +4167,7 @@ paths: post: operationId: rollups.stop.0 x-operation-group: rollups.stop - x-version-added: 1 + x-version-added: '1.0' description: Stop rollup. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/index-rollups/rollup-api/#start-or-stop-an-index-rollup-job @@ -5537,7 +5630,7 @@ paths: get: operationId: transforms.search.0 x-operation-group: transforms.search - x-version-added: 1 + x-version-added: '1.0' description: Returns the details of all transform jobs. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/index-transforms/transforms-apis/#get-a-transform-jobs-details @@ -5559,7 +5652,7 @@ paths: get: operationId: transforms.preview.0 x-operation-group: transforms.preview - x-version-added: 1 + x-version-added: '1.0' description: Returns a preview of what a transformed index would look like. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/index-transforms/transforms-apis/#preview-a-transform-jobs-results @@ -5576,7 +5669,7 @@ paths: delete: operationId: transforms.delete.0 x-operation-group: transforms.delete - x-version-added: 1 + x-version-added: '1.0' description: Delete an index transform. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/index-transforms/transforms-apis/#delete-a-transform-job @@ -5593,7 +5686,7 @@ paths: get: operationId: transforms.get.0 x-operation-group: transforms.get - x-version-added: 1 + x-version-added: '1.0' description: Returns the status and metadata of a transform job. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/index-transforms/transforms-apis/#get-a-transform-jobs-details @@ -5610,7 +5703,7 @@ paths: put: operationId: transforms.put.0 x-operation-group: transforms.put - x-version-added: 1 + x-version-added: '1.0' description: Create an index transform, or update a transform if if_seq_no and if_primary_term are provided. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/index-transforms/transforms-apis/#create-a-transform-job @@ -5632,7 +5725,7 @@ paths: get: operationId: transforms.explain.0 x-operation-group: transforms.explain - x-version-added: 1 + x-version-added: '1.0' description: Returns the status and metadata of a transform job. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/index-transforms/transforms-apis/#get-the-status-of-a-transform-job @@ -5650,7 +5743,7 @@ paths: post: operationId: transforms.start.0 x-operation-group: transforms.start - x-version-added: 1 + x-version-added: '1.0' description: Start transform. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/index-transforms/transforms-apis/#start-a-transform-job @@ -5668,7 +5761,7 @@ paths: post: operationId: transforms.stop.0 x-operation-group: transforms.stop - x-version-added: 1 + x-version-added: '1.0' description: stop transform. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/index-transforms/transforms-apis/#stop-a-transform-job @@ -7636,6 +7729,7 @@ paths: parameters: - $ref: '#/components/parameters/indices.exists::path.index' - $ref: '#/components/parameters/indices.exists::query.allow_no_indices' + - $ref: '#/components/parameters/indices.exists::query.cluster_manager_timeout' - $ref: '#/components/parameters/indices.exists::query.expand_wildcards' - $ref: '#/components/parameters/indices.exists::query.flat_settings' - $ref: '#/components/parameters/indices.exists::query.ignore_unavailable' @@ -7696,6 +7790,28 @@ paths: responses: '200': $ref: '#/components/responses/indices.get_alias@200' + put: + operationId: indices.put_alias.5 + x-operation-group: indices.put_alias + x-version-added: '1.0' + description: Creates or updates an alias. + externalDocs: + url: https://opensearch.org/docs/latest/im-plugin/index-alias/#create-aliases + parameters: + - $ref: '#/components/parameters/indices.put_alias::path.index' + - $ref: '#/components/parameters/indices.put_alias::query.cluster_manager_timeout' + - $ref: '#/components/parameters/indices.put_alias::query.master_timeout' + - $ref: '#/components/parameters/indices.put_alias::query.timeout' + - $ref: '#/components/parameters/_global::query.pretty' + - $ref: '#/components/parameters/_global::query.human' + - $ref: '#/components/parameters/_global::query.error_trace' + - $ref: '#/components/parameters/_global::query.source' + - $ref: '#/components/parameters/_global::query.filter_path' + requestBody: + $ref: '#/components/requestBodies/indices.put_alias' + responses: + '200': + $ref: '#/components/responses/indices.put_alias@200' /{index}/_alias/{name}: delete: operationId: indices.delete_alias.0 @@ -7763,7 +7879,7 @@ paths: '200': $ref: '#/components/responses/indices.exists_alias@200' post: - operationId: indices.put_alias.0 + operationId: indices.put_alias.6 x-operation-group: indices.put_alias x-version-added: '1.0' description: Creates or updates an alias. @@ -7786,7 +7902,7 @@ paths: '200': $ref: '#/components/responses/indices.put_alias@200' put: - operationId: indices.put_alias.1 + operationId: indices.put_alias.7 x-operation-group: indices.put_alias x-version-added: '1.0' description: Creates or updates an alias. @@ -7808,6 +7924,29 @@ paths: responses: '200': $ref: '#/components/responses/indices.put_alias@200' + /{index}/_aliases: + put: + operationId: indices.put_alias.8 + x-operation-group: indices.put_alias + x-version-added: '1.0' + description: Creates or updates an alias. + externalDocs: + url: https://opensearch.org/docs/latest/im-plugin/index-alias/#create-aliases + parameters: + - $ref: '#/components/parameters/indices.put_alias::path.index' + - $ref: '#/components/parameters/indices.put_alias::query.cluster_manager_timeout' + - $ref: '#/components/parameters/indices.put_alias::query.master_timeout' + - $ref: '#/components/parameters/indices.put_alias::query.timeout' + - $ref: '#/components/parameters/_global::query.pretty' + - $ref: '#/components/parameters/_global::query.human' + - $ref: '#/components/parameters/_global::query.error_trace' + - $ref: '#/components/parameters/_global::query.source' + - $ref: '#/components/parameters/_global::query.filter_path' + requestBody: + $ref: '#/components/requestBodies/indices.put_alias' + responses: + '200': + $ref: '#/components/responses/indices.put_alias@200' /{index}/_aliases/{name}: delete: operationId: indices.delete_alias.1 @@ -7831,7 +7970,7 @@ paths: '200': $ref: '#/components/responses/indices.delete_alias@200' post: - operationId: indices.put_alias.2 + operationId: indices.put_alias.9 x-operation-group: indices.put_alias x-version-added: '1.0' description: Creates or updates an alias. @@ -7854,7 +7993,7 @@ paths: '200': $ref: '#/components/responses/indices.put_alias@200' put: - operationId: indices.put_alias.3 + operationId: indices.put_alias.10 x-operation-group: indices.put_alias x-version-added: '1.0' description: Creates or updates an alias. @@ -8015,6 +8154,7 @@ paths: - $ref: '#/components/parameters/indices.clear_cache::query.expand_wildcards' - $ref: '#/components/parameters/indices.clear_cache::query.fielddata' - $ref: '#/components/parameters/indices.clear_cache::query.fields' + - $ref: '#/components/parameters/indices.clear_cache::query.file' - $ref: '#/components/parameters/indices.clear_cache::query.ignore_unavailable' - $ref: '#/components/parameters/indices.clear_cache::query.index' - $ref: '#/components/parameters/indices.clear_cache::query.query' @@ -8667,6 +8807,7 @@ paths: - $ref: '#/components/parameters/indices.get_mapping::query.cluster_manager_timeout' - $ref: '#/components/parameters/indices.get_mapping::query.expand_wildcards' - $ref: '#/components/parameters/indices.get_mapping::query.ignore_unavailable' + - $ref: '#/components/parameters/indices.get_mapping::query.index' - $ref: '#/components/parameters/indices.get_mapping::query.local' - $ref: '#/components/parameters/indices.get_mapping::query.master_timeout' - $ref: '#/components/parameters/_global::query.pretty' @@ -10104,7 +10245,7 @@ paths: get: operationId: rollups.get.0_superseded x-operation-group: rollups.get - x-version-added: 1 + x-version-added: '1.0' description: Get an index rollup. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/index-rollups/rollup-api/#get-an-index-rollup-job @@ -10123,7 +10264,7 @@ paths: put: operationId: rollups.put.0_superseded x-operation-group: rollups.put - x-version-added: 1 + x-version-added: '1.0' description: Create or update index rollup. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/index-rollups/rollup-api/#create-or-update-an-index-rollup-job @@ -10146,7 +10287,7 @@ paths: delete: operationId: rollups.delete.0_superseded x-operation-group: rollups.delete - x-version-added: 1 + x-version-added: '1.0' description: Delete index rollup. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/index-rollups/rollup-api/#delete-an-index-rollup-job @@ -10166,7 +10307,7 @@ paths: get: operationId: rollups.explain.0_superseded x-operation-group: rollups.explain - x-version-added: 1 + x-version-added: '1.0' description: Get a rollup's current status. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/index-rollups/rollup-api/#explain-an-index-rollup-job @@ -10186,7 +10327,7 @@ paths: post: operationId: rollups.start.0_superseded x-operation-group: rollups.start - x-version-added: 1 + x-version-added: '1.0' description: Start rollup. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/index-rollups/rollup-api/#start-or-stop-an-index-rollup-job @@ -10206,7 +10347,7 @@ paths: post: operationId: rollups.stop.0_superseded x-operation-group: rollups.stop - x-version-added: 1 + x-version-added: '1.0' description: Stop rollup. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/index-rollups/rollup-api/#start-or-stop-an-index-rollup-job @@ -11557,7 +11698,7 @@ components: bulk::query.require_alias: in: query name: require_alias - description: If `true`, the request’s actions must target an index alias. + description: If `true`, the request's actions must target an index alias. schema: type: boolean default: false @@ -11733,7 +11874,7 @@ components: description: Operation timeout for connection to cluster-manager node. schema: $ref: '#/components/schemas/_common:Duration' - x-version-added: 2.0.0 + x-version-added: '2.0' cat.allocation::query.format: name: format in: query @@ -11802,7 +11943,7 @@ components: description: Operation timeout for connection to cluster-manager node. schema: $ref: '#/components/schemas/_common:Duration' - x-version-added: 2.0.0 + x-version-added: '2.0' cat.cluster_manager::query.format: name: format in: query @@ -12072,7 +12213,7 @@ components: description: Operation timeout for connection to cluster-manager node. schema: $ref: '#/components/schemas/_common:Duration' - x-version-added: 2.0.0 + x-version-added: '2.0' cat.indices::query.expand_wildcards: in: query name: expand_wildcards @@ -12178,7 +12319,7 @@ components: description: Operation timeout for connection to cluster-manager node. schema: $ref: '#/components/schemas/_common:Duration' - x-version-added: 2.0.0 + x-version-added: '2.0' cat.master::query.format: name: format in: query @@ -12247,7 +12388,7 @@ components: description: Operation timeout for connection to cluster-manager node. schema: $ref: '#/components/schemas/_common:Duration' - x-version-added: 2.0.0 + x-version-added: '2.0' cat.nodeattrs::query.format: name: format in: query @@ -12323,7 +12464,7 @@ components: description: Operation timeout for connection to cluster-manager node. schema: $ref: '#/components/schemas/_common:Duration' - x-version-added: 2.0.0 + x-version-added: '2.0' cat.nodes::query.format: name: format in: query @@ -12411,7 +12552,7 @@ components: description: Operation timeout for connection to cluster-manager node. schema: $ref: '#/components/schemas/_common:Duration' - x-version-added: 2.0.0 + x-version-added: '2.0' cat.pending_tasks::query.format: name: format in: query @@ -12537,7 +12678,7 @@ components: description: Operation timeout for connection to cluster-manager node. schema: $ref: '#/components/schemas/_common:Duration' - x-version-added: 2.0.0 + x-version-added: '2.0' cat.plugins::query.format: name: format in: query @@ -12701,7 +12842,7 @@ components: description: Operation timeout for connection to cluster-manager node. schema: $ref: '#/components/schemas/_common:Duration' - x-version-added: 2.0.0 + x-version-added: '2.0' cat.repositories::query.format: name: format in: query @@ -12934,7 +13075,7 @@ components: description: Operation timeout for connection to cluster-manager node. schema: $ref: '#/components/schemas/_common:Duration' - x-version-added: 2.0.0 + x-version-added: '2.0' cat.segments::query.format: name: format in: query @@ -13013,7 +13154,7 @@ components: description: Operation timeout for connection to cluster-manager node. schema: $ref: '#/components/schemas/_common:Duration' - x-version-added: 2.0.0 + x-version-added: '2.0' cat.shards::query.format: name: format in: query @@ -13100,7 +13241,7 @@ components: description: Operation timeout for connection to cluster-manager node. schema: $ref: '#/components/schemas/_common:Duration' - x-version-added: 2.0.0 + x-version-added: '2.0' cat.snapshots::query.format: name: format in: query @@ -13271,7 +13412,7 @@ components: description: Operation timeout for connection to cluster-manager node. schema: $ref: '#/components/schemas/_common:Duration' - x-version-added: 2.0.0 + x-version-added: '2.0' cat.templates::query.format: name: format in: query @@ -13350,7 +13491,7 @@ components: description: Operation timeout for connection to cluster-manager node. schema: $ref: '#/components/schemas/_common:Duration' - x-version-added: 2.0.0 + x-version-added: '2.0' cat.thread_pool::query.format: name: format in: query @@ -13464,7 +13605,7 @@ components: description: Operation timeout for connection to cluster-manager node. schema: $ref: '#/components/schemas/_common:Duration' - x-version-added: 2.0.0 + x-version-added: '2.0' cluster.delete_component_template::query.master_timeout: in: query name: master_timeout @@ -13516,7 +13657,7 @@ components: description: Operation timeout for connection to cluster-manager node. schema: $ref: '#/components/schemas/_common:Duration' - x-version-added: 2.0.0 + x-version-added: '2.0' cluster.exists_component_template::query.local: in: query name: local @@ -13556,7 +13697,7 @@ components: description: Operation timeout for connection to cluster-manager node. schema: $ref: '#/components/schemas/_common:Duration' - x-version-added: 2.0.0 + x-version-added: '2.0' cluster.get_component_template::query.local: in: query name: local @@ -13593,7 +13734,7 @@ components: description: Operation timeout for connection to cluster-manager node. schema: $ref: '#/components/schemas/_common:Duration' - x-version-added: 2.0.0 + x-version-added: '2.0' cluster.get_settings::query.flat_settings: in: query name: flat_settings @@ -13660,7 +13801,7 @@ components: description: Operation timeout for connection to cluster-manager node. schema: $ref: '#/components/schemas/_common:Duration' - x-version-added: 2.0.0 + x-version-added: '2.0' cluster.health::query.expand_wildcards: in: query name: expand_wildcards @@ -13750,7 +13891,7 @@ components: description: Operation timeout for connection to cluster-manager node. schema: $ref: '#/components/schemas/_common:Duration' - x-version-added: 2.0.0 + x-version-added: '2.0' cluster.pending_tasks::query.local: in: query name: local @@ -13810,7 +13951,7 @@ components: OpenSearch includes the following built-in component templates: `logs-mappings`; 'logs-settings`; `metrics-mappings`; `metrics-settings`;`synthetics-mapping`; `synthetics-settings`. OpenSearch Agent uses these templates to configure backing indices for its data streams. If you use OpenSearch Agent and want to overwrite one of these templates, set the `version` for your replacement template higher than the current version. - If you don’t use OpenSearch Agent and want to disable all built-in component and index templates, set `stack.templates.enabled` to `false` using the cluster update settings API. + If you don't use OpenSearch Agent and want to disable all built-in component and index templates, set `stack.templates.enabled` to `false` using the cluster update settings API. required: true schema: $ref: '#/components/schemas/_common:Name' @@ -13821,7 +13962,7 @@ components: description: Operation timeout for connection to cluster-manager node. schema: $ref: '#/components/schemas/_common:Duration' - x-version-added: 2.0.0 + x-version-added: '2.0' cluster.put_component_template::query.create: in: query name: create @@ -13870,7 +14011,7 @@ components: description: Operation timeout for connection to cluster-manager node. schema: $ref: '#/components/schemas/_common:Duration' - x-version-added: 2.0.0 + x-version-added: '2.0' cluster.put_settings::query.flat_settings: in: query name: flat_settings @@ -13910,7 +14051,7 @@ components: description: Operation timeout for connection to cluster-manager node. schema: $ref: '#/components/schemas/_common:Duration' - x-version-added: 2.0.0 + x-version-added: '2.0' cluster.reroute::query.dry_run: in: query name: dry_run @@ -13987,7 +14128,7 @@ components: description: Operation timeout for connection to cluster-manager node. schema: $ref: '#/components/schemas/_common:Duration' - x-version-added: 2.0.0 + x-version-added: '2.0' cluster.state::query.expand_wildcards: in: query name: expand_wildcards @@ -14064,7 +14205,7 @@ components: description: |- Period to wait for each node to respond. If a node does not respond before its timeout expires, the response does not include its stats. - However, timed out nodes are included in the response’s `_nodes.failed` property. Defaults to no timeout. + However, timed out nodes are included in the response's `_nodes.failed` property. Defaults to no timeout. schema: $ref: '#/components/schemas/_common:Duration' style: form @@ -14258,8 +14399,8 @@ components: name: index description: |- Name of the data stream or index to target. - If the target doesn’t exist and matches the name or wildcard (`*`) pattern of an index template with a `data_stream` definition, this request creates the data stream. - If the target doesn’t exist and doesn’t match a data stream template, this request creates the index. + If the target doesn't exist and matches the name or wildcard (`*`) pattern of an index template with a `data_stream` definition, this request creates the data stream. + If the target doesn't exist and doesn't match a data stream template, this request creates the index. required: true schema: $ref: '#/components/schemas/_common:IndexName' @@ -14345,7 +14486,7 @@ components: description: Operation timeout for connection to cluster-manager node. schema: $ref: '#/components/schemas/_common:Duration' - x-version-added: 2.0.0 + x-version-added: '2.0' dangling_indices.delete_dangling_index::query.master_timeout: in: query name: master_timeout @@ -14385,7 +14526,7 @@ components: description: Operation timeout for connection to cluster-manager node. schema: $ref: '#/components/schemas/_common:Duration' - x-version-added: 2.0.0 + x-version-added: '2.0' dangling_indices.import_dangling_index::query.master_timeout: in: query name: master_timeout @@ -14725,7 +14866,7 @@ components: description: Operation timeout for connection to cluster-manager node. schema: $ref: '#/components/schemas/_common:Duration' - x-version-added: 2.0.0 + x-version-added: '2.0' delete_script::query.master_timeout: in: query name: master_timeout @@ -15178,7 +15319,7 @@ components: description: Operation timeout for connection to cluster-manager node. schema: $ref: '#/components/schemas/_common:Duration' - x-version-added: 2.0.0 + x-version-added: '2.0' get_script::query.master_timeout: in: query name: master_timeout @@ -15498,7 +15639,7 @@ components: description: Operation timeout for connection to cluster-manager node. schema: $ref: '#/components/schemas/_common:Duration' - x-version-added: 2.0.0 + x-version-added: '2.0' indices.add_block::query.expand_wildcards: in: query name: expand_wildcards @@ -15595,6 +15736,15 @@ components: schema: $ref: '#/components/schemas/_common:Fields' style: form + indices.clear_cache::query.file: + x-version-added: '2.8' + in: query + name: file + description: If true, clears the unused entries from the file cache on nodes with the Search role. + schema: + type: boolean + default: false + style: form indices.clear_cache::query.ignore_unavailable: in: query name: ignore_unavailable @@ -15649,7 +15799,7 @@ components: description: Operation timeout for connection to cluster-manager node. schema: $ref: '#/components/schemas/_common:Duration' - x-version-added: 2.0.0 + x-version-added: '2.0' indices.clone::query.master_timeout: in: query name: master_timeout @@ -15687,6 +15837,7 @@ components: $ref: '#/components/schemas/_common:WaitForActiveShards' style: form indices.clone::query.wait_for_completion: + x-version-added: '2.7' name: wait_for_completion in: query description: Should this request wait until the operation has completed before returning. @@ -15717,7 +15868,7 @@ components: description: Operation timeout for connection to cluster-manager node. schema: $ref: '#/components/schemas/_common:Duration' - x-version-added: 2.0.0 + x-version-added: '2.0' indices.close::query.expand_wildcards: in: query name: expand_wildcards @@ -15794,7 +15945,7 @@ components: description: Operation timeout for connection to cluster-manager node. schema: $ref: '#/components/schemas/_common:Duration' - x-version-added: 2.0.0 + x-version-added: '2.0' indices.create::query.master_timeout: in: query name: master_timeout @@ -15862,7 +16013,7 @@ components: description: Operation timeout for connection to cluster-manager node. schema: $ref: '#/components/schemas/_common:Duration' - x-version-added: 2.0.0 + x-version-added: '2.0' indices.delete_alias::query.master_timeout: in: query name: master_timeout @@ -15906,7 +16057,7 @@ components: description: Operation timeout for connection to cluster-manager node. schema: $ref: '#/components/schemas/_common:Duration' - x-version-added: 2.0.0 + x-version-added: '2.0' indices.delete_index_template::query.master_timeout: in: query name: master_timeout @@ -15940,7 +16091,7 @@ components: description: Operation timeout for connection to cluster-manager node. schema: $ref: '#/components/schemas/_common:Duration' - x-version-added: 2.0.0 + x-version-added: '2.0' indices.delete_template::query.master_timeout: in: query name: master_timeout @@ -15990,7 +16141,7 @@ components: description: Operation timeout for connection to cluster-manager node. schema: $ref: '#/components/schemas/_common:Duration' - x-version-added: 2.0.0 + x-version-added: '2.0' indices.delete::query.expand_wildcards: in: query name: expand_wildcards @@ -16098,7 +16249,7 @@ components: description: Operation timeout for connection to cluster-manager node. schema: $ref: '#/components/schemas/_common:Duration' - x-version-added: 2.0.0 + x-version-added: '2.0' indices.exists_index_template::query.flat_settings: name: flat_settings in: query @@ -16139,7 +16290,7 @@ components: description: Operation timeout for connection to cluster-manager node. schema: $ref: '#/components/schemas/_common:Duration' - x-version-added: 2.0.0 + x-version-added: '2.0' indices.exists_template::query.flat_settings: in: query name: flat_settings @@ -16184,6 +16335,13 @@ components: type: boolean default: false style: form + indices.exists::query.cluster_manager_timeout: + name: cluster_manager_timeout + in: query + description: Operation timeout for connection to cluster-manager node. + schema: + $ref: '#/components/schemas/_common:Duration' + x-version-added: '2.0' indices.exists::query.expand_wildcards: in: query name: expand_wildcards @@ -16337,6 +16495,7 @@ components: type: boolean style: form indices.forcemerge::query.primary_only: + x-version-added: '2.13' name: primary_only in: query description: Specify whether the operation should only perform on primary shards. Defaults to false. @@ -16345,6 +16504,7 @@ components: default: false description: Specify whether the operation should only perform on primary shards. Defaults to false. indices.forcemerge::query.wait_for_completion: + x-version-added: '2.7' in: query name: wait_for_completion description: Should the request wait until the force merge is completed. @@ -16494,7 +16654,7 @@ components: description: Operation timeout for connection to cluster-manager node. schema: $ref: '#/components/schemas/_common:Duration' - x-version-added: 2.0.0 + x-version-added: '2.0' indices.get_index_template::query.flat_settings: in: query name: flat_settings @@ -16547,7 +16707,7 @@ components: description: Operation timeout for connection to cluster-manager node. schema: $ref: '#/components/schemas/_common:Duration' - x-version-added: 2.0.0 + x-version-added: '2.0' indices.get_mapping::query.expand_wildcards: in: query name: expand_wildcards @@ -16566,6 +16726,16 @@ components: schema: type: boolean style: form + indices.get_mapping::query.index: + in: query + name: index + description: |- + Comma-separated list of data streams, indices, and aliases used to limit the request. + Supports wildcards (`*`). + To target all data streams and indices, omit this parameter or use `*` or `_all`. + schema: + $ref: '#/components/schemas/_common:Indices' + style: simple indices.get_mapping::query.local: in: query name: local @@ -16623,7 +16793,7 @@ components: description: Operation timeout for connection to cluster-manager node. schema: $ref: '#/components/schemas/_common:Duration' - x-version-added: 2.0.0 + x-version-added: '2.0' indices.get_settings::query.expand_wildcards: in: query name: expand_wildcards @@ -16697,7 +16867,7 @@ components: description: Operation timeout for connection to cluster-manager node. schema: $ref: '#/components/schemas/_common:Duration' - x-version-added: 2.0.0 + x-version-added: '2.0' indices.get_template::query.flat_settings: in: query name: flat_settings @@ -16783,7 +16953,7 @@ components: description: Operation timeout for connection to cluster-manager node. schema: $ref: '#/components/schemas/_common:Duration' - x-version-added: 2.0.0 + x-version-added: '2.0' indices.get::query.expand_wildcards: in: query name: expand_wildcards @@ -16864,7 +17034,7 @@ components: description: Operation timeout for connection to cluster-manager node. schema: $ref: '#/components/schemas/_common:Duration' - x-version-added: 2.0.0 + x-version-added: '2.0' indices.open::query.expand_wildcards: in: query name: expand_wildcards @@ -16920,6 +17090,7 @@ components: $ref: '#/components/schemas/_common:WaitForActiveShards' style: form indices.open::query.wait_for_completion: + x-version-added: '2.7' name: wait_for_completion in: query description: Should this request wait until the operation has completed before returning. @@ -16943,7 +17114,7 @@ components: name: name description: |- Alias to update. - If the alias doesn’t exist, the request creates it. + If the alias doesn't exist, the request creates it. Index alias names support date math. required: true schema: @@ -16955,7 +17126,7 @@ components: description: Operation timeout for connection to cluster-manager node. schema: $ref: '#/components/schemas/_common:Duration' - x-version-added: 2.0.0 + x-version-added: '2.0' indices.put_alias::query.master_timeout: in: query name: master_timeout @@ -16999,7 +17170,7 @@ components: description: Operation timeout for connection to cluster-manager node. schema: $ref: '#/components/schemas/_common:Duration' - x-version-added: 2.0.0 + x-version-added: '2.0' indices.put_index_template::query.create: in: query name: create @@ -17040,7 +17211,7 @@ components: description: Operation timeout for connection to cluster-manager node. schema: $ref: '#/components/schemas/_common:Duration' - x-version-added: 2.0.0 + x-version-added: '2.0' indices.put_mapping::query.expand_wildcards: in: query name: expand_wildcards @@ -17117,7 +17288,7 @@ components: description: Operation timeout for connection to cluster-manager node. schema: $ref: '#/components/schemas/_common:Duration' - x-version-added: 2.0.0 + x-version-added: '2.0' indices.put_settings::query.expand_wildcards: in: query name: expand_wildcards @@ -17188,7 +17359,7 @@ components: description: Operation timeout for connection to cluster-manager node. schema: $ref: '#/components/schemas/_common:Duration' - x-version-added: 2.0.0 + x-version-added: '2.0' indices.put_template::query.create: in: query name: create @@ -17332,7 +17503,7 @@ components: description: Operation timeout for connection to cluster-manager node. schema: $ref: '#/components/schemas/_common:Duration' - x-version-added: 2.0.0 + x-version-added: '2.0' indices.rollover::query.dry_run: in: query name: dry_run @@ -17484,7 +17655,7 @@ components: description: Operation timeout for connection to cluster-manager node. schema: $ref: '#/components/schemas/_common:Duration' - x-version-added: 2.0.0 + x-version-added: '2.0' indices.shrink::query.copy_settings: name: copy_settings in: query @@ -17530,6 +17701,7 @@ components: $ref: '#/components/schemas/_common:WaitForActiveShards' style: form indices.shrink::query.wait_for_completion: + x-version-added: '2.7' name: wait_for_completion in: query description: Should this request wait until the operation has completed before returning. @@ -17559,7 +17731,7 @@ components: description: Operation timeout for connection to cluster-manager node. schema: $ref: '#/components/schemas/_common:Duration' - x-version-added: 2.0.0 + x-version-added: '2.0' indices.simulate_index_template::query.create: in: query name: create @@ -17609,7 +17781,7 @@ components: description: Operation timeout for connection to cluster-manager node. schema: $ref: '#/components/schemas/_common:Duration' - x-version-added: 2.0.0 + x-version-added: '2.0' indices.simulate_template::query.create: in: query name: create @@ -17650,7 +17822,7 @@ components: description: Operation timeout for connection to cluster-manager node. schema: $ref: '#/components/schemas/_common:Duration' - x-version-added: 2.0.0 + x-version-added: '2.0' indices.split::query.copy_settings: name: copy_settings in: query @@ -17696,6 +17868,7 @@ components: $ref: '#/components/schemas/_common:WaitForActiveShards' style: form indices.split::query.wait_for_completion: + x-version-added: '2.7' name: wait_for_completion in: query description: Should this request wait until the operation has completed before returning. @@ -17798,7 +17971,7 @@ components: description: Operation timeout for connection to cluster-manager node. schema: $ref: '#/components/schemas/_common:Duration' - x-version-added: 2.0.0 + x-version-added: '2.0' indices.update_aliases::query.master_timeout: in: query name: master_timeout @@ -17858,6 +18031,7 @@ components: type: boolean description: If true, only ancient (an older Lucene major release) segments will be upgraded. indices.upgrade::query.wait_for_completion: + x-version-added: '2.7' name: wait_for_completion in: query description: Should this request wait until the operation has completed before returning. @@ -17987,7 +18161,7 @@ components: description: Operation timeout for connection to cluster-manager node. schema: $ref: '#/components/schemas/_common:Duration' - x-version-added: 2.0.0 + x-version-added: '2.0' ingest.delete_pipeline::query.master_timeout: in: query name: master_timeout @@ -18026,7 +18200,7 @@ components: description: Operation timeout for connection to cluster-manager node. schema: $ref: '#/components/schemas/_common:Duration' - x-version-added: 2.0.0 + x-version-added: '2.0' ingest.get_pipeline::query.master_timeout: in: query name: master_timeout @@ -18053,7 +18227,7 @@ components: description: Operation timeout for connection to cluster-manager node. schema: $ref: '#/components/schemas/_common:Duration' - x-version-added: 2.0.0 + x-version-added: '2.0' ingest.put_pipeline::query.master_timeout: in: query name: master_timeout @@ -18076,7 +18250,7 @@ components: name: id description: |- Pipeline to test. - If you don’t specify a `pipeline` in the request body, this parameter is required. + If you don't specify a `pipeline` in the request body, this parameter is required. required: true schema: $ref: '#/components/schemas/_common:Id' @@ -18461,34 +18635,34 @@ components: items: type: string enum: + - cache_capacity_reached - circuit_breaker_triggered - - total_load_time - eviction_count - - hit_count - - miss_count + - faiss_initialized + - graph_index_errors + - graph_index_requests - graph_memory_usage - graph_memory_usage_percentage - - graph_index_requests - - graph_index_errors - - graph_query_requests - graph_query_errors + - graph_query_requests + - hit_count + - indexing_from_model_degraded + - indices_in_cache - knn_query_requests - - cache_capacity_reached - - load_success_count - load_exception_count - - indices_in_cache - - script_compilations + - load_success_count + - miss_count + - model_index_status + - nmslib_initialized - script_compilation_errors - - script_query_requests + - script_compilations - script_query_errors - - nmslib_initialized - - faiss_initialized - - model_index_status - - indexing_from_model_degraded - - training_requests + - script_query_requests + - total_load_time - training_errors - training_memory_usage - training_memory_usage_percentage + - training_requests required: true knn.stats::query.timeout: name: timeout @@ -18904,6 +19078,22 @@ components: schema: $ref: '#/components/schemas/_common:NodeIds' style: simple + nodes.info::path.node_id_or_metric: + in: path + name: node_id_or_metric + description: | + Limits the information returned to a list of node IDs or specific metrics. + Supports a comma-separated list, such as node1,node2 or http,ingest. + required: true + schema: + anyOf: + - title: node_id + $ref: '#/components/schemas/_common:NodeIds' + - title: metric + type: array + items: + $ref: '#/components/schemas/nodes.info:Metric' + style: simple nodes.info::query.flat_settings: in: query name: flat_settings @@ -19311,7 +19501,7 @@ components: description: Operation timeout for connection to cluster-manager node. schema: $ref: '#/components/schemas/_common:Duration' - x-version-added: 2.0.0 + x-version-added: '2.0' put_script::query.master_timeout: in: query name: master_timeout @@ -19423,7 +19613,7 @@ components: name: slices description: |- The number of slices this task should be divided into. - Defaults to 1 slice, meaning the task isn’t sliced into subtasks. + Defaults to 1 slice, meaning the task isn't sliced into subtasks. schema: $ref: '#/components/schemas/_common:Slices' style: form @@ -19460,7 +19650,7 @@ components: description: Operation timeout for connection to cluster-manager node. schema: $ref: '#/components/schemas/_common:Duration' - x-version-added: 2.0.0 + x-version-added: '2.0' remote_store.restore::query.wait_for_completion: name: wait_for_completion in: query @@ -19553,7 +19743,7 @@ components: scroll::query.rest_total_hits_as_int: in: query name: rest_total_hits_as_int - description: If true, the API response’s hit.total property is returned as an integer. If false, the API response’s hit.total property is returned as an object. + description: If true, the API response's hit.total property is returned as an integer. If false, the API response's hit.total property is returned as an object. schema: type: boolean default: false @@ -19586,7 +19776,7 @@ components: description: Operation timeout for connection to cluster-manager node. schema: $ref: '#/components/schemas/_common:Duration' - x-version-added: 2.0.0 + x-version-added: '2.0' search_pipeline.delete::query.timeout: name: timeout in: query @@ -19605,7 +19795,7 @@ components: description: operation timeout for connection to cluster-manager node. schema: $ref: '#/components/schemas/_common:Duration' - x-version-added: 2.0.0 + x-version-added: '2.0' search_pipeline.put::path.id: name: id in: path @@ -19619,7 +19809,7 @@ components: description: operation timeout for connection to cluster-manager node. schema: $ref: '#/components/schemas/_common:Duration' - x-version-added: 2.0.0 + x-version-added: '2.0' search_pipeline.put::query.timeout: name: timeout in: query @@ -20478,7 +20668,7 @@ components: description: Operation timeout for connection to cluster-manager node. schema: $ref: '#/components/schemas/_common:Duration' - x-version-added: 2.0.0 + x-version-added: '2.0' snapshot.cleanup_repository::query.master_timeout: in: query name: master_timeout @@ -20526,7 +20716,7 @@ components: description: Operation timeout for connection to cluster-manager node. schema: $ref: '#/components/schemas/_common:Duration' - x-version-added: 2.0.0 + x-version-added: '2.0' snapshot.clone::query.master_timeout: in: query name: master_timeout @@ -20551,7 +20741,7 @@ components: description: Operation timeout for connection to cluster-manager node. schema: $ref: '#/components/schemas/_common:Duration' - x-version-added: 2.0.0 + x-version-added: '2.0' snapshot.create_repository::query.master_timeout: in: query name: master_timeout @@ -20598,7 +20788,7 @@ components: description: Operation timeout for connection to cluster-manager node. schema: $ref: '#/components/schemas/_common:Duration' - x-version-added: 2.0.0 + x-version-added: '2.0' snapshot.create::query.master_timeout: in: query name: master_timeout @@ -20631,7 +20821,7 @@ components: description: Operation timeout for connection to cluster-manager node. schema: $ref: '#/components/schemas/_common:Duration' - x-version-added: 2.0.0 + x-version-added: '2.0' snapshot.delete_repository::query.master_timeout: in: query name: master_timeout @@ -20671,7 +20861,7 @@ components: description: Operation timeout for connection to cluster-manager node. schema: $ref: '#/components/schemas/_common:Duration' - x-version-added: 2.0.0 + x-version-added: '2.0' snapshot.delete::query.master_timeout: in: query name: master_timeout @@ -20696,7 +20886,7 @@ components: description: Operation timeout for connection to cluster-manager node. schema: $ref: '#/components/schemas/_common:Duration' - x-version-added: 2.0.0 + x-version-added: '2.0' snapshot.get_repository::query.local: in: query name: local @@ -20740,7 +20930,7 @@ components: description: Operation timeout for connection to cluster-manager node. schema: $ref: '#/components/schemas/_common:Duration' - x-version-added: 2.0.0 + x-version-added: '2.0' snapshot.get::query.ignore_unavailable: in: query name: ignore_unavailable @@ -20788,7 +20978,7 @@ components: description: Operation timeout for connection to cluster-manager node. schema: $ref: '#/components/schemas/_common:Duration' - x-version-added: 2.0.0 + x-version-added: '2.0' snapshot.restore::query.master_timeout: in: query name: master_timeout @@ -20829,7 +21019,7 @@ components: description: Operation timeout for connection to cluster-manager node. schema: $ref: '#/components/schemas/_common:Duration' - x-version-added: 2.0.0 + x-version-added: '2.0' snapshot.status::query.ignore_unavailable: in: query name: ignore_unavailable @@ -20862,7 +21052,7 @@ components: description: Operation timeout for connection to cluster-manager node. schema: $ref: '#/components/schemas/_common:Duration' - x-version-added: 2.0.0 + x-version-added: '2.0' snapshot.verify_repository::query.master_timeout: in: query name: master_timeout @@ -21162,7 +21352,7 @@ components: transforms.search::query.from: name: from in: query - description: The starting transform to return. Default is 0. + description: The starting transform to return. Default is `0`. required: false schema: type: number @@ -21178,7 +21368,7 @@ components: transforms.search::query.size: name: size in: query - description: Specifies the number of transforms to return. Default is 10. + description: Specifies the number of transforms to return. Default is `10`. required: false schema: type: number @@ -21186,7 +21376,7 @@ components: transforms.search::query.sortDirection: name: sortDirection in: query - description: Specifies the direction to sort results in. Can be ASC or DESC. Default is ASC. + description: Specifies the direction to sort results in. Can be `ASC` or `DESC`. Default is `ASC`. required: false schema: type: string @@ -21726,12 +21916,10 @@ components: properties: persistent: type: object - additionalProperties: - type: object + additionalProperties: {} transient: type: object - additionalProperties: - type: object + additionalProperties: {} description: The settings to be updated. Can be either `transient` or `persistent` (survives cluster restart). required: true cluster.reroute: @@ -21828,7 +22016,7 @@ components: analyzer: description: |- The name of the analyzer that should be applied to the provided `text`. - This could be a built-in analyzer, or an analyzer that’s been configured in the index. + This could be a built-in analyzer, or an analyzer that's been configured in the index. type: string attributes: description: Array of token attributes used to filter the output of the `explain` parameter. @@ -21903,21 +22091,30 @@ components: schema: type: object properties: + alias: + type: string filter: $ref: '#/components/schemas/_common.query_dsl:QueryContainer' + index: + type: string index_routing: $ref: '#/components/schemas/_common:Routing' is_write_index: description: |- If `true`, sets the write index or data stream for the alias. - If an alias points to multiple indices or data streams and `is_write_index` isn’t set, the alias rejects write requests. - If an index alias points to one index and `is_write_index` isn’t set, the index automatically acts as the write index. - Data stream aliases don’t automatically set a write data stream, even if the alias points to one data stream. + If an alias points to multiple indices or data streams and `is_write_index` isn't set, the alias rejects write requests. + If an index alias points to one index and `is_write_index` isn't set, the index automatically acts as the write index. + Data stream aliases don't automatically set a write data stream, even if the alias points to one data stream. type: boolean routing: $ref: '#/components/schemas/_common:Routing' search_routing: $ref: '#/components/schemas/_common:Routing' + is_hidden: + x-version-added: '2.16' + description: If `true`, the alias will be hidden`. + type: boolean + default: false description: The settings for the alias, such as `routing` or `filter` indices.put_index_template: content: @@ -21937,7 +22134,7 @@ components: template: $ref: '#/components/schemas/indices.put_index_template:IndexTemplateMapping' data_stream: - $ref: '#/components/schemas/indices._common:DataStreamVisibility' + $ref: '#/components/schemas/indices._common:IndexTemplateDataStreamConfiguration' priority: description: |- Priority to determine index template precedence when a new data stream or index is created. @@ -22119,7 +22316,7 @@ components: template: $ref: '#/components/schemas/indices.put_index_template:IndexTemplateMapping' data_stream: - $ref: '#/components/schemas/indices._common:DataStreamVisibility' + $ref: '#/components/schemas/indices._common:IndexTemplateDataStreamConfiguration' priority: description: |- Priority to determine index template precedence when a new data stream or index is created. @@ -22151,8 +22348,7 @@ components: settings: description: Configuration options for the target index. type: object - additionalProperties: - type: object + additionalProperties: {} description: The configuration for the target index (`settings` and `aliases`) indices.update_aliases: content: @@ -22281,8 +22477,8 @@ components: type: string description: The portable format of the model file. enum: - - TORCH_SCRIPT - ONNX + - TORCH_SCRIPT description: type: string description: The model description. @@ -22290,9 +22486,9 @@ components: type: string description: The ID of the model group to which to register the model. required: + - model_format - name - version - - model_format ml.register_model_group: content: application/json: @@ -22981,8 +23177,8 @@ components: settings: $ref: '#/components/schemas/snapshot._common:RepositorySettings' required: - - type - settings + - type description: The repository definition required: true snapshot.restore: @@ -23193,6 +23389,11 @@ components: type: array items: $ref: '#/components/schemas/cat.health:HealthRecord' + application/smile: + schema: + type: array + items: + $ref: '#/components/schemas/cat.health:HealthRecord' cat.help@200: description: '' content: @@ -23219,6 +23420,11 @@ components: type: array items: $ref: '#/components/schemas/cat.indices:IndicesRecord' + application/smile: + schema: + type: array + items: + $ref: '#/components/schemas/cat.indices:IndicesRecord' cat.master@200: description: '' content: @@ -23381,8 +23587,8 @@ components: num_freed: type: number required: - - succeeded - num_freed + - succeeded cluster.allocation_explain@200: description: '' content: @@ -23550,12 +23756,10 @@ components: type: boolean persistent: type: object - additionalProperties: - type: object + additionalProperties: {} transient: type: object - additionalProperties: - type: object + additionalProperties: {} required: - acknowledged - persistent @@ -23615,8 +23819,8 @@ components: _shards: $ref: '#/components/schemas/_common:ShardStatistics' required: - - count - _shards + - count create_pit@200: description: '' content: @@ -23656,6 +23860,10 @@ components: schema: type: object properties: + _nodes: + $ref: '#/components/schemas/_common:NodeStatistics' + cluster_name: + $ref: '#/components/schemas/_common:Name' dangling_indices: type: array items: @@ -23769,8 +23977,8 @@ components: get: $ref: '#/components/schemas/_common:InlineGet' required: - - _index - _id + - _index - matched field_caps@200: description: '' @@ -23788,8 +23996,8 @@ components: additionalProperties: $ref: '#/components/schemas/_core.field_caps:FieldCapability' required: - - indices - fields + - indices get_all_pits@200: description: '' content: @@ -23889,8 +24097,8 @@ components: $ref: '#/components/schemas/indices.add_block:IndicesBlockStatus' required: - acknowledged - - shards_acknowledged - indices + - shards_acknowledged indices.analyze@200: description: '' content: @@ -23966,9 +24174,9 @@ components: acknowledged: type: boolean required: + - acknowledged - index - shards_acknowledged - - acknowledged indices.data_streams_stats@200: description: '' content: @@ -24151,15 +24359,22 @@ components: content: application/json: schema: - type: object - properties: - acknowledged: - type: boolean - shards_acknowledged: - type: boolean - required: - - acknowledged - - shards_acknowledged + oneOf: + - type: object + properties: + task: + $ref: '#/components/schemas/_common:TaskId' + additionalProperties: false + - type: object + properties: + acknowledged: + type: boolean + shards_acknowledged: + type: boolean + required: + - acknowledged + - shards_acknowledged + additionalProperties: false indices.put_alias@200: description: '' content: @@ -24224,9 +24439,9 @@ components: items: $ref: '#/components/schemas/indices.resolve_index:ResolveIndexDataStreamsItem' required: - - indices - aliases - data_streams + - indices indices.rollover@200: description: '' content: @@ -24272,8 +24487,8 @@ components: _shards: $ref: '#/components/schemas/_common:ShardStatistics' required: - - indices - _shards + - indices indices.shard_stores@200: description: '' content: @@ -24302,8 +24517,8 @@ components: $ref: '#/components/schemas/_common:IndexName' required: - acknowledged - - shards_acknowledged - index + - shards_acknowledged indices.simulate_index_template@200: description: '' content: @@ -24340,8 +24555,8 @@ components: $ref: '#/components/schemas/_common:IndexName' required: - acknowledged - - shards_acknowledged - index + - shards_acknowledged indices.stats@200: description: '' content: @@ -24358,8 +24573,8 @@ components: _all: $ref: '#/components/schemas/indices.stats:IndicesStats' required: - - _shards - _all + - _shards indices.update_aliases@200: description: '' content: @@ -24516,10 +24731,10 @@ components: type: integer format: int64 required: - - name - - latest_version - - description - access + - description + - latest_version + - name ml.get_task@200: content: application/json: @@ -24533,12 +24748,12 @@ components: type: string description: The state. enum: - - CREATED - - RUNNING - - COMPLETED - - FAILED - CANCELLED + - COMPLETED - COMPLETED_WITH_ERROR + - CREATED + - FAILED + - RUNNING required: - state ml.register_model_group@200: @@ -24572,8 +24787,8 @@ components: type: string description: The status. required: - - task_id - status + - task_id ml.search_models@200: content: application/json: @@ -24752,9 +24967,9 @@ components: additionalProperties: type: object required: - - metric_score - details - failures + - metric_score reindex_rethrottle@200: description: '' content: @@ -24929,9 +25144,9 @@ components: additionalProperties: $ref: '#/components/schemas/_core.search_shards:ShardStoreIndex' required: + - indices - nodes - shards - - indices search_template@200: description: '' content: @@ -24976,10 +25191,10 @@ components: terminated_early: type: boolean required: - - took - - timed_out - _shards - hits + - timed_out + - took search@200: description: '' content: @@ -25711,8 +25926,8 @@ components: description: The number of remaining snapshots that were not returned due to size limits and that can be fetched by additional requests using the next field value. type: number required: - - total - remaining + - total snapshot.restore@200: description: '' content: @@ -25802,11 +26017,11 @@ components: _version: $ref: '#/components/schemas/_common:VersionNumber' required: - - found - _id - _index - - took - _version + - found + - took transforms.delete@200: description: '' transforms.explain@200: @@ -25916,9 +26131,9 @@ components: _common:ActionStatusOptions: type: string enum: - - success - failure - simulated + - success - throttled _common:BaseNode: type: object @@ -25984,27 +26199,27 @@ components: avg_size_in_bytes: type: number required: + - avg_size_in_bytes + - avg_time_in_millis - total_operations - - total_time_in_millis - total_size_in_bytes - - avg_time_in_millis - - avg_size_in_bytes + - total_time_in_millis _common:byte: type: number _common:Bytes: type: string enum: - b + - g + - gb - k - kb - m - mb - - g - - gb - - t - - tb - p - pb + - t + - tb _common:ByteSize: oneOf: - type: number @@ -26027,17 +26242,17 @@ components: items: $ref: '#/components/schemas/_common:ShardFailure' required: - - status - indices + - status - timed_out _common:ClusterSearchStatus: type: string enum: - - running - - successful + - failed - partial + - running - skipped - - failed + - successful _common:ClusterStatistics: type: object properties: @@ -26058,12 +26273,12 @@ components: additionalProperties: $ref: '#/components/schemas/_common:ClusterDetails' required: + - failed + - partial + - running - skipped - successful - total - - running - - partial - - failed _common:CompletionStats: type: object properties: @@ -26095,10 +26310,10 @@ components: right: type: number required: - - top - bottom - left - right + - top _common:DataStreamName: type: string _common:DataStreamNames: @@ -26122,15 +26337,15 @@ components: _common:DFIIndependenceMeasure: type: string enum: - - standardized - - saturated - chisquared + - saturated + - standardized _common:DFRAfterEffect: type: string enum: - - no - b - l + - no _common:DFRBasicModel: type: string enum: @@ -26146,15 +26361,15 @@ components: _common:DistanceUnit: type: string enum: - - in + - cm - ft - - yd - - mi - - nmi + - in - km - m - - cm + - mi - mm + - nmi + - yd _common:DocStats: type: object properties: @@ -26171,6 +26386,20 @@ components: type: number required: - count + _common:DocStatus: + description: Item level REST category class codes during indexing. + type: object + properties: + 1xx: + type: number + 2xx: + type: number + 3xx: + type: number + 4xx: + type: number + 5xx: + type: number _common:Duration: description: |- A duration. Units can be `nanos`, `micros`, `ms` (milliseconds), `s` (seconds), `m` (minutes), `h` (hours) and @@ -26234,10 +26463,10 @@ components: type: string enum: - all - - open - closed - hidden - none + - open _common:ExpandWildcards: oneOf: - $ref: '#/components/schemas/_common:ExpandWildcard' @@ -26288,14 +26517,12 @@ components: - size_in_bytes _common:FieldValue: description: A field value. - oneOf: - - type: number - - type: number - - type: string - - type: boolean - - nullable: true - type: string - - type: object + type: + - boolean + - 'null' + - number + - object + - string _common:FlushStats: type: object properties: @@ -26376,8 +26603,8 @@ components: items: type: number required: - - type - coordinates + - type _common:GeoLocation: description: |- A latitude/longitude as a 2 dimensional point. It can be represented in various ways: @@ -26395,10 +26622,10 @@ components: _common:GeoShapeRelation: type: string enum: - - intersects + - contains - disjoint + - intersects - within - - contains _common:GeoTile: description: A map tile reference, represented as `{zoom}/{x}/{y}` type: string @@ -26439,8 +26666,14 @@ components: type: string enum: - green - - yellow - red + - yellow + _common:HealthStatusCapitalized: + type: string + enum: + - GREEN + - RED + - YELLOW _common:Host: type: string _common:HourAndMinute: @@ -26498,6 +26731,8 @@ components: $ref: '#/components/schemas/_common:DurationValueUnitMillis' delete_total: type: number + doc_status: + $ref: '#/components/schemas/_common:DocStatus' is_throttled: type: boolean noop_update_total: @@ -26521,16 +26756,16 @@ components: write_load: type: number required: - - index_current - delete_current - delete_time_in_millis - delete_total + - index_current + - index_failed + - index_time_in_millis + - index_total - is_throttled - noop_update_total - throttle_time_in_millis - - index_time_in_millis - - index_total - - index_failed _common:IndexName: type: string _common:Indices: @@ -26565,7 +26800,6 @@ components: type: object required: - found - - _source _common:InlineGetDictUserDefined: type: object properties: @@ -26583,11 +26817,9 @@ components: $ref: '#/components/schemas/_common:Routing' _source: type: object - additionalProperties: - type: object + additionalProperties: true required: - found - - _source _common:InlineScript: allOf: - $ref: '#/components/schemas/_common:ScriptBase' @@ -26691,6 +26923,8 @@ components: $ref: '#/components/schemas/_common:Duration' total_time_in_millis: $ref: '#/components/schemas/_common:DurationValueUnitMillis' + unreferenced_file_cleanups_performed: + type: number required: - current - current_docs @@ -26704,8 +26938,7 @@ components: - total_time_in_millis _common:Metadata: type: object - additionalProperties: - type: object + additionalProperties: true _common:Metrics: oneOf: - type: string @@ -26778,20 +27011,21 @@ components: _common:NodeRole: type: string enum: - - master + - client + - cluster_manager + - coordinating_only - data - data_cold - data_content - data_frozen - data_hot - data_warm - - client - ingest + - master - ml - - voting_only - - transform - remote_cluster_client - - coordinating_only + - transform + - voting_only _common:NodeRoles: description: '* @doc_id node-roles' type: array @@ -26823,15 +27057,14 @@ components: relocating_node: oneOf: - $ref: '#/components/schemas/_common:NodeId' - - nullable: true - type: string + - type: 'null' relocation_failure_info: $ref: '#/components/schemas/_common:RelocationFailureInfo' required: - - state + - index - primary - shard - - index + - state _common:NodeStatistics: type: object properties: @@ -26849,16 +27082,16 @@ components: description: Number of nodes that rejected the request or failed to respond. If this value is not 0, a reason for the rejection or failure is included in the response. type: number required: - - total - - successful - failed + - successful + - total _common:Normalization: type: string enum: - - no - h1 - h2 - h3 + - no - z _common:OpenSearchVersionInfo: type: object @@ -26896,8 +27129,8 @@ components: _common:OpType: type: string enum: - - index - create + - index _common:Password: type: string _common:Percentage: @@ -26920,12 +27153,12 @@ components: can_match: $ref: '#/components/schemas/_common:uint' required: + - can_match - dfs_pre_query - - query - - fetch - dfs_query - expand - - can_match + - fetch + - query _common:PipelineName: type: string _common:PipeSeparatedFlagsSimpleQueryStringFlag: @@ -26959,18 +27192,21 @@ components: $ref: '#/components/schemas/_common:VersionString' licensed: type: boolean + custom_foldername: + type: + - 'null' + - string opensearch_version: $ref: '#/components/schemas/_common:VersionString' required: - classname - description - - opensearch_version - extended_plugins - has_native_controller - java_version - name + - opensearch_version - version - - licensed _common:QueryCacheStats: type: object properties: @@ -27045,8 +27281,8 @@ components: _common:Refresh: type: string enum: - - 'true' - 'false' + - 'true' - wait_for _common:RefreshStats: type: object @@ -27078,6 +27314,143 @@ components: type: number required: - failed_attempts + _common:RemoteStoreDownloadStats: + type: object + description: Statistics related to downloads to the remote segment store. + properties: + total_download_size: + description: The total amount of data download from the remote segment store. + $ref: '#/components/schemas/_common:RemoteStoreUploadDownloadStats' + total_time_spent_in_millis: + description: The total duration, in milliseconds, spent on downloads from the remote segment store. + $ref: '#/components/schemas/_common:DurationValueUnitMillis' + required: + - total_download_size + - total_time_spent_in_millis + _common:RemoteStoreStats: + type: object + description: Statistics about remote segment store operations. + properties: + upload: + $ref: '#/components/schemas/_common:RemoteStoreUploadStats' + download: + $ref: '#/components/schemas/_common:RemoteStoreDownloadStats' + required: + - download + - upload + _common:RemoteStoreTranslogStats: + type: object + properties: + upload: + $ref: '#/components/schemas/_common:RemoteStoreTranslogUploadStats' + required: + - upload + _common:RemoteStoreTranslogUploadStats: + type: object + description: Statistics related to uploads to the remote translog store. + properties: + total_uploads: + $ref: '#/components/schemas/_common:RemoteStoreTranslogUploadTotalUploadsStats' + total_upload_size: + $ref: '#/components/schemas/_common:RemoteStoreTranslogUploadTotalUploadSizeStats' + required: + - total_upload_size + - total_uploads + _common:RemoteStoreTranslogUploadTotalUploadSizeStats: + type: object + description: The total amount of data uploaded to the remote translog store. + properties: + failed_bytes: + description: The number of bytes that failed to upload to the remote translog store. + $ref: '#/components/schemas/_common:ByteSize' + started_bytes: + description: The number of bytes successfully uploaded to the remote translog store. + $ref: '#/components/schemas/_common:ByteSize' + succeeded_bytes: + description: The number of bytes successfully uploaded to the remote translog store. + $ref: '#/components/schemas/_common:ByteSize' + required: + - failed_bytes + - started_bytes + - succeeded_bytes + _common:RemoteStoreTranslogUploadTotalUploadsStats: + type: object + description: The number of syncs to the remote translog store. + properties: + failed: + description: The number of failed upload syncs to the remote translog store. + type: number + started: + description: The number of upload syncs to the remote translog store that have started. + type: number + succeeded: + description: The number of successful upload syncs to the remote translog store. + type: number + required: + - failed + - started + - succeeded + _common:RemoteStoreUploadDownloadStats: + type: object + description: The amount of data, in bytes, uploaded or downloaded to/from the remote segment store. + properties: + failed_bytes: + description: The number of bytes that failed to upload/upload to/from the remote segment store. + $ref: '#/components/schemas/_common:ByteSize' + started_bytes: + description: The number of bytes to upload/download to/from the remote segment store after the upload/download has started. + $ref: '#/components/schemas/_common:ByteSize' + succeeded_bytes: + description: The number of bytes successfully uploaded/downloaded to/from the remote segment store. + $ref: '#/components/schemas/_common:ByteSize' + required: + - failed_bytes + - started_bytes + - succeeded_bytes + _common:RemoteStoreUploadPressureStats: + type: object + description: Statistics related to segment store upload backpressure. + properties: + total_rejections: + description: The total number of requests rejected due to segment store upload backpressure. + type: number + required: + - total_rejections + _common:RemoteStoreUploadRefreshSizeLagStats: + type: object + description: The amount of lag during upload between the remote segment store and the local store. + properties: + max_bytes: + description: The maximum amount of lag, in bytes, during the upload refresh between the remote segment store and the local store. + $ref: '#/components/schemas/_common:ByteSize' + total_bytes: + description: The total number of bytes that lagged during the upload refresh between the remote segment store and the local store. + $ref: '#/components/schemas/_common:ByteSize' + required: + - max_bytes + - total_bytes + _common:RemoteStoreUploadStats: + type: object + description: Statistics related to uploads to the remote segment store. + properties: + max_refresh_time_lag_in_millis: + description: The maximum duration, in milliseconds, that the remote refresh is behind the local refresh. + $ref: '#/components/schemas/_common:DurationValueUnitMillis' + pressure: + $ref: '#/components/schemas/_common:RemoteStoreUploadPressureStats' + refresh_size_lag: + $ref: '#/components/schemas/_common:RemoteStoreUploadRefreshSizeLagStats' + total_time_spent_in_millis: + description: The total amount of time, in milliseconds, spent on uploads to the remote segment store. + $ref: '#/components/schemas/_common:DurationValueUnitMillis' + total_upload_size: + $ref: '#/components/schemas/_common:RemoteStoreUploadDownloadStats' + required: + - max_refresh_time_lag_in_millis + - pressure + - refresh_size_lag + - total_time_spent_in_millis + - total_upload_size _common:RequestCacheStats: type: object properties: @@ -27096,14 +27469,23 @@ components: - hit_count - memory_size_in_bytes - miss_count + _common:RequestStats: + type: object + properties: + time_in_millis: + $ref: '#/components/schemas/_common:DurationValueUnitMillis' + current: + type: number + total: + type: number _common:Result: type: string enum: - created - - updated - deleted - - not_found - noop + - not_found + - updated _common:Retries: type: object properties: @@ -27163,10 +27545,10 @@ components: _common:ScriptLanguage: type: string enum: - - painless - expression - - mustache - java + - mustache + - painless _common:ScriptSort: type: object properties: @@ -27185,8 +27567,8 @@ components: _common:ScriptSortType: type: string enum: - - string - number + - string - version _common:ScrollId: type: string @@ -27199,39 +27581,88 @@ components: _common:SearchStats: type: object properties: + concurrent_query_total: + description: The total number of query operations that use concurrent segment search. + type: number + concurrent_query_time: + $ref: '#/components/schemas/_common:Duration' + concurrent_query_time_in_millis: + description: The total amount of time taken by all query operations that use concurrent segment search, in milliseconds. + $ref: '#/components/schemas/_common:DurationValueUnitMillis' + concurrent_query_current: + description: The number of currently running query operations that use concurrent segment search. + type: number + concurrent_avg_slice_count: + description: The average slice count of all search requests. This is computed as the total slice count divided by the total number of concurrent search requests. + type: number fetch_current: + description: The number of shard fetch operations that are currently running. type: number fetch_time: + description: The total amount of time for all shard fetch operations. $ref: '#/components/schemas/_common:Duration' fetch_time_in_millis: + description: The total amount of time for all shard fetch operations, in milliseconds. $ref: '#/components/schemas/_common:DurationValueUnitMillis' fetch_total: + description: The total number of shard fetch operations. type: number open_contexts: + description: The number of open search contexts. + type: number + point_in_time_total: + description: The total number of shard Point in Time (PIT) contexts that have been created (completed and active) since the node last restarted. + type: number + point_in_time_time: + $ref: '#/components/schemas/_common:Duration' + point_in_time_time_in_millis: + description: The amount of time that shard PIT contexts have been held open since the node last restarted, in milliseconds. + $ref: '#/components/schemas/_common:DurationValueUnitMillis' + point_in_time_current: + description: The number of shard PIT contexts currently open. type: number query_current: + description: The number of shard query operations that are currently running. type: number query_time: + description: The total amount of time for all shard query operations. $ref: '#/components/schemas/_common:Duration' query_time_in_millis: + description: The total amount of time for all shard query operations, in milliseconds. $ref: '#/components/schemas/_common:DurationValueUnitMillis' query_total: + description: The total number of shard query operations. + type: number + request: + type: object + description: Statistics about coordinator search operations for the node. + additionalProperties: + $ref: '#/components/schemas/_common:RequestStats' + search_idle_reactivate_count_total: type: number scroll_current: + description: The number of shard scroll operations that are currently running. type: number scroll_time: + description: The total amount of time for all shard scroll operations. $ref: '#/components/schemas/_common:Duration' scroll_time_in_millis: + description: The total amount of time for all shard scroll operations, in milliseconds. $ref: '#/components/schemas/_common:DurationValueUnitMillis' scroll_total: + description: The total number of shard scroll operations. type: number suggest_current: + description: The number of shard suggest operations that are currently running. type: number suggest_time: + description: The total amount of time for all shard suggest operations. $ref: '#/components/schemas/_common:Duration' suggest_time_in_millis: + description: The total amount of time for all shard suggest operations, in milliseconds. $ref: '#/components/schemas/_common:DurationValueUnitMillis' suggest_total: + description: The total number of shard suggest operations. type: number groups: type: object @@ -27253,8 +27684,21 @@ components: _common:SearchType: type: string enum: - - query_then_fetch - dfs_query_then_fetch + - query_then_fetch + _common:SegmentReplicationStats: + type: object + properties: + max_bytes_behind: + $ref: '#/components/schemas/_common:ByteSize' + max_replication_lag: + $ref: '#/components/schemas/_common:ByteSize' + total_bytes_behind: + $ref: '#/components/schemas/_common:ByteSize' + required: + - max_bytes_behind + - max_replication_lag + - total_bytes_behind _common:SegmentsStats: type: object properties: @@ -27323,6 +27767,10 @@ components: version_map_memory_in_bytes: description: Total amount, in bytes, of memory used by all version maps across all shards assigned to selected nodes. type: number + remote_store: + $ref: '#/components/schemas/_common:RemoteStoreStats' + segment_replication: + $ref: '#/components/schemas/_common:SegmentReplicationStats' required: - count - doc_values_memory_in_bytes @@ -27334,8 +27782,8 @@ components: - norms_memory_in_bytes - points_memory_in_bytes - stored_fields_memory_in_bytes - - terms_memory_in_bytes - term_vectors_memory_in_bytes + - terms_memory_in_bytes - version_map_memory_in_bytes _common:SequenceNumber: type: number @@ -27417,11 +27865,11 @@ components: _common:SortMode: type: string enum: - - min - - max - - sum - avg + - max - median + - min + - sum _common:SortOptions: type: object properties: @@ -27489,8 +27937,8 @@ components: This includes the size of shards not stored fully on the nodes, such as the cache for partially mounted indices. type: number required: - - size_in_bytes - reserved_in_bytes + - size_in_bytes _common:Stringifiedboolean: description: |- Some APIs will return values such as numbers also as a string (notably epoch timestamps). This behavior @@ -27544,9 +27992,9 @@ components: _common:SuggestMode: type: string enum: + - always - missing - popular - - always _common:TaskFailure: type: object properties: @@ -27559,10 +28007,10 @@ components: reason: $ref: '#/components/schemas/_common:ErrorCause' required: - - task_id - node_id - - status - reason + - status + - task_id _common:TaskId: oneOf: - type: string @@ -27583,13 +28031,13 @@ components: _common:TimeUnit: type: string enum: - - nanos + - d + - h + - m - micros - ms + - nanos - s - - m - - h - - d _common:TimeZone: type: string _common:TopLeftBottomRightGeoBounds: @@ -27600,8 +28048,8 @@ components: bottom_right: $ref: '#/components/schemas/_common:GeoLocation' required: - - top_left - bottom_right + - top_left _common:TopRightBottomLeftGeoBounds: type: object properties: @@ -27610,8 +28058,8 @@ components: bottom_left: $ref: '#/components/schemas/_common:GeoLocation' required: - - top_right - bottom_left + - top_right _common:TranslogStats: type: object properties: @@ -27619,6 +28067,8 @@ components: type: number operations: type: number + remote_store: + $ref: '#/components/schemas/_common:RemoteStoreTranslogStats' size: type: string size_in_bytes: @@ -27637,6 +28087,9 @@ components: - uncommitted_size_in_bytes _common:TransportAddress: type: string + _common:Type: + type: string + x-version-removed: '2.0' _common:uint: type: number _common:ulong: @@ -27661,10 +28114,10 @@ components: _common:VersionType: type: string enum: - - internal - external - external_gte - force + - internal _common:Void: description: |- The absence of any type. This is commonly used in APIs that don't return a body. @@ -27686,12 +28139,12 @@ components: _common:WaitForEvents: type: string enum: - - immediate - - urgent - high - - normal - - low + - immediate - languid + - low + - normal + - urgent _common:WarmerStats: type: object properties: @@ -27717,6 +28170,8 @@ components: _common:WriteResponseBase: type: object properties: + _type: + $ref: '#/components/schemas/_common:Type' _id: $ref: '#/components/schemas/_common:Id' _index: @@ -27737,10 +28192,10 @@ components: - _id - _index - _primary_term - - result - _seq_no - _shards - _version + - result _common.aggregations:AdjacencyMatrixAggregate: allOf: - $ref: '#/components/schemas/_common.aggregations:MultiBucketAggregateBaseAdjacencyMatrixBucket' @@ -28037,31 +28492,29 @@ components: properties: from: description: Start of the range (inclusive). - oneOf: - - type: number - - type: string - - nullable: true - type: string + type: + - 'null' + - number + - string key: description: Custom key to return the range with. type: string to: description: End of the range (exclusive). - oneOf: - - type: number - - type: string - - nullable: true - type: string + type: + - 'null' + - number + - string _common.aggregations:ArrayPercentilesItem: type: object properties: key: type: string value: - oneOf: - - type: number - - nullable: true - type: string + type: + - 'null' + - number + - string value_as_string: type: string required: @@ -28152,12 +28605,12 @@ components: upper_as_string: type: string required: - - min + - lower - max + - min - q1 - q2 - q3 - - lower - upper _common.aggregations:BoxplotAggregation: allOf: @@ -28199,7 +28652,7 @@ components: properties: doc_count: description: |- - The total number of documents that initially created the expectations. It’s required to be greater + The total number of documents that initially created the expectations. It's required to be greater than or equal to the sum of all values in the buckets_path as this is the originating superset of data to which the term values are correlated. type: number @@ -28569,13 +29022,13 @@ components: _common.aggregations:CalendarInterval: type: string enum: - - second - - minute - - hour - day - - week + - hour + - minute - month - quarter + - second + - week - year _common.aggregations:CardinalityAggregate: allOf: @@ -28603,11 +29056,11 @@ components: _common.aggregations:CardinalityExecutionMode: type: string enum: - - global_ordinals - - segment_ordinals - direct + - global_ordinals - save_memory_heuristic - save_time_heuristic + - segment_ordinals _common.aggregations:CategorizeTextAggregation: allOf: - $ref: '#/components/schemas/_common.aggregations:Aggregation' @@ -29026,40 +29479,40 @@ components: - type: object properties: sum_of_squares: - oneOf: - - type: number - - nullable: true - type: string + type: + - 'null' + - number + - string variance: - oneOf: - - type: number - - nullable: true - type: string + type: + - 'null' + - number + - string variance_population: - oneOf: - - type: number - - nullable: true - type: string + type: + - 'null' + - number + - string variance_sampling: - oneOf: - - type: number - - nullable: true - type: string + type: + - 'null' + - number + - string std_deviation: - oneOf: - - type: number - - nullable: true - type: string + type: + - 'null' + - number + - string std_deviation_population: - oneOf: - - type: number - - nullable: true - type: string + type: + - 'null' + - number + - string std_deviation_sampling: - oneOf: - - type: number - - nullable: true - type: string + type: + - 'null' + - number + - string std_deviation_bounds: $ref: '#/components/schemas/_common.aggregations:StandardDeviationBounds' sum_of_squares_as_string: @@ -29075,13 +29528,13 @@ components: std_deviation_bounds_as_string: $ref: '#/components/schemas/_common.aggregations:StandardDeviationBoundsAsString' required: + - std_deviation + - std_deviation_population + - std_deviation_sampling - sum_of_squares - variance - variance_population - variance_sampling - - std_deviation - - std_deviation_population - - std_deviation_sampling _common.aggregations:ExtendedStatsAggregation: allOf: - $ref: '#/components/schemas/_common.aggregations:FormatMetricAggregationBase' @@ -29208,9 +29661,9 @@ components: _common.aggregations:GapPolicy: type: string enum: - - skip - insert_zeros - keep_values + - skip _common.aggregations:GeoBoundsAggregate: allOf: - $ref: '#/components/schemas/_common.aggregations:AggregateBase' @@ -29347,9 +29800,9 @@ components: properties: type: object required: - - type - geometry - properties + - type _common.aggregations:GeoLineAggregation: type: object properties: @@ -29696,19 +30149,17 @@ components: properties: from: description: Start of the range. - oneOf: - - type: string - - nullable: true - type: string + type: + - 'null' + - string mask: description: IP range defined as a CIDR mask. type: string to: description: End of the range. - oneOf: - - type: string - - nullable: true - type: string + type: + - 'null' + - string _common.aggregations:IpRangeBucket: allOf: - $ref: '#/components/schemas/_common.aggregations:MultiBucketBase' @@ -29723,11 +30174,10 @@ components: _common.aggregations:KeyedPercentiles: type: object additionalProperties: - oneOf: - - type: string - - type: number - - nullable: true - type: string + type: + - 'null' + - number + - string _common.aggregations:LinearMovingAverageAggregation: allOf: - $ref: '#/components/schemas/_common.aggregations:MovingAverageAggregationBase' @@ -29830,14 +30280,14 @@ components: additionalProperties: type: number required: - - name + - correlation - count + - covariance + - kurtosis - mean - - variance + - name - skewness - - kurtosis - - covariance - - correlation + - variance _common.aggregations:MaxAggregate: allOf: - $ref: '#/components/schemas/_common.aggregations:SingleMetricAggregateBase' @@ -29886,11 +30336,11 @@ components: _common.aggregations:MinimumInterval: type: string enum: - - second - - minute - - hour - day + - hour + - minute - month + - second - year _common.aggregations:Missing: oneOf: @@ -29914,9 +30364,9 @@ components: _common.aggregations:MissingOrder: type: string enum: + - default - first - last - - default _common.aggregations:MovingAverageAggregation: type: object discriminator: @@ -30265,12 +30715,12 @@ components: _common.aggregations:NormalizeMethod: type: string enum: + - mean + - percent_of_sum - rescale_0_1 - rescale_0_100 - - percent_of_sum - - mean - - z-score - softmax + - z-score _common.aggregations:ParentAggregate: allOf: - $ref: '#/components/schemas/_common.aggregations:SingleBucketAggregateBase' @@ -30300,8 +30750,8 @@ components: - type: array items: type: number - - nullable: true - type: string + - type: 'null' + - type: string hdr: $ref: '#/components/schemas/_common.aggregations:HdrMethod' tdigest: @@ -30362,7 +30812,7 @@ components: format: description: |- `DecimalFormat` pattern for the output value. - If specified, the formatted value is returned in the aggregation’s `value_as_string` property. + If specified, the formatted value is returned in the aggregation's `value_as_string` property. type: string gap_policy: $ref: '#/components/schemas/_common.aggregations:GapPolicy' @@ -30492,9 +30942,9 @@ components: _common.aggregations:SamplerAggregationExecutionHint: type: string enum: - - map - - global_ordinals - bytes_hash + - global_ordinals + - map _common.aggregations:ScriptedHeuristic: type: object properties: @@ -30649,8 +31099,8 @@ components: bg_count: type: number required: - - score - bg_count + - score _common.aggregations:SignificantTextAggregation: allOf: - $ref: '#/components/schemas/_common.aggregations:BucketAggregationBase' @@ -30735,10 +31185,10 @@ components: description: |- The metric value. A missing value generally means that there was no data to aggregate, unless specified otherwise. - oneOf: - - type: number - - nullable: true - type: string + type: + - 'null' + - number + - string value_as_string: type: string required: @@ -30747,42 +31197,42 @@ components: type: object properties: upper: - oneOf: - - type: number - - nullable: true - type: string + type: + - 'null' + - number + - string lower: - oneOf: - - type: number - - nullable: true - type: string + type: + - 'null' + - number + - string upper_population: - oneOf: - - type: number - - nullable: true - type: string + type: + - 'null' + - number + - string lower_population: - oneOf: - - type: number - - nullable: true - type: string + type: + - 'null' + - number + - string upper_sampling: - oneOf: - - type: number - - nullable: true - type: string + type: + - 'null' + - number + - string lower_sampling: - oneOf: - - type: number - - nullable: true - type: string + type: + - 'null' + - number + - string required: - - upper - lower - - upper_population - lower_population - - upper_sampling - lower_sampling + - upper + - upper_population + - upper_sampling _common.aggregations:StandardDeviationBoundsAsString: type: object properties: @@ -30799,12 +31249,12 @@ components: lower_sampling: type: string required: - - upper - lower - - upper_population - lower_population - - upper_sampling - lower_sampling + - upper + - upper_population + - upper_sampling _common.aggregations:StatsAggregate: allOf: - $ref: '#/components/schemas/_common.aggregations:AggregateBase' @@ -30813,20 +31263,20 @@ components: count: type: number min: - oneOf: - - type: number - - nullable: true - type: string + type: + - 'null' + - number + - string max: - oneOf: - - type: number - - nullable: true - type: string + type: + - 'null' + - number + - string avg: - oneOf: - - type: number - - nullable: true - type: string + type: + - 'null' + - number + - string sum: type: number min_as_string: @@ -30838,10 +31288,10 @@ components: sum_as_string: type: string required: + - avg - count - - min - max - - avg + - min - sum _common.aggregations:StatsAggregation: allOf: @@ -30876,32 +31326,32 @@ components: count: type: number min_length: - oneOf: - - type: number - - nullable: true - type: string + type: + - 'null' + - number + - string max_length: - oneOf: - - type: number - - nullable: true - type: string + type: + - 'null' + - number + - string avg_length: - oneOf: - - type: number - - nullable: true - type: string + type: + - 'null' + - number + - string entropy: - oneOf: - - type: number - - nullable: true - type: string + type: + - 'null' + - number + - string distribution: oneOf: + - type: 'null' - type: object additionalProperties: type: number - - nullable: true - type: string + - type: string min_length_as_string: type: string max_length_as_string: @@ -30909,11 +31359,11 @@ components: avg_length_as_string: type: string required: - - count - - min_length - - max_length - avg_length + - count - entropy + - max_length + - min_length _common.aggregations:StringStatsAggregation: allOf: - $ref: '#/components/schemas/_common.aggregations:MetricAggregationBase' @@ -31053,15 +31503,15 @@ components: _common.aggregations:TermsAggregationCollectMode: type: string enum: - - depth_first - breadth_first + - depth_first _common.aggregations:TermsAggregationExecutionHint: type: string enum: - - map - global_ordinals - global_ordinals_hash - global_ordinals_low_cardinality + - map _common.aggregations:TermsBucketBase: allOf: - $ref: '#/components/schemas/_common.aggregations:MultiBucketBase' @@ -31158,20 +31608,14 @@ components: sort: type: array items: - oneOf: - - $ref: '#/components/schemas/_common:FieldValue' - - nullable: true - type: string + $ref: '#/components/schemas/_common:FieldValue' metrics: type: object additionalProperties: - oneOf: - - $ref: '#/components/schemas/_common:FieldValue' - - nullable: true - type: string + $ref: '#/components/schemas/_common:FieldValue' required: - - sort - metrics + - sort _common.aggregations:TopMetricsAggregate: allOf: - $ref: '#/components/schemas/_common.aggregations:AggregateBase' @@ -31213,10 +31657,10 @@ components: - type: object properties: value: - oneOf: - - type: number - - nullable: true - type: string + type: + - 'null' + - number + - string value_as_string: type: string required: @@ -31235,9 +31679,9 @@ components: _common.aggregations:TTestType: type: string enum: - - paired - - homoscedastic - heteroscedastic + - homoscedastic + - paired _common.aggregations:UnmappedRareTermsAggregate: allOf: - $ref: '#/components/schemas/_common.aggregations:MultiBucketAggregateBaseVoid' @@ -31265,16 +31709,16 @@ components: _common.aggregations:ValueType: type: string enum: - - string - - long - - double - - number + - boolean - date - date_nanos + - double + - geo_point - ip + - long + - number - numeric - - geo_point - - boolean + - string _common.aggregations:VariableWidthHistogramAggregate: allOf: - $ref: '#/components/schemas/_common.aggregations:MultiBucketAggregateBaseVariableWidthHistogramBucket' @@ -31315,9 +31759,9 @@ components: max_as_string: type: string required: - - min - key - max + - min _common.aggregations:WeightedAverageAggregation: allOf: - $ref: '#/components/schemas/_common.aggregations:Aggregation' @@ -31413,8 +31857,8 @@ components: max_token_length: type: number required: - - type - tokenize_on_chars + - type _common.analysis:CommonGramsTokenFilter: allOf: - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' @@ -31473,9 +31917,9 @@ components: script: $ref: '#/components/schemas/_common:Script' required: - - type - filter - script + - type _common.analysis:CustomAnalyzer: type: object properties: @@ -31498,8 +31942,8 @@ components: tokenizer: type: string required: - - type - tokenizer + - type _common.analysis:CustomNormalizer: type: object properties: @@ -31520,9 +31964,9 @@ components: _common.analysis:DelimitedPayloadEncoding: type: string enum: - - int - float - identity + - int _common.analysis:DelimitedPayloadTokenFilter: allOf: - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' @@ -31563,8 +32007,8 @@ components: _common.analysis:EdgeNGramSide: type: string enum: - - front - back + - front _common.analysis:EdgeNGramTokenFilter: allOf: - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' @@ -31604,10 +32048,10 @@ components: items: $ref: '#/components/schemas/_common.analysis:TokenChar' required: - - type - max_gram - min_gram - token_chars + - type _common.analysis:ElisionTokenFilter: allOf: - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' @@ -31647,10 +32091,10 @@ components: stopwords_path: type: string required: - - type - max_output_size - preserve_original - separator + - type _common.analysis:FingerprintTokenFilter: allOf: - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' @@ -31695,8 +32139,8 @@ components: longest_only: type: boolean required: - - type - locale + - type _common.analysis:HyphenationDecompounderTokenFilter: allOf: - $ref: '#/components/schemas/_common.analysis:CompoundWordTokenFilterBase' @@ -31720,14 +32164,14 @@ components: mode: $ref: '#/components/schemas/_common.analysis:IcuNormalizationMode' required: - - type - method - mode + - type _common.analysis:IcuCollationAlternate: type: string enum: - - shifted - non-ignorable + - shifted _common.analysis:IcuCollationCaseFirst: type: string enum: @@ -31736,16 +32180,16 @@ components: _common.analysis:IcuCollationDecomposition: type: string enum: - - no - identical + - no _common.analysis:IcuCollationStrength: type: string enum: + - identical - primary + - quaternary - secondary - tertiary - - quaternary - - identical _common.analysis:IcuCollationTokenFilter: allOf: - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' @@ -31813,8 +32257,8 @@ components: _common.analysis:IcuNormalizationMode: type: string enum: - - decompose - compose + - decompose _common.analysis:IcuNormalizationTokenFilter: allOf: - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' @@ -31827,8 +32271,8 @@ components: name: $ref: '#/components/schemas/_common.analysis:IcuNormalizationType' required: - - type - name + - type _common.analysis:IcuNormalizationType: type: string enum: @@ -31847,8 +32291,8 @@ components: rule_files: type: string required: - - type - rule_files + - type _common.analysis:IcuTransformDirection: type: string enum: @@ -31868,13 +32312,13 @@ components: id: type: string required: - - type - id + - type _common.analysis:KeepTypesMode: type: string enum: - - include - exclude + - include _common.analysis:KeepTypesTokenFilter: allOf: - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' @@ -31955,8 +32399,8 @@ components: buffer_size: type: number required: - - type - buffer_size + - type _common.analysis:KStemTokenFilter: allOf: - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' @@ -31980,8 +32424,8 @@ components: user_dictionary: type: string required: - - type - mode + - type _common.analysis:KuromojiIterationMarkCharFilter: allOf: - $ref: '#/components/schemas/_common.analysis:CharFilterBase' @@ -31996,9 +32440,9 @@ components: normalize_kanji: type: boolean required: - - type - normalize_kana - normalize_kanji + - type _common.analysis:KuromojiPartOfSpeechTokenFilter: allOf: - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' @@ -32013,8 +32457,8 @@ components: items: type: string required: - - type - stoptags + - type _common.analysis:KuromojiReadingFormTokenFilter: allOf: - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' @@ -32041,14 +32485,14 @@ components: minimum_length: type: number required: - - type - minimum_length + - type _common.analysis:KuromojiTokenizationMode: type: string enum: + - extended - normal - search - - extended _common.analysis:KuromojiTokenizer: allOf: - $ref: '#/components/schemas/_common.analysis:TokenizerBase' @@ -32075,8 +32519,8 @@ components: discard_compound_token: type: boolean required: - - type - mode + - type _common.analysis:Language: type: string enum: @@ -32112,8 +32556,8 @@ components: - Sorani - Spanish - Swedish - - Turkish - Thai + - Turkish _common.analysis:LanguageAnalyzer: type: object properties: @@ -32134,9 +32578,9 @@ components: stopwords_path: type: string required: - - type - language - stem_exclusion + - type _common.analysis:LengthTokenFilter: allOf: - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' @@ -32244,8 +32688,8 @@ components: preserve_original: $ref: '#/components/schemas/_common:Stringifiedboolean' required: - - type - filters + - type _common.analysis:NGramTokenFilter: allOf: - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' @@ -32283,10 +32727,10 @@ components: items: $ref: '#/components/schemas/_common.analysis:TokenChar' required: - - type - max_gram - min_gram - token_chars + - type _common.analysis:NoriAnalyzer: type: object properties: @@ -32310,8 +32754,8 @@ components: type: string enum: - discard - - none - mixed + - none _common.analysis:NoriPartOfSpeechTokenFilter: allOf: - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' @@ -32375,11 +32819,11 @@ components: skip: $ref: '#/components/schemas/_common:Stringifiedinteger' required: - - type - buffer_size - delimiter - reverse - skip + - type _common.analysis:PatternAnalyzer: type: object properties: @@ -32398,8 +32842,8 @@ components: stopwords: $ref: '#/components/schemas/_common.analysis:StopWords' required: - - type - pattern + - type _common.analysis:PatternCaptureTokenFilter: allOf: - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' @@ -32416,8 +32860,8 @@ components: preserve_original: $ref: '#/components/schemas/_common:Stringifiedboolean' required: - - type - patterns + - type _common.analysis:PatternReplaceCharFilter: allOf: - $ref: '#/components/schemas/_common.analysis:CharFilterBase' @@ -32434,8 +32878,8 @@ components: replacement: type: string required: - - type - pattern + - type _common.analysis:PatternReplaceTokenFilter: allOf: - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' @@ -32454,8 +32898,8 @@ components: replacement: type: string required: - - type - pattern + - type _common.analysis:PatternTokenizer: allOf: - $ref: '#/components/schemas/_common.analysis:TokenizerBase' @@ -32476,18 +32920,18 @@ components: _common.analysis:PhoneticEncoder: type: string enum: - - metaphone - - double_metaphone - - soundex - - refined_soundex + - beider_morse - caverphone1 - caverphone2 - cologne - - nysiis - - koelnerphonetik - - haasephonetik - - beider_morse - daitch_mokotoff + - double_metaphone + - haasephonetik + - koelnerphonetik + - metaphone + - nysiis + - refined_soundex + - soundex _common.analysis:PhoneticLanguage: type: string enum: @@ -32506,8 +32950,8 @@ components: _common.analysis:PhoneticNameType: type: string enum: - - generic - ashkenazi + - generic - sephardic _common.analysis:PhoneticRuleType: type: string @@ -32538,11 +32982,11 @@ components: rule_type: $ref: '#/components/schemas/_common.analysis:PhoneticRuleType' required: - - type - encoder - languageset - name_type - rule_type + - type _common.analysis:PorterStemTokenFilter: allOf: - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' @@ -32566,8 +33010,8 @@ components: script: $ref: '#/components/schemas/_common:Script' required: - - type - script + - type _common.analysis:RemoveDuplicatesTokenFilter: allOf: - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' @@ -32642,8 +33086,8 @@ components: stopwords: $ref: '#/components/schemas/_common.analysis:StopWords' required: - - type - language + - type _common.analysis:SnowballLanguage: type: string enum: @@ -32681,8 +33125,8 @@ components: language: $ref: '#/components/schemas/_common.analysis:SnowballLanguage' required: - - type - language + - type _common.analysis:StandardAnalyzer: type: object properties: @@ -32845,12 +33289,12 @@ components: _common.analysis:TokenChar: type: string enum: - - letter + - custom - digit - - whitespace + - letter - punctuation - symbol - - custom + - whitespace _common.analysis:TokenFilter: oneOf: - type: string @@ -33130,9 +33574,9 @@ components: time_series_metric: $ref: '#/components/schemas/_common.mapping:TimeSeriesMetricType' required: - - type - default_metric - metrics + - type _common.mapping:AllField: type: object properties: @@ -33339,9 +33783,9 @@ components: ef_construction: type: number required: - - type - - m - ef_construction + - m + - type _common.mapping:DenseVectorProperty: allOf: - $ref: '#/components/schemas/_common.mapping:PropertyBase' @@ -33360,8 +33804,8 @@ components: index_options: $ref: '#/components/schemas/_common.mapping:DenseVectorIndexOptions' required: - - type - dims + - type _common.mapping:DocValuesPropertyBase: allOf: - $ref: '#/components/schemas/_common.mapping:CorePropertyBase' @@ -33396,10 +33840,10 @@ components: _common.mapping:DynamicMapping: type: string enum: - - strict + - 'false' - runtime + - strict - 'true' - - 'false' _common.mapping:DynamicProperty: allOf: - $ref: '#/components/schemas/_common.mapping:DocValuesPropertyBase' @@ -33562,8 +34006,8 @@ components: _common.mapping:GeoOrientation: type: string enum: - - right - left + - right _common.mapping:GeoPointProperty: allOf: - $ref: '#/components/schemas/_common.mapping:DocValuesPropertyBase' @@ -33645,8 +34089,8 @@ components: enum: - docs - freqs - - positions - offsets + - positions _common.mapping:IntegerNumberProperty: allOf: - $ref: '#/components/schemas/_common.mapping:NumberPropertyBase' @@ -33809,8 +34253,8 @@ components: _common.mapping:MatchType: type: string enum: - - simple - regex + - simple _common.mapping:Murmur3HashProperty: allOf: - $ref: '#/components/schemas/_common.mapping:DocValuesPropertyBase' @@ -33875,8 +34319,8 @@ components: _common.mapping:OnScriptError: type: string enum: - - fail - continue + - fail _common.mapping:PercolatorProperty: allOf: - $ref: '#/components/schemas/_common.mapping:PropertyBase' @@ -34203,12 +34647,12 @@ components: type: string enum: - no - - yes - with_offsets - with_positions - with_positions_offsets - with_positions_offsets_payloads - with_positions_payloads + - yes _common.mapping:TextIndexPrefixes: type: object properties: @@ -34261,11 +34705,11 @@ components: _common.mapping:TimeSeriesMetricType: type: string enum: - - gauge - counter - - summary + - gauge - histogram - position + - summary _common.mapping:TokenCountProperty: allOf: - $ref: '#/components/schemas/_common.mapping:DocValuesPropertyBase' @@ -34421,22 +34865,22 @@ components: positive: $ref: '#/components/schemas/_common.query_dsl:QueryContainer' required: - - negative_boost - negative + - negative_boost - positive _common.query_dsl:ChildScoreMode: type: string enum: - - none - avg - - sum - max - min + - none + - sum _common.query_dsl:CombinedFieldsOperator: type: string enum: - - or - and + - or _common.query_dsl:CombinedFieldsQuery: allOf: - $ref: '#/components/schemas/_common.query_dsl:QueryBase' @@ -34467,8 +34911,8 @@ components: _common.query_dsl:CombinedFieldsZeroTerms: type: string enum: - - none - all + - none _common.query_dsl:CommonTermsQuery: allOf: - $ref: '#/components/schemas/_common.query_dsl:QueryBase' @@ -34521,13 +34965,11 @@ components: from: oneOf: - $ref: '#/components/schemas/_common:DateMath' - - nullable: true - type: string + - type: 'null' to: oneOf: - $ref: '#/components/schemas/_common:DateMath' - - nullable: true - type: string + - type: 'null' format: $ref: '#/components/schemas/_common:DateFormat' time_zone: @@ -34576,9 +35018,9 @@ components: field: $ref: '#/components/schemas/_common:Field' required: + - field - origin - pivot - - field _common.query_dsl:DistanceFeatureQueryBaseGeoLocationDistance: allOf: - $ref: '#/components/schemas/_common.query_dsl:QueryBase' @@ -34591,9 +35033,9 @@ components: field: $ref: '#/components/schemas/_common:Field' required: + - field - origin - pivot - - field _common.query_dsl:ExistsQuery: allOf: - $ref: '#/components/schemas/_common.query_dsl:QueryBase' @@ -34618,16 +35060,16 @@ components: _common.query_dsl:FieldValueFactorModifier: type: string enum: - - none - - log - - log1p - - log2p - ln - ln1p - ln2p - - square - - sqrt + - log + - log1p + - log2p + - none - reciprocal + - sqrt + - square _common.query_dsl:FieldValueFactorScoreFunction: type: object properties: @@ -34638,7 +35080,7 @@ components: type: number missing: description: |- - Value used if the document doesn’t have that field. + Value used if the document doesn't have that field. The modifier and factor are still applied to it as though it were read from the document. type: number modifier: @@ -34648,12 +35090,12 @@ components: _common.query_dsl:FunctionBoostMode: type: string enum: - - multiply - - replace - - sum - avg - max - min + - multiply + - replace + - sum _common.query_dsl:FunctionScoreContainer: allOf: - type: object @@ -34681,12 +35123,12 @@ components: _common.query_dsl:FunctionScoreMode: type: string enum: - - multiply - - sum - avg - first - max - min + - multiply + - sum _common.query_dsl:FunctionScoreQuery: allOf: - $ref: '#/components/schemas/_common.query_dsl:QueryBase' @@ -34768,13 +35210,22 @@ components: $ref: '#/components/schemas/_common:GeoDistanceType' validation_method: $ref: '#/components/schemas/_common.query_dsl:GeoValidationMethod' + ignore_unmapped: + description: |- + Set to `true` to ignore an unmapped field and not match any documents for this query. + Set to `false` to throw an exception if the field is not mapped. + type: boolean + default: false + field: + type: object required: - distance + - field _common.query_dsl:GeoExecution: type: string enum: - - memory - indexed + - memory _common.query_dsl:GeoPolygonQuery: allOf: - $ref: '#/components/schemas/_common.query_dsl:QueryBase' @@ -35315,9 +35766,9 @@ components: _common.query_dsl:MultiValueMode: type: string enum: - - min - - max - avg + - max + - min - sum _common.query_dsl:NestedQuery: allOf: @@ -35356,15 +35807,15 @@ components: description: Less than or equal to. type: number from: - oneOf: - - type: number - - nullable: true - type: string + type: + - 'null' + - number + - string to: - oneOf: - - type: number - - nullable: true - type: string + type: + - 'null' + - number + - string _common.query_dsl:NumericDecayFunction: allOf: - $ref: '#/components/schemas/_common.query_dsl:DecayFunctionBase' @@ -35468,7 +35919,7 @@ components: case_insensitive: description: |- Allows ASCII case insensitive matching of the value with the indexed field values when set to `true`. - Default is `false` which means the case sensitivity of matching depends on the underlying field’s mapping. + Default is `false` which means the case sensitivity of matching depends on the underlying field's mapping. type: boolean required: - value @@ -35544,7 +35995,9 @@ components: The provided text is analyzed before matching. type: object additionalProperties: - $ref: '#/components/schemas/_common.query_dsl:MatchQuery' + anyOf: + - $ref: '#/components/schemas/_common.query_dsl:MatchQuery' + - {} minProperties: 1 maxProperties: 1 match_all: @@ -35796,9 +36249,9 @@ components: _common.query_dsl:RangeRelation: type: string enum: - - within - contains - intersects + - within _common.query_dsl:RankFeatureFunction: type: object _common.query_dsl:RankFeatureFunctionLinear: @@ -35835,8 +36288,8 @@ components: description: Configurable Exponent. type: number required: - - pivot - exponent + - pivot _common.query_dsl:RankFeatureQuery: allOf: - $ref: '#/components/schemas/_common.query_dsl:QueryBase' @@ -35862,7 +36315,7 @@ components: case_insensitive: description: |- Allows case insensitive matching of the regular expression value with the indexed field values when set to `true`. - When `false`, case sensitivity of matching depends on the underlying field’s mapping. + When `false`, case sensitivity of matching depends on the underlying field's mapping. type: boolean flags: description: Enables optional operators for the regular expression. @@ -35889,9 +36342,9 @@ components: match_criteria: type: object required: + - match_criteria - organic - ruleset_id - - match_criteria _common.query_dsl:ScriptQuery: allOf: - $ref: '#/components/schemas/_common.query_dsl:QueryBase' @@ -35934,19 +36387,19 @@ components: _common.query_dsl:SimpleQueryStringFlag: type: string enum: - - NONE + - ALL - AND + - ESCAPE + - FUZZY + - NEAR + - NONE - NOT - OR - - PREFIX - PHRASE - PRECEDENCE - - ESCAPE - - WHITESPACE - - FUZZY - - NEAR + - PREFIX - SLOP - - ALL + - WHITESPACE _common.query_dsl:SimpleQueryStringFlags: description: Query flags can be either a single flag or a combination of flags, e.g. `OR|AND|PREFIX` allOf: @@ -36078,7 +36531,7 @@ components: properties: dist: description: |- - The number of tokens from within the include span that can’t have overlap with the exclude span. + The number of tokens from within the include span that can't have overlap with the exclude span. Equivalent to setting both `pre` and `post`. type: number exclude: @@ -36086,10 +36539,10 @@ components: include: $ref: '#/components/schemas/_common.query_dsl:SpanQuery' post: - description: The number of tokens after the include span that can’t have overlap with the exclude span. + description: The number of tokens after the include span that can't have overlap with the exclude span. type: number pre: - description: The number of tokens before the include span that can’t have overlap with the exclude span. + description: The number of tokens before the include span that can't have overlap with the exclude span. type: number required: - exclude @@ -36167,7 +36620,7 @@ components: case_insensitive: description: |- Allows ASCII case insensitive matching of the value with the indexed field values when set to `true`. - When `false`, the case sensitivity of matching depends on the underlying field’s mapping. + When `false`, the case sensitivity of matching depends on the underlying field's mapping. type: boolean required: - value @@ -36211,11 +36664,11 @@ components: type: string enum: - best_fields - - most_fields + - bool_prefix - cross_fields + - most_fields - phrase - phrase_prefix - - bool_prefix _common.query_dsl:TokenPruningConfig: type: object properties: @@ -36257,7 +36710,7 @@ components: - type: object properties: case_insensitive: - description: Allows case insensitive matching of the pattern with the indexed field values when set to true. Default is false which means the case sensitivity of matching depends on the underlying field’s mapping. + description: Allows case insensitive matching of the pattern with the indexed field values when set to `true`. Default is `false` which means the case sensitivity of matching depends on the underlying field's mapping. type: boolean rewrite: $ref: '#/components/schemas/_common:MultiTermQueryRewrite' @@ -36369,12 +36822,15 @@ components: _core.bulk:ResponseItem: type: object properties: + _type: + description: The document type. + type: string + x-version-removed: '2.0' _id: description: The document ID associated with the operation. - anyOf: - - type: string - - nullable: true - type: string + type: + - 'null' + - string _index: description: |- Name of the index associated with the operation. @@ -36438,7 +36894,7 @@ components: - type: object properties: require_alias: - description: If `true`, the request’s actions must target an index alias. + description: If `true`, the request's actions must target an index alias. type: boolean retry_on_conflict: type: number @@ -36452,7 +36908,7 @@ components: A map from the full name of fields to the name of dynamic templates. Defaults to an empty map. If a name matches a dynamic template, then that template will be applied regardless of other match predicates defined in the template. - If a field is already defined in the mapping, then this parameter won’t be used. + If a field is already defined in the mapping, then this parameter won't be used. type: object additionalProperties: type: string @@ -36463,7 +36919,7 @@ components: If a final pipeline is configured it will always run, regardless of the value of this parameter. type: string require_alias: - description: If `true`, the request’s actions must target an index alias. + description: If `true`, the request's actions must target an index alias. type: boolean _core.explain:Explanation: type: object @@ -36531,7 +36987,7 @@ components: metric_conflicts_indices: description: |- The list of indices where this field is present if these indices - don’t have the same `time_series_metric` value for this field. + don't have the same `time_series_metric` value for this field. type: array items: $ref: '#/components/schemas/_common:IndexName' @@ -36564,8 +37020,8 @@ components: $ref: '#/components/schemas/_core.get_script_context:ContextMethodParam' required: - name - - return_type - params + - return_type _core.get_script_context:ContextMethodParam: type: object properties: @@ -36591,6 +37047,8 @@ components: _core.get:GetResult: type: object properties: + _type: + $ref: '#/components/schemas/_common:Type' _index: $ref: '#/components/schemas/_common:IndexName' fields: @@ -36612,9 +37070,9 @@ components: _version: $ref: '#/components/schemas/_common:VersionNumber' required: + - _id - _index - found - - _id _core.mget:MultiGetError: type: object properties: @@ -36625,9 +37083,9 @@ components: _index: $ref: '#/components/schemas/_common:IndexName' required: - - error - _id - _index + - error _core.mget:Operation: type: object properties: @@ -36850,8 +37308,8 @@ components: items: $ref: '#/components/schemas/_core.msearch:ResponseItem' required: - - took - responses + - took _core.msearch:RequestItem: oneOf: - $ref: '#/components/schemas/_core.msearch:MultisearchHeader' @@ -36927,7 +37385,7 @@ components: _index: $ref: '#/components/schemas/_common:IndexName' rating: - description: The document’s relevance with regard to this search request. + description: The document's relevance with regard to this search request. type: number required: - _id @@ -36952,10 +37410,10 @@ components: hit: $ref: '#/components/schemas/_core.rank_eval:RankEvalHit' rating: - oneOf: - - type: number - - nullable: true - type: string + type: + - 'null' + - number + - string required: - hit _core.rank_eval:RankEvalMetric: @@ -36984,7 +37442,7 @@ components: description: The metric_score in the details section shows the contribution of this query to the global quality metric score type: number unrated_docs: - description: The unrated_docs section contains an _index and _id entry for each document in the search result for this query that didn’t have a ratings value. This can be used to ask the user to supply ratings for these documents + description: The unrated_docs section contains an _index and _id entry for each document in the search result for this query that didn't have a ratings value. This can be used to ask the user to supply ratings for these documents type: array items: $ref: '#/components/schemas/_core.rank_eval:UnratedDocument' @@ -37001,10 +37459,10 @@ components: additionalProperties: type: object required: - - metric_score - - unrated_docs - hits - metric_details + - metric_score + - unrated_docs _core.rank_eval:RankEvalMetricDiscountedCumulativeGain: allOf: - $ref: '#/components/schemas/_core.rank_eval:RankEvalMetricBase' @@ -37175,13 +37633,13 @@ components: - action - cancellable - description + - headers - id - node - running_time_in_nanos - start_time_in_millis - status - type - - headers _core.reindex:Destination: type: object properties: @@ -37246,7 +37704,7 @@ components: type: object properties: document: - description: Document that’s temporarily indexed in-memory and accessible from the script. + description: Document that's temporarily indexed in-memory and accessible from the script. type: object index: $ref: '#/components/schemas/_common:IndexName' @@ -37489,10 +37947,10 @@ components: items: $ref: '#/components/schemas/_core.search:FetchProfile' required: - - type + - breakdown - description - time_in_nanos - - breakdown + - type _core.search:FetchProfileBreakdown: type: object properties: @@ -37589,7 +38047,7 @@ components: description: |- If set to a non-negative value, highlighting stops at this defined maximum limit. The rest of the text is not processed, thus not highlighted and no error is returned - The `max_analyzed_offset` query setting does not override the `index.highlight.max_analyzed_offset` setting, which prevails when it’s set to lower value than the query setting. + The `max_analyzed_offset` query setting does not override the `index.highlight.max_analyzed_offset` setting, which prevails when it's set to lower value than the query setting. type: number no_match_size: description: The amount of text you want to return from the beginning of the field if there are no matching fragments to highlight. @@ -37657,8 +38115,8 @@ components: _core.search:HighlighterType: type: string enum: - - plain - fvh + - plain - unified _core.search:HighlightField: allOf: @@ -37674,15 +38132,17 @@ components: _core.search:Hit: type: object properties: + _type: + $ref: '#/components/schemas/_common:Type' _index: $ref: '#/components/schemas/_common:IndexName' _id: $ref: '#/components/schemas/_common:Id' _score: - oneOf: - - type: number - - nullable: true - type: string + type: + - 'null' + - number + - string _explanation: $ref: '#/components/schemas/_core.explain:Explanation' fields: @@ -37732,8 +38192,8 @@ components: sort: $ref: '#/components/schemas/_common:SortResults' required: - - _index - _id + - _index _core.search:HitsMetadata: type: object properties: @@ -37747,10 +38207,10 @@ components: items: $ref: '#/components/schemas/_core.search:Hit' max_score: - oneOf: - - type: number - - nullable: true - type: string + type: + - 'null' + - number + - string required: - hits _core.search:InnerHits: @@ -37838,8 +38298,8 @@ components: collate_match: type: boolean required: - - text - score + - text _core.search:PointInTimeReference: type: object properties: @@ -37902,20 +38362,20 @@ components: - advance_count - build_scorer - build_scorer_count + - compute_max_score + - compute_max_score_count - create_weight - create_weight_count - match - match_count - - shallow_advance - - shallow_advance_count - next_doc - next_doc_count - score - score_count - - compute_max_score - - compute_max_score_count - set_min_competitive_score - set_min_competitive_score_count + - shallow_advance + - shallow_advance_count _core.search:QueryProfile: type: object properties: @@ -37970,6 +38430,7 @@ components: _shards: $ref: '#/components/schemas/_common:ShardStatistics' phase_took: + x-version-added: '2.12' $ref: '#/components/schemas/_common:PhaseTook' hits: $ref: '#/components/schemas/_core.search:HitsMetadata' @@ -38002,10 +38463,10 @@ components: terminated_early: type: boolean required: - - took - - timed_out - _shards - hits + - timed_out + - took _core.search:ScoreMode: type: string enum: @@ -38054,6 +38515,9 @@ components: description: Defines how to fetch a source. Fetching can be disabled entirely, or the source can be filtered. oneOf: - type: boolean + - type: array + items: + $ref: '#/components/schemas/_common:Field' - $ref: '#/components/schemas/_core.search:SourceFilter' _core.search:SourceConfigParam: description: |- @@ -38120,9 +38584,9 @@ components: collate_match: type: boolean required: - - text - - score - freq + - score + - text _core.search:TotalHits: type: object properties: @@ -38362,55 +38826,48 @@ components: type: string disk.indices: description: |- - Disk space used by the node’s shards. Does not include disk space for the translog or unassigned shards. + Disk space used by the node's shards. Does not include disk space for the translog or unassigned shards. IMPORTANT: This metric double-counts disk space for hard-linked files, such as those created when shrinking, splitting, or cloning an index. anyOf: - $ref: '#/components/schemas/_common:ByteSize' - - nullable: true - type: string + - type: 'null' disk.used: description: |- Total disk space in use. - OpenSearch retrieves this metric from the node’s operating system (OS). - The metric includes disk space for: OpenSearch, including the translog and unassigned shards; the node’s operating system; any other applications or files on the node. + OpenSearch retrieves this metric from the node's operating system (OS). + The metric includes disk space for: OpenSearch, including the translog and unassigned shards; the node's operating system; any other applications or files on the node. Unlike `disk.indices`, this metric does not double-count disk space for hard-linked files. anyOf: - $ref: '#/components/schemas/_common:ByteSize' - - nullable: true - type: string + - type: 'null' disk.avail: description: |- Free disk space available to OpenSearch. - OpenSearch retrieves this metric from the node’s operating system. + OpenSearch retrieves this metric from the node's operating system. Disk-based shard allocation uses this metric to assign shards to nodes based on available disk space. anyOf: - $ref: '#/components/schemas/_common:ByteSize' - - nullable: true - type: string + - type: 'null' disk.total: description: Total disk space for the node, including in-use and available space. anyOf: - $ref: '#/components/schemas/_common:ByteSize' - - nullable: true - type: string + - type: 'null' disk.percent: description: Total percentage of disk space in use. Calculated as `disk.used / disk.total`. anyOf: - $ref: '#/components/schemas/_common:Percentage' - - nullable: true - type: string + - type: 'null' host: description: Network host for the node. Set using the `network.host` setting. anyOf: - $ref: '#/components/schemas/_common:Host' - - nullable: true - type: string + - type: 'null' ip: description: IP address and port for the node. anyOf: - $ref: '#/components/schemas/_common:Ip' - - nullable: true - type: string + - type: 'null' node: description: Name for the node. Set using the `node.name` setting. type: string @@ -38503,6 +38960,13 @@ components: active_shards_percent: description: active number of shards in percent type: string + discovered_cluster_manager: + description: cluster manager is discovered or not + type: string + discovered_master: + x-version-removed: '2.0' + description: cluster manager is discovered or not + type: string cat.indices:IndicesRecord: type: object properties: @@ -38526,16 +38990,14 @@ components: type: string docs.count: description: available docs - anyOf: - - type: string - - nullable: true - type: string + type: + - 'null' + - string docs.deleted: description: deleted docs - anyOf: - - type: string - - nullable: true - type: string + type: + - 'null' + - string creation.date: description: index creation date (millisecond value) type: string @@ -38544,16 +39006,14 @@ components: type: string store.size: description: store size of primaries & replicas - anyOf: - - type: string - - nullable: true - type: string + type: + - 'null' + - string pri.store.size: description: store size of primaries - anyOf: - - type: string - - nullable: true - type: string + type: + - 'null' + - string completion.size: description: size of completion type: string @@ -39476,31 +39936,27 @@ components: type: string docs: description: The number of documents in the shard. - anyOf: - - type: string - - nullable: true - type: string + type: + - 'null' + - string store: description: The disk space used by the shard. - anyOf: - - type: string - - nullable: true - type: string + type: + - 'null' + - string ip: description: The IP address of the node. - anyOf: - - type: string - - nullable: true - type: string + type: + - 'null' + - string id: description: The unique identifier for the node. type: string node: description: The name of node. - anyOf: - - type: string - - nullable: true - type: string + type: + - 'null' + - string sync_id: description: The sync identifier. type: string @@ -39513,11 +39969,11 @@ components: `CLUSTER_RECOVERED`: Unassigned as a result of a full cluster recovery. `DANGLING_INDEX_IMPORTED`: Unassigned as a result of importing a dangling index. `EXISTING_INDEX_RESTORED`: Unassigned as a result of restoring into a closed index. - `FORCED_EMPTY_PRIMARY`: The shard’s allocation was last modified by forcing an empty primary using the cluster reroute API. + `FORCED_EMPTY_PRIMARY`: The shard's allocation was last modified by forcing an empty primary using the cluster reroute API. `INDEX_CLOSED`: Unassigned because the index was closed. `INDEX_CREATED`: Unassigned as a result of an API creation of an index. `INDEX_REOPENED`: Unassigned as a result of opening a closed index. - `MANUAL_ALLOCATION`: The shard’s allocation was last modified by the cluster reroute API. + `MANUAL_ALLOCATION`: The shard's allocation was last modified by the cluster reroute API. `NEW_INDEX_RESTORED`: Unassigned as a result of restoring into a new index. `NODE_LEFT`: Unassigned as a result of the node hosting it leaving the cluster. `NODE_RESTARTING`: Similar to `NODE_LEFT`, except that the node was registered as restarting using the node shutdown API. @@ -39830,8 +40286,7 @@ components: description: The template version. anyOf: - $ref: '#/components/schemas/_common:VersionString' - - nullable: true - type: string + - type: 'null' composed_of: description: The component templates that comprise the index template. type: string @@ -39889,28 +40344,24 @@ components: type: string core: description: The core number of active threads allowed in a scaling thread pool. - anyOf: - - type: string - - nullable: true - type: string + type: + - 'null' + - string max: description: The maximum number of active threads allowed in a scaling thread pool. - anyOf: - - type: string - - nullable: true - type: string + type: + - 'null' + - string size: description: The number of active threads allowed in a fixed thread pool. - anyOf: - - type: string - - nullable: true - type: string + type: + - 'null' + - string keep_alive: description: The thread keep alive time. - anyOf: - - type: string - - nullable: true - type: string + type: + - 'null' + - string cluster._common:ComponentTemplate: type: object properties: @@ -39919,8 +40370,8 @@ components: component_template: $ref: '#/components/schemas/cluster._common:ComponentTemplateNode' required: - - name - component_template + - name cluster._common:ComponentTemplateNode: type: object properties: @@ -39967,10 +40418,10 @@ components: cluster.allocation_explain:AllocationExplainDecision: type: string enum: + - ALWAYS - NO - - YES - THROTTLE - - ALWAYS + - YES cluster.allocation_explain:AllocationStore: type: object properties: @@ -40018,9 +40469,9 @@ components: $ref: '#/components/schemas/cluster.allocation_explain:ReservedSize' required: - nodes - - shard_sizes - - shard_paths - reserved_sizes + - shard_paths + - shard_sizes cluster.allocation_explain:CurrentNode: type: object properties: @@ -40037,22 +40488,22 @@ components: weight_ranking: type: number required: + - attributes - id - name - - attributes - transport_address - weight_ranking cluster.allocation_explain:Decision: type: string enum: - - yes - - no - - worse_balance - - throttled - - awaiting_info - allocation_delayed - - no_valid_shard_copy + - awaiting_info + - no - no_attempt + - no_valid_shard_copy + - throttled + - worse_balance + - yes cluster.allocation_explain:DiskUsage: type: object properties: @@ -40069,11 +40520,11 @@ components: used_disk_percent: type: number required: + - free_bytes + - free_disk_percent - path - total_bytes - used_bytes - - free_bytes - - free_disk_percent - used_disk_percent cluster.allocation_explain:NodeAllocationExplanation: type: object @@ -40116,9 +40567,9 @@ components: most_available: $ref: '#/components/schemas/cluster.allocation_explain:DiskUsage' required: - - node_name - least_available - most_available + - node_name cluster.allocation_explain:ReservedSize: type: object properties: @@ -40135,8 +40586,8 @@ components: required: - node_id - path - - total - shards + - total cluster.allocation_explain:UnassignedInformation: type: object properties: @@ -40160,21 +40611,21 @@ components: cluster.allocation_explain:UnassignedInformationReason: type: string enum: - - INDEX_CREATED + - ALLOCATION_FAILED - CLUSTER_RECOVERED - - INDEX_REOPENED - DANGLING_INDEX_IMPORTED - - NEW_INDEX_RESTORED - EXISTING_INDEX_RESTORED - - REPLICA_ADDED - - ALLOCATION_FAILED - - NODE_LEFT - - REROUTE_CANCELLED - - REINITIALIZED - - REALLOCATED_REPLICA - - PRIMARY_FAILED - FORCED_EMPTY_PRIMARY + - INDEX_CREATED + - INDEX_REOPENED - MANUAL_ALLOCATION + - NEW_INDEX_RESTORED + - NODE_LEFT + - PRIMARY_FAILED + - REALLOCATED_REPLICA + - REINITIALIZED + - REPLICA_ADDED + - REROUTE_CANCELLED cluster.health:HealthResponseBody: type: object properties: @@ -40276,10 +40727,10 @@ components: cluster.health:Level: type: string enum: + - awareness_attributes - cluster - indices - shards - - awareness_attributes cluster.health:ShardHealthStats: type: object properties: @@ -40358,14 +40809,14 @@ components: max_proxy_socket_connections: type: number required: - - mode - connected - initial_connect_timeout - - skip_unavailable + - max_proxy_socket_connections + - mode + - num_proxy_sockets_connected - proxy_address - server_name - - num_proxy_sockets_connected - - max_proxy_socket_connections + - skip_unavailable cluster.remote_info:ClusterRemoteSniffInfo: type: object properties: @@ -40388,13 +40839,13 @@ components: items: type: string required: - - mode - connected + - initial_connect_timeout - max_connections_per_cluster + - mode - num_nodes_connected - - initial_connect_timeout - - skip_unavailable - seeds + - skip_unavailable cluster.reroute:Command: type: object properties: @@ -40421,10 +40872,10 @@ components: description: If a node which has a copy of the data rejoins the cluster later on, that data will be deleted. To ensure that these implications are well-understood, this command requires the flag accept_data_loss to be explicitly set to true type: boolean required: + - accept_data_loss - index - - shard - node - - accept_data_loss + - shard cluster.reroute:CommandAllocateReplicaAction: type: object properties: @@ -40436,8 +40887,8 @@ components: type: string required: - index - - shard - node + - shard cluster.reroute:CommandCancelAction: type: object properties: @@ -40451,8 +40902,8 @@ components: type: boolean required: - index - - shard - node + - shard cluster.reroute:CommandMoveAction: type: object properties: @@ -40467,9 +40918,9 @@ components: description: The node to move the shard to type: string required: + - from_node - index - shard - - from_node - to_node cluster.reroute:RerouteDecision: type: object @@ -40522,15 +40973,15 @@ components: cluster.state:Metric: type: string enum: + - _all - blocks + - cluster_manager_node + - master_node - metadata - nodes - - routing_table - routing_nodes - - master_node - - cluster_manager_node + - routing_table - version - - _all cluster.stats:CharFilterTypes: type: object properties: @@ -40637,11 +41088,11 @@ components: - count - docs - fielddata + - mappings - query_cache - segments - shards - store - - mappings cluster.stats:ClusterIndicesShards: type: object properties: @@ -41027,9 +41478,9 @@ components: description: The number of fields that declare a script. type: number required: - - name - count - index_count + - name cluster.stats:FieldTypesMappings: type: object properties: @@ -41195,7 +41646,7 @@ components: name: $ref: '#/components/schemas/_common:Name' scriptless_count: - description: Number of runtime fields that don’t declare a script. + description: Number of runtime fields that don't declare a script. type: number shadowed_count: description: Number of runtime fields that shadow an indexed field. @@ -41258,9 +41709,9 @@ components: node_ids: $ref: '#/components/schemas/_common:Ids' required: + - creation_date_millis - index_name - index_uuid - - creation_date_millis - node_ids indices._common:Alias: type: object @@ -41323,7 +41774,7 @@ components: description: If `true`, the data stream allows custom routing on write request. type: boolean generation: - description: Current generation for the data stream. This number acts as a cumulative count of the stream’s rollovers, starting at 1. + description: Current generation for the data stream. This number acts as a cumulative count of the stream's rollovers, starting at 1. type: number hidden: description: If `true`, the data stream is hidden. @@ -41337,8 +41788,8 @@ components: type: boolean indices: description: |- - Array of objects containing information about the data stream’s backing indices. - The last item in this array contains information about the stream’s current write index. + Array of objects containing information about the data stream's backing indices. + The last item in this array contains information about the stream's current write index. type: array items: $ref: '#/components/schemas/indices._common:DataStreamIndex' @@ -41350,7 +41801,7 @@ components: description: If `true`, the data stream is created and managed by cross-cluster replication and the local cluster can not write into this data stream or change its mappings. type: boolean status: - $ref: '#/components/schemas/_common:HealthStatus' + $ref: '#/components/schemas/_common:HealthStatusCapitalized' system: description: If `true`, the data stream is created and managed by an OpenSearch stack component and cannot be modified through normal user interaction. type: boolean @@ -41360,9 +41811,6 @@ components: $ref: '#/components/schemas/indices._common:DataStreamTimestampField' required: - generation - - hidden - - next_generation_managed_by - - prefer_ilm - indices - name - status @@ -41385,8 +41833,6 @@ components: required: - index_name - index_uuid - - managed_by - - prefer_ilm indices._common:DataStreamLifecycle: type: object properties: @@ -41443,11 +41889,6 @@ components: $ref: '#/components/schemas/_common:Field' required: - name - indices._common:DataStreamVisibility: - type: object - properties: - hidden: - type: boolean indices._common:DownsampleConfig: type: object properties: @@ -41481,9 +41922,9 @@ components: indices._common:IndexCheckOnStartup: type: string enum: - - 'true' - - 'false' - checksum + - 'false' + - 'true' indices._common:IndexingPressure: type: object properties: @@ -41557,9 +41998,9 @@ components: type: string enum: - all - - primaries - new_primaries - none + - primaries indices._common:IndexRoutingRebalance: type: object properties: @@ -41571,9 +42012,9 @@ components: type: string enum: - all + - none - primaries - replicas - - none indices._common:IndexSegmentSort: type: object properties: @@ -41741,6 +42182,7 @@ components: $ref: '#/components/schemas/indices._common:IndexingPressure' store: $ref: '#/components/schemas/indices._common:Storage' + additionalProperties: {} description: The index settings to be updated indices._common:IndexSettingsAnalysis: type: object @@ -41783,7 +42225,7 @@ components: Set to true to parse the origination date from the index name. This origination date is used to calculate the index age for its phase transitions. The index name must match the pattern ^.*-{date_format}-\\d+, where the date_format is yyyy.MM.dd and the trailing digits are optional. An index that was rolled over would normally match the full format, - for example logs-2016.10.31-000002). If the index name doesn’t match the pattern, index creation fails. + for example logs-2016.10.31-000002). If the index name doesn't match the pattern, index creation fails. type: boolean step: $ref: '#/components/schemas/indices._common:IndexSettingsLifecycleStep' @@ -41855,7 +42297,6 @@ components: $ref: '#/components/schemas/indices._common:IndexTemplateDataStreamConfiguration' required: - index_patterns - - composed_of description: New index template definition to be simulated, if no index template name is specified indices._common:IndexTemplateDataStreamConfiguration: type: object @@ -41866,6 +42307,8 @@ components: allow_custom_routing: description: If true, the data stream supports custom routing. type: boolean + timestamp_field: + $ref: '#/components/schemas/indices._common:DataStreamTimestampField' indices._common:IndexTemplateSummary: type: object properties: @@ -41894,8 +42337,8 @@ components: indices._common:ManagedBy: type: string enum: - - Index Lifecycle Management - Data stream lifecycle + - Index Lifecycle Management - Unmanaged indices._common:MappingLimitSettings: type: object @@ -41937,8 +42380,8 @@ components: properties: limit: description: |- - Setting for the maximum length of a field name. This setting isn’t really something that addresses mappings explosion but - might still be useful if you want to limit the field length. It usually shouldn’t be necessary to set this setting. The + Setting for the maximum length of a field name. This setting isn't really something that addresses mappings explosion but + might still be useful if you want to limit the field length. It usually shouldn't be necessary to set this setting. The default is okay unless a user starts to add a huge number of fields with really long names. Default is `Long.MAX_VALUE` (no limit). type: number indices._common:MappingLimitSettingsNestedFields: @@ -42011,13 +42454,13 @@ components: indices._common:SegmentSortMissing: type: string enum: - - _last - _first + - _last indices._common:SegmentSortMode: type: string enum: - - min - max + - min indices._common:SegmentSortOrder: type: string enum: @@ -42221,9 +42664,9 @@ components: type: string enum: - fs - - niofs - - mmapfs - hybridfs + - mmapfs + - niofs indices._common:TemplateMapping: type: object properties: @@ -42265,8 +42708,8 @@ components: indices._common:TranslogDurability: type: string enum: - - request - async + - request indices._common:TranslogRetention: type: object properties: @@ -42289,8 +42732,8 @@ components: blocked: type: boolean required: - - name - blocked + - name indices.analyze:AnalyzeDetail: type: object properties: @@ -42436,7 +42879,7 @@ components: store_size: $ref: '#/components/schemas/_common:ByteSize' store_size_bytes: - description: Total size, in bytes, of all shards for the data stream’s backing indices. + description: Total size, in bytes, of all shards for the data stream's backing indices. type: number required: - backing_indices @@ -42469,8 +42912,8 @@ components: index_template: $ref: '#/components/schemas/indices._common:IndexTemplate' required: - - name - index_template + - name indices.get_mapping:IndexMappingRecord: type: object properties: @@ -42724,8 +43167,8 @@ components: indices: $ref: '#/components/schemas/_common:Indices' required: - - name - indices + - name indices.resolve_index:ResolveIndexDataStreamsItem: type: object properties: @@ -42736,9 +43179,9 @@ components: backing_indices: $ref: '#/components/schemas/_common:Indices' required: + - backing_indices - name - timestamp_field - - backing_indices indices.resolve_index:ResolveIndexItem: type: object properties: @@ -42755,8 +43198,8 @@ components: data_stream: $ref: '#/components/schemas/_common:DataStreamName' required: - - name - attributes + - name indices.rollover:RolloverConditions: type: object properties: @@ -42832,9 +43275,9 @@ components: - compound - deleted_docs - generation + - num_docs - search - size_in_bytes - - num_docs - version indices.segments:ShardSegmentRouting: type: object @@ -42864,8 +43307,8 @@ components: $ref: '#/components/schemas/indices.segments:Segment' required: - num_committed_segments - - routing - num_search_segments + - routing - segments indices.shard_stores:IndicesShardStores: type: object @@ -42906,10 +43349,10 @@ components: indices.shard_stores:ShardStoreStatus: type: string enum: + - all - green - - yellow - red - - all + - yellow indices.shard_stores:ShardStoreWrapper: type: object properties: @@ -42929,8 +43372,8 @@ components: items: type: string required: - - name - index_patterns + - name indices.simulate_template:Template: type: object properties: @@ -42949,8 +43392,8 @@ components: indices.stats:IndexMetadataState: type: string enum: - - open - close + - open indices.stats:IndexStats: type: object properties: @@ -43073,8 +43516,8 @@ components: required: - id - retaining_seq_no - - timestamp - source + - timestamp indices.stats:ShardPath: type: object properties: @@ -43125,9 +43568,9 @@ components: items: $ref: '#/components/schemas/indices.stats:ShardLease' required: + - leases - primary_term - version - - leases indices.stats:ShardRouting: type: object properties: @@ -43136,10 +43579,9 @@ components: primary: type: boolean relocating_node: - oneOf: - - type: string - - nullable: true - type: string + type: + - 'null' + - string state: $ref: '#/components/schemas/indices.stats:ShardRoutingState' required: @@ -43149,10 +43591,10 @@ components: indices.stats:ShardRoutingState: type: string enum: - - UNASSIGNED - INITIALIZING - - STARTED - RELOCATING + - STARTED + - UNASSIGNED indices.stats:ShardSequenceNumber: type: object properties: @@ -43392,7 +43834,7 @@ components: - type: object properties: error_distance: - description: The difference between the resulting inscribed distance from center to side and the circle’s radius (measured in meters for `geo_shape`, unit-less for `shape`). + description: The difference between the resulting inscribed distance from center to side and the circle's radius (measured in meters for `geo_shape`, unit-less for `shape`). type: number field: $ref: '#/components/schemas/_common:Field' @@ -43427,13 +43869,13 @@ components: ingest._common:ConvertType: type: string enum: + - auto + - boolean + - double + - float - integer - long - - float - - double - string - - boolean - - auto ingest._common:CsvProcessor: allOf: - $ref: '#/components/schemas/ingest._common:ProcessorBase' @@ -43680,7 +44122,7 @@ components: items: type: string trace_match: - description: When `true`, `_ingest._grok_match_index` will be inserted into your matched document’s metadata with the index into the pattern found in `patterns` that matched. + description: When `true`, `_ingest._grok_match_index` will be inserted into your matched document's metadata with the index into the pattern found in `patterns` that matched. type: boolean required: - field @@ -43803,8 +44245,8 @@ components: ingest._common:JsonProcessorConflictStrategy: type: string enum: - - replace - merge + - replace ingest._common:KeyValueProcessor: allOf: - $ref: '#/components/schemas/ingest._common:ProcessorBase' @@ -44125,8 +44567,8 @@ components: type: string description: A brief description of the processor. required: - - model_id - field_map + - model_id ingest._common:TrimProcessor: allOf: - $ref: '#/components/schemas/ingest._common:ProcessorBase' @@ -44193,16 +44635,16 @@ components: ingest._common:UserAgentProperty: type: string enum: - - NAME + - BUILD + - DEVICE - MAJOR - MINOR - - PATCH + - NAME - OS - - OS_NAME - OS_MAJOR - OS_MINOR - - DEVICE - - BUILD + - OS_NAME + - PATCH ingest.simulate:Document: type: object properties: @@ -44275,15 +44717,15 @@ components: type: string description: Search operation type. enum: - - query_then_fetch - dfs_query_then_fetch + - query_then_fetch knn._common:SuggestMode: type: string description: Specify suggest mode. enum: + - always - missing - popular - - always ml._common:HitsTotal: type: object properties: @@ -44294,8 +44736,8 @@ components: type: string description: The relation. required: - - value - relation + - value ml._common:SearchModelHits: type: object properties: @@ -44306,8 +44748,8 @@ components: items: $ref: '#/components/schemas/ml._common:SearchModelHitsHit' required: - - total - hits + - total ml._common:SearchModelHitsHit: type: object properties: @@ -44435,7 +44877,7 @@ components: description: Remote address for the HTTP connection. type: string last_uri: - description: The URI of the client’s most recent request. + description: The URI of the client's most recent request. type: string opened_time_millis: description: Time at which the client opened the connection. @@ -44454,7 +44896,7 @@ components: type: number x_opaque_id: description: |- - Value from the client’s `x-opaque-id` HTTP header. + Value from the client's `x-opaque-id` HTTP header. If unavailable, this property is not included in the response. type: string nodes._common:ClusterAppliedStats: @@ -44464,6 +44906,15 @@ components: type: array items: $ref: '#/components/schemas/nodes._common:Recording' + nodes._common:ClusterStateOverallStats: + type: object + properties: + update_count: + type: number + total_time_in_millis: + $ref: '#/components/schemas/_common:DurationValueUnitMillis' + failed_count: + type: number nodes._common:ClusterStateQueue: type: object properties: @@ -44476,6 +44927,11 @@ components: committed: description: Number of committed cluster states in queue. type: number + nodes._common:ClusterStateStats: + type: object + properties: + overall: + $ref: '#/components/schemas/nodes._common:ClusterStateOverallStats' nodes._common:ClusterStateUpdate: type: object properties: @@ -44561,6 +45017,10 @@ components: available_in_bytes: description: Total number of bytes available to this Java virtual machine on this file store. type: number + cache_reserved_in_bytes: + x-version-added: '2.7' + description: Total number of cache bytes reserved available to this Java virtual machine on this file store. + type: number disk_queue: type: string disk_reads: @@ -44601,6 +45061,8 @@ components: properties: cluster_state_queue: $ref: '#/components/schemas/nodes._common:ClusterStateQueue' + cluster_state_stats: + $ref: '#/components/schemas/nodes._common:ClusterStateStats' published_cluster_states: $ref: '#/components/schemas/nodes._common:PublishedClusterStates' cluster_state_update: @@ -44671,6 +45133,10 @@ components: total_in_bytes: description: Total size of all file stores in bytes. type: number + cache_reserved_in_bytes: + x-version-added: '2.7' + description: Total size of cache bytes reserved in all file stores. + type: number nodes._common:GarbageCollector: type: object properties: @@ -44871,6 +45337,15 @@ components: $ref: '#/components/schemas/nodes._common:Processor' type: type: string + nodes._common:LastGcStats: + type: object + properties: + used_in_bytes: + type: number + max_in_bytes: + type: number + usage_percent: + type: number nodes._common:MemoryStats: type: object properties: @@ -44964,6 +45439,9 @@ components: peak_max_in_bytes: description: Largest amount of memory, in bytes, historically used by the heap. type: number + last_gc_stats: + description: Most recent GC cycle stats for a particular memory pool. + $ref: '#/components/schemas/nodes._common:LastGcStats' nodes._common:PressureMemory: type: object properties: @@ -45062,9 +45540,9 @@ components: type: string description: The type to sample. enum: + - block - cpu - wait - - block nodes._common:ScriptCache: type: object properties: @@ -45120,6 +45598,191 @@ components: type: string compressed_size_in_bytes: type: number + nodes._common:ShardAdmissionControlStats: + type: object + properties: + global_io_usage: + $ref: '#/components/schemas/nodes._common:UsageStats' + global_cpu_usage: + $ref: '#/components/schemas/nodes._common:UsageStats' + nodes._common:ShardCachesStats: + type: object + additionalProperties: + $ref: '#/components/schemas/nodes._common:ShardCacheStats' + nodes._common:ShardCacheStats: + type: object + properties: + size_in_bytes: + type: number + evictions: + type: number + hit_count: + type: number + miss_count: + type: number + item_count: + type: number + store_name: + type: string + nodes._common:ShardClusterManagerThrottlingStats: + type: object + properties: + stats: + $ref: '#/components/schemas/nodes._common:ShardClusterManagerThrottlingStatsDetail' + nodes._common:ShardClusterManagerThrottlingStatsDetail: + type: object + properties: + total_throttled_tasks: + type: number + throttled_tasks_per_task_type: + type: object + nodes._common:ShardIndexingPressureStats: + type: object + properties: + stats: + type: object + enabled: + type: boolean + enforced: + type: boolean + total_rejections_breakup_shadow_mode: + $ref: '#/components/schemas/nodes._common:TotalRejectionsBreakupShadowMode' + nodes._common:ShardRepositoriesStats: + type: array + nodes._common:ShardResourceUsageStats: + type: object + additionalProperties: + $ref: '#/components/schemas/nodes._common:ShardResourceUsageStatsDetail' + nodes._common:ShardResourceUsageStatsDetail: + type: object + properties: + timestamp: + type: number + cpu_utilization_percent: + $ref: '#/components/schemas/_common:Percentage' + memory_utilization_percent: + $ref: '#/components/schemas/_common:Percentage' + io_usage_stats: + $ref: '#/components/schemas/nodes._common:ShardResourceUsageStatsIoUsageStats' + nodes._common:ShardResourceUsageStatsIoUsageStats: + type: object + properties: + max_io_utilization_percent: + $ref: '#/components/schemas/_common:Percentage' + nodes._common:ShardSearchBackpressureMode: + type: string + enum: + - disabled + - enforced + - monitor_only + nodes._common:ShardSearchBackpressureStats: + type: object + properties: + search_task: + $ref: '#/components/schemas/nodes._common:ShardSearchBackpressureTaskStats' + search_shard_task: + $ref: '#/components/schemas/nodes._common:ShardSearchBackpressureTaskStats' + mode: + $ref: '#/components/schemas/nodes._common:ShardSearchBackpressureMode' + nodes._common:ShardSearchBackpressureTaskCancellationStats: + type: object + properties: + cancellation_count: + type: number + cancellation_limit_reached_count: + type: number + nodes._common:ShardSearchBackpressureTaskResourceTrackerCpuUsageTrackerStats: + type: object + properties: + cancellation_count: + type: number + current_max_millis: + $ref: '#/components/schemas/_common:DurationValueUnitMillis' + current_avg_millis: + $ref: '#/components/schemas/_common:DurationValueUnitMillis' + nodes._common:ShardSearchBackpressureTaskResourceTrackerElapsedTimeTrackerStats: + type: object + properties: + cancellation_count: + type: number + current_max_millis: + $ref: '#/components/schemas/_common:DurationValueUnitMillis' + current_avg_millis: + $ref: '#/components/schemas/_common:DurationValueUnitMillis' + nodes._common:ShardSearchBackpressureTaskResourceTrackerHeapUsageTrackerStats: + type: object + properties: + cancellation_count: + type: number + current_max_bytes: + type: number + current_avg_bytes: + type: number + rolling_avg_bytes: + type: number + nodes._common:ShardSearchBackpressureTaskResourceTrackerStats: + type: object + properties: + heap_usage_tracker: + $ref: '#/components/schemas/nodes._common:ShardSearchBackpressureTaskResourceTrackerHeapUsageTrackerStats' + elapsed_time_tracker: + $ref: '#/components/schemas/nodes._common:ShardSearchBackpressureTaskResourceTrackerElapsedTimeTrackerStats' + cpu_usage_tracker: + $ref: '#/components/schemas/nodes._common:ShardSearchBackpressureTaskResourceTrackerCpuUsageTrackerStats' + nodes._common:ShardSearchBackpressureTaskStats: + type: object + properties: + resource_tracker_stats: + $ref: '#/components/schemas/nodes._common:ShardSearchBackpressureTaskResourceTrackerStats' + cancellation_stats: + $ref: '#/components/schemas/nodes._common:ShardSearchBackpressureTaskCancellationStats' + nodes._common:ShardSearchPipelineStats: + type: object + properties: + total_request: + $ref: '#/components/schemas/nodes._common:ShardSearchPipelineTotalStats' + total_response: + $ref: '#/components/schemas/nodes._common:ShardSearchPipelineTotalStats' + pipelines: + type: object + nodes._common:ShardSearchPipelineTotalStats: + type: object + properties: + count: + type: number + time_in_millis: + $ref: '#/components/schemas/_common:DurationValueUnitMillis' + current: + type: number + failed: + type: number + nodes._common:ShardSegmentReplicationBackpressureStats: + type: object + properties: + total_rejected_requests: + type: number + nodes._common:ShardTaskCancellationStats: + type: object + properties: + search_shard_task: + $ref: '#/components/schemas/nodes._common:ShardTaskCancellationStatsDetail' + nodes._common:ShardTaskCancellationStatsDetail: + type: object + properties: + current_count_post_cancel: + type: number + total_count_post_cancel: + type: number + nodes._common:ShardWeightedRoutingStats: + type: object + properties: + stats: + $ref: '#/components/schemas/nodes._common:ShardWeightedRoutingStatsDetail' + nodes._common:ShardWeightedRoutingStatsDetail: + type: object + properties: + fail_open_count: + type: number nodes._common:Stats: type: object properties: @@ -45190,6 +45853,28 @@ components: $ref: '#/components/schemas/nodes._common:IndexingPressure' indices: $ref: '#/components/schemas/indices.stats:ShardStats' + shard_indexing_pressure: + $ref: '#/components/schemas/nodes._common:ShardIndexingPressureStats' + search_backpressure: + $ref: '#/components/schemas/nodes._common:ShardSearchBackpressureStats' + cluster_manager_throttling: + $ref: '#/components/schemas/nodes._common:ShardClusterManagerThrottlingStats' + weighted_routing: + $ref: '#/components/schemas/nodes._common:ShardWeightedRoutingStats' + task_cancellation: + $ref: '#/components/schemas/nodes._common:ShardTaskCancellationStats' + resource_usage_stats: + $ref: '#/components/schemas/nodes._common:ShardResourceUsageStats' + search_pipeline: + $ref: '#/components/schemas/nodes._common:ShardSearchPipelineStats' + segment_replication_backpressure: + $ref: '#/components/schemas/nodes._common:ShardSegmentReplicationBackpressureStats' + repositories: + $ref: '#/components/schemas/nodes._common:ShardRepositoriesStats' + admission_control: + $ref: '#/components/schemas/nodes._common:ShardAdmissionControlStats' + caches: + $ref: '#/components/schemas/nodes._common:ShardCachesStats' nodes._common:ThreadCount: type: object properties: @@ -45211,6 +45896,20 @@ components: threads: description: Number of threads in the thread pool. type: number + total_wait_time_in_nanos: + description: | + The total amount of time that tasks spend waiting in the thread pool queue. + Currently, only `search`, `search_throttled`, and `index_searcher` thread pools support this metric. + type: number + nodes._common:TotalRejectionsBreakupShadowMode: + type: object + properties: + node_limits: + type: number + no_successful_request_limits: + type: number + throughput_degradation_limits: + type: number nodes._common:Transport: type: object properties: @@ -45265,6 +45964,16 @@ components: ge_millis: description: The inclusive lower bound of the bucket in milliseconds. May be omitted on the first bucket if this bucket has no lower bound. type: number + nodes._common:TransportUsageStats: + type: object + properties: + rejection_count: + type: object + nodes._common:UsageStats: + type: object + properties: + transport: + $ref: '#/components/schemas/nodes._common:TransportUsageStats' nodes.info:DeprecationIndexing: type: object properties: @@ -45277,19 +45986,19 @@ components: nodes.info:Metric: type: string enum: - - settings + - _all + - aggregations + - http + - indices + - ingest + - jvm - os + - plugins - process - - jvm + - search_pipelines + - settings - thread_pool - transport - - http - - plugins - - ingest - - aggregations - - indices - - search_pipelines - - _all nodes.info:NodeInfo: type: object properties: @@ -45353,9 +46062,10 @@ components: type: object additionalProperties: $ref: '#/components/schemas/nodes.info:NodeInfoAggregation' + search_pipelines: + $ref: '#/components/schemas/nodes.info:NodeInfoSearchPipelines' required: - attributes - - build_flavor - build_hash - build_type - host @@ -45394,13 +46104,13 @@ components: type: string required: - type - nodes.info:NodeInfoDiscover: + nodes.info:NodeInfoDiscovery: type: object properties: + type: + type: string seed_hosts: type: string - required: - - seed_hosts nodes.info:NodeInfoHttp: type: object properties: @@ -45554,9 +46264,8 @@ components: items: type: string required: - - logs - home - - repo + - logs nodes.info:NodeInfoRepositories: type: object properties: @@ -45588,6 +46297,20 @@ components: $ref: '#/components/schemas/nodes.info:NodeInfoSearchRemote' required: - remote + nodes.info:NodeInfoSearchPipelines: + type: object + properties: + response_processors: + type: array + items: + $ref: '#/components/schemas/nodes.info:NodeInfoIngestProcessor' + request_processors: + type: array + items: + $ref: '#/components/schemas/nodes.info:NodeInfoIngestProcessor' + required: + - request_processors + - response_processors nodes.info:NodeInfoSearchRemote: type: object properties: @@ -45607,7 +46330,7 @@ components: repositories: $ref: '#/components/schemas/nodes.info:NodeInfoRepositories' discovery: - $ref: '#/components/schemas/nodes.info:NodeInfoDiscover' + $ref: '#/components/schemas/nodes.info:NodeInfoDiscovery' action: $ref: '#/components/schemas/nodes.info:NodeInfoAction' client: @@ -45626,12 +46349,16 @@ components: $ref: '#/components/schemas/nodes.info:NodeInfoSearch' ingest: $ref: '#/components/schemas/nodes.info:NodeInfoSettingsIngest' + index: + $ref: '#/components/schemas/nodes.info:NodeInfoSettingsIndex' + plugins: + $ref: '#/components/schemas/nodes.info:NodeInfoSettingsPlugins' required: + - client - cluster + - http - node - path - - client - - http - transport nodes.info:NodeInfoSettingsCluster: type: object @@ -45642,13 +46369,14 @@ components: $ref: '#/components/schemas/indices._common:IndexRouting' election: $ref: '#/components/schemas/nodes.info:NodeInfoSettingsClusterElection' + initial_cluster_manager_nodes: + type: string initial_master_nodes: type: string deprecation_indexing: $ref: '#/components/schemas/nodes.info:DeprecationIndexing' required: - name - - election nodes.info:NodeInfoSettingsClusterElection: type: object properties: @@ -45660,7 +46388,7 @@ components: type: object properties: type: - $ref: '#/components/schemas/nodes.info:NodeInfoSettingsHttpType' + type: string type.default: type: string compression: @@ -45673,13 +46401,28 @@ components: - type: string required: - type - nodes.info:NodeInfoSettingsHttpType: + nodes.info:NodeInfoSettingsIndex: type: object properties: - default: - type: string - required: - - default + store: + $ref: '#/components/schemas/nodes.info:NodeInfoSettingsIndexStore' + nodes.info:NodeInfoSettingsIndexHybrid: + type: object + properties: + mmap: + $ref: '#/components/schemas/nodes.info:NodeInfoSettingsIndexStoreMmap' + nodes.info:NodeInfoSettingsIndexStore: + type: object + properties: + hybrid: + $ref: '#/components/schemas/nodes.info:NodeInfoSettingsIndexHybrid' + nodes.info:NodeInfoSettingsIndexStoreMmap: + type: object + properties: + extensions: + type: array + items: + type: string nodes.info:NodeInfoSettingsIngest: type: object properties: @@ -45764,30 +46507,32 @@ components: name: $ref: '#/components/schemas/_common:Name' attr: - type: object - additionalProperties: - type: object + $ref: '#/components/schemas/nodes.info:NodeInfoShardIndexingPressureEnabled' max_local_storage_nodes: type: string required: - - name - attr + - name + nodes.info:NodeInfoSettingsPlugins: + type: object + additionalProperties: + $ref: '#/components/schemas/_common:FieldValue' nodes.info:NodeInfoSettingsTransport: type: object properties: type: - $ref: '#/components/schemas/nodes.info:NodeInfoSettingsTransportType' + type: string type.default: type: string required: - type - nodes.info:NodeInfoSettingsTransportType: + nodes.info:NodeInfoShardIndexingPressureEnabled: type: object properties: - default: + shard_indexing_pressure_enabled: type: string required: - - default + - shard_indexing_pressure_enabled nodes.info:NodeInfoTransport: type: object properties: @@ -45803,8 +46548,8 @@ components: type: string required: - bound_address - - publish_address - profiles + - publish_address nodes.info:NodeJvmInfo: type: object properties: @@ -45830,6 +46575,8 @@ components: type: string vm_version: $ref: '#/components/schemas/_common:VersionString' + bundled_jdk: + type: boolean using_bundled_jdk: type: boolean using_compressed_ordinary_object_pointers: @@ -45841,7 +46588,9 @@ components: items: type: string required: + - bundled_jdk - gc_collectors + - input_arguments - mem - memory_pools - pid @@ -45850,8 +46599,6 @@ components: - vm_name - vm_vendor - vm_version - - using_bundled_jdk - - input_arguments nodes.info:NodeOperatingSystemInfo: type: object properties: @@ -45949,40 +46696,55 @@ components: nodes.stats:IndexMetric: type: string enum: - - store - - indexing + - _all + - completion + - docs + - fielddata + - flush - get - - search + - indexing - merge - - flush - - refresh - query_cache - - fielddata - - docs - - warmer - - completion + - recovery + - refresh + - request_cache + - search - segments - - translog + - store - suggest - - request_cache - - recovery - - _all + - translog + - warmer nodes.stats:Metric: type: string enum: + - _all + - adaptive_selection + - admission_control - breaker + - caches + - cluster_manager_throttling + - discovery + - file_cache - fs - http + - indexing_pressure - indices + - ingest - jvm - os - process + - repositories + - resource_usage_stats + - script + - script_cache + - search_backpressure + - search_pipeline + - segment_replication_backpressure + - shard_indexing_pressure + - task_cancellation - thread_pool - transport - - discovery - - indexing_pressure - - search_pipeline - - _all + - weighted_routing nodes.stats:ResponseBase: allOf: - $ref: '#/components/schemas/nodes._common:NodesResponseBase' @@ -45999,8 +46761,8 @@ components: nodes.usage:Metric: type: string enum: - - rest_actions - _all + - rest_actions nodes.usage:NodeUsage: type: object properties: @@ -46017,10 +46779,10 @@ components: additionalProperties: type: object required: + - aggregations - rest_actions - since - timestamp - - aggregations nodes.usage:ResponseBase: allOf: - $ref: '#/components/schemas/nodes._common:NodesResponseBase' @@ -46072,9 +46834,9 @@ components: notifications._common:EmailEncryptionMethod: type: string enum: + - none - ssl - start_tls - - none notifications._common:EmailGroup: type: object properties: @@ -46147,9 +46909,9 @@ components: notifications._common:HttpMethodType: type: string enum: + - PATCH - POST - PUT - - PATCH notifications._common:MicrosoftTeamsItem: type: object properties: @@ -46174,15 +46936,15 @@ components: type: string description: Type of notification configuration. enum: - - slack - chime - - microsoft_teams - - webhook - email - - sns + - email_group + - microsoft_teams - ses_account + - slack - smtp_account - - email_group + - sns + - webhook notifications._common:NotificationsConfig: type: object properties: @@ -46249,23 +47011,23 @@ components: notifications._common:RestStatus: type: string enum: + - accepted - continue - - switching_protocols - - ok - created - - accepted - - non_authoritative_information - - no_content - - reset_content - - partial_content + - found + - moved_permanently - multi_status - multiple_choices - - moved_permanently - - found - - see_other + - no_content + - non_authoritative_information - not_modified - - use_proxy + - ok + - partial_content + - reset_content + - see_other + - switching_protocols - temporary_redirect + - use_proxy notifications._common:SesAccount: type: object properties: @@ -46281,9 +47043,9 @@ components: notifications._common:SeverityType: type: string enum: + - critical - high - info - - critical notifications._common:SlackItem: type: object properties: @@ -46660,8 +47422,8 @@ components: search_pipeline._common:ScoreNormalizationTechnique: type: string enum: - - min_max - l2 + - min_max search_pipeline._common:SearchPipelineMap: type: object additionalProperties: @@ -47440,9 +48202,9 @@ components: max_segments_per_shard: type: number required: + - max_segments_per_shard - shard_count - size_in_bytes - - max_segments_per_shard snapshot._common:InfoFeatureState: type: object properties: @@ -47463,8 +48225,8 @@ components: settings: $ref: '#/components/schemas/snapshot._common:RepositorySettings' required: - - type - settings + - type snapshot._common:RepositorySettings: type: object properties: @@ -47531,9 +48293,9 @@ components: $ref: '#/components/schemas/_common:DurationValueUnitMillis' required: - incremental - - total - start_time_in_millis - time_in_millis + - total snapshot._common:ShardsStatsSummaryItem: type: object properties: @@ -47732,8 +48494,8 @@ components: $ref: '#/components/schemas/_common:ShardStatistics' required: - indices - - snapshot - shards + - snapshot snapshot.verify_repository:CompactNodeInfo: type: object properties: @@ -47745,8 +48507,8 @@ components: type: string enum: - nodes - - parents - none + - parents tasks._common:NodeTasks: type: object properties: diff --git a/java-codegen/src/main/java/org/opensearch/client/codegen/model/SpecTransformer.java b/java-codegen/src/main/java/org/opensearch/client/codegen/model/SpecTransformer.java index 6848dc7b9c..09f24a35e0 100644 --- a/java-codegen/src/main/java/org/opensearch/client/codegen/model/SpecTransformer.java +++ b/java-codegen/src/main/java/org/opensearch/client/codegen/model/SpecTransformer.java @@ -332,13 +332,13 @@ private Type mapTypeInner(OpenApiSchema schema) { return mapAllOf(allOf.get()); } - var type = schema.getType(); + var types = schema.getTypes().orElse(null); - if (type.isEmpty()) { + if (types == null || types.size() != 1) { return Types.Client.Json.JsonData; } - switch (type.get()) { + switch (types.iterator().next()) { case Object: return mapObject(schema); case Array: @@ -354,7 +354,7 @@ private Type mapTypeInner(OpenApiSchema schema) { return mapNumber(schema); } - throw new UnsupportedOperationException("Can not get type name for: " + type); + throw new UnsupportedOperationException("Can not get type name for: " + types); } private Type mapOneOf(List oneOf) { @@ -434,6 +434,6 @@ private static boolean isOneOfSingleAndArray(List oneOf) { } var first = oneOf.get(0); var items = second.getItems().orElseThrow(); - return first.getType().equals(items.getType()) && first.get$ref().equals(items.get$ref()); + return first.getTypes().equals(items.getTypes()) && first.get$ref().equals(items.get$ref()); } } diff --git a/java-codegen/src/main/java/org/opensearch/client/codegen/openapi/OpenApiSchema.java b/java-codegen/src/main/java/org/opensearch/client/codegen/openapi/OpenApiSchema.java index 3ad80242cf..ea9ab3a957 100644 --- a/java-codegen/src/main/java/org/opensearch/client/codegen/openapi/OpenApiSchema.java +++ b/java-codegen/src/main/java/org/opensearch/client/codegen/openapi/OpenApiSchema.java @@ -37,7 +37,7 @@ public class OpenApiSchema extends OpenApiRefElement { @Nullable private final String description; @Nullable - private final OpenApiSchemaType type; + private final Set types; @Nullable private final OpenApiSchemaFormat format; @Nullable @@ -79,16 +79,11 @@ protected OpenApiSchema(@Nullable OpenApiElement parent, @Nonnull JsonPointer description = schema.getDescription(); - type = Optional.ofNullable(schema.getTypes()).flatMap(types -> { - switch (types.size()) { - case 0: - return Optional.empty(); - case 1: - return Optional.of(types.iterator().next()); - default: - throw new IllegalArgumentException("Multiple types not yet supported: " + types); - } - }).or(() -> Optional.ofNullable(schema.getType())).map(OpenApiSchemaType::from).orElse(null); + types = Optional.ofNullable(schema.getTypes()) + .flatMap(types -> !types.isEmpty() ? Optional.of(types) : Optional.empty()) + .or(() -> Optional.ofNullable(schema.getType()).map(Set::of)) + .map(types -> types.stream().map(OpenApiSchemaType::from).collect(Collectors.toSet())) + .orElse(null); format = ifNonnull(schema.getFormat(), OpenApiSchemaFormat::from); @@ -125,8 +120,8 @@ public Optional getDescription() { } @Nonnull - public Optional getType() { - return Optional.ofNullable(type); + public Optional> getTypes() { + return Sets.unmodifiableOpt(types); } @Nonnull @@ -136,7 +131,7 @@ public Optional getFormat() { public boolean is(@Nonnull OpenApiSchemaType type) { Objects.requireNonNull(type, "type must not be null"); - return getType().map(type::equals).orElse(false); + return types != null && types.contains(type); } public boolean isArray() { @@ -218,8 +213,8 @@ public Optional getPattern() { @Nonnull public Set determineTypes() { - if (type != null) { - return Set.of(type); + if (types != null) { + return Set.copyOf(types); } else if (has$ref()) { return resolve().determineTypes(); } else if (allOf != null) { diff --git a/java-codegen/src/main/java/org/opensearch/client/codegen/openapi/OpenApiSchemaType.java b/java-codegen/src/main/java/org/opensearch/client/codegen/openapi/OpenApiSchemaType.java index 82cd66f058..5318ab74d5 100644 --- a/java-codegen/src/main/java/org/opensearch/client/codegen/openapi/OpenApiSchemaType.java +++ b/java-codegen/src/main/java/org/opensearch/client/codegen/openapi/OpenApiSchemaType.java @@ -17,6 +17,7 @@ public enum OpenApiSchemaType { Array, Boolean, Integer, + Null, Number, Object, String;