diff --git a/src/test_workflow/smoke_test/smoke_test_runner_opensearch.py b/src/test_workflow/smoke_test/smoke_test_runner_opensearch.py index e4bed6a469..e53abbea9c 100644 --- a/src/test_workflow/smoke_test/smoke_test_runner_opensearch.py +++ b/src/test_workflow/smoke_test/smoke_test_runner_opensearch.py @@ -28,13 +28,30 @@ def __init__(self, args: TestArgs, test_manifest: TestManifest) -> None: super().__init__(args, test_manifest) logging.info("Entering Smoke test for OpenSearch Bundle.") - # TODO: Download the spec from https://github.com/opensearch-project/opensearch-api-specification/releases/download/main-latest/opensearch-openapi.yaml - spec_file = os.path.join(os.path.dirname(os.path.abspath(__file__)), "smoke_tests_spec", "opensearch-openapi.yaml") - self.spec_ = Spec.from_file_path(spec_file) + # Below URL is for the pre-release latest. In the future may consider use formal released spec when available. + self.spec_url = "https://github.com/opensearch-project/opensearch-api-specification/releases/download/main-latest/opensearch-openapi.yaml" + self.spec_local_path = os.path.join(os.path.dirname(os.path.abspath(__file__)), "smoke_tests_spec", "opensearch-openapi-local.yaml") + self.spec_download_path = os.path.join(os.path.dirname(os.path.abspath(__file__)), "smoke_tests_spec", "opensearch-openapi.yaml") + self.spec_path = self.download_spec(self.spec_url, self.spec_local_path, self.spec_download_path) + self.spec_ = Spec.from_file_path(self.spec_path) self.mimetype = { "Content-Type": "application/json" } - # self.openapi = openapi_core.OpenAPI.from_file_path(spec_file) + + def download_spec(self, url: str, local_path: str, download_path: str) -> str: + try: + response = requests.get(url, timeout=10) + if response.status_code == 200: + with open(download_path, "wb") as file: + file.write(response.content) + logging.info(f"Downloaded latest spec from {url}") + return download_path + else: + logging.info(f"Failed to fetch remote API spec, using local file: {local_path}") + return local_path + except requests.RequestException: + logging.info(f"Could not reach {url}, using local file: {local_path}") + return local_path def validate_request_swagger(self, request: Any) -> None: request = RequestsOpenAPIRequest(request) diff --git a/src/test_workflow/smoke_test/smoke_tests_spec/opensearch-openapi.yaml b/src/test_workflow/smoke_test/smoke_tests_spec/opensearch-openapi-local.yaml similarity index 83% rename from src/test_workflow/smoke_test/smoke_tests_spec/opensearch-openapi.yaml rename to src/test_workflow/smoke_test/smoke_tests_spec/opensearch-openapi-local.yaml index 2786ba3da1..f765b20e52 100644 --- a/src/test_workflow/smoke_test/smoke_tests_spec/opensearch-openapi.yaml +++ b/src/test_workflow/smoke_test/smoke_tests_spec/opensearch-openapi-local.yaml @@ -407,7 +407,7 @@ paths: x-distributions-excluded: - amazon-managed - amazon-serverless - description: Clears all or specific caches for one or more indices. + description: Clears all or specific caches for one or more indexes. externalDocs: url: https://opensearch.org/docs/latest/api-reference/index-apis/clear-index-cache/ parameters: @@ -450,7 +450,7 @@ paths: operationId: cat.aliases.0 x-operation-group: cat.aliases x-version-added: '1.0' - description: Shows information about currently configured aliases to indices including filter and routing infos. + description: Shows information about aliases currently configured to indexes, including filter and routing information. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-aliases/ parameters: @@ -474,7 +474,7 @@ paths: operationId: cat.aliases.1 x-operation-group: cat.aliases x-version-added: '1.0' - description: Shows information about currently configured aliases to indices including filter and routing infos. + description: Shows information about aliases currently configured to indexes, including filter and routing information. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-aliases/ parameters: @@ -577,7 +577,7 @@ paths: operationId: cat.count.0 x-operation-group: cat.count x-version-added: '1.0' - description: Provides quick access to the document count of the entire cluster, or individual indices. + description: Provides quick access to the document count of the entire cluster or of an individual index. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-count/ parameters: @@ -599,7 +599,7 @@ paths: operationId: cat.count.1 x-operation-group: cat.count x-version-added: '1.0' - description: Provides quick access to the document count of the entire cluster, or individual indices. + description: Provides quick access to the document count of the entire cluster or of an individual index. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-count/ parameters: @@ -622,7 +622,7 @@ paths: operationId: cat.fielddata.0 x-operation-group: cat.fielddata x-version-added: '1.0' - description: Shows how much heap memory is currently being used by fielddata on every data node in the cluster. + description: Shows how much heap memory is currently being used by field data on every data node in the cluster. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-field-data/ parameters: @@ -646,7 +646,7 @@ paths: operationId: cat.fielddata.1 x-operation-group: cat.fielddata x-version-added: '1.0' - description: Shows how much heap memory is currently being used by fielddata on every data node in the cluster. + description: Shows how much heap memory is currently being used by field data on every data node in the cluster. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-field-data/ parameters: @@ -695,7 +695,7 @@ paths: operationId: cat.indices.0 x-operation-group: cat.indices x-version-added: '1.0' - description: 'Returns information about indices: number of primaries and replicas, document counts, disk size, ...' + description: Lists information related to indexes, that is, how much disk space they are using, how many shards they have, their health status, and so on. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-indices/ parameters: @@ -726,7 +726,7 @@ paths: operationId: cat.indices.1 x-operation-group: cat.indices x-version-added: '1.0' - description: 'Returns information about indices: number of primaries and replicas, document counts, disk size, ...' + description: Lists information related to indexes, that is, how much disk space they are using, how many shards they have, their health status, and so on. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-indices/ parameters: @@ -758,7 +758,7 @@ paths: operationId: cat.master.0 x-operation-group: cat.master deprecated: true - x-deprecation-message: To promote inclusive language, please use '/_cat/cluster_manager' instead. + x-deprecation-message: To promote inclusive language, use '/_cat/cluster_manager' instead. x-version-added: '1.0' x-version-deprecated: '2.0' description: Returns information about the cluster-manager node. @@ -814,7 +814,7 @@ paths: operationId: cat.nodes.0 x-operation-group: cat.nodes x-version-added: '1.0' - description: Returns basic statistics about performance of cluster nodes. + description: Returns basic statistics about the performance of cluster nodes. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-nodes/ parameters: @@ -842,7 +842,7 @@ paths: operationId: cat.pending_tasks.0 x-operation-group: cat.pending_tasks x-version-added: '1.0' - description: Returns a concise representation of the cluster pending tasks. + description: Returns a concise representation of the cluster's pending tasks. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-pending-tasks/ parameters: @@ -868,7 +868,7 @@ paths: operationId: cat.pit_segments.0 x-operation-group: cat.pit_segments x-version-added: '2.4' - description: List segments for one or several PITs. + description: Lists one or several CAT point-in-time segments. externalDocs: url: https://opensearch.org/docs/latest/search-plugins/point-in-time-api/ parameters: @@ -893,7 +893,7 @@ paths: operationId: cat.all_pit_segments.0 x-operation-group: cat.all_pit_segments x-version-added: '2.4' - description: Lists all active point-in-time segments. + description: Lists all active CAT point-in-time segments. externalDocs: url: https://opensearch.org/docs/latest/search-plugins/point-in-time-api/ parameters: @@ -916,7 +916,7 @@ paths: operationId: cat.plugins.0 x-operation-group: cat.plugins x-version-added: '1.0' - description: Returns information about installed plugins across nodes node. + description: Returns information about the names, components, and versions of the installed plugins. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-plugins/ parameters: @@ -941,7 +941,7 @@ paths: operationId: cat.recovery.0 x-operation-group: cat.recovery x-version-added: '1.0' - description: Returns information about index shard recoveries, both on-going completed. + description: Returns all completed and ongoing index and shard recoveries. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-plugins/ parameters: @@ -968,7 +968,7 @@ paths: operationId: cat.recovery.1 x-operation-group: cat.recovery x-version-added: '1.0' - description: Returns information about index shard recoveries, both on-going completed. + description: Returns all completed and ongoing index and shard recoveries. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-plugins/ parameters: @@ -996,7 +996,7 @@ paths: operationId: cat.repositories.0 x-operation-group: cat.repositories x-version-added: '1.0' - description: Returns information about snapshot repositories registered in the cluster. + description: Returns information about all snapshot repositories for a cluster. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-repositories/ parameters: @@ -1021,7 +1021,9 @@ paths: operationId: cat.segment_replication.0 x-operation-group: cat.segment_replication x-version-added: '2.6' - description: Returns information about both on-going and latest completed Segment Replication events. + description: |- + Returns information about active and last-completed segment replication events on each replica shard, including related shard-level metrics. + These metrics provide information about how far behind the primary shard the replicas are lagging. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-segment-replication/ parameters: @@ -1055,7 +1057,9 @@ paths: operationId: cat.segment_replication.1 x-operation-group: cat.segment_replication x-version-added: '2.6' - description: Returns information about both on-going and latest completed Segment Replication events. + description: |- + Returns information about active and last-completed segment replication events on each replica shard, including related shard-level metrics. + These metrics provide information about how far behind the primary shard the replicas are lagging. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-segment-replication/ parameters: @@ -1141,7 +1145,7 @@ paths: operationId: cat.shards.0 x-operation-group: cat.shards x-version-added: '1.0' - description: Provides a detailed view of shard allocation on nodes. + description: Lists the states of all primary and replica shards and how they are distributed. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-shards/ parameters: @@ -1168,7 +1172,7 @@ paths: operationId: cat.shards.1 x-operation-group: cat.shards x-version-added: '1.0' - description: Provides a detailed view of shard allocation on nodes. + description: Lists the states of all primary and replica shards and how they are distributed. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-shards/ parameters: @@ -1196,7 +1200,7 @@ paths: operationId: cat.snapshots.0 x-operation-group: cat.snapshots x-version-added: '1.0' - description: Returns all snapshots in a specific repository. + description: Lists all of the snapshots stored in a specific repository. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-snapshots/ parameters: @@ -1206,6 +1210,7 @@ paths: - $ref: '#/components/parameters/cat.snapshots___query.help' - $ref: '#/components/parameters/cat.snapshots___query.ignore_unavailable' - $ref: '#/components/parameters/cat.snapshots___query.master_timeout' + - $ref: '#/components/parameters/cat.snapshots___query.repository' - $ref: '#/components/parameters/cat.snapshots___query.s' - $ref: '#/components/parameters/cat.snapshots___query.time' - $ref: '#/components/parameters/cat.snapshots___query.v' @@ -1222,7 +1227,7 @@ paths: operationId: cat.snapshots.1 x-operation-group: cat.snapshots x-version-added: '1.0' - description: Returns all snapshots in a specific repository. + description: Lists all of the snapshots stored in a specific repository. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-snapshots/ parameters: @@ -1233,6 +1238,7 @@ paths: - $ref: '#/components/parameters/cat.snapshots___query.help' - $ref: '#/components/parameters/cat.snapshots___query.ignore_unavailable' - $ref: '#/components/parameters/cat.snapshots___query.master_timeout' + - $ref: '#/components/parameters/cat.snapshots___query.repository' - $ref: '#/components/parameters/cat.snapshots___query.s' - $ref: '#/components/parameters/cat.snapshots___query.time' - $ref: '#/components/parameters/cat.snapshots___query.v' @@ -1249,7 +1255,7 @@ paths: operationId: cat.tasks.0 x-operation-group: cat.tasks x-version-added: '1.0' - description: Returns information about the tasks currently executing on one or more nodes in the cluster. + description: Lists the progress of all tasks currently running on the cluster. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-tasks/ parameters: @@ -1276,7 +1282,7 @@ paths: operationId: cat.templates.0 x-operation-group: cat.templates x-version-added: '1.0' - description: Returns information about existing templates. + description: Lists the names, patterns, order numbers, and version numbers of index templates. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-templates/ parameters: @@ -1301,7 +1307,7 @@ paths: operationId: cat.templates.1 x-operation-group: cat.templates x-version-added: '1.0' - description: Returns information about existing templates. + description: Lists the names, patterns, order numbers, and version numbers of index templates. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-templates/ parameters: @@ -1329,7 +1335,7 @@ paths: x-version-added: '1.0' description: |- Returns cluster-wide thread pool statistics per node. - By default the active, queue and rejected statistics are returned for all thread pools. + By default the active, queued, and rejected statistics are returned for all thread pools. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-thread-pool/ parameters: @@ -1357,7 +1363,7 @@ paths: x-version-added: '1.0' description: |- Returns cluster-wide thread pool statistics per node. - By default the active, queue and rejected statistics are returned for all thread pools. + By default the active, queued, and rejected statistics are returned for all thread pools. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-thread-pool/ parameters: @@ -1384,7 +1390,7 @@ paths: operationId: cluster.allocation_explain.0 x-operation-group: cluster.allocation_explain x-version-added: '1.0' - description: Provides explanations for shard allocations in the cluster. + description: Explains how shards are allocated in the current cluster and provides an explanation for why unassigned shards can't be allocated to a node. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-allocation/ parameters: @@ -1404,7 +1410,7 @@ paths: operationId: cluster.allocation_explain.1 x-operation-group: cluster.allocation_explain x-version-added: '1.0' - description: Provides explanations for shard allocations in the cluster. + description: Explains how shards are allocated in the current cluster and provides an explanation for why unassigned shards can't be allocated to a node. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-allocation/ parameters: @@ -1425,7 +1431,7 @@ paths: operationId: cluster.delete_decommission_awareness.0 x-operation-group: cluster.delete_decommission_awareness x-version-added: '1.0' - description: Delete any existing decommission. + description: Recommissions a decommissioned zone. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-decommission/#example-decommissioning-and-recommissioning-a-zone responses: @@ -1442,7 +1448,7 @@ paths: operationId: cluster.get_decommission_awareness.0 x-operation-group: cluster.get_decommission_awareness x-version-added: '1.0' - description: Get details and status of decommissioned attribute. + description: Retrieves the decommission status for all zones. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-decommission/#example-getting-zone-decommission-status parameters: @@ -1460,7 +1466,7 @@ paths: operationId: cluster.put_decommission_awareness.0 x-operation-group: cluster.put_decommission_awareness x-version-added: '1.0' - description: Decommissions an awareness attribute. + description: Decommissions a cluster zone based on awareness. This can greatly benefit multi-zone deployments, where awareness attributes can aid in applying new upgrades to a cluster in a controlled fashion. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-decommission/#example-decommissioning-and-recommissioning-a-zone parameters: @@ -1596,8 +1602,8 @@ paths: x-operation-group: cluster.pending_tasks x-version-added: '1.0' description: |- - Returns a list of any cluster-level changes (e.g. create index, update mapping, - allocate or fail shard) which have not yet been executed. + Returns a list of pending cluster-level tasks, such as index creation, mapping updates, + or new allocations. externalDocs: url: https://opensearch.org/docs/latest parameters: @@ -1743,7 +1749,7 @@ paths: operationId: cluster.state.0 x-operation-group: cluster.state x-version-added: '1.0' - description: Returns a comprehensive information about the state of the cluster. + description: Returns comprehensive information about the state of the cluster. externalDocs: url: https://opensearch.org/docs/latest parameters: @@ -1769,7 +1775,7 @@ paths: operationId: cluster.state.1 x-operation-group: cluster.state x-version-added: '1.0' - description: Returns a comprehensive information about the state of the cluster. + description: Returns comprehensive information about the state of the cluster. externalDocs: url: https://opensearch.org/docs/latest parameters: @@ -1796,7 +1802,7 @@ paths: operationId: cluster.state.2 x-operation-group: cluster.state x-version-added: '1.0' - description: Returns a comprehensive information about the state of the cluster. + description: Returns comprehensive information about the state of the cluster. externalDocs: url: https://opensearch.org/docs/latest parameters: @@ -1824,10 +1830,53 @@ paths: operationId: cluster.stats.0 x-operation-group: cluster.stats x-version-added: '1.0' - description: Returns high-level overview of cluster statistics. + description: Returns a high-level overview of cluster statistics. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-stats/ + parameters: + - $ref: '#/components/parameters/cluster.stats___query.flat_settings' + - $ref: '#/components/parameters/cluster.stats___query.timeout' + - $ref: '#/components/parameters/_global___query.pretty' + - $ref: '#/components/parameters/_global___query.human' + - $ref: '#/components/parameters/_global___query.error_trace' + - $ref: '#/components/parameters/_global___query.source' + - $ref: '#/components/parameters/_global___query.filter_path' + responses: + '200': + $ref: '#/components/responses/cluster.stats___200' + /_cluster/stats/{metric}/{index_metric}/nodes/{node_id}: + get: + operationId: cluster.stats.3 + x-operation-group: cluster.stats + x-version-added: '2.18' + description: Returns a high-level overview of cluster statistics. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-stats/ parameters: + - $ref: '#/components/parameters/cluster.stats___path.index_metric' + - $ref: '#/components/parameters/cluster.stats___path.metric' + - $ref: '#/components/parameters/cluster.stats___path.node_id' + - $ref: '#/components/parameters/cluster.stats___query.flat_settings' + - $ref: '#/components/parameters/cluster.stats___query.timeout' + - $ref: '#/components/parameters/_global___query.pretty' + - $ref: '#/components/parameters/_global___query.human' + - $ref: '#/components/parameters/_global___query.error_trace' + - $ref: '#/components/parameters/_global___query.source' + - $ref: '#/components/parameters/_global___query.filter_path' + responses: + '200': + $ref: '#/components/responses/cluster.stats___200' + /_cluster/stats/{metric}/nodes/{node_id}: + get: + operationId: cluster.stats.2 + x-operation-group: cluster.stats + x-version-added: '2.18' + description: Returns a high-level overview of cluster statistics. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-stats/ + parameters: + - $ref: '#/components/parameters/cluster.stats___path.metric' + - $ref: '#/components/parameters/cluster.stats___path.node_id' - $ref: '#/components/parameters/cluster.stats___query.flat_settings' - $ref: '#/components/parameters/cluster.stats___query.timeout' - $ref: '#/components/parameters/_global___query.pretty' @@ -1843,7 +1892,7 @@ paths: operationId: cluster.stats.1 x-operation-group: cluster.stats x-version-added: '1.0' - description: Returns high-level overview of cluster statistics. + description: Returns a high-level overview of cluster statistics. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-stats/ parameters: @@ -1863,7 +1912,7 @@ paths: operationId: cluster.delete_voting_config_exclusions.0 x-operation-group: cluster.delete_voting_config_exclusions x-version-added: '1.0' - description: Clears cluster voting config exclusions. + description: Clears any cluster voting configuration exclusions. externalDocs: url: https://opensearch.org/docs/latest parameters: @@ -1880,7 +1929,7 @@ paths: operationId: cluster.post_voting_config_exclusions.0 x-operation-group: cluster.post_voting_config_exclusions x-version-added: '1.0' - description: Updates the cluster voting config exclusions by node ids or node names. + description: Updates the cluster voting configuration by excluding certain node IDs or names. externalDocs: url: https://opensearch.org/docs/latest parameters: @@ -1905,6 +1954,7 @@ paths: url: https://opensearch.org/docs/latest parameters: - $ref: '#/components/parameters/cluster.get_component_template___query.cluster_manager_timeout' + - $ref: '#/components/parameters/cluster.get_component_template___query.flat_settings' - $ref: '#/components/parameters/cluster.get_component_template___query.local' - $ref: '#/components/parameters/cluster.get_component_template___query.master_timeout' - $ref: '#/components/parameters/_global___query.pretty' @@ -1946,6 +1996,7 @@ paths: parameters: - $ref: '#/components/parameters/cluster.get_component_template___path.name' - $ref: '#/components/parameters/cluster.get_component_template___query.cluster_manager_timeout' + - $ref: '#/components/parameters/cluster.get_component_template___query.flat_settings' - $ref: '#/components/parameters/cluster.get_component_template___query.local' - $ref: '#/components/parameters/cluster.get_component_template___query.master_timeout' - $ref: '#/components/parameters/_global___query.pretty' @@ -2092,7 +2143,7 @@ paths: operationId: dangling_indices.list_dangling_indices.0 x-operation-group: dangling_indices.list_dangling_indices x-version-added: '1.0' - description: Returns all dangling indices. + description: Returns all dangling indexes. externalDocs: url: https://opensearch.org/docs/latest/api-reference/index-apis/dangling-index/ parameters: @@ -2124,8 +2175,8 @@ paths: - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: - '200': - $ref: '#/components/responses/dangling_indices.delete_dangling_index___200' + '202': + $ref: '#/components/responses/dangling_indices.delete_dangling_index___202' post: operationId: dangling_indices.import_dangling_index.0 x-operation-group: dangling_indices.import_dangling_index @@ -2145,8 +2196,8 @@ paths: - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' responses: - '200': - $ref: '#/components/responses/dangling_indices.import_dangling_index___200' + '202': + $ref: '#/components/responses/dangling_indices.import_dangling_index___202' /_data_stream: get: operationId: indices.get_data_stream.0 @@ -2277,7 +2328,7 @@ paths: operationId: field_caps.0 x-operation-group: field_caps x-version-added: '1.0' - description: Returns the information about the capabilities of fields among multiple indices. + description: Returns the information about the capabilities of fields among multiple indexes. externalDocs: url: https://opensearch.org/docs/latest/field-types/supported-field-types/alias/#using-aliases-in-field-capabilities-api-operations parameters: @@ -2300,7 +2351,7 @@ paths: operationId: field_caps.1 x-operation-group: field_caps x-version-added: '1.0' - description: Returns the information about the capabilities of fields among multiple indices. + description: Returns the information about the capabilities of fields among multiple indexes. externalDocs: url: https://opensearch.org/docs/latest/field-types/supported-field-types/alias/#using-aliases-in-field-capabilities-api-operations parameters: @@ -2324,7 +2375,7 @@ paths: operationId: indices.flush.0 x-operation-group: indices.flush x-version-added: '1.0' - description: Performs the flush operation on one or more indices. + description: Performs the flush operation on one or more indexes. externalDocs: url: https://opensearch.org/docs/latest parameters: @@ -2345,7 +2396,7 @@ paths: operationId: indices.flush.1 x-operation-group: indices.flush x-version-added: '1.0' - description: Performs the flush operation on one or more indices. + description: Performs the flush operation on one or more indexes. externalDocs: url: https://opensearch.org/docs/latest parameters: @@ -2370,7 +2421,7 @@ paths: x-distributions-excluded: - amazon-managed - amazon-serverless - description: Performs the force merge operation on one or more indices. + description: Performs the force merge operation on one or more indexes. externalDocs: url: https://opensearch.org/docs/latest parameters: @@ -2444,9 +2495,7 @@ paths: url: https://opensearch.org/docs/latest parameters: - $ref: '#/components/parameters/indices.simulate_index_template___path.name' - - $ref: '#/components/parameters/indices.simulate_index_template___query.cause' - $ref: '#/components/parameters/indices.simulate_index_template___query.cluster_manager_timeout' - - $ref: '#/components/parameters/indices.simulate_index_template___query.create' - $ref: '#/components/parameters/indices.simulate_index_template___query.master_timeout' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' @@ -2761,6 +2810,7 @@ paths: externalDocs: url: https://opensearch.org/docs/latest parameters: + - $ref: '#/components/parameters/ingest.processor_grok___query.s' - $ref: '#/components/parameters/_global___query.pretty' - $ref: '#/components/parameters/_global___query.human' - $ref: '#/components/parameters/_global___query.error_trace' @@ -2785,12 +2835,159 @@ paths: responses: '200': $ref: '#/components/responses/insights.top_queries___200' + /_list: + get: + operationId: list.help.0 + x-operation-group: list.help + x-version-added: '2.18' + description: Returns help for the List APIs. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/list/index/ + responses: + '200': + $ref: '#/components/responses/list.help___200' + parameters: + - $ref: '#/components/parameters/_global___query.pretty' + - $ref: '#/components/parameters/_global___query.human' + - $ref: '#/components/parameters/_global___query.error_trace' + - $ref: '#/components/parameters/_global___query.source' + - $ref: '#/components/parameters/_global___query.filter_path' + /_list/indices: + get: + operationId: list.indices.0 + x-operation-group: list.indices + x-version-added: '2.18' + description: Returns paginated information about indexes including number of primaries and replicas, document counts, disk size. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/list/list-indices/ + parameters: + - $ref: '#/components/parameters/list.indices___query.bytes' + - $ref: '#/components/parameters/list.indices___query.cluster_manager_timeout' + - $ref: '#/components/parameters/list.indices___query.expand_wildcards' + - $ref: '#/components/parameters/list.indices___query.format' + - $ref: '#/components/parameters/list.indices___query.h' + - $ref: '#/components/parameters/list.indices___query.health' + - $ref: '#/components/parameters/list.indices___query.help' + - $ref: '#/components/parameters/list.indices___query.include_unloaded_segments' + - $ref: '#/components/parameters/list.indices___query.local' + - $ref: '#/components/parameters/list.indices___query.master_timeout' + - $ref: '#/components/parameters/list.indices___query.next_token' + - $ref: '#/components/parameters/list.indices___query.pri' + - $ref: '#/components/parameters/list.indices___query.s' + - $ref: '#/components/parameters/list.indices___query.size' + - $ref: '#/components/parameters/list.indices___query.sort' + - $ref: '#/components/parameters/list.indices___query.time' + - $ref: '#/components/parameters/list.indices___query.v' + - $ref: '#/components/parameters/_global___query.pretty' + - $ref: '#/components/parameters/_global___query.human' + - $ref: '#/components/parameters/_global___query.error_trace' + - $ref: '#/components/parameters/_global___query.source' + - $ref: '#/components/parameters/_global___query.filter_path' + responses: + '200': + $ref: '#/components/responses/list.indices___200' + /_list/indices/{index}: + get: + operationId: list.indices.1 + x-operation-group: list.indices + x-version-added: '2.18' + description: Returns paginated information about indexes including number of primaries and replicas, document counts, disk size. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/list/list-indices/ + parameters: + - $ref: '#/components/parameters/list.indices___path.index' + - $ref: '#/components/parameters/list.indices___query.bytes' + - $ref: '#/components/parameters/list.indices___query.cluster_manager_timeout' + - $ref: '#/components/parameters/list.indices___query.expand_wildcards' + - $ref: '#/components/parameters/list.indices___query.format' + - $ref: '#/components/parameters/list.indices___query.h' + - $ref: '#/components/parameters/list.indices___query.health' + - $ref: '#/components/parameters/list.indices___query.help' + - $ref: '#/components/parameters/list.indices___query.include_unloaded_segments' + - $ref: '#/components/parameters/list.indices___query.local' + - $ref: '#/components/parameters/list.indices___query.master_timeout' + - $ref: '#/components/parameters/list.indices___query.next_token' + - $ref: '#/components/parameters/list.indices___query.pri' + - $ref: '#/components/parameters/list.indices___query.s' + - $ref: '#/components/parameters/list.indices___query.size' + - $ref: '#/components/parameters/list.indices___query.sort' + - $ref: '#/components/parameters/list.indices___query.time' + - $ref: '#/components/parameters/list.indices___query.v' + - $ref: '#/components/parameters/_global___query.pretty' + - $ref: '#/components/parameters/_global___query.human' + - $ref: '#/components/parameters/_global___query.error_trace' + - $ref: '#/components/parameters/_global___query.source' + - $ref: '#/components/parameters/_global___query.filter_path' + responses: + '200': + $ref: '#/components/responses/list.indices___200' + /_list/shards: + get: + operationId: list.shards.0 + x-operation-group: list.shards + x-version-added: '2.18' + description: Returns paginated details of shard allocation on nodes. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/list/list-shards/ + parameters: + - $ref: '#/components/parameters/list.shards___query.bytes' + - $ref: '#/components/parameters/list.shards___query.cluster_manager_timeout' + - $ref: '#/components/parameters/list.shards___query.format' + - $ref: '#/components/parameters/list.shards___query.h' + - $ref: '#/components/parameters/list.shards___query.help' + - $ref: '#/components/parameters/list.shards___query.local' + - $ref: '#/components/parameters/list.shards___query.master_timeout' + - $ref: '#/components/parameters/list.shards___query.next_token' + - $ref: '#/components/parameters/list.shards___query.s' + - $ref: '#/components/parameters/list.shards___query.size' + - $ref: '#/components/parameters/list.shards___query.sort' + - $ref: '#/components/parameters/list.shards___query.time' + - $ref: '#/components/parameters/list.shards___query.v' + - $ref: '#/components/parameters/_global___query.pretty' + - $ref: '#/components/parameters/_global___query.human' + - $ref: '#/components/parameters/_global___query.error_trace' + - $ref: '#/components/parameters/_global___query.source' + - $ref: '#/components/parameters/_global___query.filter_path' + responses: + '200': + $ref: '#/components/responses/list.shards___200' + /_list/shards/{index}: + get: + operationId: list.shards.1 + x-operation-group: list.shards + x-version-added: '2.18' + description: Returns paginated details of shard allocation on nodes. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/list/list-shards/ + parameters: + - $ref: '#/components/parameters/list.shards___path.index' + - $ref: '#/components/parameters/list.shards___query.bytes' + - $ref: '#/components/parameters/list.shards___query.cluster_manager_timeout' + - $ref: '#/components/parameters/list.shards___query.format' + - $ref: '#/components/parameters/list.shards___query.h' + - $ref: '#/components/parameters/list.shards___query.help' + - $ref: '#/components/parameters/list.shards___query.local' + - $ref: '#/components/parameters/list.shards___query.master_timeout' + - $ref: '#/components/parameters/list.shards___query.next_token' + - $ref: '#/components/parameters/list.shards___query.s' + - $ref: '#/components/parameters/list.shards___query.size' + - $ref: '#/components/parameters/list.shards___query.sort' + - $ref: '#/components/parameters/list.shards___query.time' + - $ref: '#/components/parameters/list.shards___query.v' + - $ref: '#/components/parameters/_global___query.pretty' + - $ref: '#/components/parameters/_global___query.human' + - $ref: '#/components/parameters/_global___query.error_trace' + - $ref: '#/components/parameters/_global___query.source' + - $ref: '#/components/parameters/_global___query.filter_path' + responses: + '200': + $ref: '#/components/responses/list.shards___200' /_mapping: get: operationId: indices.get_mapping.0 x-operation-group: indices.get_mapping x-version-added: '1.0' - description: Returns mappings for one or more indices. + description: Returns mappings for one or more indexes. externalDocs: url: https://opensearch.org/docs/latest/field-types/index/#get-a-mapping parameters: @@ -3450,7 +3647,7 @@ paths: operationId: asynchronous_search.search.0 x-operation-group: asynchronous_search.search x-version-added: '1.0' - description: Perform an asynchronous search. + description: Performs an asynchronous search. externalDocs: url: https://opensearch.org/docs/latest/search-plugins/async/index/#rest-api parameters: @@ -3473,7 +3670,7 @@ paths: operationId: asynchronous_search.delete.0 x-operation-group: asynchronous_search.delete x-version-added: '1.0' - description: Delete asynchronous search. + description: Deletes any responses from an asynchronous search. externalDocs: url: https://opensearch.org/docs/latest/search-plugins/async/index/#delete-searches-and-results parameters: @@ -3490,7 +3687,7 @@ paths: operationId: asynchronous_search.get.0 x-operation-group: asynchronous_search.get x-version-added: '1.0' - description: Get partial responses from asynchronous search. + description: Gets partial responses from an asynchronous search. externalDocs: url: https://opensearch.org/docs/latest/search-plugins/async/index/#get-partial-results parameters: @@ -3508,7 +3705,7 @@ paths: operationId: asynchronous_search.stats.0 x-operation-group: asynchronous_search.stats x-version-added: '1.0' - description: Monitoring of asynchronous searches that are running, completed, and/or persisted. + description: Monitors any asynchronous searches that are `running`, `completed`, or `persisted`. externalDocs: url: https://opensearch.org/docs/latest/search-plugins/async/index/#monitor-stats responses: @@ -3685,7 +3882,7 @@ paths: responses: '201': $ref: '#/components/responses/flow_framework.update___201' - description: It returns the workflow_id + description: It returns the `workflow_id`. '400': $ref: '#/components/responses/flow_framework.update___400' '404': @@ -3897,7 +4094,7 @@ paths: get: operationId: ism.explain_policy.0 x-operation-group: ism.explain_policy - description: Gets the currently applied policy on indices. + description: Gets the currently applied policy on indexes. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/ism/api/#explain-index requestBody: @@ -3914,7 +4111,7 @@ paths: post: operationId: ism.explain_policy.1 x-operation-group: ism.explain_policy - description: Gets the currently applied policy on indices. + description: Gets the currently applied policy on indexes. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/ism/api/#explain-index requestBody: @@ -3932,7 +4129,7 @@ paths: get: operationId: ism.explain_policy.3 x-operation-group: ism.explain_policy - description: Gets the currently applied policy on indices. + description: Gets the currently applied policy on indexes. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/ism/api/#explain-index parameters: @@ -3950,7 +4147,7 @@ paths: post: operationId: ism.explain_policy.4 x-operation-group: ism.explain_policy - description: Gets the currently applied policy on indices. + description: Gets the currently applied policy on indexes. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/ism/api/#explain-index parameters: @@ -4439,10 +4636,99 @@ paths: responses: '200': $ref: '#/components/responses/knn.warmup___200' + /_plugins/_ml/_predict/{algorithm_name}/{model_id}: + post: + operationId: ml.predict.0 + x-operation-group: ml.predict + x-version-added: '1.3' + description: Predicts new data with trained model. + parameters: + - $ref: '#/components/parameters/ml.predict___path.algorithm_name' + - $ref: '#/components/parameters/ml.predict___path.model_id' + - $ref: '#/components/parameters/_global___query.pretty' + - $ref: '#/components/parameters/_global___query.human' + - $ref: '#/components/parameters/_global___query.error_trace' + - $ref: '#/components/parameters/_global___query.source' + - $ref: '#/components/parameters/_global___query.filter_path' + requestBody: + $ref: '#/components/requestBodies/ml.predict' + responses: + '200': + $ref: '#/components/responses/ml.predict___200' + /_plugins/_ml/_train_predict/{algorithm_name}: + post: + operationId: ml.train_predict.0 + x-operation-group: ml.train_predict + x-version-added: '1.3' + description: Trains a model and predicts against the same training dataset. + parameters: + - $ref: '#/components/parameters/ml.train_predict___path.algorithm_name' + - $ref: '#/components/parameters/_global___query.pretty' + - $ref: '#/components/parameters/_global___query.human' + - $ref: '#/components/parameters/_global___query.error_trace' + - $ref: '#/components/parameters/_global___query.source' + - $ref: '#/components/parameters/_global___query.filter_path' + requestBody: + $ref: '#/components/requestBodies/ml.train_predict' + responses: + '200': + $ref: '#/components/responses/ml.train_predict___200' + /_plugins/_ml/_train/{algorithm_name}: + post: + operationId: ml.train.0 + x-operation-group: ml.train + x-version-added: '1.3' + description: Trains a model synchronously. + parameters: + - $ref: '#/components/parameters/ml.train___path.algorithm_name' + - $ref: '#/components/parameters/_global___query.pretty' + - $ref: '#/components/parameters/_global___query.human' + - $ref: '#/components/parameters/_global___query.error_trace' + - $ref: '#/components/parameters/_global___query.source' + - $ref: '#/components/parameters/_global___query.filter_path' + requestBody: + $ref: '#/components/requestBodies/ml.train' + responses: + '200': + $ref: '#/components/responses/ml.train___200' + /_plugins/_ml/{node_id}/stats: + get: + operationId: ml.get_stats.2 + x-operation-group: ml.get_stats + x-version-added: '1.3' + description: Get stats. + parameters: + - $ref: '#/components/parameters/ml.get_stats___path.node_id' + - $ref: '#/components/parameters/_global___query.pretty' + - $ref: '#/components/parameters/_global___query.human' + - $ref: '#/components/parameters/_global___query.error_trace' + - $ref: '#/components/parameters/_global___query.source' + - $ref: '#/components/parameters/_global___query.filter_path' + responses: + '200': + $ref: '#/components/responses/ml.get_stats___200' + /_plugins/_ml/{node_id}/stats/{stat}: + get: + operationId: ml.get_stats.3 + x-operation-group: ml.get_stats + x-version-added: '1.3' + description: Get stats. + parameters: + - $ref: '#/components/parameters/ml.get_stats___path.node_id' + - $ref: '#/components/parameters/ml.get_stats___path.stat' + - $ref: '#/components/parameters/_global___query.pretty' + - $ref: '#/components/parameters/_global___query.human' + - $ref: '#/components/parameters/_global___query.error_trace' + - $ref: '#/components/parameters/_global___query.source' + - $ref: '#/components/parameters/_global___query.filter_path' + responses: + '200': + $ref: '#/components/responses/ml.get_stats___200' /_plugins/_ml/agents/_register: post: operationId: ml.register_agents.0 x-operation-group: ml.register_agents + x-version-added: '2.13' description: Register an agent. requestBody: $ref: '#/components/requestBodies/ml.register_agents' @@ -4455,10 +4741,44 @@ paths: - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' + /_plugins/_ml/agents/_search: + get: + operationId: ml.search_agents.0 + x-operation-group: ml.search_agents + x-version-added: '2.13' + description: Search agents. + requestBody: + $ref: '#/components/requestBodies/ml.search_agents' + responses: + '200': + $ref: '#/components/responses/ml.search_agents___200' + parameters: + - $ref: '#/components/parameters/_global___query.pretty' + - $ref: '#/components/parameters/_global___query.human' + - $ref: '#/components/parameters/_global___query.error_trace' + - $ref: '#/components/parameters/_global___query.source' + - $ref: '#/components/parameters/_global___query.filter_path' + post: + operationId: ml.search_agents.1 + x-operation-group: ml.search_agents + description: Search agents. + x-version-added: '2.13' + requestBody: + $ref: '#/components/requestBodies/ml.search_agents' + responses: + '200': + $ref: '#/components/responses/ml.search_agents___200' + parameters: + - $ref: '#/components/parameters/_global___query.pretty' + - $ref: '#/components/parameters/_global___query.human' + - $ref: '#/components/parameters/_global___query.error_trace' + - $ref: '#/components/parameters/_global___query.source' + - $ref: '#/components/parameters/_global___query.filter_path' /_plugins/_ml/agents/{agent_id}: delete: operationId: ml.delete_agent.0 x-operation-group: ml.delete_agent + x-version-added: '2.13' description: Delete an agent. parameters: - $ref: '#/components/parameters/ml.delete_agent___path.agent_id' @@ -4470,6 +4790,39 @@ paths: responses: '200': $ref: '#/components/responses/ml.delete_agent___200' + get: + operationId: ml.get_agent.0 + x-operation-group: ml.get_agent + x-version-added: '2.13' + description: Get an agent. + parameters: + - $ref: '#/components/parameters/ml.get_agent___path.agent_id' + - $ref: '#/components/parameters/_global___query.pretty' + - $ref: '#/components/parameters/_global___query.human' + - $ref: '#/components/parameters/_global___query.error_trace' + - $ref: '#/components/parameters/_global___query.source' + - $ref: '#/components/parameters/_global___query.filter_path' + responses: + '200': + $ref: '#/components/responses/ml.get_agent___200' + /_plugins/_ml/agents/{agent_id}/_execute: + post: + operationId: ml.execute_agent.0 + x-operation-group: ml.execute_agent + x-version-added: '2.13' + description: Execute an agent. + parameters: + - $ref: '#/components/parameters/ml.execute_agent___path.agent_id' + - $ref: '#/components/parameters/_global___query.pretty' + - $ref: '#/components/parameters/_global___query.human' + - $ref: '#/components/parameters/_global___query.error_trace' + - $ref: '#/components/parameters/_global___query.source' + - $ref: '#/components/parameters/_global___query.filter_path' + requestBody: + $ref: '#/components/requestBodies/ml.execute_agent' + responses: + '200': + $ref: '#/components/responses/ml.execute_agent___200' /_plugins/_ml/connectors/_create: post: operationId: ml.create_connector.0 @@ -4486,6 +4839,39 @@ paths: - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' + /_plugins/_ml/connectors/_search: + get: + operationId: ml.search_connectors.0 + x-operation-group: ml.search_connectors + x-version-added: '2.11' + description: Searches for standalone connectors. + requestBody: + $ref: '#/components/requestBodies/ml.search_connectors' + responses: + '200': + $ref: '#/components/responses/ml.search_connectors___200' + parameters: + - $ref: '#/components/parameters/_global___query.pretty' + - $ref: '#/components/parameters/_global___query.human' + - $ref: '#/components/parameters/_global___query.error_trace' + - $ref: '#/components/parameters/_global___query.source' + - $ref: '#/components/parameters/_global___query.filter_path' + post: + operationId: ml.search_connectors.1 + x-operation-group: ml.search_connectors + x-version-added: '2.11' + description: Searches for standalone connectors. + requestBody: + $ref: '#/components/requestBodies/ml.search_connectors' + responses: + '200': + $ref: '#/components/responses/ml.search_connectors___200' + parameters: + - $ref: '#/components/parameters/_global___query.pretty' + - $ref: '#/components/parameters/_global___query.human' + - $ref: '#/components/parameters/_global___query.error_trace' + - $ref: '#/components/parameters/_global___query.source' + - $ref: '#/components/parameters/_global___query.filter_path' /_plugins/_ml/connectors/{connector_id}: delete: operationId: ml.delete_connector.0 @@ -4501,6 +4887,338 @@ paths: responses: '200': $ref: '#/components/responses/ml.delete_connector___200' + get: + operationId: ml.get_connector.0 + x-operation-group: ml.get_connector + x-version-added: '2.11' + description: Retrieves a standalone connector. + parameters: + - $ref: '#/components/parameters/ml.get_connector___path.connector_id' + - $ref: '#/components/parameters/_global___query.pretty' + - $ref: '#/components/parameters/_global___query.human' + - $ref: '#/components/parameters/_global___query.error_trace' + - $ref: '#/components/parameters/_global___query.source' + - $ref: '#/components/parameters/_global___query.filter_path' + responses: + '200': + $ref: '#/components/responses/ml.get_connector___200' + put: + operationId: ml.update_connector.0 + x-operation-group: ml.update_connector + x-version-added: '2.12' + description: Updates a standalone connector. + parameters: + - $ref: '#/components/parameters/ml.update_connector___path.connector_id' + - $ref: '#/components/parameters/_global___query.pretty' + - $ref: '#/components/parameters/_global___query.human' + - $ref: '#/components/parameters/_global___query.error_trace' + - $ref: '#/components/parameters/_global___query.source' + - $ref: '#/components/parameters/_global___query.filter_path' + requestBody: + $ref: '#/components/requestBodies/ml.update_connector' + responses: + '200': + $ref: '#/components/responses/ml.update_connector___200' + /_plugins/_ml/controllers/{model_id}: + delete: + operationId: ml.delete_controller.0 + x-operation-group: ml.delete_controller + x-version-added: '2.12' + description: Deletes a controller. + parameters: + - $ref: '#/components/parameters/ml.delete_controller___path.model_id' + - $ref: '#/components/parameters/_global___query.pretty' + - $ref: '#/components/parameters/_global___query.human' + - $ref: '#/components/parameters/_global___query.error_trace' + - $ref: '#/components/parameters/_global___query.source' + - $ref: '#/components/parameters/_global___query.filter_path' + responses: + '200': + $ref: '#/components/responses/ml.delete_controller___200' + get: + operationId: ml.get_controller.0 + x-operation-group: ml.get_controller + x-version-added: '2.12' + description: Retrieves a controller. + parameters: + - $ref: '#/components/parameters/ml.get_controller___path.model_id' + - $ref: '#/components/parameters/_global___query.pretty' + - $ref: '#/components/parameters/_global___query.human' + - $ref: '#/components/parameters/_global___query.error_trace' + - $ref: '#/components/parameters/_global___query.source' + - $ref: '#/components/parameters/_global___query.filter_path' + responses: + '200': + $ref: '#/components/responses/ml.get_controller___200' + post: + operationId: ml.create_controller.0 + x-operation-group: ml.create_controller + x-version-added: '2.12' + description: Creates a controller. + requestBody: + $ref: '#/components/requestBodies/ml.create_controller' + parameters: + - $ref: '#/components/parameters/ml.create_controller___path.model_id' + - $ref: '#/components/parameters/_global___query.pretty' + - $ref: '#/components/parameters/_global___query.human' + - $ref: '#/components/parameters/_global___query.error_trace' + - $ref: '#/components/parameters/_global___query.source' + - $ref: '#/components/parameters/_global___query.filter_path' + responses: + '200': + $ref: '#/components/responses/ml.create_controller___200' + put: + operationId: ml.update_controller.0 + x-operation-group: ml.update_controller + x-version-added: '2.12' + description: Updates a controller. + requestBody: + $ref: '#/components/requestBodies/ml.update_controller' + parameters: + - $ref: '#/components/parameters/ml.update_controller___path.model_id' + - $ref: '#/components/parameters/_global___query.pretty' + - $ref: '#/components/parameters/_global___query.human' + - $ref: '#/components/parameters/_global___query.error_trace' + - $ref: '#/components/parameters/_global___query.source' + - $ref: '#/components/parameters/_global___query.filter_path' + responses: + '200': + $ref: '#/components/responses/ml.update_controller___200' + /_plugins/_ml/memory: + get: + operationId: ml.get_all_memories.0 + x-operation-group: ml.get_all_memories + x-version-added: '2.12' + description: Get all memories. + parameters: + - $ref: '#/components/parameters/ml.get_all_memories___query.max_results' + - $ref: '#/components/parameters/ml.get_all_memories___query.next_token' + - $ref: '#/components/parameters/_global___query.pretty' + - $ref: '#/components/parameters/_global___query.human' + - $ref: '#/components/parameters/_global___query.error_trace' + - $ref: '#/components/parameters/_global___query.source' + - $ref: '#/components/parameters/_global___query.filter_path' + responses: + '200': + $ref: '#/components/responses/ml.get_all_memories___200' + post: + operationId: ml.create_memory.0 + x-operation-group: ml.create_memory + x-version-added: '2.12' + description: Create a memory. + requestBody: + $ref: '#/components/requestBodies/ml.create_memory' + responses: + '200': + $ref: '#/components/responses/ml.create_memory___200' + parameters: + - $ref: '#/components/parameters/_global___query.pretty' + - $ref: '#/components/parameters/_global___query.human' + - $ref: '#/components/parameters/_global___query.error_trace' + - $ref: '#/components/parameters/_global___query.source' + - $ref: '#/components/parameters/_global___query.filter_path' + /_plugins/_ml/memory/_search: + get: + operationId: ml.search_memory.0 + x-operation-group: ml.search_memory + x-version-added: '2.12' + description: Search memory. + requestBody: + $ref: '#/components/requestBodies/ml.search_memory' + responses: + '200': + $ref: '#/components/responses/ml.search_memory___200' + parameters: + - $ref: '#/components/parameters/_global___query.pretty' + - $ref: '#/components/parameters/_global___query.human' + - $ref: '#/components/parameters/_global___query.error_trace' + - $ref: '#/components/parameters/_global___query.source' + - $ref: '#/components/parameters/_global___query.filter_path' + post: + operationId: ml.search_memory.1 + x-operation-group: ml.search_memory + x-version-added: '2.12' + description: Search memory. + requestBody: + $ref: '#/components/requestBodies/ml.search_memory' + responses: + '200': + $ref: '#/components/responses/ml.search_memory___200' + parameters: + - $ref: '#/components/parameters/_global___query.pretty' + - $ref: '#/components/parameters/_global___query.human' + - $ref: '#/components/parameters/_global___query.error_trace' + - $ref: '#/components/parameters/_global___query.source' + - $ref: '#/components/parameters/_global___query.filter_path' + /_plugins/_ml/memory/{memory_id}: + delete: + operationId: ml.delete_memory.0 + x-operation-group: ml.delete_memory + x-version-added: '2.12' + description: Delete a memory. + parameters: + - $ref: '#/components/parameters/ml.delete_memory___path.memory_id' + - $ref: '#/components/parameters/_global___query.pretty' + - $ref: '#/components/parameters/_global___query.human' + - $ref: '#/components/parameters/_global___query.error_trace' + - $ref: '#/components/parameters/_global___query.source' + - $ref: '#/components/parameters/_global___query.filter_path' + responses: + '200': + $ref: '#/components/responses/ml.delete_memory___200' + get: + operationId: ml.get_memory.0 + x-operation-group: ml.get_memory + x-version-added: '2.12' + description: Get a memory. + parameters: + - $ref: '#/components/parameters/ml.get_memory___path.memory_id' + - $ref: '#/components/parameters/_global___query.pretty' + - $ref: '#/components/parameters/_global___query.human' + - $ref: '#/components/parameters/_global___query.error_trace' + - $ref: '#/components/parameters/_global___query.source' + - $ref: '#/components/parameters/_global___query.filter_path' + responses: + '200': + $ref: '#/components/responses/ml.get_memory___200' + put: + operationId: ml.update_memory.0 + x-operation-group: ml.update_memory + x-version-added: '2.12' + description: Update a memory. + parameters: + - $ref: '#/components/parameters/ml.update_memory___path.memory_id' + - $ref: '#/components/parameters/_global___query.pretty' + - $ref: '#/components/parameters/_global___query.human' + - $ref: '#/components/parameters/_global___query.error_trace' + - $ref: '#/components/parameters/_global___query.source' + - $ref: '#/components/parameters/_global___query.filter_path' + requestBody: + $ref: '#/components/requestBodies/ml.update_memory' + responses: + '200': + $ref: '#/components/responses/ml.update_memory___200' + /_plugins/_ml/memory/{memory_id}/_search: + get: + operationId: ml.search_message.0 + x-operation-group: ml.search_message + x-version-added: '2.12' + description: Search messages. + parameters: + - $ref: '#/components/parameters/ml.search_message___path.memory_id' + - $ref: '#/components/parameters/_global___query.pretty' + - $ref: '#/components/parameters/_global___query.human' + - $ref: '#/components/parameters/_global___query.error_trace' + - $ref: '#/components/parameters/_global___query.source' + - $ref: '#/components/parameters/_global___query.filter_path' + requestBody: + $ref: '#/components/requestBodies/ml.search_message' + responses: + '200': + $ref: '#/components/responses/ml.search_message___200' + post: + operationId: ml.search_message.1 + x-operation-group: ml.search_message + x-version-added: '2.12' + description: Search messages. + parameters: + - $ref: '#/components/parameters/ml.search_message___path.memory_id' + - $ref: '#/components/parameters/_global___query.pretty' + - $ref: '#/components/parameters/_global___query.human' + - $ref: '#/components/parameters/_global___query.error_trace' + - $ref: '#/components/parameters/_global___query.source' + - $ref: '#/components/parameters/_global___query.filter_path' + requestBody: + $ref: '#/components/requestBodies/ml.search_message' + responses: + '200': + $ref: '#/components/responses/ml.search_message___200' + /_plugins/_ml/memory/{memory_id}/messages: + get: + operationId: ml.get_all_messages.0 + x-operation-group: ml.get_all_messages + x-version-added: '2.12' + description: Get all messages in a memory. + parameters: + - $ref: '#/components/parameters/ml.get_all_messages___path.memory_id' + - $ref: '#/components/parameters/ml.get_all_messages___query.max_results' + - $ref: '#/components/parameters/ml.get_all_messages___query.next_token' + - $ref: '#/components/parameters/_global___query.pretty' + - $ref: '#/components/parameters/_global___query.human' + - $ref: '#/components/parameters/_global___query.error_trace' + - $ref: '#/components/parameters/_global___query.source' + - $ref: '#/components/parameters/_global___query.filter_path' + responses: + '200': + $ref: '#/components/responses/ml.get_all_messages___200' + post: + operationId: ml.create_message.0 + x-operation-group: ml.create_message + x-version-added: '2.12' + description: Create a message. + parameters: + - $ref: '#/components/parameters/ml.create_message___path.memory_id' + - $ref: '#/components/parameters/_global___query.pretty' + - $ref: '#/components/parameters/_global___query.human' + - $ref: '#/components/parameters/_global___query.error_trace' + - $ref: '#/components/parameters/_global___query.source' + - $ref: '#/components/parameters/_global___query.filter_path' + requestBody: + $ref: '#/components/requestBodies/ml.create_message' + responses: + '200': + $ref: '#/components/responses/ml.create_message___200' + /_plugins/_ml/memory/message/{message_id}: + get: + operationId: ml.get_message.0 + x-operation-group: ml.get_message + x-version-added: '2.12' + description: Get a message. + parameters: + - $ref: '#/components/parameters/ml.get_message___path.message_id' + - $ref: '#/components/parameters/_global___query.pretty' + - $ref: '#/components/parameters/_global___query.human' + - $ref: '#/components/parameters/_global___query.error_trace' + - $ref: '#/components/parameters/_global___query.source' + - $ref: '#/components/parameters/_global___query.filter_path' + responses: + '200': + $ref: '#/components/responses/ml.get_message___200' + put: + operationId: ml.update_message.0 + x-operation-group: ml.update_message + x-version-added: '2.12' + description: Update a message. + parameters: + - $ref: '#/components/parameters/ml.update_message___path.message_id' + - $ref: '#/components/parameters/_global___query.pretty' + - $ref: '#/components/parameters/_global___query.human' + - $ref: '#/components/parameters/_global___query.error_trace' + - $ref: '#/components/parameters/_global___query.source' + - $ref: '#/components/parameters/_global___query.filter_path' + requestBody: + $ref: '#/components/requestBodies/ml.update_message' + responses: + '200': + $ref: '#/components/responses/ml.update_message___200' + /_plugins/_ml/memory/message/{message_id}/traces: + get: + operationId: ml.get_message_traces.0 + x-operation-group: ml.get_message_traces + x-version-added: '2.12' + description: Get a message traces. + parameters: + - $ref: '#/components/parameters/ml.get_message_traces___path.message_id' + - $ref: '#/components/parameters/ml.get_message_traces___query.max_results' + - $ref: '#/components/parameters/ml.get_message_traces___query.next_token' + - $ref: '#/components/parameters/_global___query.pretty' + - $ref: '#/components/parameters/_global___query.human' + - $ref: '#/components/parameters/_global___query.error_trace' + - $ref: '#/components/parameters/_global___query.source' + - $ref: '#/components/parameters/_global___query.filter_path' + responses: + '200': + $ref: '#/components/responses/ml.get_message_traces___200' /_plugins/_ml/model_groups/_register: post: operationId: ml.register_model_group.0 @@ -4517,6 +5235,39 @@ paths: - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' + /_plugins/_ml/model_groups/_search: + get: + operationId: ml.search_model_group.0 + x-operation-group: ml.search_model_group + x-version-added: '2.9' + description: Searches for model groups. + requestBody: + $ref: '#/components/requestBodies/ml.search_model_group' + responses: + '200': + $ref: '#/components/responses/ml.search_model_group___200' + parameters: + - $ref: '#/components/parameters/_global___query.pretty' + - $ref: '#/components/parameters/_global___query.human' + - $ref: '#/components/parameters/_global___query.error_trace' + - $ref: '#/components/parameters/_global___query.source' + - $ref: '#/components/parameters/_global___query.filter_path' + post: + operationId: ml.search_model_group.1 + x-operation-group: ml.search_model_group + x-version-added: '2.9' + description: Searches for model groups. + requestBody: + $ref: '#/components/requestBodies/ml.search_model_group' + responses: + '200': + $ref: '#/components/responses/ml.search_model_group___200' + parameters: + - $ref: '#/components/parameters/_global___query.pretty' + - $ref: '#/components/parameters/_global___query.human' + - $ref: '#/components/parameters/_global___query.error_trace' + - $ref: '#/components/parameters/_global___query.source' + - $ref: '#/components/parameters/_global___query.filter_path' /_plugins/_ml/model_groups/{model_group_id}: delete: operationId: ml.delete_model_group.0 @@ -4546,10 +5297,28 @@ paths: responses: '200': $ref: '#/components/responses/ml.get_model_group___200' + put: + operationId: ml.update_model_group.0 + x-operation-group: ml.update_model_group + x-version-added: '2.9' + description: Updates a model group. + parameters: + - $ref: '#/components/parameters/ml.update_model_group___path.model_group_id' + - $ref: '#/components/parameters/_global___query.pretty' + - $ref: '#/components/parameters/_global___query.human' + - $ref: '#/components/parameters/_global___query.error_trace' + - $ref: '#/components/parameters/_global___query.source' + - $ref: '#/components/parameters/_global___query.filter_path' + requestBody: + $ref: '#/components/requestBodies/ml.update_model_group' + responses: + '200': + $ref: '#/components/responses/ml.update_model_group___200' /_plugins/_ml/models/_register: post: operationId: ml.register_model.0 x-operation-group: ml.register_model + x-version-added: '2.7' description: Registers a model. requestBody: $ref: '#/components/requestBodies/ml.register_model' @@ -4562,10 +5331,44 @@ paths: - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' + /_plugins/_ml/models/_register_meta: + post: + operationId: ml.register_model_meta.0 + x-operation-group: ml.register_model_meta + x-version-added: '2.7' + description: Registers model metadata. + requestBody: + $ref: '#/components/requestBodies/ml.register_model_meta' + responses: + '200': + $ref: '#/components/responses/ml.register_model_meta___200' + parameters: + - $ref: '#/components/parameters/_global___query.pretty' + - $ref: '#/components/parameters/_global___query.human' + - $ref: '#/components/parameters/_global___query.error_trace' + - $ref: '#/components/parameters/_global___query.source' + - $ref: '#/components/parameters/_global___query.filter_path' /_plugins/_ml/models/_search: get: operationId: ml.search_models.0 x-operation-group: ml.search_models + x-version-added: '1.3' + description: Searches for models. + requestBody: + $ref: '#/components/requestBodies/ml.search_models' + responses: + '200': + $ref: '#/components/responses/ml.search_models___200' + parameters: + - $ref: '#/components/parameters/_global___query.pretty' + - $ref: '#/components/parameters/_global___query.human' + - $ref: '#/components/parameters/_global___query.error_trace' + - $ref: '#/components/parameters/_global___query.source' + - $ref: '#/components/parameters/_global___query.filter_path' + post: + operationId: ml.search_models.1 + x-operation-group: ml.search_models + x-version-added: '1.3' description: Searches for models. requestBody: $ref: '#/components/requestBodies/ml.search_models' @@ -4578,10 +5381,66 @@ paths: - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' + /_plugins/_ml/models/_undeploy: + post: + operationId: ml.undeploy_model.1 + x-operation-group: ml.undeploy_model + x-version-added: '2.7' + description: Undeploys a model. + requestBody: + $ref: '#/components/requestBodies/ml.undeploy_model' + responses: + '200': + $ref: '#/components/responses/ml.undeploy_model___200' + parameters: + - $ref: '#/components/parameters/_global___query.pretty' + - $ref: '#/components/parameters/_global___query.human' + - $ref: '#/components/parameters/_global___query.error_trace' + - $ref: '#/components/parameters/_global___query.source' + - $ref: '#/components/parameters/_global___query.filter_path' + /_plugins/_ml/models/_unload: + post: + operationId: ml.unload_model.1 + x-operation-group: ml.unload_model + deprecated: true + x-version-deprecated: '2.7' + x-deprecation-message: Use `undeploy_model` instead. + description: Unloads a model. + requestBody: + $ref: '#/components/requestBodies/ml.unload_model' + responses: + '200': + $ref: '#/components/responses/ml.unload_model___200' + parameters: + - $ref: '#/components/parameters/_global___query.pretty' + - $ref: '#/components/parameters/_global___query.human' + - $ref: '#/components/parameters/_global___query.error_trace' + - $ref: '#/components/parameters/_global___query.source' + - $ref: '#/components/parameters/_global___query.filter_path' + /_plugins/_ml/models/_upload: + post: + operationId: ml.upload_model.0 + x-operation-group: ml.upload_model + deprecated: true + x-version-deprecated: '2.7' + x-deprecation-message: Use `register_model` instead. + description: Registers a model. + requestBody: + $ref: '#/components/requestBodies/ml.upload_model' + responses: + '200': + $ref: '#/components/responses/ml.upload_model___200' + parameters: + - $ref: '#/components/parameters/_global___query.pretty' + - $ref: '#/components/parameters/_global___query.human' + - $ref: '#/components/parameters/_global___query.error_trace' + - $ref: '#/components/parameters/_global___query.source' + - $ref: '#/components/parameters/_global___query.filter_path' /_plugins/_ml/models/{model_id}: delete: operationId: ml.delete_model.0 x-operation-group: ml.delete_model + x-version-added: '1.3' description: Deletes a model. parameters: - $ref: '#/components/parameters/ml.delete_model___path.model_id' @@ -4593,10 +5452,43 @@ paths: responses: '200': $ref: '#/components/responses/ml.delete_model___200' + get: + operationId: ml.get_model.0 + x-operation-group: ml.get_model + x-version-added: '1.3' + description: Retrieves a model. + parameters: + - $ref: '#/components/parameters/ml.get_model___path.model_id' + - $ref: '#/components/parameters/_global___query.pretty' + - $ref: '#/components/parameters/_global___query.human' + - $ref: '#/components/parameters/_global___query.error_trace' + - $ref: '#/components/parameters/_global___query.source' + - $ref: '#/components/parameters/_global___query.filter_path' + responses: + '200': + $ref: '#/components/responses/ml.get_model___200' + put: + operationId: ml.update_model.0 + x-operation-group: ml.update_model + x-version-added: '2.12' + description: Updates a model. + parameters: + - $ref: '#/components/parameters/ml.update_model___path.model_id' + - $ref: '#/components/parameters/_global___query.pretty' + - $ref: '#/components/parameters/_global___query.human' + - $ref: '#/components/parameters/_global___query.error_trace' + - $ref: '#/components/parameters/_global___query.source' + - $ref: '#/components/parameters/_global___query.filter_path' + requestBody: + $ref: '#/components/requestBodies/ml.update_model' + responses: + '200': + $ref: '#/components/responses/ml.update_model___200' /_plugins/_ml/models/{model_id}/_deploy: post: operationId: ml.deploy_model.0 x-operation-group: ml.deploy_model + x-version-added: '2.7' description: Deploys a model. parameters: - $ref: '#/components/parameters/ml.deploy_model___path.model_id' @@ -4608,10 +5500,47 @@ paths: responses: '200': $ref: '#/components/responses/ml.deploy_model___200' + /_plugins/_ml/models/{model_id}/_load: + post: + operationId: ml.load_model.0 + x-operation-group: ml.load_model + deprecated: true + x-version-deprecated: '2.7' + x-deprecation-message: Use `deploy_model` instead. + description: Deploys a model. + parameters: + - $ref: '#/components/parameters/ml.load_model___path.model_id' + - $ref: '#/components/parameters/_global___query.pretty' + - $ref: '#/components/parameters/_global___query.human' + - $ref: '#/components/parameters/_global___query.error_trace' + - $ref: '#/components/parameters/_global___query.source' + - $ref: '#/components/parameters/_global___query.filter_path' + responses: + '200': + $ref: '#/components/responses/ml.load_model___200' + /_plugins/_ml/models/{model_id}/_predict: + post: + operationId: ml.predict_model.0 + x-operation-group: ml.predict_model + x-version-added: '2.12' + description: Predicts a model. + parameters: + - $ref: '#/components/parameters/ml.predict_model___path.model_id' + - $ref: '#/components/parameters/_global___query.pretty' + - $ref: '#/components/parameters/_global___query.human' + - $ref: '#/components/parameters/_global___query.error_trace' + - $ref: '#/components/parameters/_global___query.source' + - $ref: '#/components/parameters/_global___query.filter_path' + requestBody: + $ref: '#/components/requestBodies/ml.predict_model' + responses: + '200': + $ref: '#/components/responses/ml.predict_model___200' /_plugins/_ml/models/{model_id}/_undeploy: post: operationId: ml.undeploy_model.0 x-operation-group: ml.undeploy_model + x-version-added: '2.7' description: Undeploys a model. parameters: - $ref: '#/components/parameters/ml.undeploy_model___path.model_id' @@ -4620,13 +5549,246 @@ paths: - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' + requestBody: + $ref: '#/components/requestBodies/ml.undeploy_model' responses: '200': $ref: '#/components/responses/ml.undeploy_model___200' + /_plugins/_ml/models/{model_id}/_unload: + post: + operationId: ml.unload_model.0 + x-operation-group: ml.unload_model + deprecated: true + x-version-deprecated: '2.7' + x-deprecation-message: Use `undeploy_model` instead. + description: Unloads a model. + parameters: + - $ref: '#/components/parameters/ml.unload_model___path.model_id' + - $ref: '#/components/parameters/_global___query.pretty' + - $ref: '#/components/parameters/_global___query.human' + - $ref: '#/components/parameters/_global___query.error_trace' + - $ref: '#/components/parameters/_global___query.source' + - $ref: '#/components/parameters/_global___query.filter_path' + requestBody: + $ref: '#/components/requestBodies/ml.unload_model' + responses: + '200': + $ref: '#/components/responses/ml.unload_model___200' + /_plugins/_ml/models/{model_id}/chunk/{chunk_number}: + post: + operationId: ml.chunk_model.0 + x-operation-group: ml.chunk_model + deprecated: true + x-version-deprecated: '2.7' + x-deprecation-message: Use `upload_chunk` instead. + description: Uploads model chunk. + parameters: + - $ref: '#/components/parameters/ml.chunk_model___path.chunk_number' + - $ref: '#/components/parameters/ml.chunk_model___path.model_id' + - $ref: '#/components/parameters/_global___query.pretty' + - $ref: '#/components/parameters/_global___query.human' + - $ref: '#/components/parameters/_global___query.error_trace' + - $ref: '#/components/parameters/_global___query.source' + - $ref: '#/components/parameters/_global___query.filter_path' + requestBody: + $ref: '#/components/requestBodies/ml.chunk_model' + responses: + '200': + $ref: '#/components/responses/ml.chunk_model___200' + /_plugins/_ml/models/{model_id}/upload_chunk/{chunk_number}: + post: + operationId: ml.upload_chunk.0 + x-operation-group: ml.upload_chunk + x-version-added: '2.7' + description: Uploads model chunk. + parameters: + - $ref: '#/components/parameters/ml.upload_chunk___path.chunk_number' + - $ref: '#/components/parameters/ml.upload_chunk___path.model_id' + - $ref: '#/components/parameters/_global___query.pretty' + - $ref: '#/components/parameters/_global___query.human' + - $ref: '#/components/parameters/_global___query.error_trace' + - $ref: '#/components/parameters/_global___query.source' + - $ref: '#/components/parameters/_global___query.filter_path' + requestBody: + $ref: '#/components/requestBodies/ml.upload_chunk' + responses: + '200': + $ref: '#/components/responses/ml.upload_chunk___200' + /_plugins/_ml/models/meta: + post: + operationId: ml.create_model_meta.0 + x-operation-group: ml.create_model_meta + deprecated: true + x-version-deprecated: '2.7' + x-deprecation-message: Use `_register_meta` instead. + description: Registers model metadata. + requestBody: + $ref: '#/components/requestBodies/ml.create_model_meta' + responses: + '200': + $ref: '#/components/responses/ml.create_model_meta___200' + parameters: + - $ref: '#/components/parameters/_global___query.pretty' + - $ref: '#/components/parameters/_global___query.human' + - $ref: '#/components/parameters/_global___query.error_trace' + - $ref: '#/components/parameters/_global___query.source' + - $ref: '#/components/parameters/_global___query.filter_path' + /_plugins/_ml/profile: + get: + operationId: ml.get_profile.0 + x-operation-group: ml.get_profile + x-version-added: '2.4' + description: Get a profile. + requestBody: + $ref: '#/components/requestBodies/ml.get_profile' + responses: + '200': + $ref: '#/components/responses/ml.get_profile___200' + parameters: + - $ref: '#/components/parameters/_global___query.pretty' + - $ref: '#/components/parameters/_global___query.human' + - $ref: '#/components/parameters/_global___query.error_trace' + - $ref: '#/components/parameters/_global___query.source' + - $ref: '#/components/parameters/_global___query.filter_path' + /_plugins/_ml/profile/models: + get: + operationId: ml.get_profile_models.0 + x-operation-group: ml.get_profile_models + x-version-added: '2.4' + description: Get a profile models. + requestBody: + $ref: '#/components/requestBodies/ml.get_profile_models' + responses: + '200': + $ref: '#/components/responses/ml.get_profile_models___200' + parameters: + - $ref: '#/components/parameters/_global___query.pretty' + - $ref: '#/components/parameters/_global___query.human' + - $ref: '#/components/parameters/_global___query.error_trace' + - $ref: '#/components/parameters/_global___query.source' + - $ref: '#/components/parameters/_global___query.filter_path' + /_plugins/_ml/profile/models/{model_id}: + get: + operationId: ml.get_profile_models.1 + x-operation-group: ml.get_profile_models + x-version-added: '2.11' + description: Get a profile models. + requestBody: + $ref: '#/components/requestBodies/ml.get_profile_models' + parameters: + - $ref: '#/components/parameters/ml.get_profile_models___path.model_id' + - $ref: '#/components/parameters/_global___query.pretty' + - $ref: '#/components/parameters/_global___query.human' + - $ref: '#/components/parameters/_global___query.error_trace' + - $ref: '#/components/parameters/_global___query.source' + - $ref: '#/components/parameters/_global___query.filter_path' + responses: + '200': + $ref: '#/components/responses/ml.get_profile_models___200' + /_plugins/_ml/profile/tasks: + get: + operationId: ml.get_profile_tasks.0 + x-operation-group: ml.get_profile_tasks + x-version-added: '2.4' + description: Get a profile tasks. + requestBody: + $ref: '#/components/requestBodies/ml.get_profile_tasks' + responses: + '200': + $ref: '#/components/responses/ml.get_profile_tasks___200' + parameters: + - $ref: '#/components/parameters/_global___query.pretty' + - $ref: '#/components/parameters/_global___query.human' + - $ref: '#/components/parameters/_global___query.error_trace' + - $ref: '#/components/parameters/_global___query.source' + - $ref: '#/components/parameters/_global___query.filter_path' + /_plugins/_ml/profile/tasks/{task_id}: + get: + operationId: ml.get_profile_tasks.1 + x-operation-group: ml.get_profile_tasks + x-version-added: '2.11' + description: Get a profile tasks. + requestBody: + $ref: '#/components/requestBodies/ml.get_profile_tasks' + parameters: + - $ref: '#/components/parameters/ml.get_profile_tasks___path.task_id' + - $ref: '#/components/parameters/_global___query.pretty' + - $ref: '#/components/parameters/_global___query.human' + - $ref: '#/components/parameters/_global___query.error_trace' + - $ref: '#/components/parameters/_global___query.source' + - $ref: '#/components/parameters/_global___query.filter_path' + responses: + '200': + $ref: '#/components/responses/ml.get_profile_tasks___200' + /_plugins/_ml/stats: + get: + operationId: ml.get_stats.0 + x-operation-group: ml.get_stats + x-version-added: '1.3' + description: Get stats. + responses: + '200': + $ref: '#/components/responses/ml.get_stats___200' + parameters: + - $ref: '#/components/parameters/_global___query.pretty' + - $ref: '#/components/parameters/_global___query.human' + - $ref: '#/components/parameters/_global___query.error_trace' + - $ref: '#/components/parameters/_global___query.source' + - $ref: '#/components/parameters/_global___query.filter_path' + /_plugins/_ml/stats/{stat}: + get: + operationId: ml.get_stats.1 + x-operation-group: ml.get_stats + x-version-added: '1.3' + description: Get stats. + parameters: + - $ref: '#/components/parameters/ml.get_stats___path.stat' + - $ref: '#/components/parameters/_global___query.pretty' + - $ref: '#/components/parameters/_global___query.human' + - $ref: '#/components/parameters/_global___query.error_trace' + - $ref: '#/components/parameters/_global___query.source' + - $ref: '#/components/parameters/_global___query.filter_path' + responses: + '200': + $ref: '#/components/responses/ml.get_stats___200' + /_plugins/_ml/tasks/_search: + get: + operationId: ml.search_tasks.0 + x-operation-group: ml.search_tasks + x-version-added: '1.3' + description: Searches for tasks. + requestBody: + $ref: '#/components/requestBodies/ml.search_tasks' + responses: + '200': + $ref: '#/components/responses/ml.search_tasks___200' + parameters: + - $ref: '#/components/parameters/_global___query.pretty' + - $ref: '#/components/parameters/_global___query.human' + - $ref: '#/components/parameters/_global___query.error_trace' + - $ref: '#/components/parameters/_global___query.source' + - $ref: '#/components/parameters/_global___query.filter_path' + post: + operationId: ml.search_tasks.1 + x-operation-group: ml.search_tasks + x-version-added: '1.3' + description: Searches for tasks. + requestBody: + $ref: '#/components/requestBodies/ml.search_tasks' + responses: + '200': + $ref: '#/components/responses/ml.search_tasks___200' + parameters: + - $ref: '#/components/parameters/_global___query.pretty' + - $ref: '#/components/parameters/_global___query.human' + - $ref: '#/components/parameters/_global___query.error_trace' + - $ref: '#/components/parameters/_global___query.source' + - $ref: '#/components/parameters/_global___query.filter_path' /_plugins/_ml/tasks/{task_id}: delete: operationId: ml.delete_task.0 x-operation-group: ml.delete_task + x-version-added: '1.3' description: Deletes a task. parameters: - $ref: '#/components/parameters/ml.delete_task___path.task_id' @@ -4641,6 +5803,7 @@ paths: get: operationId: ml.get_task.0 x-operation-group: ml.get_task + x-version-added: '1.3' description: Retrieves a task. parameters: - $ref: '#/components/parameters/ml.get_task___path.task_id' @@ -4652,6 +5815,37 @@ paths: responses: '200': $ref: '#/components/responses/ml.get_task___200' + /_plugins/_ml/tools: + get: + operationId: ml.get_all_tools.0 + x-operation-group: ml.get_all_tools + x-version-added: '2.12' + description: Get tools. + responses: + '200': + $ref: '#/components/responses/ml.get_all_tools___200' + parameters: + - $ref: '#/components/parameters/_global___query.pretty' + - $ref: '#/components/parameters/_global___query.human' + - $ref: '#/components/parameters/_global___query.error_trace' + - $ref: '#/components/parameters/_global___query.source' + - $ref: '#/components/parameters/_global___query.filter_path' + /_plugins/_ml/tools/{tool_name}: + get: + operationId: ml.get_tool.0 + x-operation-group: ml.get_tool + x-version-added: '2.12' + description: Get tools. + parameters: + - $ref: '#/components/parameters/ml.get_tool___path.tool_name' + - $ref: '#/components/parameters/_global___query.pretty' + - $ref: '#/components/parameters/_global___query.human' + - $ref: '#/components/parameters/_global___query.error_trace' + - $ref: '#/components/parameters/_global___query.source' + - $ref: '#/components/parameters/_global___query.filter_path' + responses: + '200': + $ref: '#/components/responses/ml.get_tool___200' /_plugins/_notifications/channels: get: operationId: notifications.list_channels.0 @@ -4875,8 +6069,8 @@ paths: get: operationId: observability.get_localstats.0 x-operation-group: observability.get_localstats - x-version-added: '1.1' - description: Retrieves Local Stats of all observability objects. + x-version-added: '2.5' + description: Retrieves local stats of all observability objects. responses: '200': $ref: '#/components/responses/observability.get_localstats___200' @@ -5191,6 +6385,212 @@ paths: responses: '200': $ref: '#/components/responses/ism.refresh_search_analyzers___200' + /_plugins/_replication/_autofollow: + delete: + operationId: replication.delete_replication_rule.0 + x-operation-group: replication.delete_replication_rule + x-version-added: '1.1' + description: Deletes the specified replication rule. + externalDocs: + url: https://opensearch.org/docs/latest/tuning-your-cluster/replication-plugin/api/#delete-replication-rule + requestBody: + $ref: '#/components/requestBodies/replication.delete_replication_rule' + responses: + '200': + $ref: '#/components/responses/replication.delete_replication_rule___200' + parameters: + - $ref: '#/components/parameters/_global___query.pretty' + - $ref: '#/components/parameters/_global___query.human' + - $ref: '#/components/parameters/_global___query.error_trace' + - $ref: '#/components/parameters/_global___query.source' + - $ref: '#/components/parameters/_global___query.filter_path' + post: + operationId: replication.create_replication_rule.0 + x-operation-group: replication.create_replication_rule + x-version-added: '1.1' + description: Automatically starts replication on indexes matching a specified pattern. + externalDocs: + url: https://opensearch.org/docs/latest/tuning-your-cluster/replication-plugin/api/#create-replication-rule + requestBody: + $ref: '#/components/requestBodies/replication.create_replication_rule' + responses: + '200': + $ref: '#/components/responses/replication.create_replication_rule___200' + parameters: + - $ref: '#/components/parameters/_global___query.pretty' + - $ref: '#/components/parameters/_global___query.human' + - $ref: '#/components/parameters/_global___query.error_trace' + - $ref: '#/components/parameters/_global___query.source' + - $ref: '#/components/parameters/_global___query.filter_path' + /_plugins/_replication/{index}/_pause: + post: + operationId: replication.pause.0 + x-operation-group: replication.pause + x-version-added: '1.1' + description: Pauses replication of the leader index. + externalDocs: + url: https://opensearch.org/docs/latest/tuning-your-cluster/replication-plugin/api/#pause-replication + parameters: + - $ref: '#/components/parameters/replication.pause___path.index' + - $ref: '#/components/parameters/_global___query.pretty' + - $ref: '#/components/parameters/_global___query.human' + - $ref: '#/components/parameters/_global___query.error_trace' + - $ref: '#/components/parameters/_global___query.source' + - $ref: '#/components/parameters/_global___query.filter_path' + requestBody: + $ref: '#/components/requestBodies/replication.pause' + responses: + '200': + $ref: '#/components/responses/replication.pause___200' + /_plugins/_replication/{index}/_resume: + post: + operationId: replication.resume.0 + x-operation-group: replication.resume + x-version-added: '1.1' + description: Resumes replication of the leader index. + externalDocs: + url: https://opensearch.org/docs/latest/tuning-your-cluster/replication-plugin/api/#resume-replication + parameters: + - $ref: '#/components/parameters/replication.resume___path.index' + - $ref: '#/components/parameters/_global___query.pretty' + - $ref: '#/components/parameters/_global___query.human' + - $ref: '#/components/parameters/_global___query.error_trace' + - $ref: '#/components/parameters/_global___query.source' + - $ref: '#/components/parameters/_global___query.filter_path' + requestBody: + $ref: '#/components/requestBodies/replication.resume' + responses: + '200': + $ref: '#/components/responses/replication.resume___200' + /_plugins/_replication/{index}/_start: + put: + operationId: replication.start.0 + x-operation-group: replication.start + x-version-added: '1.1' + description: Initiate replication of an index from the leader cluster to the follower cluster. + externalDocs: + url: https://opensearch.org/docs/latest/tuning-your-cluster/replication-plugin/api/#start-replication + parameters: + - $ref: '#/components/parameters/replication.start___path.index' + - $ref: '#/components/parameters/_global___query.pretty' + - $ref: '#/components/parameters/_global___query.human' + - $ref: '#/components/parameters/_global___query.error_trace' + - $ref: '#/components/parameters/_global___query.source' + - $ref: '#/components/parameters/_global___query.filter_path' + requestBody: + $ref: '#/components/requestBodies/replication.start' + responses: + '200': + $ref: '#/components/responses/replication.start___200' + /_plugins/_replication/{index}/_status: + get: + operationId: replication.status.0 + x-operation-group: replication.status + x-version-added: '1.1' + description: Gets the status of index replication. + externalDocs: + url: https://opensearch.org/docs/latest/tuning-your-cluster/replication-plugin/api/#get-replication-status + parameters: + - $ref: '#/components/parameters/replication.status___path.index' + - $ref: '#/components/parameters/_global___query.pretty' + - $ref: '#/components/parameters/_global___query.human' + - $ref: '#/components/parameters/_global___query.error_trace' + - $ref: '#/components/parameters/_global___query.source' + - $ref: '#/components/parameters/_global___query.filter_path' + responses: + '200': + $ref: '#/components/responses/replication.status___200' + /_plugins/_replication/{index}/_stop: + post: + operationId: replication.stop.0 + x-operation-group: replication.stop + x-version-added: '1.1' + description: Terminates replication and converts the follower index to a standard index. + externalDocs: + url: https://opensearch.org/docs/latest/tuning-your-cluster/replication-plugin/api/#stop-replication + parameters: + - $ref: '#/components/parameters/replication.stop___path.index' + - $ref: '#/components/parameters/_global___query.pretty' + - $ref: '#/components/parameters/_global___query.human' + - $ref: '#/components/parameters/_global___query.error_trace' + - $ref: '#/components/parameters/_global___query.source' + - $ref: '#/components/parameters/_global___query.filter_path' + requestBody: + $ref: '#/components/requestBodies/replication.stop' + responses: + '200': + $ref: '#/components/responses/replication.stop___200' + /_plugins/_replication/{index}/_update: + put: + operationId: replication.update_settings.0 + x-operation-group: replication.update_settings + x-version-added: '1.1' + description: Updates settings on the follower index. + externalDocs: + url: https://opensearch.org/docs/latest/tuning-your-cluster/replication-plugin/api/#update-settings + parameters: + - $ref: '#/components/parameters/replication.update_settings___path.index' + - $ref: '#/components/parameters/_global___query.pretty' + - $ref: '#/components/parameters/_global___query.human' + - $ref: '#/components/parameters/_global___query.error_trace' + - $ref: '#/components/parameters/_global___query.source' + - $ref: '#/components/parameters/_global___query.filter_path' + requestBody: + $ref: '#/components/requestBodies/replication.update_settings' + responses: + '200': + $ref: '#/components/responses/replication.update_settings___200' + /_plugins/_replication/autofollow_stats: + get: + operationId: replication.autofollow_stats.0 + x-operation-group: replication.autofollow_stats + x-version-added: '1.1' + description: Gets information about auto-follow activity and any replication rules configured on the specified cluster. + externalDocs: + url: https://opensearch.org/docs/latest/tuning-your-cluster/replication-plugin/api/#get-auto-follow-stats + responses: + '200': + $ref: '#/components/responses/replication.autofollow_stats___200' + parameters: + - $ref: '#/components/parameters/_global___query.pretty' + - $ref: '#/components/parameters/_global___query.human' + - $ref: '#/components/parameters/_global___query.error_trace' + - $ref: '#/components/parameters/_global___query.source' + - $ref: '#/components/parameters/_global___query.filter_path' + /_plugins/_replication/follower_stats: + get: + operationId: replication.follower_stats.0 + x-operation-group: replication.follower_stats + x-version-added: '1.1' + description: Gets information about follower (syncing) indexes on a specified cluster. + externalDocs: + url: https://opensearch.org/docs/latest/tuning-your-cluster/replication-plugin/api/#get-follower-cluster-stats + responses: + '200': + $ref: '#/components/responses/replication.follower_stats___200' + parameters: + - $ref: '#/components/parameters/_global___query.pretty' + - $ref: '#/components/parameters/_global___query.human' + - $ref: '#/components/parameters/_global___query.error_trace' + - $ref: '#/components/parameters/_global___query.source' + - $ref: '#/components/parameters/_global___query.filter_path' + /_plugins/_replication/leader_stats: + get: + operationId: replication.leader_stats.0 + x-operation-group: replication.leader_stats + x-version-added: '1.1' + description: Gets information about replicated leader indexes on a specified cluster. + externalDocs: + url: https://opensearch.org/docs/latest/tuning-your-cluster/replication-plugin/api/#get-leader-cluster-stats + responses: + '200': + $ref: '#/components/responses/replication.leader_stats___200' + parameters: + - $ref: '#/components/parameters/_global___query.pretty' + - $ref: '#/components/parameters/_global___query.human' + - $ref: '#/components/parameters/_global___query.error_trace' + - $ref: '#/components/parameters/_global___query.source' + - $ref: '#/components/parameters/_global___query.filter_path' /_plugins/_rollup/jobs/{id}: delete: operationId: rollups.delete.0 @@ -5234,8 +6634,8 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/im-plugin/index-rollups/rollup-api/#create-or-update-an-index-rollup-job responses: - '200': - $ref: '#/components/responses/rollups.put___200' + '201': + $ref: '#/components/responses/rollups.put___201' parameters: - $ref: '#/components/parameters/rollups.put___path.id' - $ref: '#/components/parameters/rollups.put___query.if_primary_term' @@ -5568,7 +6968,7 @@ paths: x-distributions-excluded: - amazon-managed - amazon-serverless - description: Creates or replaces the allowlisted APIs. Accessible via Super Admin certificate or REST API permission. + description: Creates or replaces the permitted APIs. Accessible using Super Admin certificate or REST API permission. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#access-control-for-the-api requestBody: @@ -5938,6 +7338,8 @@ paths: responses: '200': $ref: '#/components/responses/security.create_user___200' + '201': + $ref: '#/components/responses/security.create_user___201' /_plugins/_security/api/internalusers/{username}/authtoken: post: operationId: security.generate_user_token.0 @@ -6125,6 +7527,8 @@ paths: responses: '200': $ref: '#/components/responses/security.update_distinguished_name___200' + '201': + $ref: '#/components/responses/security.update_distinguished_name___201' '400': $ref: '#/components/responses/security.update_distinguished_name___400' '403': @@ -6440,7 +7844,7 @@ paths: x-distributions-excluded: - amazon-managed - amazon-serverless - description: A PATCH call is used to update the existing configuration using the REST API. Only accessible by admins and users with rest api access and only when put or patch is enabled. + description: A `PATCH` call is used to update the existing configuration using the REST API. Only accessible by admins and users with REST API access and only when put or patch is enabled. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#patch-configuration requestBody: @@ -6464,7 +7868,7 @@ paths: x-distributions-excluded: - amazon-managed - amazon-serverless - description: Adds or updates the existing configuration using the REST API. Only accessible by admins and users with rest api access and only when put or patch is enabled. + description: Adds or updates the existing configuration using the REST API. Only accessible by admins and users with REST API access and only when put or patch is enabled. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#update-configuration requestBody: @@ -6820,7 +8224,7 @@ paths: x-distributions-excluded: - amazon-managed - amazon-serverless - description: Generates authorization token for the given user. Legacy API. Not Implemented. + description: Generates authorization token for the given user. Legacy API. Not Implemented. parameters: - $ref: '#/components/parameters/security.generate_user_token_legacy___path.username' - $ref: '#/components/parameters/_global___query.pretty' @@ -7077,6 +8481,149 @@ paths: - $ref: '#/components/parameters/_global___query.error_trace' - $ref: '#/components/parameters/_global___query.source' - $ref: '#/components/parameters/_global___query.filter_path' + /_plugins/_sm/policies: + get: + operationId: sm.get_policies.0 + x-operation-group: sm.get_policies + x-version-added: '2.1' + description: Retrieves all snapshot management policies with optional pagination and filtering. + parameters: + - $ref: '#/components/parameters/sm.get_policies___query.from' + - $ref: '#/components/parameters/sm.get_policies___query.queryString' + - $ref: '#/components/parameters/sm.get_policies___query.size' + - $ref: '#/components/parameters/sm.get_policies___query.sortField' + - $ref: '#/components/parameters/sm.get_policies___query.sortOrder' + - $ref: '#/components/parameters/_global___query.pretty' + - $ref: '#/components/parameters/_global___query.human' + - $ref: '#/components/parameters/_global___query.error_trace' + - $ref: '#/components/parameters/_global___query.source' + - $ref: '#/components/parameters/_global___query.filter_path' + responses: + '200': + $ref: '#/components/responses/sm.get_policies___200' + /_plugins/_sm/policies/{policy_name}: + delete: + operationId: sm.delete_policy.0 + x-operation-group: sm.delete_policy + x-version-added: '2.1' + description: Deletes a snapshot management policy. + parameters: + - $ref: '#/components/parameters/sm.delete_policy___path.policy_name' + - $ref: '#/components/parameters/_global___query.pretty' + - $ref: '#/components/parameters/_global___query.human' + - $ref: '#/components/parameters/_global___query.error_trace' + - $ref: '#/components/parameters/_global___query.source' + - $ref: '#/components/parameters/_global___query.filter_path' + responses: + '200': + $ref: '#/components/responses/sm.delete_policy___200' + '404': + $ref: '#/components/responses/sm.delete_policy___404' + get: + operationId: sm.get_policy.0 + x-operation-group: sm.get_policy + x-version-added: '2.1' + description: Retrieves a specific snapshot management policy by name. + parameters: + - $ref: '#/components/parameters/sm.get_policy___path.policy_name' + - $ref: '#/components/parameters/_global___query.pretty' + - $ref: '#/components/parameters/_global___query.human' + - $ref: '#/components/parameters/_global___query.error_trace' + - $ref: '#/components/parameters/_global___query.source' + - $ref: '#/components/parameters/_global___query.filter_path' + responses: + '200': + $ref: '#/components/responses/sm.get_policy___200' + '404': + $ref: '#/components/responses/sm.get_policy___404' + post: + operationId: sm.create_policy.0 + x-operation-group: sm.create_policy + x-version-added: '2.1' + description: Creates a snapshot management policy. + parameters: + - $ref: '#/components/parameters/sm.create_policy___path.policy_name' + - $ref: '#/components/parameters/_global___query.pretty' + - $ref: '#/components/parameters/_global___query.human' + - $ref: '#/components/parameters/_global___query.error_trace' + - $ref: '#/components/parameters/_global___query.source' + - $ref: '#/components/parameters/_global___query.filter_path' + requestBody: + $ref: '#/components/requestBodies/sm.create_policy' + responses: + '201': + $ref: '#/components/responses/sm.create_policy___201' + '400': + $ref: '#/components/responses/sm.create_policy___400' + put: + operationId: sm.update_policy.0 + x-operation-group: sm.update_policy + x-version-added: '2.1' + description: Updates an existing snapshot management policy. Requires `if_seq_no` and `if_primary_term`. + parameters: + - $ref: '#/components/parameters/sm.update_policy___path.policy_name' + - $ref: '#/components/parameters/sm.update_policy___query.if_primary_term' + - $ref: '#/components/parameters/sm.update_policy___query.if_seq_no' + - $ref: '#/components/parameters/_global___query.pretty' + - $ref: '#/components/parameters/_global___query.human' + - $ref: '#/components/parameters/_global___query.error_trace' + - $ref: '#/components/parameters/_global___query.source' + - $ref: '#/components/parameters/_global___query.filter_path' + requestBody: + $ref: '#/components/requestBodies/sm.update_policy' + responses: + '200': + $ref: '#/components/responses/sm.update_policy___200' + '404': + $ref: '#/components/responses/sm.update_policy___404' + /_plugins/_sm/policies/{policy_name}/_explain: + get: + operationId: sm.explain_policy.0 + x-operation-group: sm.explain_policy + x-version-added: '2.1' + description: Explains the state of the snapshot management policy. + parameters: + - $ref: '#/components/parameters/sm.explain_policy___path.policy_name' + - $ref: '#/components/parameters/_global___query.pretty' + - $ref: '#/components/parameters/_global___query.human' + - $ref: '#/components/parameters/_global___query.error_trace' + - $ref: '#/components/parameters/_global___query.source' + - $ref: '#/components/parameters/_global___query.filter_path' + responses: + '200': + $ref: '#/components/responses/sm.explain_policy___200' + /_plugins/_sm/policies/{policy_name}/_start: + post: + operationId: sm.start_policy.0 + x-operation-group: sm.start_policy + x-version-added: '2.1' + description: Starts a snapshot management policy. + parameters: + - $ref: '#/components/parameters/sm.start_policy___path.policy_name' + - $ref: '#/components/parameters/_global___query.pretty' + - $ref: '#/components/parameters/_global___query.human' + - $ref: '#/components/parameters/_global___query.error_trace' + - $ref: '#/components/parameters/_global___query.source' + - $ref: '#/components/parameters/_global___query.filter_path' + responses: + '200': + $ref: '#/components/responses/sm.start_policy___200' + /_plugins/_sm/policies/{policy_name}/_stop: + post: + operationId: sm.stop_policy.0 + x-operation-group: sm.stop_policy + x-version-added: '2.1' + description: Stops a snapshot management policy. + parameters: + - $ref: '#/components/parameters/sm.stop_policy___path.policy_name' + - $ref: '#/components/parameters/_global___query.pretty' + - $ref: '#/components/parameters/_global___query.human' + - $ref: '#/components/parameters/_global___query.error_trace' + - $ref: '#/components/parameters/_global___query.source' + - $ref: '#/components/parameters/_global___query.filter_path' + responses: + '200': + $ref: '#/components/responses/sm.stop_policy___200' /_plugins/_sql: post: operationId: sql.query.0 @@ -7259,7 +8806,7 @@ paths: operationId: transforms.put.0 x-operation-group: transforms.put x-version-added: '1.0' - description: Create an index transform, or update a transform if if_seq_no and if_primary_term are provided. + description: Create an index transform, or update a transform if `if_seq_no` and `if_primary_term` are provided. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/index-transforms/transforms-apis/#create-a-transform-job parameters: @@ -7276,6 +8823,8 @@ paths: responses: '200': $ref: '#/components/responses/transforms.put___200' + '201': + $ref: '#/components/responses/transforms.put___201' /_plugins/_transform/{id}/_explain: get: operationId: transforms.explain.0 @@ -7399,7 +8948,7 @@ paths: operationId: indices.refresh.0 x-operation-group: indices.refresh x-version-added: '1.0' - description: Performs the refresh operation in one or more indices. + description: Performs the refresh operation in one or more indexes. externalDocs: url: https://opensearch.org/docs/latest/tuning-your-cluster/availability-and-recovery/remote-store/index/#refresh-level-and-request-level-durability parameters: @@ -7418,7 +8967,7 @@ paths: operationId: indices.refresh.1 x-operation-group: indices.refresh x-version-added: '1.0' - description: Performs the refresh operation in one or more indices. + description: Performs the refresh operation in one or more indexes. externalDocs: url: https://opensearch.org/docs/latest/tuning-your-cluster/availability-and-recovery/remote-store/index/#refresh-level-and-request-level-durability parameters: @@ -7448,6 +8997,7 @@ paths: - $ref: '#/components/parameters/reindex___query.max_docs' - $ref: '#/components/parameters/reindex___query.refresh' - $ref: '#/components/parameters/reindex___query.requests_per_second' + - $ref: '#/components/parameters/reindex___query.require_alias' - $ref: '#/components/parameters/reindex___query.scroll' - $ref: '#/components/parameters/reindex___query.slices' - $ref: '#/components/parameters/reindex___query.timeout' @@ -7468,7 +9018,7 @@ paths: operationId: reindex_rethrottle.0 x-operation-group: reindex_rethrottle x-version-added: '1.0' - description: Changes the number of requests per second for a particular Reindex operation. + description: Changes the number of requests per second for a particular reindex operation. externalDocs: url: https://opensearch.org/docs/latest parameters: @@ -7601,7 +9151,7 @@ paths: operationId: indices.resolve_index.0 x-operation-group: indices.resolve_index x-version-added: '1.0' - description: Returns information about any matching indices, aliases, and data streams. + description: Returns information about any matching indexes, aliases, and data streams. externalDocs: url: https://opensearch.org/docs/latest parameters: @@ -7963,7 +9513,7 @@ paths: operationId: search_shards.0 x-operation-group: search_shards x-version-added: '1.0' - description: Returns information about the indices and shards that a search request would be executed against. + description: Returns information about the indexes and shards that a search request would be executed against. externalDocs: url: https://opensearch.org/docs/latest parameters: @@ -7985,7 +9535,7 @@ paths: operationId: search_shards.1 x-operation-group: search_shards x-version-added: '1.0' - description: Returns information about the indices and shards that a search request would be executed against. + description: Returns information about the indexes and shards that a search request would be executed against. externalDocs: url: https://opensearch.org/docs/latest parameters: @@ -8145,6 +9695,8 @@ paths: responses: '200': $ref: '#/components/responses/clear_scroll___200' + '404': + $ref: '#/components/responses/clear_scroll___404' get: operationId: scroll.0 x-operation-group: scroll @@ -8210,6 +9762,8 @@ paths: responses: '200': $ref: '#/components/responses/clear_scroll___200' + '404': + $ref: '#/components/responses/clear_scroll___404' get: operationId: scroll.2 x-operation-group: scroll @@ -8355,7 +9909,7 @@ paths: x-distributions-excluded: - amazon-managed - amazon-serverless - description: Returns settings for one or more indices. + description: Returns settings for one or more indexes. externalDocs: url: https://opensearch.org/docs/latest/api-reference/index-apis/get-settings/ parameters: @@ -8406,7 +9960,7 @@ paths: operationId: indices.get_settings.1 x-operation-group: indices.get_settings x-version-added: '1.0' - description: Returns settings for one or more indices. + description: Returns settings for one or more indexes. externalDocs: url: https://opensearch.org/docs/latest/api-reference/index-apis/get-settings/ parameters: @@ -8432,7 +9986,7 @@ paths: operationId: indices.shard_stores.0 x-operation-group: indices.shard_stores x-version-added: '1.0' - description: Provides store information for shard copies of indices. + description: Provides store information for shard copies of indexes. externalDocs: url: https://opensearch.org/docs/latest parameters: @@ -8732,7 +10286,7 @@ paths: operationId: snapshot.clone.0 x-operation-group: snapshot.clone x-version-added: '1.0' - description: Clones indices from one snapshot into another snapshot in the same repository. + description: Clones indexes from one snapshot into another snapshot in the same repository. externalDocs: url: https://opensearch.org/docs/latest parameters: @@ -9091,7 +10645,8 @@ paths: operationId: indices.get_upgrade.0 x-operation-group: indices.get_upgrade x-version-added: '1.0' - description: The _upgrade API is no longer useful and will be removed. + x-version-deprecated: '1.0' + description: The `_upgrade` API is no longer useful and will be removed. externalDocs: url: https://opensearch.org/docs/latest parameters: @@ -9110,7 +10665,8 @@ paths: operationId: indices.upgrade.0 x-operation-group: indices.upgrade x-version-added: '1.0' - description: The _upgrade API is no longer useful and will be removed. + x-version-deprecated: '1.0' + description: The `_upgrade` API is no longer useful and will be removed. externalDocs: url: https://opensearch.org/docs/latest parameters: @@ -9193,7 +10749,7 @@ paths: operationId: wlm.get_query_group.0 x-operation-group: wlm.get_query_group x-version-added: '2.17' - description: Gets the specified QueryGroup or get all if no name is provided. + description: Retrieves the specified query group. If no query group is specified, all query groups in the cluster are retrieved. responses: '200': $ref: '#/components/responses/wlm.get_query_group___200' @@ -9207,7 +10763,7 @@ paths: operationId: wlm.create_query_group.0 x-operation-group: wlm.create_query_group x-version-added: '2.17' - description: Creates the specified query group. + description: Creates a new query group and sets the resource limits for the new query group. requestBody: $ref: '#/components/requestBodies/wlm.create_query_group' responses: @@ -9224,7 +10780,7 @@ paths: operationId: wlm.delete_query_group.0 x-operation-group: wlm.delete_query_group x-version-added: '2.17' - description: Deletes the specified QueryGroup. + description: Deletes the specified query group. parameters: - $ref: '#/components/parameters/wlm.delete_query_group___path.name' - $ref: '#/components/parameters/_global___query.pretty' @@ -9239,7 +10795,7 @@ paths: operationId: wlm.get_query_group.1 x-operation-group: wlm.get_query_group x-version-added: '2.17' - description: Gets the specified QueryGroup or get all if no name is provided. + description: Retrieves the specified query group. If no query group is specified, all query groups in the cluster are retrieved. parameters: - $ref: '#/components/parameters/wlm.get_query_group___path.name' - $ref: '#/components/parameters/_global___query.pretty' @@ -9352,7 +10908,7 @@ paths: operationId: indices.get.0 x-operation-group: indices.get x-version-added: '1.0' - description: Returns information about one or more indices. + description: Returns information about one or more indexes. externalDocs: url: https://opensearch.org/docs/latest/api-reference/index-apis/get-index/ parameters: @@ -9868,7 +11424,7 @@ paths: operationId: indices.clear_cache.1 x-operation-group: indices.clear_cache x-version-added: '1.0' - description: Clears all or specific caches for one or more indices. + description: Clears all or specific caches for one or more indexes. externalDocs: url: https://opensearch.org/docs/latest/api-reference/index-apis/clear-index-cache/ parameters: @@ -10064,8 +11620,8 @@ paths: requestBody: $ref: '#/components/requestBodies/create' responses: - '200': - $ref: '#/components/responses/create___200' + '201': + $ref: '#/components/responses/create___201' put: operationId: create.1 x-operation-group: create @@ -10094,8 +11650,8 @@ paths: requestBody: $ref: '#/components/requestBodies/create' responses: - '200': - $ref: '#/components/responses/create___200' + '201': + $ref: '#/components/responses/create___201' /{index}/_delete_by_query: post: operationId: delete_by_query.0 @@ -10269,6 +11825,8 @@ paths: responses: '200': $ref: '#/components/responses/exists___200' + '404': + $ref: '#/components/responses/exists___404' post: operationId: index.1 x-operation-group: index @@ -10405,7 +11963,7 @@ paths: operationId: field_caps.2 x-operation-group: field_caps x-version-added: '1.0' - description: Returns the information about the capabilities of fields among multiple indices. + description: Returns the information about the capabilities of fields among multiple indexes. externalDocs: url: https://opensearch.org/docs/latest/field-types/supported-field-types/alias/#using-aliases-in-field-capabilities-api-operations parameters: @@ -10429,7 +11987,7 @@ paths: operationId: field_caps.3 x-operation-group: field_caps x-version-added: '1.0' - description: Returns the information about the capabilities of fields among multiple indices. + description: Returns the information about the capabilities of fields among multiple indexes. externalDocs: url: https://opensearch.org/docs/latest/field-types/supported-field-types/alias/#using-aliases-in-field-capabilities-api-operations parameters: @@ -10454,7 +12012,7 @@ paths: operationId: indices.flush.2 x-operation-group: indices.flush x-version-added: '1.0' - description: Performs the flush operation on one or more indices. + description: Performs the flush operation on one or more indexes. externalDocs: url: https://opensearch.org/docs/latest parameters: @@ -10476,7 +12034,7 @@ paths: operationId: indices.flush.3 x-operation-group: indices.flush x-version-added: '1.0' - description: Performs the flush operation on one or more indices. + description: Performs the flush operation on one or more indexes. externalDocs: url: https://opensearch.org/docs/latest parameters: @@ -10499,7 +12057,7 @@ paths: operationId: indices.forcemerge.1 x-operation-group: indices.forcemerge x-version-added: '1.0' - description: Performs the force merge operation on one or more indices. + description: Performs the force merge operation on one or more indexes. externalDocs: url: https://opensearch.org/docs/latest parameters: @@ -10525,7 +12083,7 @@ paths: operationId: indices.get_mapping.1 x-operation-group: indices.get_mapping x-version-added: '1.0' - description: Returns mappings for one or more indices. + description: Returns mappings for one or more indexes. externalDocs: url: https://opensearch.org/docs/latest/field-types/index/#get-a-mapping parameters: @@ -10940,7 +12498,7 @@ paths: operationId: indices.refresh.2 x-operation-group: indices.refresh x-version-added: '1.0' - description: Performs the refresh operation in one or more indices. + description: Performs the refresh operation in one or more indexes. externalDocs: url: https://opensearch.org/docs/latest/tuning-your-cluster/availability-and-recovery/remote-store/index/#refresh-level-and-request-level-durability parameters: @@ -10960,7 +12518,7 @@ paths: operationId: indices.refresh.3 x-operation-group: indices.refresh x-version-added: '1.0' - description: Performs the refresh operation in one or more indices. + description: Performs the refresh operation in one or more indexes. externalDocs: url: https://opensearch.org/docs/latest/tuning-your-cluster/availability-and-recovery/remote-store/index/#refresh-level-and-request-level-durability parameters: @@ -11120,7 +12678,7 @@ paths: operationId: search_shards.2 x-operation-group: search_shards x-version-added: '1.0' - description: Returns information about the indices and shards that a search request would be executed against. + description: Returns information about the indexes and shards that a search request would be executed against. externalDocs: url: https://opensearch.org/docs/latest parameters: @@ -11143,7 +12701,7 @@ paths: operationId: search_shards.3 x-operation-group: search_shards x-version-added: '1.0' - description: Returns information about the indices and shards that a search request would be executed against. + description: Returns information about the indexes and shards that a search request would be executed against. externalDocs: url: https://opensearch.org/docs/latest parameters: @@ -11280,7 +12838,7 @@ paths: operationId: indices.get_settings.2 x-operation-group: indices.get_settings x-version-added: '1.0' - description: Returns settings for one or more indices. + description: Returns settings for one or more indexes. externalDocs: url: https://opensearch.org/docs/latest/api-reference/index-apis/get-settings/ parameters: @@ -11333,7 +12891,7 @@ paths: operationId: indices.get_settings.3 x-operation-group: indices.get_settings x-version-added: '1.0' - description: Returns settings for one or more indices. + description: Returns settings for one or more indexes. externalDocs: url: https://opensearch.org/docs/latest/api-reference/index-apis/get-settings/ parameters: @@ -11360,7 +12918,7 @@ paths: operationId: indices.shard_stores.1 x-operation-group: indices.shard_stores x-version-added: '1.0' - description: Provides store information for shard copies of indices. + description: Provides store information for shard copies of indexes. externalDocs: url: https://opensearch.org/docs/latest parameters: @@ -11460,6 +13018,8 @@ paths: responses: '200': $ref: '#/components/responses/get_source___200' + '404': + $ref: '#/components/responses/get_source___404' head: operationId: exists_source.0 x-operation-group: exists_source @@ -11487,6 +13047,8 @@ paths: responses: '200': $ref: '#/components/responses/exists_source___200' + '404': + $ref: '#/components/responses/exists_source___404' /{index}/_split/{target}: post: operationId: indices.split.0 @@ -11815,7 +13377,8 @@ paths: operationId: indices.get_upgrade.1 x-operation-group: indices.get_upgrade x-version-added: '1.0' - description: The _upgrade API is no longer useful and will be removed. + x-version-deprecated: '1.0' + description: The `_upgrade` API is no longer useful and will be removed. externalDocs: url: https://opensearch.org/docs/latest parameters: @@ -11835,7 +13398,8 @@ paths: operationId: indices.upgrade.1 x-operation-group: indices.upgrade x-version-added: '1.0' - description: The _upgrade API is no longer useful and will be removed. + x-version-deprecated: '1.0' + description: The `_upgrade` API is no longer useful and will be removed. externalDocs: url: https://opensearch.org/docs/latest parameters: @@ -11921,7 +13485,7 @@ paths: operationId: asynchronous_search.search.0_superseded x-operation-group: asynchronous_search.search x-version-added: '1.0' - description: Perform an asynchronous search. + description: Performs an asynchronous search. externalDocs: url: https://opensearch.org/docs/latest/search-plugins/async/index/#rest-api parameters: @@ -11946,7 +13510,7 @@ paths: operationId: asynchronous_search.stats.0_superseded x-operation-group: asynchronous_search.stats x-version-added: '1.0' - description: Monitoring of asynchronous searches that are running, completed, and/or persisted. + description: Monitors any asynchronous searches that are `running`, `completed`, or `persisted`. externalDocs: url: https://opensearch.org/docs/latest/search-plugins/async/index/#monitor-stats responses: @@ -11965,7 +13529,7 @@ paths: operationId: asynchronous_search.get.0_superseded x-operation-group: asynchronous_search.get x-version-added: '1.0' - description: Get partial responses from asynchronous search. + description: Gets partial responses from an asynchronous search. externalDocs: url: https://opensearch.org/docs/latest/search-plugins/async/index/#get-partial-results parameters: @@ -11984,7 +13548,7 @@ paths: operationId: asynchronous_search.delete.0_superseded x-operation-group: asynchronous_search.delete x-version-added: '1.0' - description: Delete asynchronous search. + description: Deletes any responses from an asynchronous search. externalDocs: url: https://opensearch.org/docs/latest/search-plugins/async/index/#delete-searches-and-results parameters: @@ -12089,7 +13653,7 @@ paths: get: operationId: ism.explain_policy.0_superseded x-operation-group: ism.explain_policy - description: Gets the currently applied policy on indices. + description: Gets the currently applied policy on indexes. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/ism/api/#explain-index requestBody: @@ -12108,7 +13672,7 @@ paths: post: operationId: ism.explain_policy.1_superseded x-operation-group: ism.explain_policy - description: Gets the currently applied policy on indices. + description: Gets the currently applied policy on indexes. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/ism/api/#explain-index requestBody: @@ -12128,7 +13692,7 @@ paths: get: operationId: ism.explain_policy.3_superseded x-operation-group: ism.explain_policy - description: Gets the currently applied policy on indices. + description: Gets the currently applied policy on indexes. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/ism/api/#explain-index parameters: @@ -12148,7 +13712,7 @@ paths: post: operationId: ism.explain_policy.4_superseded x-operation-group: ism.explain_policy - description: Gets the currently applied policy on indices. + description: Gets the currently applied policy on indexes. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/ism/api/#explain-index parameters: @@ -12567,8 +14131,8 @@ paths: externalDocs: url: https://opensearch.org/docs/latest/im-plugin/index-rollups/rollup-api/#create-or-update-an-index-rollup-job responses: - '200': - $ref: '#/components/responses/rollups.put___200' + '201': + $ref: '#/components/responses/rollups.put___201' parameters: - $ref: '#/components/parameters/rollups.put___path.id' - $ref: '#/components/parameters/rollups.put___query.if_primary_term' @@ -12971,6 +14535,8 @@ paths: responses: '200': $ref: '#/components/responses/security.create_user___200' + '201': + $ref: '#/components/responses/security.create_user___201' deprecated: true x-ignorable: true patch: @@ -13309,7 +14875,7 @@ paths: x-distributions-excluded: - amazon-managed - amazon-serverless - description: A PATCH call is used to update the existing configuration using the REST API. Only accessible by admins and users with rest api access and only when put or patch is enabled. + description: A `PATCH` call is used to update the existing configuration using the REST API. Only accessible by admins and users with REST API access and only when put or patch is enabled. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#patch-configuration requestBody: @@ -13335,7 +14901,7 @@ paths: x-distributions-excluded: - amazon-managed - amazon-serverless - description: Adds or updates the existing configuration using the REST API. Only accessible by admins and users with rest api access and only when put or patch is enabled. + description: Adds or updates the existing configuration using the REST API. Only accessible by admins and users with REST API access and only when put or patch is enabled. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#update-configuration requestBody: @@ -13481,6 +15047,8 @@ paths: responses: '200': $ref: '#/components/responses/security.update_distinguished_name___200' + '201': + $ref: '#/components/responses/security.update_distinguished_name___201' '400': $ref: '#/components/responses/security.update_distinguished_name___400' '403': @@ -13831,7 +15399,7 @@ paths: x-distributions-excluded: - amazon-managed - amazon-serverless - description: Generates authorization token for the given user. Legacy API. Not Implemented. + description: Generates authorization token for the given user. Legacy API. Not Implemented. parameters: - $ref: '#/components/parameters/security.generate_user_token_legacy___path.username' - $ref: '#/components/parameters/_global___query.pretty' @@ -13898,7 +15466,7 @@ paths: x-distributions-excluded: - amazon-managed - amazon-serverless - description: Creates or replaces the allowlisted APIs. Accessible via Super Admin certificate or REST API permission. + description: Creates or replaces the permitted APIs. Accessible using Super Admin certificate or REST API permission. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#access-control-for-the-api requestBody: @@ -14401,11 +15969,7 @@ components: in: query description: Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-". schema: - oneOf: - - type: string - - type: array - items: - type: string + $ref: '#/components/schemas/_common___StringOrStringArray' x-global: true asynchronous_search.delete___path.id: name: id @@ -14422,25 +15986,28 @@ components: asynchronous_search.search___query.index: name: index in: query - description: The name of the index to be searched. + description: The name of the index to be searched. Can be an individual name, a comma-separated list of indexes, or a wildcard expression of index names. schema: type: string asynchronous_search.search___query.keep_alive: name: keep_alive in: query - description: The amount of time that the result is saved in the cluster. + description: |- + The amount of time that the result is saved in the cluster. For example, `2d` means that the results are stored in the cluster for 48 hours. + The saved search results are deleted after this period or if the search is canceled. Note that this includes the query execution time. + If the query exceeds this amount of time, the process cancels this query automatically. schema: type: string asynchronous_search.search___query.keep_on_completion: name: keep_on_completion in: query - description: Whether you want to save the results in the cluster after the search is complete. + description: Whether to save the results in the cluster after the search is complete. You can examine the stored results at a later time. schema: type: boolean asynchronous_search.search___query.wait_for_completion_timeout: name: wait_for_completion_timeout in: query - description: The amount of time that you plan to wait for the results. + description: The amount of time to wait for the results. You can poll the remaining results based on an ID. The maximum value is 300 seconds. Default is `1s`. schema: type: string bulk_stream___path.index: @@ -14635,7 +16202,6 @@ components: cat.aliases___path.name: in: path name: name - description: A comma-separated list of aliases to retrieve. Supports wildcards (`*`). To retrieve all aliases, omit this parameter or use `*` or `_all`. required: true schema: $ref: '#/components/schemas/_common___Names' @@ -14643,118 +16209,117 @@ components: cat.aliases___query.expand_wildcards: in: query name: expand_wildcards - description: Whether to expand wildcard expression to concrete indices that are open, closed or both. schema: $ref: '#/components/schemas/_common___ExpandWildcards' style: form cat.aliases___query.format: name: format in: query - description: A short version of the Accept header, e.g. json, yaml. + description: A short version of the `Accept` header, such as `json` or `yaml`. schema: type: string - description: A short version of the Accept header, e.g. json, yaml. + description: A short version of the `Accept` header, such as `json` or `yaml`. cat.aliases___query.h: name: h in: query - description: Comma-separated list of column names to display. + description: A comma-separated list of column names to display. style: form schema: type: array items: type: string - description: Comma-separated list of column names to display. + description: A comma-separated list of column names to display. explode: true cat.aliases___query.help: name: help in: query - description: Return help information. + description: Returns help information. schema: - description: Return help information. + description: Returns help information. type: boolean default: false cat.aliases___query.local: name: local in: query - description: Return local information, do not retrieve the state from cluster-manager node. + description: Whether to return information from the local node only instead of from the cluster manager node. schema: type: boolean default: false - description: Return local information, do not retrieve the state from cluster-manager node. + description: Whether to return information from the local node only instead of from the cluster manager node. cat.aliases___query.s: name: s in: query - description: Comma-separated list of column names or column aliases to sort by. + description: A comma-separated list of column names or column aliases to sort by. style: form schema: type: array items: type: string - description: Comma-separated list of column names or column aliases to sort by. + description: A comma-separated list of column names or column aliases to sort by. explode: true cat.aliases___query.v: name: v in: query - description: Verbose mode. Display column headers. + description: Enables verbose mode, which displays column headers. schema: type: boolean default: false - description: Verbose mode. Display column headers. + description: Enables verbose mode, which displays column headers. cat.all_pit_segments___query.bytes: name: bytes in: query - description: The unit in which to display byte values. + description: The units used to display byte values. schema: $ref: '#/components/schemas/_common___ByteUnit' cat.all_pit_segments___query.format: name: format in: query - description: A short version of the Accept header, e.g. json, yaml. + description: A short version of the `Accept` header, such as `json` or `yaml`. schema: type: string - description: A short version of the Accept header, e.g. json, yaml. + description: A short version of the `Accept` header, such as `json` or `yaml`. cat.all_pit_segments___query.h: name: h in: query - description: Comma-separated list of column names to display. + description: A comma-separated list of column names to display. style: form schema: type: array items: type: string - description: Comma-separated list of column names to display. + description: A comma-separated list of column names to display. explode: true cat.all_pit_segments___query.help: name: help in: query - description: Return help information. + description: Returns help information. schema: type: boolean default: false - description: Return help information. + description: Returns help information. cat.all_pit_segments___query.s: name: s in: query - description: Comma-separated list of column names or column aliases to sort by. + description: A comma-separated list of column names or column aliases to sort by. style: form schema: type: array items: type: string - description: Comma-separated list of column names or column aliases to sort by. + description: A comma-separated list of column names or column aliases to sort by. explode: true cat.all_pit_segments___query.v: name: v in: query - description: Verbose mode. Display column headers. + description: Enables verbose mode, which displays column headers. schema: type: boolean default: false - description: Verbose mode. Display column headers. + description: Enables verbose mode, which displays column headers. cat.allocation___path.node_id: in: path name: node_id - description: Comma-separated list of node identifiers or names used to limit the returned information. + description: A comma-separated list of node IDs or names used to limit the returned information. required: true schema: $ref: '#/components/schemas/_common___NodeIds' @@ -14762,154 +16327,154 @@ components: cat.allocation___query.bytes: in: query name: bytes - description: The unit used to display byte values. + description: The units used to display byte values. schema: $ref: '#/components/schemas/_common___ByteUnit' style: form cat.allocation___query.cluster_manager_timeout: name: cluster_manager_timeout in: query - description: Operation timeout for connection to cluster-manager node. + description: A timeout for connection to the cluster manager node. schema: $ref: '#/components/schemas/_common___Duration' x-version-added: '2.0' cat.allocation___query.format: name: format in: query - description: A short version of the Accept header, e.g. json, yaml. + description: A short version of the HTTP `Accept` header, such as `json` or `yaml`. schema: type: string - description: A short version of the Accept header, e.g. json, yaml. + description: A short version of the HTTP `Accept` header, such as `json` or `yaml`. cat.allocation___query.h: name: h in: query - description: Comma-separated list of column names to display. + description: A comma-separated list of column names to display. style: form schema: type: array items: type: string - description: Comma-separated list of column names to display. + description: A comma-separated list of column names to display. explode: true cat.allocation___query.help: name: help in: query - description: Return help information. + description: Returns help information. schema: type: boolean default: false - description: Return help information. + description: Returns help information. cat.allocation___query.local: name: local in: query - description: Return local information, do not retrieve the state from cluster-manager node. + description: Returns local information but does not retrieve the state from cluster-manager node. schema: type: boolean default: false - description: Return local information, do not retrieve the state from cluster-manager node. + description: Returns local information but does not retrieve the state from cluster-manager node. cat.allocation___query.master_timeout: name: master_timeout in: query - description: Operation timeout for connection to master node. + description: A timeout for connection to the cluster manager node. schema: $ref: '#/components/schemas/_common___Duration' x-version-deprecated: '2.0' - x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. deprecated: true cat.allocation___query.s: name: s in: query - description: Comma-separated list of column names or column aliases to sort by. + description: A comma-separated list of column names or column aliases to sort by. style: form schema: type: array items: type: string - description: Comma-separated list of column names or column aliases to sort by. + description: A comma-separated list of column names or column aliases to sort by. explode: true cat.allocation___query.v: name: v in: query - description: Verbose mode. Display column headers. + description: Enables verbose mode, which displays column headers. schema: type: boolean default: false - description: Verbose mode. Display column headers. + description: Enables verbose mode, which displays column headers. cat.cluster_manager___query.cluster_manager_timeout: name: cluster_manager_timeout in: query - description: Operation timeout for connection to cluster-manager node. + description: A timeout for connection to the cluster manager node. schema: $ref: '#/components/schemas/_common___Duration' x-version-added: '2.0' cat.cluster_manager___query.format: name: format in: query - description: A short version of the Accept header, e.g. json, yaml. + description: A short version of the HTTP `Accept` header, such as `json` or `yaml`. schema: type: string - description: A short version of the Accept header, e.g. json, yaml. + description: A short version of the HTTP `Accept` header, such as `json` or `yaml`. cat.cluster_manager___query.h: name: h in: query - description: Comma-separated list of column names to display. + description: A comma-separated list of column names to display. style: form schema: type: array items: type: string - description: Comma-separated list of column names to display. + description: A comma-separated list of column names to display. explode: true cat.cluster_manager___query.help: name: help in: query - description: Return help information. + description: Returns help information. schema: type: boolean default: false - description: Return help information. + description: Returns help information. cat.cluster_manager___query.local: name: local in: query - description: Return local information, do not retrieve the state from cluster-manager node. + description: Returns local information but does not retrieve the state from the cluster manager node. schema: type: boolean default: false - description: Return local information, do not retrieve the state from cluster-manager node. + description: Returns local information but does not retrieve the state from the cluster manager node. cat.cluster_manager___query.master_timeout: name: master_timeout in: query - description: Operation timeout for connection to master node. + description: A timeout for connection to the cluster manager node. schema: $ref: '#/components/schemas/_common___Duration' x-version-deprecated: '2.0' - x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. deprecated: true cat.cluster_manager___query.s: name: s in: query - description: Comma-separated list of column names or column aliases to sort by. + description: A comma-separated list of column names or column aliases to sort by. style: form schema: type: array items: type: string - description: Comma-separated list of column names or column aliases to sort by. + description: A comma-separated list of column names or column aliases to sort by. explode: true cat.cluster_manager___query.v: name: v in: query - description: Verbose mode. Display column headers. + description: Enables verbose mode, which displays column headers. schema: type: boolean default: false - description: Verbose mode. Display column headers. + description: Enables verbose mode, which displays column headers. cat.count___path.index: in: path name: index description: |- - Comma-separated list of data streams, indices, and aliases used to limit the request. - Supports wildcards (`*`). To target all data streams and indices, omit this parameter or use `*` or `_all`. + Comma-separated list of data streams, indexes, and aliases used to limit the request. + Supports wildcards (`*`). To target all data streams and indexes, omit this parameter or use `*` or `_all`. required: true schema: $ref: '#/components/schemas/_common___Indices' @@ -14917,53 +16482,53 @@ components: cat.count___query.format: name: format in: query - description: A short version of the Accept header, e.g. json, yaml. + description: A short version of the `Accept` header, such as `json` or `yaml`. schema: type: string - description: A short version of the Accept header, e.g. json, yaml. + description: A short version of the `Accept` header, such as `json` or `yaml`. cat.count___query.h: name: h in: query - description: Comma-separated list of column names to display. + description: A comma-separated list of column names to display. style: form schema: type: array items: type: string - description: Comma-separated list of column names to display. + description: A comma-separated list of column names to display. explode: true cat.count___query.help: name: help in: query - description: Return help information. + description: Returns help information. schema: type: boolean default: false - description: Return help information. + description: Returns help information. cat.count___query.s: name: s in: query - description: Comma-separated list of column names or column aliases to sort by. + description: A comma-separated list of column names or column aliases to sort by. style: form schema: type: array items: type: string - description: Comma-separated list of column names or column aliases to sort by. + description: A comma-separated list of column names or column aliases to sort by. explode: true cat.count___query.v: name: v in: query - description: Verbose mode. Display column headers. + description: Enables verbose mode, which displays column headers. schema: type: boolean default: false - description: Verbose mode. Display column headers. + description: Enables verbose mode, which displays column headers. cat.fielddata___path.fields: in: path name: fields description: |- - Comma-separated list of fields used to limit returned information. + A comma-separated list of fields used to limit the amount of returned information. To retrieve all fields, omit this parameter. required: true schema: @@ -14972,98 +16537,98 @@ components: cat.fielddata___query.bytes: in: query name: bytes - description: The unit used to display byte values. + description: The units used to display byte values. schema: $ref: '#/components/schemas/_common___ByteUnit' style: form cat.fielddata___query.fields: in: query name: fields - description: Comma-separated list of fields used to limit returned information. + description: A comma-separated list of fields used to limit the amount of returned information. schema: $ref: '#/components/schemas/_common___Fields' style: form cat.fielddata___query.format: name: format in: query - description: A short version of the Accept header, e.g. json, yaml. + description: A short version of the `Accept` header, such as `json` or `yaml`. schema: type: string - description: A short version of the Accept header, e.g. json, yaml. + description: A short version of the `Accept` header, such as `json` or `yaml`. cat.fielddata___query.h: name: h in: query - description: Comma-separated list of column names to display. + description: A comma-separated list of column names to display. style: form schema: type: array items: type: string - description: Comma-separated list of column names to display. + description: A comma-separated list of column names to display. explode: true cat.fielddata___query.help: name: help in: query - description: Return help information. + description: Returns help information. schema: type: boolean default: false - description: Return help information. + description: Returns help information. cat.fielddata___query.s: name: s in: query - description: Comma-separated list of column names or column aliases to sort by. + description: A comma-separated list of column names or column aliases to sort by. style: form schema: type: array items: type: string - description: Comma-separated list of column names or column aliases to sort by. + description: A comma-separated list of column names or column aliases to sort by. explode: true cat.fielddata___query.v: name: v in: query - description: Verbose mode. Display column headers. + description: Enables verbose mode, which displays column headers. schema: type: boolean default: false - description: Verbose mode. Display column headers. + description: Enables verbose mode, which displays column headers. cat.health___query.format: name: format in: query - description: A short version of the Accept header, e.g. json, yaml. + description: A short version of the `Accept` header, such as `json` or `yaml`. schema: type: string - description: A short version of the Accept header, e.g. json, yaml. + description: A short version of the `Accept` header, such as `json` or `yaml`. cat.health___query.h: name: h in: query - description: Comma-separated list of column names to display. + description: A comma-separated list of column names to display. style: form schema: type: array items: type: string - description: Comma-separated list of column names to display. + description: A comma-separated list of column names to display. explode: true cat.health___query.help: name: help in: query - description: Return help information. + description: Returns help information. schema: type: boolean default: false - description: Return help information. + description: Returns help information. cat.health___query.s: name: s in: query - description: Comma-separated list of column names or column aliases to sort by. + description: A comma-separated list of column names or column aliases to sort by. style: form schema: type: array items: type: string - description: Comma-separated list of column names or column aliases to sort by. + description: A comma-separated list of column names or column aliases to sort by. explode: true cat.health___query.time: in: query @@ -15075,7 +16640,7 @@ components: cat.health___query.ts: in: query name: ts - description: If true, returns `HH:MM:SS` and Unix epoch timestamps. + description: When `true`, returns `HH:MM:SS` and Unix epoch timestamps. schema: type: boolean default: true @@ -15083,17 +16648,17 @@ components: cat.health___query.v: name: v in: query - description: Verbose mode. Display column headers. + description: Enables verbose mode, which displays column headers. schema: type: boolean default: false - description: Verbose mode. Display column headers. + description: Enables verbose mode, which displays column headers. cat.indices___path.index: in: path name: index description: |- - Comma-separated list of data streams, indices, and aliases used to limit the request. - Supports wildcards (`*`). To target all data streams and indices, omit this parameter or use `*` or `_all`. + A comma-separated list of data streams, indexes, and aliases used to limit the request. + Supports wildcards (`*`). To target all data streams and indexes, omit this parameter or use `*` or `_all`. required: true schema: $ref: '#/components/schemas/_common___Indices' @@ -15101,61 +16666,60 @@ components: cat.indices___query.bytes: in: query name: bytes - description: The unit used to display byte values. + description: The units used to display byte values. schema: $ref: '#/components/schemas/_common___ByteUnit' style: form cat.indices___query.cluster_manager_timeout: name: cluster_manager_timeout in: query - description: Operation timeout for connection to cluster-manager node. + description: The amount of time allowed to establish a connection to the cluster manager node. schema: $ref: '#/components/schemas/_common___Duration' x-version-added: '2.0' cat.indices___query.expand_wildcards: in: query name: expand_wildcards - description: The type of index that wildcard patterns can match. schema: $ref: '#/components/schemas/_common___ExpandWildcards' style: form cat.indices___query.format: name: format in: query - description: A short version of the Accept header, e.g. json, yaml. + description: A short version of the `Accept` header, such as `json` or `yaml`. schema: type: string - description: A short version of the Accept header, e.g. json, yaml. + description: A short version of the `Accept` header, such as `json` or `yaml`. cat.indices___query.h: name: h in: query - description: Comma-separated list of column names to display. + description: A comma-separated list of column names to display. style: form schema: type: array items: type: string - description: Comma-separated list of column names to display. + description: A comma-separated list of column names to display. explode: true cat.indices___query.health: in: query name: health - description: The health status used to limit returned indices. By default, the response includes indices of any health status. + description: Limits indexes based on their health status. Supported values are `green`, `yellow`, and `red`. schema: $ref: '#/components/schemas/_common___HealthStatus' style: form cat.indices___query.help: name: help in: query - description: Return help information. + description: Returns help information. schema: type: boolean default: false - description: Return help information. + description: Returns help information. cat.indices___query.include_unloaded_segments: in: query name: include_unloaded_segments - description: If true, the response includes information from segments that are not loaded into memory. + description: Whether to include information from segments not loaded into memory. schema: type: boolean default: false @@ -15163,24 +16727,24 @@ components: cat.indices___query.local: name: local in: query - description: Return local information, do not retrieve the state from cluster-manager node. + description: Returns local information but does not retrieve the state from the cluster manager node. schema: type: boolean default: false - description: Return local information, do not retrieve the state from cluster-manager node. + description: Returns local information but does not retrieve the state from the cluster manager node. cat.indices___query.master_timeout: name: master_timeout in: query - description: Operation timeout for connection to master node. + description: The amount of time allowed to establish a connection to the cluster manager node. schema: $ref: '#/components/schemas/_common___Duration' x-version-deprecated: '2.0' - x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. deprecated: true cat.indices___query.pri: in: query name: pri - description: If true, the response only includes information from primary shards. + description: When `true`, returns information only from the primary shards. schema: type: boolean default: false @@ -15188,463 +16752,461 @@ components: cat.indices___query.s: name: s in: query - description: Comma-separated list of column names or column aliases to sort by. + description: A comma-separated list of column names or column aliases to sort by. style: form schema: type: array items: type: string - description: Comma-separated list of column names or column aliases to sort by. + description: A comma-separated list of column names or column aliases to sort by. explode: true cat.indices___query.time: in: query name: time - description: The unit used to display time values. + description: Specifies the time units. schema: $ref: '#/components/schemas/_common___TimeUnit' style: form cat.indices___query.v: name: v in: query - description: Verbose mode. Display column headers. + description: Enables verbose mode, which displays column headers. schema: type: boolean default: false - description: Verbose mode. Display column headers. + description: Enables verbose mode, which displays column headers. cat.master___query.cluster_manager_timeout: name: cluster_manager_timeout in: query - description: Operation timeout for connection to cluster-manager node. + description: The amount of time allowed to establish a connection to the cluster manager node. schema: $ref: '#/components/schemas/_common___Duration' x-version-added: '2.0' cat.master___query.format: name: format in: query - description: A short version of the Accept header, e.g. json, yaml. + description: A short version of the `Accept` header, such as `json` or `yaml`. schema: type: string - description: A short version of the Accept header, e.g. json, yaml. + description: A short version of the `Accept` header, such as `json` or `yaml`. cat.master___query.h: name: h in: query - description: Comma-separated list of column names to display. + description: A comma-separated list of column names to display. style: form schema: type: array items: type: string - description: Comma-separated list of column names to display. + description: A comma-separated list of column names to display. explode: true cat.master___query.help: name: help in: query - description: Return help information. + description: Returns help information. schema: type: boolean default: false - description: Return help information. + description: Returns help information. cat.master___query.local: name: local in: query - description: Return local information, do not retrieve the state from cluster-manager node. + description: Returns local information but does not retrieve the state from the cluster manager node. schema: type: boolean default: false - description: Return local information, do not retrieve the state from cluster-manager node. + description: Returns local information but does not retrieve the state from the cluster manager node. cat.master___query.master_timeout: name: master_timeout in: query - description: Operation timeout for connection to master node. + description: The amount of time allowed to establish a connection to the cluster manager node. schema: $ref: '#/components/schemas/_common___Duration' x-version-deprecated: '2.0' - x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. deprecated: true cat.master___query.s: name: s in: query - description: Comma-separated list of column names or column aliases to sort by. + description: A comma-separated list of column names or column aliases to sort by. style: form schema: type: array items: type: string - description: Comma-separated list of column names or column aliases to sort by. + description: A comma-separated list of column names or column aliases to sort by. explode: true cat.master___query.v: name: v in: query - description: Verbose mode. Display column headers. + description: Enables verbose mode, which displays column headers. schema: type: boolean default: false - description: Verbose mode. Display column headers. + description: Enables verbose mode, which displays column headers. cat.nodeattrs___query.cluster_manager_timeout: name: cluster_manager_timeout in: query - description: Operation timeout for connection to cluster-manager node. + description: The amount of time allowed to establish a connection to the cluster manager node. schema: $ref: '#/components/schemas/_common___Duration' x-version-added: '2.0' cat.nodeattrs___query.format: name: format in: query - description: A short version of the Accept header, e.g. json, yaml. + description: A short version of the `Accept` header, such as `json` or `yaml`. schema: type: string - description: A short version of the Accept header, e.g. json, yaml. + description: A short version of the `Accept` header, such as `json` or `yaml`. cat.nodeattrs___query.h: name: h in: query - description: Comma-separated list of column names to display. + description: A comma-separated list of column names to display. style: form schema: type: array items: type: string - description: Comma-separated list of column names to display. + description: A comma-separated list of column names to display. explode: true cat.nodeattrs___query.help: name: help in: query - description: Return help information. + description: Returns help information. schema: type: boolean default: false - description: Return help information. + description: Returns help information. cat.nodeattrs___query.local: name: local in: query - description: Return local information, do not retrieve the state from cluster-manager node. + description: Returns local information but does not retrieve the state from the cluster manager node. schema: type: boolean default: false - description: Return local information, do not retrieve the state from cluster-manager node. + description: Returns local information but does not retrieve the state from the cluster manager node. cat.nodeattrs___query.master_timeout: name: master_timeout in: query - description: Operation timeout for connection to master node. + description: The amount of time allowed to establish a connection to the cluster manager node. schema: $ref: '#/components/schemas/_common___Duration' x-version-deprecated: '2.0' - x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. deprecated: true cat.nodeattrs___query.s: name: s in: query - description: Comma-separated list of column names or column aliases to sort by. + description: A comma-separated list of column names or column aliases to sort by. style: form schema: type: array items: type: string - description: Comma-separated list of column names or column aliases to sort by. + description: A comma-separated list of column names or column aliases to sort by. explode: true cat.nodeattrs___query.v: name: v in: query - description: Verbose mode. Display column headers. + description: Enables verbose mode, which displays column headers. schema: type: boolean default: false - description: Verbose mode. Display column headers. + description: Enables verbose mode, which displays column headers. cat.nodes___query.bytes: in: query name: bytes - description: The unit used to display byte values. + description: The units used to display byte values. schema: $ref: '#/components/schemas/_common___ByteUnit' style: form cat.nodes___query.cluster_manager_timeout: name: cluster_manager_timeout in: query - description: Operation timeout for connection to cluster-manager node. + description: The amount of time allowed to establish a connection to the cluster manager node. schema: $ref: '#/components/schemas/_common___Duration' x-version-added: '2.0' cat.nodes___query.format: name: format in: query - description: A short version of the Accept header, e.g. json, yaml. + description: A short version of the `Accept` header, such as `json` or `yaml`. schema: type: string - description: A short version of the Accept header, e.g. json, yaml. + description: A short version of the `Accept` header, such as `json` or `yaml`. cat.nodes___query.full_id: in: query name: full_id - description: If `true`, return the full node ID. If `false`, return the shortened node ID. + description: When `true`, returns the full node ID. When `false`, returns the shortened node ID. schema: - anyOf: - - type: boolean - - type: string + $ref: '#/components/schemas/_common___StringifiedBoolean' default: false style: form cat.nodes___query.h: name: h in: query - description: Comma-separated list of column names to display. + description: A comma-separated list of column names to display. style: form schema: type: array items: type: string - description: Comma-separated list of column names to display. + description: A comma-separated list of column names to display. explode: true cat.nodes___query.help: name: help in: query - description: Return help information. + description: Returns help information. schema: type: boolean default: false - description: Return help information. + description: Returns help information. cat.nodes___query.local: name: local in: query - description: Return local information, do not retrieve the state from cluster-manager node. + description: Returns local information but does not retrieve the state from the cluster manager node. deprecated: true x-version-deprecated: '1.0' x-deprecation-message: This parameter does not cause this API to act locally. schema: type: boolean default: false - description: Return local information, do not retrieve the state from cluster-manager node. + description: Returns local information but does not retrieve the state from the cluster manager node. cat.nodes___query.master_timeout: name: master_timeout in: query - description: Operation timeout for connection to master node. + description: The amount of time allowed to establish a connection to the cluster manager node. schema: $ref: '#/components/schemas/_common___Duration' x-version-deprecated: '2.0' - x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. deprecated: true cat.nodes___query.s: name: s in: query - description: Comma-separated list of column names or column aliases to sort by. + description: A comma-separated list of column names or column aliases to sort by. style: form schema: type: array items: type: string - description: Comma-separated list of column names or column aliases to sort by. + description: A comma-separated list of column names or column aliases to sort by. explode: true cat.nodes___query.time: name: time in: query - description: The unit in which to display time values. + description: Specifies the time units, for example, `5d` or `7h`. For more information, see [Supported units](https://opensearch.org/docs/latest/api-reference/units/). schema: $ref: '#/components/schemas/_common___TimeUnit' cat.nodes___query.v: name: v in: query - description: Verbose mode. Display column headers. + description: Enables verbose mode, which displays column headers. schema: type: boolean default: false - description: Verbose mode. Display column headers. + description: Enables verbose mode, which displays column headers. cat.pending_tasks___query.cluster_manager_timeout: name: cluster_manager_timeout in: query - description: Operation timeout for connection to cluster-manager node. + description: The amount of time allowed to establish a connection to the cluster manager node. schema: $ref: '#/components/schemas/_common___Duration' x-version-added: '2.0' cat.pending_tasks___query.format: name: format in: query - description: A short version of the Accept header, e.g. json, yaml. + description: A short version of the `Accept` header, such as `json` or `yaml`. schema: type: string - description: A short version of the Accept header, e.g. json, yaml. + description: A short version of the `Accept` header, such as `json` or `yaml`. cat.pending_tasks___query.h: name: h in: query - description: Comma-separated list of column names to display. + description: A comma-separated list of column names to display. style: form schema: type: array items: type: string - description: Comma-separated list of column names to display. + description: A comma-separated list of column names to display. explode: true cat.pending_tasks___query.help: name: help in: query - description: Return help information. + description: Returns help information. schema: type: boolean default: false - description: Return help information. + description: Returns help information. cat.pending_tasks___query.local: name: local in: query - description: Return local information, do not retrieve the state from cluster-manager node. + description: Returns local information but does not retrieve the state from the cluster manager node. schema: type: boolean default: false - description: Return local information, do not retrieve the state from cluster-manager node. + description: Returns local information but does not retrieve the state from the cluster manager node. cat.pending_tasks___query.master_timeout: name: master_timeout in: query - description: Operation timeout for connection to master node. + description: The amount of time allowed to establish a connection to the cluster manager node. schema: $ref: '#/components/schemas/_common___Duration' x-version-deprecated: '2.0' - x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. deprecated: true cat.pending_tasks___query.s: name: s in: query - description: Comma-separated list of column names or column aliases to sort by. + description: A comma-separated list of column names or column aliases to sort by. style: form schema: type: array items: type: string - description: Comma-separated list of column names or column aliases to sort by. + description: A comma-separated list of column names or column aliases to sort by. explode: true cat.pending_tasks___query.time: name: time in: query - description: The unit in which to display time values. + description: Specifies the time units, for example, `5d` or `7h`. For more information, see [Supported units](https://opensearch.org/docs/latest/api-reference/units/). schema: $ref: '#/components/schemas/_common___TimeUnit' cat.pending_tasks___query.v: name: v in: query - description: Verbose mode. Display column headers. + description: Enables verbose mode, which displays column headers. schema: type: boolean default: false - description: Verbose mode. Display column headers. + description: Enables verbose mode, which displays column headers. cat.pit_segments___query.bytes: name: bytes in: query - description: The unit in which to display byte values. + description: The units used to display byte values. schema: $ref: '#/components/schemas/_common___ByteUnit' cat.pit_segments___query.format: name: format in: query - description: A short version of the Accept header, e.g. json, yaml. + description: A short version of the `Accept` header, such as `json` or `yaml`. schema: type: string - description: A short version of the Accept header, e.g. json, yaml. + description: A short version of the `Accept` header, such as `json` or `yaml`. cat.pit_segments___query.h: name: h in: query - description: Comma-separated list of column names to display. + description: A comma-separated list of column names to display. style: form schema: type: array items: type: string - description: Comma-separated list of column names to display. + description: A comma-separated list of column names to display. explode: true cat.pit_segments___query.help: name: help in: query - description: Return help information. + description: Returns help information. schema: type: boolean default: false - description: Return help information. + description: Returns help information. cat.pit_segments___query.s: name: s in: query - description: Comma-separated list of column names or column aliases to sort by. + description: A comma-separated list of column names or column aliases to sort by. style: form schema: type: array items: type: string - description: Comma-separated list of column names or column aliases to sort by. + description: A comma-separated list of column names or column aliases to sort by. explode: true cat.pit_segments___query.v: name: v in: query - description: Verbose mode. Display column headers. + description: Enables verbose mode, which displays column headers. schema: type: boolean default: false - description: Verbose mode. Display column headers. + description: Enables verbose mode, which displays column headers. cat.plugins___query.cluster_manager_timeout: name: cluster_manager_timeout in: query - description: Operation timeout for connection to cluster-manager node. + description: The amount of time allowed to establish a connection to the cluster manager node. schema: $ref: '#/components/schemas/_common___Duration' x-version-added: '2.0' cat.plugins___query.format: name: format in: query - description: A short version of the Accept header, e.g. json, yaml. + description: A short version of the `Accept` header, such as `json` or `yaml`. schema: type: string - description: A short version of the Accept header, e.g. json, yaml. + description: A short version of the `Accept` header, such as `json` or `yaml`. cat.plugins___query.h: name: h in: query - description: Comma-separated list of column names to display. + description: A comma-separated list of column names to display. style: form schema: type: array items: type: string - description: Comma-separated list of column names to display. + description: A comma-separated list of column names to display. explode: true cat.plugins___query.help: name: help in: query - description: Return help information. + description: Returns help information. schema: type: boolean default: false - description: Return help information. + description: Returns help information. cat.plugins___query.local: name: local in: query - description: Return local information, do not retrieve the state from cluster-manager node. + description: Returns local information but does not retrieve the state from the cluster manager node. schema: type: boolean default: false - description: Return local information, do not retrieve the state from cluster-manager node. + description: Returns local information but does not retrieve the state from the cluster manager node. cat.plugins___query.master_timeout: name: master_timeout in: query - description: Operation timeout for connection to master node. + description: The amount of time allowed to establish a connection to the cluster manager node. schema: $ref: '#/components/schemas/_common___Duration' x-version-deprecated: '2.0' - x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. deprecated: true cat.plugins___query.s: name: s in: query - description: Comma-separated list of column names or column aliases to sort by. + description: A comma-separated list of column names or column aliases to sort by. style: form schema: type: array items: type: string - description: Comma-separated list of column names or column aliases to sort by. + description: A comma-separated list of column names or column aliases to sort by. explode: true cat.plugins___query.v: name: v in: query - description: Verbose mode. Display column headers. + description: Enables verbose mode, which displays column headers. schema: type: boolean default: false - description: Verbose mode. Display column headers. + description: Enables verbose mode, which displays column headers. cat.recovery___path.index: in: path name: index description: |- - A comma-separated list of data streams, indices, and aliases used to limit the request. - Supports wildcards (`*`). To target all data streams and indices, omit this parameter or use `*` or `_all`. + A comma-separated list of data streams, indexes, and aliases used to limit the request. + Supports wildcards (`*`). To target all data streams and indexes, omit this parameter or use `*` or `_all`. required: true schema: $ref: '#/components/schemas/_common___Indices' @@ -15660,14 +17222,14 @@ components: cat.recovery___query.bytes: in: query name: bytes - description: The unit used to display byte values. + description: The units used to display byte values. schema: $ref: '#/components/schemas/_common___ByteUnit' style: form cat.recovery___query.detailed: in: query name: detailed - description: If `true`, the response includes detailed information about shard recoveries. + description: When `true`, includes detailed information about shard recoveries. schema: type: boolean default: false @@ -15675,287 +17237,298 @@ components: cat.recovery___query.format: name: format in: query - description: A short version of the Accept header, e.g. json, yaml. + description: A short version of the `Accept` header, such as `json` or `yaml`. schema: type: string - description: A short version of the Accept header, e.g. json, yaml. + description: A short version of the `Accept` header, such as `json` or `yaml`. cat.recovery___query.h: name: h in: query - description: Comma-separated list of column names to display. + description: A comma-separated list of column names to display. style: form schema: type: array items: type: string - description: Comma-separated list of column names to display. + description: A comma-separated list of column names to display. explode: true cat.recovery___query.help: name: help in: query - description: Return help information. + description: Returns help information. schema: type: boolean default: false - description: Return help information. + description: Returns help information. cat.recovery___query.index: name: index in: query - description: Comma-separated list or wildcard expression of index names to limit the returned information. + description: |- + A comma-separated list of data streams, indexes, and aliases used to limit the request. + Supports wildcards (`*`). To target all data streams and indexes, omit this parameter or use `*` or `_all`. style: form schema: type: array items: type: string - description: Comma-separated list or wildcard expression of index names to limit the returned information. + description: |- + A comma-separated list of data streams, indexes, and aliases used to limit the request. + Supports wildcards (`*`). To target all data streams and indexes, omit this parameter or use `*` or `_all`. explode: true cat.recovery___query.s: name: s in: query - description: Comma-separated list of column names or column aliases to sort by. + description: A comma-separated list of column names or column aliases to sort by. style: form schema: type: array items: type: string - description: Comma-separated list of column names or column aliases to sort by. + description: A comma-separated list of column names or column aliases to sort by. explode: true cat.recovery___query.time: name: time in: query - description: The unit in which to display time values. + description: Specifies the time units, for example, `5d` or `7h`. For more information, see [Supported units](https://opensearch.org/docs/latest/api-reference/units/). schema: $ref: '#/components/schemas/_common___TimeUnit' cat.recovery___query.v: name: v in: query - description: Verbose mode. Display column headers. + description: Enables verbose mode, which displays column headers. schema: type: boolean default: false - description: Verbose mode. Display column headers. + description: Enables verbose mode, which displays column headers. cat.repositories___query.cluster_manager_timeout: name: cluster_manager_timeout in: query - description: Operation timeout for connection to cluster-manager node. + description: The amount of time allowed to establish a connection to the cluster manager node. schema: $ref: '#/components/schemas/_common___Duration' x-version-added: '2.0' cat.repositories___query.format: name: format in: query - description: A short version of the Accept header, e.g. json, yaml. + description: A short version of the `Accept` header, such as `json` or `yaml`. schema: type: string - description: A short version of the Accept header, e.g. json, yaml. + description: A short version of the `Accept` header, such as `json` or `yaml`. cat.repositories___query.h: name: h in: query - description: Comma-separated list of column names to display. + description: A comma-separated list of column names to display. style: form schema: type: array items: type: string - description: Comma-separated list of column names to display. + description: A comma-separated list of column names to display. explode: true cat.repositories___query.help: name: help in: query - description: Return help information. + description: Returns help information. schema: type: boolean default: false - description: Return help information. + description: Returns help information. cat.repositories___query.local: name: local in: query - description: Return local information, do not retrieve the state from cluster-manager node. + description: Returns local information but does not retrieve the state from the cluster manager node. schema: type: boolean default: false - description: Return local information, do not retrieve the state from cluster-manager node. + description: Returns local information but does not retrieve the state from the cluster manager node. cat.repositories___query.master_timeout: name: master_timeout in: query - description: Operation timeout for connection to master node. + description: The amount of time allowed to establish a connection to the cluster manager node. schema: $ref: '#/components/schemas/_common___Duration' x-version-deprecated: '2.0' - x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. deprecated: true cat.repositories___query.s: name: s in: query - description: Comma-separated list of column names or column aliases to sort by. + description: A comma-separated list of column names or column aliases to sort by. style: form schema: type: array items: type: string - description: Comma-separated list of column names or column aliases to sort by. + description: A comma-separated list of column names or column aliases to sort by. explode: true cat.repositories___query.v: name: v in: query - description: Verbose mode. Display column headers. + description: Enables verbose mode, which displays column headers. schema: type: boolean default: false - description: Verbose mode. Display column headers. + description: Enables verbose mode, which displays column headers. cat.segment_replication___path.index: name: index in: path - description: Comma-separated list or wildcard expression of index names to limit the returned information. + description: |- + A comma-separated list of data streams, indexes, and aliases used to limit the request. + Supports wildcards (`*`). To target all data streams and indexes, omit this parameter or use `*` or `_all`. schema: type: array - description: Comma-separated list or wildcard expression of index names to limit the returned information. + description: |- + A comma-separated list of data streams, indexes, and aliases used to limit the request. + Supports wildcards (`*`). To target all data streams and indexes, omit this parameter or use `*` or `_all`. items: type: string required: true cat.segment_replication___query.active_only: name: active_only in: query - description: If `true`, the response only includes ongoing segment replication events. + description: When `true`, the response only includes ongoing segment replication events. schema: type: boolean default: false - description: If `true`, the response only includes ongoing segment replication events. + description: When `true`, the response only includes ongoing segment replication events. cat.segment_replication___query.allow_no_indices: name: allow_no_indices in: query - description: Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified). + description: Whether to ignore the index if a wildcard index expression resolves to no concrete indexes. This includes the `_all` string or when no indexes have been specified. schema: type: boolean - description: Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified). + description: Whether to ignore the index if a wildcard index expression resolves to no concrete indexes. This includes the `_all` string or when no indexes have been specified. cat.segment_replication___query.bytes: name: bytes in: query - description: The unit in which to display byte values. + description: The units used to display byte values. schema: $ref: '#/components/schemas/_common___ByteUnit' cat.segment_replication___query.completed_only: name: completed_only in: query - description: If `true`, the response only includes latest completed segment replication events. + description: When `true`, the response only includes the last-completed segment replication events. schema: type: boolean default: false - description: If `true`, the response only includes latest completed segment replication events. + description: When `true`, the response only includes the last-completed segment replication events. cat.segment_replication___query.detailed: name: detailed in: query - description: If `true`, the response includes detailed information about segment replications. + description: When `true`, the response includes additional metrics for each stage of a segment replication event. schema: type: boolean default: false - description: If `true`, the response includes detailed information about segment replications. + description: When `true`, the response includes additional metrics for each stage of a segment replication event. cat.segment_replication___query.expand_wildcards: name: expand_wildcards in: query - description: Whether to expand wildcard expression to concrete indices that are open, closed or both. schema: $ref: '#/components/schemas/_common___ExpandWildcards' cat.segment_replication___query.format: name: format in: query - description: A short version of the Accept header, e.g. json, yaml. + description: A short version of the `Accept` header, such as `json` or `yaml`. schema: type: string - description: A short version of the Accept header, e.g. json, yaml. + description: A short version of the `Accept` header, such as `json` or `yaml`. cat.segment_replication___query.h: name: h in: query - description: Comma-separated list of column names to display. + description: A comma-separated list of column names to display. style: form schema: type: array items: type: string - description: Comma-separated list of column names to display. + description: A comma-separated list of column names to display. explode: true cat.segment_replication___query.help: name: help in: query - description: Return help information. + description: Returns help information. schema: type: boolean default: false - description: Return help information. + description: Returns help information. cat.segment_replication___query.ignore_throttled: name: ignore_throttled in: query - description: Whether specified concrete, expanded or aliased indices should be ignored when throttled. + description: Whether specified concrete, expanded, or aliased indexes should be ignored when throttled. schema: type: boolean - description: Whether specified concrete, expanded or aliased indices should be ignored when throttled. + description: Whether specified concrete, expanded, or aliased indexes should be ignored when throttled. cat.segment_replication___query.ignore_unavailable: name: ignore_unavailable in: query - description: Whether specified concrete indices should be ignored when unavailable (missing or closed). + description: Whether the specified concrete indexes should be ignored when missing or closed. schema: type: boolean - description: Whether specified concrete indices should be ignored when unavailable (missing or closed). + description: Whether the specified concrete indexes should be ignored when missing or closed. cat.segment_replication___query.index: name: index in: query - description: Comma-separated list or wildcard expression of index names to limit the returned information. + description: |- + A comma-separated list of data streams, indexes, and aliases used to limit the request. + Supports wildcards (`*`). To target all data streams and indexes, omit this parameter or use `*` or `_all`. style: form schema: type: array items: type: string - description: Comma-separated list or wildcard expression of index names to limit the returned information. + description: |- + A comma-separated list of data streams, indexes, and aliases used to limit the request. + Supports wildcards (`*`). To target all data streams and indexes, omit this parameter or use `*` or `_all`. explode: true cat.segment_replication___query.s: name: s in: query - description: Comma-separated list of column names or column aliases to sort by. + description: A comma-separated list of column names or column aliases to sort by. style: form schema: type: array items: type: string - description: Comma-separated list of column names or column aliases to sort by. + description: A comma-separated list of column names or column aliases to sort by. explode: true cat.segment_replication___query.shards: name: shards in: query - description: Comma-separated list of shards to display. + description: A comma-separated list of shards to display. style: form schema: type: array items: type: string - description: Comma-separated list of shards to display. + description: A comma-separated list of shards to display. explode: true cat.segment_replication___query.time: name: time in: query - description: The unit in which to display time values. + description: Specifies the time units, for example, `5d` or `7h`. For more information, see [Supported units](https://opensearch.org/docs/latest/api-reference/units/). schema: $ref: '#/components/schemas/_common___TimeUnit' cat.segment_replication___query.timeout: name: timeout in: query - description: Operation timeout. + description: The operation timeout. schema: $ref: '#/components/schemas/_common___Duration' cat.segment_replication___query.v: name: v in: query - description: Verbose mode. Display column headers. + description: Enables verbose mode, which displays column headers. schema: type: boolean default: false - description: Verbose mode. Display column headers. + description: Enables verbose mode, which displays column headers. cat.segments___path.index: in: path name: index description: |- - A comma-separated list of data streams, indices, and aliases used to limit the request. + A comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (`*`). - To target all data streams and indices, omit this parameter or use `*` or `_all`. + To target all data streams and indexes, omit this parameter or use `*` or `_all`. required: true schema: $ref: '#/components/schemas/_common___Indices' @@ -15963,78 +17536,74 @@ components: cat.segments___query.bytes: in: query name: bytes - description: The unit used to display byte values. + description: The units used to display byte values. schema: $ref: '#/components/schemas/_common___ByteUnit' style: form cat.segments___query.cluster_manager_timeout: name: cluster_manager_timeout in: query - description: Operation timeout for connection to cluster-manager node. + description: The amount of time allowed to establish a connection to the cluster manager node. schema: $ref: '#/components/schemas/_common___Duration' x-version-added: '2.0' cat.segments___query.format: name: format in: query - description: A short version of the Accept header, e.g. json, yaml. + description: A short version of the `Accept` header, such as `json` or `yaml`. schema: type: string - description: A short version of the Accept header, e.g. json, yaml. + description: A short version of the `Accept` header, such as `json` or `yaml`. cat.segments___query.h: name: h in: query - description: Comma-separated list of column names to display. + description: A comma-separated list of column names to display. style: form schema: type: array items: type: string - description: Comma-separated list of column names to display. + description: A comma-separated list of column names to display. explode: true cat.segments___query.help: name: help in: query - description: Return help information. + description: Returns help information. schema: type: boolean default: false - description: Return help information. + description: Returns help information. cat.segments___query.master_timeout: name: master_timeout in: query - description: Operation timeout for connection to master node. + description: The amount of time allowed to establish a connection to the cluster manager node. schema: $ref: '#/components/schemas/_common___Duration' x-version-deprecated: '2.0' - x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. deprecated: true cat.segments___query.s: name: s in: query - description: Comma-separated list of column names or column aliases to sort by. + description: A comma-separated list of column names or column aliases to sort by. style: form schema: type: array items: type: string - description: Comma-separated list of column names or column aliases to sort by. + description: A comma-separated list of column names or column aliases to sort by. explode: true cat.segments___query.v: name: v in: query - description: Verbose mode. Display column headers. + description: Enables verbose mode, which displays column headers. schema: type: boolean default: false - description: Verbose mode. Display column headers. + description: Enables verbose mode, which displays column headers. cat.shards___path.index: in: path name: index - description: |- - A comma-separated list of data streams, indices, and aliases used to limit the request. - Supports wildcards (`*`). - To target all data streams and indices, omit this parameter or use `*` or `_all`. required: true schema: $ref: '#/components/schemas/_common___Indices' @@ -16042,85 +17611,84 @@ components: cat.shards___query.bytes: in: query name: bytes - description: The unit used to display byte values. + description: The units used to display byte values. schema: $ref: '#/components/schemas/_common___ByteUnit' style: form cat.shards___query.cluster_manager_timeout: name: cluster_manager_timeout in: query - description: Operation timeout for connection to cluster-manager node. + description: The amount of time allowed to establish a connection to the cluster manager node. schema: $ref: '#/components/schemas/_common___Duration' x-version-added: '2.0' cat.shards___query.format: name: format in: query - description: A short version of the Accept header, e.g. json, yaml. + description: A short version of the `Accept` header, such as `json` or `yaml`. schema: type: string - description: A short version of the Accept header, e.g. json, yaml. + description: A short version of the `Accept` header, such as `json` or `yaml`. cat.shards___query.h: name: h in: query - description: Comma-separated list of column names to display. + description: A comma-separated list of column names to display. style: form schema: type: array items: type: string - description: Comma-separated list of column names to display. + description: A comma-separated list of column names to display. explode: true cat.shards___query.help: name: help in: query - description: Return help information. + description: Returns help information. schema: type: boolean default: false - description: Return help information. + description: Returns help information. cat.shards___query.local: name: local in: query - description: Return local information, do not retrieve the state from cluster-manager node. + description: Returns local information but does not retrieve the state from the cluster manager node. schema: type: boolean default: false - description: Return local information, do not retrieve the state from cluster-manager node. + description: Returns local information but does not retrieve the state from the cluster manager node. cat.shards___query.master_timeout: name: master_timeout in: query - description: Operation timeout for connection to master node. + description: The amount of time allowed to establish a connection to the cluster manager node. schema: $ref: '#/components/schemas/_common___Duration' x-version-deprecated: '2.0' - x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. deprecated: true cat.shards___query.s: name: s in: query - description: Comma-separated list of column names or column aliases to sort by. + description: A comma-separated list of column names or column aliases to sort by. style: form schema: type: array items: type: string - description: Comma-separated list of column names or column aliases to sort by. + description: A comma-separated list of column names or column aliases to sort by. explode: true cat.shards___query.time: name: time in: query - description: The unit in which to display time values. schema: $ref: '#/components/schemas/_common___TimeUnit' cat.shards___query.v: name: v in: query - description: Verbose mode. Display column headers. + description: Enables verbose mode, which displays column headers. schema: type: boolean default: false - description: Verbose mode. Display column headers. + description: Enables verbose mode, which displays column headers. cat.snapshots___path.repository: in: path name: repository @@ -16136,40 +17704,40 @@ components: cat.snapshots___query.cluster_manager_timeout: name: cluster_manager_timeout in: query - description: Operation timeout for connection to cluster-manager node. + description: The amount of time allowed to establish a connection to the cluster manager node. schema: $ref: '#/components/schemas/_common___Duration' x-version-added: '2.0' cat.snapshots___query.format: name: format in: query - description: A short version of the Accept header, e.g. json, yaml. + description: A short version of the `Accept` header, such as `json` or `yaml`. schema: type: string - description: A short version of the Accept header, e.g. json, yaml. + description: A short version of the `Accept` header, such as `json` or `yaml`. cat.snapshots___query.h: name: h in: query - description: Comma-separated list of column names to display. + description: A comma-separated list of column names to display. style: form schema: type: array items: type: string - description: Comma-separated list of column names to display. + description: A comma-separated list of column names to display. explode: true cat.snapshots___query.help: name: help in: query - description: Return help information. + description: Returns help information. schema: type: boolean default: false - description: Return help information. + description: Returns help information. cat.snapshots___query.ignore_unavailable: in: query name: ignore_unavailable - description: If `true`, the response does not include information from unavailable snapshots. + description: When `true`, the response does not include information from unavailable snapshots. schema: type: boolean default: false @@ -16177,41 +17745,52 @@ components: cat.snapshots___query.master_timeout: name: master_timeout in: query - description: Operation timeout for connection to master node. + description: The amount of time allowed to establish a connection to the cluster manager node. schema: $ref: '#/components/schemas/_common___Duration' x-version-deprecated: '2.0' - x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. deprecated: true + cat.snapshots___query.repository: + in: query + name: repository + description: |- + A comma-separated list of snapshot repositories used to limit the request. + Accepts wildcard expressions. + `_all` returns all repositories. + If any repository fails during the request, OpenSearch returns an error. + required: true + schema: + $ref: '#/components/schemas/_common___Names' cat.snapshots___query.s: name: s in: query - description: Comma-separated list of column names or column aliases to sort by. + description: A comma-separated list of column names or column aliases to sort by. style: form schema: type: array items: type: string - description: Comma-separated list of column names or column aliases to sort by. + description: A comma-separated list of column names or column aliases to sort by. explode: true cat.snapshots___query.time: name: time in: query - description: The unit in which to display time values. + description: Specifies the time units, for example, `5d` or `7h`. For more information, see [Supported units](https://opensearch.org/docs/latest/api-reference/units/). schema: $ref: '#/components/schemas/_common___TimeUnit' cat.snapshots___query.v: name: v in: query - description: Verbose mode. Display column headers. + description: Enables verbose mode, which displays column headers. schema: type: boolean default: false - description: Verbose mode. Display column headers. + description: Enables verbose mode, which displays column headers. cat.tasks___query.actions: in: query name: actions - description: The task action names, which are used to limit the response. + description: The task action names used to limit the response. schema: type: array items: @@ -16228,40 +17807,43 @@ components: cat.tasks___query.format: name: format in: query - description: A short version of the Accept header, e.g. json, yaml. + description: A short version of the `Accept` header, such as `json` or `yaml`. schema: type: string - description: A short version of the Accept header, e.g. json, yaml. + description: A short version of the `Accept` header, such as `json` or `yaml`. cat.tasks___query.h: name: h in: query - description: Comma-separated list of column names to display. + description: A comma-separated list of column names to display. style: form schema: type: array items: type: string - description: Comma-separated list of column names to display. + description: A comma-separated list of column names to display. explode: true cat.tasks___query.help: name: help in: query - description: Return help information. + description: Returns help information. schema: type: boolean default: false - description: Return help information. + description: Returns help information. cat.tasks___query.nodes: name: nodes in: query - description: Comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes. + description: |- + A comma-separated list of node IDs or names used to limit the returned information. + Use `_local` to return information from the node to which you're connecting, specify a specific node from which to get information, or keep the parameter empty to get information from all nodes. style: form schema: type: array items: type: string - description: Comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes. - explode: true + description: |- + A comma-separated list of node IDs or names used to limit the returned information. + Use `_local` to return information from the node to which you're connecting, specify a specific node from which to get information, or keep the parameter empty to get information from all nodes. cat.tasks___query.parent_task_id: in: query name: parent_task_id @@ -16272,28 +17854,28 @@ components: cat.tasks___query.s: name: s in: query - description: Comma-separated list of column names or column aliases to sort by. + description: A comma-separated list of column names or column aliases to sort by. style: form schema: type: array items: type: string - description: Comma-separated list of column names or column aliases to sort by. + description: A comma-separated list of column names or column aliases to sort by. explode: true cat.tasks___query.time: name: time in: query - description: The unit in which to display time values. + description: Specifies the time units, for example, `5d` or `7h`. For more information, see [Supported units](https://opensearch.org/docs/latest/api-reference/units/). schema: $ref: '#/components/schemas/_common___TimeUnit' cat.tasks___query.v: name: v in: query - description: Verbose mode. Display column headers. + description: Enables verbose mode, which displays column headers. schema: type: boolean default: false - description: Verbose mode. Display column headers. + description: Enables verbose mode, which displays column headers. cat.templates___path.name: in: path name: name @@ -16307,72 +17889,72 @@ components: cat.templates___query.cluster_manager_timeout: name: cluster_manager_timeout in: query - description: Operation timeout for connection to cluster-manager node. + description: The amount of time allowed to establish a connection to the cluster manager node. schema: $ref: '#/components/schemas/_common___Duration' x-version-added: '2.0' cat.templates___query.format: name: format in: query - description: A short version of the Accept header, e.g. json, yaml. + description: A short version of the `Accept` header, such as `json` or `yaml`. schema: type: string - description: A short version of the Accept header, e.g. json, yaml. + description: A short version of the `Accept` header, such as `json` or `yaml`. cat.templates___query.h: name: h in: query - description: Comma-separated list of column names to display. + description: A comma-separated list of column names to display. style: form schema: type: array items: type: string - description: Comma-separated list of column names to display. + description: A comma-separated list of column names to display. explode: true cat.templates___query.help: name: help in: query - description: Return help information. + description: Returns help information. schema: type: boolean default: false - description: Return help information. + description: Returns help information. cat.templates___query.local: name: local in: query - description: Return local information, do not retrieve the state from cluster-manager node. + description: Returns local information but does not retrieve the state from the cluster manager node. schema: type: boolean default: false - description: Return local information, do not retrieve the state from cluster-manager node. + description: Returns local information but does not retrieve the state from the cluster manager node. cat.templates___query.master_timeout: name: master_timeout in: query - description: Operation timeout for connection to master node. + description: The amount of time allowed to establish a connection to the cluster manager node. schema: $ref: '#/components/schemas/_common___Duration' x-version-deprecated: '2.0' - x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. deprecated: true cat.templates___query.s: name: s in: query - description: Comma-separated list of column names or column aliases to sort by. + description: A comma-separated list of column names or column aliases to sort by. style: form schema: type: array items: type: string - description: Comma-separated list of column names or column aliases to sort by. + description: A comma-separated list of column names or column aliases to sort by. explode: true cat.templates___query.v: name: v in: query - description: Verbose mode. Display column headers. + description: Enables verbose mode, which displays column headers. schema: type: boolean default: false - description: Verbose mode. Display column headers. + description: Enables verbose mode, which displays column headers. cat.thread_pool___path.thread_pool_patterns: in: path name: thread_pool_patterns @@ -16386,63 +17968,63 @@ components: cat.thread_pool___query.cluster_manager_timeout: name: cluster_manager_timeout in: query - description: Operation timeout for connection to cluster-manager node. + description: A timeout for connection to the cluster manager node. schema: $ref: '#/components/schemas/_common___Duration' x-version-added: '2.0' cat.thread_pool___query.format: name: format in: query - description: A short version of the Accept header, e.g. json, yaml. + description: A short version of the `Accept` header, such as `json` or `yaml`. schema: type: string - description: A short version of the Accept header, e.g. json, yaml. + description: A short version of the `Accept` header, such as `json` or `yaml`. cat.thread_pool___query.h: name: h in: query - description: Comma-separated list of column names to display. + description: A comma-separated list of column names to display. style: form schema: type: array items: type: string - description: Comma-separated list of column names to display. + description: A comma-separated list of column names to display. explode: true cat.thread_pool___query.help: name: help in: query - description: Return help information. + description: Returns help information. schema: type: boolean default: false - description: Return help information. + description: Returns help information. cat.thread_pool___query.local: name: local in: query - description: Return local information, do not retrieve the state from cluster-manager node. + description: Returns local information but does not retrieve the state from the cluster manager node. schema: type: boolean default: false - description: Return local information, do not retrieve the state from cluster-manager node. + description: Returns local information but does not retrieve the state from the cluster manager node. cat.thread_pool___query.master_timeout: name: master_timeout in: query - description: Operation timeout for connection to master node. + description: The amount of time allowed to establish a connection to the cluster manager node. schema: $ref: '#/components/schemas/_common___Duration' x-version-deprecated: '2.0' - x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. deprecated: true cat.thread_pool___query.s: name: s in: query - description: Comma-separated list of column names or column aliases to sort by. + description: A comma-separated list of column names or column aliases to sort by. style: form schema: type: array items: type: string - description: Comma-separated list of column names or column aliases to sort by. + description: A comma-separated list of column names or column aliases to sort by. explode: true cat.thread_pool___query.size: name: size @@ -16455,11 +18037,11 @@ components: cat.thread_pool___query.v: name: v in: query - description: Verbose mode. Display column headers. + description: Enables verbose mode, which displays column headers. schema: type: boolean default: false - description: Verbose mode. Display column headers. + description: Enables verbose mode, which displays column headers. clear_scroll___path.scroll_id: in: path name: scroll_id @@ -16474,7 +18056,7 @@ components: cluster.allocation_explain___query.include_disk_info: in: query name: include_disk_info - description: If true, returns information about disk usage and shard sizes. + description: When `true`, returns information about disk usage and shard sizes. schema: type: boolean default: false @@ -16482,7 +18064,7 @@ components: cluster.allocation_explain___query.include_yes_decisions: in: query name: include_yes_decisions - description: If true, returns YES decisions in explanation. + description: When `true`, returns any `YES` decisions in the allocation explanation. schema: type: boolean default: false @@ -16491,8 +18073,8 @@ components: in: path name: name description: |- - Name of the component template to delete. - Wildcard (*) expressions are supported. + The name of the component template to delete. + Supports wildcard (*) expressions. required: true schema: $ref: '#/components/schemas/_common___Name' @@ -16507,21 +18089,15 @@ components: cluster.delete_component_template___query.master_timeout: in: query name: master_timeout - description: |- - Period to wait for a connection to the master node. - If no response is received before the timeout expires, the request fails and returns an error. deprecated: true schema: $ref: '#/components/schemas/_common___Duration' style: form x-version-deprecated: '2.0' - x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. cluster.delete_component_template___query.timeout: in: query name: timeout - description: |- - Period to wait for a response. - If no response is received before the timeout expires, the request fails and returns an error. schema: $ref: '#/components/schemas/_common___Duration' style: form @@ -16531,8 +18107,8 @@ components: description: |- Specifies whether to wait for all excluded nodes to be removed from the cluster before clearing the voting configuration exclusions list. - Defaults to true, meaning that all excluded nodes must be removed from - the cluster before this API takes any action. If set to false then the + When `true`, all excluded nodes are removed from + the cluster before this API takes any action. When `false`, the voting configuration exclusions list is cleared even if some excluded nodes are still in the cluster. schema: @@ -16543,7 +18119,7 @@ components: in: path name: name description: |- - Name of the component template to check existence of. + The name of the component template. Wildcard (*) expressions are supported. required: true schema: @@ -16552,7 +18128,6 @@ components: cluster.exists_component_template___query.cluster_manager_timeout: name: cluster_manager_timeout in: query - description: Operation timeout for connection to cluster-manager node. schema: $ref: '#/components/schemas/_common___Duration' x-version-added: '2.0' @@ -16560,8 +18135,8 @@ components: in: query name: local description: |- - If true, the request retrieves information from the local node only. - Defaults to false, which means information is retrieved from the master node. + When `true`, the request retrieves information from the local node only. + When `false, information is retrieved from the cluster manager node. schema: type: boolean default: false @@ -16569,21 +18144,17 @@ components: cluster.exists_component_template___query.master_timeout: in: query name: master_timeout - description: |- - Period to wait for a connection to the master node. If no response is - received before the timeout expires, the request fails and returns an - error. deprecated: true schema: $ref: '#/components/schemas/_common___Duration' style: form x-version-deprecated: '2.0' - x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. cluster.get_component_template___path.name: in: path name: name description: |- - Name of the component template to retrieve. + The name of the component template to retrieve. Wildcard (`*`) expressions are supported. required: true schema: @@ -16592,16 +18163,23 @@ components: cluster.get_component_template___query.cluster_manager_timeout: name: cluster_manager_timeout in: query - description: Operation timeout for connection to cluster-manager node. schema: $ref: '#/components/schemas/_common___Duration' x-version-added: '2.0' + cluster.get_component_template___query.flat_settings: + in: query + name: flat_settings + description: If `true`, returns settings in flat format. + schema: + type: boolean + default: false + style: form cluster.get_component_template___query.local: in: query name: local description: |- - If `true`, the request retrieves information from the local node only. - If `false`, information is retrieved from the master node. + When `true`, the request retrieves information from the local node only. + When `false`, information is retrieved from the cluster manager node. schema: type: boolean default: false @@ -16609,34 +18187,30 @@ components: cluster.get_component_template___query.master_timeout: in: query name: master_timeout - description: |- - Period to wait for a connection to the master node. - If no response is received before the timeout expires, the request fails and returns an error. deprecated: true schema: $ref: '#/components/schemas/_common___Duration' style: form x-version-deprecated: '2.0' - x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. cluster.get_decommission_awareness___path.awareness_attribute_name: name: awareness_attribute_name in: path - description: Awareness attribute name. + description: The name of the awareness attribute. schema: type: string - description: Awareness attribute name. + description: The name of the awareness attribute. required: true cluster.get_settings___query.cluster_manager_timeout: name: cluster_manager_timeout in: query - description: Operation timeout for connection to cluster-manager node. schema: $ref: '#/components/schemas/_common___Duration' x-version-added: '2.0' cluster.get_settings___query.flat_settings: in: query name: flat_settings - description: If `true`, returns settings in flat format. + description: When `true`, returns cluster settings in a flat format. schema: type: boolean default: false @@ -16644,7 +18218,7 @@ components: cluster.get_settings___query.include_defaults: in: query name: include_defaults - description: If `true`, returns default cluster settings from the local node. + description: When `true`, returns default cluster settings from the local node. schema: type: boolean default: false @@ -16652,36 +18226,29 @@ components: cluster.get_settings___query.master_timeout: in: query name: master_timeout - description: |- - Period to wait for a connection to the master node. - If no response is received before the timeout expires, the request fails and returns an error. deprecated: true schema: $ref: '#/components/schemas/_common___Duration' style: form x-version-deprecated: '2.0' - x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. cluster.get_settings___query.timeout: in: query name: timeout - description: |- - Period to wait for a response. - If no response is received before the timeout expires, the request fails and returns an error. schema: $ref: '#/components/schemas/_common___Duration' style: form cluster.get_weighted_routing___path.attribute: name: attribute in: path - description: Awareness attribute name. + description: The name of the awareness attribute. schema: type: string - description: Awareness attribute name. + description: The name of the awareness attribute. required: true cluster.health___path.index: in: path name: index - description: Comma-separated list of data streams, indices, and index aliases used to limit the request. Wildcard expressions (*) are supported. To target all data streams and indices in a cluster, omit this parameter or use `_all` or `*`. required: true schema: $ref: '#/components/schemas/_common___Indices' @@ -16689,35 +18256,33 @@ components: cluster.health___query.awareness_attribute: name: awareness_attribute in: query - description: The awareness attribute for which the health is required. + description: The name of the awareness attribute for which to return the cluster health status (for example, `zone`). Applicable only if `level` is set to `awareness_attributes`. schema: type: string - description: The awareness attribute for which the health is required. + description: The name of the awareness attribute for which to return the cluster health status (for example, `zone`). Applicable only if `level` is set to `awareness_attributes`. cluster.health___query.cluster_manager_timeout: name: cluster_manager_timeout in: query - description: Operation timeout for connection to cluster-manager node. schema: $ref: '#/components/schemas/_common___Duration' x-version-added: '2.0' cluster.health___query.expand_wildcards: in: query name: expand_wildcards - description: Whether to expand wildcard expression to concrete indices that are open, closed or both. schema: $ref: '#/components/schemas/_common___ExpandWildcards' style: form cluster.health___query.level: in: query name: level - description: Can be one of cluster, indices or shards. Controls the details level of the health information returned. schema: $ref: '#/components/schemas/cluster.health___Level' + default: cluster style: form cluster.health___query.local: in: query name: local - description: If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the master node. + description: Whether to return information from the local node only instead of from the cluster manager node. schema: type: boolean default: false @@ -16725,52 +18290,49 @@ components: cluster.health___query.master_timeout: in: query name: master_timeout - description: Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. deprecated: true schema: $ref: '#/components/schemas/_common___Duration' style: form x-version-deprecated: '2.0' - x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. cluster.health___query.timeout: in: query name: timeout - description: Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. schema: $ref: '#/components/schemas/_common___Duration' style: form cluster.health___query.wait_for_active_shards: in: query name: wait_for_active_shards - description: A number controlling to how many active shards to wait for, all to wait for all shards in the cluster to be active, or 0 to not wait. schema: $ref: '#/components/schemas/_common___WaitForActiveShards' style: form cluster.health___query.wait_for_events: in: query name: wait_for_events - description: Can be one of immediate, urgent, high, normal, low, languid. Wait until all currently queued events with the given priority are processed. schema: $ref: '#/components/schemas/_common___WaitForEvents' style: form cluster.health___query.wait_for_no_initializing_shards: in: query name: wait_for_no_initializing_shards - description: A boolean value which controls whether to wait (until the timeout provided) for the cluster to have no shard initializations. Defaults to false, which means it will not wait for initializing shards. + description: Whether to wait until there are no initializing shards in the cluster. schema: type: boolean + default: false style: form cluster.health___query.wait_for_no_relocating_shards: in: query name: wait_for_no_relocating_shards - description: A boolean value which controls whether to wait (until the timeout provided) for the cluster to have no shard relocations. Defaults to false, which means it will not wait for relocating shards. + description: Whether to wait until there are no relocating shards in the cluster. schema: type: boolean style: form cluster.health___query.wait_for_nodes: in: query name: wait_for_nodes - description: The request waits until the specified number N of nodes is available. It also accepts >=N, <=N, >N and =N`, `<=N`, `>N`, and ` yellow > red. By default, will not wait for any status. + description: Waits until the cluster health reaches the specified status or better. schema: $ref: '#/components/schemas/_common___HealthStatus' style: form cluster.pending_tasks___query.cluster_manager_timeout: name: cluster_manager_timeout in: query - description: Operation timeout for connection to cluster-manager node. schema: $ref: '#/components/schemas/_common___Duration' x-version-added: '2.0' @@ -16794,8 +18355,8 @@ components: in: query name: local description: |- - If `true`, the request retrieves information from the local node only. - If `false`, information is retrieved from the master node. + When `true`, the request retrieves information from the local node only. + When `false`, information is retrieved from the cluster manager node. schema: type: boolean default: false @@ -16803,21 +18364,18 @@ components: cluster.pending_tasks___query.master_timeout: in: query name: master_timeout - description: |- - Period to wait for a connection to the master node. - If no response is received before the timeout expires, the request fails and returns an error. deprecated: true schema: $ref: '#/components/schemas/_common___Duration' style: form x-version-deprecated: '2.0' - x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. cluster.post_voting_config_exclusions___query.node_ids: in: query name: node_ids description: |- - A comma-separated list of the persistent ids of the nodes to exclude - from the voting configuration. If specified, you may not also specify node_names. + A comma-separated list of node IDs to exclude + from the voting configuration. When using this setting, you cannot also specify `node_names`. schema: $ref: '#/components/schemas/_common___Ids' style: form @@ -16825,8 +18383,8 @@ components: in: query name: node_names description: |- - A comma-separated list of the names of the nodes to exclude from the - voting configuration. If specified, you may not also specify node_ids. + A comma-separated list of node names to exclude from the + voting configuration. When using this setting, you cannot also specify `node_ids`. schema: $ref: '#/components/schemas/_common___Names' style: form @@ -16836,7 +18394,7 @@ components: description: |- When adding a voting configuration exclusion, the API waits for the specified nodes to be excluded from the voting configuration before - returning. If the timeout expires before the appropriate condition + returning a response. If the timeout expires before the appropriate condition is satisfied, the request fails and returns an error. schema: $ref: '#/components/schemas/_common___Duration' @@ -16845,11 +18403,11 @@ components: in: path name: name description: |- - Name of the component template to create. + The name of the component template to create. OpenSearch includes the following built-in component templates: `logs-mappings`; 'logs-settings`; `metrics-mappings`; `metrics-settings`;`synthetics-mapping`; `synthetics-settings`. - OpenSearch Agent uses these templates to configure backing indices for its data streams. - If you use OpenSearch Agent and want to overwrite one of these templates, set the `version` for your replacement template higher than the current version. - If you don't use OpenSearch Agent and want to disable all built-in component and index templates, set `stack.templates.enabled` to `false` using the cluster update settings API. + OpenSearch uses these templates to configure backing indexes for its data streams. + If you want to overwrite one of these templates, set the replacement template `version` to a higher value than the current version. + If you 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' @@ -16857,14 +18415,13 @@ components: cluster.put_component_template___query.cluster_manager_timeout: name: cluster_manager_timeout in: query - description: Operation timeout for connection to cluster-manager node. schema: $ref: '#/components/schemas/_common___Duration' x-version-added: '2.0' cluster.put_component_template___query.create: in: query name: create - description: If `true`, this request cannot replace or update existing component templates. + description: When `true`, this request cannot replace or update existing component templates. schema: type: boolean default: false @@ -16872,48 +18429,43 @@ components: cluster.put_component_template___query.master_timeout: in: query name: master_timeout - description: |- - Period to wait for a connection to the master node. - If no response is received before the timeout expires, the request fails and returns an error. deprecated: true schema: $ref: '#/components/schemas/_common___Duration' style: form x-version-deprecated: '2.0' - x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. cluster.put_component_template___query.timeout: name: timeout in: query - description: Operation timeout. schema: $ref: '#/components/schemas/_common___Duration' cluster.put_decommission_awareness___path.awareness_attribute_name: name: awareness_attribute_name in: path - description: Awareness attribute name. + description: The name of the awareness attribute. schema: type: string - description: Awareness attribute name. + description: The name of the awareness attribute. required: true cluster.put_decommission_awareness___path.awareness_attribute_value: name: awareness_attribute_value in: path - description: Awareness attribute value. + description: The value of the awareness attribute. schema: type: string - description: Awareness attribute value. + description: The value of the awareness attribute. required: true cluster.put_settings___query.cluster_manager_timeout: name: cluster_manager_timeout in: query - description: Operation timeout for connection to cluster-manager node. schema: $ref: '#/components/schemas/_common___Duration' x-version-added: '2.0' cluster.put_settings___query.flat_settings: in: query name: flat_settings - description: Return settings in flat format. + description: Returns settings in a flat format. schema: type: boolean default: false @@ -16921,59 +18473,55 @@ components: cluster.put_settings___query.master_timeout: in: query name: master_timeout - description: Explicit operation timeout for connection to master node deprecated: true schema: $ref: '#/components/schemas/_common___Duration' style: form x-version-deprecated: '2.0' - x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. cluster.put_settings___query.timeout: in: query name: timeout - description: Explicit operation timeout schema: $ref: '#/components/schemas/_common___Duration' style: form cluster.put_weighted_routing___path.attribute: name: attribute in: path - description: Awareness attribute name. + description: The name of the awareness attribute. schema: type: string - description: Awareness attribute name. + description: The name of the awareness attribute. required: true cluster.reroute___query.cluster_manager_timeout: name: cluster_manager_timeout in: query - description: Operation timeout for connection to cluster-manager node. schema: $ref: '#/components/schemas/_common___Duration' x-version-added: '2.0' cluster.reroute___query.dry_run: in: query name: dry_run - description: If true, then the request simulates the operation only and returns the resulting state. + description: When `true`, the request simulates the operation and returns the resulting state. schema: type: boolean style: form cluster.reroute___query.explain: in: query name: explain - description: If true, then the response contains an explanation of why the commands can or cannot be executed. + description: When `true`, the response contains an explanation of why certain commands can or cannot be executed. schema: type: boolean style: form cluster.reroute___query.master_timeout: in: query name: master_timeout - description: Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. deprecated: true schema: $ref: '#/components/schemas/_common___Duration' style: form x-version-deprecated: '2.0' - x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. cluster.reroute___query.metric: in: query name: metric @@ -16988,21 +18536,19 @@ components: cluster.reroute___query.retry_failed: in: query name: retry_failed - description: If true, then retries allocation of shards that are blocked due to too many subsequent allocation failures. + description: When `true`, retries shard allocation if it was blocked because of too many subsequent failures. schema: type: boolean style: form cluster.reroute___query.timeout: in: query name: timeout - description: Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. schema: $ref: '#/components/schemas/_common___Duration' style: form cluster.state___path.index: in: path name: index - description: A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices required: true schema: $ref: '#/components/schemas/_common___Indices' @@ -17010,7 +18556,7 @@ components: cluster.state___path.metric: in: path name: metric - description: Limit the information returned to the specified metrics + description: Limits the information returned to only the specified metrics. required: true schema: type: array @@ -17020,28 +18566,26 @@ components: cluster.state___query.allow_no_indices: in: query name: allow_no_indices - description: Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) + description: Whether to ignore a wildcard index expression that resolves into no concrete indexes. This includes the `_all` string or when no indexes have been specified. schema: type: boolean style: form cluster.state___query.cluster_manager_timeout: name: cluster_manager_timeout in: query - description: Operation timeout for connection to cluster-manager node. schema: $ref: '#/components/schemas/_common___Duration' x-version-added: '2.0' cluster.state___query.expand_wildcards: in: query name: expand_wildcards - description: Whether to expand wildcard expression to concrete indices that are open, closed or both. schema: $ref: '#/components/schemas/_common___ExpandWildcards' style: form cluster.state___query.flat_settings: in: query name: flat_settings - description: Return settings in flat format. + description: Returns settings in a flat format. schema: type: boolean default: false @@ -17049,14 +18593,14 @@ components: cluster.state___query.ignore_unavailable: in: query name: ignore_unavailable - description: Whether specified concrete indices should be ignored when unavailable (missing or closed) + description: Whether the specified concrete indexes should be ignored when unavailable (missing or closed). schema: type: boolean style: form cluster.state___query.local: in: query name: local - description: Return local information, do not retrieve the state from cluster-manager node. + description: Whether to return information from the local node only instead of from the cluster manager node. schema: type: boolean default: false @@ -17064,31 +18608,49 @@ components: cluster.state___query.master_timeout: in: query name: master_timeout - description: Specify timeout for connection to master deprecated: true schema: $ref: '#/components/schemas/_common___Duration' style: form x-version-deprecated: '2.0' - x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. cluster.state___query.wait_for_metadata_version: in: query name: wait_for_metadata_version - description: Wait for the metadata version to be equal or greater than the specified metadata version + description: Wait for the metadata version to be equal or greater than the specified metadata version. schema: $ref: '#/components/schemas/_common___VersionNumber' style: form cluster.state___query.wait_for_timeout: in: query name: wait_for_timeout - description: The maximum time to wait for wait_for_metadata_version before timing out + description: The maximum time to wait for `wait_for_metadata_version` before timing out. schema: $ref: '#/components/schemas/_common___Duration' style: form + cluster.stats___path.index_metric: + in: path + name: index_metric + description: A comma-separated list of index metric groups, for example, `docs,store`. + required: true + schema: + type: array + items: + $ref: '#/components/schemas/cluster.stats___IndexMetric' + style: simple + cluster.stats___path.metric: + in: path + name: metric + description: Limit the information returned to the specified metrics. + required: true + schema: + type: array + items: + $ref: '#/components/schemas/cluster.stats___Metric' + style: simple cluster.stats___path.node_id: in: path name: node_id - description: Comma-separated list of node filters used to limit returned information. Defaults to all nodes in the cluster. required: true schema: $ref: '#/components/schemas/_common___NodeIds' @@ -17096,7 +18658,7 @@ components: cluster.stats___query.flat_settings: in: query name: flat_settings - description: If `true`, returns settings in flat format. + description: When `true`, returns settings in a flat format. schema: type: boolean default: false @@ -17105,7 +18667,7 @@ components: in: query name: timeout description: |- - Period to wait for each node to respond. + The amount of time 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. schema: @@ -17115,9 +18677,9 @@ components: in: path name: index description: |- - Comma-separated list of data streams, indices, and aliases to search. + Comma-separated list of data streams, indexes, and aliases to search. Supports wildcards (`*`). - To search all data streams and indices, omit this parameter or use `*` or `_all`. + To search all data streams and indexes, omit this parameter or use `*` or `_all`. required: true schema: $ref: '#/components/schemas/_common___Indices' @@ -17126,8 +18688,8 @@ components: in: query name: allow_no_indices description: |- - If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. - This behavior applies even if the request targets other open indices. + If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indexes. + This behavior applies even if the request targets other open indexes. schema: type: boolean style: form @@ -17171,17 +18733,13 @@ components: count___query.expand_wildcards: in: query name: expand_wildcards - description: |- - Type of index that wildcard patterns can match. - If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. - Supports comma-separated values, such as `open,hidden`. schema: $ref: '#/components/schemas/_common___ExpandWildcards' style: form count___query.ignore_throttled: in: query name: ignore_throttled - description: If `true`, concrete, expanded or aliased indices are ignored when frozen. + description: If `true`, concrete, expanded or aliased indexes are ignored when frozen. schema: type: boolean style: form @@ -17245,10 +18803,10 @@ components: create_pit___path.index: name: index in: path - description: Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices. + description: Comma-separated list of indexes; use `_all` or empty string to perform the operation on all indexes. schema: type: array - description: Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices. + description: Comma-separated list of indexes; use `_all` or empty string to perform the operation on all indexes. items: type: string required: true @@ -17262,7 +18820,7 @@ components: create_pit___query.expand_wildcards: name: expand_wildcards in: query - description: Whether to expand wildcard expression to concrete indices that are open, closed or both. + description: Whether to expand wildcard expression to concrete indexes that are open, closed or both. schema: $ref: '#/components/schemas/_common___ExpandWildcards' create_pit___query.keep_alive: @@ -17368,7 +18926,7 @@ components: dangling_indices.delete_dangling_index___path.index_uuid: in: path name: index_uuid - description: The UUID of the dangling index + description: The UUID of the dangling index. required: true schema: $ref: '#/components/schemas/_common___Uuid' @@ -17376,7 +18934,7 @@ components: dangling_indices.delete_dangling_index___query.accept_data_loss: in: query name: accept_data_loss - description: Must be set to true in order to delete the dangling index + description: Must be set to true in order to delete the dangling index. required: true schema: type: boolean @@ -17391,24 +18949,24 @@ components: dangling_indices.delete_dangling_index___query.master_timeout: in: query name: master_timeout - description: Specify timeout for connection to master + description: Specify timeout for connection to cluster manager. deprecated: true schema: $ref: '#/components/schemas/_common___Duration' style: form x-version-deprecated: '2.0' - x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. dangling_indices.delete_dangling_index___query.timeout: in: query name: timeout - description: Explicit operation timeout + description: Explicit operation timeout. schema: $ref: '#/components/schemas/_common___Duration' style: form dangling_indices.import_dangling_index___path.index_uuid: in: path name: index_uuid - description: The UUID of the dangling index + description: The UUID of the dangling index. required: true schema: $ref: '#/components/schemas/_common___Uuid' @@ -17416,7 +18974,7 @@ components: dangling_indices.import_dangling_index___query.accept_data_loss: in: query name: accept_data_loss - description: Must be set to true in order to import the dangling index + description: Must be set to true in order to import the dangling index. required: true schema: type: boolean @@ -17431,17 +18989,17 @@ components: dangling_indices.import_dangling_index___query.master_timeout: in: query name: master_timeout - description: Specify timeout for connection to master + description: Specify timeout for connection to cluster manager. deprecated: true schema: $ref: '#/components/schemas/_common___Duration' style: form x-version-deprecated: '2.0' - x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. dangling_indices.import_dangling_index___query.timeout: in: query name: timeout - description: Explicit operation timeout + description: Explicit operation timeout. schema: $ref: '#/components/schemas/_common___Duration' style: form @@ -17465,9 +19023,9 @@ components: in: path name: index description: |- - Comma-separated list of data streams, indices, and aliases to search. + Comma-separated list of data streams, indexes, and aliases to search. Supports wildcards (`*`). - To search all data streams or indices, omit this parameter or use `*` or `_all`. + To search all data streams or indexes, omit this parameter or use `*` or `_all`. required: true schema: $ref: '#/components/schemas/_common___Indices' @@ -17475,42 +19033,39 @@ components: delete_by_query___query._source: name: _source in: query - description: True or false to return the _source field or not, or a list of fields to return. + description: Set to `true` or `false` to return the `_source` field or not, or a list of fields to return. style: form schema: - type: array - items: - type: string - description: True or false to return the _source field or not, or a list of fields to return. + $ref: '#/components/schemas/_core.search___SourceConfigParam' explode: true delete_by_query___query._source_excludes: name: _source_excludes in: query - description: List of fields to exclude from the returned _source field. + description: List of fields to exclude from the returned `_source` field. style: form schema: type: array items: type: string - description: List of fields to exclude from the returned _source field. + description: List of fields to exclude from the returned `_source` field. explode: true delete_by_query___query._source_includes: name: _source_includes in: query - description: List of fields to extract and return from the _source field. + description: List of fields to extract and return from the `_source` field. style: form schema: type: array items: type: string - description: List of fields to extract and return from the _source field. + description: List of fields to extract and return from the `_source` field. explode: true delete_by_query___query.allow_no_indices: in: query name: allow_no_indices description: |- - If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. - This behavior applies even if the request targets other open indices. + If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indexes. + This behavior applies even if the request targets other open indexes. For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. schema: type: boolean @@ -17616,7 +19171,7 @@ components: name: refresh description: If `true`, OpenSearch refreshes all shards involved in the delete by query after the request completes. schema: - type: boolean + $ref: '#/components/schemas/_common___Refresh' style: form delete_by_query___query.request_cache: in: query @@ -17680,10 +19235,10 @@ components: delete_by_query___query.size: name: size in: query - description: Deprecated, please use `max_docs` instead. + description: Deprecated, use `max_docs` instead. schema: type: integer - description: Deprecated, please use `max_docs` instead. + description: Deprecated, use `max_docs` instead. format: int32 delete_by_query___query.slices: in: query @@ -17721,7 +19276,7 @@ components: Use with caution. OpenSearch applies this parameter to each shard handling the request. When possible, let OpenSearch perform early termination automatically. - Avoid specifying this parameter for requests that target data streams with backing indices across multiple data tiers. + Avoid specifying this parameter for requests that target data streams with backing indexes across multiple data tiers. schema: type: integer format: int32 @@ -17778,14 +19333,14 @@ components: in: query name: master_timeout description: |- - Period to wait for a connection to the master node. + Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error. deprecated: true schema: $ref: '#/components/schemas/_common___Duration' style: form x-version-deprecated: '2.0' - x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. delete_script___query.timeout: in: query name: timeout @@ -17887,7 +19442,7 @@ components: in: path name: index description: |- - Comma-separated list of data streams, indices, and aliases. + Comma-separated list of data streams, indexes, and aliases. Supports wildcards (`*`). required: true schema: @@ -17927,7 +19482,7 @@ components: exists_source___query.realtime: in: query name: realtime - description: If true, the request is real-time as opposed to near-real-time. + description: If `true`, the request is real-time as opposed to near-real-time. schema: type: boolean style: form @@ -17936,7 +19491,7 @@ components: name: refresh description: If `true`, OpenSearch refreshes all shards involved in the delete by query after the request completes. schema: - type: boolean + $ref: '#/components/schemas/_common___Refresh' style: form exists_source___query.routing: in: query @@ -17973,7 +19528,7 @@ components: in: path name: index description: |- - Comma-separated list of data streams, indices, and aliases. + Comma-separated list of data streams, indexes, and aliases. Supports wildcards (`*`). required: true schema: @@ -18022,7 +19577,7 @@ components: name: refresh description: If `true`, OpenSearch refreshes all shards involved in the delete by query after the request completes. schema: - type: boolean + $ref: '#/components/schemas/_common___Refresh' style: form exists___query.routing: in: query @@ -18078,7 +19633,7 @@ components: explain___query._source: in: query name: _source - description: True or false to return the `_source` field or not, or a list of fields to return. + description: Set to `true` or `false` to return the `_source` field or not, or a list of fields to return. schema: $ref: '#/components/schemas/_core.search___SourceConfigParam' style: form @@ -18169,7 +19724,7 @@ components: field_caps___path.index: in: path name: index - description: Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (*). To target all data streams and indices, omit this parameter or use * or _all. + description: Comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (*). To target all data streams and indexes, omit this parameter or use * or `_all`. required: true schema: $ref: '#/components/schemas/_common___Indices' @@ -18178,8 +19733,8 @@ components: in: query name: allow_no_indices description: |- - If false, the request returns an error if any wildcard expression, index alias, - or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request + If `false`, the request returns an error if any wildcard expression, index alias, + or `_all` value targets only missing or closed indexes. This behavior applies even if the request targets other open indexes. For example, a request targeting `foo*,bar*` returns an error if an index starts with foo but no index starts with bar. schema: type: boolean @@ -18201,14 +19756,14 @@ components: field_caps___query.ignore_unavailable: in: query name: ignore_unavailable - description: If `true`, missing or closed indices are not included in the response. + description: If `true`, missing or closed indexes are not included in the response. schema: type: boolean style: form field_caps___query.include_unmapped: in: query name: include_unmapped - description: If true, unmapped fields are included in the response. + description: If `true`, unmapped fields are included in the response. schema: type: boolean default: false @@ -18230,7 +19785,7 @@ components: schema: $ref: '#/components/schemas/flow_framework.common___UpdateFields' flow_framework.create___query.use_case: - description: To use a workflow template, specify it in the use_case query parameter when creating a workflow. + description: To use a workflow template, specify it in the `use_case` query parameter when creating a workflow. in: query name: use_case schema: @@ -18281,6 +19836,7 @@ components: name: workflow_step required: false schema: + description: The name of the step to retrieve. $ref: '#/components/schemas/flow_framework.common___WorkflowStepName' flow_framework.get___path.workflow_id: name: workflow_id @@ -18317,7 +19873,7 @@ components: schema: $ref: '#/components/schemas/flow_framework.common___UpdateFields' flow_framework.update___query.use_case: - description: To use a workflow template, specify it in the use_case query parameter when creating a workflow. + description: To use a workflow template, specify it in the `use_case` query parameter when creating a workflow. in: query name: use_case schema: @@ -18351,7 +19907,7 @@ components: $ref: '#/components/schemas/_common___Duration' style: form x-version-deprecated: '2.0' - x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. get_source___path.id: in: path name: id @@ -18371,7 +19927,7 @@ components: get_source___query._source: in: query name: _source - description: True or false to return the _source field or not, or a list of fields to return. + description: Set to `true` or `false` to return the `_source` field or not, or a list of fields to return. schema: $ref: '#/components/schemas/_core.search___SourceConfigParam' style: form @@ -18400,16 +19956,16 @@ components: get_source___query.realtime: in: query name: realtime - description: Boolean) If true, the request is real-time as opposed to near-real-time. + description: Boolean) If `true`, the request is real-time as opposed to near-real-time. schema: type: boolean style: form get_source___query.refresh: in: query name: refresh - description: If true, OpenSearch refreshes the affected shards to make this operation visible to search. If false, do nothing with refreshes. + description: If `true`, OpenSearch refreshes the affected shards to make this operation visible to search. If `false`, do nothing with refreshes. schema: - type: boolean + $ref: '#/components/schemas/_common___Refresh' style: form get_source___query.routing: in: query @@ -18428,7 +19984,7 @@ components: get_source___query.version_type: in: query name: version_type - description: 'Specific version type: internal, external, external_gte.' + description: Specific version type. One of `internal`, `external`, `external_gte`. schema: $ref: '#/components/schemas/_common___VersionType' style: form @@ -18451,7 +20007,7 @@ components: get___query._source: in: query name: _source - description: True or false to return the _source field or not, or a list of fields to return. + description: Set to `true` or `false` to return the `_source` field or not, or a list of fields to return. schema: $ref: '#/components/schemas/_core.search___SourceConfigParam' style: form @@ -18487,9 +20043,9 @@ components: get___query.refresh: in: query name: refresh - description: If true, OpenSearch refreshes the affected shards to make this operation visible to search. If false, do nothing with refreshes. + description: If `true`, OpenSearch refreshes the affected shards to make this operation visible to search. If `false`, do nothing with refreshes. schema: - type: boolean + $ref: '#/components/schemas/_common___Refresh' style: form get___query.routing: in: query @@ -18518,7 +20074,7 @@ components: get___query.version_type: in: query name: version_type - description: 'Specific version type: internal, external, external_gte.' + description: 'Specific version type: `internal`, `external`, `external_gte`.' schema: $ref: '#/components/schemas/_common___VersionType' style: form @@ -18636,7 +20192,7 @@ components: indices.add_block___path.block: in: path name: block - description: The block to add (one of read, write, read_only or metadata) + description: The block to add (one of `read`, `write`, `read_only` or `metadata`). required: true schema: $ref: '#/components/schemas/indices.add_block___IndicesBlockOptions' @@ -18644,7 +20200,7 @@ components: indices.add_block___path.index: in: path name: index - description: A comma separated list of indices to add a block to + description: A comma separated list of indexes to add a block to. required: true schema: $ref: '#/components/schemas/_common___Indices' @@ -18652,7 +20208,7 @@ components: indices.add_block___query.allow_no_indices: in: query name: allow_no_indices - description: Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) + description: Whether to ignore if a wildcard indexes expression resolves into no concrete indexes. (This includes `_all` string or when no indexes have been specified). schema: type: boolean style: form @@ -18666,27 +20222,27 @@ components: indices.add_block___query.expand_wildcards: in: query name: expand_wildcards - description: Whether to expand wildcard expression to concrete indices that are open, closed or both. + description: Whether to expand wildcard expression to concrete indexes that are open, closed or both. schema: $ref: '#/components/schemas/_common___ExpandWildcards' style: form indices.add_block___query.ignore_unavailable: in: query name: ignore_unavailable - description: Whether specified concrete indices should be ignored when unavailable (missing or closed) + description: Whether specified concrete indexes should be ignored when unavailable (missing or closed). schema: type: boolean style: form indices.add_block___query.master_timeout: in: query name: master_timeout - description: Specify timeout for connection to master + description: Specify timeout for connection to cluster manager. deprecated: true schema: $ref: '#/components/schemas/_common___Duration' style: form x-version-deprecated: '2.0' - x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. indices.add_block___query.timeout: in: query name: timeout @@ -18716,9 +20272,9 @@ components: in: path name: index description: |- - Comma-separated list of data streams, indices, and aliases used to limit the request. + Comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (`*`). - To target all data streams and indices, omit this parameter or use `*` or `_all`. + To target all data streams and indexes, omit this parameter or use `*` or `_all`. required: true schema: $ref: '#/components/schemas/_common___Indices' @@ -18727,8 +20283,8 @@ components: in: query name: allow_no_indices description: |- - If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. - This behavior applies even if the request targets other open indices. + If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indexes. + This behavior applies even if the request targets other open indexes. schema: type: boolean style: form @@ -18763,7 +20319,7 @@ components: x-version-added: '2.8' in: query name: file - description: If true, clears the unused entries from the file cache on nodes with the Search role. + description: If `true`, clears the unused entries from the file cache on nodes with the Search role. schema: type: boolean default: false @@ -18778,13 +20334,13 @@ components: indices.clear_cache___query.index: name: index in: query - description: Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices. + description: Comma-separated list of indexes; use `_all` or empty string to perform the operation on all indexes. style: form schema: type: array items: type: string - description: Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices. + description: Comma-separated list of indexes; use `_all` or empty string to perform the operation on all indexes. explode: true indices.clear_cache___query.query: in: query @@ -18827,18 +20383,18 @@ components: in: query name: master_timeout description: |- - Period to wait for a connection to the master node. + Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error. deprecated: true schema: $ref: '#/components/schemas/_common___Duration' style: form x-version-deprecated: '2.0' - x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. indices.clone___query.task_execution_timeout: name: task_execution_timeout in: query - description: Explicit task execution timeout, only useful when wait_for_completion is false, defaults to 1h. + description: Explicit task execution timeout, only useful when `wait_for_completion` is false, defaults to `1h`. schema: $ref: '#/components/schemas/_common___Duration' indices.clone___query.timeout: @@ -18880,8 +20436,8 @@ components: in: query name: allow_no_indices description: |- - If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. - This behavior applies even if the request targets other open indices. + If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indexes. + This behavior applies even if the request targets other open indexes. schema: type: boolean style: form @@ -18914,14 +20470,14 @@ components: in: query name: master_timeout description: |- - Period to wait for a connection to the master node. + Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error. deprecated: true schema: $ref: '#/components/schemas/_common___Duration' style: form x-version-deprecated: '2.0' - x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. indices.close___query.timeout: in: query name: timeout @@ -18973,14 +20529,14 @@ components: in: query name: master_timeout description: |- - Period to wait for a connection to the master node. + Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error. deprecated: true schema: $ref: '#/components/schemas/_common___Duration' style: form x-version-deprecated: '2.0' - x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. indices.create___query.timeout: in: query name: timeout @@ -19014,7 +20570,7 @@ components: in: path name: index description: |- - Comma-separated list of data streams or indices used to limit the request. + Comma-separated list of data streams or indexes used to limit the request. Supports wildcards (`*`). required: true schema: @@ -19041,14 +20597,14 @@ components: in: query name: master_timeout description: |- - Period to wait for a connection to the master node. + Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error. deprecated: true schema: $ref: '#/components/schemas/_common___Duration' style: form x-version-deprecated: '2.0' - x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. indices.delete_alias___query.timeout: in: query name: timeout @@ -19084,13 +20640,13 @@ components: indices.delete_index_template___query.master_timeout: in: query name: master_timeout - description: Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + description: Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error. deprecated: true schema: $ref: '#/components/schemas/_common___Duration' style: form x-version-deprecated: '2.0' - x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. indices.delete_index_template___query.timeout: in: query name: timeout @@ -19119,14 +20675,14 @@ components: in: query name: master_timeout description: |- - Period to wait for a connection to the master node. + Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error. deprecated: true schema: $ref: '#/components/schemas/_common___Duration' style: form x-version-deprecated: '2.0' - x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. indices.delete_template___query.timeout: in: query name: timeout @@ -19140,7 +20696,7 @@ components: in: path name: index description: |- - Comma-separated list of indices to delete. + Comma-separated list of indexes to delete. You cannot specify index aliases. By default, this parameter does not support wildcards (`*`) or `_all`. To use wildcards or `_all`, set the `action.destructive_requires_name` cluster setting to `false`. @@ -19152,8 +20708,8 @@ components: in: query name: allow_no_indices description: |- - If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. - This behavior applies even if the request targets other open indices. + If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indexes. + This behavior applies even if the request targets other open indexes. schema: type: boolean default: false @@ -19188,14 +20744,14 @@ components: in: query name: master_timeout description: |- - Period to wait for a connection to the master node. + Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error. deprecated: true schema: $ref: '#/components/schemas/_common___Duration' style: form x-version-deprecated: '2.0' - x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. indices.delete___query.timeout: in: query name: timeout @@ -19209,8 +20765,8 @@ components: in: path name: index description: |- - Comma-separated list of data streams or indices used to limit the request. Supports wildcards (`*`). - To target all data streams and indices, omit this parameter or use `*` or `_all`. + Comma-separated list of data streams or indexes used to limit the request. Supports wildcards (`*`). + To target all data streams and indexes, omit this parameter or use `*` or `_all`. required: true schema: $ref: '#/components/schemas/_common___Indices' @@ -19227,8 +20783,8 @@ components: in: query name: allow_no_indices description: |- - If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. - This behavior applies even if the request targets other open indices. + If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indexes. + This behavior applies even if the request targets other open indexes. schema: type: boolean style: form @@ -19246,7 +20802,7 @@ components: indices.exists_alias___query.ignore_unavailable: in: query name: ignore_unavailable - description: If `false`, requests that include a missing data stream or index in the target indices or data streams return an error. + description: If `false`, requests that include a missing data stream or index in the target indexes or data streams return an error. schema: type: boolean style: form @@ -19292,13 +20848,13 @@ components: indices.exists_index_template___query.master_timeout: in: query name: master_timeout - description: Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + description: Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error. deprecated: true schema: $ref: '#/components/schemas/_common___Duration' style: form x-version-deprecated: '2.0' - x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. indices.exists_template___path.name: in: path name: name @@ -19333,17 +20889,17 @@ components: indices.exists_template___query.master_timeout: in: query name: master_timeout - description: Explicit operation timeout for connection to master node + description: Explicit operation timeout for connection to cluster-manager node deprecated: true schema: $ref: '#/components/schemas/_common___Duration' style: form x-version-deprecated: '2.0' - x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. indices.exists___path.index: in: path name: index - description: Comma-separated list of data streams, indices, and aliases. Supports wildcards (`*`). + description: Comma-separated list of data streams, indexes, and aliases. Supports wildcards (`*`). required: true schema: $ref: '#/components/schemas/_common___Indices' @@ -19352,8 +20908,8 @@ components: in: query name: allow_no_indices description: |- - If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. - This behavior applies even if the request targets other open indices. + If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indexes. + This behavior applies even if the request targets other open indexes. schema: type: boolean default: false @@ -19412,9 +20968,9 @@ components: in: path name: index description: |- - Comma-separated list of data streams, indices, and aliases to flush. + Comma-separated list of data streams, indexes, and aliases to flush. Supports wildcards (`*`). - To flush all data streams and indices, omit this parameter or use `*` or `_all`. + To flush all data streams and indexes, omit this parameter or use `*` or `_all`. required: true schema: $ref: '#/components/schemas/_common___Indices' @@ -19423,8 +20979,8 @@ components: in: query name: allow_no_indices description: |- - If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. - This behavior applies even if the request targets other open indices. + If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indexes. + This behavior applies even if the request targets other open indexes. schema: type: boolean style: form @@ -19466,7 +21022,7 @@ components: indices.forcemerge___path.index: in: path name: index - description: A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices + description: A comma-separated list of index names; use `_all` or empty string to perform the operation on all indexes required: true schema: $ref: '#/components/schemas/_common___Indices' @@ -19474,14 +21030,14 @@ components: indices.forcemerge___query.allow_no_indices: in: query name: allow_no_indices - description: Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) + description: Whether to ignore if a wildcard indexes expression resolves into no concrete indexes. (This includes `_all` string or when no indexes have been specified) schema: type: boolean style: form indices.forcemerge___query.expand_wildcards: in: query name: expand_wildcards - description: Whether to expand wildcard expression to concrete indices that are open, closed or both. + description: Whether to expand wildcard expression to concrete indexes that are open, closed or both. schema: $ref: '#/components/schemas/_common___ExpandWildcards' style: form @@ -19496,7 +21052,7 @@ components: indices.forcemerge___query.ignore_unavailable: in: query name: ignore_unavailable - description: Whether specified concrete indices should be ignored when unavailable (missing or closed) + description: Whether specified concrete indexes should be ignored when unavailable (missing or closed) schema: type: boolean style: form @@ -19508,7 +21064,8 @@ components: Set this parameter to 1 to merge all segments into one segment. The default behavior is to perform the merge as necessary. schema: - type: number + type: integer + format: int64 style: form indices.forcemerge___query.only_expunge_deletes: in: query @@ -19539,9 +21096,9 @@ components: in: path name: index description: |- - Comma-separated list of data streams or indices used to limit the request. + Comma-separated list of data streams or indexes used to limit the request. Supports wildcards (`*`). - To target all data streams and indices, omit this parameter or use `*` or `_all`. + To target all data streams and indexes, omit this parameter or use `*` or `_all`. required: true schema: $ref: '#/components/schemas/_common___Indices' @@ -19561,8 +21118,8 @@ components: in: query name: allow_no_indices description: |- - If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. - This behavior applies even if the request targets other open indices. + If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indexes. + This behavior applies even if the request targets other open indexes. schema: type: boolean style: form @@ -19614,9 +21171,9 @@ components: in: path name: index description: |- - Comma-separated list of data streams, indices, and aliases used to limit the request. + Comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (`*`). - To target all data streams and indices, omit this parameter or use `*` or `_all`. + To target all data streams and indexes, omit this parameter or use `*` or `_all`. required: true schema: $ref: '#/components/schemas/_common___Indices' @@ -19625,8 +21182,8 @@ components: in: query name: allow_no_indices description: |- - If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. - This behavior applies even if the request targets other open indices. + If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indexes. + This behavior applies even if the request targets other open indexes. schema: type: boolean style: form @@ -19681,7 +21238,7 @@ components: indices.get_index_template___query.flat_settings: in: query name: flat_settings - description: If true, returns settings in flat format. + description: If `true`, returns settings in flat format. schema: type: boolean default: false @@ -19689,7 +21246,7 @@ components: indices.get_index_template___query.local: in: query name: local - description: If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the master node. + description: If `true`, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the cluster-manager node. schema: type: boolean default: false @@ -19697,20 +21254,20 @@ components: indices.get_index_template___query.master_timeout: in: query name: master_timeout - description: Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + description: Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error. deprecated: true schema: $ref: '#/components/schemas/_common___Duration' style: form x-version-deprecated: '2.0' - x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. indices.get_mapping___path.index: in: path name: index description: |- - Comma-separated list of data streams, indices, and aliases used to limit the request. + Comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (`*`). - To target all data streams and indices, omit this parameter or use `*` or `_all`. + To target all data streams and indexes, omit this parameter or use `*` or `_all`. required: true schema: $ref: '#/components/schemas/_common___Indices' @@ -19719,8 +21276,8 @@ components: in: query name: allow_no_indices description: |- - If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. - This behavior applies even if the request targets other open indices. + If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indexes. + This behavior applies even if the request targets other open indexes. schema: type: boolean style: form @@ -19753,9 +21310,9 @@ components: in: query name: index description: |- - Comma-separated list of data streams, indices, and aliases used to limit the request. + Comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (`*`). - To target all data streams and indices, omit this parameter or use `*` or `_all`. + To target all data streams and indexes, omit this parameter or use `*` or `_all`. schema: $ref: '#/components/schemas/_common___Indices' style: form @@ -19771,21 +21328,21 @@ components: in: query name: master_timeout description: |- - Period to wait for a connection to the master node. + Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error. deprecated: true schema: $ref: '#/components/schemas/_common___Duration' style: form x-version-deprecated: '2.0' - x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. indices.get_settings___path.index: in: path name: index description: |- - Comma-separated list of data streams, indices, and aliases used to limit + Comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams and - indices, omit this parameter or use `*` or `_all`. + indexes, omit this parameter or use `*` or `_all`. required: true schema: $ref: '#/components/schemas/_common___Indices' @@ -19803,8 +21360,8 @@ components: name: allow_no_indices description: |- If `false`, the request returns an error if any wildcard expression, index - alias, or `_all` value targets only missing or closed indices. This - behavior applies even if the request targets other open indices. For + alias, or `_all` value targets only missing or closed indexes. This + behavior applies even if the request targets other open indexes. For example, a request targeting `foo*,bar*` returns an error if an index starts with foo but no index starts with `bar`. schema: @@ -19855,7 +21412,7 @@ components: name: local description: |- If `true`, the request retrieves information from the local node only. If - `false`, information is retrieved from the master node. + `false`, information is retrieved from the cluster-manager node. schema: type: boolean default: false @@ -19864,7 +21421,7 @@ components: in: query name: master_timeout description: |- - Period to wait for a connection to the master node. If no response is + Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error. deprecated: true @@ -19872,7 +21429,7 @@ components: $ref: '#/components/schemas/_common___Duration' style: form x-version-deprecated: '2.0' - x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. indices.get_template___path.name: in: path name: name @@ -19911,49 +21468,49 @@ components: in: query name: master_timeout description: |- - Period to wait for a connection to the master node. + Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error. deprecated: true schema: $ref: '#/components/schemas/_common___Duration' style: form x-version-deprecated: '2.0' - x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. indices.get_upgrade___path.index: name: index in: path - description: Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices. + description: Comma-separated list of indexes; use `_all` or empty string to perform the operation on all indexes. schema: type: array - description: Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices. + description: Comma-separated list of indexes; use `_all` or empty string to perform the operation on all indexes. items: type: string required: true indices.get_upgrade___query.allow_no_indices: name: allow_no_indices in: query - description: Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified). + description: Whether to ignore if a wildcard indexes expression resolves into no concrete indexes. (This includes `_all` string or when no indexes have been specified). schema: type: boolean - description: Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified). + description: Whether to ignore if a wildcard indexes expression resolves into no concrete indexes. (This includes `_all` string or when no indexes have been specified). indices.get_upgrade___query.expand_wildcards: name: expand_wildcards in: query - description: Whether to expand wildcard expression to concrete indices that are open, closed or both. + description: Whether to expand wildcard expression to concrete indexes that are open, closed or both. schema: $ref: '#/components/schemas/_common___ExpandWildcards' indices.get_upgrade___query.ignore_unavailable: name: ignore_unavailable in: query - description: Whether specified concrete indices should be ignored when unavailable (missing or closed). + description: Whether specified concrete indexes should be ignored when unavailable (missing or closed). schema: type: boolean - description: Whether specified concrete indices should be ignored when unavailable (missing or closed). + description: Whether specified concrete indexes should be ignored when unavailable (missing or closed). indices.get___path.index: in: path name: index description: |- - Comma-separated list of data streams, indices, and index aliases used to limit the request. + Comma-separated list of data streams, indexes, and index aliases used to limit the request. Wildcard expressions (*) are supported. required: true schema: @@ -19963,8 +21520,8 @@ components: in: query name: allow_no_indices description: |- - If false, the request returns an error if any wildcard expression, index alias, or _all value targets only - missing or closed indices. This behavior applies even if the request targets other open indices. For example, + If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only + missing or closed indexes. This behavior applies even if the request targets other open indexes. For example, a request targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar. schema: type: boolean @@ -19983,14 +21540,14 @@ components: description: |- Type of index that wildcard expressions can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, - such as open,hidden. + such as `open,hidden`. schema: $ref: '#/components/schemas/_common___ExpandWildcards' style: form indices.get___query.flat_settings: in: query name: flat_settings - description: If true, returns settings in flat format. + description: If `true`, returns settings in flat format. schema: type: boolean default: false @@ -19998,7 +21555,7 @@ components: indices.get___query.ignore_unavailable: in: query name: ignore_unavailable - description: If false, requests that target a missing index return an error. + description: If `false`, requests that target a missing index return an error. schema: type: boolean default: false @@ -20006,7 +21563,7 @@ components: indices.get___query.include_defaults: in: query name: include_defaults - description: If true, return all default settings in the response. + description: If `true`, return all default settings in the response. schema: type: boolean default: false @@ -20014,7 +21571,7 @@ components: indices.get___query.local: in: query name: local - description: If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the master node. + description: If `true`, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the cluster-manager node. schema: type: boolean default: false @@ -20022,20 +21579,20 @@ components: indices.get___query.master_timeout: in: query name: master_timeout - description: Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + description: Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error. deprecated: true schema: $ref: '#/components/schemas/_common___Duration' style: form x-version-deprecated: '2.0' - x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. indices.open___path.index: in: path name: index description: |- - Comma-separated list of data streams, indices, and aliases used to limit the request. + Comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (`*`). - By default, you must explicitly name the indices you using to limit the request. + By default, you must explicitly name the indexes you using to limit the request. To limit a request using `_all`, `*`, or other wildcard expressions, change the `action.destructive_requires_name` setting to false. You can update this setting in the `opensearch.yml` file or using the cluster update settings API. required: true @@ -20046,8 +21603,8 @@ components: in: query name: allow_no_indices description: |- - If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. - This behavior applies even if the request targets other open indices. + If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indexes. + This behavior applies even if the request targets other open indexes. schema: type: boolean style: form @@ -20080,18 +21637,18 @@ components: in: query name: master_timeout description: |- - Period to wait for a connection to the master node. + Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error. deprecated: true schema: $ref: '#/components/schemas/_common___Duration' style: form x-version-deprecated: '2.0' - x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. indices.open___query.task_execution_timeout: name: task_execution_timeout in: query - description: Explicit task execution timeout, only useful when wait_for_completion is false, defaults to 1h. + description: Explicit task execution timeout, only useful when `wait_for_completion` is false, defaults to `1h`. schema: $ref: '#/components/schemas/_common___Duration' indices.open___query.timeout: @@ -20125,9 +21682,9 @@ components: in: path name: index description: |- - Comma-separated list of data streams or indices to add. + Comma-separated list of data streams or indexes to add. Supports wildcards (`*`). - Wildcard patterns that match both data streams and indices return an error. + Wildcard patterns that match both data streams and indexes return an error. required: true schema: $ref: '#/components/schemas/_common___Indices' @@ -20154,14 +21711,14 @@ components: in: query name: master_timeout description: |- - Period to wait for a connection to the master node. + Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error. deprecated: true schema: $ref: '#/components/schemas/_common___Duration' style: form x-version-deprecated: '2.0' - x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. indices.put_alias___query.timeout: in: query name: timeout @@ -20205,16 +21762,16 @@ components: indices.put_index_template___query.master_timeout: name: master_timeout in: query - description: Operation timeout for connection to master node. + description: Operation timeout for connection to cluster-manager node. schema: $ref: '#/components/schemas/_common___Duration' x-version-deprecated: '2.0' - x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. deprecated: true indices.put_mapping___path.index: in: path name: index - description: A comma-separated list of index names the mapping should be added to (supports wildcards); use `_all` or omit to add the mapping on all indices. + description: A comma-separated list of index names the mapping should be added to (supports wildcards); use `_all` or omit to add the mapping on all indexes. required: true schema: $ref: '#/components/schemas/_common___Indices' @@ -20223,8 +21780,8 @@ components: in: query name: allow_no_indices description: |- - If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. - This behavior applies even if the request targets other open indices. + If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indexes. + This behavior applies even if the request targets other open indexes. schema: type: boolean style: form @@ -20257,14 +21814,14 @@ components: in: query name: master_timeout description: |- - Period to wait for a connection to the master node. + Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error. deprecated: true schema: $ref: '#/components/schemas/_common___Duration' style: form x-version-deprecated: '2.0' - x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. indices.put_mapping___query.timeout: in: query name: timeout @@ -20286,9 +21843,9 @@ components: in: path name: index description: |- - Comma-separated list of data streams, indices, and aliases used to limit + Comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams and - indices, omit this parameter or use `*` or `_all`. + indexes, omit this parameter or use `*` or `_all`. required: true schema: $ref: '#/components/schemas/_common___Indices' @@ -20298,8 +21855,8 @@ components: name: allow_no_indices description: |- If `false`, the request returns an error if any wildcard expression, index - alias, or `_all` value targets only missing or closed indices. This - behavior applies even if the request targets other open indices. For + alias, or `_all` value targets only missing or closed indexes. This + behavior applies even if the request targets other open indexes. For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. schema: @@ -20334,7 +21891,7 @@ components: indices.put_settings___query.ignore_unavailable: in: query name: ignore_unavailable - description: Whether specified concrete indices should be ignored when unavailable (missing or closed). + description: Whether specified concrete indexes should be ignored when unavailable (missing or closed). schema: type: boolean style: form @@ -20342,7 +21899,7 @@ components: in: query name: master_timeout description: |- - Period to wait for a connection to the master node. If no response is + Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error. deprecated: true @@ -20350,7 +21907,7 @@ components: $ref: '#/components/schemas/_common___Duration' style: form x-version-deprecated: '2.0' - x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. indices.put_settings___query.preserve_existing: in: query name: preserve_existing @@ -20386,7 +21943,7 @@ components: indices.put_template___query.create: in: query name: create - description: If true, this request cannot replace or update existing index templates. + description: If `true`, this request cannot replace or update existing index templates. schema: type: boolean default: false @@ -20395,14 +21952,14 @@ components: in: query name: master_timeout description: |- - Period to wait for a connection to the master node. If no response is + Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error. deprecated: true schema: $ref: '#/components/schemas/_common___Duration' style: form x-version-deprecated: '2.0' - x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. indices.put_template___query.order: in: query name: order @@ -20413,15 +21970,16 @@ components: Templates with lower 'order' values are merged first. Templates with higher 'order' values are merged later, overriding templates with lower values. schema: - type: number + type: integer + format: int32 style: form indices.recovery___path.index: in: path name: index description: |- - Comma-separated list of data streams, indices, and aliases used to limit the request. + Comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (`*`). - To target all data streams and indices, omit this parameter or use `*` or `_all`. + To target all data streams and indexes, omit this parameter or use `*` or `_all`. required: true schema: $ref: '#/components/schemas/_common___Indices' @@ -20446,9 +22004,9 @@ components: in: path name: index description: |- - Comma-separated list of data streams, indices, and aliases used to limit the request. + Comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (`*`). - To target all data streams and indices, omit this parameter or use `*` or `_all`. + To target all data streams and indexes, omit this parameter or use `*` or `_all`. required: true schema: $ref: '#/components/schemas/_common___Indices' @@ -20457,8 +22015,8 @@ components: in: query name: allow_no_indices description: |- - If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. - This behavior applies even if the request targets other open indices. + If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indexes. + This behavior applies even if the request targets other open indexes. schema: type: boolean style: form @@ -20484,7 +22042,7 @@ components: in: path name: name description: |- - Comma-separated name(s) or index pattern(s) of the indices, aliases, and data streams to resolve. + Comma-separated name(s) or index pattern(s) of the indexes, aliases, and data streams to resolve. Resources on remote clusters can be specified using the ``:`` syntax. required: true schema: @@ -20539,14 +22097,14 @@ components: in: query name: master_timeout description: |- - Period to wait for a connection to the master node. + Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error. deprecated: true schema: $ref: '#/components/schemas/_common___Duration' style: form x-version-deprecated: '2.0' - x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. indices.rollover___query.timeout: in: query name: timeout @@ -20569,9 +22127,9 @@ components: in: path name: index description: |- - Comma-separated list of data streams, indices, and aliases used to limit the request. + Comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (`*`). - To target all data streams and indices, omit this parameter or use `*` or `_all`. + To target all data streams and indexes, omit this parameter or use `*` or `_all`. required: true schema: $ref: '#/components/schemas/_common___Indices' @@ -20580,8 +22138,8 @@ components: in: query name: allow_no_indices description: |- - If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. - This behavior applies even if the request targets other open indices. + If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indexes. + This behavior applies even if the request targets other open indexes. schema: type: boolean style: form @@ -20614,7 +22172,7 @@ components: indices.shard_stores___path.index: in: path name: index - description: List of data streams, indices, and aliases used to limit the request. + description: List of data streams, indexes, and aliases used to limit the request. required: true schema: $ref: '#/components/schemas/_common___Indices' @@ -20623,9 +22181,9 @@ components: in: query name: allow_no_indices description: |- - If false, the request returns an error if any wildcard expression, index alias, or _all - value targets only missing or closed indices. This behavior applies even if the request - targets other open indices. + If `false`, the request returns an error if any wildcard expression, index alias, or `_all` + value targets only missing or closed indexes. This behavior applies even if the request + targets other open indexes. schema: type: boolean style: form @@ -20641,7 +22199,7 @@ components: indices.shard_stores___query.ignore_unavailable: in: query name: ignore_unavailable - description: If true, missing or closed indices are not included in the response. + description: If `true`, missing or closed indexes are not included in the response. schema: type: boolean style: form @@ -20651,10 +22209,10 @@ components: description: List of shard health statuses used to limit the request. schema: oneOf: - - $ref: '#/components/schemas/indices.shard_stores___Status' + - $ref: '#/components/schemas/indices.shard_stores___ShardStoreStatus' - type: array items: - $ref: '#/components/schemas/indices.shard_stores___Status' + $ref: '#/components/schemas/indices.shard_stores___ShardStoreStatus' style: form indices.shrink___path.index: in: path @@ -20691,18 +22249,18 @@ components: in: query name: master_timeout description: |- - Period to wait for a connection to the master node. + Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error. deprecated: true schema: $ref: '#/components/schemas/_common___Duration' style: form x-version-deprecated: '2.0' - x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. indices.shrink___query.task_execution_timeout: name: task_execution_timeout in: query - description: Explicit task execution timeout, only useful when wait_for_completion is false, defaults to 1h. + description: Explicit task execution timeout, only useful when `wait_for_completion` is false, defaults to `1h`. schema: $ref: '#/components/schemas/_common___Duration' indices.shrink___query.timeout: @@ -20740,14 +22298,6 @@ components: schema: $ref: '#/components/schemas/_common___Name' style: simple - indices.simulate_index_template___query.cause: - name: cause - in: query - description: User defined reason for dry-run creating the new template for simulation purposes. - schema: - type: string - default: 'false' - description: User defined reason for dry-run creating the new template for simulation purposes. indices.simulate_index_template___query.cluster_manager_timeout: name: cluster_manager_timeout in: query @@ -20755,31 +22305,18 @@ components: schema: $ref: '#/components/schemas/_common___Duration' x-version-added: '2.0' - indices.simulate_index_template___query.create: - in: query - name: create - description: |- - If `true`, the template passed in the body is only used if no existing - templates match the same index patterns. If `false`, the simulation uses - the template with the highest priority. Note that the template is not - permanently added or updated in either case; it is only used for the - simulation. - schema: - type: boolean - default: false - style: form indices.simulate_index_template___query.master_timeout: in: query name: master_timeout description: |- - Period to wait for a connection to the master node. If no response is received + Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error. deprecated: true schema: $ref: '#/components/schemas/_common___Duration' style: form x-version-deprecated: '2.0' - x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. indices.simulate_template___path.name: in: path name: name @@ -20808,7 +22345,7 @@ components: indices.simulate_template___query.create: in: query name: create - description: If true, the template passed in the body is only used if no existing templates match the same index patterns. If false, the simulation uses the template with the highest priority. Note that the template is not permanently added or updated in either case; it is only used for the simulation. + description: If `true`, the template passed in the body is only used if no existing templates match the same index patterns. If `false`, the simulation uses the template with the highest priority. Note that the template is not permanently added or updated in either case; it is only used for the simulation. schema: type: boolean default: false @@ -20816,13 +22353,13 @@ components: indices.simulate_template___query.master_timeout: in: query name: master_timeout - description: Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + description: Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error. deprecated: true schema: $ref: '#/components/schemas/_common___Duration' style: form x-version-deprecated: '2.0' - x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. indices.split___path.index: in: path name: index @@ -20858,18 +22395,18 @@ components: in: query name: master_timeout description: |- - Period to wait for a connection to the master node. + Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error. deprecated: true schema: $ref: '#/components/schemas/_common___Duration' style: form x-version-deprecated: '2.0' - x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. indices.split___query.task_execution_timeout: name: task_execution_timeout in: query - description: Explicit task execution timeout, only useful when wait_for_completion is false, defaults to 1h. + description: Explicit task execution timeout, only useful when `wait_for_completion` is false, defaults to `1h`. schema: $ref: '#/components/schemas/_common___Duration' indices.split___query.timeout: @@ -20902,7 +22439,7 @@ components: indices.stats___path.index: in: path name: index - description: A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices + description: A comma-separated list of index names; use `_all` or empty string to perform the operation on all indexes required: true schema: $ref: '#/components/schemas/_common___Indices' @@ -20922,7 +22459,7 @@ components: indices.stats___query.completion_fields: in: query name: completion_fields - description: Comma-separated list or wildcard expressions of fields to include in fielddata and suggest statistics. + description: Comma-separated list or wildcard expressions of fields to include in field data and suggest statistics. schema: $ref: '#/components/schemas/_common___Fields' style: form @@ -20939,7 +22476,7 @@ components: indices.stats___query.fielddata_fields: in: query name: fielddata_fields - description: Comma-separated list or wildcard expressions of fields to include in fielddata statistics. + description: Comma-separated list or wildcard expressions of fields to include in field data statistics. schema: $ref: '#/components/schemas/_common___Fields' style: form @@ -20953,7 +22490,7 @@ components: indices.stats___query.forbid_closed_indices: in: query name: forbid_closed_indices - description: If true, statistics are not collected from closed indices. + description: If `true`, statistics are not collected from closed indexes. schema: type: boolean default: true @@ -20963,16 +22500,12 @@ components: name: groups description: Comma-separated list of search groups to include in the search statistics. schema: - oneOf: - - type: string - - type: array - items: - type: string + $ref: '#/components/schemas/_common___StringOrStringArray' style: form indices.stats___query.include_segment_file_sizes: in: query name: include_segment_file_sizes - description: If true, the call reports the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested). + description: If `true`, the call reports the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested). schema: type: boolean default: false @@ -20980,7 +22513,7 @@ components: indices.stats___query.include_unloaded_segments: in: query name: include_unloaded_segments - description: If true, the response includes information from segments that are not loaded into memory. + description: If `true`, the response includes information from segments that are not loaded into memory. schema: type: boolean default: false @@ -21003,14 +22536,14 @@ components: in: query name: master_timeout description: |- - Period to wait for a connection to the master node. + Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error. deprecated: true schema: $ref: '#/components/schemas/_common___Duration' style: form x-version-deprecated: '2.0' - x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. indices.update_aliases___query.timeout: in: query name: timeout @@ -21023,40 +22556,40 @@ components: indices.upgrade___path.index: name: index in: path - description: Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices. + description: Comma-separated list of indexes; use `_all` or empty string to perform the operation on all indexes. schema: type: array - description: Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices. + description: Comma-separated list of indexes; use `_all` or empty string to perform the operation on all indexes. items: type: string required: true indices.upgrade___query.allow_no_indices: name: allow_no_indices in: query - description: Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified). + description: Whether to ignore if a wildcard indexes expression resolves into no concrete indexes. (This includes `_all` string or when no indexes have been specified). schema: type: boolean - description: Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified). + description: Whether to ignore if a wildcard indexes expression resolves into no concrete indexes. (This includes `_all` string or when no indexes have been specified). indices.upgrade___query.expand_wildcards: name: expand_wildcards in: query - description: Whether to expand wildcard expression to concrete indices that are open, closed or both. + description: Whether to expand wildcard expression to concrete indexes that are open, closed or both. schema: $ref: '#/components/schemas/_common___ExpandWildcards' indices.upgrade___query.ignore_unavailable: name: ignore_unavailable in: query - description: Whether specified concrete indices should be ignored when unavailable (missing or closed). + description: Whether specified concrete indexes should be ignored when unavailable (missing or closed). schema: type: boolean - description: Whether specified concrete indices should be ignored when unavailable (missing or closed). + description: Whether specified concrete indexes should be ignored when unavailable (missing or closed). indices.upgrade___query.only_ancient_segments: name: only_ancient_segments in: query - description: If true, only ancient (an older Lucene major release) segments will be upgraded. + description: If `true`, only ancient (an older Lucene major release) segments will be upgraded. schema: type: boolean - description: If true, only ancient (an older Lucene major release) segments will be upgraded. + 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 @@ -21070,9 +22603,9 @@ components: in: path name: index description: |- - Comma-separated list of data streams, indices, and aliases to search. + Comma-separated list of data streams, indexes, and aliases to search. Supports wildcards (`*`). - To search all data streams or indices, omit this parameter or use `*` or `_all`. + To search all data streams or indexes, omit this parameter or use `*` or `_all`. required: true schema: $ref: '#/components/schemas/_common___Indices' @@ -21088,8 +22621,8 @@ components: in: query name: allow_no_indices description: |- - If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. - This behavior applies even if the request targets other open indices. + If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indexes. + This behavior applies even if the request targets other open indexes. schema: type: boolean style: form @@ -21193,14 +22726,14 @@ components: in: query name: master_timeout description: |- - Period to wait for a connection to the master node. + Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error. deprecated: true schema: $ref: '#/components/schemas/_common___Duration' style: form x-version-deprecated: '2.0' - x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. ingest.delete_pipeline___query.timeout: in: query name: timeout @@ -21232,14 +22765,21 @@ components: in: query name: master_timeout description: |- - Period to wait for a connection to the master node. + Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error. deprecated: true schema: $ref: '#/components/schemas/_common___Duration' style: form x-version-deprecated: '2.0' - x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. + ingest.processor_grok___query.s: + name: s + in: query + description: Sort returned patterns by key name. + schema: + type: boolean + default: false ingest.put_pipeline___path.id: in: path name: id @@ -21258,13 +22798,13 @@ components: ingest.put_pipeline___query.master_timeout: in: query name: master_timeout - description: Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + description: Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error. deprecated: true schema: $ref: '#/components/schemas/_common___Duration' style: form x-version-deprecated: '2.0' - x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. ingest.put_pipeline___query.timeout: in: query name: timeout @@ -21305,7 +22845,7 @@ components: name: index in: path description: |- - Comma-separated list of data streams, indices, and aliases. + Comma-separated list of data streams, indexes, and aliases. Supports wildcards (`*`). required: true schema: @@ -21315,7 +22855,7 @@ components: name: index in: query description: |- - Comma-separated list of data streams, indices, and aliases. + Comma-separated list of data streams, indexes, and aliases. Supports wildcards (`*`). required: true schema: @@ -21324,7 +22864,7 @@ components: name: index in: path description: |- - Comma-separated list of data streams, indices, and aliases. + Comma-separated list of data streams, indexes, and aliases. Supports wildcards (`*`). required: true schema: @@ -21334,7 +22874,7 @@ components: name: index in: query description: |- - Comma-separated list of data streams, indices, and aliases. + Comma-separated list of data streams, indexes, and aliases. Supports wildcards (`*`). required: true schema: @@ -21355,7 +22895,7 @@ components: name: index in: path description: |- - Comma-separated list of data streams, indices, and aliases. + Comma-separated list of data streams, indexes, and aliases. Supports wildcards (`*`). required: true schema: @@ -21412,7 +22952,7 @@ components: name: index in: path description: |- - Comma-separated list of data streams, indices, and aliases. + Comma-separated list of data streams, indexes, and aliases. Supports wildcards (`*`). required: true schema: @@ -21422,7 +22962,7 @@ components: name: index in: path description: |- - Comma-separated list of data streams, indices, and aliases. + Comma-separated list of data streams, indexes, and aliases. Supports wildcards (`*`). required: true schema: @@ -21432,7 +22972,7 @@ components: name: index in: query description: |- - Comma-separated list of data streams, indices, and aliases. + Comma-separated list of data streams, indexes, and aliases. Supports wildcards (`*`). required: true schema: @@ -21441,7 +22981,7 @@ components: name: index in: path description: |- - Comma-separated list of data streams, indices, and aliases. + Comma-separated list of data streams, indexes, and aliases. Supports wildcards (`*`). required: true schema: @@ -21451,7 +22991,7 @@ components: name: index in: query description: |- - Comma-separated list of data streams, indices, and aliases. + Comma-separated list of data streams, indexes, and aliases. Supports wildcards (`*`). required: true schema: @@ -21475,43 +23015,43 @@ components: knn.search_models___query._source: name: _source in: query - description: True or false to return the _source field or not, or a list of fields to return. + description: Set to `true` or `false` to return the `_source` field or not, or a list of fields to return. style: form schema: type: array items: type: string - description: True or false to return the _source field or not, or a list of fields to return. + description: Set to `true` or `false` to return the `_source` field or not, or a list of fields to return. explode: true knn.search_models___query._source_excludes: name: _source_excludes in: query - description: List of fields to exclude from the returned _source field. + description: List of fields to exclude from the returned `_source` field. style: form schema: type: array items: type: string - description: List of fields to exclude from the returned _source field. + description: List of fields to exclude from the returned `_source` field. explode: true knn.search_models___query._source_includes: name: _source_includes in: query - description: List of fields to extract and return from the _source field. + description: List of fields to extract and return from the `_source` field. style: form schema: type: array items: type: string - description: List of fields to extract and return from the _source field. + description: List of fields to extract and return from the `_source` field. explode: true knn.search_models___query.allow_no_indices: name: allow_no_indices in: query - description: Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified). + description: Whether to ignore if a wildcard indexes expression resolves into no concrete indexes. (This includes `_all` string or when no indexes have been specified). schema: type: boolean - description: Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified). + description: Whether to ignore if a wildcard indexes expression resolves into no concrete indexes. (This includes `_all` string or when no indexes have been specified). knn.search_models___query.allow_partial_search_results: name: allow_partial_search_results in: query @@ -21579,7 +23119,7 @@ components: knn.search_models___query.expand_wildcards: name: expand_wildcards in: query - description: Whether to expand wildcard expression to concrete indices that are open, closed or both. + description: Whether to expand wildcard expression to concrete indexes that are open, closed or both. schema: $ref: '#/components/schemas/_common___ExpandWildcards' knn.search_models___query.explain: @@ -21601,17 +23141,17 @@ components: knn.search_models___query.ignore_throttled: name: ignore_throttled in: query - description: Whether specified concrete, expanded or aliased indices should be ignored when throttled. + description: Whether specified concrete, expanded or aliased indexes should be ignored when throttled. schema: type: boolean - description: Whether specified concrete, expanded or aliased indices should be ignored when throttled. + description: Whether specified concrete, expanded or aliased indexes should be ignored when throttled. knn.search_models___query.ignore_unavailable: name: ignore_unavailable in: query - description: Whether specified concrete indices should be ignored when unavailable (missing or closed). + description: Whether specified concrete indexes should be ignored when unavailable (missing or closed). schema: type: boolean - description: Whether specified concrete indices should be ignored when unavailable (missing or closed). + description: Whether specified concrete indexes should be ignored when unavailable (missing or closed). knn.search_models___query.lenient: name: lenient in: query @@ -21631,10 +23171,10 @@ components: knn.search_models___query.pre_filter_shard_size: name: pre_filter_shard_size in: query - description: Threshold that enforces a pre-filter round-trip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter round-trip can limit the number of shards significantly if for instance a shard can not match any documents based on its rewrite method ie. if date filters are mandatory to match but the shard bounds and the query are disjoint. + description: Threshold that enforces a pre-filter round-trip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter round-trip can limit the number of shards significantly if for instance a shard can not match any documents based on its rewrite method, that is if date filters are mandatory to match but the shard bounds and the query are disjoint. schema: type: integer - description: Threshold that enforces a pre-filter round-trip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter round-trip can limit the number of shards significantly if for instance a shard can not match any documents based on its rewrite method ie. if date filters are mandatory to match but the shard bounds and the query are disjoint. + description: Threshold that enforces a pre-filter round-trip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter round-trip can limit the number of shards significantly if for instance a shard can not match any documents based on its rewrite method, that is if date filters are mandatory to match but the shard bounds and the query are disjoint. format: int32 knn.search_models___query.preference: name: preference @@ -21661,11 +23201,11 @@ components: knn.search_models___query.rest_total_hits_as_int: name: rest_total_hits_as_int in: query - description: Indicates whether hits.total should be rendered as an integer or an object in the rest search response. + description: Indicates whether `hits.total` should be rendered as an integer or an object in the rest search response. schema: type: boolean default: false - description: Indicates whether hits.total should be rendered as an integer or an object in the rest search response. + description: Indicates whether `hits.total` should be rendered as an integer or an object in the rest search response. knn.search_models___query.routing: name: routing in: query @@ -21835,12 +23375,19 @@ components: - graph_memory_usage_percentage - graph_query_errors - graph_query_requests + - graph_stats - hit_count - indexing_from_model_degraded - indices_in_cache - knn_query_requests + - knn_query_with_filter_requests - load_exception_count - load_success_count + - lucene_initialized + - max_distance_query_requests + - max_distance_query_with_filter_requests + - min_score_query_requests + - min_score_query_with_filter_requests - miss_count - model_index_status - nmslib_initialized @@ -21878,13 +23425,279 @@ components: knn.warmup___path.index: name: index in: path - description: Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices. + description: Comma-separated list of indexes; use `_all` or empty string to perform the operation on all indexes. schema: type: array - description: Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices. + description: Comma-separated list of indexes; use `_all` or empty string to perform the operation on all indexes. items: type: string required: true + list.indices___path.index: + in: path + name: index + description: |- + Comma-separated list of data streams, indexes, and aliases used to limit the request. + Supports wildcards (`*`). To target all data streams and indexes, omit this parameter or use `*` or `_all`. + required: true + schema: + $ref: '#/components/schemas/_common___Indices' + style: simple + list.indices___query.bytes: + in: query + name: bytes + description: The unit used to display byte values. + schema: + $ref: '#/components/schemas/_common___ByteUnit' + style: form + list.indices___query.cluster_manager_timeout: + name: cluster_manager_timeout + in: query + description: Operation timeout for connection to cluster-manager node. + schema: + $ref: '#/components/schemas/_common___Duration' + x-version-added: '2.0' + list.indices___query.expand_wildcards: + in: query + name: expand_wildcards + description: The type of index that wildcard patterns can match. + schema: + $ref: '#/components/schemas/_common___ExpandWildcards' + style: form + list.indices___query.format: + name: format + in: query + description: A short version of the Accept header, such as `JSON`, `YAML`. + schema: + type: string + description: A short version of the Accept header, such as `JSON`, `YAML`. + list.indices___query.h: + name: h + in: query + description: Comma-separated list of column names to display. + style: form + schema: + type: array + items: + type: string + description: Comma-separated list of column names to display. + explode: true + list.indices___query.health: + in: query + name: health + description: The health status used to limit returned indexes. By default, the response includes indexes of any health status. + schema: + $ref: '#/components/schemas/_common___HealthStatus' + style: form + list.indices___query.help: + name: help + in: query + description: Return help information. + schema: + type: boolean + default: false + description: Return help information. + list.indices___query.include_unloaded_segments: + in: query + name: include_unloaded_segments + description: If `true`, the response includes information from segments that are not loaded into memory. + schema: + type: boolean + default: false + style: form + list.indices___query.local: + name: local + in: query + description: Return local information, do not retrieve the state from cluster-manager node. + schema: + type: boolean + default: false + description: Return local information, do not retrieve the state from cluster-manager node. + list.indices___query.master_timeout: + name: master_timeout + in: query + description: Operation timeout for connection to cluster-manager node. + schema: + $ref: '#/components/schemas/_common___Duration' + x-version-deprecated: '2.0' + x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. + deprecated: true + list.indices___query.next_token: + name: next_token + in: query + description: Token to retrieve next page of indexes. + schema: + type: + - 'null' + - string + description: Token to retrieve next page of indexes. + list.indices___query.pri: + in: query + name: pri + description: If `true`, the response only includes information from primary shards. + schema: + type: boolean + default: false + style: form + list.indices___query.s: + name: s + in: query + description: Comma-separated list of column names or column aliases to sort by. + style: form + schema: + type: array + items: + type: string + description: Comma-separated list of column names or column aliases to sort by. + explode: true + list.indices___query.size: + name: size + in: query + description: Maximum number of indexes to be displayed in a page. + schema: + type: integer + format: int32 + list.indices___query.sort: + name: sort + in: query + description: Defines order in which indexes will be displayed. Accepted values are `asc` and `desc`. If `desc`, most recently created indexes would be displayed first. + schema: + type: string + enum: + - asc + - desc + list.indices___query.time: + in: query + name: time + description: The unit used to display time values. + schema: + $ref: '#/components/schemas/_common___TimeUnit' + style: form + list.indices___query.v: + name: v + in: query + description: Verbose mode. Display column headers. + schema: + type: boolean + default: false + description: Verbose mode. Display column headers. + list.shards___path.index: + in: path + name: index + description: |- + A comma-separated list of data streams, indexes, and aliases used to limit the request. + Supports wildcards (`*`). + To target all data streams and indexes, omit this parameter or use `*` or `_all`. + required: true + schema: + $ref: '#/components/schemas/_common___Indices' + style: simple + list.shards___query.bytes: + in: query + name: bytes + description: The unit used to display byte values. + schema: + $ref: '#/components/schemas/_common___ByteUnit' + style: form + list.shards___query.cluster_manager_timeout: + name: cluster_manager_timeout + in: query + description: Operation timeout for connection to cluster-manager node. + schema: + $ref: '#/components/schemas/_common___Duration' + x-version-added: '2.0' + list.shards___query.format: + name: format + in: query + description: A short version of the Accept header, such as `JSON`, `YAML`. + schema: + type: string + description: A short version of the Accept header, such as `JSON`, `YAML`. + list.shards___query.h: + name: h + in: query + description: Comma-separated list of column names to display. + style: form + schema: + type: array + items: + type: string + description: Comma-separated list of column names to display. + explode: true + list.shards___query.help: + name: help + in: query + description: Return help information. + schema: + type: boolean + default: false + description: Return help information. + list.shards___query.local: + name: local + in: query + description: Return local information, do not retrieve the state from cluster-manager node. + schema: + type: boolean + default: false + description: Return local information, do not retrieve the state from cluster-manager node. + list.shards___query.master_timeout: + name: master_timeout + in: query + description: Operation timeout for connection to cluster-manager node. + schema: + $ref: '#/components/schemas/_common___Duration' + x-version-deprecated: '2.0' + x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. + deprecated: true + list.shards___query.next_token: + name: next_token + in: query + description: Token to retrieve next page of shards. + schema: + type: + - 'null' + - string + description: Token to retrieve next page of shards. + list.shards___query.s: + name: s + in: query + description: Comma-separated list of column names or column aliases to sort by. + style: form + schema: + type: array + items: + type: string + description: Comma-separated list of column names or column aliases to sort by. + explode: true + list.shards___query.size: + name: size + in: query + description: Maximum number of shards to be displayed in a page. + schema: + type: integer + format: int32 + list.shards___query.sort: + name: sort + in: query + description: Defines order in which shards will be displayed. Accepted values are `asc` and `desc`. If `desc`, most recently created shards would be displayed first. + schema: + type: string + enum: + - asc + - desc + list.shards___query.time: + name: time + in: query + description: The unit in which to display time values. + schema: + $ref: '#/components/schemas/_common___TimeUnit' + list.shards___query.v: + name: v + in: query + description: Verbose mode. Display column headers. + schema: + type: boolean + default: false + description: Verbose mode. Display column headers. mget___path.index: in: path name: index @@ -21896,7 +23709,7 @@ components: mget___query._source: in: query name: _source - description: True or false to return the `_source` field or not, or a list of fields to return. + description: Set to `true` or `false` to return the `_source` field or not, or a list of fields to return. schema: $ref: '#/components/schemas/_core.search___SourceConfigParam' style: form @@ -21939,7 +23752,7 @@ components: name: refresh description: If `true`, the request refreshes relevant shards before retrieving documents. schema: - type: boolean + $ref: '#/components/schemas/_common___Refresh' style: form mget___query.routing: in: query @@ -21955,6 +23768,31 @@ components: schema: $ref: '#/components/schemas/_common___Fields' style: form + ml.chunk_model___path.chunk_number: + name: chunk_number + in: path + required: true + schema: + type: integer + format: int64 + ml.chunk_model___path.model_id: + name: model_id + in: path + required: true + schema: + type: string + ml.create_controller___path.model_id: + name: model_id + in: path + required: true + schema: + type: string + ml.create_message___path.memory_id: + name: memory_id + in: path + required: true + schema: + type: string ml.delete_agent___path.agent_id: name: agent_id in: path @@ -21967,6 +23805,18 @@ components: required: true schema: type: string + ml.delete_controller___path.model_id: + name: model_id + in: path + required: true + schema: + type: string + ml.delete_memory___path.memory_id: + name: memory_id + in: path + required: true + schema: + type: string ml.delete_model_group___path.model_group_id: name: model_group_id in: path @@ -21991,31 +23841,282 @@ components: required: true schema: type: string + ml.execute_agent___path.agent_id: + name: agent_id + in: path + required: true + schema: + type: string + ml.get_agent___path.agent_id: + name: agent_id + in: path + required: true + schema: + type: string + ml.get_all_memories___query.max_results: + name: max_results + in: query + required: false + schema: + description: The maximum number of results to return. If there are fewer memories than the number set in `max_results`, the response returns only the number of memories that exist. Default is `10`. + type: integer + format: int32 + ml.get_all_memories___query.next_token: + name: next_token + in: query + required: false + schema: + description: The index of the first memory in the sorted list of memories to return. Memories are ordered by `create_time`. For example, if memories `A`, `B`, and `C` exist, `next_token=1` returns memories `B` and `C`. Default is `0` (return all memories). + type: integer + format: int32 + ml.get_all_messages___path.memory_id: + name: memory_id + in: path + required: true + schema: + type: string + ml.get_all_messages___query.max_results: + name: max_results + in: query + required: false + schema: + type: integer + format: int32 + ml.get_all_messages___query.next_token: + name: next_token + in: query + required: false + schema: + type: integer + format: int32 + ml.get_connector___path.connector_id: + name: connector_id + in: path + required: true + schema: + type: string + ml.get_controller___path.model_id: + name: model_id + in: path + required: true + schema: + type: string + ml.get_memory___path.memory_id: + name: memory_id + in: path + required: true + schema: + type: string + ml.get_message_traces___path.message_id: + name: message_id + in: path + required: true + schema: + type: string + ml.get_message_traces___query.max_results: + name: max_results + in: query + required: false + schema: + type: integer + format: int32 + ml.get_message_traces___query.next_token: + name: next_token + in: query + required: false + schema: + type: integer + format: int32 + ml.get_message___path.message_id: + name: message_id + in: path + required: true + schema: + type: string ml.get_model_group___path.model_group_id: name: model_group_id in: path required: true schema: type: string + ml.get_model___path.model_id: + name: model_id + in: path + required: true + schema: + type: string + ml.get_profile_models___path.model_id: + name: model_id + in: path + required: true + schema: + type: string + ml.get_profile_tasks___path.task_id: + name: task_id + in: path + required: true + schema: + type: string + ml.get_stats___path.node_id: + name: node_id + in: path + required: true + schema: + type: string + ml.get_stats___path.stat: + name: stat + in: path + required: true + schema: + type: string + enum: + - ml_config_index_status + - ml_connector_count + - ml_connector_index_status + - ml_controller_index_status + - ml_model_count + - ml_model_index_status + - ml_task_index_status ml.get_task___path.task_id: name: task_id in: path required: true schema: type: string + ml.get_tool___path.tool_name: + name: tool_name + in: path + required: true + schema: + type: string + enum: + - AgentTool + - CatIndexTool + - ConnectorTool + - CreateAnomalyDetectorTool + - IndexMappingTool + - LogPatternTool + - MLModelTool + - NeuralSparseSearchTool + - PPLTool + - RAGTool + - SearchAlertsTool + - SearchAnomalyDetectorsTool + - SearchAnomalyResultsTool + - SearchIndexTool + - SearchMonitorsTool + - VectorDBTool + - VisualizationTool + ml.load_model___path.model_id: + name: model_id + in: path + required: true + schema: + type: string + ml.predict_model___path.model_id: + name: model_id + in: path + required: true + schema: + type: string + ml.predict___path.algorithm_name: + name: algorithm_name + in: path + required: true + schema: + type: string + ml.predict___path.model_id: + name: model_id + in: path + required: true + schema: + type: string + ml.search_message___path.memory_id: + name: memory_id + in: path + required: true + schema: + type: string + ml.train_predict___path.algorithm_name: + name: algorithm_name + in: path + required: true + schema: + type: string + ml.train___path.algorithm_name: + name: algorithm_name + in: path + required: true + schema: + type: string ml.undeploy_model___path.model_id: name: model_id in: path required: true schema: type: string + ml.unload_model___path.model_id: + name: model_id + in: path + required: true + schema: + type: string + ml.update_connector___path.connector_id: + name: connector_id + in: path + required: true + schema: + type: string + ml.update_controller___path.model_id: + name: model_id + in: path + required: true + schema: + type: string + ml.update_memory___path.memory_id: + name: memory_id + in: path + required: true + schema: + type: string + ml.update_message___path.message_id: + name: message_id + in: path + required: true + schema: + type: string + ml.update_model_group___path.model_group_id: + name: model_group_id + in: path + required: true + schema: + type: string + ml.update_model___path.model_id: + name: model_id + in: path + required: true + schema: + type: string + ml.upload_chunk___path.chunk_number: + name: chunk_number + in: path + required: true + schema: + type: integer + format: int64 + ml.upload_chunk___path.model_id: + name: model_id + in: path + required: true + schema: + type: string msearch_template___path.index: in: path name: index description: |- - Comma-separated list of data streams, indices, and aliases to search. + Comma-separated list of data streams, indexes, and aliases to search. Supports wildcards (`*`). - To search all data streams and indices, omit this parameter or use `*`. + To search all data streams and indexes, omit this parameter or use `*`. required: true schema: $ref: '#/components/schemas/_common___Indices' @@ -22065,7 +24166,7 @@ components: msearch___path.index: in: path name: index - description: Comma-separated list of data streams, indices, and index aliases to search. + description: Comma-separated list of data streams, indexes, and index aliases to search. required: true schema: $ref: '#/components/schemas/_common___Indices' @@ -22073,7 +24174,7 @@ components: msearch___query.ccs_minimize_roundtrips: in: query name: ccs_minimize_roundtrips - description: If true, network roundtrips between the coordinating node and remote clusters are minimized for cross-cluster search requests. + description: If `true`, network round-trips between the coordinating node and remote clusters are minimized for cross-cluster search requests. schema: type: boolean default: true @@ -22106,7 +24207,7 @@ components: msearch___query.rest_total_hits_as_int: in: query name: rest_total_hits_as_int - description: If true, hits.total are returned as an integer in the response. Defaults to false, which returns an object. + description: If `true`, `hits.total` are returned as an integer in the response. Defaults to false, which returns an object. schema: type: boolean default: false @@ -22196,7 +24297,7 @@ components: mtermvectors___query.realtime: in: query name: realtime - description: If true, the request is real-time as opposed to near-real-time. + description: If `true`, the request is real-time as opposed to near-real-time. schema: type: boolean default: true @@ -22211,7 +24312,7 @@ components: mtermvectors___query.term_statistics: in: query name: term_statistics - description: If true, the response includes term frequency and document frequency. + description: If `true`, the response includes term frequency and document frequency. schema: type: boolean default: false @@ -22257,11 +24358,11 @@ components: nodes.hot_threads___query.snapshots: name: snapshots in: query - description: Number of samples of thread stacktrace. + description: Number of samples of thread stack trace. schema: type: integer default: 10 - description: Number of samples of thread stacktrace. + description: Number of samples of thread stack trace. format: int32 nodes.hot_threads___query.threads: name: threads @@ -22287,7 +24388,7 @@ components: nodes.info___path.metric: in: path name: metric - description: Limits the information returned to the specific metrics. Supports a comma-separated list, such as http,ingest. + description: Limits the information returned to the specific metrics. Supports a comma-separated list, such as `http,ingest`. required: true schema: type: array @@ -22307,7 +24408,7 @@ components: name: node_id_or_metric description: | Limits the information returned to a list of node IDs or specific metrics. - Supports a comma-separated list, such as node1,node2 or http,ingest. + Supports a comma-separated list, such as `node1,node2` or `http,ingest`. required: true schema: anyOf: @@ -22321,7 +24422,7 @@ components: nodes.info___query.flat_settings: in: query name: flat_settings - description: If true, returns settings in flat format. + description: If `true`, returns settings in flat format. schema: type: boolean default: false @@ -22353,7 +24454,7 @@ components: nodes.stats___path.index_metric: in: path name: index_metric - description: Limit the information returned for indices metric to the specific index metrics. It can be used only if indices (or all) metric is specified. + description: Limit the information returned for indexes metric to the specific index metrics. It can be used only if indexes (or all) metric is specified. required: true schema: type: array @@ -22381,14 +24482,14 @@ components: nodes.stats___query.completion_fields: in: query name: completion_fields - description: Comma-separated list or wildcard expressions of fields to include in fielddata and suggest statistics. + description: Comma-separated list or wildcard expressions of fields to include in field data and suggest statistics. schema: $ref: '#/components/schemas/_common___Fields' style: form nodes.stats___query.fielddata_fields: in: query name: fielddata_fields - description: Comma-separated list or wildcard expressions of fields to include in fielddata statistics. + description: Comma-separated list or wildcard expressions of fields to include in field data statistics. schema: $ref: '#/components/schemas/_common___Fields' style: form @@ -22411,7 +24512,7 @@ components: nodes.stats___query.include_segment_file_sizes: in: query name: include_segment_file_sizes - description: If true, the call reports the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested). + description: If `true`, the call reports the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested). schema: type: boolean default: false @@ -22756,7 +24857,7 @@ components: ppl.explain___query.format: name: format in: query - description: A short version of the Accept header, e.g. json, yaml. + description: A short version of the Accept header (for example, `json`, `yaml`). schema: type: string ppl.explain___query.sanitize: @@ -22769,7 +24870,7 @@ components: ppl.get_stats___query.format: name: format in: query - description: A short version of the Accept header, e.g. json, yaml. + description: A short version of the Accept header (for example, `json`, `yaml`). schema: type: string ppl.get_stats___query.sanitize: @@ -22782,7 +24883,7 @@ components: ppl.post_stats___query.format: name: format in: query - description: A short version of the Accept header, e.g. json, yaml. + description: A short version of the Accept header (for example, `json`, `yaml`). schema: type: string ppl.post_stats___query.sanitize: @@ -22795,7 +24896,7 @@ components: ppl.query___query.format: name: format in: query - description: A short version of the Accept header, e.g. json, yaml. + description: A short version of the Accept header (for example, `json`, `yaml`). schema: type: string ppl.query___query.sanitize: @@ -22844,14 +24945,14 @@ components: in: query name: master_timeout description: |- - Period to wait for a connection to the master node. + Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error. deprecated: true schema: $ref: '#/components/schemas/_common___Duration' style: form x-version-deprecated: '2.0' - x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. put_script___query.timeout: in: query name: timeout @@ -22879,8 +24980,8 @@ components: in: path name: index description: |- - Comma-separated list of data streams, indices, and index aliases used to limit the request. Wildcard (`*`) expressions are supported. - To target all data streams and indices in a cluster, omit this parameter or use `_all` or `*`. + Comma-separated list of data streams, indexes, and index aliases used to limit the request. Wildcard (`*`) expressions are supported. + To target all data streams and indexes in a cluster, omit this parameter or use `_all` or `*`. required: true schema: $ref: '#/components/schemas/_common___Indices' @@ -22888,21 +24989,21 @@ components: rank_eval___query.allow_no_indices: in: query name: allow_no_indices - description: If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. + description: If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indexes. This behavior applies even if the request targets other open indexes. For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. schema: type: boolean style: form rank_eval___query.expand_wildcards: in: query name: expand_wildcards - description: Whether to expand wildcard expression to concrete indices that are open, closed or both. + description: Whether to expand wildcard expression to concrete indexes that are open, closed or both. schema: $ref: '#/components/schemas/_common___ExpandWildcards' style: form rank_eval___query.ignore_unavailable: in: query name: ignore_unavailable - description: If `true`, missing or closed indices are not included in the response. + description: If `true`, missing or closed indexes are not included in the response. schema: type: boolean style: form @@ -22942,7 +25043,7 @@ components: name: refresh description: If `true`, the request refreshes affected shards to make this operation visible to search. schema: - type: boolean + $ref: '#/components/schemas/_common___Refresh' style: form reindex___query.requests_per_second: in: query @@ -22955,6 +25056,11 @@ components: format: float default: 0 style: form + reindex___query.require_alias: + in: query + name: require_alias + schema: + type: boolean reindex___query.scroll: in: query name: scroll @@ -23023,6 +25129,54 @@ components: schema: $ref: '#/components/schemas/_common___Id' style: simple + replication.pause___path.index: + in: path + name: index + description: Name of the data stream, index, or index alias to perform bulk actions on. + required: true + schema: + $ref: '#/components/schemas/_common___IndexName' + style: simple + replication.resume___path.index: + in: path + name: index + description: Name of the data stream, index, or index alias to perform bulk actions on. + required: true + schema: + $ref: '#/components/schemas/_common___IndexName' + style: simple + replication.start___path.index: + in: path + name: index + description: Name of the data stream, index, or index alias to perform bulk actions on. + required: true + schema: + $ref: '#/components/schemas/_common___IndexName' + style: simple + replication.status___path.index: + in: path + name: index + description: Name of the data stream, index, or index alias to perform bulk actions on. + required: true + schema: + $ref: '#/components/schemas/_common___IndexName' + style: simple + replication.stop___path.index: + in: path + name: index + description: Name of the data stream, index, or index alias to perform bulk actions on. + required: true + schema: + $ref: '#/components/schemas/_common___IndexName' + style: simple + replication.update_settings___path.index: + in: path + name: index + description: Name of the data stream, index, or index alias to perform bulk actions on. + required: true + schema: + $ref: '#/components/schemas/_common___IndexName' + style: simple rollups.delete___path.id: name: id in: path @@ -23097,7 +25251,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 @@ -23174,7 +25328,7 @@ components: search_shards___path.index: in: path name: index - description: Returns the indices and shards that a search request would be executed against. + description: Returns the indexes and shards that a search request would be executed against. required: true schema: $ref: '#/components/schemas/_common___Indices' @@ -23183,8 +25337,8 @@ components: in: query name: allow_no_indices description: |- - If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. - This behavior applies even if the request targets other open indices. + If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indexes. + This behavior applies even if the request targets other open indexes. For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. schema: type: boolean @@ -23236,7 +25390,7 @@ components: in: path name: index description: |- - Comma-separated list of data streams, indices, + Comma-separated list of data streams, indexes, and aliases to search. Supports wildcards (*). required: true schema: @@ -23246,8 +25400,8 @@ components: in: query name: allow_no_indices description: |- - If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. - This behavior applies even if the request targets other open indices. + If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indexes. + This behavior applies even if the request targets other open indexes. For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. schema: type: boolean @@ -23281,7 +25435,7 @@ components: search_template___query.ignore_throttled: in: query name: ignore_throttled - description: If `true`, specified concrete, expanded, or aliased indices are not included in the response when throttled. + description: If `true`, specified concrete, expanded, or aliased indexes are not included in the response when throttled. schema: type: boolean style: form @@ -23312,7 +25466,7 @@ components: search_template___query.rest_total_hits_as_int: in: query name: rest_total_hits_as_int - description: If true, hits.total are rendered as an integer in the response. + description: If `true`, `hits.total` are rendered as an integer in the response. schema: type: boolean default: false @@ -23351,9 +25505,9 @@ components: in: path name: index description: |- - Comma-separated list of data streams, indices, and aliases to search. + Comma-separated list of data streams, indexes, and aliases to search. Supports wildcards (`*`). - To search all data streams and indices, omit this parameter or use `*` or `_all`. + To search all data streams and indexes, omit this parameter or use `*` or `_all`. required: true schema: $ref: '#/components/schemas/_common___Indices' @@ -23396,8 +25550,8 @@ components: in: query name: allow_no_indices description: |- - If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. - This behavior applies even if the request targets other open indices. + If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indexes. + This behavior applies even if the request targets other open indexes. For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. schema: type: boolean @@ -23405,7 +25559,7 @@ components: search___query.allow_partial_search_results: in: query name: allow_partial_search_results - description: If true, returns partial results if there are shard request timeouts or shard failures. If false, returns an error with no partial results. + description: If `true`, returns partial results if there are shard request timeouts or shard failures. If `false`, returns an error with no partial results. schema: type: boolean default: true @@ -23414,7 +25568,7 @@ components: in: query name: analyze_wildcard description: |- - If true, wildcard and prefix queries are analyzed. + If `true`, wildcard and prefix queries are analyzed. This parameter can only be used when the q query string parameter is specified. schema: type: boolean @@ -23452,7 +25606,7 @@ components: search___query.ccs_minimize_roundtrips: in: query name: ccs_minimize_roundtrips - description: If true, network round-trips between the coordinating node and the remote clusters are minimized when executing cross-cluster search (CCS) requests. + description: If `true`, network round-trips between the coordinating node and the remote clusters are minimized when executing cross-cluster search (CCS) requests. schema: type: boolean default: true @@ -23515,7 +25669,7 @@ components: search___query.ignore_throttled: in: query name: ignore_throttled - description: If `true`, concrete, expanded or aliased indices will be ignored when frozen. + description: If `true`, concrete, expanded or aliased indexes will be ignored when frozen. schema: type: boolean style: form @@ -23529,11 +25683,11 @@ components: search___query.include_named_queries_score: name: include_named_queries_score in: query - description: Indicates whether hit.matched_queries should be rendered as a map that includes the name of the matched query associated with its score (true) or as an array containing the name of the matched queries (false) + description: Indicates whether `hit.matched_queries` should be rendered as a map that includes the name of the matched query associated with its score (true) or as an array containing the name of the matched queries (false) schema: type: boolean default: false - description: Indicates whether hit.matched_queries should be rendered as a map that includes the name of the matched query associated with its score (true) or as an array containing the name of the matched queries (false) + description: Indicates whether `hit.matched_queries` should be rendered as a map that includes the name of the matched query associated with its score (true) or as an array containing the name of the matched queries (false) search___query.lenient: in: query name: lenient @@ -23673,11 +25827,7 @@ components: name: sort description: A comma-separated list of : pairs. schema: - oneOf: - - type: string - - type: array - items: - type: string + $ref: '#/components/schemas/_common___StringOrStringArray' style: form search___query.stats: in: query @@ -23744,7 +25894,7 @@ components: Use with caution. OpenSearch applies this parameter to each shard handling the request. When possible, let OpenSearch perform early termination automatically. - Avoid specifying this parameter for requests that target data streams with backing indices across multiple data tiers. + Avoid specifying this parameter for requests that target data streams with backing indexes across multiple data tiers. If set to `0` (default), the query does not terminate early. schema: type: integer @@ -23940,14 +26090,14 @@ components: security.get_distinguished_name___query.show_all: name: show_all in: query - description: A boolean flag to include/exclude static nodes DN from final result. + description: A Boolean flag to include/exclude static nodes DN from final result. schema: type: boolean required: false security.get_distinguished_names___query.show_all: name: show_all in: query - description: A boolean flag to include/exclude static nodes DN from final result. + description: A Boolean flag to include/exclude static nodes DN from final result. schema: type: boolean required: false @@ -23987,7 +26137,7 @@ components: security.get_sslinfo___query.show_dn: name: show_dn in: query - description: A boolean flag to indicate whether all domain names should be returned. + description: A Boolean flag to indicate whether all domain names should be returned. schema: type: - boolean @@ -24017,7 +26167,7 @@ components: security.health___query.mode: name: mode in: query - description: A flag to indicate whether service should consider security-plugin's status before returning health response. `strict` mode indicates service should check security plugin status. + description: A flag to indicate whether service should consider security-plugin's status before returning health response. `strict` mode indicates service should check Security plugin status. schema: type: string required: false @@ -24031,7 +26181,7 @@ components: security.patch_distinguished_name___path.cluster_name: name: cluster_name in: path - description: The cluster-name to update nodesDn value. + description: The cluster name to update `nodesDn` value. schema: type: string required: true @@ -24066,17 +26216,114 @@ components: security.update_distinguished_name___path.cluster_name: name: cluster_name in: path - description: The cluster-name to create/update nodesDn value for. + description: The cluster-name to create/update `nodesDn` value for. schema: type: string required: true security.validate___query.accept_invalid: name: accept_invalid in: query - description: A boolean flag to indicate whether invalid v6 configuration should be allowed. + description: A Boolean flag to indicate whether invalid v6 configuration should be allowed. schema: type: boolean required: false + sm.create_policy___path.policy_name: + name: policy_name + in: path + description: The name of the snapshot management policy. + required: true + schema: + type: string + sm.delete_policy___path.policy_name: + name: policy_name + in: path + description: The name of the snapshot management policy. + required: true + schema: + type: string + sm.explain_policy___path.policy_name: + name: policy_name + in: path + description: The name of the snapshot management policy. + required: true + schema: + type: string + sm.get_policies___query.from: + name: from + in: query + description: 'The starting index (default: 0)' + schema: + type: integer + sm.get_policies___query.queryString: + name: queryString + in: query + description: A query string to filter policies. + schema: + type: string + sm.get_policies___query.size: + name: size + in: query + description: The number of policies to return. + schema: + type: integer + sm.get_policies___query.sortField: + name: sortField + in: query + description: The field to sort on. + schema: + type: string + sm.get_policies___query.sortOrder: + name: sortOrder + in: query + description: The order of sorting. + schema: + type: string + enum: + - asc + - desc + default: asc + sm.get_policy___path.policy_name: + name: policy_name + in: path + description: The name of the snapshot management policy. + required: true + schema: + type: string + sm.start_policy___path.policy_name: + name: policy_name + in: path + description: The name of the snapshot management policy. + required: true + schema: + type: string + sm.stop_policy___path.policy_name: + name: policy_name + in: path + description: The name of the snapshot management policy. + required: true + schema: + type: string + sm.update_policy___path.policy_name: + name: policy_name + in: path + description: The name of the snapshot management policy. + required: true + schema: + type: string + sm.update_policy___query.if_primary_term: + name: if_primary_term + in: query + description: The primary term of the policy to update. + required: true + schema: + type: integer + sm.update_policy___query.if_seq_no: + name: if_seq_no + in: query + description: The sequence number of the policy to update. + required: true + schema: + type: integer snapshot.cleanup_repository___path.repository: in: path name: repository @@ -24095,13 +26342,13 @@ components: snapshot.cleanup_repository___query.master_timeout: in: query name: master_timeout - description: Period to wait for a connection to the master node. + description: Period to wait for a connection to the cluster-manager node. deprecated: true schema: $ref: '#/components/schemas/_common___Duration' style: form x-version-deprecated: '2.0' - x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. snapshot.cleanup_repository___query.timeout: in: query name: timeout @@ -24143,13 +26390,13 @@ components: snapshot.clone___query.master_timeout: in: query name: master_timeout - description: Explicit operation timeout for connection to master node + description: Explicit operation timeout for connection to cluster-manager node deprecated: true schema: $ref: '#/components/schemas/_common___Duration' style: form x-version-deprecated: '2.0' - x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. snapshot.create_repository___path.repository: in: path name: repository @@ -24168,13 +26415,13 @@ components: snapshot.create_repository___query.master_timeout: in: query name: master_timeout - description: Explicit operation timeout for connection to master node + description: Explicit operation timeout for connection to cluster-manager node deprecated: true schema: $ref: '#/components/schemas/_common___Duration' style: form x-version-deprecated: '2.0' - x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. snapshot.create_repository___query.timeout: in: query name: timeout @@ -24215,13 +26462,13 @@ components: snapshot.create___query.master_timeout: in: query name: master_timeout - description: Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + description: Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error. deprecated: true schema: $ref: '#/components/schemas/_common___Duration' style: form x-version-deprecated: '2.0' - x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. snapshot.create___query.wait_for_completion: in: query name: wait_for_completion @@ -24248,13 +26495,13 @@ components: snapshot.delete_repository___query.master_timeout: in: query name: master_timeout - description: Explicit operation timeout for connection to master node + description: Explicit operation timeout for connection to cluster-manager node deprecated: true schema: $ref: '#/components/schemas/_common___Duration' style: form x-version-deprecated: '2.0' - x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. snapshot.delete_repository___query.timeout: in: query name: timeout @@ -24288,13 +26535,13 @@ components: snapshot.delete___query.master_timeout: in: query name: master_timeout - description: Explicit operation timeout for connection to master node + description: Explicit operation timeout for connection to cluster-manager node deprecated: true schema: $ref: '#/components/schemas/_common___Duration' style: form x-version-deprecated: '2.0' - x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. snapshot.get_repository___path.repository: in: path name: repository @@ -24321,13 +26568,13 @@ components: snapshot.get_repository___query.master_timeout: in: query name: master_timeout - description: Explicit operation timeout for connection to master node + description: Explicit operation timeout for connection to cluster-manager node deprecated: true schema: $ref: '#/components/schemas/_common___Duration' style: form x-version-deprecated: '2.0' - x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. snapshot.get___path.repository: in: path name: repository @@ -24340,9 +26587,9 @@ components: in: path name: snapshot description: |- - Comma-separated list of snapshot names to retrieve. Also accepts wildcards (*). - - To get information about all snapshots in a registered repository, use a wildcard (*) or _all. - - To get information about any snapshots that are currently running, use _current. + Comma-separated list of snapshot names to retrieve. Also accepts wildcards (`*`). + - To get information about all snapshots in a registered repository, use a wildcard (`*`) or `_all`. + - To get information about any snapshots that are currently running, use `_current`. required: true schema: $ref: '#/components/schemas/_common___Names' @@ -24357,7 +26604,7 @@ components: snapshot.get___query.ignore_unavailable: in: query name: ignore_unavailable - description: If false, the request returns an error for any snapshots that are unavailable. + description: If `false`, the request returns an error for any snapshots that are unavailable. schema: type: boolean default: false @@ -24365,17 +26612,17 @@ components: snapshot.get___query.master_timeout: in: query name: master_timeout - description: Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + description: Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error. deprecated: true schema: $ref: '#/components/schemas/_common___Duration' style: form x-version-deprecated: '2.0' - x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. snapshot.get___query.verbose: in: query name: verbose - description: If true, returns additional information about each snapshot such as the version of OpenSearch which took the snapshot, the start and end times of the snapshot, and the number of shards snapshotted. + description: If `true`, returns additional information about each snapshot such as the version of OpenSearch which took the snapshot, the start and end times of the snapshot, and the number of shards snapshotted. schema: type: boolean style: form @@ -24405,13 +26652,13 @@ components: snapshot.restore___query.master_timeout: in: query name: master_timeout - description: Explicit operation timeout for connection to master node + description: Explicit operation timeout for connection to cluster-manager node deprecated: true schema: $ref: '#/components/schemas/_common___Duration' style: form x-version-deprecated: '2.0' - x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. snapshot.restore___query.wait_for_completion: in: query name: wait_for_completion @@ -24446,7 +26693,7 @@ components: snapshot.status___query.ignore_unavailable: in: query name: ignore_unavailable - description: Whether to ignore unavailable snapshots, defaults to false which means a SnapshotMissingException is thrown + description: Whether to ignore unavailable snapshots, defaults to `false` which means a SnapshotMissingException is thrown schema: type: boolean default: false @@ -24454,13 +26701,13 @@ components: snapshot.status___query.master_timeout: in: query name: master_timeout - description: Explicit operation timeout for connection to master node + description: Explicit operation timeout for connection to cluster-manager node deprecated: true schema: $ref: '#/components/schemas/_common___Duration' style: form x-version-deprecated: '2.0' - x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. snapshot.verify_repository___path.repository: in: path name: repository @@ -24479,13 +26726,13 @@ components: snapshot.verify_repository___query.master_timeout: in: query name: master_timeout - description: Explicit operation timeout for connection to master node + description: Explicit operation timeout for connection to cluster-manager node deprecated: true schema: $ref: '#/components/schemas/_common___Duration' style: form x-version-deprecated: '2.0' - x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. snapshot.verify_repository___query.timeout: in: query name: timeout @@ -24496,7 +26743,7 @@ components: sql.close___query.format: name: format in: query - description: A short version of the Accept header, e.g. json, yaml. + description: A short version of the Accept header (for example, `json`, `yaml`). schema: type: string sql.close___query.sanitize: @@ -24509,7 +26756,7 @@ components: sql.explain___query.format: name: format in: query - description: A short version of the Accept header, e.g. json, yaml. + description: A short version of the Accept header (for example, `json`, `yaml`). schema: type: string sql.explain___query.sanitize: @@ -24522,7 +26769,7 @@ components: sql.get_stats___query.format: name: format in: query - description: A short version of the Accept header, e.g. json, yaml. + description: A short version of the Accept header (for example, `json`, `yaml`). schema: type: string sql.get_stats___query.sanitize: @@ -24535,7 +26782,7 @@ components: sql.post_stats___query.format: name: format in: query - description: A short version of the Accept header, e.g. json, yaml. + description: A short version of the Accept header (for example, `json`, `yaml`). schema: type: string sql.post_stats___query.sanitize: @@ -24548,7 +26795,7 @@ components: sql.query___query.format: name: format in: query - description: A short version of the Accept header, e.g. json, yaml. + description: A short version of the Accept header (for example, `json`, `yaml`). schema: type: string sql.query___query.sanitize: @@ -24561,7 +26808,7 @@ components: sql.settings___query.format: name: format in: query - description: A short version of the Accept header, e.g. json, yaml. + description: A short version of the Accept header (for example, `json`, `yaml`). schema: type: string tasks.cancel___path.task_id: @@ -24577,11 +26824,7 @@ components: name: actions description: Comma-separated list or wildcard expression of actions used to limit the request. schema: - oneOf: - - type: string - - type: array - items: - type: string + $ref: '#/components/schemas/_common___StringOrStringArray' style: form tasks.cancel___query.nodes: in: query @@ -24637,11 +26880,7 @@ components: name: actions description: Comma-separated list or wildcard expression of actions used to limit the request. schema: - oneOf: - - type: string - - type: array - items: - type: string + $ref: '#/components/schemas/_common___StringOrStringArray' style: form tasks.list___query.detailed: in: query @@ -24761,7 +27000,7 @@ components: termvectors___query.realtime: in: query name: realtime - description: If true, the request is real-time as opposed to near-real-time. + description: If `true`, the request is real-time as opposed to near-real-time. schema: type: boolean default: true @@ -24919,9 +27158,9 @@ components: in: path name: index description: |- - Comma-separated list of data streams, indices, and aliases to search. + Comma-separated list of data streams, indexes, and aliases to search. Supports wildcards (`*`). - To search all data streams or indices, omit this parameter or use `*` or `_all`. + To search all data streams or indexes, omit this parameter or use `*` or `_all`. required: true schema: $ref: '#/components/schemas/_common___Indices' @@ -24929,42 +27168,39 @@ components: update_by_query___query._source: name: _source in: query - description: True or false to return the _source field or not, or a list of fields to return. + description: Set to `true` or `false` to return the `_source` field or not, or a list of fields to return. style: form schema: - type: array - items: - type: string - description: True or false to return the _source field or not, or a list of fields to return. + $ref: '#/components/schemas/_core.search___SourceConfigParam' explode: true update_by_query___query._source_excludes: name: _source_excludes in: query - description: List of fields to exclude from the returned _source field. + description: List of fields to exclude from the returned `_source` field. style: form schema: type: array items: type: string - description: List of fields to exclude from the returned _source field. + description: List of fields to exclude from the returned `_source` field. explode: true update_by_query___query._source_includes: name: _source_includes in: query - description: List of fields to extract and return from the _source field. + description: List of fields to extract and return from the `_source` field. style: form schema: type: array items: type: string - description: List of fields to extract and return from the _source field. + description: List of fields to extract and return from the `_source` field. explode: true update_by_query___query.allow_no_indices: in: query name: allow_no_indices description: |- - If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. - This behavior applies even if the request targets other open indices. + If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indexes. + This behavior applies even if the request targets other open indexes. For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. schema: type: boolean @@ -25081,7 +27317,7 @@ components: name: refresh description: If `true`, OpenSearch refreshes affected shards to make the operation visible to search. schema: - type: boolean + $ref: '#/components/schemas/_common___Refresh' style: form update_by_query___query.request_cache: in: query @@ -25139,10 +27375,10 @@ components: update_by_query___query.size: name: size in: query - description: Deprecated, please use `max_docs` instead. + description: Deprecated, use `max_docs` instead. schema: type: integer - description: Deprecated, please use `max_docs` instead. + description: Deprecated, use `max_docs` instead. format: int32 update_by_query___query.slices: in: query @@ -25180,7 +27416,7 @@ components: Use with caution. OpenSearch applies this parameter to each shard handling the request. When possible, let OpenSearch perform early termination automatically. - Avoid specifying this parameter for requests that target data streams with backing indices across multiple data tiers. + Avoid specifying this parameter for requests that target data streams with backing indexes across multiple data tiers. schema: type: integer format: int32 @@ -25238,7 +27474,7 @@ components: in: query name: _source description: |- - Set to false to disable source retrieval. You can also specify a comma-separated + Set to `false` to disable source retrieval. You can also specify a comma-separated list of the fields you want to retrieve. schema: $ref: '#/components/schemas/_core.search___SourceConfigParam' @@ -25285,15 +27521,15 @@ components: name: refresh description: |- If 'true', OpenSearch refreshes the affected shards to make this operation - visible to search, if 'wait_for' then wait for a refresh to make this operation - visible to search, if 'false' do nothing with refreshes. + visible to search, if `wait_for` then wait for a refresh to make this operation + visible to search, if `false` do nothing with refreshes. schema: $ref: '#/components/schemas/_common___Refresh' style: form update___query.require_alias: in: query name: require_alias - description: If true, the destination must be an index alias. + description: If `true`, the destination must be an index alias. schema: type: boolean default: false @@ -25338,21 +27574,21 @@ components: wlm.delete_query_group___path.name: name: name in: path - description: QueryGroup name. + description: The name of the query group. schema: type: string required: true wlm.get_query_group___path.name: name: name in: path - description: QueryGroup name. + description: The name of the query group. schema: type: string required: true wlm.update_query_group___path.name: name: name in: path - description: QueryGroup name. + description: The name of the query group. schema: type: string required: true @@ -25406,7 +27642,7 @@ components: properties: scroll_id: $ref: '#/components/schemas/_common___ScrollIds' - description: Comma-separated list of scroll IDs to clear if none was specified via the scroll_id parameter + description: Comma-separated list of scroll IDs to clear if none was specified using the `scroll_id` parameter cluster.allocation_explain: content: application/json: @@ -25419,12 +27655,13 @@ components: index: $ref: '#/components/schemas/_common___IndexName' primary: - description: If true, returns explanation for the primary shard for the given shard ID. + description: When `true`, returns a routing explanation for the primary shard based on the node ID. type: boolean shard: description: Specifies the ID of the shard that you would like an explanation for. - type: number - description: The index, shard, and primary flag to explain. Empty means 'explain the first unassigned shard' + type: integer + format: int32 + description: The index, shard, and primary flag for which to generate an explanation. Leave this empty to generate an explanation for the first unassigned shard. cluster.delete_weighted_routing: content: application/json: @@ -25438,10 +27675,9 @@ components: properties: allow_auto_create: description: |- - This setting overrides the value of the `action.auto_create_index` cluster setting. - If set to `true` in a template, then indices can be automatically created using that - template even if auto-creation of indices is disabled via `actions.auto_create_index`. - If set to `false` then data streams matching the template must always be explicitly created. + This setting overrides the `action.auto_create_index` cluster setting. + When set to `true` in a component template, indexes are automatically created using that + template. When set to `false`, data streams matching the component template must always be explicitly created. type: boolean template: $ref: '#/components/schemas/indices._common___IndexState' @@ -25451,7 +27687,7 @@ components: $ref: '#/components/schemas/_common___Metadata' required: - template - description: The template definition + description: The template definition. required: true cluster.put_settings: content: @@ -25465,7 +27701,7 @@ components: transient: type: object additionalProperties: {} - description: The settings to be updated. Can be either `transient` or `persistent` (survives cluster restart). + description: The cluster settings to update. required: true cluster.put_weighted_routing: content: @@ -25479,7 +27715,7 @@ components: type: object properties: commands: - description: Defines the commands to perform. + description: Defines the reroute commands to perform, either `move`, `cancel`, or `allocate`. type: array items: $ref: '#/components/schemas/cluster.reroute___Command' @@ -25637,8 +27873,7 @@ components: settings: description: Configuration options for the target index. type: object - additionalProperties: - type: object + additionalProperties: true description: The configuration for the target index (`settings` and `aliases`) indices.create: content: @@ -25679,7 +27914,7 @@ components: is_write_index: description: |- If `true`, sets the write index or data stream for the alias. - If an alias points to multiple indices or data streams and `is_write_index` isn't set, the alias rejects write requests. + If an alias points to multiple indexes or data streams and `is_write_index` isn't set, the alias rejects write requests. If an index alias points to one index and `is_write_index` isn't set, the index automatically acts as the write index. Data stream aliases don't automatically set a write data stream, even if the alias points to one data stream. type: boolean @@ -25718,7 +27953,7 @@ components: The index template with the highest priority is chosen. If no priority is specified the template is treated as though it is of priority 0 (lowest priority). This number is not automatically generated by OpenSearch. - type: number + type: integer version: $ref: '#/components/schemas/_common___VersionNumber' _meta: @@ -25739,7 +27974,7 @@ components: dynamic_date_formats: description: |- If date detection is enabled then new string fields are checked - against 'dynamic_date_formats' and if the value matches then + against `dynamic_date_formats` and if the value matches then a new date field is added instead of string. type: array items: @@ -25782,6 +28017,7 @@ components: content: application/json: schema: + title: settings $ref: '#/components/schemas/indices._common___IndexSettings' required: true indices.put_template: @@ -25798,12 +28034,8 @@ components: index_patterns: description: |- Array of wildcard expressions used to match the names - of indices during creation. - oneOf: - - type: string - - type: array - items: - type: string + of indexes during creation. + $ref: '#/components/schemas/_common___StringOrStringArray' mappings: $ref: '#/components/schemas/_common.mapping___TypeMapping' order: @@ -25813,12 +28045,12 @@ components: Templates with lower 'order' values are merged first. Templates with higher 'order' values are merged later, overriding templates with lower values. - type: number + type: integer + format: int32 settings: description: Configuration options for the index. type: object - additionalProperties: - type: object + additionalProperties: true version: $ref: '#/components/schemas/_common___VersionNumber' description: The template definition @@ -25845,8 +28077,7 @@ components: Configuration options for the index. Data streams do not support this parameter. type: object - additionalProperties: - type: object + additionalProperties: true description: The conditions that needs to be met for executing rollover indices.shrink: content: @@ -25864,8 +28095,7 @@ components: settings: description: Configuration options for the target index. type: object - additionalProperties: - type: object + additionalProperties: true description: The configuration for the target index (`settings` and `aliases`) indices.simulate_index_template: content: @@ -25876,8 +28106,8 @@ components: allow_auto_create: description: |- This setting overrides the value of the `action.auto_create_index` cluster setting. - If set to `true` in a template, then indices can be automatically created using that template even if auto-creation of indices is disabled via `actions.auto_create_index`. - If set to `false`, then indices or data streams matching the template must always be explicitly created, and may never be automatically created. + If set to `true` in a template, then indexes can be automatically created using that template even if auto-creation of indexes is disabled using `actions.auto_create_index`. + If set to `false`, then indexes or data streams matching the template must always be explicitly created, and may never be automatically created. type: boolean index_patterns: $ref: '#/components/schemas/_common___Indices' @@ -25898,7 +28128,7 @@ components: The index template with the highest priority is chosen. If no priority is specified the template is treated as though it is of priority 0 (lowest priority). This number is not automatically generated by OpenSearch. - type: number + type: integer version: $ref: '#/components/schemas/_common___VersionNumber' _meta: @@ -25908,6 +28138,7 @@ components: content: application/json: schema: + title: template $ref: '#/components/schemas/indices._common___IndexTemplate' indices.split: content: @@ -26022,64 +28253,243 @@ components: schema: type: object knn.train_model: + content: + application/json: + schema: + $ref: '#/components/schemas/knn._common___TrainedModel' + mget: + content: + application/json: + schema: + type: object + properties: + docs: + description: The documents you want to retrieve. Required if no index is specified in the request URI. + type: array + items: + $ref: '#/components/schemas/_core.mget___Operation' + ids: + $ref: '#/components/schemas/_common___Ids' + description: Document identifiers; can be either `docs` (containing full document information) or `ids` (when index is provided in the URL. + required: true + ml.chunk_model: content: application/json: schema: type: object properties: - training_index: + chunk: type: string - training_field: + description: The model chunk. + required: + - chunk + ml.create_connector: + content: + application/json: + schema: + type: object + properties: + name: type: string - dimension: - type: integer - format: int32 - max_training_vector_count: - type: integer - format: int32 - search_size: - type: integer - format: int32 description: type: string - mode: + version: + type: integer + protocol: + type: string + enum: + - aws_sigv4 + - http + credential: + $ref: '#/components/schemas/ml._common___Credential' + parameters: + $ref: '#/components/schemas/ml._common___Parameters' + client_config: + $ref: '#/components/schemas/ml._common___ClientConfig' + actions: + type: array + items: + $ref: '#/components/schemas/ml._common___Action' + required: + - actions + - credential + - description + - name + - parameters + - protocol + - version + ml.create_controller: + content: + application/json: + schema: + type: object + properties: + user_rate_limiter: + type: object + additionalProperties: + $ref: '#/components/schemas/ml._common___RateLimiter' + ml.create_memory: + content: + application/json: + schema: + type: object + properties: + name: + $ref: '#/components/schemas/_common___Name' + ml.create_message: + content: + application/json: + schema: + type: object + properties: + input: + type: string + description: The question in the message. + prompt_template: + type: string + description: The prompt template. + response: + type: string + description: The answer to the question. + origin: type: string - compression_level: + description: The system name that generated the response. + additional_info: + $ref: '#/components/schemas/ml._common___AdditionalInfo' + ml.create_model_meta: + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: The model name. + version: + $ref: '#/components/schemas/_common___VersionString' + model_format: + $ref: '#/components/schemas/ml._common___ModelFormat' + model_group_id: + $ref: '#/components/schemas/_common___Id' + model_content_hash_value: type: string - method: + description: The model content hash value. + model_config: + $ref: '#/components/schemas/ml._common___ModelConfig' + total_chunks: + type: integer + format: int64 + description: Number of chunks the model is split into. + url: type: string - spaceType: + description: The model URL. + description: type: string + description: The model description. required: - - dimension - - training_field - - training_index - required: true - mget: + - model_config + - model_content_hash_value + - model_format + - name + - total_chunks + - version + ml.execute_agent: content: application/json: schema: type: object properties: - docs: - description: The documents you want to retrieve. Required if no index is specified in the request URI. + parameters: + $ref: '#/components/schemas/ml._common___Parameters' + parameters.verbose: + type: boolean + description: Whether to provide verbose output. + required: + - parameters + ml.get_profile: + content: + application/json: + schema: + $ref: '#/components/schemas/ml._common___ProfileRequest' + ml.get_profile_models: + content: + application/json: + schema: + $ref: '#/components/schemas/ml._common___ProfileRequest' + ml.get_profile_tasks: + content: + application/json: + schema: + $ref: '#/components/schemas/ml._common___ProfileRequest' + ml.predict: + content: + application/json: + schema: + type: object + properties: + input_query: + $ref: '#/components/schemas/ml._common___InputQuery' + input_index: type: array items: - $ref: '#/components/schemas/_core.mget___Operation' - ids: - $ref: '#/components/schemas/_common___Ids' - description: Document identifiers; can be either `docs` (containing full document information) or `ids` (when index is provided in the URL. - required: true - ml.create_connector: + type: string + description: The input index. + text_docs: + type: array + items: + type: string + description: The text documents. + return_number: + type: boolean + description: Whether to return bytes in model output. + target_response: + type: array + items: + type: string + description: The target response. + ml.predict_model: content: application/json: schema: - $ref: '#/components/schemas/ml._common___CreateConnectorRequest' + type: object + properties: + query_text: + type: string + description: The query text. + text_docs: + type: array + items: + type: string + description: The text documents. + required: + - text_docs ml.register_agents: content: application/json: schema: - $ref: '#/components/schemas/ml._common___RegisterAgentsRequest' + type: object + properties: + name: + type: string + type: + type: string + description: + type: string + tools: + type: array + items: + $ref: '#/components/schemas/ml._common___ToolItems' + parameters: + $ref: '#/components/schemas/ml._common___Parameters' + app_type: + type: string + memory: + $ref: '#/components/schemas/ml._common___Memory' + llm: + $ref: '#/components/schemas/ml._common___LLM' + required: + - name + - type ml.register_model: content: application/json: @@ -26090,24 +28500,22 @@ components: type: string description: The model name. version: - type: string - description: The model version. + $ref: '#/components/schemas/_common___VersionString' model_format: - type: string - description: The portable format of the model file. - enum: - - ONNX - - TORCH_SCRIPT + $ref: '#/components/schemas/ml._common___ModelFormat' description: type: string description: The model description. model_group_id: + $ref: '#/components/schemas/_common___Id' + function_name: + type: string + description: The function name. + connector_id: type: string - description: The ID of the model group to which to register the model. + description: The connector ID. required: - - model_format - name - - version ml.register_model_group: content: application/json: @@ -26137,11 +28545,393 @@ components: description: The add all backend roles. required: - name + ml.register_model_meta: + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: The model name. + version: + $ref: '#/components/schemas/_common___VersionString' + model_format: + $ref: '#/components/schemas/ml._common___ModelFormat' + model_group_id: + $ref: '#/components/schemas/_common___Id' + model_content_hash_value: + type: string + description: The model content hash value. + model_config: + $ref: '#/components/schemas/ml._common___ModelConfig' + total_chunks: + type: integer + format: int64 + description: Number of chunks the model is split into. + url: + type: string + description: The model URL. + description: + type: string + description: The model description. + required: + - model_config + - model_content_hash_value + - model_format + - name + - total_chunks + - version + ml.search_agents: + content: + application/json: + schema: + type: object + properties: + query: + $ref: '#/components/schemas/ml._common___Query' + size: + type: integer + description: The number of agents to return. + sort: + type: array + items: + $ref: '#/components/schemas/ml._common___SortAgent' + description: The sort order. + ml.search_connectors: + content: + application/json: + schema: + type: object + properties: + query: + $ref: '#/components/schemas/ml._common___Query' + size: + type: integer + description: The number of connectors to return. + sort: + type: array + items: + type: string + description: The sort order. + ml.search_memory: + content: + application/json: + schema: + type: object + properties: + query: + $ref: '#/components/schemas/ml._common___Query' + size: + type: integer + format: int64 + description: The number of memories to return. + sort: + type: array + items: + $ref: '#/components/schemas/ml._common___SortMemory' + description: The sort order. + ml.search_message: + content: + application/json: + schema: + type: object + properties: + query: + $ref: '#/components/schemas/ml._common___Query' + size: + type: integer + format: int64 + description: The number of messages to return. + sort: + type: array + items: + $ref: '#/components/schemas/ml._common___SortMessage' + description: The sort order. + ml.search_model_group: + content: + application/json: + schema: + type: object + properties: + query: + $ref: '#/components/schemas/ml._common___Query' + size: + type: integer + format: int64 + description: The number of model groups to return. + sort: + type: array + items: + $ref: '#/components/schemas/ml._common___Sort' + description: The sort order. ml.search_models: content: application/json: schema: - $ref: '#/components/schemas/ml._common___SearchModelsQuery' + type: object + properties: + query: + type: object + $ref: '#/components/schemas/ml._common___Query' + size: + type: integer + format: int64 + description: The number of models to return. + sort: + type: array + items: + $ref: '#/components/schemas/ml._common___Sort' + description: The sort order. + ml.search_tasks: + content: + application/json: + schema: + type: object + properties: + query: + $ref: '#/components/schemas/ml._common___Query' + size: + type: integer + format: int64 + description: The number of tasks to return. + sort: + type: array + items: + $ref: '#/components/schemas/ml._common___Sort' + description: The sort order. + ml.train: + content: + application/json: + schema: + type: object + properties: + parameters: + $ref: '#/components/schemas/ml._common___TrainParameters' + input_query: + $ref: '#/components/schemas/ml._common___InputQuery' + input_index: + type: array + description: The input index. + items: + type: string + ml.train_predict: + content: + application/json: + schema: + type: object + properties: + parameters: + $ref: '#/components/schemas/ml._common___TrainParameters' + input_query: + $ref: '#/components/schemas/ml._common___InputQuery' + input_index: + type: array + description: The input index. + items: + type: string + input_data: + $ref: '#/components/schemas/ml._common___PredictionResult' + ml.undeploy_model: + content: + application/json: + schema: + type: object + properties: + node_ids: + type: array + items: + $ref: '#/components/schemas/_common___Id' + model_ids: + type: array + items: + $ref: '#/components/schemas/_common___Id' + ml.unload_model: + content: + application/json: + schema: + type: object + properties: + node_ids: + type: array + items: + $ref: '#/components/schemas/_common___Id' + model_ids: + type: array + items: + $ref: '#/components/schemas/_common___Id' + ml.update_connector: + content: + application/json: + schema: + type: object + properties: + name: + $ref: '#/components/schemas/_common___Name' + description: + type: string + description: The connector description. + version: + $ref: '#/components/schemas/_common___VersionNumber' + protocol: + type: string + description: The connector protocol. + enum: + - aws_sigv4 + - http + parameters: + $ref: '#/components/schemas/ml._common___Parameters' + credential: + $ref: '#/components/schemas/ml._common___Credential' + actions: + type: array + items: + $ref: '#/components/schemas/ml._common___Action' + backend_roles: + type: array + items: + type: string + description: The backend roles. + access_mode: + type: string + description: The model group access mode. + enum: + - private + - public + - restricted + parameters.skip_validating_missing_parameters: + type: boolean + description: Whether to skip validating missing parameters. + ml.update_controller: + content: + application/json: + schema: + type: object + properties: + user_rate_limiter: + type: object + additionalProperties: + $ref: '#/components/schemas/ml._common___RateLimiter' + model_id: + $ref: '#/components/schemas/_common___Name' + ml.update_memory: + content: + application/json: + schema: + type: object + properties: + name: + $ref: '#/components/schemas/_common___Name' + ml.update_message: + content: + application/json: + schema: + type: object + properties: + input: + type: string + description: The question in the message. + prompt_template: + type: string + description: The prompt template. + response: + type: string + description: The answer to the question. + origin: + type: string + description: The system name that generated the response. + additional_info: + $ref: '#/components/schemas/ml._common___AdditionalInfo' + ml.update_model: + content: + application/json: + schema: + type: object + properties: + connector: + type: object + description: The connector to use for the model. + connector_id: + type: string + description: The connector ID. + is_enabled: + type: boolean + description: Whether the model is enabled. + description: + type: string + description: The model description. + model_config: + $ref: '#/components/schemas/ml._common___ModelConfig' + name: + type: string + description: The model name. + rate_limiter: + $ref: '#/components/schemas/ml._common___RateLimiter' + guardrails: + $ref: '#/components/schemas/ml._common___Guardrails' + interface: + type: object + description: The model interface. + ml.update_model_group: + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: The model group name. + description: + type: string + description: The model group description. + add_all_backend_roles: + type: boolean + description: Whether to include all backend roles. + model_access_name: + type: string + description: The model access name + backend_roles: + type: array + items: + type: string + description: The backend roles. + add_backend_roles: + type: array + items: + type: string + description: The backend roles to add. + ml.upload_chunk: + content: + application/json: + schema: + type: object + properties: + chunk: + type: string + description: The model chunk. + required: + - chunk + ml.upload_model: + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: The model name. + version: + $ref: '#/components/schemas/_common___VersionString' + model_format: + $ref: '#/components/schemas/ml._common___ModelFormat' + description: + type: string + description: The model description. + model_group_id: + $ref: '#/components/schemas/_common___Id' + required: + - name + - version msearch: content: application/x-ndjson: @@ -26185,7 +28975,7 @@ components: properties: secure_settings_password: $ref: '#/components/schemas/_common___Password' - description: An object containing the password for the opensearch keystore + description: An object containing the password for the OpenSearch keystore. notifications.create_config: content: application/json: @@ -26337,24 +29127,65 @@ components: schema: type: object properties: - file: - type: string + id: + $ref: '#/components/schemas/_common___Id' params: description: |- Key-value pairs used to replace Mustache variables in the template. The key is the variable name. The value is the variable value. type: object - additionalProperties: - type: object + additionalProperties: true source: description: |- An inline search template. - Supports the same parameters as the search API's request body. + Supports the same parameters as the search API request body. These parameters also support Mustache variables. If no `id` or `` is specified, this parameter is required. type: string - description: The search definition template and its params + description: The search definition template and its parameters. + replication.create_replication_rule: + content: + application/json: + schema: + $ref: '#/components/schemas/replication._common___CreateReplicationRule' + required: true + replication.delete_replication_rule: + content: + application/json: + schema: + $ref: '#/components/schemas/replication._common___DeleteReplicationRule' + required: true + replication.pause: + content: + application/json: + schema: + type: object + required: true + replication.resume: + content: + application/json: + schema: + type: object + required: true + replication.start: + content: + application/json: + schema: + $ref: '#/components/schemas/replication._common___Replication' + required: true + replication.stop: + content: + application/json: + schema: + type: object + required: true + replication.update_settings: + content: + application/json: + schema: + $ref: '#/components/schemas/replication._common___UpdateSettings' + required: true rollups.put: content: application/json: @@ -26384,9 +29215,6 @@ components: $ref: '#/components/schemas/_common___Duration' scroll_id: $ref: '#/components/schemas/_common___ScrollId' - required: - - scroll_id - description: The scroll ID if not passed by URL or query parameter. search: content: application/json: @@ -26398,10 +29226,15 @@ components: type: object additionalProperties: $ref: '#/components/schemas/_common.aggregations___AggregationContainer' + aggs: + description: Defines the aggregations that are run as part of the search request. + type: object + additionalProperties: + $ref: '#/components/schemas/_common.aggregations___AggregationContainer' collapse: $ref: '#/components/schemas/_core.search___FieldCollapse' explain: - description: If true, returns detailed information about score computation as part of a hit. + description: If `true`, returns detailed information about score computation as part of a hit. type: boolean ext: description: Configuration of search extensions defined by OpenSearch plugins. @@ -26421,7 +29254,7 @@ components: track_total_hits: $ref: '#/components/schemas/_core.search___TrackHits' indices_boost: - description: Boosts the _score of documents from specified indices. + description: Boosts the `_score` of documents from specified indexes. type: array items: type: object @@ -26496,7 +29329,7 @@ components: Use with caution. OpenSearch applies this parameter to each shard handling the request. When possible, let OpenSearch perform early termination automatically. - Avoid specifying this parameter for requests that target data streams with backing indices across multiple data tiers. + Avoid specifying this parameter for requests that target data streams with backing indexes across multiple data tiers. If set to `0` (default), the query does not terminate early. type: integer format: int32 @@ -26507,10 +29340,10 @@ components: Defaults to no timeout. type: string track_scores: - description: If true, calculate and return document scores, even if the scores are not used for sorting. + description: If `true`, calculate and return document scores, even if the scores are not used for sorting. type: boolean version: - description: If true, returns document version as part of a hit. + description: If `true`, returns document version as part of a hit. type: boolean seq_no_primary_term: description: If `true`, returns sequence number and primary term of the last modification of each hit. @@ -26523,7 +29356,7 @@ components: description: |- Stats groups to associate with the search. Each group maintains a statistics aggregation for its associated searches. - You can retrieve these stats using the indices stats API. + You can retrieve these stats using the indexes stats API. type: array items: type: string @@ -26558,11 +29391,11 @@ components: type: boolean source: description: |- - An inline search template. Supports the same parameters as the search API's + An inline search template. Supports the same parameters as the search API request body. Also supports Mustache variables. If no id is specified, this parameter is required. type: string - description: The search definition template and its params + description: The search definition template and its parameters. required: true security.change_password: content: @@ -26673,7 +29506,7 @@ components: content: application/json: schema: - $ref: '#/components/schemas/security._common___PatchOperation' + $ref: '#/components/schemas/security._common___PatchOperations' security.patch_distinguished_names: content: application/json: @@ -26763,6 +29596,16 @@ components: application/json: schema: $ref: '#/components/schemas/security._common___DistinguishedNames' + sm.create_policy: + content: + application/json: + schema: + $ref: '#/components/schemas/sm._common___CreateUpdatePolicyRequest' + sm.update_policy: + content: + application/json: + schema: + $ref: '#/components/schemas/sm._common___CreateUpdatePolicyRequest' snapshot.clone: content: application/json: @@ -26782,22 +29625,22 @@ components: type: object properties: ignore_unavailable: - description: If `true`, the request ignores data streams and indices in `indices` that are missing or closed. If `false`, the request returns an error for any data stream or index that is missing or closed. + description: If `true`, the request ignores data streams and indexes in `indexes` that are missing or closed. If `false`, the request returns an error for any data stream or index that is missing or closed. type: boolean include_global_state: - description: If `true`, the current cluster state is included in the snapshot. The cluster state includes persistent cluster settings, composable index templates, legacy index templates, ingest pipelines, and ILM policies. It also includes data stored in system indices, such as Watches and task records (configurable via `feature_states`). + description: If `true`, the current cluster state is included in the snapshot. The cluster state includes persistent cluster settings, composable index templates, legacy index templates, ingest pipelines, and ILM policies. It also includes data stored in system indexes, such as Watches and task records (configurable with `feature_states`). type: boolean indices: $ref: '#/components/schemas/_common___Indices' feature_states: - description: Feature states to include in the snapshot. Each feature state includes one or more system indices containing related data. You can view a list of eligible features using the get features API. If `include_global_state` is `true`, all current feature states are included by default. If `include_global_state` is `false`, no feature states are included by default. + description: Feature states to include in the snapshot. Each feature state includes one or more system indexes containing related data. You can view a list of eligible features using the get features API. If `include_global_state` is `true`, all current feature states are included by default. If `include_global_state` is `false`, no feature states are included by default. type: array items: type: string metadata: $ref: '#/components/schemas/_common___Metadata' partial: - description: If `true`, allows restoring a partial snapshot of indices with unavailable shards. Only shards that were successfully included in the snapshot will be restored. All missing shards will be recreated as empty. If `false`, the entire restore operation will fail if one or more indices included in the snapshot do not have all primary shards available. + description: If `true`, allows restoring a partial snapshot of indexes with unavailable shards. Only shards that were successfully included in the snapshot will be restored. All missing shards will be recreated as empty. If `false`, the entire restore operation will fail if one or more indexes included in the snapshot do not have all primary shards available. type: boolean description: The snapshot definition snapshot.create_repository: @@ -26823,30 +29666,67 @@ components: schema: type: object properties: - feature_states: - type: array - items: - type: string ignore_index_settings: + description: A comma-delimited list of index settings that you don't want to restore from a snapshot. type: array items: type: string ignore_unavailable: type: boolean + description: How to handle data streams or indexes that are missing or closed. If `false`, the request returns an error for any data stream or index that is missing or closed. If `true`, the request ignores data streams and indexes in indexes that are missing or closed. Defaults to `false`. include_aliases: type: boolean + description: How to handle index aliases from the original snapshot. If `true`, index aliases from the original snapshot are restored. If `false`, aliases along with associated indexes are not restored. Defaults to `true`. include_global_state: type: boolean + description: Whether to restore the current cluster state. If `false`, the cluster state is not restored. If true, the current cluster state is restored. Defaults to `false`. index_settings: + description: A comma-delimited list of settings to add or change in all restored indexes. Use this parameter to override index settings during snapshot restoration. For data streams, these index settings are applied to the restored backing indexes. $ref: '#/components/schemas/indices._common___IndexSettings' indices: + description: A comma-delimited list of data streams and indexes to restore from the snapshot. Multi-index syntax is supported. By default, a restore operation includes all data streams and indexes in the snapshot. If this argument is provided, the restore operation only includes the data streams and indexes that you specify. $ref: '#/components/schemas/_common___Indices' partial: type: boolean + description: |- + How the restore operation will behave if indexes in the snapshot do not have all primary shards available. + If `false`, the entire restore operation fails if any indexes in the snapshot do not have all primary shards available. + If `true`, allows the restoration of a partial snapshot of indexes with unavailable shards. Only shards that were successfully included in the snapshot are restored. All missing shards are recreated as empty. By default, the entire restore operation fails if one or more indexes included in the snapshot do not have all primary shards available. To change this behavior, set `partial` to `true`. + Defaults to `false`. rename_pattern: type: string + description: |- + The pattern to apply to the restored data streams and indexes. Data streams and indexes matching the rename pattern will be renamed according to the `rename_replacement` setting. + The rename pattern is applied as defined by the regular expression that supports referencing the original text. + The request fails if two or more data streams or indexes are renamed into the same name. + If you rename a restored data stream, its backing indexes are also renamed. For example, if you rename the logs data stream to `recovered-logs`, the backing index `.ds-logs-1` is renamed to `.ds-recovered-logs-1`. + If you rename a restored stream, ensure an index template matches the new stream name. If there are no matching index template names, the stream cannot roll over and new backing indexes are not created. rename_replacement: type: string + description: The rename replacement string. + rename_alias_pattern: + x-version-added: '2.18' + type: string + description: |- + The pattern to apply to the restored aliases. Aliases matching the rename pattern will be renamed according to the `rename_alias_replacement` setting. + The rename pattern is applied as defined by the regular expression that supports referencing the original text. + If two or more aliases are renamed into the same name, these aliases will be merged into one. + rename_alias_replacement: + x-version-added: '2.18' + type: string + description: The rename replacement string for aliases. + source_remote_store_repository: + x-version-added: '2.10' + type: string + description: The name of the remote store repository of the source index being restored. If not provided, the Snapshot Restore API will use the repository that was registered when the snapshot was created. + storage_type: + x-version-added: '2.7' + type: string + description: |- + Where will be the authoritative store of the restored indexes' data. + A value of `local` indicates that all snapshot metadata and index data will be downloaded to local storage. + A value of `remote_snapshot` indicates that snapshot metadata will be downloaded to the cluster, but the remote repository will remain the authoritative store of the index data. Data will be downloaded and cached as necessary to service queries. At least one node in the cluster must be configured with the search role in order to restore a snapshot using the type `remote_snapshot`. + Defaults to `local`. description: Details of what to restore sql.close: content: @@ -26896,17 +29776,12 @@ components: content: application/json: schema: - type: object - properties: - transform: - $ref: '#/components/schemas/transforms._common___Transform' - required: - - transform + $ref: '#/components/schemas/transforms._common___TransformRequest' transforms.put: content: application/json: schema: - $ref: '#/components/schemas/transforms._common___Transform' + $ref: '#/components/schemas/transforms._common___TransformRequest' update: content: application/json: @@ -26915,19 +29790,19 @@ components: properties: detect_noop: description: |- - Set to false to disable setting 'result' in the response - to 'noop' if no change to the document occurred. + Set to `false` to disable setting `result` in the response + to `noop` if no change to the document occurred. type: boolean doc: description: A partial update to an existing document. type: object doc_as_upsert: - description: Set to true to use the contents of 'doc' as the value of 'upsert' + description: Set to `true` to use the contents of 'doc' as the value of 'upsert' type: boolean script: $ref: '#/components/schemas/_common___Script' scripted_upsert: - description: Set to true to execute the script whether or not the document exists. + description: Set to `true` to execute the script whether or not the document exists. type: boolean _source: $ref: '#/components/schemas/_core.search___SourceConfig' @@ -27071,7 +29946,7 @@ components: schema: type: array items: - $ref: '#/components/schemas/cat._common___CatPitSegmentsRecord' + $ref: '#/components/schemas/cat.segments___SegmentsRecord' description: '' cat.allocation___200: content: @@ -27228,7 +30103,7 @@ components: schema: type: array items: - $ref: '#/components/schemas/cat._common___CatPitSegmentsRecord' + $ref: '#/components/schemas/cat.segments___SegmentsRecord' description: '' cat.plugins___200: content: @@ -27272,7 +30147,7 @@ components: schema: type: array items: - $ref: '#/components/schemas/cat._common___CatSegmentReplicationRecord' + $ref: '#/components/schemas/cat.segment_replication___SegmentReplicationRecord' description: '' cat.segments___200: content: @@ -27355,6 +30230,21 @@ components: - num_freed - succeeded description: '' + clear_scroll___404: + content: + application/json: + schema: + type: object + properties: + succeeded: + type: boolean + num_freed: + type: integer + format: int32 + required: + - num_freed + - succeeded + description: '' cluster.allocation_explain___200: content: application/json: @@ -27412,7 +30302,8 @@ components: remaining_delay_in_millis: $ref: '#/components/schemas/_common___DurationValueUnitMillis' shard: - type: number + type: integer + format: int32 unassigned_info: $ref: '#/components/schemas/cluster.allocation_explain___UnassignedInformation' note: @@ -27565,34 +30456,55 @@ components: content: application/json: schema: - type: object - properties: - acknowledged: - type: boolean - explanations: - type: array - items: - $ref: '#/components/schemas/cluster.reroute___RerouteExplanation' - state: - description: |- - There aren't any guarantees on the output/structure of the raw cluster state. - Here you will find the internal representation of the cluster, which can - differ from the external representation. - type: object - required: - - acknowledged + allOf: + - $ref: '#/components/schemas/_common___AcknowledgedResponseBase' + - type: object + properties: + explanations: + type: array + items: + $ref: '#/components/schemas/cluster.reroute___RerouteExplanation' + state: + description: |- + Shows the internal representation of the structure, which can + differ from the external representation. description: '' cluster.state___200: content: application/json: - schema: - type: object + schema: {} description: '' cluster.stats___200: content: application/json: schema: - $ref: '#/components/schemas/cluster.stats___StatsResponseBase' + allOf: + - $ref: '#/components/schemas/nodes._common___NodesResponseBase' + - type: object + properties: + cluster_name: + description: The name of the cluster. + $ref: '#/components/schemas/_common___Name' + cluster_uuid: + description: The unique identifier of the cluster. + $ref: '#/components/schemas/_common___Uuid' + indices: + description: Displays statistics about indexes in the cluster. + $ref: '#/components/schemas/cluster.stats___ClusterIndices' + nodes: + description: Displays statistics about nodes selected by the request's node filters. + $ref: '#/components/schemas/cluster.stats___ClusterNodes' + status: + description: The health status of the cluster, based on the state of its primary and replica shards. + $ref: '#/components/schemas/_common___HealthStatus' + timestamp: + description: The Unix timestamp, in milliseconds, indicating when any cluster statistics were last refreshed. + $ref: '#/components/schemas/_common___EpochTimeUnitMillis' + required: + - cluster_name + - cluster_uuid + - status + - timestamp description: '' count___200: content: @@ -27620,24 +30532,24 @@ components: pit_id: type: string _shards: - $ref: '#/components/schemas/_core._common___ShardStatistics' + $ref: '#/components/schemas/_common___ShardStatistics' creation_time: type: integer format: int64 description: '' - create___200: + create___201: content: application/json: schema: $ref: '#/components/schemas/_common___WriteResponseBase' description: '' - dangling_indices.delete_dangling_index___200: + dangling_indices.delete_dangling_index___202: content: application/json: schema: $ref: '#/components/schemas/_common___AcknowledgedResponseBase' description: '' - dangling_indices.import_dangling_index___200: + dangling_indices.import_dangling_index___202: content: application/json: schema: @@ -27669,7 +30581,7 @@ components: pits: type: array items: - $ref: '#/components/schemas/_core._common___PitsDetailsDeleteAll' + $ref: '#/components/schemas/_core.pit___DeletedPit' description: '' delete_by_query_rethrottle___200: content: @@ -27697,7 +30609,7 @@ components: pits: type: array items: - $ref: '#/components/schemas/_core._common___DeletedPit' + $ref: '#/components/schemas/_core.pit___DeletedPit' description: '' delete_script___200: content: @@ -27721,16 +30633,26 @@ components: content: application/json: {} description: '' + exists_source___404: + content: + application/json: {} + description: '' exists___200: content: application/json: {} description: '' + exists___404: + content: + application/json: {} + description: '' explain___200: content: application/json: schema: type: object properties: + _type: + $ref: '#/components/schemas/_common___Type' _index: $ref: '#/components/schemas/_common___IndexName' _id: @@ -28004,7 +30926,7 @@ components: pits: type: array items: - $ref: '#/components/schemas/_core._common___PitDetail' + $ref: '#/components/schemas/_core.pit___PitDetail' description: '' get_script_context___200: content: @@ -28059,6 +30981,12 @@ components: schema: type: object description: '' + get_source___404: + content: + application/json: + schema: + $ref: '#/components/schemas/query._common___ErrorResponse' + description: '' get___200: content: application/json: @@ -28087,20 +31015,19 @@ components: content: application/json: schema: - type: object - properties: - acknowledged: - type: boolean - shards_acknowledged: - type: boolean - indices: - type: array - items: - $ref: '#/components/schemas/indices.add_block___IndicesBlockStatus' - required: - - acknowledged - - indices - - shards_acknowledged + allOf: + - $ref: '#/components/schemas/_common___AcknowledgedResponseBase' + - type: object + properties: + shards_acknowledged: + type: boolean + indices: + type: array + items: + $ref: '#/components/schemas/indices.add_block___IndicesBlockStatus' + required: + - indices + - shards_acknowledged description: '' indices.analyze___200: content: @@ -28125,37 +31052,35 @@ components: content: application/json: schema: - type: object - properties: - acknowledged: - type: boolean - index: - $ref: '#/components/schemas/_common___IndexName' - shards_acknowledged: - type: boolean - required: - - acknowledged - - index - - shards_acknowledged + allOf: + - $ref: '#/components/schemas/_common___AcknowledgedResponseBase' + - type: object + properties: + shards_acknowledged: + type: boolean + index: + $ref: '#/components/schemas/_common___IndexName' + required: + - index + - shards_acknowledged description: '' indices.close___200: content: application/json: schema: - type: object - properties: - acknowledged: - type: boolean - indices: - type: object - additionalProperties: - $ref: '#/components/schemas/indices.close___CloseIndexResult' - shards_acknowledged: - type: boolean - required: - - acknowledged - - indices - - shards_acknowledged + allOf: + - $ref: '#/components/schemas/_common___AcknowledgedResponseBase' + - type: object + properties: + indices: + type: object + additionalProperties: + $ref: '#/components/schemas/indices.close___CloseIndexResult' + shards_acknowledged: + type: boolean + required: + - indices + - shards_acknowledged description: '' indices.create_data_stream___200: content: @@ -28189,19 +31114,22 @@ components: _shards: $ref: '#/components/schemas/_common___ShardStatistics' backing_indices: - description: Total number of backing indices for the selected data streams. - type: number + description: Total number of backing indexes for the selected data streams. + type: integer + format: int32 data_stream_count: description: Total number of selected data streams. - type: number + type: integer + format: int32 data_streams: description: Contains statistics for the selected data streams. type: array items: - $ref: '#/components/schemas/indices.data_streams_stats___DataStreamsStatsItem' - total_store_sizes: + $ref: '#/components/schemas/indices._common___DataStreamStats' + total_store_size: $ref: '#/components/schemas/_common___HumanReadableByteCount' total_store_size_bytes: + description: Total size, in bytes, of all shards for the selected data streams. $ref: '#/components/schemas/_common___ByteCount' required: - _shards @@ -28286,8 +31214,8 @@ components: properties: task: description: |- - task contains a task id returned when wait_for_completion=false, - you can use the task_id to get the status of the task at _tasks/ + Task contains a task id returned when `wait_for_completion=false`, + you can use the `task_id` to get the status of the task at _tasks/. type: string description: '' indices.get_alias___200: @@ -28361,6 +31289,10 @@ components: $ref: '#/components/schemas/indices._common___TemplateMapping' description: '' indices.get_upgrade___200: + content: + application/json: + schema: + $ref: '#/components/schemas/indices._common___IndexGetUpgradeStatus' description: '' indices.get___200: content: @@ -28462,32 +31394,31 @@ components: content: application/json: schema: - type: object - properties: - acknowledged: - type: boolean - conditions: - type: object - additionalProperties: - type: boolean - dry_run: - type: boolean - new_index: - type: string - old_index: - type: string - rolled_over: - type: boolean - shards_acknowledged: - type: boolean - required: - - acknowledged - - conditions - - dry_run - - new_index - - old_index - - rolled_over - - shards_acknowledged + allOf: + - $ref: '#/components/schemas/_common___AcknowledgedResponseBase' + - type: object + properties: + conditions: + type: object + additionalProperties: + type: boolean + dry_run: + type: boolean + new_index: + type: string + old_index: + type: string + rolled_over: + type: boolean + shards_acknowledged: + type: boolean + required: + - conditions + - dry_run + - new_index + - old_index + - rolled_over + - shards_acknowledged description: '' indices.segments___200: content: @@ -28522,18 +31453,17 @@ components: content: application/json: schema: - type: object - properties: - acknowledged: - type: boolean - shards_acknowledged: - type: boolean - index: - $ref: '#/components/schemas/_common___IndexName' - required: - - acknowledged - - index - - shards_acknowledged + allOf: + - $ref: '#/components/schemas/_common___AcknowledgedResponseBase' + - type: object + properties: + shards_acknowledged: + type: boolean + index: + $ref: '#/components/schemas/_common___IndexName' + required: + - index + - shards_acknowledged description: '' indices.simulate_index_template___200: content: @@ -28560,18 +31490,17 @@ components: content: application/json: schema: - type: object - properties: - acknowledged: - type: boolean - shards_acknowledged: - type: boolean - index: - $ref: '#/components/schemas/_common___IndexName' - required: - - acknowledged - - index - - shards_acknowledged + allOf: + - $ref: '#/components/schemas/_common___AcknowledgedResponseBase' + - type: object + properties: + shards_acknowledged: + type: boolean + index: + $ref: '#/components/schemas/_common___IndexName' + required: + - index + - shards_acknowledged description: '' indices.stats___200: content: @@ -28598,6 +31527,17 @@ components: $ref: '#/components/schemas/_common___AcknowledgedResponseBase' description: '' indices.upgrade___200: + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/_common___ShardsOperationResponseBase' + - type: object + properties: + upgraded_indices: + type: object + additionalProperties: + $ref: '#/components/schemas/indices._common___UpgradeVersionStatus' description: '' indices.validate_query___200: content: @@ -28776,6 +31716,10 @@ components: $ref: '#/components/schemas/ism._common___RetryIndexResponse' description: '' knn.delete_model___200: + content: + application/json: + schema: + $ref: '#/components/schemas/knn._common___DeletedModel' description: '' knn.get_model___200: content: @@ -28784,8 +31728,16 @@ components: type: object description: '' knn.search_models___200: + content: + application/json: + schema: + $ref: '#/components/schemas/_core.search___ResponseBody' description: '' knn.stats___200: + content: + application/json: + schema: + $ref: '#/components/schemas/knn._common___Stats' description: '' knn.train_model___200: content: @@ -28799,6 +31751,124 @@ components: - model_id description: '' knn.warmup___200: + content: + application/json: + schema: + $ref: '#/components/schemas/_common___ShardsOperationResponseBase' + description: '' + list.help___200: + content: + text/plain: + schema: + type: string + description: '' + list.indices___200: + content: + text/plain: + schema: + type: string + application/json: + schema: + type: object + properties: + next_token: + type: + - 'null' + - string + indices: + type: array + items: + $ref: '#/components/schemas/cat.indices___IndicesRecord' + application/yaml: + schema: + type: object + properties: + next_token: + type: + - 'null' + - string + indices: + type: array + items: + $ref: '#/components/schemas/cat.indices___IndicesRecord' + application/cbor: + schema: + type: object + properties: + next_token: + type: + - 'null' + - string + indices: + type: array + items: + $ref: '#/components/schemas/cat.indices___IndicesRecord' + application/smile: + schema: + type: object + properties: + next_token: + type: + - 'null' + - string + indices: + type: array + items: + $ref: '#/components/schemas/cat.indices___IndicesRecord' + description: '' + list.shards___200: + content: + text/plain: + schema: + type: string + application/json: + schema: + type: object + properties: + next_token: + type: + - 'null' + - string + shards: + type: array + items: + $ref: '#/components/schemas/cat.shards___ShardsRecord' + application/yaml: + schema: + type: object + properties: + next_token: + type: + - 'null' + - string + shards: + type: array + items: + $ref: '#/components/schemas/cat.shards___ShardsRecord' + application/cbor: + schema: + type: object + properties: + next_token: + type: + - 'null' + - string + shards: + type: array + items: + $ref: '#/components/schemas/cat.shards___ShardsRecord' + application/smile: + schema: + type: object + properties: + next_token: + type: + - 'null' + - string + shards: + type: array + items: + $ref: '#/components/schemas/cat.shards___ShardsRecord' description: '' mget___200: content: @@ -28813,6 +31883,18 @@ components: required: - docs description: '' + ml.chunk_model___200: + content: + application/json: + schema: + type: object + properties: + status: + type: string + description: The status of the chunk upload operation. + required: + - status + description: '' ml.create_connector___200: content: application/json: @@ -28822,6 +31904,53 @@ components: connector_id: type: string description: '' + ml.create_controller___200: + content: + application/json: + schema: + type: object + properties: + model_id: + $ref: '#/components/schemas/_common___Name' + status: + $ref: '#/components/schemas/ml._common___Status' + description: '' + ml.create_memory___200: + content: + application/json: + schema: + type: object + properties: + memory_id: + $ref: '#/components/schemas/_common___Name' + required: + - memory_id + description: '' + ml.create_message___200: + content: + application/json: + schema: + type: object + properties: + message_id: + $ref: '#/components/schemas/_common___Name' + required: + - message_id + description: '' + ml.create_model_meta___200: + content: + application/json: + schema: + type: object + properties: + status: + type: string + model_id: + type: string + required: + - model_id + - status + description: '' ml.delete_agent___200: content: application/json: @@ -28834,6 +31963,24 @@ components: schema: $ref: '#/components/schemas/_common___WriteResponseBase' description: '' + ml.delete_controller___200: + content: + application/json: + schema: + $ref: '#/components/schemas/_common___WriteResponseBase' + description: '' + ml.delete_memory___200: + content: + application/json: + schema: + type: object + properties: + success: + type: boolean + description: Whether the memory was deleted successfully. + required: + - success + description: '' ml.delete_model_group___200: content: application/json: @@ -28868,18 +32015,193 @@ components: - status - task_id description: '' + ml.execute_agent___200: + content: + application/json: + schema: + $ref: '#/components/schemas/ml._common___PredictResponse' + description: '' + ml.get_agent___200: + content: + application/json: + schema: + $ref: '#/components/schemas/ml._common___GetAgentResponse' + description: '' + ml.get_all_memories___200: + content: + application/json: + schema: + type: object + properties: + memories: + type: array + items: + $ref: '#/components/schemas/ml._common___Memory' + next_token: + description: The index of the next memory after the last memory in the returned list. + type: integer + format: int32 + required: + - memories + description: '' + ml.get_all_messages___200: + content: + application/json: + schema: + type: object + properties: + messages: + type: array + items: + $ref: '#/components/schemas/ml._common___Message' + next_token: + description: The index of the next message after the last message in the returned list. + type: integer + format: int32 + required: + - messages + description: '' + ml.get_all_tools___200: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ml._common___Tool' + description: '' + ml.get_connector___200: + content: + application/json: + schema: + $ref: '#/components/schemas/ml._common___GetConnectorResponse' + description: '' + ml.get_controller___200: + content: + application/json: + schema: + type: object + properties: + user_rate_limiter: + type: object + additionalProperties: + $ref: '#/components/schemas/ml._common___RateLimiter' + model_id: + $ref: '#/components/schemas/_common___Name' + description: '' + ml.get_memory___200: + content: + application/json: + schema: + $ref: '#/components/schemas/ml._common___Memory' + description: '' + ml.get_message_traces___200: + content: + application/json: + schema: + type: object + properties: + traces: + type: array + items: + $ref: '#/components/schemas/ml._common___Message' + next_token: + type: integer + format: int32 + required: + - traces + description: '' + ml.get_message___200: + content: + application/json: + schema: + $ref: '#/components/schemas/ml._common___Message' + description: '' ml.get_model_group___200: content: application/json: schema: $ref: '#/components/schemas/ml._common___ModelGroup' description: '' + ml.get_model___200: + content: + application/json: + schema: + $ref: '#/components/schemas/ml._common___Model' + description: '' + ml.get_profile_models___200: + content: + application/json: + schema: + $ref: '#/components/schemas/ml._common___GetProfileResponse' + description: '' + ml.get_profile_tasks___200: + content: + application/json: + schema: + $ref: '#/components/schemas/ml._common___GetProfileResponse' + description: '' + ml.get_profile___200: + content: + application/json: + schema: + $ref: '#/components/schemas/ml._common___GetProfileResponse' + description: '' + ml.get_stats___200: + content: + application/json: + schema: + $ref: '#/components/schemas/ml._common___GetStatsResponse' + description: '' ml.get_task___200: content: application/json: schema: $ref: '#/components/schemas/ml._common___Task' description: '' + ml.get_tool___200: + content: + application/json: + schema: + $ref: '#/components/schemas/ml._common___Tool' + description: '' + ml.load_model___200: + content: + application/json: + schema: + type: object + properties: + status: + type: string + task_id: + type: string + task_type: + type: string + enum: + - BATCH_INGEST + - BATCH_PREDICTION + - DEPLOY_MODEL + - EXECUTION + - PREDICTION + - REGISTER_MODEL + - TRAINING + - TRAINING_AND_PREDICTION + required: + - status + - task_id + - task_type + description: '' + ml.predict_model___200: + content: + application/json: + schema: + $ref: '#/components/schemas/ml._common___PredictModelResponse' + description: '' + ml.predict___200: + content: + application/json: + schema: + $ref: '#/components/schemas/ml._common___PredictResponse' + description: '' ml.register_agents___200: content: application/json: @@ -28895,6 +32217,20 @@ components: schema: $ref: '#/components/schemas/ml._common___ModelGroupRegistration' description: '' + ml.register_model_meta___200: + content: + application/json: + schema: + type: object + properties: + status: + type: string + model_id: + type: string + required: + - model_id + - status + description: '' ml.register_model___200: content: application/json: @@ -28905,22 +32241,140 @@ components: type: string task_id: type: string + model_id: + type: string required: - status - task_id description: '' + ml.search_agents___200: + content: + application/json: + schema: + $ref: '#/components/schemas/ml._common___SearchAgentsResponse' + description: '' + ml.search_connectors___200: + content: + application/json: + schema: + $ref: '#/components/schemas/ml._common___SearchConnectorsResponse' + description: '' + ml.search_memory___200: + content: + application/json: + schema: + $ref: '#/components/schemas/ml._common___SearchMemoryResponse' + description: '' + ml.search_message___200: + content: + application/json: + schema: + $ref: '#/components/schemas/ml._common___SearchMessageResponse' + description: '' + ml.search_model_group___200: + content: + application/json: + schema: + $ref: '#/components/schemas/ml._common___SearchModelGroupsResponse' + description: '' ml.search_models___200: content: application/json: schema: $ref: '#/components/schemas/ml._common___SearchModelsResponse' description: '' + ml.search_tasks___200: + content: + application/json: + schema: + $ref: '#/components/schemas/ml._common___SearchTasksResponse' + description: '' + ml.train_predict___200: + content: + application/json: + schema: + $ref: '#/components/schemas/ml._common___TrainPredictResponse' + description: '' + ml.train___200: + content: + application/json: + schema: + $ref: '#/components/schemas/ml._common___TrainResponse' + description: '' ml.undeploy_model___200: content: application/json: schema: $ref: '#/components/schemas/ml._common___UndeployModelResponse' description: '' + ml.unload_model___200: + content: + application/json: + schema: + $ref: '#/components/schemas/ml._common___UnloadModelResponse' + description: '' + ml.update_connector___200: + content: + application/json: + schema: + $ref: '#/components/schemas/_common___WriteResponseBase' + description: '' + ml.update_controller___200: + content: + application/json: + schema: + $ref: '#/components/schemas/_common___WriteResponseBase' + description: '' + ml.update_memory___200: + content: + application/json: + schema: + $ref: '#/components/schemas/_common___WriteResponseBase' + description: '' + ml.update_message___200: + content: + application/json: + schema: + $ref: '#/components/schemas/_common___WriteResponseBase' + description: '' + ml.update_model_group___200: + content: + application/json: + schema: + $ref: '#/components/schemas/ml._common___UpdateModelGroupResponse' + description: '' + ml.update_model___200: + content: + application/json: + schema: + $ref: '#/components/schemas/_common___WriteResponseBase' + description: '' + ml.upload_chunk___200: + content: + application/json: + schema: + type: object + properties: + status: + type: string + description: The status of the chunk upload operation. + required: + - status + description: '' + ml.upload_model___200: + content: + application/json: + schema: + type: object + properties: + status: + type: string + task_id: + type: string + required: + - status + - task_id + description: '' msearch_template___200: content: application/json: @@ -28954,25 +32408,72 @@ components: content: application/json: schema: - $ref: '#/components/schemas/nodes.info___ResponseBase' + allOf: + - $ref: '#/components/schemas/nodes._common___NodesResponseBase' + - type: object + properties: + cluster_name: + $ref: '#/components/schemas/_common___Name' + nodes: + type: object + additionalProperties: + $ref: '#/components/schemas/nodes.info___NodeInfo' + required: + - cluster_name + - nodes description: '' nodes.reload_secure_settings___200: content: application/json: schema: - $ref: '#/components/schemas/nodes.reload_secure_settings___ResponseBase' + allOf: + - $ref: '#/components/schemas/nodes._common___NodesResponseBase' + - type: object + properties: + cluster_name: + $ref: '#/components/schemas/_common___Name' + nodes: + type: object + additionalProperties: + $ref: '#/components/schemas/nodes.reload_secure_settings___NodeReloadResult' + required: + - cluster_name + - nodes description: '' nodes.stats___200: content: application/json: schema: - $ref: '#/components/schemas/nodes.stats___ResponseBase' + allOf: + - $ref: '#/components/schemas/nodes._common___NodesResponseBase' + - type: object + properties: + cluster_name: + $ref: '#/components/schemas/_common___Name' + nodes: + type: object + additionalProperties: + $ref: '#/components/schemas/nodes.stats___Stats' + required: + - nodes description: '' nodes.usage___200: content: application/json: schema: - $ref: '#/components/schemas/nodes.usage___ResponseBase' + allOf: + - $ref: '#/components/schemas/nodes._common___NodesResponseBase' + - type: object + properties: + cluster_name: + $ref: '#/components/schemas/_common___Name' + nodes: + type: object + additionalProperties: + $ref: '#/components/schemas/nodes.usage___NodeUsage' + required: + - cluster_name + - nodes description: '' notifications.create_config___200: content: @@ -29107,7 +32608,7 @@ components: observability.get_localstats___200: description: Retrieves content: - application/json: + text/plain: schema: type: string observability.get_object___200: @@ -29243,8 +32744,7 @@ components: $ref: '#/components/schemas/_core.rank_eval___RankEvalMetricDetail' failures: type: object - additionalProperties: - type: object + additionalProperties: true required: - details - failures @@ -29304,12 +32804,81 @@ components: properties: template_output: type: object - additionalProperties: - type: object + additionalProperties: true required: - template_output description: '' + replication.autofollow_stats___200: + content: + application/json: + schema: + $ref: '#/components/schemas/replication._common___AutoFollowStatus' + description: '' + replication.create_replication_rule___200: + content: + application/json: + schema: + $ref: '#/components/schemas/_common___AcknowledgedResponseBase' + description: '' + replication.delete_replication_rule___200: + content: + application/json: + schema: + $ref: '#/components/schemas/_common___AcknowledgedResponseBase' + description: '' + replication.follower_stats___200: + content: + application/json: + schema: + $ref: '#/components/schemas/replication._common___FollowerStatus' + description: '' + replication.leader_stats___200: + content: + application/json: + schema: + $ref: '#/components/schemas/replication._common___LeaderStatus' + description: '' + replication.pause___200: + content: + application/json: + schema: + $ref: '#/components/schemas/_common___AcknowledgedResponseBase' + description: '' + replication.resume___200: + content: + application/json: + schema: + $ref: '#/components/schemas/_common___AcknowledgedResponseBase' + description: '' + replication.start___200: + content: + application/json: + schema: + $ref: '#/components/schemas/_common___AcknowledgedResponseBase' + description: '' + replication.status___200: + content: + application/json: + schema: + $ref: '#/components/schemas/replication._common___Status' + description: '' + replication.stop___200: + content: + application/json: + schema: + $ref: '#/components/schemas/_common___AcknowledgedResponseBase' + description: '' + replication.update_settings___200: + content: + application/json: + schema: + $ref: '#/components/schemas/_common___AcknowledgedResponseBase' + description: '' rollups.delete___200: + content: + application/json: + schema: + $ref: '#/components/schemas/_common___WriteResponseBase' description: '' rollups.explain___200: content: @@ -29323,15 +32892,23 @@ components: schema: $ref: '#/components/schemas/rollups._common___RollupEntity' description: '' - rollups.put___200: + rollups.put___201: content: application/json: schema: $ref: '#/components/schemas/rollups._common___RollupEntity' description: '' rollups.start___200: + content: + application/json: + schema: + $ref: '#/components/schemas/_common___AcknowledgedResponseBase' description: '' rollups.stop___200: + content: + application/json: + schema: + $ref: '#/components/schemas/_common___AcknowledgedResponseBase' description: '' scripts_painless_execute___200: content: @@ -29340,7 +32917,10 @@ components: type: object properties: result: - type: object + oneOf: + - type: number + - type: string + - type: boolean required: - result description: '' @@ -29444,6 +33024,8 @@ components: $ref: '#/components/schemas/_core.search___Suggest' terminated_early: type: boolean + status: + type: number required: - _shards - hits @@ -29618,6 +33200,12 @@ components: schema: $ref: '#/components/schemas/security._common___Ok' description: '' + security.create_user___201: + content: + application/json: + schema: + $ref: '#/components/schemas/security._common___Created' + description: '' security.delete_action_group___200: content: application/json: @@ -29808,11 +33396,11 @@ components: $ref: '#/components/schemas/security._common___InternalServerError' description: '' security.get_distinguished_name___200: - description: Show nodesDn setting for given cluster. + description: Show `nodesDn` setting for given cluster. content: application/json: schema: - $ref: '#/components/schemas/security._common___DistinguishedNames' + $ref: '#/components/schemas/security._common___DistinguishedNamesMap' security.get_distinguished_name___400: content: application/json: @@ -29832,7 +33420,7 @@ components: $ref: '#/components/schemas/security._common___DistinguishedNamesMap' description: '' security.get_distinguished_names___400: - description: Show nodesDn setting for given cluster. + description: Show `nodesDn` setting for given cluster. content: application/json: schema: @@ -30236,6 +33824,12 @@ components: schema: $ref: '#/components/schemas/security._common___Ok' description: '' + security.update_distinguished_name___201: + content: + application/json: + schema: + $ref: '#/components/schemas/security._common___Ok' + description: '' security.update_distinguished_name___400: content: application/json: @@ -30284,6 +33878,84 @@ components: schema: $ref: '#/components/schemas/security._common___InternalServerError' description: '' + sm.create_policy___201: + description: Successfully created the snapshot management policy. + content: + application/json: + schema: + $ref: '#/components/schemas/sm._common___PolicyResponse' + sm.create_policy___400: + description: Bad request when creating the snapshot management policy. + content: + application/json: + schema: + $ref: '#/components/schemas/sm._common___BadRequestResponse' + sm.delete_policy___200: + description: Successfully deleted the snapshot management policy. + content: + application/json: + schema: + $ref: '#/components/schemas/sm._common___DeletePolicyResponse' + sm.delete_policy___404: + description: Snapshot management policy not found. + content: + application/json: + schema: + $ref: '#/components/schemas/sm._common___NotFoundResponse' + sm.explain_policy___200: + description: Successfully explained the state of the snapshot management policy. + content: + application/json: + schema: + $ref: '#/components/schemas/sm._common___PolicyExplanation' + sm.get_policies___200: + description: Successfully retrieved the list of snapshot management policies. + content: + application/json: + schema: + $ref: '#/components/schemas/sm._common___GetPoliciesResponse' + sm.get_policy___200: + description: Successfully retrieved the snapshot management policy. + content: + application/json: + schema: + $ref: '#/components/schemas/sm._common___PolicyResponse' + sm.get_policy___404: + description: Snapshot management policy not found. + content: + application/json: + schema: + $ref: '#/components/schemas/sm._common___NotFoundResponse' + sm.start_policy___200: + description: Successfully started the snapshot management policy. + content: + application/json: + schema: + type: object + properties: + acknowledged: + type: boolean + sm.stop_policy___200: + description: Successfully stopped the snapshot management policy. + content: + application/json: + schema: + type: object + properties: + acknowledged: + type: boolean + sm.update_policy___200: + description: Successfully updated the snapshot management policy. + content: + application/json: + schema: + $ref: '#/components/schemas/sm._common___PolicyResponse' + sm.update_policy___404: + description: Snapshot management policy not found. + content: + application/json: + schema: + $ref: '#/components/schemas/sm._common___NotFoundResponse' snapshot.cleanup_repository___200: content: application/json: @@ -30373,7 +34045,7 @@ components: snapshots: type: array items: - $ref: '#/components/schemas/snapshot._common___Status' + $ref: '#/components/schemas/snapshot._common___SnapshotStatus' required: - snapshots description: '' @@ -30477,14 +34149,19 @@ components: format: int64 _version: $ref: '#/components/schemas/_common___VersionNumber' + _type: + $ref: '#/components/schemas/_common___Type' required: - - _id - _index - _version - found - took description: '' transforms.delete___200: + content: + application/json: + schema: + $ref: '#/components/schemas/transforms._common___DeleteTransformsResponse' description: '' transforms.explain___200: content: @@ -30496,7 +34173,7 @@ components: content: application/json: schema: - $ref: '#/components/schemas/transforms._common___TransformEntity' + $ref: '#/components/schemas/transforms._common___TransformResponse' description: '' transforms.preview___200: content: @@ -30508,7 +34185,13 @@ components: content: application/json: schema: - $ref: '#/components/schemas/transforms._common___TransformEntity' + $ref: '#/components/schemas/transforms._common___TransformResponse' + description: '' + transforms.put___201: + content: + application/json: + schema: + $ref: '#/components/schemas/transforms._common___TransformResponse' description: '' transforms.search___200: content: @@ -30538,6 +34221,10 @@ components: type: object additionalProperties: $ref: '#/components/schemas/_core.update_by_query_rethrottle___UpdateByQueryRethrottleNode' + node_failures: + type: array + items: + $ref: '#/components/schemas/_common___ErrorCause' required: - nodes description: '' @@ -30749,19 +34436,35 @@ components: type: integer format: int64 _common___ByteUnit: - type: string - enum: - - b - - g - - gb - - k - - kb - - m - - mb - - p - - pb - - t - - tb + oneOf: + - title: bytes + type: string + const: b + - title: kilo_bytes + type: string + enum: + - kb + - k + - title: mega_bytes + type: string + enum: + - mb + - m + - title: giga_bytes + type: string + enum: + - gb + - g + - title: tera_bytes + type: string + enum: + - tb + - t + - title: peta_bytes + type: string + enum: + - pb + - p _common___ClusterDetails: type: object properties: @@ -30827,6 +34530,7 @@ components: type: object properties: size_in_bytes: + description: The total amount, in bytes, of memory used for completion across all shards assigned to the selected nodes. $ref: '#/components/schemas/_common___ByteCount' size: $ref: '#/components/schemas/_common___HumanReadableByteCount' @@ -30906,17 +34610,34 @@ components: _common___Distance: type: string _common___DistanceUnit: - type: string - enum: - - cm - - ft - - in - - km - - m - - mi - - mm - - nmi - - yd + oneOf: + - title: centimeters + type: string + const: cm + - title: feet + type: string + const: ft + - title: inches + type: string + const: in + - title: kilometers + type: string + const: km + - title: meters + type: string + const: m + - title: miles + type: string + const: mi + - title: millimeters + type: string + const: mm + - title: nautical miles + type: string + const: nmi + - title: yards + type: string + const: yd _common___DocStats: type: object properties: @@ -30924,13 +34645,15 @@ components: description: |- The total number of non-deleted documents across all primary shards assigned to the selected nodes. This number is based on documents in Lucene segments and may include documents from nested fields. - type: number + type: integer + format: int64 deleted: description: |- The total number of deleted documents across all primary shards assigned to the selected nodes. This number is based on the number of documents stored in Lucene segments. OpenSearch reclaims the disk space previously occupied by the deleted Lucene documents when a segment is merged. - type: number + type: integer + format: int64 required: - count _common___DocStatus: @@ -30956,11 +34679,14 @@ components: description: |- A duration. Units can be `nanos`, `micros`, `ms` (milliseconds), `s` (seconds), `m` (minutes), `h` (hours) and `d` (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value. - pattern: ^([0-9\.]+)(?:d|h|m|s|ms|micros|nanos)$ + pattern: ^(?:(-1)|([0-9\.]+)(?:d|h|m|s|ms|micros|nanos))$ type: string _common___DurationLarge: description: 'A date histogram interval, similar to `Duration`, with support for additional units: `w` (week), `M` (month), `q` (quarter), and `y` (year).' type: string + _common___DurationValueUnitMicros: + allOf: + - $ref: '#/components/schemas/_common___UnitMicros' _common___DurationValueUnitMillis: allOf: - $ref: '#/components/schemas/_common___UnitMillis' @@ -31019,17 +34745,18 @@ components: description: Match any index, including hidden ones. - type: string const: closed - description: Match closed, non-hidden indices. + description: Match closed, non-hidden indexes. - type: string const: hidden - description: Match hidden indices. Must be combined with open, closed, or both. + description: Match hidden indexes. Must be combined with open, closed, or both. - type: string const: none description: Wildcard expressions are not accepted. - type: string const: open - description: Match open, non-hidden indices. + description: Match open, non-hidden indexes. _common___ExpandWildcards: + description: Specifies the type of index that wildcard expressions can match. Supports comma-separated values. oneOf: - $ref: '#/components/schemas/_common___ExpandWildcard' - type: array @@ -31042,7 +34769,8 @@ components: type: object properties: evictions: - type: number + type: integer + format: int64 memory_size: $ref: '#/components/schemas/_common___HumanReadableByteCount' memory_size_in_bytes: @@ -31077,29 +34805,49 @@ components: $ref: '#/components/schemas/_common___ByteCount' required: - size_in_bytes + _common___FieldSort: + oneOf: + - title: order + $ref: '#/components/schemas/_common___SortOrder' + - type: object + properties: + missing: + $ref: '#/components/schemas/_common___FieldValue' + mode: + $ref: '#/components/schemas/_common___SortMode' + nested: + $ref: '#/components/schemas/_common___NestedSortValue' + order: + $ref: '#/components/schemas/_common___SortOrder' + unmapped_type: + $ref: '#/components/schemas/_common.mapping___FieldType' + numeric_type: + $ref: '#/components/schemas/_common___FieldSortNumericType' + format: + type: string + _common___FieldSortNumericType: + type: string + enum: + - date + - date_nanos + - double + - long _common___FieldValue: description: A field value. type: - boolean - 'null' - number - - object - string - _common___FieldWithDirection: - type: object - additionalProperties: - $ref: '#/components/schemas/_common___SortOrder' - _common___FieldWithOrder: - type: object - additionalProperties: - $ref: '#/components/schemas/_common___ScoreSort' _common___FlushStats: type: object properties: periodic: - type: number + type: integer + format: int64 total: - type: number + type: integer + format: int64 total_time: $ref: '#/components/schemas/_common___Duration' total_time_in_millis: @@ -31142,6 +34890,10 @@ components: $ref: '#/components/schemas/_common___SortOrder' unit: $ref: '#/components/schemas/_common___DistanceUnit' + additionalProperties: + type: array + items: + $ref: '#/components/schemas/_common___GeoLocation' _common___GeoDistanceType: type: string enum: @@ -31159,12 +34911,11 @@ components: _common___GeoHashPrecision: description: The level of geohash precision, which can be expressed as a geohash length between 1 and 12 or as a distance measure, such as "1km" or "10m". oneOf: - - type: integer + - title: geohash_length + type: integer format: int32 - - type: string - _common___GeoHexCell: - description: A map hex cell (H3) reference. - type: string + - title: distance + type: string _common___GeoLine: type: object properties: @@ -31217,25 +34968,34 @@ components: type: object properties: total: - type: number + type: integer + format: int64 getTime: $ref: '#/components/schemas/_common___Duration' + deprecated: true + x-version-deprecated: '2.19' + time: + $ref: '#/components/schemas/_common___Duration' + x-version-added: '2.19' time_in_millis: $ref: '#/components/schemas/_common___DurationValueUnitMillis' exists_total: - type: number + type: integer + format: int64 exists_time: $ref: '#/components/schemas/_common___Duration' exists_time_in_millis: $ref: '#/components/schemas/_common___DurationValueUnitMillis' missing_total: - type: number + type: integer + format: int64 missing_time: $ref: '#/components/schemas/_common___Duration' missing_time_in_millis: $ref: '#/components/schemas/_common___DurationValueUnitMillis' current: - type: number + type: integer + format: int64 required: - current - exists_time_in_millis @@ -31245,44 +35005,36 @@ components: - time_in_millis - total _common___HealthStatus: - type: string - enum: - - green - - red - - yellow - _common___HealthStatusCapitalized: - type: string - enum: - - GREEN - - RED - - YELLOW + oneOf: + - description: All shards are assigned. + type: string + enum: + - green + - GREEN + - description: | + All primary shards are assigned, but one or more replica shards are + unassigned. If a node in the cluster fails, some data could be unavailable + until that node is repaired. + type: string + enum: + - yellow + - YELLOW + - description: | + One or more primary shards are unassigned, so some data is unavailable. This + can occur briefly during cluster startup as primary shards are assigned. + type: string + enum: + - red + - RED _common___Host: type: string - _common___HourAndMinute: - type: object - properties: - hour: - type: array - items: - type: number - minute: - type: array - items: - type: number - required: - - hour - - minute _common___HttpHeaders: type: object additionalProperties: - oneOf: - - type: string - - type: array - items: - type: string + $ref: '#/components/schemas/_common___StringOrStringArray' _common___HumanReadableByteCount: type: string - pattern: \d+(\.\d+)?(b|kb|k|mb|m|gb|g|tb|t|pb|p) + pattern: (?:(-1)|(0)|\d+(\.\d+)?(b|kb|k|mb|m|gb|g|tb|t|pb|p)) _common___IBDistribution: type: string enum: @@ -31307,25 +35059,31 @@ components: type: object properties: index_total: - type: number + type: integer + format: int64 index_time: $ref: '#/components/schemas/_common___Duration' index_time_in_millis: $ref: '#/components/schemas/_common___DurationValueUnitMillis' index_current: - type: number + type: integer + format: int64 index_failed: - type: number + type: integer + format: int64 delete_total: - type: number + type: integer + format: int64 delete_time: $ref: '#/components/schemas/_common___Duration' delete_time_in_millis: $ref: '#/components/schemas/_common___DurationValueUnitMillis' delete_current: - type: number + type: integer + format: int64 noop_update_total: - type: number + type: integer + format: int64 is_throttled: type: boolean throttle_time: @@ -31353,6 +35111,10 @@ components: _common___IndexName: type: string _common___Indices: + description: |- + A comma-separated list of data streams, indexes, and aliases used to limit the request. + Supports wildcards (`*`). + To target all data streams and indexes, omit this parameter or use `*` or `_all`. oneOf: - $ref: '#/components/schemas/_common___IndexName' - type: array @@ -31426,50 +35188,6 @@ components: - source _common___Ip: type: string - _common___KnnField: - type: object - properties: - vector: - $ref: '#/components/schemas/_common___QueryVector' - k: - description: The total number of nearest neighbors to return as top hits. - type: integer - format: int32 - min_score: - description: The minimum similarity score required in order for a neighbor to be considered a hit. - type: number - format: float - x-version-added: '2.14' - max_distance: - description: The maximum physical vector space distance required in order for a neighbor to be considered a hit. - type: number - format: float - x-version-added: '2.14' - filter: - description: The filters for the k-NN search query. - oneOf: - - $ref: '#/components/schemas/_common.query_dsl___QueryContainer' - - type: array - items: - $ref: '#/components/schemas/_common.query_dsl___QueryContainer' - boost: - description: The boost value applied to k-NN scores. - type: number - format: float - method_parameters: - type: object - x-version-added: '2.16' - additionalProperties: - type: integer - format: int32 - rescore: - type: object - x-version-added: '2.17' - additionalProperties: - type: number - format: float - required: - - vector _common___LatLonGeoLocation: type: object properties: @@ -31485,6 +35203,7 @@ components: - lat - lon _common___Level: + description: Specifies the level of detail of the returned information. type: string enum: - cluster @@ -31494,21 +35213,25 @@ components: type: object properties: current: - type: number + type: integer + format: int64 current_docs: - type: number + type: integer + format: int64 current_size: $ref: '#/components/schemas/_common___HumanReadableByteCount' current_size_in_bytes: $ref: '#/components/schemas/_common___ByteCount' total: - type: number + type: integer + format: int64 total_auto_throttle: $ref: '#/components/schemas/_common___HumanReadableByteCount' total_auto_throttle_in_bytes: $ref: '#/components/schemas/_common___ByteCount' total_docs: - type: number + type: integer + format: int64 total_size: $ref: '#/components/schemas/_common___HumanReadableByteCount' total_size_in_bytes: @@ -31526,7 +35249,8 @@ components: total_time_in_millis: $ref: '#/components/schemas/_common___DurationValueUnitMillis' unreferenced_file_cleanups_performed: - type: number + type: integer + format: int64 required: - current - current_docs @@ -31548,17 +35272,18 @@ components: format: int32 - type: string _common___MultiTermQueryRewrite: - type: string - enum: - - constant_score - - constant_score_boolean - - scoring_boolean - - top_terms_N - - top_terms_blended_freqs_N - - top_terms_boost_N + oneOf: + - type: string + enum: + - constant_score + - constant_score_boolean + - scoring_boolean + - type: string + pattern: top_terms(_blended_freqs|_boost)?_\d+ _common___Name: type: string _common___Names: + description: A comma-separated list of aliases to retrieve. Supports wildcards (`*`). To retrieve all aliases, omit this parameter or use `*` or `_all`. oneOf: - $ref: '#/components/schemas/_common___Name' - type: array @@ -31606,6 +35331,7 @@ components: _common___NodeId: type: string _common___NodeIds: + description: A comma-separated list of node IDs used to filter results. Supports [node filters](https://opensearch.org/docs/latest/api-reference/nodes-apis/index/#node-filters). oneOf: - $ref: '#/components/schemas/_common___NodeId' - type: array @@ -31635,7 +35361,7 @@ components: - master deprecated: true x-version-deprecated: '2.0' - x-deprecation-message: Use 'cluster_manager' instead. + x-deprecation-message: Use `cluster_manager` instead. - type: string enum: - cluster_manager @@ -31655,7 +35381,8 @@ components: node: $ref: '#/components/schemas/_common___NodeName' shard: - type: number + type: integer + format: int32 index: $ref: '#/components/schemas/_common___IndexName' allocation_id: @@ -31672,8 +35399,6 @@ components: oneOf: - $ref: '#/components/schemas/_common___NodeId' - type: 'null' - relocation_failure_info: - $ref: '#/components/schemas/_common___RelocationFailureInfo' required: - index - primary @@ -31769,16 +35494,6 @@ components: - query _common___PipelineName: type: string - _common___PipeSeparatedFlagsSimpleQueryStringFlag: - description: |- - A set of flags represented as a single enum value or a set of values that are encoded - as a pipe-separated string. - - Depending on the target language, code generators can use this hint to generate language specific - flags enum constructs and the corresponding (de-)serialization code. - oneOf: - - $ref: '#/components/schemas/_common.query_dsl___SimpleQueryStringFlag' - - type: string _common___PluginStats: type: object properties: @@ -31822,26 +35537,33 @@ components: description: |- The total number of entries added to the query cache across all shards assigned to the selected nodes. This number includes all current and evicted entries. - type: number + type: integer + format: int64 cache_size: description: The total number of entries currently stored in the query cache across all shards assigned to the selected nodes. - type: number + type: integer + format: int64 evictions: description: The total number of query cache evictions across all shards assigned to the selected nodes. - type: number + type: integer + format: int64 hit_count: description: The total number of query cache hits across all shards assigned to the selected nodes. - type: number + type: integer + format: int64 memory_size: $ref: '#/components/schemas/_common___HumanReadableByteCount' memory_size_in_bytes: + description: The total amount, in bytes, of memory used for the query cache across all shards assigned to the selected nodes. $ref: '#/components/schemas/_common___ByteCount' miss_count: description: The total number of query cache misses across all shards assigned to the selected nodes. - type: number + type: integer + format: int64 total_count: description: The total number of hits and misses stored in the query cache across all shards assigned to the selected nodes. - type: number + type: integer + format: int64 required: - cache_count - cache_size @@ -31850,11 +35572,6 @@ components: - memory_size_in_bytes - miss_count - total_count - _common___QueryVector: - type: array - items: - type: number - format: float _common___RankBase: type: object _common___RankContainer: @@ -31868,9 +35585,11 @@ components: type: object properties: current_as_source: - type: number + type: integer + format: int64 current_as_target: - type: number + type: integer + format: int64 throttle_time: $ref: '#/components/schemas/_common___Duration' throttle_time_in_millis: @@ -31880,24 +35599,29 @@ components: - current_as_target - throttle_time_in_millis _common___Refresh: - type: string - enum: - - 'false' - - 'true' - - wait_for + oneOf: + - type: boolean + - type: string + enum: + - 'false' + - 'true' + - wait_for _common___RefreshStats: type: object properties: external_total: - type: number + type: integer + format: int64 external_total_time: $ref: '#/components/schemas/_common___Duration' external_total_time_in_millis: $ref: '#/components/schemas/_common___DurationValueUnitMillis' listeners: - type: number + type: integer + format: int64 total: - type: number + type: integer + format: int64 total_time: $ref: '#/components/schemas/_common___Duration' total_time_in_millis: @@ -31910,22 +35634,18 @@ components: - total_time_in_millis _common___RelationName: type: string - _common___RelocationFailureInfo: - type: object - properties: - failed_attempts: - type: number - required: - - failed_attempts _common___RemoteStoreDownloadStats: type: object description: Statistics related to downloads to the remote segment store. properties: total_download_size: + description: The total amount of data downloaded from the remote segment store. $ref: '#/components/schemas/_common___RemoteStoreUploadDownloadStats' total_time_spent: + description: The total amount of time spent on downloads from the remote segment store. $ref: '#/components/schemas/_common___Duration' 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 @@ -31964,16 +35684,22 @@ components: description: The total amount of data uploaded to the remote translog store. properties: failed: + description: The number of bytes that failed to upload to the remote translog store. $ref: '#/components/schemas/_common___HumanReadableByteCount' failed_bytes: + description: The number of bytes that failed to upload to the remote translog store. $ref: '#/components/schemas/_common___ByteCount' started: + description: The number of bytes successfully uploaded to the remote translog store. $ref: '#/components/schemas/_common___HumanReadableByteCount' started_bytes: + description: The number of bytes successfully uploaded to the remote translog store. $ref: '#/components/schemas/_common___ByteCount' succeeded: + description: The number of bytes successfully uploaded to the remote translog store. $ref: '#/components/schemas/_common___HumanReadableByteCount' succeeded_bytes: + description: The number of bytes successfully uploaded to the remote translog store. $ref: '#/components/schemas/_common___ByteCount' required: - failed_bytes @@ -31985,13 +35711,16 @@ components: properties: failed: description: The number of failed upload syncs to the remote translog store. - type: number + type: integer + format: int64 started: description: The number of upload syncs to the remote translog store that have started. - type: number + type: integer + format: int64 succeeded: description: The number of successful upload syncs to the remote translog store. - type: number + type: integer + format: int64 required: - failed - started @@ -32001,16 +35730,22 @@ components: description: The amount of data, in bytes, uploaded or downloaded to/from the remote segment store. properties: failed: + description: The number of bytes that failed to upload to/from the remote segment store. $ref: '#/components/schemas/_common___HumanReadableByteCount' failed_bytes: + description: The number of bytes that failed to upload to/from the remote segment store. $ref: '#/components/schemas/_common___ByteCount' started: + description: The number of bytes to upload/download to/from the remote segment store after the upload/download has started. $ref: '#/components/schemas/_common___HumanReadableByteCount' started_bytes: + description: The number of bytes to upload/download to/from the remote segment store after the upload/download has started. $ref: '#/components/schemas/_common___ByteCount' succeeded: + description: The number of bytes successfully uploaded/downloaded to/from the remote segment store. $ref: '#/components/schemas/_common___HumanReadableByteCount' succeeded_bytes: + description: The number of bytes successfully uploaded/downloaded to/from the remote segment store. $ref: '#/components/schemas/_common___ByteCount' required: - failed_bytes @@ -32022,7 +35757,8 @@ components: properties: total_rejections: description: The total number of requests rejected due to segment store upload backpressure. - type: number + type: integer + format: int64 required: - total_rejections _common___RemoteStoreUploadRefreshSizeLagStats: @@ -32030,12 +35766,16 @@ components: description: The amount of lag during upload between the remote segment store and the local store. properties: max: + description: The maximum amount of lag, in bytes, during the upload refresh between the remote segment store and the local store. $ref: '#/components/schemas/_common___HumanReadableByteCount' max_bytes: + description: The maximum amount of lag, in bytes, during the upload refresh between the remote segment store and the local store. $ref: '#/components/schemas/_common___ByteCount' total: + description: The total number of bytes that lagged during the upload refresh between the remote segment store and the local store. $ref: '#/components/schemas/_common___HumanReadableByteCount' total_bytes: + description: The total number of bytes that lagged during the upload refresh between the remote segment store and the local store. $ref: '#/components/schemas/_common___ByteCount' required: - max_bytes @@ -32045,22 +35785,25 @@ components: description: Statistics related to uploads to the remote segment store. properties: max_refresh_time_lag: + description: The maximum duration that the remote refresh is behind the local refresh. $ref: '#/components/schemas/_common___Duration' 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: + description: The total amount of time spent on uploads to the remote segment store. $ref: '#/components/schemas/_common___Duration' total_time_spent_in_millis: + description: The total amount of time, in milliseconds, spent on uploads to the remote segment store. $ref: '#/components/schemas/_common___DurationValueUnitMillis' 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 @@ -32068,15 +35811,18 @@ components: type: object properties: evictions: - type: number + type: integer + format: int64 hit_count: - type: number + type: integer + format: int64 memory_size: $ref: '#/components/schemas/_common___HumanReadableByteCount' memory_size_in_bytes: $ref: '#/components/schemas/_common___ByteCount' miss_count: - type: number + type: integer + format: int64 required: - evictions - hit_count @@ -32090,9 +35836,40 @@ components: time_in_millis: $ref: '#/components/schemas/_common___DurationValueUnitMillis' current: - type: number + type: integer + format: int64 total: - type: number + type: integer + format: int64 + _common___ResourceStat: + type: object + properties: + cpu_time_in_nanos: + $ref: '#/components/schemas/_common___DurationValueUnitNanos' + memory_in_bytes: + $ref: '#/components/schemas/_common___ByteCount' + required: + - cpu_time_in_nanos + - memory_in_bytes + _common___ResourceStats: + type: object + properties: + average: + $ref: '#/components/schemas/_common___ResourceStat' + total: + $ref: '#/components/schemas/_common___ResourceStat' + min: + $ref: '#/components/schemas/_common___ResourceStat' + max: + $ref: '#/components/schemas/_common___ResourceStat' + thread_info: + $ref: '#/components/schemas/_common___ThreadInfo' + required: + - average + - max + - min + - thread_info + - total _common___ResourceType: type: string enum: @@ -32120,11 +35897,7 @@ components: _common___Routing: type: string _common___RoutingInQueryString: - oneOf: - - type: string - - type: array - items: - type: string + $ref: '#/components/schemas/_common___StringOrStringArray' _common___RrfRank: allOf: - $ref: '#/components/schemas/_common___RankBase' @@ -32136,11 +35909,6 @@ components: window_size: description: The size of the individual result sets per query. type: number - _common___ScheduleTimeOfDay: - description: A time of day, expressed either as `hh:mm`, `noon`, `midnight`, or an hour/minutes structure. - oneOf: - - type: string - - $ref: '#/components/schemas/_common___HourAndMinute' _common___ScoreSort: type: object properties: @@ -32158,7 +35926,7 @@ components: params: description: |- Specifies any named parameters that are passed into the script as variables. - Use parameters instead of hard-coded values to decrease compilation time. + Use parameters instead of hard-coded values to decrease compilation time. type: object additionalProperties: true _common___ScriptField: @@ -32228,72 +35996,97 @@ components: properties: open_contexts: description: The number of open search contexts. - type: number + type: integer + format: int64 query_current: description: The number of currently running shard query operations. - type: number + type: integer + format: int64 query_time: + description: The total amount of time taken to complete all shard query operations. $ref: '#/components/schemas/_common___Duration' query_time_in_millis: + description: The total amount of time taken to complete all shard query operations, in milliseconds. $ref: '#/components/schemas/_common___DurationValueUnitMillis' query_total: description: The total number of shard query operations. - type: number + type: integer + format: int64 concurrent_query_total: description: The total number of query operations using concurrent segment search. - type: number + type: integer + format: int64 concurrent_query_time: $ref: '#/components/schemas/_common___Duration' concurrent_query_time_in_millis: + description: The total amount of time taken by all query operations using concurrent segment search, in milliseconds. $ref: '#/components/schemas/_common___DurationValueUnitMillis' concurrent_query_current: description: The number of currently running query operations using concurrent segment search. - type: number + type: integer + format: int64 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 + type: integer + format: int64 fetch_current: description: The number of currently running shard fetch operations. - type: number + type: integer + format: int64 fetch_time: + description: The total amount of time taken to complete all shard fetch operations. $ref: '#/components/schemas/_common___Duration' fetch_time_in_millis: + description: The total amount of time taken to complete all shard fetch operations, in milliseconds. $ref: '#/components/schemas/_common___DurationValueUnitMillis' fetch_total: description: The total number of shard fetch operations. - type: number + type: integer + format: int64 scroll_current: description: The number of shard scroll operations that are currently running. - type: number + type: integer + format: int64 scroll_time: + description: The total amount of time taken to complete all shard scroll operations. $ref: '#/components/schemas/_common___Duration' scroll_time_in_millis: + description: The total amount of time taken to complete all shard scroll operations, in milliseconds. $ref: '#/components/schemas/_common___DurationValueUnitMillis' scroll_total: description: The total number of shard scroll operations. - type: number + type: integer + format: int64 point_in_time_total: description: The total number of shard Point in Time (PIT) contexts created (completed and active) since the node last restarted. - type: number + type: integer + format: int64 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 currently open shard PIT contexts. - type: number + type: integer + format: int64 suggest_current: description: The number of currently running shard suggest operations. - type: number + type: integer + format: int64 suggest_time: + description: The total amount of time take to complete all shard suggest operations. $ref: '#/components/schemas/_common___Duration' suggest_time_in_millis: + description: The total amount of time taken to complete all shard suggest operations, in milliseconds. $ref: '#/components/schemas/_common___DurationValueUnitMillis' suggest_total: description: The total number of shard suggest operations. - type: number + type: integer + format: int64 search_idle_reactivate_count_total: - type: number + type: integer + format: int64 request: type: object description: Statistics related to coordinator search operations for the node. @@ -32317,32 +36110,54 @@ components: - suggest_time_in_millis - suggest_total _common___SearchType: - type: string - enum: - - dfs_query_then_fetch - - query_then_fetch + oneOf: + - type: string + const: dfs_query_then_fetch + description: Documents are scored using global term and document frequencies across all shards. This is usually slower but more accurate. + - type: string + const: query_then_fetch + description: Documents are scored using local term and document frequencies for the shard. This is usually faster but less accurate. _common___SegmentReplicationStats: - type: object - properties: - max_bytes_behind: - $ref: '#/components/schemas/_common___ByteCount' - max_replication_lag: - $ref: '#/components/schemas/_common___ByteCount' - total_bytes_behind: - $ref: '#/components/schemas/_common___ByteCount' - required: - - max_bytes_behind - - max_replication_lag - - total_bytes_behind + x-version-added: 2.10.0 + oneOf: + - x-version-added: 2.10.0 + x-version-removed: 2.12.0 + type: object + properties: + max_bytes_behind: + $ref: '#/components/schemas/_common___HumanReadableByteCount' + max_replication_lag: + $ref: '#/components/schemas/_common___Duration' + total_bytes_behind: + $ref: '#/components/schemas/_common___HumanReadableByteCount' + required: + - max_bytes_behind + - max_replication_lag + - total_bytes_behind + - x-version-added: 2.12.0 + type: object + properties: + max_bytes_behind: + $ref: '#/components/schemas/_common___ByteCount' + max_replication_lag: + $ref: '#/components/schemas/_common___DurationValueUnitMillis' + total_bytes_behind: + $ref: '#/components/schemas/_common___ByteCount' + required: + - max_bytes_behind + - max_replication_lag + - total_bytes_behind _common___SegmentsStats: type: object properties: count: description: The total number of segments across all shards assigned to the selected nodes. - type: number + type: integer + format: int32 doc_values_memory: $ref: '#/components/schemas/_common___HumanReadableByteCount' doc_values_memory_in_bytes: + description: The total amount, in bytes, of memory used for document values across all shards assigned to the selected nodes. $ref: '#/components/schemas/_common___ByteCount' file_sizes: description: |- @@ -32354,47 +36169,64 @@ components: fixed_bit_set: $ref: '#/components/schemas/_common___HumanReadableByteCount' fixed_bit_set_memory_in_bytes: + description: The total amount of memory, in bytes, used by fixed bit sets across all shards assigned to the selected nodes. $ref: '#/components/schemas/_common___ByteCount' index_writer_memory: $ref: '#/components/schemas/_common___HumanReadableByteCount' index_writer_max_memory_in_bytes: $ref: '#/components/schemas/_common___ByteCount' index_writer_memory_in_bytes: + description: The total amount, in bytes, of memory used by all index writers across all shards assigned to the selected nodes. $ref: '#/components/schemas/_common___ByteCount' max_unsafe_auto_id_timestamp: description: The Unix timestamp, in milliseconds, of the most recently retried indexing request. - type: number + $ref: '#/components/schemas/_common___EpochTimeUnitMillis' memory: + description: The total amount of memory used for segments across all shards assigned to the selected nodes. $ref: '#/components/schemas/_common___HumanReadableByteCount' memory_in_bytes: + description: The total amount, in bytes, of memory used for segments across all shards assigned to the selected nodes. $ref: '#/components/schemas/_common___ByteCount' norms_memory: + description: The total amount of memory used for normalization factors across all shards assigned to the selected nodes. $ref: '#/components/schemas/_common___HumanReadableByteCount' norms_memory_in_bytes: + description: The total amount, in bytes, of memory used for normalization factors across all shards assigned to the selected nodes. $ref: '#/components/schemas/_common___ByteCount' points_memory: + description: The total amount of memory used for points across all shards assigned to the selected nodes. $ref: '#/components/schemas/_common___HumanReadableByteCount' points_memory_in_bytes: + description: The total amount, in bytes, of memory used for points across all shards assigned to the selected nodes. $ref: '#/components/schemas/_common___ByteCount' stored_fields_memory: + description: The total amount of memory used for stored fields across all shards assigned to the selected nodes. $ref: '#/components/schemas/_common___HumanReadableByteCount' stored_fields_memory_in_bytes: + description: The total amount, in bytes, of memory used for stored fields across all shards assigned to the selected nodes. $ref: '#/components/schemas/_common___ByteCount' terms_memory: + description: The total amount of memory used for terms across all shards assigned to the selected nodes. $ref: '#/components/schemas/_common___HumanReadableByteCount' terms_memory_in_bytes: + description: The total amount, in bytes, of memory used for terms across all shards assigned to the selected nodes. $ref: '#/components/schemas/_common___ByteCount' term_vectors_memory: + description: The total amount of memory used for term vectors across all shards assigned to the selected nodes. $ref: '#/components/schemas/_common___HumanReadableByteCount' term_vectors_memory_in_bytes: + description: The total amount, in bytes, of memory used for term vectors across all shards assigned to the selected nodes. $ref: '#/components/schemas/_common___ByteCount' version_map_memory: + description: The total amount of memory used by all version maps across all shards assigned to the selected nodes. $ref: '#/components/schemas/_common___HumanReadableByteCount' version_map_memory_in_bytes: + description: The total amount, in bytes, of memory used by all version maps across all shards assigned to the selected nodes. $ref: '#/components/schemas/_common___ByteCount' remote_store: $ref: '#/components/schemas/_common___RemoteStoreStats' segment_replication: + x-version-added: 2.10.0 $ref: '#/components/schemas/_common___SegmentReplicationStats' required: - count @@ -32463,7 +36295,8 @@ components: field: $ref: '#/components/schemas/_common___Field' id: - $ref: '#/components/schemas/_common___Id' + type: integer + format: int32 max: type: integer format: int32 @@ -32473,28 +36306,21 @@ components: _common___Slices: description: The slice configuration used to parallelize a process. oneOf: - - type: number - - $ref: '#/components/schemas/_common___SlicesCalculation' + - title: count + type: integer + format: int32 + - title: calculation + $ref: '#/components/schemas/_common___SlicesCalculation' _common___SlicesCalculation: type: string enum: - auto _common___Sort: oneOf: - - $ref: '#/components/schemas/_common___SortCombinations' + - $ref: '#/components/schemas/_common___SortOptions' - type: array items: - $ref: '#/components/schemas/_common___SortCombinations' - _common___SortCombinations: - oneOf: - - title: field - $ref: '#/components/schemas/_common___Field' - - title: field_with_direction - $ref: '#/components/schemas/_common___FieldWithDirection' - - title: field_with_order - $ref: '#/components/schemas/_common___FieldWithOrder' - - title: options - $ref: '#/components/schemas/_common___SortOptions' + $ref: '#/components/schemas/_common___SortOptions' _common___SortMode: type: string enum: @@ -32504,18 +36330,44 @@ components: - min - sum _common___SortOptions: - type: object - properties: - _score: - $ref: '#/components/schemas/_common___ScoreSort' - _doc: - $ref: '#/components/schemas/_common___ScoreSort' - _geo_distance: - $ref: '#/components/schemas/_common___GeoDistanceSort' - _script: - $ref: '#/components/schemas/_common___ScriptSort' - minProperties: 1 - maxProperties: 1 + oneOf: + - type: string + const: _score + - type: string + const: _doc + - type: string + not: + type: string + enum: + - _doc + - _score + - type: object + properties: + _score: + $ref: '#/components/schemas/_common___ScoreSort' + _doc: + $ref: '#/components/schemas/_common___ScoreSort' + _geo_distance: + $ref: '#/components/schemas/_common___GeoDistanceSort' + _script: + $ref: '#/components/schemas/_common___ScriptSort' + minProperties: 1 + maxProperties: 1 + - type: object + propertyNames: + allOf: + - $ref: '#/components/schemas/_common___Field' + - not: + type: string + enum: + - _doc + - _geo_distance + - _score + - _script + additionalProperties: + $ref: '#/components/schemas/_common___FieldSort' + minProperties: 1 + maxProperties: 1 _common___SortOrder: type: string enum: @@ -32555,15 +36407,17 @@ components: size: $ref: '#/components/schemas/_common___HumanReadableByteCount' size_in_bytes: + description: The total size, in bytes, of all shards assigned to the selected nodes. $ref: '#/components/schemas/_common___ByteCount' reserved: $ref: '#/components/schemas/_common___HumanReadableByteCount' reserved_in_bytes: + description: A prediction, in bytes, of how much larger the shard stores will eventually grow due to ongoing peer recoveries, restoring snapshots, and similar activities. $ref: '#/components/schemas/_common___ByteCount' required: - reserved_in_bytes - size_in_bytes - _common___Stringifiedboolean: + _common___StringifiedBoolean: description: |- Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. @@ -32573,6 +36427,11 @@ components: oneOf: - type: boolean - type: string + _common___StringifiedDouble: + oneOf: + - type: number + format: double + - type: string _common___StringifiedEpochTimeUnitMillis: description: |- Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures @@ -32593,7 +36452,7 @@ components: oneOf: - $ref: '#/components/schemas/_common___EpochTimeUnitSeconds' - type: string - _common___Stringifiedinteger: + _common___StringifiedInteger: description: |- Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures this behavior while keeping the semantics of the field type. @@ -32603,6 +36462,11 @@ components: oneOf: - type: integer - type: string + _common___StringifiedLong: + oneOf: + - type: integer + format: int64 + - type: string _common___StringifiedVersionNumber: description: |- Certain APIs may return values, including numbers such as epoch timestamps, as strings. This setting captures @@ -32613,6 +36477,12 @@ components: oneOf: - $ref: '#/components/schemas/_common___VersionNumber' - type: string + _common___StringOrStringArray: + oneOf: + - type: string + - type: array + items: + type: string _common___SuggestMode: type: string enum: @@ -32647,19 +36517,43 @@ components: - h3 - 'no' - z + _common___ThreadInfo: + type: object + properties: + thread_executions: + type: number + active_threads: + type: number + required: + - active_threads + - thread_executions _common___TimeOfDay: description: Time of day, expressed as HH:MM:SS. type: string _common___TimeUnit: - type: string - enum: - - d - - h - - m - - micros - - ms - - nanos - - s + description: Specifies the time units, for example, `5d` or `7h`. For more information, see [Supported units](https://opensearch.org/docs/latest/api-reference/units/). + oneOf: + - title: nanoseconds + type: string + const: nanos + - title: microseconds + type: string + const: micros + - title: milliseconds + type: string + const: ms + - title: seconds + type: string + const: s + - title: minutes + type: string + const: m + - title: hours + type: string + const: h + - title: days + type: string + const: d _common___TimeZone: type: string _common___TopLeftBottomRightGeoBounds: @@ -32686,9 +36580,11 @@ components: type: object properties: earliest_last_modified_age: - type: number + type: integer + format: int64 operations: - type: number + type: integer + format: int32 remote_store: $ref: '#/components/schemas/_common___RemoteStoreTranslogStats' size: @@ -32696,7 +36592,8 @@ components: size_in_bytes: $ref: '#/components/schemas/_common___ByteCount' uncommitted_operations: - type: number + type: integer + format: int32 uncommitted_size: $ref: '#/components/schemas/_common___HumanReadableByteCount' uncommitted_size_in_bytes: @@ -32716,6 +36613,10 @@ components: type: integer _common___ulong: type: number + _common___UnitMicros: + description: Time unit for microseconds. + type: integer + format: int64 _common___UnitMillis: description: The time unit for milliseconds. type: integer @@ -32759,12 +36660,14 @@ components: - all - index-setting _common___WaitForActiveShards: + description: Waits until the specified number of shards is active before returning a response. Use `all` for all shards. oneOf: - title: count type: integer - title: option $ref: '#/components/schemas/_common___WaitForActiveShardOptions' _common___WaitForEvents: + description: Waits until all currently queued events with the given priority are processed. type: string enum: - high @@ -32777,9 +36680,11 @@ components: type: object properties: current: - type: number + type: integer + format: int64 total: - type: number + type: integer + format: int64 total_time: $ref: '#/components/schemas/_common___Duration' total_time_in_millis: @@ -32929,19 +36834,16 @@ components: - $ref: '#/components/schemas/_common.aggregations___UnmappedSamplerAggregate' - $ref: '#/components/schemas/_common.aggregations___GeoHashGridAggregate' - $ref: '#/components/schemas/_common.aggregations___GeoTileGridAggregate' - - $ref: '#/components/schemas/_common.aggregations___GeoHexGridAggregate' - $ref: '#/components/schemas/_common.aggregations___RangeAggregate' - $ref: '#/components/schemas/_common.aggregations___DateRangeAggregate' - $ref: '#/components/schemas/_common.aggregations___GeoDistanceAggregate' - $ref: '#/components/schemas/_common.aggregations___IpRangeAggregate' - - $ref: '#/components/schemas/_common.aggregations___IpPrefixAggregate' - $ref: '#/components/schemas/_common.aggregations___FiltersAggregate' - $ref: '#/components/schemas/_common.aggregations___AdjacencyMatrixAggregate' - $ref: '#/components/schemas/_common.aggregations___SignificantLongTermsAggregate' - $ref: '#/components/schemas/_common.aggregations___SignificantStringTermsAggregate' - $ref: '#/components/schemas/_common.aggregations___UnmappedSignificantTermsAggregate' - $ref: '#/components/schemas/_common.aggregations___CompositeAggregate' - - $ref: '#/components/schemas/_common.aggregations___FrequentItemSetsAggregate' - $ref: '#/components/schemas/_common.aggregations___ScriptedMetricAggregate' - $ref: '#/components/schemas/_common.aggregations___TopHitsAggregate' - $ref: '#/components/schemas/_common.aggregations___InferenceAggregate' @@ -33010,14 +36912,8 @@ components: $ref: '#/components/schemas/_common.aggregations___BucketSelectorAggregation' bucket_sort: $ref: '#/components/schemas/_common.aggregations___BucketSortAggregation' - bucket_count_ks_test: - $ref: '#/components/schemas/_common.aggregations___BucketKsAggregation' - bucket_correlation: - $ref: '#/components/schemas/_common.aggregations___BucketCorrelationAggregation' cardinality: $ref: '#/components/schemas/_common.aggregations___CardinalityAggregation' - categorize_text: - $ref: '#/components/schemas/_common.aggregations___CategorizeTextAggregation' children: $ref: '#/components/schemas/_common.aggregations___ChildrenAggregation' composite: @@ -33038,8 +36934,6 @@ components: $ref: '#/components/schemas/_common.aggregations___ExtendedStatsAggregation' extended_stats_bucket: $ref: '#/components/schemas/_common.aggregations___ExtendedStatsBucketAggregation' - frequent_item_sets: - $ref: '#/components/schemas/_common.aggregations___FrequentItemSetsAggregation' filter: $ref: '#/components/schemas/_common.query_dsl___QueryContainer' filters: @@ -33056,16 +36950,12 @@ components: $ref: '#/components/schemas/_common.aggregations___GeoLineAggregation' geotile_grid: $ref: '#/components/schemas/_common.aggregations___GeoTileGridAggregation' - geohex_grid: - $ref: '#/components/schemas/_common.aggregations___GeohexGridAggregation' global: $ref: '#/components/schemas/_common.aggregations___GlobalAggregation' histogram: $ref: '#/components/schemas/_common.aggregations___HistogramAggregation' ip_range: $ref: '#/components/schemas/_common.aggregations___IpRangeAggregation' - ip_prefix: - $ref: '#/components/schemas/_common.aggregations___IpPrefixAggregation' inference: $ref: '#/components/schemas/_common.aggregations___InferenceAggregation' line: @@ -33197,7 +37087,8 @@ components: properties: buckets: description: The target number of buckets. - type: number + type: integer + format: int32 field: $ref: '#/components/schemas/_common___Field' format: @@ -33214,8 +37105,7 @@ components: type: string params: type: object - additionalProperties: - type: object + additionalProperties: true script: $ref: '#/components/schemas/_common___Script' time_zone: @@ -33281,90 +37171,11 @@ components: compression: description: Limits the maximum number of nodes used by the underlying TDigest algorithm to `20 * compression`, enabling control of memory usage and approximation error. type: number + format: double _common.aggregations___BucketAggregationBase: allOf: - $ref: '#/components/schemas/_common.aggregations___Aggregation' - type: object - _common.aggregations___BucketCorrelationAggregation: - allOf: - - $ref: '#/components/schemas/_common.aggregations___BucketPathAggregation' - - type: object - properties: - function: - $ref: '#/components/schemas/_common.aggregations___BucketCorrelationFunction' - required: - - function - _common.aggregations___BucketCorrelationFunction: - type: object - properties: - count_correlation: - $ref: '#/components/schemas/_common.aggregations___BucketCorrelationFunctionCountCorrelation' - required: - - count_correlation - _common.aggregations___BucketCorrelationFunctionCountCorrelation: - type: object - properties: - indicator: - $ref: '#/components/schemas/_common.aggregations___BucketCorrelationFunctionCountCorrelationIndicator' - required: - - indicator - _common.aggregations___BucketCorrelationFunctionCountCorrelationIndicator: - type: object - properties: - doc_count: - description: |- - The total number of documents that initially created the expectations. It's required to be greater - than or equal to the sum of all values in the buckets_path as this is the originating superset of data - to which the term values are correlated. - type: number - expectations: - description: |- - An array of numbers with which to correlate the configured `bucket_path` values. - The length of this value must always equal the number of buckets returned by the `bucket_path`. - type: array - items: - type: number - fractions: - description: |- - An array of fractions to use when averaging and calculating variance. This should be used if - the pre-calculated data and the buckets_path have known gaps. The length of fractions, if provided, - must equal expectations. - type: array - items: - type: number - required: - - doc_count - - expectations - _common.aggregations___BucketKsAggregation: - allOf: - - $ref: '#/components/schemas/_common.aggregations___BucketPathAggregation' - - type: object - properties: - alternative: - description: |- - A list of string values indicating which K-S test alternative to calculate. The valid values - are: "greater", "less", "two_sided". This parameter is key for determining the K-S statistic used - when calculating the K-S test. Default value is all possible alternative hypotheses. - type: array - items: - type: string - fractions: - description: |- - A list of doubles indicating the distribution of the samples with which to compare to the `buckets_path` results. - In typical usage this is the overall proportion of documents in each bucket, which is compared with the actual - document proportions in each bucket from the sibling aggregation counts. The default is to assume that overall - documents are uniformly distributed on these buckets, which they would be if one used equal percentiles of a - metric to define the bucket end points. - type: array - items: - type: number - sampling_method: - description: |- - Indicates the sampling methodology when calculating the K-S test. Note, this is sampling of the returned values. - This determines the cumulative distribution function (CDF) points used comparing the two samples. Default is - `upper_tail`, which emphasizes the upper end of the CDF points. Valid options are: `upper_tail`, `uniform`, - and `lower_tail`. - type: string _common.aggregations___BucketMetricValueAggregate: allOf: - $ref: '#/components/schemas/_common.aggregations___SingleMetricAggregateBase' @@ -33452,17 +37263,6 @@ components: - type: array items: $ref: '#/components/schemas/_common.aggregations___FiltersBucket' - _common.aggregations___BucketsFrequentItemSetsBucket: - description: |- - Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for - the different buckets, the result is a dictionary. - oneOf: - - type: object - additionalProperties: - $ref: '#/components/schemas/_common.aggregations___FrequentItemSetsBucket' - - type: array - items: - $ref: '#/components/schemas/_common.aggregations___FrequentItemSetsBucket' _common.aggregations___BucketsGeoHashGridBucket: description: |- Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for @@ -33474,17 +37274,6 @@ components: - type: array items: $ref: '#/components/schemas/_common.aggregations___GeoHashGridBucket' - _common.aggregations___BucketsGeoHexGridBucket: - description: |- - Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for - the different buckets, the result is a dictionary. - oneOf: - - type: object - additionalProperties: - $ref: '#/components/schemas/_common.aggregations___GeoHexGridBucket' - - type: array - items: - $ref: '#/components/schemas/_common.aggregations___GeoHexGridBucket' _common.aggregations___BucketsGeoTileGridBucket: description: |- Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for @@ -33507,17 +37296,6 @@ components: - type: array items: $ref: '#/components/schemas/_common.aggregations___HistogramBucket' - _common.aggregations___BucketsIpPrefixBucket: - description: |- - Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for - the different buckets, the result is a dictionary. - oneOf: - - type: object - additionalProperties: - $ref: '#/components/schemas/_common.aggregations___IpPrefixBucket' - - type: array - items: - $ref: '#/components/schemas/_common.aggregations___IpPrefixBucket' _common.aggregations___BucketsIpRangeBucket: description: |- Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for @@ -33569,27 +37347,32 @@ components: properties: from: description: Buckets in positions prior to `from` will be truncated. - type: number + type: integer + format: int32 gap_policy: $ref: '#/components/schemas/_common.aggregations___GapPolicy' size: description: |- The number of buckets to return. Defaults to all buckets of the parent aggregation. - type: number + type: integer + format: int32 sort: $ref: '#/components/schemas/_common___Sort' _common.aggregations___BucketsPath: description: |- Buckets path can be expressed in different ways, and an aggregation may accept some or all of these - forms depending on its type. Please refer to each aggregation's documentation to know what buckets + forms depending on its type. Refer to each aggregation's documentation to know what buckets path forms they accept. oneOf: - - type: string - - type: array + - title: single + type: string + - title: array + type: array items: type: string - - type: object + - title: dict + type: object additionalProperties: type: string _common.aggregations___BucketsQueryContainer: @@ -33597,10 +37380,12 @@ components: Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for the different buckets, the result is a dictionary. oneOf: - - type: object + - title: keyed + type: object additionalProperties: $ref: '#/components/schemas/_common.query_dsl___QueryContainer' - - type: array + - title: array + type: array items: $ref: '#/components/schemas/_common.query_dsl___QueryContainer' _common.aggregations___BucketsRangeBucket: @@ -33681,16 +37466,47 @@ components: items: $ref: '#/components/schemas/_common___Void' _common.aggregations___CalendarInterval: - type: string - enum: - - day - - hour - - minute - - month - - quarter - - second - - week - - year + oneOf: + - title: second + type: string + enum: + - second + - 1s + - title: minute + type: string + enum: + - minute + - 1m + - title: hour + type: string + enum: + - hour + - 1h + - title: day + type: string + enum: + - day + - 1d + - title: week + type: string + enum: + - week + - 1w + - title: month + type: string + enum: + - month + - 1M + - title: quarter + type: string + enum: + - quarter + - 1q + - title: year + type: string + enum: + - year + - 1Y _common.aggregations___CardinalityAggregate: allOf: - $ref: '#/components/schemas/_common.aggregations___AggregateBase' @@ -33709,7 +37525,8 @@ components: description: |- A unique count below which counts are expected to be close to accurate. This allows to trade memory for accuracy. - type: number + type: integer + format: int32 rehash: type: boolean execution_hint: @@ -33722,62 +37539,6 @@ components: - save_memory_heuristic - save_time_heuristic - segment_ordinals - _common.aggregations___CategorizeTextAggregation: - allOf: - - $ref: '#/components/schemas/_common.aggregations___Aggregation' - - type: object - properties: - field: - $ref: '#/components/schemas/_common___Field' - max_unique_tokens: - description: |- - The maximum number of unique tokens at any position up to max_matched_tokens. Must be larger than 1. - Smaller values use less memory and create fewer categories. Larger values will use more memory and - create narrower categories. Max allowed value is 100. - type: number - max_matched_tokens: - description: |- - The maximum number of token positions to match on before attempting to merge categories. Larger - values will use more memory and create narrower categories. Max allowed value is 100. - type: number - similarity_threshold: - description: |- - The minimum percentage of tokens that must match for text to be added to the category bucket. Must - be between 1 and 100. The larger the value the narrower the categories. Larger values will increase memory - usage and create narrower categories. - type: number - categorization_filters: - description: |- - This property expects an array of regular expressions. The expressions are used to filter out matching - sequences from the categorization field values. You can use this functionality to fine tune the categorization - by excluding sequences from consideration when categories are defined. For example, you can exclude SQL - statements that appear in your log files. This property cannot be used at the same time as categorization_analyzer. - If you only want to define simple regular expression filters that are applied prior to tokenization, setting - this property is the easiest method. If you also want to customize the tokenizer or post-tokenization filtering, - use the categorization_analyzer property instead and include the filters as pattern_replace character filters. - type: array - items: - type: string - categorization_analyzer: - $ref: '#/components/schemas/_common.aggregations___CategorizeTextAnalyzer' - shard_size: - description: The number of categorization buckets to return from each shard before merging all the results. - type: number - size: - description: The number of buckets to return. - type: number - min_doc_count: - description: The minimum number of documents in a bucket to be returned to the results. - type: number - shard_min_doc_count: - description: The minimum number of documents in a bucket to be returned from the shard before merging. - type: number - required: - - field - _common.aggregations___CategorizeTextAnalyzer: - oneOf: - - type: string - - $ref: '#/components/schemas/_common.aggregations___CustomCategorizeTextAnalyzer' _common.aggregations___ChildrenAggregate: allOf: - $ref: '#/components/schemas/_common.aggregations___SingleBucketAggregateBase' @@ -33806,18 +37567,20 @@ components: properties: num_top_classes: description: Specifies the number of top class predictions to return. Defaults to 0. - type: number + type: integer + format: int32 num_top_feature_importance_values: description: Specifies the maximum number of feature importance values per document. - type: number + type: integer + format: int32 prediction_field_type: - description: 'Specifies the type of the predicted field to write. Acceptable values are: string, number, boolean. When boolean is provided 1.0 is transformed to true and 0.0 to false.' + description: 'Specifies the type of the predicted field to write. Acceptable values are: string, number, Boolean. When Boolean is provided 1.0 is transformed to true and 0.0 to false.' type: string results_field: - description: The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + description: The field that is added to incoming documents to contain the inference prediction. Defaults to `predicted_value`. type: string top_classes_results_field: - description: Specifies the field to which the top classes are written. Defaults to top_classes. + description: Specifies the field to which the top classes are written. Defaults to `top_classes`. type: string _common.aggregations___CompositeAggregate: allOf: @@ -33839,7 +37602,8 @@ components: $ref: '#/components/schemas/_common.aggregations___CompositeAggregateKey' size: description: The number of composite buckets that should be returned. - type: number + type: integer + format: int32 sources: description: |- The value sources used to build composite buckets. @@ -33849,32 +37613,17 @@ components: type: object additionalProperties: $ref: '#/components/schemas/_common.aggregations___CompositeAggregationSource' - _common.aggregations___CompositeAggregationBase: - type: object - properties: - field: - $ref: '#/components/schemas/_common___Field' - missing_bucket: - type: boolean - missing_order: - $ref: '#/components/schemas/_common.aggregations___MissingOrder' - script: - $ref: '#/components/schemas/_common___Script' - value_type: - $ref: '#/components/schemas/_common.aggregations___ValueType' - order: - $ref: '#/components/schemas/_common___SortOrder' _common.aggregations___CompositeAggregationSource: type: object properties: terms: - $ref: '#/components/schemas/_common.aggregations___CompositeTermsAggregation' + $ref: '#/components/schemas/_common.aggregations___CompositeTermsAggregationSource' histogram: - $ref: '#/components/schemas/_common.aggregations___CompositeHistogramAggregation' + $ref: '#/components/schemas/_common.aggregations___CompositeHistogramAggregationSource' date_histogram: - $ref: '#/components/schemas/_common.aggregations___CompositeDateHistogramAggregation' + $ref: '#/components/schemas/_common.aggregations___CompositeDateHistogramAggregationSource' geotile_grid: - $ref: '#/components/schemas/_common.aggregations___CompositeGeoTileGridAggregation' + $ref: '#/components/schemas/_common.aggregations___CompositeGeoTileGridAggregationSource' _common.aggregations___CompositeBucket: allOf: - $ref: '#/components/schemas/_common.aggregations___MultiBucketBase' @@ -33884,9 +37633,9 @@ components: $ref: '#/components/schemas/_common.aggregations___CompositeAggregateKey' required: - key - _common.aggregations___CompositeDateHistogramAggregation: + _common.aggregations___CompositeDateHistogramAggregationSource: allOf: - - $ref: '#/components/schemas/_common.aggregations___CompositeAggregationBase' + - $ref: '#/components/schemas/_common.aggregations___CompositeValuesSource' - type: object properties: format: @@ -33899,28 +37648,45 @@ components: $ref: '#/components/schemas/_common___Duration' time_zone: $ref: '#/components/schemas/_common___TimeZone' - _common.aggregations___CompositeGeoTileGridAggregation: + _common.aggregations___CompositeGeoTileGridAggregationSource: allOf: - - $ref: '#/components/schemas/_common.aggregations___CompositeAggregationBase' + - $ref: '#/components/schemas/_common.aggregations___CompositeValuesSource' - type: object properties: precision: - type: number + type: integer + format: int32 bounds: $ref: '#/components/schemas/_common___GeoBounds' - _common.aggregations___CompositeHistogramAggregation: + _common.aggregations___CompositeHistogramAggregationSource: allOf: - - $ref: '#/components/schemas/_common.aggregations___CompositeAggregationBase' + - $ref: '#/components/schemas/_common.aggregations___CompositeValuesSource' - type: object properties: interval: type: number + format: double required: - interval - _common.aggregations___CompositeTermsAggregation: + _common.aggregations___CompositeTermsAggregationSource: allOf: - - $ref: '#/components/schemas/_common.aggregations___CompositeAggregationBase' + - $ref: '#/components/schemas/_common.aggregations___CompositeValuesSource' - type: object + _common.aggregations___CompositeValuesSource: + type: object + properties: + field: + $ref: '#/components/schemas/_common___Field' + missing_bucket: + type: boolean + missing_order: + $ref: '#/components/schemas/_common.aggregations___MissingOrder' + script: + $ref: '#/components/schemas/_common___Script' + value_type: + $ref: '#/components/schemas/_common.aggregations___ValueType' + order: + $ref: '#/components/schemas/_common___SortOrder' _common.aggregations___CumulativeCardinalityAggregate: allOf: - $ref: '#/components/schemas/_common.aggregations___AggregateBase' @@ -33940,19 +37706,6 @@ components: allOf: - $ref: '#/components/schemas/_common.aggregations___PipelineAggregationBase' - type: object - _common.aggregations___CustomCategorizeTextAnalyzer: - type: object - properties: - char_filter: - type: array - items: - type: string - tokenizer: - type: string - filter: - type: array - items: - type: string _common.aggregations___DateHistogramAggregate: allOf: - $ref: '#/components/schemas/_common.aggregations___MultiBucketAggregateBaseDateHistogramBucket' @@ -33983,17 +37736,17 @@ components: description: |- Only returns buckets that have `min_doc_count` number of documents. By default, all buckets between the first bucket that matches documents and the last one are returned. - type: number + type: integer + format: int32 missing: $ref: '#/components/schemas/_common___DateTime' offset: $ref: '#/components/schemas/_common___Duration' order: - $ref: '#/components/schemas/_common.aggregations___AggregateOrder' + $ref: '#/components/schemas/_common.aggregations___HistogramOrder' params: type: object - additionalProperties: - type: object + additionalProperties: true script: $ref: '#/components/schemas/_common___Script' time_zone: @@ -34027,7 +37780,7 @@ components: description: The date format used to format `from` and `to` in the response. type: string missing: - $ref: '#/components/schemas/_common.aggregations___Missing' + $ref: '#/components/schemas/_common___FieldValue' ranges: description: Array of date ranges. type: array @@ -34070,12 +37823,14 @@ components: $ref: '#/components/schemas/_common.aggregations___SamplerAggregationExecutionHint' max_docs_per_value: description: Limits how many documents are permitted per choice of de-duplicating value. - type: number + type: integer + format: int32 script: $ref: '#/components/schemas/_common___Script' shard_size: description: Limits how many top-scoring documents are collected in the sample processed on each shard. - type: number + type: integer + format: int32 field: $ref: '#/components/schemas/_common___Field' _common.aggregations___DoubleTermsAggregate: @@ -34098,6 +37853,7 @@ components: properties: alpha: type: number + format: float _common.aggregations___EwmaMovingAverageAggregation: allOf: - $ref: '#/components/schemas/_common.aggregations___MovingAverageAggregationBase' @@ -34204,6 +37960,7 @@ components: sigma: description: The number of standard deviations above/below the mean to display. type: number + format: double _common.aggregations___ExtendedStatsBucketAggregate: allOf: - $ref: '#/components/schemas/_common.aggregations___ExtendedStatsAggregate' @@ -34216,13 +37973,17 @@ components: sigma: description: The number of standard deviations above/below the mean to display. type: number + format: double _common.aggregations___FieldDateMath: description: |- A date range limit, represented either as a DateMath expression or a number expressed according to the target field's precision. oneOf: - - $ref: '#/components/schemas/_common___DateMath' - - type: number + - title: expr + $ref: '#/components/schemas/_common___DateMath' + - title: value + type: number + format: double _common.aggregations___FilterAggregate: allOf: - $ref: '#/components/schemas/_common.aggregations___SingleBucketAggregateBase' @@ -34267,58 +38028,6 @@ components: properties: format: type: string - _common.aggregations___FrequentItemSetsAggregate: - allOf: - - $ref: '#/components/schemas/_common.aggregations___MultiBucketAggregateBaseFrequentItemSetsBucket' - - type: object - _common.aggregations___FrequentItemSetsAggregation: - type: object - properties: - fields: - description: Fields to analyze. - type: array - items: - $ref: '#/components/schemas/_common.aggregations___FrequentItemSetsField' - minimum_set_size: - description: The minimum size of one item set. - type: number - minimum_support: - description: The minimum support of one item set. - type: number - size: - description: The number of top item sets to return. - type: number - filter: - $ref: '#/components/schemas/_common.query_dsl___QueryContainer' - required: - - fields - _common.aggregations___FrequentItemSetsBucket: - allOf: - - $ref: '#/components/schemas/_common.aggregations___MultiBucketBase' - - type: object - properties: - key: - type: object - additionalProperties: - type: array - items: - type: string - support: - type: number - required: - - key - - support - _common.aggregations___FrequentItemSetsField: - type: object - properties: - field: - $ref: '#/components/schemas/_common___Field' - exclude: - $ref: '#/components/schemas/_common.aggregations___TermsExclude' - include: - $ref: '#/components/schemas/_common.aggregations___TermsInclude' - required: - - field _common.aggregations___GapPolicy: type: string enum: @@ -34357,7 +38066,8 @@ components: - type: object properties: count: - type: number + type: integer + format: int64 location: $ref: '#/components/schemas/_common___GeoLocation' _common.aggregations___GeoDistanceAggregate: @@ -34401,10 +38111,12 @@ components: description: |- Allows for more accurate counting of the top cells returned in the final result the aggregation. Defaults to returning `max(10,(size x number-of-shards))` buckets from each shard. - type: number + type: integer + format: int32 size: description: The maximum number of geohash buckets to return. - type: number + type: integer + format: int32 _common.aggregations___GeoHashGridBucket: allOf: - $ref: '#/components/schemas/_common.aggregations___MultiBucketBase' @@ -34414,41 +38126,6 @@ components: $ref: '#/components/schemas/_common___GeoHash' required: - key - _common.aggregations___GeoHexGridAggregate: - allOf: - - $ref: '#/components/schemas/_common.aggregations___MultiBucketAggregateBaseGeoHexGridBucket' - - type: object - _common.aggregations___GeohexGridAggregation: - allOf: - - $ref: '#/components/schemas/_common.aggregations___BucketAggregationBase' - - type: object - properties: - field: - $ref: '#/components/schemas/_common___Field' - precision: - description: |- - Integer zoom of the key used to defined cells or buckets - in the results. Value should be between 0-15. - type: number - bounds: - $ref: '#/components/schemas/_common___GeoBounds' - size: - description: Maximum number of buckets to return. - type: number - shard_size: - description: Number of buckets returned from each shard. - type: number - required: - - field - _common.aggregations___GeoHexGridBucket: - allOf: - - $ref: '#/components/schemas/_common.aggregations___MultiBucketBase' - - type: object - properties: - key: - $ref: '#/components/schemas/_common___GeoHexCell' - required: - - key _common.aggregations___GeoLineAggregate: allOf: - $ref: '#/components/schemas/_common.aggregations___AggregateBase' @@ -34480,7 +38157,8 @@ components: description: |- The maximum length of the line represented in the aggregation. Valid sizes are between 1 and 10000. - type: number + type: integer + format: int32 required: - point - sort @@ -34515,10 +38193,12 @@ components: description: |- Allows for more accurate counting of the top cells returned in the final result the aggregation. Defaults to returning `max(10,(size x number-of-shards))` buckets from each shard. - type: number + type: integer + format: int32 size: description: The maximum number of buckets to return. - type: number + type: integer + format: int32 bounds: $ref: '#/components/schemas/_common___GeoBounds' _common.aggregations___GeoTileGridBucket: @@ -34549,7 +38229,8 @@ components: properties: number_of_significant_value_digits: description: Specifies the resolution of values for the histogram in number of significant digits. - type: number + type: integer + format: int32 _common.aggregations___HdrPercentileRanksAggregate: allOf: - $ref: '#/components/schemas/_common.aggregations___PercentilesAggregateBase' @@ -34578,23 +38259,27 @@ components: The interval for the buckets. Must be a positive decimal. type: number + format: double min_doc_count: description: |- Only returns buckets that have `min_doc_count` number of documents. By default, the response will fill gaps in the histogram with empty buckets. - type: number + type: integer + format: int32 missing: description: |- The value to apply to documents that do not have a value. By default, documents without a value are ignored. type: number + format: double offset: description: |- By default, the bucket keys start with 0 and then continue in even spaced steps of `interval`. The bucket boundaries can be shifted by using the `offset` option. type: number + format: double order: - $ref: '#/components/schemas/_common.aggregations___AggregateOrder' + $ref: '#/components/schemas/_common.aggregations___HistogramOrder' script: $ref: '#/components/schemas/_common___Script' format: @@ -34613,13 +38298,22 @@ components: type: number required: - key + _common.aggregations___HistogramOrder: + type: object + properties: + _count: + $ref: '#/components/schemas/_common___SortOrder' + _key: + $ref: '#/components/schemas/_common___SortOrder' _common.aggregations___HoltLinearModelSettings: type: object properties: alpha: type: number + format: float beta: type: number + format: float _common.aggregations___HoltMovingAverageAggregation: allOf: - $ref: '#/components/schemas/_common.aggregations___MovingAverageAggregationBase' @@ -34639,14 +38333,18 @@ components: properties: alpha: type: number + format: float beta: type: number + format: float gamma: type: number + format: float pad: type: boolean period: - type: number + type: integer + format: int32 type: $ref: '#/components/schemas/_common.aggregations___HoltWintersType' _common.aggregations___HoltWintersMovingAverageAggregation: @@ -34664,10 +38362,13 @@ components: - model - settings _common.aggregations___HoltWintersType: - type: string - enum: - - add - - mult + oneOf: + - title: additive + type: string + const: add + - title: multiplicative + type: string + const: mult _common.aggregations___InferenceAggregate: allOf: - $ref: '#/components/schemas/_common.aggregations___AggregateBase' @@ -34741,54 +38442,6 @@ components: - class_name - class_probability - class_score - _common.aggregations___IpPrefixAggregate: - allOf: - - $ref: '#/components/schemas/_common.aggregations___MultiBucketAggregateBaseIpPrefixBucket' - - type: object - _common.aggregations___IpPrefixAggregation: - allOf: - - $ref: '#/components/schemas/_common.aggregations___BucketAggregationBase' - - type: object - properties: - field: - $ref: '#/components/schemas/_common___Field' - prefix_length: - description: |- - Length of the network prefix. For IPv4 addresses the accepted range is [0, 32]. - For IPv6 addresses the accepted range is [0, 128]. - type: number - is_ipv6: - description: Defines whether the prefix applies to IPv6 addresses. - type: boolean - append_prefix_length: - description: Defines whether the prefix length is appended to IP address keys in the response. - type: boolean - keyed: - description: Defines whether buckets are returned as a hash rather than an array in the response. - type: boolean - min_doc_count: - description: Minimum number of documents in a bucket for it to be included in the response. - type: number - required: - - field - - prefix_length - _common.aggregations___IpPrefixBucket: - allOf: - - $ref: '#/components/schemas/_common.aggregations___MultiBucketBase' - - type: object - properties: - is_ipv6: - type: boolean - key: - type: string - prefix_length: - type: number - netmask: - type: string - required: - - is_ipv6 - - key - - prefix_length _common.aggregations___IpRangeAggregate: allOf: - $ref: '#/components/schemas/_common.aggregations___MultiBucketAggregateBaseIpRangeBucket' @@ -34897,6 +38550,7 @@ components: type: object additionalProperties: type: number + format: double _common.aggregations___MatrixStatsAggregate: allOf: - $ref: '#/components/schemas/_common.aggregations___AggregateBase' @@ -34973,13 +38627,14 @@ components: compression: description: Limits the maximum number of nodes used by the underlying TDigest algorithm to `20 * compression`, enabling control of memory usage and approximation error. type: number + format: double _common.aggregations___MetricAggregationBase: type: object properties: field: $ref: '#/components/schemas/_common___Field' missing: - $ref: '#/components/schemas/_common.aggregations___Missing' + $ref: '#/components/schemas/_common___FieldValue' script: $ref: '#/components/schemas/_common___Script' _common.aggregations___MinAggregate: @@ -35003,12 +38658,6 @@ components: - month - second - year - _common.aggregations___Missing: - oneOf: - - type: string - - type: number - - type: number - - type: boolean _common.aggregations___MissingAggregate: allOf: - $ref: '#/components/schemas/_common.aggregations___SingleBucketAggregateBase' @@ -35021,7 +38670,7 @@ components: field: $ref: '#/components/schemas/_common___Field' missing: - $ref: '#/components/schemas/_common.aggregations___Missing' + $ref: '#/components/schemas/_common___FieldValue' _common.aggregations___MissingOrder: type: string enum: @@ -35046,9 +38695,11 @@ components: minimize: type: boolean predict: - type: number + type: integer + format: int32 window: - type: number + type: integer + format: int32 _common.aggregations___MovingFunctionAggregation: allOf: - $ref: '#/components/schemas/_common.aggregations___PipelineAggregationBase' @@ -35061,10 +38712,12 @@ components: description: |- By default, the window consists of the last n values excluding the current bucket. Increasing `shift` by 1, moves the starting window position by 1 to the right. - type: number + type: integer + format: int32 window: description: The size of window to "slide" across the histogram. - type: number + type: integer + format: int32 _common.aggregations___MovingPercentilesAggregation: allOf: - $ref: '#/components/schemas/_common.aggregations___PipelineAggregationBase' @@ -35072,12 +38725,14 @@ components: properties: window: description: The size of window to "slide" across the histogram. - type: number + type: integer + format: int32 shift: description: |- By default, the window consists of the last n values excluding the current bucket. Increasing `shift` by 1, moves the starting window position by 1 to the right. - type: number + type: integer + format: int32 keyed: type: boolean _common.aggregations___MultiBucketAggregateBaseAdjacencyMatrixBucket: @@ -35125,15 +38780,6 @@ components: $ref: '#/components/schemas/_common.aggregations___BucketsFiltersBucket' required: - buckets - _common.aggregations___MultiBucketAggregateBaseFrequentItemSetsBucket: - allOf: - - $ref: '#/components/schemas/_common.aggregations___AggregateBase' - - type: object - properties: - buckets: - $ref: '#/components/schemas/_common.aggregations___BucketsFrequentItemSetsBucket' - required: - - buckets _common.aggregations___MultiBucketAggregateBaseGeoHashGridBucket: allOf: - $ref: '#/components/schemas/_common.aggregations___AggregateBase' @@ -35143,15 +38789,6 @@ components: $ref: '#/components/schemas/_common.aggregations___BucketsGeoHashGridBucket' required: - buckets - _common.aggregations___MultiBucketAggregateBaseGeoHexGridBucket: - allOf: - - $ref: '#/components/schemas/_common.aggregations___AggregateBase' - - type: object - properties: - buckets: - $ref: '#/components/schemas/_common.aggregations___BucketsGeoHexGridBucket' - required: - - buckets _common.aggregations___MultiBucketAggregateBaseGeoTileGridBucket: allOf: - $ref: '#/components/schemas/_common.aggregations___AggregateBase' @@ -35170,15 +38807,6 @@ components: $ref: '#/components/schemas/_common.aggregations___BucketsHistogramBucket' required: - buckets - _common.aggregations___MultiBucketAggregateBaseIpPrefixBucket: - allOf: - - $ref: '#/components/schemas/_common.aggregations___AggregateBase' - - type: object - properties: - buckets: - $ref: '#/components/schemas/_common.aggregations___BucketsIpPrefixBucket' - required: - - buckets _common.aggregations___MultiBucketAggregateBaseIpRangeBucket: allOf: - $ref: '#/components/schemas/_common.aggregations___AggregateBase' @@ -35291,7 +38919,7 @@ components: field: $ref: '#/components/schemas/_common___Field' missing: - $ref: '#/components/schemas/_common.aggregations___Missing' + $ref: '#/components/schemas/_common___FieldValue' required: - field _common.aggregations___MultiTermsAggregate: @@ -35306,24 +38934,28 @@ components: collect_mode: $ref: '#/components/schemas/_common.aggregations___TermsAggregationCollectMode' order: - $ref: '#/components/schemas/_common.aggregations___AggregateOrder' + $ref: '#/components/schemas/_common.aggregations___HistogramOrder' min_doc_count: description: The minimum number of documents in a bucket for it to be returned. - type: number + type: integer + format: int32 shard_min_doc_count: description: The minimum number of documents in a bucket on each shard for it to be returned. - type: number + type: integer + format: int32 shard_size: description: |- The number of candidate terms produced by each shard. By default, `shard_size` will be automatically estimated based on the number of shards and the `size` parameter. - type: number + type: integer + format: int32 show_term_doc_count_error: description: Calculates the doc count error on per term basis. type: boolean size: description: The number of term buckets should be returned out of the overall terms list. - type: number + type: integer + format: int32 terms: description: The field from which to generate sets of terms. type: array @@ -35410,12 +39042,10 @@ components: type: boolean values: description: An array of values for which to calculate the percentile ranks. - oneOf: - - type: array - items: - type: number - - type: 'null' - - type: string + type: array + items: + type: number + format: double hdr: $ref: '#/components/schemas/_common.aggregations___HdrMethod' tdigest: @@ -35450,6 +39080,7 @@ components: type: array items: type: number + format: double hdr: $ref: '#/components/schemas/_common.aggregations___HdrMethod' tdigest: @@ -35468,6 +39099,7 @@ components: type: array items: type: number + format: double _common.aggregations___PipelineAggregationBase: allOf: - $ref: '#/components/schemas/_common.aggregations___BucketPathAggregation' @@ -35495,7 +39127,8 @@ components: description: |- The value to apply to documents that do not have a value. By default, documents without a value are ignored. - type: number + type: integer + format: int32 ranges: description: An array of ranges used to bucket documents. type: array @@ -35522,7 +39155,7 @@ components: to_as_string: type: string key: - description: The bucket key. Present if the aggregation is _not_ keyed + description: The bucket key. Present if the aggregation is not keyed. type: string _common.aggregations___RareTermsAggregation: allOf: @@ -35537,14 +39170,16 @@ components: $ref: '#/components/schemas/_common.aggregations___TermsInclude' max_doc_count: description: The maximum number of documents a term should appear in. - type: number + type: integer + format: int64 missing: - $ref: '#/components/schemas/_common.aggregations___Missing' + $ref: '#/components/schemas/_common___FieldValue' precision: description: |- The precision of the internal CuckooFilters. Smaller precision leads to better approximation, but higher memory usage. type: number + format: double value_type: type: string _common.aggregations___RateAggregate: @@ -35579,7 +39214,8 @@ components: $ref: '#/components/schemas/_common___Field' num_top_feature_importance_values: description: Specifies the maximum number of feature importance values per document. - type: number + type: integer + format: int32 _common.aggregations___ReverseNestedAggregate: allOf: - $ref: '#/components/schemas/_common.aggregations___SingleBucketAggregateBase' @@ -35602,7 +39238,8 @@ components: properties: shard_size: description: Limits how many top-scoring documents are collected in the sample processed on each shard. - type: number + type: integer + format: int32 _common.aggregations___SamplerAggregationExecutionHint: type: string enum: @@ -35641,8 +39278,7 @@ components: A global object with script parameters for `init`, `map` and `combine` scripts. It is shared between the scripts. type: object - additionalProperties: - type: object + additionalProperties: true reduce_script: $ref: '#/components/schemas/_common___Script' _common.aggregations___SerialDifferencingAggregation: @@ -35654,7 +39290,8 @@ components: description: |- The historical bucket to subtract from the current value. Must be a positive, non-zero integer. - type: number + type: integer + format: int32 _common.aggregations___SignificantLongTermsAggregate: allOf: - $ref: '#/components/schemas/_common.aggregations___SignificantTermsAggregateBaseSignificantLongTermsBucket' @@ -35733,7 +39370,8 @@ components: $ref: '#/components/schemas/_common___EmptyObject' min_doc_count: description: Only return terms that are found in more than `min_doc_count` hits. - type: number + type: integer + format: int64 mutual_information: $ref: '#/components/schemas/_common.aggregations___MutualInformationHeuristic' percentage: @@ -35744,15 +39382,18 @@ components: description: |- Regulates the certainty a shard has if the term should actually be added to the candidate list or not with respect to the `min_doc_count`. Terms will only be considered if their local shard frequency within the set is higher than the `shard_min_doc_count`. - type: number + type: integer + format: int64 shard_size: description: |- Can be used to control the volumes of candidate terms produced by each shard. By default, `shard_size` will be automatically estimated based on the number of shards and the `size` parameter. - type: number + type: integer + format: int32 size: description: The number of buckets returned out of the overall terms list. - type: number + type: integer + format: int32 _common.aggregations___SignificantTermsBucketBase: allOf: - $ref: '#/components/schemas/_common.aggregations___MultiBucketBase' @@ -35791,7 +39432,8 @@ components: $ref: '#/components/schemas/_common___EmptyObject' min_doc_count: description: Only return values that are found in more than `min_doc_count` hits. - type: number + type: integer + format: int64 mutual_information: $ref: '#/components/schemas/_common.aggregations___MutualInformationHeuristic' percentage: @@ -35800,17 +39442,20 @@ components: $ref: '#/components/schemas/_common.aggregations___ScriptedHeuristic' shard_min_doc_count: description: |- - Regulates the certainty a shard has if the values should actually be added to the candidate list or not with respect to the min_doc_count. + Regulates the certainty a shard has if the values should actually be added to the candidate list or not with respect to the `min_doc_count`. Values will only be considered if their local shard frequency within the set is higher than the `shard_min_doc_count`. - type: number + type: integer + format: int64 shard_size: description: |- The number of candidate terms produced by each shard. By default, `shard_size` will be automatically estimated based on the number of shards and the `size` parameter. - type: number + type: integer + format: int32 size: description: The number of buckets returned out of the overall terms list. - type: number + type: integer + format: int32 source_fields: $ref: '#/components/schemas/_common___Fields' _common.aggregations___SimpleMovingAverageAggregation: @@ -36066,7 +39711,8 @@ components: properties: compression: description: Limits the maximum number of nodes used by the underlying TDigest algorithm to `20 * compression`, enabling control of memory usage and approximation error. - type: number + type: integer + format: int32 _common.aggregations___TDigestPercentileRanksAggregate: allOf: - $ref: '#/components/schemas/_common.aggregations___PercentilesAggregateBase' @@ -36137,9 +39783,10 @@ components: $ref: '#/components/schemas/_common.aggregations___TermsInclude' min_doc_count: description: Only return values that are found in more than `min_doc_count` hits. - type: number + type: integer + format: int32 missing: - $ref: '#/components/schemas/_common.aggregations___Missing' + $ref: '#/components/schemas/_common___FieldValue' missing_order: $ref: '#/components/schemas/_common.aggregations___MissingOrder' missing_bucket: @@ -36155,13 +39802,15 @@ components: description: |- The number of candidate terms produced by each shard. By default, `shard_size` will be automatically estimated based on the number of shards and the `size` parameter. - type: number + type: integer + format: int32 show_term_doc_count_error: description: Set to `true` to return the `doc_count_error_upper_bound`, which is an upper bound to the error on the `doc_count` returned by each shard. type: boolean size: description: The number of buckets returned out of the overall terms list. - type: number + type: integer + format: int32 format: type: string _common.aggregations___TermsAggregationCollectMode: @@ -36185,26 +39834,33 @@ components: type: number _common.aggregations___TermsExclude: oneOf: - - type: string - - type: array + - title: regexp + type: string + - title: terms + type: array items: type: string _common.aggregations___TermsInclude: oneOf: - - type: string - - type: array + - title: regexp + type: string + - title: terms + type: array items: type: string - - $ref: '#/components/schemas/_common.aggregations___TermsPartition' + - title: partition + $ref: '#/components/schemas/_common.aggregations___TermsPartition' _common.aggregations___TermsPartition: type: object properties: num_partitions: description: The number of partitions. - type: number + type: integer + format: int64 partition: description: The partition number for this request. - type: number + type: integer + format: int64 required: - num_partitions - partition @@ -36240,7 +39896,8 @@ components: type: boolean from: description: Starting document offset. - type: number + type: integer + format: int32 highlight: $ref: '#/components/schemas/_core.search___Highlight' script_fields: @@ -36250,7 +39907,8 @@ components: $ref: '#/components/schemas/_common___ScriptField' size: description: The maximum number of top matching hits to return per bucket. - type: number + type: integer + format: int32 sort: $ref: '#/components/schemas/_common___Sort' _source: @@ -36305,7 +39963,8 @@ components: $ref: '#/components/schemas/_common.aggregations___TopMetricsValue' size: description: The number of top documents from which to return metrics. - type: number + type: integer + format: int32 sort: $ref: '#/components/schemas/_common___Sort' _common.aggregations___TopMetricsValue: @@ -36394,17 +40053,20 @@ components: $ref: '#/components/schemas/_common___Field' buckets: description: The target number of buckets. - type: number + type: integer + format: int32 shard_size: description: |- The number of buckets that the coordinating node will request from each shard. Defaults to `buckets * 50`. - type: number + type: integer + format: int32 initial_buffer: description: |- Specifies the number of individual documents that will be stored in memory on a shard before the initial bucketing algorithm is run. Defaults to `min(10 * shard_size, 50000)`. - type: number + type: integer + format: int32 _common.aggregations___VariableWidthHistogramBucket: allOf: - $ref: '#/components/schemas/_common.aggregations___MultiBucketBase' @@ -36448,6 +40110,7 @@ components: missing: description: A value or weight to use if the field is missing. type: number + format: double script: $ref: '#/components/schemas/_common___Script' _common.aggregations___WeightedAvgAggregate: @@ -36475,6 +40138,7 @@ components: - $ref: '#/components/schemas/_common.analysis___DutchAnalyzer' - $ref: '#/components/schemas/_common.analysis___SmartcnAnalyzer' - $ref: '#/components/schemas/_common.analysis___CjkAnalyzer' + - $ref: '#/components/schemas/_common.analysis___PhoneAnalyzer' _common.analysis___AsciiFoldingTokenFilter: allOf: - $ref: '#/components/schemas/_common.analysis___TokenFilterBase' @@ -36485,7 +40149,7 @@ components: enum: - asciifolding preserve_original: - $ref: '#/components/schemas/_common___Stringifiedboolean' + $ref: '#/components/schemas/_common___StringifiedBoolean' required: - type _common.analysis___CharFilter: @@ -36704,7 +40368,7 @@ components: side: $ref: '#/components/schemas/_common.analysis___EdgeNGramSide' preserve_original: - $ref: '#/components/schemas/_common___Stringifiedboolean' + $ref: '#/components/schemas/_common___StringifiedBoolean' required: - type _common.analysis___EdgeNGramTokenizer: @@ -36747,7 +40411,7 @@ components: articles_path: type: string articles_case: - $ref: '#/components/schemas/_common___Stringifiedboolean' + $ref: '#/components/schemas/_common___StringifiedBoolean' required: - type _common.analysis___FingerprintAnalyzer: @@ -37298,7 +40962,7 @@ components: consume_all_tokens: type: boolean max_token_count: - $ref: '#/components/schemas/_common___Stringifiedinteger' + $ref: '#/components/schemas/_common___StringifiedInteger' required: - type _common.analysis___LowercaseNormalizer: @@ -37365,7 +41029,7 @@ components: items: type: string preserve_original: - $ref: '#/components/schemas/_common___Stringifiedboolean' + $ref: '#/components/schemas/_common___StringifiedBoolean' required: - filters - type @@ -37383,7 +41047,7 @@ components: min_gram: type: integer preserve_original: - $ref: '#/components/schemas/_common___Stringifiedboolean' + $ref: '#/components/schemas/_common___StringifiedBoolean' required: - type _common.analysis___NGramTokenizer: @@ -37488,15 +41152,15 @@ components: enum: - path_hierarchy buffer_size: - $ref: '#/components/schemas/_common___Stringifiedinteger' + $ref: '#/components/schemas/_common___StringifiedInteger' delimiter: type: string replacement: type: string reverse: - $ref: '#/components/schemas/_common___Stringifiedboolean' + $ref: '#/components/schemas/_common___StringifiedBoolean' skip: - $ref: '#/components/schemas/_common___Stringifiedinteger' + $ref: '#/components/schemas/_common___StringifiedInteger' required: - buffer_size - delimiter @@ -37537,7 +41201,7 @@ components: items: type: string preserve_original: - $ref: '#/components/schemas/_common___Stringifiedboolean' + $ref: '#/components/schemas/_common___StringifiedBoolean' required: - patterns - type @@ -37607,6 +41271,17 @@ components: - persian_stem required: - type + _common.analysis___PhoneAnalyzer: + type: object + properties: + type: + type: string + enum: + - phone + - phone-search + phone-region: + type: string + description: Optional ISO 3166 country code, defaults to "ZZ" (unknown region). _common.analysis___PhoneticEncoder: type: string enum: @@ -37938,14 +41613,10 @@ components: - type _common.analysis___StopWords: description: |- - Language value, such as _arabic_ or _thai_. Defaults to _english_. + Language value, such as `arabic` or `thai`. Defaults to `english`. Each language value corresponds to a predefined list of stop words in Lucene. See Stop words by language for supported language values and their stop words. Also accepts an array of stop words. - oneOf: - - type: string - - type: array - items: - type: string + $ref: '#/components/schemas/_common___StringOrStringArray' _common.analysis___SynonymFormat: type: string enum: @@ -38220,7 +41891,7 @@ components: ignore_keywords: type: boolean preserve_original: - $ref: '#/components/schemas/_common___Stringifiedboolean' + $ref: '#/components/schemas/_common___StringifiedBoolean' protected_words: type: array items: @@ -38261,7 +41932,7 @@ components: generate_word_parts: type: boolean preserve_original: - $ref: '#/components/schemas/_common___Stringifiedboolean' + $ref: '#/components/schemas/_common___StringifiedBoolean' protected_words: type: array items: @@ -38297,8 +41968,6 @@ components: type: array items: type: string - time_series_metric: - $ref: '#/components/schemas/_common.mapping___TimeSeriesMetricType' required: - default_metric - metrics @@ -38501,39 +42170,6 @@ components: - date_range required: - type - _common.mapping___DenseVectorIndexOptions: - type: object - properties: - type: - type: string - m: - type: number - ef_construction: - type: number - required: - - ef_construction - - m - - type - _common.mapping___DenseVectorProperty: - allOf: - - $ref: '#/components/schemas/_common.mapping___PropertyBase' - - type: object - properties: - type: - type: string - enum: - - dense_vector - dims: - type: number - similarity: - type: string - index: - type: boolean - index_options: - $ref: '#/components/schemas/_common.mapping___DenseVectorIndexOptions' - required: - - dims - - type _common.mapping___DocValuesPropertyBase: allOf: - $ref: '#/components/schemas/_common.mapping___CorePropertyBase' @@ -38624,34 +42260,68 @@ components: type: boolean required: - enabled - _common.mapping___FlattenedProperty: + _common.mapping___FieldType: + type: string + enum: + - aggregate_metric_double + - alias + - binary + - boolean + - byte + - completion + - constant_keyword + - date + - date_nanos + - date_range + - double + - double_range + - flat_object + - float + - float_range + - geo_point + - geo_shape + - half_float + - histogram + - icu_collation_keyword + - integer + - integer_range + - ip + - ip_range + - join + - keyword + - knn_vector + - long + - long_range + - match_only_text + - murmur3 + - nested + - object + - percolator + - rank_feature + - rank_features + - scaled_float + - search_as_you_type + - short + - text + - token_count + - unsigned_long + - version + - wildcard + - xy_point + - xy_shape + _common.mapping___FlatObjectProperty: allOf: - $ref: '#/components/schemas/_common.mapping___PropertyBase' - type: object properties: - boost: - type: number - format: double - depth_limit: - type: number - doc_values: - type: boolean - eager_global_ordinals: - type: boolean - index: + searchable: type: boolean - index_options: - $ref: '#/components/schemas/_common.mapping___IndexOptions' - null_value: - type: string - similarity: - type: string - split_queries_on_whitespace: + aggregatable: type: boolean type: type: string enum: - - flattened + - flat_object required: - type _common.mapping___FloatNumberProperty: @@ -38684,17 +42354,17 @@ components: - title: left type: string enum: + - left - LEFT - clockwise - cw - - left - title: right type: string enum: + - right - RIGHT - - ccw - counterclockwise - - right + - ccw _common.mapping___GeoPointProperty: allOf: - $ref: '#/components/schemas/_common.mapping___DocValuesPropertyBase' @@ -38770,6 +42440,43 @@ components: - histogram required: - type + _common.mapping___IcuCollationKeywordProperty: + allOf: + - $ref: '#/components/schemas/_common.mapping___DocValuesPropertyBase' + - type: object + properties: + type: + type: string + enum: + - icu_collation_keyword + index: + type: boolean + null_value: + type: string + alternate: + $ref: '#/components/schemas/_common.analysis___IcuCollationAlternate' + case_level: + type: boolean + case_first: + $ref: '#/components/schemas/_common.analysis___IcuCollationCaseFirst' + decomposition: + $ref: '#/components/schemas/_common.analysis___IcuCollationDecomposition' + hiragana_quaternary_mode: + type: boolean + numeric: + type: boolean + strength: + $ref: '#/components/schemas/_common.analysis___IcuCollationStrength' + variable_top: + type: string + country: + type: string + language: + type: string + variant: + type: string + required: + - type _common.mapping___IndexField: type: object properties: @@ -38822,13 +42529,6 @@ components: type: boolean null_value: type: string - on_script_error: - $ref: '#/components/schemas/_common.mapping___OnScriptError' - script: - $ref: '#/components/schemas/_common___Script' - time_series_dimension: - description: For internal use by OpenSearch only. Marks the field as a time series dimension. Defaults to false. - type: boolean type: type: string enum: @@ -38889,9 +42589,6 @@ components: type: string split_queries_on_whitespace: type: boolean - time_series_dimension: - description: For internal use by OpenSearch only. Marks the field as a time series dimension. Defaults to false. - type: boolean type: type: string enum: @@ -39033,15 +42730,6 @@ components: type: boolean index: type: boolean - on_script_error: - $ref: '#/components/schemas/_common.mapping___OnScriptError' - script: - $ref: '#/components/schemas/_common___Script' - time_series_metric: - $ref: '#/components/schemas/_common.mapping___TimeSeriesMetricType' - time_series_dimension: - description: For internal use by OpenSearch only. Marks the field as a time series dimension. Defaults to false. - type: boolean _common.mapping___ObjectProperty: allOf: - $ref: '#/components/schemas/_common.mapping___CorePropertyBase' @@ -39053,11 +42741,6 @@ components: type: string enum: - object - _common.mapping___OnScriptError: - type: string - enum: - - continue - - fail _common.mapping___PercolatorProperty: allOf: - $ref: '#/components/schemas/_common.mapping___PropertyBase' @@ -39073,6 +42756,7 @@ components: type: object discriminator: propertyName: type + x-default: object oneOf: - $ref: '#/components/schemas/_common.mapping___BinaryProperty' - $ref: '#/components/schemas/_common.mapping___BooleanProperty' @@ -39089,9 +42773,7 @@ components: - $ref: '#/components/schemas/_common.mapping___DateNanosProperty' - $ref: '#/components/schemas/_common.mapping___DateProperty' - $ref: '#/components/schemas/_common.mapping___AggregateMetricDoubleProperty' - - $ref: '#/components/schemas/_common.mapping___DenseVectorProperty' - - $ref: '#/components/schemas/_common.mapping___SparseVectorProperty' - - $ref: '#/components/schemas/_common.mapping___FlattenedProperty' + - $ref: '#/components/schemas/_common.mapping___FlatObjectProperty' - $ref: '#/components/schemas/_common.mapping___NestedProperty' - $ref: '#/components/schemas/_common.mapping___ObjectProperty' - $ref: '#/components/schemas/_common.mapping___CompletionProperty' @@ -39121,6 +42803,7 @@ components: - $ref: '#/components/schemas/_common.mapping___IpRangeProperty' - $ref: '#/components/schemas/_common.mapping___LongRangeProperty' - $ref: '#/components/schemas/_common.mapping___KnnVectorProperty' + - $ref: '#/components/schemas/_common.mapping___IcuCollationKeywordProperty' _common.mapping___PropertyBase: type: object properties: @@ -39265,17 +42948,6 @@ components: type: array items: type: string - _common.mapping___SparseVectorProperty: - allOf: - - $ref: '#/components/schemas/_common.mapping___PropertyBase' - - type: object - properties: - type: - type: string - enum: - - sparse_vector - required: - - type _common.mapping___SuggestContext: type: object properties: @@ -39352,14 +43024,6 @@ components: - text required: - type - _common.mapping___TimeSeriesMetricType: - type: string - enum: - - counter - - gauge - - histogram - - position - - summary _common.mapping___TokenCountProperty: allOf: - $ref: '#/components/schemas/_common.mapping___DocValuesPropertyBase' @@ -39540,8 +43204,8 @@ components: $ref: '#/components/schemas/_common.query_dsl___QueryContainer' adjust_pure_negative: description: |- - Ensures correct behavior when a query contains only must_not clauses. - By default set to true, OpenSearch adds a match-all clause to ensure results are returned from Lucene, with the must_not conditions applied as filters. + Ensures correct behavior when a query contains only `must_not` clauses. + By default set to true, OpenSearch adds a match-all clause to ensure results are returned from Lucene, with the `must_not` conditions applied as filters. If set to false, the query may return no results, as Lucene typically requires at least one positive condition. type: boolean default: true @@ -39591,7 +43255,7 @@ components: The `combined_fields` query analyzes the provided text before performing a search. type: string auto_generate_synonyms_phrase_query: - description: If true, match phrase queries are automatically created for multi-term synonyms. + description: If `true`, match phrase queries are automatically created for multi-term synonyms. type: boolean operator: $ref: '#/components/schemas/_common.query_dsl___CombinedFieldsOperator' @@ -39608,25 +43272,28 @@ components: - all - none _common.query_dsl___CommonTermsQuery: - allOf: - - $ref: '#/components/schemas/_common.query_dsl___QueryBase' - - type: object - properties: - analyzer: - type: string - cutoff_frequency: - type: number - format: float - high_freq_operator: - $ref: '#/components/schemas/_common.query_dsl___Operator' - low_freq_operator: - $ref: '#/components/schemas/_common.query_dsl___Operator' - minimum_should_match: - $ref: '#/components/schemas/_common___MinimumShouldMatch' - query: - type: string - required: - - query + oneOf: + - title: query + type: string + - allOf: + - $ref: '#/components/schemas/_common.query_dsl___QueryBase' + - type: object + properties: + analyzer: + type: string + cutoff_frequency: + type: number + format: float + high_freq_operator: + $ref: '#/components/schemas/_common.query_dsl___Operator' + low_freq_operator: + $ref: '#/components/schemas/_common.query_dsl___Operator' + minimum_should_match: + $ref: '#/components/schemas/_common___MinimumShouldMatch' + query: + type: string + required: + - query _common.query_dsl___ConstantScoreQuery: allOf: - $ref: '#/components/schemas/_common.query_dsl___QueryBase' @@ -39742,17 +43409,20 @@ components: required: - field _common.query_dsl___FieldAndFormat: - type: object - properties: - field: + oneOf: + - title: field $ref: '#/components/schemas/_common___Field' - format: - description: Format in which the values are returned. - type: string - include_unmapped: - type: boolean - required: - - field + - type: object + properties: + field: + $ref: '#/components/schemas/_common___Field' + format: + description: Format in which the values are returned. + type: string + include_unmapped: + type: boolean + required: + - field _common.query_dsl___FieldValueFactorModifier: type: string enum: @@ -39853,33 +43523,33 @@ components: score_mode: $ref: '#/components/schemas/_common.query_dsl___FunctionScoreMode' _common.query_dsl___FuzzyQuery: - allOf: - - $ref: '#/components/schemas/_common.query_dsl___QueryBase' - - type: object - properties: - max_expansions: - description: Maximum number of variations created. - type: integer - format: int32 - prefix_length: - description: Number of beginning characters left unchanged when creating expansions. - type: integer - format: int32 - rewrite: - $ref: '#/components/schemas/_common___MultiTermQueryRewrite' - transpositions: - description: Indicates whether edits include transpositions of two adjacent characters (for example `ab` to `ba`). - type: boolean - fuzziness: - $ref: '#/components/schemas/_common___Fuzziness' - value: - description: Term you wish to find in the provided field. - oneOf: - - type: string - - type: number - - type: boolean - required: - - value + oneOf: + - title: value + $ref: '#/components/schemas/_common___FieldValue' + - allOf: + - $ref: '#/components/schemas/_common.query_dsl___QueryBase' + - type: object + properties: + max_expansions: + description: Maximum number of variations created. + type: integer + format: int32 + prefix_length: + description: Number of beginning characters left unchanged when creating expansions. + type: integer + format: int32 + rewrite: + $ref: '#/components/schemas/_common___MultiTermQueryRewrite' + transpositions: + description: Indicates whether edits include transpositions of two adjacent characters (for example, `ab` to `ba`). + type: boolean + fuzziness: + $ref: '#/components/schemas/_common___Fuzziness' + value: + description: Term you wish to find in the provided field. + $ref: '#/components/schemas/_common___FieldValue' + required: + - value _common.query_dsl___GeoBoundingBoxQuery: allOf: - $ref: '#/components/schemas/_common.query_dsl___QueryBase' @@ -39973,6 +43643,7 @@ components: properties: ignore_unmapped: $ref: '#/components/schemas/_common.query_dsl___IgnoreUnmapped' + description: Indicates whether to ignore an unmapped `type` and not return any documents instead of an error. inner_hits: $ref: '#/components/schemas/_core.search___InnerHits' max_children: @@ -40003,6 +43674,9 @@ components: properties: ignore_unmapped: $ref: '#/components/schemas/_common.query_dsl___IgnoreUnmapped' + description: |- + Indicates whether to ignore an unmapped `parent_type` and not return any documents instead of an error. + You can use this parameter to query multiple indexes that may not contain the `parent_type`. inner_hits: $ref: '#/components/schemas/_core.search___InnerHits' parent_type: @@ -40015,6 +43689,15 @@ components: required: - parent_type - query + _common.query_dsl___HybridQuery: + allOf: + - $ref: '#/components/schemas/_common.query_dsl___QueryBase' + - type: object + properties: + queries: + type: array + items: + $ref: '#/components/schemas/_common.query_dsl___QueryContainer' _common.query_dsl___IdsQuery: allOf: - $ref: '#/components/schemas/_common.query_dsl___QueryBase' @@ -40195,22 +43878,59 @@ components: required: - pattern _common.query_dsl___KnnQuery: - type: object - additionalProperties: - $ref: '#/components/schemas/_common___KnnField' - minProperties: 1 - maxProperties: 1 + allOf: + - $ref: '#/components/schemas/_common.query_dsl___QueryBase' + - type: object + properties: + vector: + $ref: '#/components/schemas/_common.query_dsl___QueryVector' + k: + description: The total number of nearest neighbors to return as top hits. + type: integer + format: int32 + min_score: + description: The minimum similarity score required in order for a neighbor to be considered a hit. + type: number + format: float + x-version-added: '2.14' + max_distance: + description: The maximum physical vector space distance required in order for a neighbor to be considered a hit. + type: number + format: float + x-version-added: '2.14' + filter: + description: The filters for the k-NN search query. + oneOf: + - $ref: '#/components/schemas/_common.query_dsl___QueryContainer' + - type: array + items: + $ref: '#/components/schemas/_common.query_dsl___QueryContainer' + method_parameters: + type: object + x-version-added: '2.16' + additionalProperties: + type: integer + format: int32 + rescore: + type: object + x-version-added: '2.17' + additionalProperties: + type: number + format: float + required: + - vector _common.query_dsl___Like: description: Text that we want similar documents for or a lookup to a document's field for the text. oneOf: - - type: string - - $ref: '#/components/schemas/_common.query_dsl___LikeDocument' + - title: text + type: string + - title: document + $ref: '#/components/schemas/_common.query_dsl___LikeDocument' _common.query_dsl___LikeDocument: type: object properties: doc: description: A document not present in the index. - type: object fields: type: array items: @@ -40219,6 +43939,8 @@ components: $ref: '#/components/schemas/_common___Id' _index: $ref: '#/components/schemas/_common___IndexName' + _type: + $ref: '#/components/schemas/_common___Type' per_field_analyzer: type: object additionalProperties: @@ -40230,140 +43952,152 @@ components: version_type: $ref: '#/components/schemas/_common___VersionType' _common.query_dsl___MatchAllQuery: - $ref: '#/components/schemas/_common.query_dsl___QueryBase' - _common.query_dsl___MatchBoolPrefixQuery: allOf: - $ref: '#/components/schemas/_common.query_dsl___QueryBase' - type: object - properties: - analyzer: - description: Analyzer used to convert the text in the query value into tokens. - type: string - fuzziness: - $ref: '#/components/schemas/_common___Fuzziness' - fuzzy_rewrite: - $ref: '#/components/schemas/_common___MultiTermQueryRewrite' - fuzzy_transpositions: - description: |- - If `true`, edits for fuzzy matching include transpositions of two adjacent characters (for example, `ab` to `ba`). - Can be applied to the term subqueries constructed for all terms but the final term. - type: boolean - max_expansions: - description: |- - Maximum number of terms to which the query will expand. - Can be applied to the term subqueries constructed for all terms but the final term. - type: integer - format: int32 - minimum_should_match: - $ref: '#/components/schemas/_common___MinimumShouldMatch' - operator: - $ref: '#/components/schemas/_common.query_dsl___Operator' - prefix_length: - description: |- - Number of beginning characters left unchanged for fuzzy matching. - Can be applied to the term subqueries constructed for all terms but the final term. - type: integer - format: int32 - query: - description: |- - Terms you wish to find in the provided field. - The last term is used in a prefix query. - type: string - required: - - query + properties: {} + _common.query_dsl___MatchBoolPrefixQuery: + oneOf: + - title: query + type: string + - allOf: + - $ref: '#/components/schemas/_common.query_dsl___QueryBase' + - type: object + properties: + analyzer: + description: Analyzer used to convert the text in the query value into tokens. + type: string + fuzziness: + $ref: '#/components/schemas/_common___Fuzziness' + fuzzy_rewrite: + $ref: '#/components/schemas/_common___MultiTermQueryRewrite' + fuzzy_transpositions: + description: |- + If `true`, edits for fuzzy matching include transpositions of two adjacent characters (for example, `ab` to `ba`). + Can be applied to the term subqueries constructed for all terms but the final term. + type: boolean + max_expansions: + description: |- + Maximum number of terms to which the query will expand. + Can be applied to the term subqueries constructed for all terms but the final term. + type: integer + format: int32 + minimum_should_match: + $ref: '#/components/schemas/_common___MinimumShouldMatch' + operator: + $ref: '#/components/schemas/_common.query_dsl___Operator' + prefix_length: + description: |- + Number of beginning characters left unchanged for fuzzy matching. + Can be applied to the term subqueries constructed for all terms but the final term. + type: integer + format: int32 + query: + description: |- + Terms you wish to find in the provided field. + The last term is used in a prefix query. + type: string + required: + - query _common.query_dsl___MatchNoneQuery: allOf: - $ref: '#/components/schemas/_common.query_dsl___QueryBase' - type: object _common.query_dsl___MatchPhrasePrefixQuery: - allOf: - - $ref: '#/components/schemas/_common.query_dsl___QueryBase' - - type: object - properties: - analyzer: - description: Analyzer used to convert text in the query value into tokens. - type: string - max_expansions: - description: Maximum number of terms to which the last provided term of the query value will expand. - type: integer - format: int32 - query: - description: Text you wish to find in the provided field. - type: string - slop: - description: Maximum number of positions allowed between matching tokens. - type: integer - format: int32 - zero_terms_query: - $ref: '#/components/schemas/_common.query_dsl___ZeroTermsQuery' - required: - - query + oneOf: + - title: query + type: string + - allOf: + - $ref: '#/components/schemas/_common.query_dsl___QueryBase' + - type: object + properties: + analyzer: + description: Analyzer used to convert text in the query value into tokens. + type: string + max_expansions: + description: Maximum number of terms to which the last provided term of the query value will expand. + type: integer + format: int32 + query: + description: Text you wish to find in the provided field. + type: string + slop: + description: Maximum number of positions allowed between matching tokens. + type: integer + format: int32 + zero_terms_query: + $ref: '#/components/schemas/_common.query_dsl___ZeroTermsQuery' + required: + - query _common.query_dsl___MatchPhraseQuery: - allOf: - - $ref: '#/components/schemas/_common.query_dsl___QueryBase' - - type: object - properties: - analyzer: - description: Analyzer used to convert the text in the query value into tokens. - type: string - query: - description: Query terms that are analyzed and turned into a phrase query. - type: string - slop: - description: Maximum number of positions allowed between matching tokens. - type: integer - format: int32 - zero_terms_query: - $ref: '#/components/schemas/_common.query_dsl___ZeroTermsQuery' - required: - - query + oneOf: + - title: query + type: string + - allOf: + - $ref: '#/components/schemas/_common.query_dsl___QueryBase' + - type: object + properties: + analyzer: + description: Analyzer used to convert the text in the query value into tokens. + type: string + query: + description: Query terms that are analyzed and turned into a phrase query. + type: string + slop: + description: Maximum number of positions allowed between matching tokens. + type: integer + format: int32 + zero_terms_query: + $ref: '#/components/schemas/_common.query_dsl___ZeroTermsQuery' + required: + - query _common.query_dsl___MatchQuery: - allOf: - - $ref: '#/components/schemas/_common.query_dsl___QueryBase' - - type: object - properties: - analyzer: - description: Analyzer used to convert the text in the query value into tokens. - type: string - auto_generate_synonyms_phrase_query: - description: If `true`, match phrase queries are automatically created for multi-term synonyms. - type: boolean - cutoff_frequency: - deprecated: true - type: number - format: float - fuzziness: - $ref: '#/components/schemas/_common___Fuzziness' - fuzzy_rewrite: - $ref: '#/components/schemas/_common___MultiTermQueryRewrite' - fuzzy_transpositions: - description: If `true`, edits for fuzzy matching include transpositions of two adjacent characters (for example, `ab` to `ba`). - type: boolean - lenient: - description: If `true`, format-based errors, such as providing a text query value for a numeric field, are ignored. - type: boolean - max_expansions: - description: Maximum number of terms to which the query will expand. - type: integer - format: int32 - minimum_should_match: - $ref: '#/components/schemas/_common___MinimumShouldMatch' - operator: - $ref: '#/components/schemas/_common.query_dsl___Operator' - prefix_length: - description: Number of beginning characters left unchanged for fuzzy matching. - type: integer - format: int32 - query: - description: Text, number, boolean value or date you wish to find in the provided field. - oneOf: - - type: string - - type: number - - type: boolean - zero_terms_query: - $ref: '#/components/schemas/_common.query_dsl___ZeroTermsQuery' - required: - - query + oneOf: + - title: query + $ref: '#/components/schemas/_common___FieldValue' + - allOf: + - $ref: '#/components/schemas/_common.query_dsl___QueryBase' + - type: object + properties: + analyzer: + description: Analyzer used to convert the text in the query value into tokens. + type: string + auto_generate_synonyms_phrase_query: + description: If `true`, match phrase queries are automatically created for multi-term synonyms. + type: boolean + cutoff_frequency: + deprecated: true + type: number + format: float + fuzziness: + $ref: '#/components/schemas/_common___Fuzziness' + fuzzy_rewrite: + $ref: '#/components/schemas/_common___MultiTermQueryRewrite' + fuzzy_transpositions: + description: If `true`, edits for fuzzy matching include transpositions of two adjacent characters (for example, `ab` to `ba`). + type: boolean + lenient: + description: If `true`, format-based errors, such as providing a text query value for a numeric field, are ignored. + type: boolean + max_expansions: + description: Maximum number of terms to which the query will expand. + type: integer + format: int32 + minimum_should_match: + $ref: '#/components/schemas/_common___MinimumShouldMatch' + operator: + $ref: '#/components/schemas/_common.query_dsl___Operator' + prefix_length: + description: Number of beginning characters left unchanged for fuzzy matching. + type: integer + format: int32 + query: + description: Text, number, Boolean value or date you wish to find in the provided field. + $ref: '#/components/schemas/_common___FieldValue' + zero_terms_query: + $ref: '#/components/schemas/_common.query_dsl___ZeroTermsQuery' + required: + - query _common.query_dsl___MoreLikeThisQuery: allOf: - $ref: '#/components/schemas/_common.query_dsl___QueryBase' @@ -40493,7 +44227,7 @@ components: type: integer format: int32 query: - description: Text, number, boolean value or date you wish to find in the provided field. + description: Text, number, Boolean value or date you wish to find in the provided field. type: string slop: description: Maximum number of positions allowed between matching tokens. @@ -40523,6 +44257,7 @@ components: properties: ignore_unmapped: $ref: '#/components/schemas/_common.query_dsl___IgnoreUnmapped' + description: Indicates whether to ignore an unmapped path and not return any documents instead of an error. inner_hits: $ref: '#/components/schemas/_core.search___InnerHits' path: @@ -40538,28 +44273,24 @@ components: allOf: - $ref: '#/components/schemas/_common.query_dsl___QueryBase' - type: object - additionalProperties: - $ref: '#/components/schemas/_common.query_dsl___NeuralQueryVectorField' - _common.query_dsl___NeuralQueryVectorField: - type: object - properties: - query_text: - type: string - query_image: - type: string - contentEncoding: base64 - model_id: - type: string - k: - type: integer - min_score: - type: number - format: float - max_distance: - type: number - format: float - filter: - $ref: '#/components/schemas/_common.query_dsl___QueryContainer' + properties: + query_text: + type: string + query_image: + type: string + contentEncoding: base64 + model_id: + type: string + k: + type: integer + min_score: + type: number + format: float + max_distance: + type: number + format: float + filter: + $ref: '#/components/schemas/_common.query_dsl___QueryContainer' _common.query_dsl___NumberRangeQuery: allOf: - $ref: '#/components/schemas/_common.query_dsl___RangeQueryBase' @@ -40595,7 +44326,9 @@ components: type: string enum: - and + - AND - or + - OR _common.query_dsl___ParentIdQuery: allOf: - $ref: '#/components/schemas/_common.query_dsl___QueryBase' @@ -40605,6 +44338,7 @@ components: $ref: '#/components/schemas/_common___Id' ignore_unmapped: $ref: '#/components/schemas/_common.query_dsl___IgnoreUnmapped' + description: Indicates whether to ignore an unmapped `type` and not return any documents instead of an error. type: $ref: '#/components/schemas/_common___RelationName' _common.query_dsl___PercolateQuery: @@ -40614,12 +44348,10 @@ components: properties: document: description: The source of the document being percolated. - type: object documents: description: An array of sources of the documents being percolated. type: array - items: - type: object + items: {} field: $ref: '#/components/schemas/_common___Field' id: @@ -40677,22 +44409,25 @@ components: minProperties: 1 maxProperties: 1 _common.query_dsl___PrefixQuery: - allOf: - - $ref: '#/components/schemas/_common.query_dsl___QueryBase' - - type: object - properties: - rewrite: - $ref: '#/components/schemas/_common___MultiTermQueryRewrite' - value: - description: Beginning characters of terms you wish to find in the provided field. - type: string - case_insensitive: - description: |- - Allows ASCII case insensitive matching of the value with the indexed field values when set to `true`. - Default is `false` which means the case sensitivity of matching depends on the underlying field's mapping. - type: boolean - required: - - value + oneOf: + - title: value + type: string + - allOf: + - $ref: '#/components/schemas/_common.query_dsl___QueryBase' + - type: object + properties: + rewrite: + $ref: '#/components/schemas/_common___MultiTermQueryRewrite' + value: + description: Beginning characters of terms you wish to find in the provided field. + type: string + case_insensitive: + description: |- + Allows ASCII case insensitive matching of the value with the indexed field values when set to `true`. + Default is `false` which means the case sensitivity of matching depends on the underlying field's mapping. + type: boolean + required: + - value _common.query_dsl___QueryBase: type: object properties: @@ -40716,6 +44451,8 @@ components: common: deprecated: true type: object + propertyNames: + $ref: '#/components/schemas/_common___Field' additionalProperties: $ref: '#/components/schemas/_common.query_dsl___CommonTermsQuery' minProperties: 1 @@ -40735,6 +44472,8 @@ components: fuzzy: description: Returns documents that contain terms similar to the search term, as measured by a Levenshtein edit distance. type: object + propertyNames: + $ref: '#/components/schemas/_common___Field' additionalProperties: $ref: '#/components/schemas/_common.query_dsl___FuzzyQuery' minProperties: 1 @@ -40751,26 +44490,36 @@ components: $ref: '#/components/schemas/_common.query_dsl___HasChildQuery' has_parent: $ref: '#/components/schemas/_common.query_dsl___HasParentQuery' + hybrid: + $ref: '#/components/schemas/_common.query_dsl___HybridQuery' ids: $ref: '#/components/schemas/_common.query_dsl___IdsQuery' intervals: description: Returns documents based on the order and proximity of matching terms. type: object + propertyNames: + $ref: '#/components/schemas/_common___Field' additionalProperties: $ref: '#/components/schemas/_common.query_dsl___IntervalsQuery' minProperties: 1 maxProperties: 1 knn: - $ref: '#/components/schemas/_common.query_dsl___KnnQuery' + type: object + propertyNames: + $ref: '#/components/schemas/_common___Field' + additionalProperties: + $ref: '#/components/schemas/_common.query_dsl___KnnQuery' + minProperties: 1 + maxProperties: 1 match: description: |- - Returns documents that match a provided text, number, date or boolean value. + Returns documents that match a provided text, number, date or Boolean value. The provided text is analyzed before matching. type: object + propertyNames: + $ref: '#/components/schemas/_common___Field' additionalProperties: - anyOf: - - $ref: '#/components/schemas/_common.query_dsl___MatchQuery' - - {} + $ref: '#/components/schemas/_common.query_dsl___MatchQuery' minProperties: 1 maxProperties: 1 match_all: @@ -40781,6 +44530,8 @@ components: Each term except the last is used in a `term` query. The last term is used in a prefix query. type: object + propertyNames: + $ref: '#/components/schemas/_common___Field' additionalProperties: $ref: '#/components/schemas/_common.query_dsl___MatchBoolPrefixQuery' minProperties: 1 @@ -40790,6 +44541,8 @@ components: match_phrase: description: Analyzes the text and creates a phrase query out of the analyzed text. type: object + propertyNames: + $ref: '#/components/schemas/_common___Field' additionalProperties: $ref: '#/components/schemas/_common.query_dsl___MatchPhraseQuery' minProperties: 1 @@ -40799,6 +44552,8 @@ components: Returns documents that contain the words of a provided text, in the same order as provided. The last term of the provided text is treated as a prefix, matching any words that begin with that term. type: object + propertyNames: + $ref: '#/components/schemas/_common___Field' additionalProperties: $ref: '#/components/schemas/_common.query_dsl___MatchPhrasePrefixQuery' minProperties: 1 @@ -40810,7 +44565,13 @@ components: nested: $ref: '#/components/schemas/_common.query_dsl___NestedQuery' neural: - $ref: '#/components/schemas/_common.query_dsl___NeuralQuery' + type: object + propertyNames: + $ref: '#/components/schemas/_common___Field' + additionalProperties: + $ref: '#/components/schemas/_common.query_dsl___NeuralQuery' + minProperties: 1 + maxProperties: 1 parent_id: $ref: '#/components/schemas/_common.query_dsl___ParentIdQuery' percolate: @@ -40820,6 +44581,8 @@ components: prefix: description: Returns documents that contain a specific prefix in a provided field. type: object + propertyNames: + $ref: '#/components/schemas/_common___Field' additionalProperties: $ref: '#/components/schemas/_common.query_dsl___PrefixQuery' minProperties: 1 @@ -40829,6 +44592,8 @@ components: range: description: Returns documents that contain terms within a provided range. type: object + propertyNames: + $ref: '#/components/schemas/_common___Field' additionalProperties: $ref: '#/components/schemas/_common.query_dsl___RangeQuery' minProperties: 1 @@ -40838,12 +44603,12 @@ components: regexp: description: Returns documents that contain terms matching a regular expression. type: object + propertyNames: + $ref: '#/components/schemas/_common___Field' additionalProperties: $ref: '#/components/schemas/_common.query_dsl___RegexpQuery' minProperties: 1 maxProperties: 1 - rule_query: - $ref: '#/components/schemas/_common.query_dsl___RuleQuery' script: $ref: '#/components/schemas/_common.query_dsl___ScriptQuery' script_score: @@ -40867,6 +44632,8 @@ components: span_term: description: Matches spans containing a term. type: object + propertyNames: + $ref: '#/components/schemas/_common___Field' additionalProperties: $ref: '#/components/schemas/_common.query_dsl___SpanTermQuery' minProperties: 1 @@ -40876,44 +44643,35 @@ components: term: description: |- Returns documents that contain an exact term in a provided field. - To return a document, the query term must exactly match the queried field's value, including whitespace and capitalization. + To return a document, the query term must exactly match the queried field's value, including white space and capitalization. type: object + propertyNames: + $ref: '#/components/schemas/_common___Field' additionalProperties: - anyOf: - - $ref: '#/components/schemas/_common.query_dsl___TermQuery' - - $ref: '#/components/schemas/_common___FieldValue' + $ref: '#/components/schemas/_common.query_dsl___TermQuery' minProperties: 1 maxProperties: 1 terms: - $ref: '#/components/schemas/_common.query_dsl___TermsQueryField' + description: Returns documents that contain one or more exact terms in a provided field. + $ref: '#/components/schemas/_common.query_dsl___TermsQuery' terms_set: description: |- Returns documents that contain a minimum number of exact terms in a provided field. - To return a document, a required number of terms must exactly match the field values, including whitespace and capitalization. + To return a document, a required number of terms must exactly match the field values, including white space and capitalization. type: object + propertyNames: + $ref: '#/components/schemas/_common___Field' additionalProperties: $ref: '#/components/schemas/_common.query_dsl___TermsSetQuery' minProperties: 1 maxProperties: 1 - text_expansion: - description: Uses a natural language processing model to convert the query text into a list of token-weight pairs which are then used in a query against a sparse vector or rank features field. - type: object - additionalProperties: - $ref: '#/components/schemas/_common.query_dsl___TextExpansionQuery' - minProperties: 1 - maxProperties: 1 type: $ref: '#/components/schemas/_common.query_dsl___TypeQuery' - weighted_tokens: - description: Supports returning text_expansion query results by sending in precomputed tokens with the query. - type: object - additionalProperties: - $ref: '#/components/schemas/_common.query_dsl___WeightedTokensQuery' - minProperties: 1 - maxProperties: 1 wildcard: description: Returns documents that contain terms matching a wildcard pattern. type: object + propertyNames: + $ref: '#/components/schemas/_common___Field' additionalProperties: $ref: '#/components/schemas/_common.query_dsl___WildcardQuery' minProperties: 1 @@ -41008,6 +44766,11 @@ components: $ref: '#/components/schemas/_common.query_dsl___TextQueryType' required: - query + _common.query_dsl___QueryVector: + type: array + items: + type: number + format: float _common.query_dsl___RandomScoreFunction: type: object properties: @@ -41095,44 +44858,32 @@ components: required: - field _common.query_dsl___RegexpQuery: - allOf: - - $ref: '#/components/schemas/_common.query_dsl___QueryBase' - - type: object - properties: - case_insensitive: - description: |- - Allows case insensitive matching of the regular expression value with the indexed field values when set to `true`. - When `false`, case sensitivity of matching depends on the underlying field's mapping. - type: boolean - flags: - description: Enables optional operators for the regular expression. - type: string - max_determinized_states: - description: Maximum number of automaton states required for the query. - type: integer - format: int32 - rewrite: - $ref: '#/components/schemas/_common___MultiTermQueryRewrite' - value: - description: Regular expression for terms you wish to find in the provided field. - type: string - required: - - value - _common.query_dsl___RuleQuery: - allOf: - - $ref: '#/components/schemas/_common.query_dsl___QueryBase' - - type: object - properties: - organic: - $ref: '#/components/schemas/_common.query_dsl___QueryContainer' - ruleset_id: - $ref: '#/components/schemas/_common___Id' - match_criteria: - type: object - required: - - match_criteria - - organic - - ruleset_id + oneOf: + - title: value + type: string + - allOf: + - $ref: '#/components/schemas/_common.query_dsl___QueryBase' + - type: object + properties: + case_insensitive: + description: |- + Allows case insensitive matching of the regular expression value with the indexed field values when set to `true`. + When `false`, case sensitivity of matching depends on the underlying field's mapping. + type: boolean + flags: + description: Enables optional operators for the regular expression. + type: string + max_determinized_states: + description: Maximum number of automaton states required for the query. + type: integer + format: int32 + rewrite: + $ref: '#/components/schemas/_common___MultiTermQueryRewrite' + value: + description: Regular expression for terms you wish to find in the provided field. + type: string + required: + - value _common.query_dsl___ScriptQuery: allOf: - $ref: '#/components/schemas/_common.query_dsl___QueryBase' @@ -41182,9 +44933,12 @@ components: - SLOP - WHITESPACE _common.query_dsl___SimpleQueryStringFlags: - description: Query flags can be either a single flag or a combination of flags, e.g. `OR|AND|PREFIX`. - allOf: - - $ref: '#/components/schemas/_common___PipeSeparatedFlagsSimpleQueryStringFlag' + description: Query flags can be either a single flag or a combination of flags (e.g. `OR|AND|PREFIX`). + oneOf: + - title: single + $ref: '#/components/schemas/_common.query_dsl___SimpleQueryStringFlag' + - title: multiple + type: string _common.query_dsl___SimpleQueryStringQuery: allOf: - $ref: '#/components/schemas/_common.query_dsl___QueryBase' @@ -41197,7 +44951,7 @@ components: description: If `true`, the query attempts to analyze wildcard terms in the query string. type: boolean auto_generate_synonyms_phrase_query: - description: If `true`, the parser creates a match_phrase query for each multi-position token. + description: If `true`, the parser creates a `match_phrase` query for each multi-position token. type: boolean default_operator: $ref: '#/components/schemas/_common.query_dsl___Operator' @@ -41275,7 +45029,7 @@ components: - end - match _common.query_dsl___SpanGapQuery: - description: Can only be used as a clause in a span_near query. + description: Can only be used as a clause in a `span_near` query. type: object additionalProperties: type: integer @@ -41379,14 +45133,17 @@ components: minProperties: 1 maxProperties: 1 _common.query_dsl___SpanTermQuery: - allOf: - - $ref: '#/components/schemas/_common.query_dsl___QueryBase' - - type: object - properties: - value: - type: string - required: - - value + oneOf: + - title: value + type: string + - allOf: + - $ref: '#/components/schemas/_common.query_dsl___QueryBase' + - type: object + properties: + value: + type: string + required: + - value _common.query_dsl___SpanWithinQuery: allOf: - $ref: '#/components/schemas/_common.query_dsl___QueryBase' @@ -41400,20 +45157,23 @@ components: - big - little _common.query_dsl___TermQuery: - allOf: - - $ref: '#/components/schemas/_common.query_dsl___QueryBase' - - type: object - properties: - value: - $ref: '#/components/schemas/_common___FieldValue' - case_insensitive: - description: |- - Allows ASCII case insensitive matching of the value with the indexed field values when set to `true`. - When `false`, the case sensitivity of matching depends on the underlying field's mapping. - type: boolean - required: - - value - _common.query_dsl___TermsLookupField: + oneOf: + - title: value + $ref: '#/components/schemas/_common___FieldValue' + - allOf: + - $ref: '#/components/schemas/_common.query_dsl___QueryBase' + - type: object + properties: + value: + $ref: '#/components/schemas/_common___FieldValue' + case_insensitive: + description: |- + Allows ASCII case insensitive matching of the value with the indexed field values when set to `true`. + When `false`, the case sensitivity of matching depends on the underlying field's mapping. + type: boolean + required: + - value + _common.query_dsl___TermsLookup: type: object properties: index: @@ -41424,22 +45184,24 @@ components: $ref: '#/components/schemas/_common___Field' routing: $ref: '#/components/schemas/_common___Routing' + _common.query_dsl___TermsQuery: + allOf: + - $ref: '#/components/schemas/_common.query_dsl___QueryBase' + - type: object + properties: + _name: {} + boost: {} + additionalProperties: + $ref: '#/components/schemas/_common.query_dsl___TermsQueryField' + minProperties: 1 _common.query_dsl___TermsQueryField: - type: object - properties: - boost: - description: |- - A floating-point value that specifies the weight of this field toward the relevance score. - Values above 1.0 increase the field’s relevance. Values between 0.0 and 1.0 decrease the field’s relevance. - Default is 1.0. - type: number - format: float - additionalProperties: - oneOf: - - $ref: '#/components/schemas/_common.query_dsl___TermsLookupField' - - type: array - items: - type: string + oneOf: + - title: value + type: array + items: + $ref: '#/components/schemas/_common___FieldValue' + - title: lookup + $ref: '#/components/schemas/_common.query_dsl___TermsLookup' _common.query_dsl___TermsSetQuery: allOf: - $ref: '#/components/schemas/_common.query_dsl___QueryBase' @@ -41455,22 +45217,6 @@ components: type: string required: - terms - _common.query_dsl___TextExpansionQuery: - allOf: - - $ref: '#/components/schemas/_common.query_dsl___QueryBase' - - type: object - properties: - model_id: - description: The text expansion NLP model to use - type: string - model_text: - description: The query text - type: string - pruning_config: - $ref: '#/components/schemas/_common.query_dsl___TokenPruningConfig' - required: - - model_id - - model_text _common.query_dsl___TextQueryType: type: string enum: @@ -41480,18 +45226,6 @@ components: - most_fields - phrase - phrase_prefix - _common.query_dsl___TokenPruningConfig: - type: object - properties: - tokens_freq_ratio_threshold: - description: Tokens whose frequency is more than this threshold times the average frequency of all tokens in the specified field are considered outliers and pruned. - type: number - tokens_weight_threshold: - description: Tokens whose weight is less than this threshold are considered nonsignificant and pruned. - type: number - only_score_pruned_tokens: - description: Whether to only score pruned tokens, vs only scoring kept tokens. - type: boolean _common.query_dsl___TypeQuery: allOf: - $ref: '#/components/schemas/_common.query_dsl___QueryBase' @@ -41501,36 +45235,25 @@ components: type: string required: - value - _common.query_dsl___WeightedTokensQuery: - allOf: - - $ref: '#/components/schemas/_common.query_dsl___QueryBase' - - type: object - properties: - tokens: - description: The tokens representing this query - type: object - additionalProperties: - type: number - pruning_config: - $ref: '#/components/schemas/_common.query_dsl___TokenPruningConfig' - required: - - tokens _common.query_dsl___WildcardQuery: - allOf: - - $ref: '#/components/schemas/_common.query_dsl___QueryBase' - - type: object - properties: - case_insensitive: - description: Allows case insensitive matching of the pattern with the indexed field values when set to `true`. Default is `false` which means the case sensitivity of matching depends on the underlying field's mapping. - type: boolean - rewrite: - $ref: '#/components/schemas/_common___MultiTermQueryRewrite' - value: - description: Wildcard pattern for terms you wish to find in the provided field. Required, when wildcard is not set. - type: string - wildcard: - description: Wildcard pattern for terms you wish to find in the provided field. Required, when value is not set. - type: string + oneOf: + - title: value + type: string + - allOf: + - $ref: '#/components/schemas/_common.query_dsl___QueryBase' + - type: object + properties: + case_insensitive: + description: Allows case insensitive matching of the pattern with the indexed field values when set to `true`. Default is `false` which means the case sensitivity of matching depends on the underlying field's mapping. + type: boolean + rewrite: + $ref: '#/components/schemas/_common___MultiTermQueryRewrite' + value: + description: Wildcard pattern for terms you wish to find in the provided field. Required, when wildcard is not set. + type: string + wildcard: + description: Wildcard pattern for terms you wish to find in the provided field. Required, when value is not set. + type: string _common.query_dsl___WrapperQuery: allOf: - $ref: '#/components/schemas/_common.query_dsl___QueryBase' @@ -41573,46 +45296,6 @@ components: enum: - all - none - _core._common___DeletedPit: - type: object - properties: - successful: - type: boolean - pit_id: - type: string - _core._common___PitDetail: - type: object - properties: - pit_id: - type: string - creation_time: - type: integer - format: int64 - keep_alive: - type: integer - format: int64 - _core._common___PitsDetailsDeleteAll: - type: object - properties: - successful: - type: boolean - pit_id: - type: string - _core._common___ShardStatistics: - type: object - properties: - total: - type: integer - format: int32 - successful: - type: integer - format: int32 - skipped: - type: integer - format: int32 - failed: - type: integer - format: int32 _core.bulk___CreateOperation: $ref: '#/components/schemas/_core.bulk___WriteOperation' _core.bulk___DeleteOperation: @@ -41700,14 +45383,14 @@ components: properties: detect_noop: description: |- - When `false` disables the setting 'result' in the response - to 'noop' if no change to the document occurred. + When `false` disables the setting `result` in the response + to `noop` if no change to the document occurred. type: boolean doc: description: A partial update to an existing document. type: object doc_as_upsert: - description: When `true`, uses the contents of 'doc' as the value of 'upsert'. + description: When `true`, uses the contents of `doc` as the value of `upsert`. type: boolean script: $ref: '#/components/schemas/_common___Script' @@ -41718,8 +45401,8 @@ components: $ref: '#/components/schemas/_core.search___SourceConfig' upsert: description: |- - If the document does not already exist, the contents of 'upsert' are inserted as a - new document. If the document exists, the 'script' is executed. + If the document does not already exist, the contents of `upsert` are inserted as a + new document. If the document exists, the `script` is executed. type: object _core.bulk___UpdateOperation: allOf: @@ -41787,7 +45470,7 @@ components: items: $ref: '#/components/schemas/_core.explain___ExplanationDetail' value: - oneOf: + anyOf: - type: integer format: int32 - type: integer @@ -41808,7 +45491,11 @@ components: indices: $ref: '#/components/schemas/_common___Indices' meta: - $ref: '#/components/schemas/_common___Metadata' + type: object + additionalProperties: + type: array + items: + type: string non_aggregatable_indices: $ref: '#/components/schemas/_common___Indices' non_searchable_indices: @@ -41821,25 +45508,6 @@ components: metadata_field: description: Whether this field is registered as a metadata field. type: boolean - time_series_dimension: - description: Whether this field is used as a time series dimension. - type: boolean - time_series_metric: - $ref: '#/components/schemas/_common.mapping___TimeSeriesMetricType' - non_dimension_indices: - description: |- - If this list is present in the response, then indexes not contained in the list have the - field marked as a dimension. Any indexes contained in the list are not marked as a dimension. - type: array - items: - $ref: '#/components/schemas/_common___IndexName' - metric_conflicts_indices: - description: |- - The list of indexes in which this field is present if the indexes - don't have the same `time_series_metric` value for the field. - type: array - items: - $ref: '#/components/schemas/_common___IndexName' required: - aggregatable - searchable @@ -41977,13 +45645,15 @@ components: The value is the variable value. type: object additionalProperties: - type: object + oneOf: + - type: string + - type: object profile: description: When `true`, provides a profile for the query execution. type: boolean source: description: |- - An inline search template that supports the same parameters as the Search API's + An inline search template that supports the same parameters as the Search API request body and Mustache variables. If no `id` is specified, this parameter is required. type: string @@ -42016,7 +45686,7 @@ components: items: $ref: '#/components/schemas/_common.query_dsl___FieldAndFormat' knn: - description: Defines the approximate kNN search to run. + description: Defines the approximate k-NN search to run. oneOf: - $ref: '#/components/schemas/_common.query_dsl___KnnQuery' - type: array @@ -42174,7 +45844,6 @@ components: $ref: '#/components/schemas/_common___IndexName' doc: description: An artificial document for which you want to retrieve term vectors. - type: object fields: $ref: '#/components/schemas/_common___Fields' field_statistics: @@ -42212,7 +45881,8 @@ components: _version: $ref: '#/components/schemas/_common___VersionNumber' took: - type: number + type: integer + format: int64 found: type: boolean term_vectors: @@ -42221,9 +45891,29 @@ components: $ref: '#/components/schemas/_core.termvectors___TermVector' error: $ref: '#/components/schemas/_common___ErrorCause' + _type: + $ref: '#/components/schemas/_common___Type' required: - _id - _index + _core.pit___DeletedPit: + type: object + properties: + successful: + type: boolean + pit_id: + type: string + _core.pit___PitDetail: + type: object + properties: + pit_id: + type: string + creation_time: + type: integer + format: int64 + keep_alive: + type: integer + format: int64 _core.rank_eval___DocumentRating: type: object properties: @@ -42233,7 +45923,8 @@ components: $ref: '#/components/schemas/_common___IndexName' rating: description: The document's relevance with regard to the specified search request. - type: number + type: integer + format: int32 required: - _id - _index @@ -42247,6 +45938,9 @@ components: $ref: '#/components/schemas/_common___IndexName' _score: type: number + format: double + _type: + $ref: '#/components/schemas/_common___Type' required: - _id - _index @@ -42257,10 +45951,8 @@ components: hit: $ref: '#/components/schemas/_core.rank_eval___RankEvalHit' rating: - type: - - 'null' - - number - - string + type: integer + format: int32 required: - hit _core.rank_eval___RankEvalMetric: @@ -42281,13 +45973,15 @@ components: properties: k: description: Sets the maximum number of documents retrieved per query. This value replaces the `size` parameter in the query. - type: number + type: integer + format: int32 _core.rank_eval___RankEvalMetricDetail: type: object properties: metric_score: description: The `metric_score`, found in the `metric_details` section, shows the contribution of this query to the global quality metric score. type: number + format: double unrated_docs: description: The `unrated_docs` section contains an `_index` and `_id` entry for each document that didn't have a `ratings` value. This can be used to ask the user to supply ratings for these documents. type: array @@ -42303,8 +45997,7 @@ components: type: object additionalProperties: type: object - additionalProperties: - type: object + additionalProperties: true required: - hits - metric_details @@ -42325,7 +46018,8 @@ components: properties: maximum_relevance: description: The highest relevance grade used in user-supplied relevance judgments. - type: number + type: integer + format: int32 required: - maximum_relevance _core.rank_eval___RankEvalMetricMeanReciprocalRank: @@ -42347,7 +46041,8 @@ components: properties: relevant_rating_threshold: description: Sets the rating threshold above which documents are considered to be relevant. - type: number + type: integer + format: int32 _core.rank_eval___RankEvalMetricRecall: allOf: - $ref: '#/components/schemas/_core.rank_eval___RankEvalMetricRatingThreshold' @@ -42358,7 +46053,8 @@ components: query: $ref: '#/components/schemas/_common.query_dsl___QueryContainer' size: - type: number + type: integer + format: int32 required: - query _core.rank_eval___RankEvalRequestItem: @@ -42378,8 +46074,7 @@ components: params: description: The search template parameters. type: object - additionalProperties: - type: object + additionalProperties: true required: - id - ratings @@ -42409,19 +46104,24 @@ components: properties: batches: description: The number of scroll responses shown by the reindex. - type: number + type: integer + format: int64 created: description: The number of documents that were successfully created. - type: number + type: integer + format: int64 deleted: description: The number of documents that were successfully deleted. - type: number + type: integer + format: int64 noops: description: The number of documents that were ignored because the script used for the reindex operation returned a `noop` value for `ctx.op`. - type: number + type: integer + format: int64 requests_per_second: description: The number of successful requests per second during the reindex operation. type: number + format: float retries: $ref: '#/components/schemas/_common___Retries' throttled: @@ -42434,13 +46134,16 @@ components: $ref: '#/components/schemas/_common___DurationValueUnitMillis' total: description: The number of documents that were successfully processed. - type: number + type: integer + format: int64 updated: description: The number of documents that were successfully updated. - type: number + type: integer + format: int64 version_conflicts: description: The number of version conflicts that reindex hits. - type: number + type: integer + format: int64 required: - batches - created @@ -42460,12 +46163,17 @@ components: type: string cancellable: type: boolean + cancelled: + type: boolean description: type: string id: - type: number + type: integer + format: int64 node: $ref: '#/components/schemas/_common___Name' + resource_stats: + $ref: '#/components/schemas/_common___ResourceStats' running_time_in_nanos: $ref: '#/components/schemas/_common___DurationValueUnitNanos' start_time_in_millis: @@ -42536,7 +46244,8 @@ components: description: |- The number of documents to index per batch. Use the `size` setting when indexing from a remote cluster. This ensures that batches fit in the on-heap buffer. The buffer defaults to a maximum size of `100MB`. - type: number + type: integer + format: int32 slice: $ref: '#/components/schemas/_common___SlicedScroll' sort: @@ -42558,7 +46267,6 @@ components: required: - document - index - - query _core.search_shards___ShardStoreIndex: type: object properties: @@ -42743,11 +46451,14 @@ components: - sentence - word _core.search___BuiltinHighlighterType: - type: string - enum: - - fvh - - plain - - unified + oneOf: + - type: string + const: plain + - title: fast_vector + type: string + const: fvh + - type: string + const: unified _core.search___Collector: type: object properties: @@ -42927,6 +46638,9 @@ components: type: boolean fragmenter: $ref: '#/components/schemas/_core.search___HighlighterFragmenter' + fragment_offset: + type: integer + format: int32 fragment_size: description: The size of the highlighted fragment in characters. type: integer @@ -42938,11 +46652,11 @@ components: max_fragment_length: type: integer format: int32 - max_analyzed_offset: + max_analyzer_offset: description: |- If set to a non-negative value, highlighting stops at this defined maximum limit. The rest of the text is not processed or highlighted, and no error is returned. - The `max_analyzed_offset` query setting does not override the `index.highlight.max_analyzed_offset` setting, which takes precedence when it is set to a lower value than the query setting. + The `max_analyzer_offset` query setting does not override the `index.highlight.max_analyzed_offset` setting, which takes precedence when it is set to a lower value than the query setting. type: integer format: int32 no_match_size: @@ -43022,9 +46736,6 @@ components: - $ref: '#/components/schemas/_core.search___HighlightBase' - type: object properties: - fragment_offset: - type: integer - format: int32 matched_fields: $ref: '#/components/schemas/_common___Fields' analyzer: @@ -43047,8 +46758,7 @@ components: $ref: '#/components/schemas/_core.explain___Explanation' fields: type: object - additionalProperties: - type: object + additionalProperties: true highlight: type: object additionalProperties: @@ -43152,7 +46862,7 @@ components: $ref: '#/components/schemas/_common___Sort' _source: $ref: '#/components/schemas/_core.search___SourceConfig' - stored_field: + stored_fields: $ref: '#/components/schemas/_common___Fields' track_scores: type: boolean @@ -43447,10 +47157,6 @@ components: oneOf: - title: fetch type: boolean - - title: includes - type: array - items: - $ref: '#/components/schemas/_common___Field' - title: filter $ref: '#/components/schemas/_core.search___SourceFilter' _core.search___SourceConfigParam: @@ -43458,15 +47164,20 @@ components: Defines how to fetch a source. Fetching can be disabled entirely, or the source can be filtered. Use this setting with the `_source_includes` and `_source_excludes` parameters. oneOf: - - type: boolean - - $ref: '#/components/schemas/_common___Fields' - _core.search___SourceFilter: - type: object - properties: - excludes: + - title: fetch + type: boolean + - title: fields $ref: '#/components/schemas/_common___Fields' - includes: + _core.search___SourceFilter: + oneOf: + - title: includes $ref: '#/components/schemas/_common___Fields' + - type: object + properties: + excludes: + $ref: '#/components/schemas/_common___Fields' + includes: + $ref: '#/components/schemas/_common___Fields' _core.search___Suggest: oneOf: - $ref: '#/components/schemas/_core.search___CompletionSuggest' @@ -43555,11 +47266,14 @@ components: type: object properties: doc_count: - type: number + type: integer + format: int32 sum_doc_freq: - type: number + type: integer + format: int64 sum_ttf: - type: number + type: integer + format: int64 required: - doc_count - sum_doc_freq @@ -43571,44 +47285,59 @@ components: description: |- Ignores words that appear in more than the specified number of documents. Default is `unbounded`. - type: number + type: integer + format: int32 max_num_terms: description: The maximum number of terms that should be returned per field. - type: number + type: integer + format: int32 max_term_freq: description: |- Ignore words with more than this frequency in the source doc. Default is `unbounded`. - type: number + type: integer + format: int32 max_word_length: description: |- - The maximum word length above which words will be ignored. + The maximum word length. + Words longer than this value will be ignored. Default is `unbounded`. - type: number + type: integer + format: int32 min_doc_freq: description: Ignore terms which do not occur in at least this many docs. - type: number + type: integer + format: int32 min_term_freq: description: Ignore words with less than this frequency in the source doc. - type: number + type: integer + format: int32 min_word_length: - description: The minimum word length below which words will be ignored. - type: number + description: |- + The minimum word length. + Words shorter than this value will be ignored. + Default is 0. + type: integer + format: int32 _core.termvectors___Term: type: object properties: doc_freq: - type: number + type: integer + format: int32 score: type: number + format: double term_freq: - type: number + type: integer + format: int32 tokens: type: array items: $ref: '#/components/schemas/_core.termvectors___Token' ttf: - type: number + type: integer + format: int32 required: - term_freq _core.termvectors___TermVector: @@ -43621,19 +47350,21 @@ components: additionalProperties: $ref: '#/components/schemas/_core.termvectors___Term' required: - - field_statistics - terms _core.termvectors___Token: type: object properties: end_offset: - type: number + type: integer + format: int32 payload: type: string position: - type: number + type: integer + format: int32 start_offset: - type: number + type: integer + format: int32 required: - position _core.update_by_query_rethrottle___UpdateByQueryRethrottleNode: @@ -43706,7 +47437,7 @@ components: collapse: $ref: '#/components/schemas/_core.search___FieldCollapse' explain: - description: If true, returns detailed information about score computation as part of a hit. + description: If `true`, returns detailed information about score computation as part of a hit. type: boolean ext: description: Configuration of search extensions defined by OpenSearch plugins. @@ -43725,7 +47456,7 @@ components: track_total_hits: $ref: '#/components/schemas/_core.search___TrackHits' indices_boost: - description: Boosts the _score of documents from specified indices. + description: Boosts the `_score` of documents from specified indexes. type: array items: type: object @@ -43790,7 +47521,7 @@ components: Use with caution. OpenSearch applies this parameter to each shard handling the request. When possible, let OpenSearch perform early termination automatically. - Avoid specifying this parameter for requests that target data streams with backing indices across multiple data tiers. + Avoid specifying this parameter for requests that target data streams with backing indexes across multiple data tiers. If set to `0` (default), the query does not terminate early. type: integer format: int32 @@ -43801,10 +47532,10 @@ components: Defaults to no timeout. type: string track_scores: - description: If true, calculate and return document scores, even if the scores are not used for sorting. + description: If `true`, calculate and return document scores, even if the scores are not used for sorting. type: boolean version: - description: If true, returns document version as part of a hit. + description: If `true`, returns document version as part of a hit. type: boolean seq_no_primary_term: description: If `true`, returns sequence number and primary term of the last modification of each hit. @@ -43817,7 +47548,7 @@ components: description: |- Stats groups to associate with the search. Each group maintains a statistics aggregation for its associated searches. - You can retrieve these stats using the indices stats API. + You can retrieve these stats using the indexes stats API. type: array items: type: string @@ -43833,90 +47564,6 @@ components: type: object additionalProperties: $ref: '#/components/schemas/asynchronous_search._common___NodesStats' - cat._common___CatPitSegmentsRecord: - type: object - properties: - index: - type: string - shard: - type: string - prirep: - type: string - ip: - type: string - segment: - type: string - generation: - type: string - docs.count: - type: string - docs.deleted: - type: string - size: - type: string - size.memory: - type: string - committed: - type: string - searchable: - type: string - version: - type: string - compound: - type: string - cat._common___CatSegmentReplicationRecord: - type: object - properties: - shardId: - type: string - target_node: - type: string - target_host: - type: string - checkpoints_behind: - type: string - bytes_behind: - type: string - current_lag: - type: string - last_completed_lag: - type: string - rejected_requests: - type: string - stage: - type: string - time: - type: string - files_fetched: - type: string - files_percent: - $ref: '#/components/schemas/_common___PercentageString' - bytes_fetched: - type: string - bytes_percent: - $ref: '#/components/schemas/_common___PercentageString' - start_time: - type: string - stop_time: - type: string - files: - type: string - files_total: - type: string - bytes: - type: string - bytes_total: - type: string - replicating_stage_time_taken: - type: string - get_checkpoint_info_stage_time_taken: - type: string - file_diff_stage_time_taken: - type: string - get_files_stage_time_taken: - type: string - finalize_replication_stage_time_taken: - type: string cat.aliases___AliasesRecord: type: object properties: @@ -43997,10 +47644,10 @@ components: description: node id type: string host: - description: host name + description: hostname type: string ip: - description: ip address + description: IP address type: string node: description: node name @@ -44022,10 +47669,10 @@ components: description: node id type: string host: - description: host name + description: hostname type: string ip: - description: ip address + description: IP address type: string node: description: node name @@ -44077,6 +47724,7 @@ components: description: wait time of longest task pending type: string active_shards_percent: + description: active number of shards in percent $ref: '#/components/schemas/_common___PercentageString' discovered_cluster_manager: description: cluster manager is discovered or not @@ -44098,7 +47746,7 @@ components: description: index name type: string uuid: - description: index uuid + description: index UUID type: string pri: description: number of primary shards @@ -44123,7 +47771,7 @@ components: description: index creation date (as string) type: string store.size: - description: store size of primaries & replicas + description: store size of primaries and replicas type: - 'null' - string @@ -44143,22 +47791,22 @@ components: - 'null' - string fielddata.memory_size: - description: used fielddata cache + description: used field data cache type: - 'null' - string pri.fielddata.memory_size: - description: used fielddata cache + description: used field data cache type: - 'null' - string fielddata.evictions: - description: fielddata evictions + description: field data evictions type: - 'null' - string pri.fielddata.evictions: - description: fielddata evictions + description: field data evictions type: - 'null' - string @@ -44699,12 +48347,12 @@ components: - 'null' - string segments.fixed_bitset_memory: - description: memory used by fixed bit sets for nested object field types and export type filters for types referred in _parent fields + description: memory used by fixed bit sets for nested object field types and export type filters for types referred in `_parent` fields type: - 'null' - string pri.segments.fixed_bitset_memory: - description: memory used by fixed bit sets for nested object field types and export type filters for types referred in _parent fields + description: memory used by fixed bit sets for nested object field types and export type filters for types referred in `_parent` fields type: - 'null' - string @@ -44784,10 +48432,10 @@ components: description: node id type: string host: - description: host name + description: hostname type: string ip: - description: ip address + description: IP address type: string node: description: node name @@ -44805,7 +48453,7 @@ components: description: The process identifier. type: string host: - description: The host name. + description: The hostname. type: string ip: description: The IP address. @@ -44914,21 +48562,21 @@ components: type: string master: description: |- - Indicates whether the node is the elected master node. - Returned values include `*`(elected master) and `-`(not elected master). + Indicates whether the node is the elected cluster-manager node. + Returned values include `*`(elected cluster manager) and `-`(not elected cluster manager). type: string x-version-deprecated: '2.0' - x-deprecation-message: To promote inclusive language, use 'cluster_manager' instead. + x-deprecation-message: To promote inclusive language, use `cluster_manager` instead. name: $ref: '#/components/schemas/_common___Name' completion.size: description: The size of completion. type: string fielddata.memory_size: - description: The used fielddata cache. + description: The used field data cache. type: string fielddata.evictions: - description: The fielddata evictions. + description: The field data evictions. type: string query_cache.memory_size: description: The used query cache. @@ -45104,7 +48752,7 @@ components: description: The memory used by the version map. type: string segments.fixed_bitset_memory: - description: The memory used by fixed bit sets for nested object field types and export type filters for types referred in _parent fields. + description: The memory used by fixed bit sets for nested object field types and export type filters for types referred in `_parent` fields. type: string suggest.current: description: The number of current suggest operations. @@ -45244,6 +48892,59 @@ components: type: description: The repository type. type: string + cat.segment_replication___SegmentReplicationRecord: + type: object + properties: + shardId: + type: string + target_node: + type: string + target_host: + type: string + checkpoints_behind: + type: string + bytes_behind: + type: string + current_lag: + type: string + last_completed_lag: + type: string + rejected_requests: + type: string + stage: + type: string + time: + type: string + files_fetched: + type: string + files_percent: + $ref: '#/components/schemas/_common___PercentageString' + bytes_fetched: + type: string + bytes_percent: + $ref: '#/components/schemas/_common___PercentageString' + start_time: + type: string + stop_time: + type: string + files: + type: string + files_total: + type: string + bytes: + type: string + bytes_total: + type: string + replicating_stage_time_taken: + type: string + get_checkpoint_info_stage_time_taken: + type: string + file_diff_stage_time_taken: + type: string + get_files_stage_time_taken: + type: string + finalize_replication_stage_time_taken: + type: string cat.segments___SegmentsRecord: type: object properties: @@ -45407,12 +49108,12 @@ components: - 'null' - string fielddata.memory_size: - description: The used fielddata cache memory. + description: The used field data cache memory. type: - 'null' - string fielddata.evictions: - description: The fielddata cache evictions. + description: The field data cache evictions. type: - 'null' - string @@ -45764,7 +49465,7 @@ components: start_epoch: $ref: '#/components/schemas/_common___StringifiedEpochTimeUnitSeconds' start_time: - $ref: '#/components/schemas/_common___ScheduleTimeOfDay' + $ref: '#/components/schemas/_common___TimeOfDay' end_epoch: $ref: '#/components/schemas/_common___StringifiedEpochTimeUnitSeconds' end_time: @@ -45772,7 +49473,7 @@ components: duration: $ref: '#/components/schemas/_common___Duration' indices: - description: The number of indices in the snapshot. + description: The number of indexes in the snapshot. type: string successful_shards: description: The number of successful shards in the snapshot. @@ -45867,7 +49568,7 @@ components: description: The process identifier. type: string host: - description: The host name for the current node. + description: The hostname for the current node. type: string ip: description: The IP address for the current node. @@ -46050,7 +49751,8 @@ components: transport_address: $ref: '#/components/schemas/_common___TransportAddress' weight_ranking: - type: number + type: integer + format: int32 required: - attributes - id @@ -46118,7 +49820,8 @@ components: transport_address: $ref: '#/components/schemas/_common___TransportAddress' weight_ranking: - type: number + type: integer + format: int32 required: - deciders - node_attributes @@ -46147,7 +49850,8 @@ components: path: type: string total: - type: number + type: integer + format: int64 shards: type: array items: @@ -46169,7 +49873,8 @@ components: details: type: string failed_allocation_attempts: - type: number + type: integer + format: int32 delayed: type: boolean allocation_status: @@ -46213,26 +49918,34 @@ components: x-version-added: '2.5' properties: active_shards: - type: number + type: integer + format: int32 initializing_shards: - type: number + type: integer + format: int32 relocating_shards: - type: number + type: integer + format: int32 unassigned_shards: - type: number + type: integer + format: int32 data_nodes: - type: number + type: integer + format: int32 weight: - type: number + type: integer + format: int32 cluster.health___HealthResponseBody: type: object properties: active_primary_shards: description: The number of active primary shards. - type: number + type: integer + format: int32 active_shards: description: The total number of active primary and replica shards. - type: number + type: integer + format: int32 active_shards_percent: $ref: '#/components/schemas/_common___PercentageString' active_shards_percent_as_number: @@ -46247,13 +49960,14 @@ components: $ref: '#/components/schemas/_common___Name' delayed_unassigned_shards: description: The number of shards whose allocation has been delayed by the timeout settings. - type: number + type: integer + format: int32 discovered_master: - description: True if the master node has been discovered. + description: True if the cluster-manager node has been discovered. type: boolean x-version-deprecated: '2.0' discovered_cluster_manager: - description: True if the cluster manager node has been discovered. + description: True if the cluster-manager node has been discovered. type: boolean x-version-added: '2.0' indices: @@ -46262,22 +49976,28 @@ components: $ref: '#/components/schemas/cluster.health___IndexHealthStats' initializing_shards: description: The number of shards that are under initialization. - type: number + type: integer + format: int32 number_of_data_nodes: description: The number of nodes that are dedicated data nodes. - type: number + type: integer + format: int32 number_of_in_flight_fetch: description: The number of unfinished fetches. - type: number + type: integer + format: int32 number_of_nodes: description: The number of nodes within the cluster. - type: number + type: integer + format: int32 number_of_pending_tasks: description: The number of cluster-level changes that have not yet been executed. - type: number + type: integer + format: int32 relocating_shards: description: The number of shards that are under relocation. - type: number + type: integer + format: int32 status: $ref: '#/components/schemas/_common___HealthStatus' task_max_waiting_in_queue: @@ -46285,11 +50005,12 @@ components: task_max_waiting_in_queue_millis: $ref: '#/components/schemas/_common___DurationValueUnitMillis' timed_out: - description: If false the response returned within the period of time that is specified by the timeout parameter (30s by default). + description: If `false` the response returned within the period of time that is specified by the timeout parameter (`30s` by default). type: boolean unassigned_shards: description: The number of shards that are not allocated. - type: number + type: integer + format: int32 required: - active_primary_shards - active_shards @@ -46310,17 +50031,23 @@ components: type: object properties: active_primary_shards: - type: number + type: integer + format: int32 active_shards: - type: number + type: integer + format: int32 initializing_shards: - type: number + type: integer + format: int32 number_of_replicas: - type: number + type: integer + format: int32 number_of_shards: - type: number + type: integer + format: int32 relocating_shards: - type: number + type: integer + format: int32 shards: type: object additionalProperties: @@ -46328,7 +50055,8 @@ components: status: $ref: '#/components/schemas/_common___HealthStatus' unassigned_shards: - type: number + type: integer + format: int32 required: - active_primary_shards - active_shards @@ -46349,17 +50077,21 @@ components: type: object properties: active_shards: - type: number + type: integer + format: int32 initializing_shards: - type: number + type: integer + format: int32 primary_active: type: boolean relocating_shards: - type: number + type: integer + format: int32 status: $ref: '#/components/schemas/_common___HealthStatus' unassigned_shards: - type: number + type: integer + format: int32 required: - active_shards - initializing_shards @@ -46375,7 +50107,8 @@ components: type: boolean insert_order: description: The number that represents when the task has been inserted into the task queue. - type: number + type: integer + format: int32 priority: description: |- The priority of the pending task. @@ -46419,9 +50152,11 @@ components: server_name: type: string num_proxy_sockets_connected: - type: number + type: integer + format: int32 max_proxy_socket_connections: - type: number + type: integer + format: int32 required: - connected - initial_connect_timeout @@ -46441,9 +50176,11 @@ components: connected: type: boolean max_connections_per_cluster: - type: number + type: integer + format: int32 num_nodes_connected: - type: number + type: integer + format: int64 initial_connect_timeout: $ref: '#/components/schemas/_common___Duration' skip_unavailable: @@ -46464,14 +50201,48 @@ components: type: object properties: cancel: + description: |- + Cancel allocation of a shard (or recovery). Accepts `index` and `shard` for index + name and shard number, and `node` for the node to cancel the shard allocation + on. This can be used to force resynchronization of existing replicas from the + primary shard by cancelling them and allowing them to be reinitialized + through the standard recovery process. By default only replica shard + allocations can be cancelled. If it is necessary to cancel the allocation of + a primary shard then the `allow_primary` flag must also be included in the + request. $ref: '#/components/schemas/cluster.reroute___CommandCancelAction' move: + description: |- + Move a started shard from one node to another node. Accepts `index` and `shard` + for index name and shard number, `from_node` for the node to move the shard + from, and `to_node` for the node to move the shard to. $ref: '#/components/schemas/cluster.reroute___CommandMoveAction' allocate_replica: + description: |- + Allocate an unassigned replica shard to a node. Accepts `index` and `shard` for + index name and shard number, and `node` to allocate the shard to. Takes + allocation deciders into account. $ref: '#/components/schemas/cluster.reroute___CommandAllocateReplicaAction' allocate_stale_primary: + description: |- + Allocate a primary shard to a node that holds a stale copy. Accepts `index` + and `shard` for index name and shard number, and `node` to allocate the shard to. + Using this command may lead to data loss for the provided shard id. If a node + which has the good copy of the data rejoins the cluster later on, that data + will be deleted or overwritten with the data of the stale copy that was + forcefully allocated with this command. To ensure that these implications are + well-understood, this command requires the flag `accept_data_loss` to be + explicitly set to true. $ref: '#/components/schemas/cluster.reroute___CommandAllocatePrimaryAction' allocate_empty_primary: + description: |- + Allocate an empty primary shard to a node. Accepts `index` and `shard` for + index name and shard number, and `node` to allocate the shard to. Using this + command leads to a complete loss of all data that was indexed into this + shard, if it was previously started. 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. $ref: '#/components/schemas/cluster.reroute___CommandAllocatePrimaryAction' cluster.reroute___CommandAllocatePrimaryAction: type: object @@ -46479,11 +50250,12 @@ components: index: $ref: '#/components/schemas/_common___IndexName' shard: - type: number + type: integer + format: int32 node: type: string accept_data_loss: - description: If a node which has a copy of the data rejoins the cluster later on, that data will be deleted. To ensure that these implications are well-understood, this command requires the flag accept_data_loss to be explicitly set to true + description: If a node which has a copy of the data rejoins the cluster later on, that data will be deleted. To ensure that these implications are well-understood, this command requires the flag `accept_data_loss` to be explicitly set to `true`. type: boolean required: - accept_data_loss @@ -46496,7 +50268,8 @@ components: index: $ref: '#/components/schemas/_common___IndexName' shard: - type: number + type: integer + format: int32 node: type: string required: @@ -46509,7 +50282,8 @@ components: index: $ref: '#/components/schemas/_common___IndexName' shard: - type: number + type: integer + format: int32 node: type: string allow_primary: @@ -46524,7 +50298,8 @@ components: index: $ref: '#/components/schemas/_common___IndexName' shard: - type: number + type: integer + format: int32 from_node: description: The node to move the shard from type: string @@ -46586,7 +50361,8 @@ components: node: $ref: '#/components/schemas/_common___NodeName' shard: - type: number + type: integer + format: int32 from_node: $ref: '#/components/schemas/_common___NodeName' to_node: @@ -46664,21 +50440,35 @@ components: type: object properties: available: + description: |- + Total number of bytes available to JVM in file stores across all selected nodes. + Depending on operating system or process-level restrictions, this number may be less than `nodes.fs.free_in_byes`. + This is the actual amount of free disk space the selected OpenSearch nodes can use. $ref: '#/components/schemas/_common___HumanReadableByteCount' available_in_bytes: + description: |- + Total number of bytes available to JVM in file stores across all selected nodes. + Depending on operating system or process-level restrictions, this number may be less than `nodes.fs.free_in_byes`. + This is the actual amount of free disk space the selected OpenSearch nodes can use. $ref: '#/components/schemas/_common___ByteCount' free: + description: Total number of unallocated bytes in file stores across all selected nodes. $ref: '#/components/schemas/_common___HumanReadableByteCount' free_in_bytes: + description: Total number of unallocated bytes in file stores across all selected nodes. $ref: '#/components/schemas/_common___ByteCount' total: + description: Total size, of all file stores across all selected nodes. $ref: '#/components/schemas/_common___HumanReadableByteCount' total_in_bytes: + description: Total size, in bytes, of all file stores across all selected nodes. $ref: '#/components/schemas/_common___ByteCount' cache_reserved: + description: Total size, of all cache reserved across all selected nodes. $ref: '#/components/schemas/_common___HumanReadableByteCount' x-version-added: '2.7' cache_reserved_in_bytes: + description: Total size, in bytes, of all cache reserved across all selected nodes. $ref: '#/components/schemas/_common___ByteCount' x-version-added: '2.7' required: @@ -46693,8 +50483,9 @@ components: completion: $ref: '#/components/schemas/_common___CompletionStats' count: - description: Total number of indices with shards assigned to selected nodes. - type: number + description: Total number of indexes with shards assigned to selected nodes. + type: integer + format: int64 docs: $ref: '#/components/schemas/_common___DocStats' fielddata: @@ -46714,17 +50505,6 @@ components: type: array items: $ref: '#/components/schemas/cluster.stats___IndicesVersions' - required: - - analysis - - completion - - count - - docs - - fielddata - - mappings - - query_cache - - segments - - shards - - store cluster.stats___ClusterIndicesShards: type: object properties: @@ -46732,21 +50512,27 @@ components: $ref: '#/components/schemas/cluster.stats___ClusterIndicesShardsIndex' primaries: description: Number of primary shards assigned to selected nodes. - type: number + type: integer + format: int32 replication: description: Ratio of replica shards to primary shards across all selected nodes. - type: number + type: integer + format: int32 total: description: Total number of shards assigned to selected nodes. - type: number + type: integer + format: int32 cluster.stats___ClusterIndicesShardsIndex: type: object properties: primaries: + description: Contains statistics about the number of primary shards assigned to selected nodes. $ref: '#/components/schemas/cluster.stats___ClusterShardMetrics' replication: + description: Contains statistics about the number of replication shards assigned to selected nodes. $ref: '#/components/schemas/cluster.stats___ClusterShardMetrics' shards: + description: Contains statistics about the number of shards assigned to selected nodes. $ref: '#/components/schemas/cluster.stats___ClusterShardMetrics' required: - primaries @@ -46756,7 +50542,8 @@ components: type: object properties: number_of_pipelines: - type: number + type: integer + format: int32 processor_stats: type: object additionalProperties: @@ -46775,7 +50562,8 @@ components: $ref: '#/components/schemas/cluster.stats___ClusterJvmMemory' threads: description: Number of active threads in use by JVM across all selected nodes. - type: number + type: integer + format: int64 versions: description: Contains statistics about the JVM versions used by selected nodes. type: array @@ -46790,12 +50578,16 @@ components: type: object properties: heap_max: + description: Maximum amount of memory available for use by the heap across all selected nodes. $ref: '#/components/schemas/_common___HumanReadableByteCount' heap_max_in_bytes: + description: Maximum amount of memory, in bytes, available for use by the heap across all selected nodes. $ref: '#/components/schemas/_common___ByteCount' heap_used: + description: Memory currently in use by the heap across all selected nodes. $ref: '#/components/schemas/_common___HumanReadableByteCount' heap_used_in_bytes: + description: Memory, in bytes, currently in use by the heap across all selected nodes. $ref: '#/components/schemas/_common___ByteCount' required: - heap_max_in_bytes @@ -46808,7 +50600,8 @@ components: type: boolean count: description: Total number of selected nodes using JVM. - type: number + type: integer + format: int32 using_bundled_jdk: description: If `true`, a bundled JDK is in use by JVM. type: boolean @@ -46837,12 +50630,14 @@ components: description: Contains statistics about the HTTP network types used by selected nodes. type: object additionalProperties: - type: number + type: integer + format: int32 transport_types: description: Contains statistics about the transport network types used by selected nodes. type: object additionalProperties: - type: number + type: integer + format: int32 required: - http_types - transport_types @@ -46850,39 +50645,55 @@ components: type: object properties: coordinating_only: - type: number + type: integer + format: int32 data: - type: number + type: integer + format: int32 data_cold: - type: number + type: integer + format: int32 data_content: - type: number + type: integer + format: int32 data_frozen: - type: number + type: integer + format: int32 data_hot: - type: number + type: integer + format: int32 data_warm: - type: number + type: integer + format: int32 ingest: - type: number + type: integer + format: int32 master: - type: number + type: integer + format: int32 cluster_manager: - type: number + type: integer + format: int32 x-version-added: '2.0' ml: - type: number + type: integer + format: int32 remote_cluster_client: - type: number + type: integer + format: int32 search: - type: number + type: integer + format: int32 x-version-added: '2.4' total: - type: number + type: integer + format: int32 transform: - type: number + type: integer + format: int32 voting_only: - type: number + type: integer + format: int32 required: - coordinating_only - data @@ -46894,23 +50705,29 @@ components: type: object properties: count: + description: Contains counts for nodes selected by the request's node filters. $ref: '#/components/schemas/cluster.stats___ClusterNodeCount' discovery_types: description: Contains statistics about the discovery types used by selected nodes. type: object additionalProperties: - type: number + type: integer + format: int32 fs: + description: Contains statistics about file stores by selected nodes. $ref: '#/components/schemas/cluster.stats___ClusterFileSystem' indexing_pressure: $ref: '#/components/schemas/cluster.stats___IndexingPressure' ingest: $ref: '#/components/schemas/cluster.stats___ClusterIngest' jvm: + description: Contains statistics about the Java Virtual Machines (JVMs) used by selected nodes. $ref: '#/components/schemas/cluster.stats___ClusterJvm' network_types: + description: Contains statistics about the transport and HTTP networks used by selected nodes. $ref: '#/components/schemas/cluster.stats___ClusterNetworkTypes' os: + description: Contains statistics about the operating systems used by selected nodes. $ref: '#/components/schemas/cluster.stats___ClusterOperatingSystem' packaging_types: description: Contains statistics about OpenSearch distributions installed on selected nodes. @@ -46925,24 +50742,13 @@ components: items: $ref: '#/components/schemas/_common___PluginStats' process: + description: Contains statistics about processes used by selected nodes. $ref: '#/components/schemas/cluster.stats___ClusterProcess' versions: description: Array of OpenSearch versions used on selected nodes. type: array items: $ref: '#/components/schemas/_common___VersionString' - required: - - count - - discovery_types - - fs - - ingest - - jvm - - network_types - - os - - packaging_types - - plugins - - process - - versions cluster.stats___ClusterOperatingSystem: type: object properties: @@ -46951,7 +50757,8 @@ components: Number of processors used to calculate thread pool size across all selected nodes. This number can be set with the processors setting of a node and defaults to the number of processors reported by the operating system. In both cases, this number will never be larger than 32. - type: number + type: integer + format: int32 architectures: description: Contains statistics about processor architectures (for example, x86_64 or aarch64) used by selected nodes. type: array @@ -46959,7 +50766,8 @@ components: $ref: '#/components/schemas/cluster.stats___ClusterOperatingSystemArchitecture' available_processors: description: Number of processors available to JVM across all selected nodes. - type: number + type: integer + format: int32 mem: $ref: '#/components/schemas/cluster.stats___OperatingSystemMemoryInfo' names: @@ -46986,7 +50794,8 @@ components: type: string count: description: Number of selected nodes using the architecture. - type: number + type: integer + format: int32 required: - arch - count @@ -46995,7 +50804,8 @@ components: properties: count: description: Number of selected nodes using the operating system. - type: number + type: integer + format: int32 name: $ref: '#/components/schemas/_common___Name' required: @@ -47006,7 +50816,8 @@ components: properties: count: description: Number of selected nodes using the operating system. - type: number + type: integer + format: int32 pretty_name: $ref: '#/components/schemas/_common___Name' required: @@ -47026,6 +50837,9 @@ components: type: object properties: percent: + description: |- + Percentage of CPU used across all selected nodes. + Returns `-1` if not supported. $ref: '#/components/schemas/_common___PercentageNumber' required: - percent @@ -47036,17 +50850,20 @@ components: description: |- Average number of concurrently open file descriptors. Returns `-1` if not supported. - type: number + type: integer + format: int64 max: description: |- Maximum number of concurrently open file descriptors allowed across all selected nodes. Returns `-1` if not supported. - type: number + type: integer + format: int64 min: description: |- Minimum number of concurrently open file descriptors across all selected nodes. Returns -1 if not supported. - type: number + type: integer + format: int64 required: - avg - max @@ -47055,11 +50872,14 @@ components: type: object properties: count: - type: number + type: integer + format: int64 current: - type: number + type: integer + format: int64 failed: - type: number + type: integer + format: int64 time: $ref: '#/components/schemas/_common___Duration' time_in_millis: @@ -47075,12 +50895,15 @@ components: avg: description: Mean number of shards in an index, counting only shards assigned to selected nodes. type: number + format: double max: description: Maximum number of shards in an index, counting only shards assigned to selected nodes. type: number + format: double min: description: Minimum number of shards in an index, counting only shards assigned to selected nodes. type: number + format: double required: - avg - max @@ -47092,22 +50915,12 @@ components: $ref: '#/components/schemas/_common___Name' count: description: The number of occurrences of the field type in selected nodes. - type: number + type: integer + format: int32 index_count: - description: The number of indices containing the field type in selected nodes. - type: number - indexed_vector_count: - description: For dense_vector field types, number of indexed vector types in selected nodes. - type: number - indexed_vector_dim_max: - description: For dense_vector field types, the maximum dimension of all indexed vector types in selected nodes. - type: number - indexed_vector_dim_min: - description: For dense_vector field types, the minimum dimension of all indexed vector types in selected nodes. - type: number - script_count: - description: The number of fields that declare a script. - type: number + description: The number of indexes containing the field type in selected nodes. + type: integer + format: int32 required: - count - index_count @@ -47120,16 +50933,6 @@ components: type: array items: $ref: '#/components/schemas/cluster.stats___FieldTypes' - total_field_count: - description: Total number of fields in all non-system indices. - type: number - total_deduplicated_field_count: - description: Total number of fields in all non-system indices, accounting for mapping deduplication. - type: number - total_deduplicated_mapping_size: - $ref: '#/components/schemas/_common___HumanReadableByteCount' - total_deduplicated_mapping_size_in_bytes: - $ref: '#/components/schemas/_common___ByteCount' required: - field_types cluster.stats___IndexingPressure: @@ -47177,13 +50980,28 @@ components: - coordinating_in_bytes - primary_in_bytes - replica_in_bytes + cluster.stats___IndexMetric: + type: string + enum: + - _all + - analysis + - completion + - docs + - fielddata + - mappings + - query_cache + - segments + - shards + - store cluster.stats___IndicesVersions: type: object properties: index_count: - type: number + type: integer + format: int32 primary_shard_count: - type: number + type: integer + format: int32 total_primary_bytes: $ref: '#/components/schemas/_common___ByteCount' version: @@ -47193,12 +51011,27 @@ components: - primary_shard_count - total_primary_bytes - version + cluster.stats___Metric: + type: string + enum: + - _all + - discovery_type + - fs + - indices + - ingest + - jvm + - network_types + - os + - packaging_types + - plugins + - process cluster.stats___NodePackagingType: type: object properties: count: description: Number of selected nodes using the distribution flavor and file type. - type: number + type: integer + format: int32 flavor: description: Type of OpenSearch distribution. This is always `default`. type: string @@ -47212,22 +51045,31 @@ components: type: object properties: adjusted_total_in_bytes: + description: Total amount, in bytes, of memory across all selected nodes, but using the value specified using the `es.total_memory_bytes` system property instead of measured total memory for those nodes where that system property was set. $ref: '#/components/schemas/_common___ByteCount' free: + description: Amount, in bytes, of free physical memory across all selected nodes. $ref: '#/components/schemas/_common___HumanReadableByteCount' free_in_bytes: + description: Amount, in bytes, of free physical memory across all selected nodes. $ref: '#/components/schemas/_common___ByteCount' free_percent: + description: Percentage of free physical memory across all selected nodes. $ref: '#/components/schemas/_common___PercentageNumber' total: + description: Total amount of physical memory across all selected nodes. $ref: '#/components/schemas/_common___HumanReadableByteCount' total_in_bytes: + description: Total amount, in bytes, of physical memory across all selected nodes. $ref: '#/components/schemas/_common___ByteCount' used: + description: Amount of physical memory in use across all selected nodes. $ref: '#/components/schemas/_common___HumanReadableByteCount' used_in_bytes: + description: Amount, in bytes, of physical memory in use across all selected nodes. $ref: '#/components/schemas/_common___ByteCount' used_percent: + description: Percentage of physical memory in use across all selected nodes. $ref: '#/components/schemas/_common___PercentageNumber' required: - free_in_bytes @@ -47235,31 +51077,6 @@ components: - total_in_bytes - used_in_bytes - used_percent - cluster.stats___StatsResponseBase: - allOf: - - $ref: '#/components/schemas/nodes._common___NodesResponseBase' - - type: object - properties: - cluster_name: - $ref: '#/components/schemas/_common___Name' - cluster_uuid: - $ref: '#/components/schemas/_common___Uuid' - indices: - $ref: '#/components/schemas/cluster.stats___ClusterIndices' - nodes: - $ref: '#/components/schemas/cluster.stats___ClusterNodes' - status: - $ref: '#/components/schemas/_common___HealthStatus' - timestamp: - description: Unix timestamp, in milliseconds, for the last time the cluster statistics were refreshed. - type: number - required: - - cluster_name - - cluster_uuid - - indices - - nodes - - status - - timestamp cluster.weighted_routing___Weights: allOf: - $ref: '#/components/schemas/cluster.weighted_routing___WeightsBase' @@ -47320,7 +51137,7 @@ components: $ref: '#/components/schemas/flow_framework.common___version' workflows: type: object - description: A map of workflows. Presently, only the provision key is supported. The value for the workflow key is a key-value map that includes fields for user_params and lists of nodes and edges. + description: A map of workflows. Presently, only the provision key is supported. The value for the workflow key is a key-value map that includes fields for `user_params` and lists of nodes and edges. required: - name flow_framework.common___FlowFrameworkDeleteResponse: @@ -47716,7 +51533,7 @@ components: properties: error: type: string - description: Describes the resources that require the allow_delete parameter for deprovisioning + description: Describes the resources that require the `allow_delete` parameter for deprovisioning required: - error flow_framework.errors___DuplicateKeyError: @@ -47852,7 +51669,7 @@ components: is_hidden: description: |- If `true`, the alias is hidden. - All indices for the alias must have the same `is_hidden` value. + All indexes for the alias must have the same `is_hidden` value. type: boolean is_write_index: description: If `true`, the index is the write index for the alias. @@ -47885,7 +51702,7 @@ components: is_hidden: description: |- If `true`, the alias is hidden. - All indices for the alias must have the same `is_hidden` value. + All indexes for the alias must have the same `is_hidden` value. type: boolean indices._common___DataStream: type: object @@ -47897,7 +51714,8 @@ components: 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. - type: number + type: integer + format: int64 hidden: description: If `true`, the data stream is hidden. type: boolean @@ -47910,7 +51728,7 @@ components: type: boolean indices: description: |- - Array of objects containing information about the data stream's backing indices. + Array of objects containing information about the data stream's backing indexes. The last item in this array contains information about the stream's current write index. type: array items: @@ -47921,7 +51739,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___HealthStatusCapitalized' + $ref: '#/components/schemas/_common___HealthStatus' 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 @@ -47953,6 +51771,27 @@ components: required: - index_name - index_uuid + indices._common___DataStreamStats: + type: object + properties: + backing_indices: + description: Current number of backing indexes for the data stream. + type: integer + format: int32 + data_stream: + $ref: '#/components/schemas/_common___Name' + maximum_timestamp: + $ref: '#/components/schemas/_common___EpochTimeUnitMillis' + store_size: + $ref: '#/components/schemas/_common___HumanReadableByteCount' + store_size_bytes: + description: Total size, in bytes, of all shards for the data stream's backing indexes. + $ref: '#/components/schemas/_common___ByteCount' + required: + - backing_indices + - data_stream + - maximum_timestamp + - store_size_bytes indices._common___DataStreamTimestampField: type: object properties: @@ -48014,6 +51853,19 @@ components: additionalProperties: title: metadata description: Additional details about the error. + indices._common___IndexGetUpgradeStatus: + type: object + properties: + size_in_bytes: + $ref: '#/components/schemas/_common___ByteCount' + size_to_upgrade_in_bytes: + $ref: '#/components/schemas/_common___ByteCount' + size_to_upgrade_ancient_in_bytes: + $ref: '#/components/schemas/_common___ByteCount' + indices: + type: object + additionalProperties: + $ref: '#/components/schemas/indices._common___UpgradeStatus' indices._common___IndexingPressure: type: object properties: @@ -48039,9 +51891,9 @@ components: level: type: string source: - type: integer + $ref: '#/components/schemas/_common___StringifiedInteger' reformat: - type: boolean + $ref: '#/components/schemas/_common___StringifiedBoolean' threshold: $ref: '#/components/schemas/indices._common___IndexingSlowlogThresholds' indices._common___IndexingSlowlogThresholds: @@ -48067,11 +51919,13 @@ components: $ref: '#/components/schemas/indices._common___IndexRoutingAllocationInitialRecovery' disk: $ref: '#/components/schemas/indices._common___IndexRoutingAllocationDisk' + total_shards_per_node: + $ref: '#/components/schemas/_common___StringifiedInteger' indices._common___IndexRoutingAllocationDisk: type: object properties: threshold_enabled: - $ref: '#/components/schemas/_common___Stringifiedboolean' + $ref: '#/components/schemas/_common___StringifiedBoolean' indices._common___IndexRoutingAllocationInclude: type: object properties: @@ -48132,15 +51986,15 @@ components: type: object properties: read_only: - $ref: '#/components/schemas/_common___Stringifiedboolean' + $ref: '#/components/schemas/_common___StringifiedBoolean' read_only_allow_delete: - $ref: '#/components/schemas/_common___Stringifiedboolean' + $ref: '#/components/schemas/_common___StringifiedBoolean' read: - $ref: '#/components/schemas/_common___Stringifiedboolean' + $ref: '#/components/schemas/_common___StringifiedBoolean' write: - $ref: '#/components/schemas/_common___Stringifiedboolean' + $ref: '#/components/schemas/_common___StringifiedBoolean' metadata: - $ref: '#/components/schemas/_common___Stringifiedboolean' + $ref: '#/components/schemas/_common___StringifiedBoolean' indices._common___IndexSettings: type: object description: The index settings to be updated. @@ -48150,11 +52004,7 @@ components: mode: type: string routing_path: - oneOf: - - type: string - - type: array - items: - type: string + $ref: '#/components/schemas/_common___StringOrStringArray' soft_deletes: $ref: '#/components/schemas/indices._common___SoftDeletes' soft_deletes.retention_lease.period: @@ -48162,31 +52012,27 @@ components: sort: $ref: '#/components/schemas/indices._common___IndexSegmentSort' number_of_shards: - oneOf: - - type: integer - - type: string + $ref: '#/components/schemas/_common___StringifiedInteger' number_of_replicas: - oneOf: - - type: integer - - type: string + $ref: '#/components/schemas/_common___StringifiedInteger' number_of_routing_shards: - type: integer + $ref: '#/components/schemas/_common___StringifiedInteger' check_on_startup: $ref: '#/components/schemas/indices._common___IndexCheckOnStartup' codec: type: string routing_partition_size: - $ref: '#/components/schemas/_common___Stringifiedinteger' + $ref: '#/components/schemas/_common___StringifiedInteger' load_fixed_bitset_filters_eagerly: - type: boolean + $ref: '#/components/schemas/_common___StringifiedBoolean' hidden: - $ref: '#/components/schemas/_common___Stringifiedboolean' + $ref: '#/components/schemas/_common___StringifiedBoolean' auto_expand_replicas: type: string merge: $ref: '#/components/schemas/indices._common___IndexSettingsMerge' merge.scheduler.max_thread_count: - $ref: '#/components/schemas/_common___Stringifiedinteger' + $ref: '#/components/schemas/_common___StringifiedInteger' search: $ref: '#/components/schemas/indices._common___IndexSettingsSearch' search.idle.after: @@ -48194,45 +52040,45 @@ components: refresh_interval: $ref: '#/components/schemas/_common___Duration' max_result_window: - type: integer + $ref: '#/components/schemas/_common___StringifiedInteger' max_inner_result_window: - type: integer + $ref: '#/components/schemas/_common___StringifiedInteger' max_rescore_window: - type: integer + $ref: '#/components/schemas/_common___StringifiedInteger' max_docvalue_fields_search: - type: integer + $ref: '#/components/schemas/_common___StringifiedInteger' max_script_fields: - type: integer + $ref: '#/components/schemas/_common___StringifiedInteger' max_ngram_diff: - type: integer + $ref: '#/components/schemas/_common___StringifiedInteger' max_shingle_diff: - type: integer + $ref: '#/components/schemas/_common___StringifiedInteger' blocks: $ref: '#/components/schemas/indices._common___IndexSettingBlocks' blocks.read_only: - $ref: '#/components/schemas/_common___Stringifiedboolean' + $ref: '#/components/schemas/_common___StringifiedBoolean' blocks.read_only_allow_delete: - $ref: '#/components/schemas/_common___Stringifiedboolean' + $ref: '#/components/schemas/_common___StringifiedBoolean' blocks.read: - $ref: '#/components/schemas/_common___Stringifiedboolean' + $ref: '#/components/schemas/_common___StringifiedBoolean' blocks.write: - $ref: '#/components/schemas/_common___Stringifiedboolean' + $ref: '#/components/schemas/_common___StringifiedBoolean' blocks.metadata: - $ref: '#/components/schemas/_common___Stringifiedboolean' + $ref: '#/components/schemas/_common___StringifiedBoolean' max_refresh_listeners: - type: integer + $ref: '#/components/schemas/_common___StringifiedInteger' analyze: $ref: '#/components/schemas/indices._common___IndexSettingsAnalyze' analyze.max_token_count: - $ref: '#/components/schemas/_common___Stringifiedinteger' + $ref: '#/components/schemas/_common___StringifiedInteger' highlight: $ref: '#/components/schemas/indices._common___IndexSettingsHighlight' highlight.max_analyzed_offset: - type: integer + $ref: '#/components/schemas/_common___StringifiedInteger' max_terms_count: - type: integer + $ref: '#/components/schemas/_common___StringifiedInteger' max_regex_length: - type: integer + $ref: '#/components/schemas/_common___StringifiedInteger' routing: $ref: '#/components/schemas/indices._common___IndexRouting' gc_deletes: @@ -48256,13 +52102,13 @@ components: version: $ref: '#/components/schemas/indices._common___IndexVersioning' verified_before_close: - $ref: '#/components/schemas/_common___Stringifiedboolean' + $ref: '#/components/schemas/_common___StringifiedBoolean' format: oneOf: - type: string - type: number max_slices_per_scroll: - type: integer + $ref: '#/components/schemas/_common___StringifiedInteger' translog: $ref: '#/components/schemas/indices._common___Translog' translog.durability: @@ -48272,19 +52118,17 @@ components: query_string: $ref: '#/components/schemas/indices._common___IndexSettingsQueryString' query_string.lenient: - $ref: '#/components/schemas/_common___Stringifiedboolean' + $ref: '#/components/schemas/_common___StringifiedBoolean' priority: oneOf: - type: number - type: string top_metrics_max_size: - type: integer + $ref: '#/components/schemas/_common___StringifiedInteger' analysis: $ref: '#/components/schemas/indices._common___IndexSettingsAnalysis' settings: $ref: '#/components/schemas/indices._common___IndexSettings' - time_series: - $ref: '#/components/schemas/indices._common___IndexSettingsTimeSeries' queries: $ref: '#/components/schemas/indices._common___IndexSettingsQueries' similarity: @@ -48298,9 +52142,11 @@ components: store: $ref: '#/components/schemas/indices._common___IndexSettingsStore' knn: - type: boolean + $ref: '#/components/schemas/_common___StringifiedBoolean' knn.algo_param.ef_search: - type: integer + $ref: '#/components/schemas/_common___StringifiedInteger' + composite_index.star_tree: + $ref: '#/components/schemas/indices._common___IndexSettingsStarTree' additionalProperties: title: custom_settings indices._common___IndexSettingsAnalysis: @@ -48330,12 +52176,12 @@ components: type: object properties: max_token_count: - $ref: '#/components/schemas/_common___Stringifiedinteger' + $ref: '#/components/schemas/_common___StringifiedInteger' indices._common___IndexSettingsHighlight: type: object properties: max_analyzed_offset: - type: integer + $ref: '#/components/schemas/_common___StringifiedInteger' indices._common___IndexSettingsIndexing: type: object properties: @@ -48347,15 +52193,19 @@ components: name: $ref: '#/components/schemas/_common___Name' indexing_complete: - $ref: '#/components/schemas/_common___Stringifiedboolean' + $ref: '#/components/schemas/_common___StringifiedBoolean' origination_date: + description: |- + If specified, this is the timestamp used to calculate the index age for its phase transitions. Use this setting + if you create a new index that contains old data and want to use the original creation date to calculate the index + age. Specified as a Unix epoch value in milliseconds. $ref: '#/components/schemas/_common___StringifiedEpochTimeUnitMillis' parse_origination_date: description: |- - Set to true to parse the origination date from the index name. This origination date is used to calculate the index age - for its phase transitions. The index name must match the pattern ^.*-{date_format}-\\d+, where the date_format is - yyyy.MM.dd and the trailing digits are optional. An index that was rolled over would normally match the full format, - for example logs-2016.10.31-000002). If the index name doesn't match the pattern, index creation fails. + Set to `true` to parse the origination date from the index name. This origination date is used to calculate the index age + for its phase transitions. The index name must match the pattern `^.*-{date_format}-\\d+`, where the `date_format` is + `yyyy.MM.dd` and the trailing digits are optional. An index that was rolled over would normally match the full format, + for example `logs-2016.10.31-000002`). If the index name doesn't match the pattern, index creation fails. type: boolean step: $ref: '#/components/schemas/indices._common___IndexSettingsLifecycleStep' @@ -48363,7 +52213,7 @@ components: description: |- The index alias to update when the index rolls over. Specify when using a policy that contains a rollover action. When the index rolls over, the alias is updated to reflect that the index is no longer the write index. For more - information about rolling indices, see Rollover. + information about rolling indexes, see Rollover. type: string required: - name @@ -48376,7 +52226,7 @@ components: type: object properties: coerce: - type: boolean + $ref: '#/components/schemas/_common___StringifiedBoolean' total_fields: $ref: '#/components/schemas/indices._common___IndexSettingsMappingLimitTotalFields' depth: @@ -48390,16 +52240,15 @@ components: dimension_fields: $ref: '#/components/schemas/indices._common___IndexSettingsMappingLimitDimensionFields' ignore_malformed: - type: boolean + $ref: '#/components/schemas/_common___StringifiedBoolean' indices._common___IndexSettingsMappingLimitDepth: type: object properties: limit: description: |- The maximum depth for a field, which is measured as the number of inner objects. For instance, if all fields are defined - at the root object level, then the depth is 1. If there is one object mapping, then the depth is 2, etc. - type: integer - format: int64 + at the root object level, then the depth is `1`. If there is one object mapping, then the depth is `2`. + $ref: '#/components/schemas/_common___StringifiedLong' indices._common___IndexSettingsMappingLimitDimensionFields: type: object properties: @@ -48407,8 +52256,7 @@ components: description: |- [preview] This functionality is in technical preview and may be changed or removed in a future release. OpenSearch will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features. - type: integer - format: int64 + $ref: '#/components/schemas/_common___StringifiedLong' indices._common___IndexSettingsMappingLimitFieldNameLength: type: object properties: @@ -48417,8 +52265,7 @@ components: Setting for the maximum length of a field name. This setting isn't really something that addresses mappings explosion but might still be useful if you want to limit the field length. It usually shouldn't be necessary to set this setting. The default is okay unless a user starts to add a huge number of fields with really long names. Default is `Long.MAX_VALUE` (no limit). - type: integer - format: int64 + $ref: '#/components/schemas/_common___StringifiedLong' indices._common___IndexSettingsMappingLimitNestedFields: type: object properties: @@ -48427,8 +52274,7 @@ components: The maximum number of distinct nested mappings in an index. The nested type should only be used in special cases, when arrays of objects need to be queried independently of each other. To safeguard against poorly designed mappings, this setting limits the number of unique nested types per index. - type: integer - format: int64 + $ref: '#/components/schemas/_common___StringifiedLong' indices._common___IndexSettingsMappingLimitNestedObjects: type: object properties: @@ -48436,8 +52282,7 @@ components: description: |- The maximum number of nested JSON objects that a single document can contain across all nested types. This limit helps to prevent out of memory errors when a document contains too many nested objects. - type: integer - format: int64 + $ref: '#/components/schemas/_common___StringifiedLong' indices._common___IndexSettingsMappingLimitTotalFields: type: object properties: @@ -48446,20 +52291,86 @@ components: The maximum number of fields in an index. Field and object mappings, as well as field aliases count towards this limit. The limit is in place to prevent mappings and searches from becoming too large. Higher values can lead to performance degradations and memory issues, especially in clusters with a high load or few resources. - type: integer - format: int64 + $ref: '#/components/schemas/_common___StringifiedLong' indices._common___IndexSettingsMerge: type: object properties: + log_byte_size_policy: + $ref: '#/components/schemas/indices._common___IndexSettingsMergeLogByteSizePolicy' + policy: + $ref: '#/components/schemas/indices._common___IndexSettingsMergePolicy' + policy.deletes_pct_allowed: + $ref: '#/components/schemas/_common___StringifiedDouble' + policy.expunge_deletes_allowed: + $ref: '#/components/schemas/_common___StringifiedDouble' + policy.floor_segment: + $ref: '#/components/schemas/_common___HumanReadableByteCount' + policy.max_merge_at_once: + $ref: '#/components/schemas/_common___StringifiedInteger' + policy.max_merged_segment: + $ref: '#/components/schemas/_common___HumanReadableByteCount' + policy.reclaim_deletes_weight: + $ref: '#/components/schemas/_common___StringifiedDouble' + policy.segments_per_tier: + $ref: '#/components/schemas/_common___StringifiedDouble' scheduler: $ref: '#/components/schemas/indices._common___IndexSettingsMergeScheduler' + indices._common___IndexSettingsMergeLogByteSizePolicy: + type: object + properties: + max_merge_segment: + $ref: '#/components/schemas/_common___HumanReadableByteCount' + max_merge_segment_forced_merge: + $ref: '#/components/schemas/_common___HumanReadableByteCount' + max_merged_docs: + $ref: '#/components/schemas/_common___StringifiedInteger' + merge_factor: + $ref: '#/components/schemas/_common___StringifiedInteger' + min_merge: + $ref: '#/components/schemas/_common___HumanReadableByteCount' + no_cfs_ratio: + $ref: '#/components/schemas/_common___StringifiedDouble' + indices._common___IndexSettingsMergePolicy: + oneOf: + - title: name + $ref: '#/components/schemas/indices._common___IndexSettingsMergePolicyName' + - title: tiered_policy_config + $ref: '#/components/schemas/indices._common___IndexSettingsMergeTieredPolicy' + indices._common___IndexSettingsMergePolicyName: + type: string + enum: + - default + - log_byte_size + - tiered indices._common___IndexSettingsMergeScheduler: type: object properties: + auto_throttle: + $ref: '#/components/schemas/_common___StringifiedBoolean' max_thread_count: - $ref: '#/components/schemas/_common___Stringifiedinteger' + $ref: '#/components/schemas/_common___StringifiedInteger' max_merge_count: - $ref: '#/components/schemas/_common___Stringifiedinteger' + $ref: '#/components/schemas/_common___StringifiedInteger' + indices._common___IndexSettingsMergeTieredPolicy: + type: object + properties: + deletes_pct_allowed: + $ref: '#/components/schemas/_common___StringifiedDouble' + expunge_deletes_allowed: + $ref: '#/components/schemas/_common___StringifiedDouble' + floor_segment: + $ref: '#/components/schemas/_common___HumanReadableByteCount' + max_merge_at_once: + $ref: '#/components/schemas/_common___StringifiedInteger' + max_merge_at_once_explicit: + $ref: '#/components/schemas/_common___StringifiedInteger' + x-version-removed: '2.0' + max_merged_segment: + $ref: '#/components/schemas/_common___HumanReadableByteCount' + reclaim_deletes_weight: + $ref: '#/components/schemas/_common___StringifiedDouble' + segments_per_tier: + $ref: '#/components/schemas/_common___StringifiedDouble' indices._common___IndexSettingsQueries: type: object properties: @@ -48469,21 +52380,41 @@ components: type: object properties: enabled: - type: boolean + $ref: '#/components/schemas/_common___StringifiedBoolean' required: - enabled indices._common___IndexSettingsQueryString: type: object properties: lenient: - $ref: '#/components/schemas/_common___Stringifiedboolean' + $ref: '#/components/schemas/_common___StringifiedBoolean' indices._common___IndexSettingsSearch: type: object properties: + concurrent: + $ref: '#/components/schemas/indices._common___IndexSettingsSearchConcurrent' + concurrent_segment_search: + $ref: '#/components/schemas/indices._common___IndexSettingsSearchConcurrentSegmentSearch' + default_pipeline: + type: string idle: $ref: '#/components/schemas/indices._common___SearchIdle' slowlog: $ref: '#/components/schemas/indices._common___SearchSlowlog' + throttled: + $ref: '#/components/schemas/_common___StringifiedBoolean' + indices._common___IndexSettingsSearchConcurrent: + type: object + properties: + max_slice_count: + $ref: '#/components/schemas/_common___StringifiedInteger' + indices._common___IndexSettingsSearchConcurrentSegmentSearch: + type: object + properties: + mode: + type: string + enabled: + $ref: '#/components/schemas/_common___StringifiedBoolean' indices._common___IndexSettingsSimilarity: type: object properties: @@ -48607,6 +52538,42 @@ components: required: - script - type + indices._common___IndexSettingsStarTree: + type: object + properties: + default: + $ref: '#/components/schemas/indices._common___IndexSettingsStarTreeDefault' + field: + $ref: '#/components/schemas/indices._common___IndexSettingsStarTreeField' + max_fields: + $ref: '#/components/schemas/_common___StringifiedInteger' + indices._common___IndexSettingsStarTreeDefault: + type: object + properties: + max_leaf_docs: + $ref: '#/components/schemas/_common___StringifiedInteger' + indices._common___IndexSettingsStarTreeField: + type: object + properties: + default: + $ref: '#/components/schemas/indices._common___IndexSettingsStarTreeFieldDefault' + max_base_metrics: + $ref: '#/components/schemas/_common___StringifiedInteger' + max_date_intervals: + $ref: '#/components/schemas/_common___StringifiedInteger' + max_dimensions: + $ref: '#/components/schemas/_common___StringifiedInteger' + indices._common___IndexSettingsStarTreeFieldDefault: + type: object + properties: + date_intervals: + type: array + items: + type: string + metrics: + type: array + items: + type: string indices._common___IndexSettingsStore: type: object properties: @@ -48614,20 +52581,54 @@ components: $ref: '#/components/schemas/indices._common___StorageType' allow_mmap: description: |- - You can restrict the use of the mmapfs and the related hybridfs store type via the setting node.store.allow_mmap. - This is a boolean setting indicating whether or not memory-mapping is allowed. The default is to allow it. This + You can restrict the use of the `mmapfs` and the related `hybridfs` store types with the setting `node.store.allow_mmap`. + This is a Boolean setting indicating whether or not memory-mapping is allowed. The default is to allow it. This setting is useful, for example, if you are in an environment where you can not control the ability to create a lot of memory maps so you need disable the ability to use memory-mapping. - type: boolean + $ref: '#/components/schemas/_common___StringifiedBoolean' + fs: + $ref: '#/components/schemas/indices._common___IndexSettingsStoreFs' + hybrid: + $ref: '#/components/schemas/indices._common___IndexSettingsStoreHybrid' + preload: + type: array + items: + type: string + stats_refresh_interval: + $ref: '#/components/schemas/_common___Duration' required: - type - indices._common___IndexSettingsTimeSeries: + indices._common___IndexSettingsStoreFs: type: object properties: - end_time: - $ref: '#/components/schemas/_common___DateTime' - start_time: - $ref: '#/components/schemas/_common___DateTime' + fs_lock: + $ref: '#/components/schemas/indices._common___IndexSettingsStoreFsLock' + indices._common___IndexSettingsStoreFsLock: + type: string + enum: + - native + - simple + indices._common___IndexSettingsStoreHybrid: + type: object + properties: + mmap: + $ref: '#/components/schemas/indices._common___IndexSettingsStoreHybridMmap' + nio: + $ref: '#/components/schemas/indices._common___IndexSettingsStoreHybridNio' + indices._common___IndexSettingsStoreHybridMmap: + type: object + properties: + extensions: + type: array + items: + type: string + indices._common___IndexSettingsStoreHybridNio: + type: object + properties: + extensions: + type: array + items: + type: string indices._common___IndexState: type: object properties: @@ -48665,7 +52666,8 @@ components: The index template with the highest priority is chosen. If no priority is specified the template is treated as though it is of priority 0 (lowest priority). This number is not automatically generated by OpenSearch. - type: number + type: integer + format: int64 _meta: $ref: '#/components/schemas/_common___Metadata' allow_auto_create: @@ -48679,10 +52681,10 @@ components: type: object properties: hidden: - description: If true, the data stream is hidden. + description: If `true`, the data stream is hidden. type: boolean allow_custom_routing: - description: If true, the data stream supports custom routing. + description: If `true`, the data stream supports custom routing. type: boolean timestamp_field: $ref: '#/components/schemas/indices._common___DataStreamTimestampField' @@ -48786,16 +52788,25 @@ components: properties: enabled: description: Indicates whether soft deletes are enabled on the index. - type: boolean + $ref: '#/components/schemas/_common___StringifiedBoolean' + retention: + $ref: '#/components/schemas/indices._common___SoftDeletesRetention' retention_lease: $ref: '#/components/schemas/indices._common___RetentionLease' + indices._common___SoftDeletesRetention: + type: object + properties: + operations: + $ref: '#/components/schemas/_common___StringifiedLong' indices._common___StorageType: - type: string - enum: - - fs - - hybridfs - - mmapfs - - niofs + anyOf: + - type: string + enum: + - fs + - hybridfs + - mmapfs + - niofs + - type: string indices._common___TemplateMapping: type: object properties: @@ -48810,11 +52821,11 @@ components: mappings: $ref: '#/components/schemas/_common.mapping___TypeMapping' order: - type: number + type: integer + format: int32 settings: type: object - additionalProperties: - type: object + additionalProperties: true version: $ref: '#/components/schemas/_common___VersionNumber' required: @@ -48832,6 +52843,8 @@ components: $ref: '#/components/schemas/indices._common___TranslogDurability' flush_threshold_size: $ref: '#/components/schemas/_common___HumanReadableByteCount' + generation_threshold_size: + $ref: '#/components/schemas/_common___HumanReadableByteCount' retention: $ref: '#/components/schemas/indices._common___TranslogRetention' indices._common___TranslogDurability: @@ -48848,6 +52861,22 @@ components: $ref: '#/components/schemas/_common___HumanReadableByteCount' age: $ref: '#/components/schemas/_common___Duration' + indices._common___UpgradeStatus: + type: object + properties: + size_in_bytes: + $ref: '#/components/schemas/_common___ByteCount' + size_to_upgrade_in_bytes: + $ref: '#/components/schemas/_common___ByteCount' + size_to_upgrade_ancient_in_bytes: + $ref: '#/components/schemas/_common___ByteCount' + indices._common___UpgradeVersionStatus: + type: object + properties: + upgrade_version: + $ref: '#/components/schemas/_common___VersionString' + oldest_lucene_segment_version: + $ref: '#/components/schemas/_common___VersionString' indices.add_block___IndicesBlockOptions: type: string enum: @@ -48900,13 +52929,17 @@ components: type: object properties: end_offset: - type: number + type: integer + format: int32 position: - type: number + type: integer + format: int32 positionLength: - type: number + type: integer + format: int32 start_offset: - type: number + type: integer + format: int32 token: type: string type: @@ -48935,17 +52968,22 @@ components: bytes: type: string end_offset: - type: number + type: integer + format: int32 keyword: type: boolean position: - type: number + type: integer + format: int32 positionLength: - type: number + type: integer + format: int32 start_offset: - type: number + type: integer + format: int32 termFrequency: - type: number + type: integer + format: int32 token: type: string type: @@ -48960,11 +52998,7 @@ components: - token - type indices.analyze___TextToAnalyze: - oneOf: - - type: string - - type: array - items: - type: string + $ref: '#/components/schemas/_common___StringOrStringArray' indices.analyze___TokenDetail: type: object properties: @@ -48997,25 +53031,6 @@ components: $ref: '#/components/schemas/_common___ShardFailure' required: - failures - indices.data_streams_stats___DataStreamsStatsItem: - type: object - properties: - backing_indices: - description: Current number of backing indices for the data stream. - type: number - data_stream: - $ref: '#/components/schemas/_common___Name' - maximum_timestamp: - $ref: '#/components/schemas/_common___EpochTimeUnitMillis' - store_size: - $ref: '#/components/schemas/_common___HumanReadableByteCount' - store_size_bytes: - $ref: '#/components/schemas/_common___ByteCount' - required: - - backing_indices - - data_stream - - maximum_timestamp - - store_size_bytes indices.get_alias___IndexAliases: type: object properties: @@ -49073,11 +53088,13 @@ components: type: object properties: length: - type: number + type: integer + format: int64 name: type: string recovered: - type: number + type: integer + format: int64 required: - length - name @@ -49118,11 +53135,14 @@ components: percent: $ref: '#/components/schemas/_common___PercentageString' recovered: - type: number + type: integer + format: int64 reused: - type: number + type: integer + format: int64 total: - type: number + type: integer + format: int64 required: - percent - recovered @@ -49221,7 +53241,8 @@ components: type: object properties: id: - type: number + type: integer + format: int32 index: $ref: '#/components/schemas/indices.recovery___RecoveryIndexStatus' primary: @@ -49270,11 +53291,14 @@ components: percent: $ref: '#/components/schemas/_common___PercentageString' recovered: - type: number + type: integer + format: int32 total: - type: number + type: integer + format: int32 total_on_start: - type: number + type: integer + format: int32 total_time: $ref: '#/components/schemas/_common___Duration' total_time_in_millis: @@ -49350,9 +53374,11 @@ components: max_age_millis: $ref: '#/components/schemas/_common___DurationValueUnitMillis' min_docs: - type: number + type: integer + format: int64 max_docs: - type: number + type: integer + format: int64 max_size: $ref: '#/components/schemas/_common___HumanReadableByteCount' max_size_bytes: @@ -49370,9 +53396,11 @@ components: min_primary_shard_size_bytes: $ref: '#/components/schemas/_common___ByteCount' max_primary_shard_docs: - type: number + type: integer + format: int64 min_primary_shard_docs: - type: number + type: integer + format: int64 indices.segments___IndexSegment: type: object properties: @@ -49442,11 +53470,13 @@ components: type: object properties: num_committed_segments: - type: number + type: integer + format: int32 routing: $ref: '#/components/schemas/indices.segments___ShardSegmentRouting' num_search_segments: - type: number + type: integer + format: int32 segments: type: object additionalProperties: @@ -49474,6 +53504,9 @@ components: $ref: '#/components/schemas/_common___Id' store_exception: $ref: '#/components/schemas/indices.shard_stores___ShardStoreException' + additionalProperties: + title: nodes + $ref: '#/components/schemas/_common___NodeAttributes' required: - allocation indices.shard_stores___ShardStoreAllocation: @@ -49492,6 +53525,20 @@ components: required: - reason - type + indices.shard_stores___ShardStoreStatus: + oneOf: + - type: string + const: all + description: Return all shards, regardless of health status. + - type: string + const: green + description: The primary shard and all replica shards are assigned. + - type: string + const: red + description: The primary shard is unassigned. + - type: string + const: yellow + description: One or more replica shards are unassigned. indices.shard_stores___ShardStoreWrapper: type: object properties: @@ -49501,13 +53548,6 @@ components: $ref: '#/components/schemas/indices.shard_stores___ShardStore' required: - stores - indices.shard_stores___Status: - type: string - enum: - - all - - green - - red - - yellow indices.simulate_template___Overlapping: type: object properties: @@ -49533,7 +53573,6 @@ components: $ref: '#/components/schemas/indices._common___IndexSettings' required: - aliases - - mappings - settings indices.stats___AllIndicesStats: type: object @@ -49546,6 +53585,11 @@ components: - primaries - total indices.stats___IndexShardStats: + allOf: + - $ref: '#/components/schemas/indices.stats___IndexShardStatsBase' + - type: object + properties: {} + indices.stats___IndexShardStatsBase: allOf: - $ref: '#/components/schemas/indices.stats___IndexStatsBase' - type: object @@ -49643,11 +53687,13 @@ components: type: object properties: generation: - type: number + type: integer + format: int32 id: $ref: '#/components/schemas/_common___Id' num_docs: - type: number + type: integer + format: int64 user_data: type: object additionalProperties: @@ -49673,7 +53719,8 @@ components: average_size_in_bytes: $ref: '#/components/schemas/_common___ByteCount' count: - type: number + type: integer + format: int64 required: - description - size_in_bytes @@ -49685,7 +53732,8 @@ components: retaining_seq_no: $ref: '#/components/schemas/_common___SequenceNumber' timestamp: - type: number + type: integer + format: int64 source: type: string required: @@ -49710,7 +53758,8 @@ components: type: object properties: primary_term: - type: number + type: integer + format: int64 version: $ref: '#/components/schemas/_common___VersionNumber' leases: @@ -49749,9 +53798,11 @@ components: type: object properties: global_checkpoint: - type: number + type: integer + format: int64 local_checkpoint: - type: number + type: integer + format: int64 max_seq_no: $ref: '#/components/schemas/_common___SequenceNumber' required: @@ -49859,8 +53910,7 @@ components: value: description: The value to be appended. Supports template snippets. type: array - items: - type: object + items: {} allow_duplicates: description: If `false`, the processor does not append values already present in the field. type: boolean @@ -49881,7 +53931,8 @@ components: description: |- The number of chars being used for extraction to prevent huge fields. Use `-1` for no limit. - type: number + type: integer + format: int64 indexed_chars_field: $ref: '#/components/schemas/_common___Field' properties: @@ -49922,6 +53973,7 @@ components: error_distance: description: The difference between the resulting inscribed distance from center to side and the circle's radius (measured in meters for `geo_shape`, unit-less for `shape`). type: number + format: double field: $ref: '#/components/schemas/_common___Field' ignore_missing: @@ -49972,7 +54024,6 @@ components: Value used to fill empty fields. Empty fields are skipped if this is not provided. An empty field is one with no value (2 consecutive separators) or empty quotes (`""`). - type: object field: $ref: '#/components/schemas/_common___Field' ignore_missing: @@ -49987,7 +54038,7 @@ components: target_fields: $ref: '#/components/schemas/_common___Fields' trim: - description: Trim whitespaces in unquoted fields. + description: Trim white spaces in unquoted fields. type: boolean required: - field @@ -49999,8 +54050,8 @@ components: properties: date_formats: description: |- - An array of the expected date formats for parsing dates / timestamps in the document being preprocessed. - Can be a java time pattern or one of the following formats: ISO8601, UNIX, UNIX_MS, or TAI64N. + An array of the expected date formats for parsing dates/timestamps in the document being preprocessed. + Can be a java time pattern or one of the following formats: `ISO8601`, `UNIX`, `UNIX_MS`, or `TAI64N`. type: array items: type: string @@ -50027,7 +54078,7 @@ components: description: The locale to use when parsing the date from the document being preprocessed, relevant when parsing month names or week days. type: string timezone: - description: The timezone to use when parsing the date and when date math index supports resolves expressions into concrete index names. + description: The time zone to use when parsing the date and when date math index supports resolves expressions into concrete index names. type: string required: - date_formats @@ -50056,7 +54107,7 @@ components: $ref: '#/components/schemas/_common___Field' timezone: description: |- - The timezone to use when parsing the date. + The time zone to use when parsing the date. Supports template snippets. type: string required: @@ -50099,38 +54150,6 @@ components: allOf: - $ref: '#/components/schemas/ingest._common___ProcessorBase' - type: object - ingest._common___EnrichProcessor: - allOf: - - $ref: '#/components/schemas/ingest._common___ProcessorBase' - - type: object - properties: - field: - $ref: '#/components/schemas/_common___Field' - ignore_missing: - description: If `true` and `field` does not exist, the processor quietly exits without modifying the document. - type: boolean - max_matches: - description: |- - The maximum number of matched documents to include under the configured target field. - The `target_field` will be turned into a json array if `max_matches` is higher than 1, otherwise `target_field` will become a json object. - In order to avoid documents getting too large, the maximum allowed value is 128. - type: number - override: - description: |- - If processor will update fields with pre-existing non-null-valued field. - When set to `false`, such fields will not be touched. - type: boolean - policy_name: - description: The name of the enrich policy to use. - type: string - shape_relation: - $ref: '#/components/schemas/_common___GeoShapeRelation' - target_field: - $ref: '#/components/schemas/_common___Field' - required: - - field - - policy_name - - target_field ingest._common___FailProcessor: allOf: - $ref: '#/components/schemas/ingest._common___ProcessorBase' @@ -50164,7 +54183,7 @@ components: - type: object properties: database_file: - description: The database filename referring to a database the module ships with (GeoLite2-City.mmdb, GeoLite2-Country.mmdb, or GeoLite2-ASN.mmdb) or a custom database in the ingest-geoip config directory. + description: The database filename referring to a database the module ships with (`GeoLite2-City.mmdb`, `GeoLite2-Country.mmdb`, or `GeoLite2-ASN.mmdb`) or a custom database in the `ingest-geoip` config directory. type: string field: $ref: '#/components/schemas/_common___Field' @@ -50235,61 +54254,6 @@ components: - field - pattern - replacement - ingest._common___InferenceConfig: - type: object - properties: - regression: - $ref: '#/components/schemas/ingest._common___InferenceConfigRegression' - classification: - $ref: '#/components/schemas/ingest._common___InferenceConfigClassification' - minProperties: 1 - maxProperties: 1 - ingest._common___InferenceConfigClassification: - type: object - properties: - num_top_classes: - description: Specifies the number of top class predictions to return. - type: number - num_top_feature_importance_values: - description: Specifies the maximum number of feature importance values per document. - type: number - results_field: - $ref: '#/components/schemas/_common___Field' - top_classes_results_field: - $ref: '#/components/schemas/_common___Field' - prediction_field_type: - description: |- - Specifies the type of the predicted field to write. - Valid values are: `string`, `number`, `boolean`. - type: string - ingest._common___InferenceConfigRegression: - type: object - properties: - results_field: - $ref: '#/components/schemas/_common___Field' - num_top_feature_importance_values: - description: Specifies the maximum number of feature importance values per document. - type: number - ingest._common___InferenceProcessor: - allOf: - - $ref: '#/components/schemas/ingest._common___ProcessorBase' - - type: object - properties: - model_id: - $ref: '#/components/schemas/_common___Id' - target_field: - $ref: '#/components/schemas/_common___Field' - field_map: - description: |- - Maps the document field names to the known field names of the model. - This mapping takes precedence over any default mappings provided in the model configuration. - type: object - additionalProperties: - type: object - inference_config: - $ref: '#/components/schemas/ingest._common___InferenceConfig' - required: - - model_id ingest._common___JoinProcessor: allOf: - $ref: '#/components/schemas/ingest._common___ProcessorBase' @@ -50468,8 +54432,6 @@ components: $ref: '#/components/schemas/ingest._common___DateIndexNameProcessor' dot_expander: $ref: '#/components/schemas/ingest._common___DotExpanderProcessor' - enrich: - $ref: '#/components/schemas/ingest._common___EnrichProcessor' fail: $ref: '#/components/schemas/ingest._common___FailProcessor' foreach: @@ -50520,8 +54482,6 @@ components: $ref: '#/components/schemas/ingest._common___DropProcessor' circle: $ref: '#/components/schemas/ingest._common___CircleProcessor' - inference: - $ref: '#/components/schemas/ingest._common___InferenceProcessor' text_embedding: $ref: '#/components/schemas/ingest._common___TextEmbeddingProcessor' minProperties: 1 @@ -50581,7 +54541,6 @@ components: The value to be set for the field. Supports template snippets. May specify only one of `value` or `copy_from`. - type: object required: - field ingest._common___SetSecurityUserProcessor: @@ -50602,7 +54561,7 @@ components: type: string enum: - geo_shape - - shape + - xy_shape ingest._common___SortProcessor: allOf: - $ref: '#/components/schemas/ingest._common___ProcessorBase' @@ -50649,9 +54608,9 @@ components: type: object additionalProperties: type: string - description: - type: string - description: A brief description of the processor. + batch_size: + type: integer + format: int32 required: - field_map - model_id @@ -50740,7 +54699,6 @@ components: $ref: '#/components/schemas/_common___IndexName' _source: description: JSON body for the document. - type: object required: - _source ingest.simulate___DocumentSimulation: @@ -50758,8 +54716,7 @@ components: _source: description: JSON body for the document. type: object - additionalProperties: - type: object + additionalProperties: true _version: $ref: '#/components/schemas/_common___StringifiedVersionNumber' _version_type: @@ -50823,7 +54780,7 @@ components: collapse: $ref: '#/components/schemas/_core.search___FieldCollapse' explain: - description: If true, returns detailed information about score computation as part of a hit. + description: If `true`, returns detailed information about score computation as part of a hit. type: boolean ext: description: Configuration of search extensions defined by OpenSearch plugins. @@ -50842,7 +54799,7 @@ components: track_total_hits: $ref: '#/components/schemas/_core.search___TrackHits' indices_boost: - description: Boosts the _score of documents from specified indices. + description: Boosts the `_score` of documents from specified indexes. type: array items: type: object @@ -50905,7 +54862,7 @@ components: Use with caution. OpenSearch applies this parameter to each shard handling the request. When possible, let OpenSearch perform early termination automatically. - Avoid specifying this parameter for requests that target data streams with backing indices across multiple data tiers. + Avoid specifying this parameter for requests that target data streams with backing indexes across multiple data tiers. If set to `0` (default), the query does not terminate early. type: integer format: int32 @@ -50916,10 +54873,10 @@ components: Defaults to no timeout. type: string track_scores: - description: If true, calculate and return document scores, even if the scores are not used for sorting. + description: If `true`, calculate and return document scores, even if the scores are not used for sorting. type: boolean version: - description: If true, returns document version as part of a hit. + description: If `true`, returns document version as part of a hit. type: boolean seq_no_primary_term: description: If `true`, returns sequence number and primary term of the last modification of each hit. @@ -50932,7 +54889,7 @@ components: description: |- Stats groups to associate with the search. Each group maintains a statistics aggregation for its associated searches. - You can retrieve these stats using the indices stats API. + You can retrieve these stats using the indexes stats API. type: array items: type: string @@ -50995,7 +54952,7 @@ components: description: Additional labels for the query. search_type: type: string - description: The search query type (e.g., query_then_fetch). + description: The search query type (for example, `query_then_fetch`). source: type: object $ref: '#/components/schemas/insights._common___Source' @@ -51006,7 +54963,7 @@ components: type: array items: type: string - description: The indices involved in the query. + description: The indexes involved in the query. phase_latency_map: type: object measurements: @@ -51432,12 +55389,143 @@ components: enum: - AND - OR + knn._common___DeletedModel: + type: object + properties: + model_id: + type: string + result: + type: string + enum: + - deleted + - error + required: + - model_id + - result + knn._common___GraphMergeStats: + type: object + properties: + current: + type: number + total: + type: number + total_time_in_millis: + $ref: '#/components/schemas/_common___DurationValueUnitMillis' + current_docs: + type: number + total_docs: + type: number + total_size_in_bytes: + $ref: '#/components/schemas/_common___ByteCount' + current_size_in_bytes: + $ref: '#/components/schemas/_common___ByteCount' + knn._common___GraphRefreshStats: + type: object + properties: + total: + type: number + total_time_in_millis: + $ref: '#/components/schemas/_common___DurationValueUnitMillis' + knn._common___GraphStats: + type: object + properties: + merge: + $ref: '#/components/schemas/knn._common___GraphMergeStats' + refresh: + $ref: '#/components/schemas/knn._common___GraphRefreshStats' + knn._common___NodeStats: + type: object + properties: + max_distance_query_with_filter_requests: + type: number + graph_memory_usage_percentage: + $ref: '#/components/schemas/_common___PercentageNumber' + graph_query_requests: + type: number + graph_memory_usage: + type: number + cache_capacity_reached: + type: boolean + load_success_count: + type: number + training_memory_usage: + type: number + indices_in_cache: + type: object + additionalProperties: true + script_query_errors: + type: number + hit_count: + type: number + knn_query_requests: + type: number + total_load_time: + type: number + miss_count: + type: number + min_score_query_requests: + type: number + knn_query_with_filter_requests: + type: number + training_memory_usage_percentage: + $ref: '#/components/schemas/_common___PercentageNumber' + max_distance_query_requests: + type: number + lucene_initialized: + type: boolean + graph_index_requests: + type: number + faiss_initialized: + type: boolean + load_exception_count: + type: number + training_errors: + type: number + min_score_query_with_filter_requests: + type: number + eviction_count: + type: number + nmslib_initialized: + type: boolean + script_compilations: + type: number + script_query_requests: + type: number + graph_stats: + $ref: '#/components/schemas/knn._common___GraphStats' + graph_query_errors: + type: number + indexing_from_model_degraded: + type: boolean + graph_index_errors: + type: number + training_requests: + type: number + script_compilation_errors: + type: number knn._common___SearchType: type: string description: Search operation type. enum: - dfs_query_then_fetch - query_then_fetch + knn._common___Stats: + type: object + properties: + _nodes: + $ref: '#/components/schemas/_common___NodeStatistics' + cluster_name: + $ref: '#/components/schemas/_common___Name' + circuit_breaker_triggered: + type: boolean + model_index_status: + oneOf: + - $ref: '#/components/schemas/_common___HealthStatus' + - type: 'null' + nodes: + type: object + additionalProperties: + $ref: '#/components/schemas/knn._common___NodeStats' knn._common___SuggestMode: type: string description: Specify suggest mode. @@ -51445,6 +55533,36 @@ components: - always - missing - popular + knn._common___TrainedModel: + type: object + properties: + training_index: + type: string + training_field: + type: string + dimension: + type: integer + format: int32 + max_training_vector_count: + type: integer + format: int32 + search_size: + type: integer + format: int32 + description: + type: string + mode: + type: string + compression_level: + type: string + method: + type: string + spaceType: + type: string + required: + - dimension + - training_field + - training_index ml._common___Action: type: object properties: @@ -51462,6 +55580,79 @@ components: type: string post_process_function: type: string + ml._common___AdditionalInfo: + type: object + description: Additional information query. + properties: {} + additionalProperties: true + ml._common___Aggregation: + type: object + properties: + sum: + $ref: '#/components/schemas/ml._common___Aggregation' + field: + type: string + description: The field name. + additionalProperties: true + ml._common___Algorithm: + type: object + description: The algorithm. + properties: + value: + $ref: '#/components/schemas/ml._common___FunctionName' + ml._common___AlgorithmOperations: + type: object + properties: + deploy: + $ref: '#/components/schemas/ml._common___ModelStats' + register: + $ref: '#/components/schemas/ml._common___ModelStats' + undeploy: + $ref: '#/components/schemas/ml._common___ModelStats' + predict: + $ref: '#/components/schemas/ml._common___ModelStats' + train: + $ref: '#/components/schemas/ml._common___ModelStats' + train_predict: + $ref: '#/components/schemas/ml._common___ModelStats' + ml._common___Algorithms: + type: object + additionalProperties: + $ref: '#/components/schemas/ml._common___AlgorithmOperations' + ml._common___BoolQuery: + type: object + description: The Boolean query. + properties: + filter: + type: array + description: Filter query that appears in matching documents. + items: + $ref: '#/components/schemas/ml._common___Filter' + must: + type: array + description: Query that must appears in matching documents + items: + $ref: '#/components/schemas/ml._common___Filter' + must_not: + description: Query that must not appears in matching documents. + $ref: '#/components/schemas/ml._common___Filter' + should: + type: array + description: Query that should appear in matching documents. + items: + $ref: '#/components/schemas/ml._common___Filter' + ml._common___ByteBuffer: + type: object + properties: + array: + type: string + description: The byte buffer array. + order: + type: string + description: The byte buffer order. + enum: + - BIG_ENDIAN + - LITTLE_ENDIAN ml._common___ClientConfig: type: object properties: @@ -51479,45 +55670,232 @@ components: type: integer retry_timeout_seconds: type: integer - ml._common___CreateConnectorRequest: + ml._common___ColumnMeta: + type: object + properties: + name: + $ref: '#/components/schemas/_common___Name' + column_type: + type: string + description: The column type. + enum: + - BOOLEAN + - DOUBLE + - INTEGER + - STRING + ml._common___Credential: + type: object + properties: + access_key: + type: string + secret_key: + type: string + session_token: + type: string + additionalProperties: true + ml._common___Exists: + type: object + description: The exists filter. + properties: + field: + $ref: '#/components/schemas/_common___Field' + ml._common___Filter: + type: object + description: The filter element. + properties: + range: + $ref: '#/components/schemas/ml._common___Range' + nested: + $ref: '#/components/schemas/ml._common___Nested' + exists: + $ref: '#/components/schemas/ml._common___Exists' + term: + $ref: '#/components/schemas/ml._common___Term' + terms: + $ref: '#/components/schemas/ml._common___Term' + match: + $ref: '#/components/schemas/ml._common___Match' + ml._common___FunctionName: + type: string + description: The function name. + enum: + - AD_LIBSVM + - AGENT + - ANOMALY_LOCALIZATION + - BATCH_RCF + - CONNECTOR + - FIT_RCF + - KMEANS + - LINEAR_REGRESSION + - LOCAL_SAMPLE_CALCULATOR + - LOGISTIC_REGRESSION + - METRICS_CORRELATION + - QUESTION_ANSWERING + - RCF_SUMMARIZE + - REMOTE + - SAMPLE_ALGO + - SPARSE_ENCODING + - SPARSE_TOKENIZE + - TEXT_EMBEDDING + - TEXT_SIMILARITY + ml._common___GetAgentResponse: type: object properties: name: + $ref: '#/components/schemas/_common___Name' + type: type: string + description: The agent type. + enum: + - conversational + - conversational_flow + - flow description: type: string - version: + description: The agent description. + tools: + type: array + items: + $ref: '#/components/schemas/ml._common___ToolItems' + created_time: + type: integer + format: int64 + description: The created time. + last_updated_time: type: integer + format: int64 + description: The last updated time. + is_hidden: + type: boolean + description: Whether the agent is hidden. + ml._common___GetConnectorResponse: + type: object + properties: + name: + $ref: '#/components/schemas/_common___Name' + version: + $ref: '#/components/schemas/_common___VersionString' + description: + type: string + description: The connector description. protocol: type: string - credential: - $ref: '#/components/schemas/ml._common___Credential' + description: The connector protocol. + enum: + - aws_sigv4 + - http parameters: $ref: '#/components/schemas/ml._common___Parameters' - client_config: - $ref: '#/components/schemas/ml._common___ClientConfig' actions: type: array items: $ref: '#/components/schemas/ml._common___Action' - required: - - actions - - credential - - description - - name - - parameters - - protocol - - version - ml._common___Credential: + created_time: + type: integer + format: int64 + description: The created time. + last_updated_time: + type: integer + format: int64 + description: The last updated time. + ml._common___GetProfileResponse: type: object properties: - access_key: + nodes: + $ref: '#/components/schemas/ml._common___Nodes' + ml._common___GetStatsResponse: + type: object + properties: + ml_model_count: + type: integer + format: int64 + description: The model count. + ml_connector_index_status: type: string - secret_key: + description: The connector index status. + enum: + - green + - non-existent + - red + - yellow + ml_config_index_status: type: string - session_token: + description: The config index status. + enum: + - green + - non-existent + - red + - yellow + ml_task_index_status: type: string - additionalProperties: true + description: The task index status. + enum: + - green + - non-existent + - red + - yellow + ml_connector_count: + type: integer + format: int64 + description: The connector count. + ml_model_index_status: + type: string + description: The model index status. + enum: + - green + - non-existent + - red + - yellow + ml_controller_index_status: + type: string + description: The controller index status. + enum: + - green + - non-existent + - red + - yellow + nodes: + $ref: '#/components/schemas/ml._common___NodeStats' + ml._common___Guardrails: + type: object + properties: + type: + type: string + description: The guardrails type. + enum: + - local_regex + - model + input_guardrail: + $ref: '#/components/schemas/ml._common___GuardrailsInputOutput' + output_guardrail: + $ref: '#/components/schemas/ml._common___GuardrailsInputOutput' + stop_words: + $ref: '#/components/schemas/_common.analysis___StopWords' + index_name: + $ref: '#/components/schemas/_common___IndexName' + source_fields: + $ref: '#/components/schemas/_common___Fields' + regex: + type: object + description: The regex used for input/output validation. + model_id: + type: string + description: The model ID. + response_filter: + type: string + description: The response filter. + response_validation_regex: + type: string + description: The response validation regex. + ml._common___GuardrailsInputOutput: + type: object + properties: + model_id: + type: string + description: The model ID. + response_validation_regex: + type: string + description: The response validation regex. ml._common___Headers: type: object properties: @@ -51529,6 +55907,7 @@ components: properties: value: type: integer + format: int64 description: The total number of hits. relation: type: string @@ -51536,6 +55915,43 @@ components: required: - relation - value + ml._common___InferenceResults: + type: object + properties: + output: + type: array + items: + $ref: '#/components/schemas/ml._common___Output' + ml._common___InputQuery: + type: object + properties: + _source: + type: array + items: + type: string + description: The source fields + size: + type: integer + format: int64 + description: The size of the query. + query: + $ref: '#/components/schemas/ml._common___Query' + ml._common___Key: + type: object + description: The key. + properties: + gte: + type: number + description: Greater than or equal to. + lte: + type: number + description: Less than or equal to. + gt: + type: number + description: Greater than. + lt: + type: number + description: Less than. ml._common___LLM: type: object properties: @@ -51543,26 +55959,182 @@ components: type: string parameters: $ref: '#/components/schemas/ml._common___Parameters' - ml._common___Memory: + ml._common___Match: type: object + description: Match query. properties: - type: + description: type: string - ml._common___ModelGroup: + description: The description. + additionalProperties: true + ml._common___MatchAllQuery: + type: object + description: The match all query. + properties: {} + ml._common___Memory: type: object properties: - name: + type: type: string - description: The model group name. + memory_id: + $ref: '#/components/schemas/_common___Name' + create_time: + type: string + format: date-time + description: The create time. + updated_time: + type: string + format: date-time + description: The updated time. + name: + $ref: '#/components/schemas/_common___Name' + user: + type: string + description: The username of the user. + additional_info: + $ref: '#/components/schemas/ml._common___AdditionalInfo' + ml._common___Message: + type: object + properties: + memory_id: + $ref: '#/components/schemas/_common___Name' + message_id: + $ref: '#/components/schemas/_common___Name' + create_time: + type: string + format: date-time + description: The create time. + input: + type: + - 'null' + - string + description: The question in the message. + prompt_template: + type: + - 'null' + - string + description: The prompt template. + response: + type: + - 'null' + - string + description: The answer to the question. + origin: + type: + - 'null' + - string + description: The system name that generated the response. + additional_info: + $ref: '#/components/schemas/ml._common___AdditionalInfo' + parent_message_id: + type: + - 'null' + - string + description: The parent message ID. + trace_number: + type: integer + format: int64 + description: The trace number. + ml._common___Model: + type: object + properties: + name: + type: string + description: The model name. + model_group_id: + type: string + description: The model group ID. + algorithm: + type: string + description: The algorithm. + model_version: + type: string + description: The model version. + model_format: + $ref: '#/components/schemas/ml._common___ModelFormat' + model_state: + type: string + description: The model state. + enum: + - DEPLOYED + - DEPLOYING + - DEPLOY_FAILED + - PARTIALLY_DEPLOYED + - REGISTERED + - REGISTERING + - UNDEPLOYED + model_content_size_in_bytes: + type: integer + format: int64 + description: The model content size in bytes. + model_content_hash_value: + type: string + description: The model content hash value. + model_config: + $ref: '#/components/schemas/ml._common___ModelConfig' + created_time: + type: integer + format: int64 + description: The created time. + last_updated_time: + type: integer + format: int64 + description: The last updated time. + last_registered_time: + type: integer + format: int64 + description: The last registered time. + total_chunks: + type: integer + format: int64 + description: The total chunks. + is_hidden: + type: boolean + description: Whether the model is hidden. + required: + - model_state + ml._common___ModelConfig: + type: object + properties: + all_config: + type: string + description: The all config. + model_type: + type: string + description: The model type. + embedding_dimension: + type: integer + format: int64 + description: The embedding dimension. + framework_type: + type: string + description: The framework type. + ml._common___ModelFormat: + type: string + enum: + - ONNX + - TORCH_SCRIPT + ml._common___ModelGroup: + type: object + properties: + name: + type: string + description: The model group name. latest_version: type: integer description: The latest version. description: type: string description: The model group description. + owner: + $ref: '#/components/schemas/ml._common___Owner' access: type: string description: The model group access. + enum: + - private + - public + - restricted created_time: type: integer format: int64 @@ -51586,34 +56158,398 @@ components: required: - model_group_id - status + ml._common___ModelProfile: + type: object + properties: + model_state: + type: string + description: The model state. + enum: + - DEPLOYED + - DEPLOYING + - DEPLOY_FAILED + - PARTIALLY_DEPLOYED + - REGISTERED + - REGISTERING + - UNDEPLOYED + predictor: + type: string + description: The predictor. + worker_nodes: + type: array + items: + $ref: '#/components/schemas/_common___NodeIds' + predict_request_stats: + $ref: '#/components/schemas/ml._common___PredictRequestStats' + target_worker_nodes: + type: array + items: + $ref: '#/components/schemas/_common___NodeIds' + memory_size_estimation_cpu: + type: integer + format: int64 + description: The estimated memory size in CPU. + memory_size_estimation_gpu: + type: integer + format: int64 + description: The estimated memory size in GPU. + deploy: + $ref: '#/components/schemas/ml._common___ModelStats' + register: + $ref: '#/components/schemas/ml._common___ModelStats' + undeploy: + $ref: '#/components/schemas/ml._common___ModelStats' + predict: + $ref: '#/components/schemas/ml._common___ModelStats' + train: + $ref: '#/components/schemas/ml._common___ModelStats' + train_predict: + $ref: '#/components/schemas/ml._common___ModelStats' + ml._common___Models: + type: object + additionalProperties: + $ref: '#/components/schemas/ml._common___ModelProfile' + ml._common___ModelStats: + type: object + properties: + ml_action_request_count: + type: integer + format: int64 + description: The request count. + ml_action_failure_count: + type: integer + format: int64 + description: The failure count. + ml_executing_task_count: + type: integer + format: int64 + description: The executing task count. + ml._common___Nested: + type: object + description: The nested filter. + properties: + query: + $ref: '#/components/schemas/ml._common___Query' + path: + $ref: '#/components/schemas/_common___Field' + ignore_unmapped: + type: boolean + description: Whether to ignore unmapped fields. + score_mode: + type: string + description: The score mode. + enum: + - avg + - max + - min + - none + - sum + boost: + type: number + description: Adjust the relevance score of a match. + ml._common___Node: + type: object + properties: + tasks: + $ref: '#/components/schemas/ml._common___Tasks' + models: + $ref: '#/components/schemas/ml._common___Models' + ml._common___Nodes: + type: object + additionalProperties: + $ref: '#/components/schemas/ml._common___Node' + ml._common___NodeStats: + type: object + additionalProperties: + $ref: '#/components/schemas/ml._common___NodeStatsDetails' + ml._common___NodeStatsDetails: + type: object + properties: + ml_deployed_model_count: + type: integer + format: int64 + description: The deployed model count. + ml_jvm_heap_usage: + type: integer + format: int64 + description: The JVM heap usage. + ml_failure_count: + type: integer + format: int64 + description: The failure count. + ml_executing_task_count: + type: integer + format: int64 + description: The executing task count. + ml_circuit_breaker_trigger_count: + type: integer + format: int64 + description: The circuit breaker trigger count. + ml_request_count: + type: integer + format: int64 + description: The request count. + algorithms: + $ref: '#/components/schemas/ml._common___Algorithms' + models: + $ref: '#/components/schemas/ml._common___Models' + ml._common___Output: + type: object + properties: + name: + type: string + description: The output name. + data_type: + type: string + description: The output data type. + enum: + - BOOLEAN + - FLOAT16 + - FLOAT32 + - FLOAT64 + - INT32 + - INT64 + - INT8 + - STRING + - UINT8 + - UNKNOWN + shape: + type: array + items: + type: integer + format: int64 + description: The output shape. + data: + type: array + items: + type: number + format: double + description: The output data. + byte_buffer: + $ref: '#/components/schemas/ml._common___ByteBuffer' + result: + type: string + description: The output result. + required: + - data + ml._common___Owner: + type: object + properties: + name: + $ref: '#/components/schemas/_common___Name' + backend_roles: + type: array + items: + type: string + description: The backend roles. + roles: + type: array + items: + type: string + description: The roles. + custom_attribute_names: + type: array + items: + type: string + description: The custom attribute names. + user_requested_tenant: + type: + - 'null' + - string + description: The user requested tenant. + required: + - name + ml._common___OwnerNameKeyword: + type: object + description: The owner name keyword. + properties: + value: + $ref: '#/components/schemas/_common___FieldValue' + boost: + type: number + description: Adjust the relevance score of a match. ml._common___Parameters: type: object additionalProperties: true - ml._common___RegisterAgentsRequest: + ml._common___PredictionResult: + type: object + properties: + column_metas: + type: array + items: + $ref: '#/components/schemas/ml._common___ColumnMeta' + rows: + type: array + items: + $ref: '#/components/schemas/ml._common___Rows' + ml._common___PredictModelOutput: type: object properties: name: type: string - type: - type: string - description: + description: The output name. + data_type: type: string - tools: + description: The output data type. + enum: + - BOOLEAN + - FLOAT16 + - FLOAT32 + - FLOAT64 + - INT32 + - INT64 + - INT8 + - STRING + - UINT8 + - UNKNOWN + shape: type: array items: - $ref: '#/components/schemas/ml._common___ToolItems' - parameters: - $ref: '#/components/schemas/ml._common___Parameters' - app_type: + type: integer + format: int64 + description: The output shape. + data: + type: array + items: + type: number + format: double + description: The output data. + byte_buffer: + $ref: '#/components/schemas/ml._common___ByteBuffer' + required: + - data + ml._common___PredictModelResponse: + type: object + properties: + inference_results: + type: array + items: + $ref: '#/components/schemas/ml._common___PredictModelResult' + ml._common___PredictModelResult: + type: object + properties: + output: + type: array + items: + $ref: '#/components/schemas/ml._common___PredictModelOutput' + ml._common___PredictRequestStats: + type: object + properties: + count: + type: integer + format: int64 + description: The total predict requests on this node. + max: + type: number + format: double + description: The maximum latency in milliseconds. + min: + type: number + format: double + description: The minimum latency in milliseconds. + average: + type: number + format: double + description: The average latency in milliseconds. + p50: + type: number + format: double + description: The 50th percentile latency in milliseconds. + p90: + type: number + format: double + description: The 90th percentile latency in milliseconds. + p99: + type: number + format: double + description: The 99th percentile latency in milliseconds. + ml._common___PredictResponse: + type: object + properties: + inference_results: + type: array + items: + $ref: '#/components/schemas/ml._common___InferenceResults' + status: + $ref: '#/components/schemas/ml._common___Status' + prediction_result: + $ref: '#/components/schemas/ml._common___PredictionResult' + ml._common___ProfileRequest: + type: object + properties: + node_ids: + type: array + items: + $ref: '#/components/schemas/_common___Id' + model_ids: + type: array + items: + $ref: '#/components/schemas/_common___Id' + task_ids: + type: array + items: + $ref: '#/components/schemas/_common___Id' + return_all_tasks: + type: boolean + description: Whether to return all tasks. + return_all_models: + type: boolean + description: Whether to return all models. + ml._common___Query: + type: object + description: The query. + properties: + bool: + $ref: '#/components/schemas/ml._common___BoolQuery' + match: + $ref: '#/components/schemas/ml._common___Match' + match_all: + $ref: '#/components/schemas/ml._common___MatchAllQuery' + term: + $ref: '#/components/schemas/ml._common___Term' + additionalProperties: true + ml._common___Range: + type: object + description: The filter range. + properties: + k1: + $ref: '#/components/schemas/ml._common___Key' + k2: + $ref: '#/components/schemas/ml._common___Key' + k3: + $ref: '#/components/schemas/ml._common___Key' + ml._common___RateLimiter: + type: object + properties: + limit: + description: The maximum limit. + $ref: '#/components/schemas/_common___StringifiedDouble' + unit: type: string - memory: - $ref: '#/components/schemas/ml._common___Memory' - llm: - $ref: '#/components/schemas/ml._common___LLM' + description: The unit of time. + enum: + - DAYS + - HOURS + - MICROSECONDS + - MILLISECONDS + - MINUTES + - NANOSECONDS + - SECONDS required: - - name - - type - ml._common___SearchModelsHits: + - limit + - unit + ml._common___Rows: + type: object + properties: + values: + type: array + items: + $ref: '#/components/schemas/ml._common___Values' + ml._common___SearchAgentsResponse: + $ref: '#/components/schemas/ml._common___SearchResponse' + ml._common___SearchConnectorsResponse: + $ref: '#/components/schemas/ml._common___SearchResponse' + ml._common___SearchHits: type: object properties: total: @@ -51621,44 +56557,443 @@ components: hits: type: array items: - $ref: '#/components/schemas/ml._common___SearchModelsHitsHit' + $ref: '#/components/schemas/ml._common___SearchHitsHit' + max_score: + type: + - 'null' + - number + description: The maximum score. required: - hits - total - ml._common___SearchModelsHitsHit: + ml._common___SearchHitsHit: type: object properties: + _version: + $ref: '#/components/schemas/_common___VersionNumber' + _seq_no: + $ref: '#/components/schemas/_common___SequenceNumber' + _primary_term: + type: integer + description: The primary term. _index: - type: string - description: The index. + $ref: '#/components/schemas/_common___IndexName' _id: - type: string - description: The hit ID. + $ref: '#/components/schemas/_common___Id' + _score: + type: + - 'null' + - number + description: The score. + _source: + $ref: '#/components/schemas/ml._common___Source' model_id: - type: string - description: The model ID. - required: - - _id - - model_id - ml._common___SearchModelsQuery: - type: object - properties: - query: - type: object - description: The query. - size: - type: integer - description: The number of models to return. + $ref: '#/components/schemas/_common___Name' + sort: + type: array + items: + type: number + format: float + description: The sort values. required: - - query - - size + - _score + ml._common___SearchMemoryResponse: + $ref: '#/components/schemas/ml._common___SearchResponse' + ml._common___SearchMessageResponse: + $ref: '#/components/schemas/ml._common___SearchResponse' + ml._common___SearchModelGroupsResponse: + $ref: '#/components/schemas/ml._common___SearchResponse' ml._common___SearchModelsResponse: + $ref: '#/components/schemas/ml._common___SearchResponse' + ml._common___SearchResponse: type: object properties: + took: + type: integer + description: The time taken to execute the search. + timed_out: + type: boolean + description: Whether the search timed out. + _shards: + $ref: '#/components/schemas/_common___ShardStatistics' hits: - $ref: '#/components/schemas/ml._common___SearchModelsHits' + $ref: '#/components/schemas/ml._common___SearchHits' required: - hits + ml._common___SearchTasksResponse: + $ref: '#/components/schemas/ml._common___SearchResponse' + ml._common___Sort: + type: object + description: Sort query. + properties: + algorithm: + $ref: '#/components/schemas/ml._common___SortOrder' + auto_redeploy_retry_times: + $ref: '#/components/schemas/ml._common___SortOrder' + chunk_number: + $ref: '#/components/schemas/ml._common___SortOrder' + created_time: + $ref: '#/components/schemas/ml._common___SortOrder' + current_worker_node_count: + $ref: '#/components/schemas/ml._common___SortOrder' + deploy_to_all_nodes: + $ref: '#/components/schemas/ml._common___SortOrder' + is_hidden: + $ref: '#/components/schemas/ml._common___SortOrder' + last_registered_time: + $ref: '#/components/schemas/ml._common___SortOrder' + last_updated_time: + $ref: '#/components/schemas/ml._common___SortOrder' + model_content_hash_value: + $ref: '#/components/schemas/ml._common___SortOrder' + model_content_size_in_bytes: + $ref: '#/components/schemas/ml._common___SortOrder' + model_format: + $ref: '#/components/schemas/ml._common___SortOrder' + model_group_id: + $ref: '#/components/schemas/ml._common___SortOrder' + model_state: + $ref: '#/components/schemas/ml._common___SortOrder' + model_version: + $ref: '#/components/schemas/ml._common___SortOrder' + planning_worker_nodes: + $ref: '#/components/schemas/ml._common___SortOrder' + planning_worker_node_count: + $ref: '#/components/schemas/ml._common___SortOrder' + total_chunks: + $ref: '#/components/schemas/ml._common___SortOrder' + _index: + $ref: '#/components/schemas/ml._common___SortOrder' + _id: + $ref: '#/components/schemas/ml._common___SortOrder' + _seq_no: + $ref: '#/components/schemas/ml._common___SortOrder' + _score: + $ref: '#/components/schemas/ml._common___SortOrder' + ml._common___SortAgent: + type: object + description: The sort agent query. + properties: + created_time: + $ref: '#/components/schemas/ml._common___SortOrder' + is_hidden: + $ref: '#/components/schemas/ml._common___SortOrder' + last_updated_time: + $ref: '#/components/schemas/ml._common___SortOrder' + parameters: + $ref: '#/components/schemas/ml._common___SortOrder' + tools: + $ref: '#/components/schemas/ml._common___SortOrder' + type: + $ref: '#/components/schemas/ml._common___SortOrder' + _id: + $ref: '#/components/schemas/ml._common___SortOrder' + _index: + $ref: '#/components/schemas/ml._common___SortOrder' + _score: + $ref: '#/components/schemas/ml._common___SortOrder' + _seq_no: + $ref: '#/components/schemas/ml._common___SortOrder' + ml._common___SortMemory: + type: object + description: The sort memory query. + properties: + additional_info: + $ref: '#/components/schemas/ml._common___SortOrder' + application_time: + $ref: '#/components/schemas/ml._common___SortOrder' + create_time: + $ref: '#/components/schemas/ml._common___SortOrder' + updated_time: + $ref: '#/components/schemas/ml._common___SortOrder' + user: + $ref: '#/components/schemas/ml._common___SortOrder' + _id: + $ref: '#/components/schemas/ml._common___SortOrder' + _index: + $ref: '#/components/schemas/ml._common___SortOrder' + _score: + $ref: '#/components/schemas/ml._common___SortOrder' + _seq_no: + $ref: '#/components/schemas/ml._common___SortOrder' + ml._common___SortMessage: + type: object + description: The sort message query. + properties: + additional_info: + $ref: '#/components/schemas/ml._common___SortOrder' + create_time: + $ref: '#/components/schemas/ml._common___SortOrder' + memory_id: + $ref: '#/components/schemas/ml._common___SortOrder' + origin: + $ref: '#/components/schemas/ml._common___SortOrder' + parent_message_id: + $ref: '#/components/schemas/ml._common___SortOrder' + trace_number: + $ref: '#/components/schemas/ml._common___SortOrder' + _id: + $ref: '#/components/schemas/ml._common___SortOrder' + _index: + $ref: '#/components/schemas/ml._common___SortOrder' + _score: + $ref: '#/components/schemas/ml._common___SortOrder' + _seq_no: + $ref: '#/components/schemas/ml._common___SortOrder' + ml._common___SortOrder: + type: object + description: The order of the sort. + properties: + order: + type: string + description: The order. + enum: + - asc + - desc + ml._common___Source: + type: object + properties: + last_deployed_time: + type: integer + format: int64 + description: The last deployed time. + model_version: + type: string + description: The model version. + version: + $ref: '#/components/schemas/_common___VersionString' + created_time: + type: integer + format: int64 + description: The created time. + chunk_number: + type: integer + format: int64 + description: The chunk number. + deploy_to_all_nodes: + type: boolean + description: Whether to deploy to all nodes. + is_hidden: + type: boolean + description: Whether the model is hidden. + model_id: + $ref: '#/components/schemas/_common___Name' + description: + type: string + description: The model description. + model_state: + type: string + description: The model state. + enum: + - DEPLOYED + - DEPLOYING + - DEPLOY_FAILED + - PARTIALLY_DEPLOYED + - REGISTERED + - REGISTERING + - UNDEPLOYED + model_content_size_in_bytes: + type: integer + format: int64 + description: The model content size in bytes. + model_content_hash_value: + type: string + description: The model content hash value. + planning_worker_node_count: + type: number + description: The planning worker node count. + model_config: + $ref: '#/components/schemas/ml._common___ModelConfig' + model_format: + $ref: '#/components/schemas/ml._common___ModelFormat' + model_task_type: + type: string + description: The model task type. + last_updated_time: + type: integer + format: int64 + description: The last updated time. + last_update_time: + type: integer + format: int64 + description: The last update time. + last_registered_time: + type: integer + format: int64 + description: The last registered time. + auto_redeploy_retry_times: + type: integer + format: int64 + description: The auto redeploy retry times. + name: + $ref: '#/components/schemas/_common___Name' + connector_id: + type: string + description: The connector ID. + current_worker_node_count: + type: number + description: The current worker node count. + model_group_id: + type: string + description: The model group ID. + planning_worker_nodes: + type: array + items: + $ref: '#/components/schemas/_common___NodeIds' + total_chunks: + type: integer + format: int64 + description: The total chunks. + algorithm: + type: string + description: The algorithm. + url: + type: string + description: The model URL. + backend_roles: + type: array + items: + type: string + description: The backend roles. + owner: + $ref: '#/components/schemas/ml._common___Owner' + access: + type: string + description: The model group access. + enum: + - private + - public + - restricted + latest_version: + type: integer + description: The latest version. + protocol: + type: string + description: The connector protocol. + enum: + - aws_sigv4 + - http + parameters: + $ref: '#/components/schemas/ml._common___Parameters' + actions: + type: array + items: + $ref: '#/components/schemas/ml._common___Action' + updated_time: + type: string + format: date-time + description: The updated time. + create_time: + anyOf: + - type: string + format: date-time + - type: integer + format: int64 + description: The create time. + application_type: + type: + - 'null' + - string + description: The application type. + additional_info: + $ref: '#/components/schemas/ml._common___AdditionalInfo' + user: + type: string + description: The username of the user. + input: + type: + - 'null' + - string + description: The question in the message. + memory_id: + $ref: '#/components/schemas/_common___Name' + trace_number: + type: + - 'null' + - string + description: The trace number. + response: + type: + - 'null' + - string + description: The answer to the question. + origin: + type: + - 'null' + - string + description: The system name that generated the response. + parent_message_id: + type: + - 'null' + - string + description: The parent message ID. + prompt_template: + type: + - 'null' + - string + description: The prompt template. + type: + type: string + description: The agent type + enum: + - conversational + - conversational_flow + - flow + tools: + type: array + items: + $ref: '#/components/schemas/ml._common___ToolItems' + memory: + $ref: '#/components/schemas/ml._common___Memory' + app_type: + type: string + description: The app type. + is_async: + type: boolean + description: Whether the task is asynchronous. + function_name: + $ref: '#/components/schemas/ml._common___FunctionName' + input_type: + type: string + description: The input type. + enum: + - DATA_FRAME + - QUESTION_ANSWERING + - REMOTE + - SEARCH_QUERY + - TEXT_DOCS + - TEXT_SIMILARITY + worker_node: + type: array + items: + $ref: '#/components/schemas/_common___NodeIds' + task_type: + type: string + description: Task type. + enum: + - BATCH_INGEST + - BATCH_PREDICTION + - DEPLOY_MODEL + - EXECUTION + - PREDICTION + - REGISTER_MODEL + - TRAINING + - TRAINING_AND_PREDICTION + state: + $ref: '#/components/schemas/ml._common___Status' + error: + type: string + description: The error message. + ml._common___Status: + type: string + description: The status. + enum: + - CANCELLED + - COMPLETED + - COMPLETED_WITH_ERROR + - CREATED + - FAILED + - RUNNING ml._common___Task: type: object properties: @@ -51670,19 +57005,27 @@ components: type: string enum: - CANCELLED + - CANCELLING - COMPLETED - COMPLETED_WITH_ERROR - CREATED + - EXPIRED - FAILED - RUNNING task_type: type: string description: Task type. enum: + - BATCH_INGEST + - BATCH_PREDICTION - DEPLOY_MODEL + - EXECUTION + - PREDICTION - REGISTER_MODEL + - TRAINING + - TRAINING_AND_PREDICTION function_name: - type: string + $ref: '#/components/schemas/ml._common___FunctionName' worker_node: type: array items: @@ -51699,16 +57042,102 @@ components: type: string required: - state - ml._common___ToolItems: + ml._common___Tasks: + type: object + additionalProperties: + $ref: '#/components/schemas/ml._common___Task' + ml._common___Term: type: object + description: Term to match the query. properties: + algorithm: + $ref: '#/components/schemas/ml._common___Algorithm' + _id: + type: array + items: + $ref: '#/components/schemas/_common___Id' + function_name: + $ref: '#/components/schemas/ml._common___FunctionName' + model_id: + $ref: '#/components/schemas/_common___Name' name: - type: string + $ref: '#/components/schemas/ml._common___OwnerNameKeyword' + owner.name.keyword: + $ref: '#/components/schemas/ml._common___OwnerNameKeyword' type: - type: string + $ref: '#/components/schemas/ml._common___Type' + ml._common___Tool: + type: object + properties: + name: + $ref: '#/components/schemas/_common___Name' + description: + type: string + description: The tool description. + type: + type: string + description: The tool type. + version: + $ref: '#/components/schemas/_common___VersionString' + ml._common___ToolItems: + type: object + properties: + name: + type: string + type: + type: string parameters: $ref: '#/components/schemas/ml._common___Parameters' + include_output_in_agent_response: + type: boolean additionalProperties: true + ml._common___TrainParameters: + type: object + properties: + centroids: + type: integer + format: int64 + description: The centroids. + iterations: + type: integer + format: int64 + description: The iterations. + distance_type: + type: string + description: The distance type. + enum: + - COSINE + - EUCLIDEAN + - L1 + ml._common___TrainPredictResponse: + type: object + properties: + status: + $ref: '#/components/schemas/ml._common___Status' + prediction_result: + $ref: '#/components/schemas/ml._common___PredictionResult' + required: + - status + ml._common___TrainResponse: + type: object + properties: + model_id: + $ref: '#/components/schemas/_common___Name' + status: + $ref: '#/components/schemas/ml._common___Status' + required: + - status + ml._common___Type: + type: object + description: The type. + properties: + value: + type: string + description: The agent type. + enum: + - conversational + - conversational_flow + - flow ml._common___UndeployModelNode: type: object properties: @@ -51722,443 +57151,1128 @@ components: additionalProperties: title: nodes $ref: '#/components/schemas/ml._common___UndeployModelNode' - nodes._common___AdaptiveSelection: + ml._common___UnloadModelNode: type: object properties: - avg_queue_size: - description: The exponentially weighted moving average queue size of search requests on the keyed node. - type: number - avg_response_time: - $ref: '#/components/schemas/_common___Duration' - avg_response_time_ns: - description: The exponentially weighted moving average response time, in nanoseconds, of search requests on the keyed node. - type: number - avg_service_time: - $ref: '#/components/schemas/_common___Duration' - avg_service_time_ns: - description: The exponentially weighted moving average service time, in nanoseconds, of search requests on the keyed node. - type: number - outgoing_searches: - description: The number of outstanding search requests to the keyed node from the node these stats are for. - type: number - rank: - description: The rank of this node; used for shard selection when routing search requests. - type: string - nodes._common___Breaker: + stats: + $ref: '#/components/schemas/ml._common___UnloadModelNodeStats' + ml._common___UnloadModelNodeStats: type: object - properties: - estimated_size: - $ref: '#/components/schemas/_common___HumanReadableByteCount' - estimated_size_in_bytes: - $ref: '#/components/schemas/_common___ByteCount' - limit_size: - $ref: '#/components/schemas/_common___HumanReadableByteCount' - limit_size_in_bytes: - $ref: '#/components/schemas/_common___ByteCount' - overhead: - description: A constant that all estimates for the circuit breaker are multiplied with to calculate a final estimate. - type: number - tripped: - description: Total number of times the circuit breaker has been triggered and prevented an out of memory error. - type: number - nodes._common___Cgroup: + additionalProperties: true + ml._common___UnloadModelResponse: type: object - properties: - cpuacct: - $ref: '#/components/schemas/nodes._common___CpuAcct' - cpu: - $ref: '#/components/schemas/nodes._common___CgroupCpu' - memory: - $ref: '#/components/schemas/nodes._common___CgroupMemory' - nodes._common___CgroupCpu: + additionalProperties: + title: nodes + $ref: '#/components/schemas/ml._common___UnloadModelNode' + ml._common___UpdateModelGroupResponse: type: object properties: - control_group: - description: The `cpu` control group to which the OpenSearch process belongs. + status: type: string - cfs_period_micros: - description: The period of time, in microseconds, for how regularly all tasks in the same cgroup as the OpenSearch process should have their access to CPU resources reallocated. - type: number - cfs_quota_micros: - description: The total amount of time, in microseconds, for which all tasks in the same cgroup as the OpenSearch process can run during one period `cfs_period_micros`. - type: number - stat: - $ref: '#/components/schemas/nodes._common___CgroupCpuStat' - nodes._common___CgroupCpuStat: + description: The status. + ml._common___Values: type: object properties: - number_of_elapsed_periods: - description: The number of reporting periods (as specified by `cfs_period_micros`) that have elapsed. - type: number - number_of_times_throttled: - description: The number of times all tasks in the same cgroup as the OpenSearch process have been throttled. + column_type: + type: string + description: The column type. + enum: + - BOOLEAN + - DOUBLE + - INTEGER + - STRING + value: type: number - time_throttled_nanos: - $ref: '#/components/schemas/_common___DurationValueUnitNanos' - nodes._common___CgroupMemory: + description: The value. + nodes._common___NodesResponseBase: type: object properties: - control_group: - description: The `memory` control group to which the OpenSearch process belongs. - type: string - limit_in_bytes: - description: |- - The maximum amount of user memory (including file cache) allowed for all tasks in the same cgroup as the OpenSearch process. - This value can be too big to store in a `long`, so is returned as a string so that the value returned can exactly match what the underlying operating system interface returns. - Any value that is too large to parse into a `long` almost certainly means no limit has been set for the cgroup. - type: string - usage_in_bytes: - description: |- - The total current memory usage by processes in the cgroup, in bytes, by all tasks in the same cgroup as the OpenSearch process. - This value is stored as a string for consistency with `limit_in_bytes`. - type: string - nodes._common___Client: + _nodes: + description: Contains statistics about the number of nodes selected by the request's node filters. + $ref: '#/components/schemas/_common___NodeStatistics' + nodes._common___SampleType: + type: string + description: The type to sample. + enum: + - block + - cpu + - wait + nodes.info___Metric: + type: string + enum: + - _all + - aggregations + - http + - indices + - ingest + - jvm + - os + - plugins + - process + - search_pipelines + - settings + - thread_pool + - transport + nodes.info___NodeInfo: type: object properties: - id: - description: Unique ID for the HTTP client. - type: number - agent: - description: |- - Reported agent for the HTTP client. - If unavailable, this property is not included in the response. - type: string - local_address: - description: Local address for the HTTP connection. + attributes: + type: object + additionalProperties: + type: string + build_flavor: type: string - remote_address: - description: Remote address for the HTTP connection. + build_hash: + description: Short hash of the last git commit in this release. type: string - last_uri: - description: The URI of the client's most recent request. + build_type: type: string - opened_time_millis: - description: Time at which the client opened the connection. - type: number - closed_time_millis: - description: Time at which the client closed the connection if the connection is closed. - type: number - last_request_time_millis: - description: Time of the most recent request from this client. - type: number - request_count: - description: Number of requests from this client. - type: number - request_size_bytes: + host: + $ref: '#/components/schemas/_common___Host' + http: + $ref: '#/components/schemas/nodes.info___NodeInfoHttp' + ip: + $ref: '#/components/schemas/_common___Ip' + jvm: + $ref: '#/components/schemas/nodes.info___NodeJvmInfo' + name: + $ref: '#/components/schemas/_common___Name' + network: + $ref: '#/components/schemas/nodes.info___NodeInfoNetwork' + os: + $ref: '#/components/schemas/nodes.info___NodeOperatingSystemInfo' + plugins: + type: array + items: + $ref: '#/components/schemas/_common___PluginStats' + process: + $ref: '#/components/schemas/nodes.info___NodeProcessInfo' + roles: + $ref: '#/components/schemas/_common___NodeRoles' + settings: + $ref: '#/components/schemas/nodes.info___NodeInfoSettings' + thread_pool: + type: object + additionalProperties: + $ref: '#/components/schemas/nodes.info___NodeThreadPoolInfo' + total_indexing_buffer: + description: Total heap allowed to be used to hold recently indexed documents before they must be written to disk. This size is a shared pool across all shards on this node, and is controlled by Indexing Buffer settings. $ref: '#/components/schemas/_common___ByteCount' - x_opaque_id: - description: |- - Value from the client's `x-opaque-id` HTTP header. - If unavailable, this property is not included in the response. + total_indexing_buffer_in_bytes: + $ref: '#/components/schemas/_common___HumanReadableByteCount' + transport: + $ref: '#/components/schemas/nodes.info___NodeInfoTransport' + transport_address: + $ref: '#/components/schemas/_common___TransportAddress' + version: + $ref: '#/components/schemas/_common___VersionString' + modules: + type: array + items: + $ref: '#/components/schemas/_common___PluginStats' + ingest: + $ref: '#/components/schemas/nodes.info___NodeInfoIngest' + aggregations: + type: object + additionalProperties: + $ref: '#/components/schemas/nodes.info___NodeInfoAggregation' + search_pipelines: + $ref: '#/components/schemas/nodes.info___NodeInfoSearchPipelines' + required: + - build_hash + - build_type + - name + - roles + - version + nodes.info___NodeInfoAction: + type: object + properties: + destructive_requires_name: type: string - nodes._common___ClusterAppliedStats: + required: + - destructive_requires_name + nodes.info___NodeInfoAggregation: type: object properties: - recordings: + types: type: array items: - $ref: '#/components/schemas/nodes._common___Recording' - nodes._common___ClusterStateOverallStats: + type: string + required: + - types + nodes.info___NodeInfoBootstrap: type: object properties: - update_count: - type: number - total_time_in_millis: - $ref: '#/components/schemas/_common___DurationValueUnitMillis' - failed_count: - type: number - nodes._common___ClusterStateQueue: + memory_lock: + type: string + required: + - memory_lock + nodes.info___NodeInfoClient: type: object properties: - total: - description: Total number of cluster states in queue. - type: number - pending: - description: Number of pending cluster states in queue. - type: number - committed: - description: Number of committed cluster states in queue. - type: number - nodes._common___ClusterStateStats: + type: + type: string + required: + - type + nodes.info___NodeInfoDiscovery: type: object properties: - overall: - $ref: '#/components/schemas/nodes._common___ClusterStateOverallStats' - nodes._common___ClusterStateUpdate: + type: + type: string + seed_hosts: + type: string + nodes.info___NodeInfoHttp: type: object properties: - count: - description: The number of cluster state update attempts that did not change the cluster state since the node started. - type: number - computation_time: - $ref: '#/components/schemas/_common___Duration' - computation_time_millis: - $ref: '#/components/schemas/_common___DurationValueUnitMillis' - publication_time: - $ref: '#/components/schemas/_common___Duration' - publication_time_millis: - $ref: '#/components/schemas/_common___DurationValueUnitMillis' - context_construction_time: - $ref: '#/components/schemas/_common___Duration' - context_construction_time_millis: - $ref: '#/components/schemas/_common___DurationValueUnitMillis' - commit_time: - $ref: '#/components/schemas/_common___Duration' - commit_time_millis: - $ref: '#/components/schemas/_common___DurationValueUnitMillis' - completion_time: - $ref: '#/components/schemas/_common___Duration' - completion_time_millis: - $ref: '#/components/schemas/_common___DurationValueUnitMillis' - master_apply_time: - $ref: '#/components/schemas/_common___Duration' - master_apply_time_millis: - $ref: '#/components/schemas/_common___DurationValueUnitMillis' - notification_time: - $ref: '#/components/schemas/_common___Duration' - notification_time_millis: - $ref: '#/components/schemas/_common___DurationValueUnitMillis' + bound_address: + type: array + items: + type: string + max_content_length: + $ref: '#/components/schemas/_common___HumanReadableByteCount' + max_content_length_in_bytes: + $ref: '#/components/schemas/_common___ByteCount' + publish_address: + type: string required: - - count - nodes._common___Context: + - bound_address + - max_content_length_in_bytes + - publish_address + nodes.info___NodeInfoIngest: type: object properties: - context: + processors: + type: array + items: + $ref: '#/components/schemas/nodes.info___NodeInfoIngestProcessor' + required: + - processors + nodes.info___NodeInfoIngestDownloader: + type: object + properties: + enabled: type: string - compilations: - type: number - cache_evictions: - type: number - compilation_limit_triggered: - type: number - nodes._common___Cpu: + required: + - enabled + nodes.info___NodeInfoIngestInfo: type: object properties: - percent: - $ref: '#/components/schemas/_common___PercentageNumber' - sys: - $ref: '#/components/schemas/_common___Duration' - sys_in_millis: - $ref: '#/components/schemas/_common___DurationValueUnitMillis' - total: - $ref: '#/components/schemas/_common___Duration' - total_in_millis: - $ref: '#/components/schemas/_common___DurationValueUnitMillis' - user: - $ref: '#/components/schemas/_common___Duration' - user_in_millis: - $ref: '#/components/schemas/_common___DurationValueUnitMillis' - load_average: - type: object - additionalProperties: - type: number - nodes._common___CpuAcct: + downloader: + $ref: '#/components/schemas/nodes.info___NodeInfoIngestDownloader' + required: + - downloader + nodes.info___NodeInfoIngestProcessor: type: object properties: - control_group: - description: The `cpuacct` control group to which the OpenSearch process belongs. + type: type: string - usage_nanos: - $ref: '#/components/schemas/_common___DurationValueUnitNanos' - nodes._common___DataPathStats: + required: + - type + nodes.info___NodeInfoJvmMemory: type: object properties: - available: + direct_max: $ref: '#/components/schemas/_common___HumanReadableByteCount' - available_in_bytes: + direct_max_in_bytes: $ref: '#/components/schemas/_common___ByteCount' - cache_reserved: - x-version-added: '2.7' + heap_init: $ref: '#/components/schemas/_common___HumanReadableByteCount' - cache_reserved_in_bytes: - x-version-added: '2.7' + heap_init_in_bytes: $ref: '#/components/schemas/_common___ByteCount' - disk_queue: - type: string - disk_reads: - type: number - disk_read_size: + heap_max: $ref: '#/components/schemas/_common___HumanReadableByteCount' - disk_read_size_in_bytes: + heap_max_in_bytes: $ref: '#/components/schemas/_common___ByteCount' - disk_writes: - type: number - disk_write_size: + non_heap_init: $ref: '#/components/schemas/_common___HumanReadableByteCount' - disk_write_size_in_bytes: + non_heap_init_in_bytes: $ref: '#/components/schemas/_common___ByteCount' - free: + non_heap_max: $ref: '#/components/schemas/_common___HumanReadableByteCount' - free_in_bytes: + non_heap_max_in_bytes: $ref: '#/components/schemas/_common___ByteCount' - mount: - description: 'Mount point of the file store (for example: `/dev/sda2`).' - type: string - path: - description: Path to the file store. - type: string + required: + - direct_max_in_bytes + - heap_init_in_bytes + - heap_max_in_bytes + - non_heap_init_in_bytes + - non_heap_max_in_bytes + nodes.info___NodeInfoMemory: + type: object + properties: total: $ref: '#/components/schemas/_common___HumanReadableByteCount' total_in_bytes: $ref: '#/components/schemas/_common___ByteCount' - type: - description: 'Type of the file store (ex: ext4).' - type: string - nodes._common___Discovery: + required: + - total + - total_in_bytes + nodes.info___NodeInfoNetwork: type: object 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: - description: |- - Contains low-level statistics about how long various activities took during cluster state updates while the node was the elected master. - Omitted if the node is not master-eligible. - Every field whose name ends in `_time` within this object is also represented as a raw number of milliseconds in a field whose name ends in `_time_millis`. - The human-readable fields with a `_time` suffix are only returned if requested with the `?human=true` query parameter. - type: object - additionalProperties: - $ref: '#/components/schemas/nodes._common___ClusterStateUpdate' - serialized_cluster_states: - $ref: '#/components/schemas/nodes._common___SerializedClusterState' - cluster_applier_stats: - $ref: '#/components/schemas/nodes._common___ClusterAppliedStats' - nodes._common___ExtendedMemoryStats: - allOf: - - $ref: '#/components/schemas/nodes._common___MemoryStats' - - type: object - properties: - free_percent: - $ref: '#/components/schemas/_common___PercentageNumber' - used_percent: - $ref: '#/components/schemas/_common___PercentageNumber' - nodes._common___FileSystem: + primary_interface: + $ref: '#/components/schemas/nodes.info___NodeInfoNetworkInterface' + refresh_interval: + type: integer + format: int32 + required: + - primary_interface + - refresh_interval + nodes.info___NodeInfoNetworkInterface: type: object properties: - data: - description: List of all file stores. - type: array - items: - $ref: '#/components/schemas/nodes._common___DataPathStats' - timestamp: - description: |- - Last time the file stores statistics were refreshed. - Recorded in milliseconds since the Unix Epoch. - type: number - total: - $ref: '#/components/schemas/nodes._common___FileSystemTotal' - io_stats: - $ref: '#/components/schemas/nodes._common___IoStats' - nodes._common___FileSystemTotal: + address: + type: string + mac_address: + type: string + name: + $ref: '#/components/schemas/_common___Name' + required: + - address + - mac_address + - name + nodes.info___NodeInfoOSCPU: type: object properties: - available: - $ref: '#/components/schemas/_common___HumanReadableByteCount' - available_in_bytes: - $ref: '#/components/schemas/_common___ByteCount' - free: - $ref: '#/components/schemas/_common___HumanReadableByteCount' - free_in_bytes: - $ref: '#/components/schemas/_common___ByteCount' - total: - $ref: '#/components/schemas/_common___HumanReadableByteCount' - total_in_bytes: - $ref: '#/components/schemas/_common___ByteCount' - cache_reserved: - x-version-added: '2.7' + cache_size: $ref: '#/components/schemas/_common___HumanReadableByteCount' - cache_reserved_in_bytes: - x-version-added: '2.7' + cache_size_in_bytes: $ref: '#/components/schemas/_common___ByteCount' - nodes._common___GarbageCollector: - type: object - properties: - collectors: - description: Contains statistics about JVM garbage collectors for the node. - type: object - additionalProperties: - $ref: '#/components/schemas/nodes._common___GarbageCollectorTotal' - nodes._common___GarbageCollectorTotal: - type: object - properties: - collection_count: - description: Total number of JVM garbage collectors that collect objects. - type: number - collection_time: - description: Total time spent by JVM collecting objects. + cores_per_socket: + type: integer + format: int32 + mhz: + type: integer + format: int32 + model: type: string - collection_time_in_millis: - description: Total time, in milliseconds, spent by JVM collecting objects. - type: number - nodes._common___Http: + total_cores: + type: integer + format: int32 + total_sockets: + type: integer + format: int32 + vendor: + type: string + required: + - cache_size + - cache_size_in_bytes + - cores_per_socket + - mhz + - model + - total_cores + - total_sockets + - vendor + nodes.info___NodeInfoPath: type: object properties: - current_open: - description: Current number of open HTTP connections for the node. - type: number - total_opened: - description: Total number of HTTP connections opened for the node. - type: number - clients: - description: |- - Information on current and recently-closed HTTP client connections. - Clients that have been closed longer than the `http.client_stats.closed_channels.max_age` setting will not be represented here. + logs: + type: string + home: + type: string + repo: + type: array + items: + type: string + data: type: array items: - $ref: '#/components/schemas/nodes._common___Client' - nodes._common___IndexingPressure: + type: string + required: + - home + - logs + nodes.info___NodeInfoRepositories: type: object properties: + url: + $ref: '#/components/schemas/nodes.info___NodeInfoRepositoriesUrl' + required: + - url + nodes.info___NodeInfoRepositoriesUrl: + type: object + properties: + allowed_urls: + type: string + required: + - allowed_urls + nodes.info___NodeInfoScript: + type: object + properties: + allowed_types: + type: string + disable_max_compilations_rate: + type: string + required: + - allowed_types + - disable_max_compilations_rate + nodes.info___NodeInfoSearch: + type: object + properties: + remote: + $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' + nodes.info___NodeInfoSearchRemote: + type: object + properties: + connect: + type: string + required: + - connect + nodes.info___NodeInfoSettings: + type: object + properties: + cluster: + $ref: '#/components/schemas/nodes.info___NodeInfoSettingsCluster' + node: + $ref: '#/components/schemas/nodes.info___NodeInfoSettingsNode' + path: + $ref: '#/components/schemas/nodes.info___NodeInfoPath' + repositories: + $ref: '#/components/schemas/nodes.info___NodeInfoRepositories' + discovery: + $ref: '#/components/schemas/nodes.info___NodeInfoDiscovery' + action: + $ref: '#/components/schemas/nodes.info___NodeInfoAction' + client: + $ref: '#/components/schemas/nodes.info___NodeInfoClient' + http: + $ref: '#/components/schemas/nodes.info___NodeInfoSettingsHttp' + bootstrap: + $ref: '#/components/schemas/nodes.info___NodeInfoBootstrap' + transport: + $ref: '#/components/schemas/nodes.info___NodeInfoSettingsTransport' + network: + $ref: '#/components/schemas/nodes.info___NodeInfoSettingsNetwork' + script: + $ref: '#/components/schemas/nodes.info___NodeInfoScript' + search: + $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 + - transport + nodes.info___NodeInfoSettingsCluster: + type: object + properties: + name: + $ref: '#/components/schemas/_common___Name' + routing: + $ref: '#/components/schemas/indices._common___IndexRouting' + election: + $ref: '#/components/schemas/nodes.info___NodeInfoSettingsClusterElection' + initial_cluster_manager_nodes: + $ref: '#/components/schemas/_common___StringOrStringArray' + initial_master_nodes: + $ref: '#/components/schemas/_common___StringOrStringArray' + deprecation_indexing: + $ref: '#/components/schemas/nodes.info___NodeInfoSettingsDeprecationIndexing' + required: + - name + nodes.info___NodeInfoSettingsClusterElection: + type: object + properties: + strategy: + $ref: '#/components/schemas/_common___Name' + required: + - strategy + nodes.info___NodeInfoSettingsDeprecationIndexing: + type: object + properties: + enabled: + $ref: '#/components/schemas/_common___StringifiedBoolean' + required: + - enabled + nodes.info___NodeInfoSettingsHttp: + type: object + properties: + type: + $ref: '#/components/schemas/nodes.info___NodeInfoSettingsHttpType' + type.default: + type: string + compression: + $ref: '#/components/schemas/_common___StringifiedBoolean' + port: + $ref: '#/components/schemas/_common___StringifiedInteger' + required: + - type + nodes.info___NodeInfoSettingsHttpType: + oneOf: + - title: type + type: string + - title: config + $ref: '#/components/schemas/nodes.info___NodeInfoSettingsHttpTypeConfig' + nodes.info___NodeInfoSettingsHttpTypeConfig: + type: object + properties: + default: + type: string + nodes.info___NodeInfoSettingsIndex: + type: object + properties: + 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: + attachment: + $ref: '#/components/schemas/nodes.info___NodeInfoIngestInfo' + append: + $ref: '#/components/schemas/nodes.info___NodeInfoIngestInfo' + csv: + $ref: '#/components/schemas/nodes.info___NodeInfoIngestInfo' + convert: + $ref: '#/components/schemas/nodes.info___NodeInfoIngestInfo' + date: + $ref: '#/components/schemas/nodes.info___NodeInfoIngestInfo' + date_index_name: + $ref: '#/components/schemas/nodes.info___NodeInfoIngestInfo' + dot_expander: + $ref: '#/components/schemas/nodes.info___NodeInfoIngestInfo' + enrich: + $ref: '#/components/schemas/nodes.info___NodeInfoIngestInfo' + fail: + $ref: '#/components/schemas/nodes.info___NodeInfoIngestInfo' + foreach: + $ref: '#/components/schemas/nodes.info___NodeInfoIngestInfo' + json: + $ref: '#/components/schemas/nodes.info___NodeInfoIngestInfo' + user_agent: + $ref: '#/components/schemas/nodes.info___NodeInfoIngestInfo' + kv: + $ref: '#/components/schemas/nodes.info___NodeInfoIngestInfo' + geoip: + $ref: '#/components/schemas/nodes.info___NodeInfoIngestInfo' + grok: + $ref: '#/components/schemas/nodes.info___NodeInfoIngestInfo' + gsub: + $ref: '#/components/schemas/nodes.info___NodeInfoIngestInfo' + join: + $ref: '#/components/schemas/nodes.info___NodeInfoIngestInfo' + lowercase: + $ref: '#/components/schemas/nodes.info___NodeInfoIngestInfo' + remove: + $ref: '#/components/schemas/nodes.info___NodeInfoIngestInfo' + rename: + $ref: '#/components/schemas/nodes.info___NodeInfoIngestInfo' + script: + $ref: '#/components/schemas/nodes.info___NodeInfoIngestInfo' + set: + $ref: '#/components/schemas/nodes.info___NodeInfoIngestInfo' + sort: + $ref: '#/components/schemas/nodes.info___NodeInfoIngestInfo' + split: + $ref: '#/components/schemas/nodes.info___NodeInfoIngestInfo' + trim: + $ref: '#/components/schemas/nodes.info___NodeInfoIngestInfo' + uppercase: + $ref: '#/components/schemas/nodes.info___NodeInfoIngestInfo' + urldecode: + $ref: '#/components/schemas/nodes.info___NodeInfoIngestInfo' + bytes: + $ref: '#/components/schemas/nodes.info___NodeInfoIngestInfo' + dissect: + $ref: '#/components/schemas/nodes.info___NodeInfoIngestInfo' + set_security_user: + $ref: '#/components/schemas/nodes.info___NodeInfoIngestInfo' + pipeline: + $ref: '#/components/schemas/nodes.info___NodeInfoIngestInfo' + drop: + $ref: '#/components/schemas/nodes.info___NodeInfoIngestInfo' + circle: + $ref: '#/components/schemas/nodes.info___NodeInfoIngestInfo' + inference: + $ref: '#/components/schemas/nodes.info___NodeInfoIngestInfo' + nodes.info___NodeInfoSettingsNetwork: + type: object + properties: + host: + $ref: '#/components/schemas/_common___Host' + required: + - host + nodes.info___NodeInfoSettingsNode: + type: object + properties: + name: + $ref: '#/components/schemas/_common___Name' + attr: + type: object + additionalProperties: true + max_local_storage_nodes: + type: string + required: + - name + nodes.info___NodeInfoSettingsPlugins: + type: object + additionalProperties: true + nodes.info___NodeInfoSettingsTransport: + type: object + properties: + type: + $ref: '#/components/schemas/nodes.info___NodeInfoSettingsTransportType' + type.default: + type: string + required: + - type + nodes.info___NodeInfoSettingsTransportType: + oneOf: + - title: type + type: string + - title: config + $ref: '#/components/schemas/nodes.info___NodeInfoSettingsTransportTypeConfig' + nodes.info___NodeInfoSettingsTransportTypeConfig: + type: object + properties: + default: + type: string + nodes.info___NodeInfoTransport: + type: object + properties: + bound_address: + type: array + items: + type: string + publish_address: + type: string + profiles: + type: object + additionalProperties: + type: string + required: + - bound_address + - profiles + - publish_address + nodes.info___NodeJvmInfo: + type: object + properties: + gc_collectors: + type: array + items: + type: string + mem: + $ref: '#/components/schemas/nodes.info___NodeInfoJvmMemory' + memory_pools: + type: array + items: + type: string + pid: + type: integer + format: int32 + start_time: + $ref: '#/components/schemas/_common___DateTime' + start_time_in_millis: + $ref: '#/components/schemas/_common___EpochTimeUnitMillis' + version: + $ref: '#/components/schemas/_common___VersionString' + vm_name: + $ref: '#/components/schemas/_common___Name' + vm_vendor: + type: string + vm_version: + $ref: '#/components/schemas/_common___VersionString' + bundled_jdk: + type: boolean + using_bundled_jdk: + type: + - boolean + - 'null' + using_compressed_ordinary_object_pointers: + $ref: '#/components/schemas/_common___StringifiedBoolean' + input_arguments: + type: array + items: + type: string + required: + - bundled_jdk + - mem + - pid + - start_time_in_millis + nodes.info___NodeOperatingSystemInfo: + type: object + properties: + arch: + description: 'Name of the JVM architecture (ex: amd64, x86)' + type: string + available_processors: + description: Number of processors available to the Java virtual machine + type: integer + format: int32 + allocated_processors: + description: The number of processors actually used to calculate thread pool size. This number can be set with the `node.processors` setting of a node and defaults to the number of processors reported by the OS. + type: integer + format: int32 + name: + $ref: '#/components/schemas/_common___Name' + pretty_name: + $ref: '#/components/schemas/_common___Name' + refresh_interval: + $ref: '#/components/schemas/_common___Duration' + refresh_interval_in_millis: + $ref: '#/components/schemas/_common___DurationValueUnitMillis' + version: + $ref: '#/components/schemas/_common___VersionString' + cpu: + $ref: '#/components/schemas/nodes.info___NodeInfoOSCPU' + mem: + $ref: '#/components/schemas/nodes.info___NodeInfoMemory' + swap: + $ref: '#/components/schemas/nodes.info___NodeInfoMemory' + required: + - available_processors + - refresh_interval_in_millis + nodes.info___NodeProcessInfo: + type: object + properties: + id: + description: Process identifier (PID) + type: integer + format: int64 + mlockall: + description: Indicates if the process address space has been successfully locked in memory + type: boolean + refresh_interval: + $ref: '#/components/schemas/_common___Duration' + refresh_interval_in_millis: + $ref: '#/components/schemas/_common___DurationValueUnitMillis' + required: + - id + - mlockall + - refresh_interval_in_millis + nodes.info___NodeThreadPoolInfo: + type: object + properties: + core: + type: integer + format: int32 + keep_alive: + $ref: '#/components/schemas/_common___Duration' + max: + type: integer + format: int32 + queue_size: + type: integer + format: int32 + size: + type: integer + format: int32 + type: + type: string + required: + - queue_size + - type + nodes.reload_secure_settings___NodeReloadError: + allOf: + - $ref: '#/components/schemas/nodes.reload_secure_settings___NodeReloadResponse' + - type: object + properties: + reload_exception: + $ref: '#/components/schemas/_common___ErrorCause' + nodes.reload_secure_settings___NodeReloadResponse: + type: object + properties: + name: + $ref: '#/components/schemas/_common___Name' + required: + - name + nodes.reload_secure_settings___NodeReloadResult: + anyOf: + - $ref: '#/components/schemas/nodes.reload_secure_settings___NodeReloadResponse' + - $ref: '#/components/schemas/nodes.reload_secure_settings___NodeReloadError' + nodes.stats___AdaptiveSelection: + type: object + properties: + avg_queue_size: + description: The exponentially weighted moving average queue size of search requests on the keyed node. + type: integer + format: int64 + avg_response_time: + $ref: '#/components/schemas/_common___Duration' + avg_response_time_ns: + description: The exponentially weighted moving average response time, in nanoseconds, of search requests on the keyed node. + $ref: '#/components/schemas/_common___DurationValueUnitNanos' + avg_service_time: + $ref: '#/components/schemas/_common___Duration' + avg_service_time_ns: + description: The exponentially weighted moving average service time, in nanoseconds, of search requests on the keyed node. + $ref: '#/components/schemas/_common___DurationValueUnitNanos' + outgoing_searches: + description: The number of outstanding search requests to the keyed node from the node these stats are for. + type: integer + format: int64 + rank: + description: The rank of this node; used for shard selection when routing search requests. + type: string + nodes.stats___Breaker: + type: object + properties: + estimated_size: + description: Estimated memory used for the operation. + $ref: '#/components/schemas/_common___HumanReadableByteCount' + estimated_size_in_bytes: + description: Estimated memory used, in bytes, for the operation. + $ref: '#/components/schemas/_common___ByteCount' + limit_size: + description: Memory limit for the circuit breaker. + $ref: '#/components/schemas/_common___HumanReadableByteCount' + limit_size_in_bytes: + description: Memory limit, in bytes, for the circuit breaker. + $ref: '#/components/schemas/_common___ByteCount' + overhead: + description: A constant that all estimates for the circuit breaker are multiplied with to calculate a final estimate. + type: number + format: double + tripped: + description: Total number of times the circuit breaker has been triggered and prevented an out of memory error. + type: integer + format: int64 + nodes.stats___CgroupCpuAcctStats: + type: object + properties: + control_group: + description: The `cpuacct` control group to which the OpenSearch process belongs. + type: string + usage_nanos: + $ref: '#/components/schemas/_common___DurationValueUnitNanos' + nodes.stats___CgroupCpuStat: + type: object + properties: + number_of_elapsed_periods: + description: The number of reporting periods (as specified by `cfs_period_micros`) that have elapsed. + type: integer + format: int64 + number_of_times_throttled: + description: The number of times all tasks in the same cgroup as the OpenSearch process have been throttled. + type: integer + format: int64 + time_throttled_nanos: + $ref: '#/components/schemas/_common___DurationValueUnitNanos' + nodes.stats___CgroupCpuStats: + type: object + properties: + control_group: + description: The `cpu` control group to which the OpenSearch process belongs. + type: string + cfs_period_micros: + description: The period of time, in microseconds, for how regularly all tasks in the same cgroup as the OpenSearch process should have their access to CPU resources reallocated. + $ref: '#/components/schemas/_common___DurationValueUnitMicros' + cfs_quota_micros: + description: The total amount of time, in microseconds, for which all tasks in the same cgroup as the OpenSearch process can run during one period `cfs_period_micros`. + $ref: '#/components/schemas/_common___DurationValueUnitMicros' + stat: + $ref: '#/components/schemas/nodes.stats___CgroupCpuStat' + nodes.stats___CgroupMemoryStats: + type: object + properties: + control_group: + description: The `memory` control group to which the OpenSearch process belongs. + type: string + limit_in_bytes: + description: |- + The maximum amount of user memory (including file cache) allowed for all tasks in the same cgroup as the OpenSearch process. + This value can be too big to store in a `long`, so is returned as a string so that the value returned can exactly match what the underlying operating system interface returns. + Any value that is too large to parse into a `long` almost certainly means no limit has been set for the cgroup. + type: string + usage_in_bytes: + description: |- + The total current memory usage by processes in the cgroup, in bytes, by all tasks in the same cgroup as the OpenSearch process. + This value is stored as a string for consistency with `limit_in_bytes`. + type: string + nodes.stats___CgroupStats: + type: object + properties: + cpuacct: + $ref: '#/components/schemas/nodes.stats___CgroupCpuAcctStats' + cpu: + $ref: '#/components/schemas/nodes.stats___CgroupCpuStats' memory: - $ref: '#/components/schemas/nodes._common___IndexingPressureMemory' - nodes._common___IndexingPressureMemory: + $ref: '#/components/schemas/nodes.stats___CgroupMemoryStats' + nodes.stats___ClusterStateOverallStats: + type: object + properties: + update_count: + type: integer + format: int64 + total_time_in_millis: + $ref: '#/components/schemas/_common___DurationValueUnitMillis' + failed_count: + type: integer + format: int64 + nodes.stats___ClusterStateQueue: + type: object + properties: + total: + description: Total number of cluster states in queue. + type: integer + format: int32 + pending: + description: Number of pending cluster states in queue. + type: integer + format: int32 + committed: + description: Number of committed cluster states in queue. + type: integer + format: int32 + nodes.stats___ClusterStateStats: + type: object + properties: + overall: + $ref: '#/components/schemas/nodes.stats___ClusterStateOverallStats' + nodes.stats___DataPathStats: + type: object + properties: + available: + description: Total amount of disk space available to this Java virtual machine on this file store. + $ref: '#/components/schemas/_common___HumanReadableByteCount' + available_in_bytes: + description: Total number of bytes available to this Java virtual machine on this file store. + $ref: '#/components/schemas/_common___ByteCount' + cache_reserved: + x-version-added: '2.7' + description: Total number of cache bytes reserved available to this Java virtual machine on this file store. + $ref: '#/components/schemas/_common___HumanReadableByteCount' + cache_reserved_in_bytes: + x-version-added: '2.7' + description: Total number of cache bytes reserved available to this Java virtual machine on this file store. + $ref: '#/components/schemas/_common___ByteCount' + free: + description: Total amount of unallocated disk space in the file store. + $ref: '#/components/schemas/_common___HumanReadableByteCount' + free_in_bytes: + description: Total number of unallocated bytes in the file store. + $ref: '#/components/schemas/_common___ByteCount' + mount: + description: 'Mount point of the file store (for example: `/dev/sda2`).' + type: string + path: + description: Path to the file store. + type: string + total: + description: Total size of the file store. + $ref: '#/components/schemas/_common___HumanReadableByteCount' + total_in_bytes: + description: Total size of the file store in bytes. + $ref: '#/components/schemas/_common___ByteCount' + type: + description: 'Type of the file store (ex: ext4).' + type: string + nodes.stats___Discovery: + type: object + properties: + cluster_state_queue: + $ref: '#/components/schemas/nodes.stats___ClusterStateQueue' + cluster_state_stats: + $ref: '#/components/schemas/nodes.stats___ClusterStateStats' + published_cluster_states: + $ref: '#/components/schemas/nodes.stats___PublishedClusterStates' + nodes.stats___ExtendedMemoryStats: + allOf: + - $ref: '#/components/schemas/nodes.stats___MemoryStatsBase' + - type: object + properties: + free_percent: + description: Percentage of free memory. + $ref: '#/components/schemas/_common___PercentageNumber' + used_percent: + description: Percentage of used memory. + $ref: '#/components/schemas/_common___PercentageNumber' + nodes.stats___FileSystem: + type: object + properties: + data: + description: List of all file stores. + type: array + items: + $ref: '#/components/schemas/nodes.stats___DataPathStats' + timestamp: + description: |- + Last time the file stores statistics were refreshed. + Recorded in milliseconds since the Unix Epoch. + $ref: '#/components/schemas/_common___EpochTimeUnitMillis' + total: + $ref: '#/components/schemas/nodes.stats___FileSystemTotal' + io_stats: + $ref: '#/components/schemas/nodes.stats___IoStats' + nodes.stats___FileSystemTotal: + type: object + properties: + available: + description: |- + Total disk space available to this Java virtual machine on all file stores. + Depending on OS or process level restrictions, this might appear less than `free`. + This is the actual amount of free disk space the OpenSearch node can utilize. + $ref: '#/components/schemas/_common___HumanReadableByteCount' + available_in_bytes: + description: |- + Total number of bytes available to this Java virtual machine on all file stores. + Depending on OS or process level restrictions, this might appear less than `free_in_bytes`. + This is the actual amount of free disk space the OpenSearch node can utilize. + $ref: '#/components/schemas/_common___ByteCount' + free: + description: Total unallocated disk space in all file stores. + $ref: '#/components/schemas/_common___HumanReadableByteCount' + free_in_bytes: + description: Total number of unallocated bytes in all file stores. + $ref: '#/components/schemas/_common___ByteCount' + total: + description: Total size of all file stores. + $ref: '#/components/schemas/_common___HumanReadableByteCount' + total_in_bytes: + description: Total size of all file stores in bytes. + $ref: '#/components/schemas/_common___ByteCount' + cache_reserved: + x-version-added: '2.7' + description: Total size of cache bytes reserved in all file stores. + $ref: '#/components/schemas/_common___HumanReadableByteCount' + cache_reserved_in_bytes: + x-version-added: '2.7' + description: Total size of cache bytes reserved in all file stores. + $ref: '#/components/schemas/_common___ByteCount' + nodes.stats___GarbageCollector: + type: object + properties: + collectors: + description: Contains statistics about JVM garbage collectors for the node. + type: object + additionalProperties: + $ref: '#/components/schemas/nodes.stats___GarbageCollectorTotal' + nodes.stats___GarbageCollectorTotal: + type: object + properties: + collection_count: + description: Total number of JVM garbage collectors that collect objects. + type: integer + format: int64 + collection_time: + description: Total time spent by JVM collecting objects. + $ref: '#/components/schemas/_common___Duration' + collection_time_in_millis: + description: Total time, in milliseconds, spent by JVM collecting objects. + $ref: '#/components/schemas/_common___DurationValueUnitMillis' + nodes.stats___Http: + type: object + properties: + current_open: + description: Current number of open HTTP connections for the node. + type: integer + format: int64 + total_opened: + description: Total number of HTTP connections opened for the node. + type: integer + format: int64 + nodes.stats___IndexingPressure: + type: object + properties: + memory: + $ref: '#/components/schemas/nodes.stats___IndexingPressureMemory' + nodes.stats___IndexingPressureMemory: type: object properties: limit: $ref: '#/components/schemas/_common___HumanReadableByteCount' limit_in_bytes: + description: |- + Configured memory limit, in bytes, for the indexing requests. + Replica requests have an automatic limit that is 1.5x this value. $ref: '#/components/schemas/_common___ByteCount' current: - $ref: '#/components/schemas/nodes._common___PressureMemory' + $ref: '#/components/schemas/nodes.stats___PressureMemory' total: - $ref: '#/components/schemas/nodes._common___PressureMemory' - nodes._common___Ingest: + $ref: '#/components/schemas/nodes.stats___PressureMemory' + nodes.stats___IndexMetric: + type: string + enum: + - _all + - completion + - docs + - fielddata + - flush + - get + - indexing + - merge + - query_cache + - recovery + - refresh + - request_cache + - search + - segments + - store + - suggest + - translog + - warmer + nodes.stats___Ingest: type: object properties: pipelines: description: Contains statistics about ingest pipelines for the node. type: object additionalProperties: - $ref: '#/components/schemas/nodes._common___IngestTotal' + $ref: '#/components/schemas/nodes.stats___IngestTotal' total: - $ref: '#/components/schemas/nodes._common___IngestTotal' - nodes._common___IngestTotal: + $ref: '#/components/schemas/nodes.stats___IngestTotal' + nodes.stats___IngestTotal: type: object properties: count: description: Total number of documents ingested during the lifetime of this node. - type: number + type: integer + format: int64 current: description: Total number of documents currently being ingested. - type: number + type: integer + format: int64 failed: description: Total number of failed ingest operations during the lifetime of this node. - type: number + type: integer + format: int64 processors: description: Total number of ingest processors. type: array items: type: object additionalProperties: - $ref: '#/components/schemas/nodes._common___KeyedProcessor' + $ref: '#/components/schemas/nodes.stats___KeyedProcessor' time: $ref: '#/components/schemas/_common___Duration' time_in_millis: $ref: '#/components/schemas/_common___DurationValueUnitMillis' - nodes._common___IoStatDevice: + nodes.stats___IoStatDevice: type: object properties: device_name: @@ -52166,28 +58280,36 @@ components: type: string operations: description: The total number of read and write operations for the device completed since starting OpenSearch. - type: number + type: integer + format: int64 read_kilobytes: description: The total number of kilobytes read for the device since starting OpenSearch. - type: number + type: integer + format: int64 read_operations: description: The total number of read operations for the device completed since starting OpenSearch. - type: number + type: integer + format: int64 write_kilobytes: description: The total number of kilobytes written for the device since starting OpenSearch. - type: number + type: integer + format: int64 write_operations: description: The total number of write operations for the device completed since starting OpenSearch. - type: number + type: integer + format: int64 read_time: - type: number + type: integer + format: int64 write_time: - type: number + type: integer + format: int64 queue_size: - type: number + type: integer + format: int64 io_time_in_millis: $ref: '#/components/schemas/_common___DurationValueUnitMillis' - nodes._common___IoStats: + nodes.stats___IoStats: type: object properties: devices: @@ -52196,95 +58318,111 @@ components: These disk metrics are probed periodically and averages between the last probe and the current probe are computed. type: array items: - $ref: '#/components/schemas/nodes._common___IoStatDevice' + $ref: '#/components/schemas/nodes.stats___IoStatDevice' total: - $ref: '#/components/schemas/nodes._common___IoStatDevice' - nodes._common___Jvm: + $ref: '#/components/schemas/nodes.stats___IoStatDevice' + nodes.stats___Jvm: type: object properties: buffer_pools: description: Contains statistics about JVM buffer pools for the node. type: object additionalProperties: - $ref: '#/components/schemas/nodes._common___NodeBufferPool' + $ref: '#/components/schemas/nodes.stats___NodeBufferPool' classes: - $ref: '#/components/schemas/nodes._common___JvmClasses' + $ref: '#/components/schemas/nodes.stats___JvmClasses' gc: - $ref: '#/components/schemas/nodes._common___GarbageCollector' + $ref: '#/components/schemas/nodes.stats___GarbageCollector' mem: - $ref: '#/components/schemas/nodes._common___JvmMemoryStats' + $ref: '#/components/schemas/nodes.stats___JvmMemoryStats' threads: - $ref: '#/components/schemas/nodes._common___JvmThreads' + $ref: '#/components/schemas/nodes.stats___JvmThreads' timestamp: description: Last time JVM statistics were refreshed. - type: number + $ref: '#/components/schemas/_common___EpochTimeUnitMillis' uptime: description: |- Human-readable JVM uptime. Only returned if the `human` query parameter is `true`. - type: string + $ref: '#/components/schemas/_common___Duration' uptime_in_millis: description: JVM uptime in milliseconds. - type: number - nodes._common___JvmClasses: + $ref: '#/components/schemas/_common___DurationValueUnitMillis' + nodes.stats___JvmClasses: type: object properties: current_loaded_count: description: Number of classes currently loaded by JVM. - type: number + type: integer + format: int64 total_loaded_count: description: Total number of classes loaded since the JVM started. - type: number + type: integer + format: int64 total_unloaded_count: description: Total number of classes unloaded since the JVM started. - type: number - nodes._common___JvmMemoryStats: + type: integer + format: int64 + nodes.stats___JvmMemoryStats: type: object properties: heap_used: + description: Memory currently in use by the heap. $ref: '#/components/schemas/_common___HumanReadableByteCount' heap_used_in_bytes: + description: Memory, in bytes, currently in use by the heap. $ref: '#/components/schemas/_common___ByteCount' heap_used_percent: + description: Percentage of memory currently in use by the heap. $ref: '#/components/schemas/_common___PercentageNumber' heap_committed: + description: Amount of memory available for use by the heap. $ref: '#/components/schemas/_common___HumanReadableByteCount' heap_committed_in_bytes: + description: Amount of memory, in bytes, available for use by the heap. $ref: '#/components/schemas/_common___ByteCount' heap_max: + description: Maximum amount of memory available for use by the heap. $ref: '#/components/schemas/_common___HumanReadableByteCount' heap_max_in_bytes: + description: Maximum amount of memory, in bytes, available for use by the heap. $ref: '#/components/schemas/_common___ByteCount' non_heap_used: + description: Non-heap memory used. $ref: '#/components/schemas/_common___HumanReadableByteCount' non_heap_used_in_bytes: + description: Non-heap memory used, in bytes. $ref: '#/components/schemas/_common___ByteCount' non_heap_committed: + description: Amount of non-heap memory available. $ref: '#/components/schemas/_common___HumanReadableByteCount' non_heap_committed_in_bytes: + description: Amount of non-heap memory available, in bytes. $ref: '#/components/schemas/_common___ByteCount' pools: description: Contains statistics about heap memory usage for the node. type: object additionalProperties: - $ref: '#/components/schemas/nodes._common___Pool' - nodes._common___JvmThreads: + $ref: '#/components/schemas/nodes.stats___Pool' + nodes.stats___JvmThreads: type: object properties: count: description: Number of active threads in use by JVM. - type: number + type: integer + format: int64 peak_count: description: Highest number of threads used by JVM. - type: number - nodes._common___KeyedProcessor: + type: integer + format: int64 + nodes.stats___KeyedProcessor: type: object properties: stats: - $ref: '#/components/schemas/nodes._common___Processor' + $ref: '#/components/schemas/nodes.stats___Processor' type: type: string - nodes._common___LastGcStats: + nodes.stats___LastGcStats: type: object properties: used: @@ -52297,269 +58435,339 @@ components: $ref: '#/components/schemas/_common___ByteCount' usage_percent: $ref: '#/components/schemas/_common___PercentageNumber' - nodes._common___MemoryStats: + nodes.stats___MemoryStats: + allOf: + - $ref: '#/components/schemas/nodes.stats___MemoryStatsBase' + - type: object + properties: {} + nodes.stats___MemoryStatsBase: type: object properties: - adjusted_total_in_bytes: - $ref: '#/components/schemas/_common___ByteCount' - resident: - $ref: '#/components/schemas/_common___HumanReadableByteCount' - resident_in_bytes: - $ref: '#/components/schemas/_common___ByteCount' - share: - $ref: '#/components/schemas/_common___HumanReadableByteCount' - share_in_bytes: - $ref: '#/components/schemas/_common___ByteCount' - total_virtual: - $ref: '#/components/schemas/_common___HumanReadableByteCount' - total_virtual_in_bytes: - $ref: '#/components/schemas/_common___ByteCount' total: + description: Total amount of physical memory. $ref: '#/components/schemas/_common___HumanReadableByteCount' total_in_bytes: + description: Total amount of physical memory in bytes. $ref: '#/components/schemas/_common___ByteCount' free: + description: Amount of free physical memory. $ref: '#/components/schemas/_common___HumanReadableByteCount' free_in_bytes: + description: Amount of free physical memory in bytes. $ref: '#/components/schemas/_common___ByteCount' used: + description: Amount of used physical memory. $ref: '#/components/schemas/_common___HumanReadableByteCount' used_in_bytes: + description: Amount of used physical memory in bytes. $ref: '#/components/schemas/_common___ByteCount' - nodes._common___NodeBufferPool: + 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 + - weighted_routing + nodes.stats___NodeBufferPool: type: object properties: count: description: Number of buffer pools. - type: number + type: integer + format: int64 total_capacity: + description: Total capacity of buffer pools. $ref: '#/components/schemas/_common___HumanReadableByteCount' total_capacity_in_bytes: + description: Total capacity of buffer pools in bytes. $ref: '#/components/schemas/_common___ByteCount' used: + description: Size of buffer pools. $ref: '#/components/schemas/_common___HumanReadableByteCount' used_in_bytes: + description: Size of buffer pools in bytes. $ref: '#/components/schemas/_common___ByteCount' - nodes._common___NodeReloadError: - type: object - properties: - name: - $ref: '#/components/schemas/_common___Name' - reload_exception: - $ref: '#/components/schemas/_common___ErrorCause' - required: - - name - nodes._common___NodeReloadResult: - oneOf: - - $ref: '#/components/schemas/nodes._common___Stats' - - $ref: '#/components/schemas/nodes._common___NodeReloadError' - nodes._common___NodesResponseBase: - type: object - properties: - _nodes: - $ref: '#/components/schemas/_common___NodeStatistics' - nodes._common___OperatingSystem: + nodes.stats___NodeIndexShardStats: + allOf: + - $ref: '#/components/schemas/indices.stats___IndexShardStatsBase' + - type: object + properties: {} + nodes.stats___NodeIndicesStats: + allOf: + - $ref: '#/components/schemas/indices.stats___IndexStatsBase' + - type: object + properties: + indices: + type: object + additionalProperties: + $ref: '#/components/schemas/indices.stats___IndexStats' + shards: + type: object + additionalProperties: + type: array + items: + type: object + propertyNames: + title: shard_id + type: string + additionalProperties: + $ref: '#/components/schemas/nodes.stats___NodeIndexShardStats' + minProperties: 1 + maxProperties: 1 + nodes.stats___OperatingSystem: type: object properties: cpu: - $ref: '#/components/schemas/nodes._common___Cpu' + $ref: '#/components/schemas/nodes.stats___OperatingSystemCpuStats' mem: - $ref: '#/components/schemas/nodes._common___ExtendedMemoryStats' + $ref: '#/components/schemas/nodes.stats___ExtendedMemoryStats' swap: - $ref: '#/components/schemas/nodes._common___MemoryStats' + $ref: '#/components/schemas/nodes.stats___MemoryStats' cgroup: - $ref: '#/components/schemas/nodes._common___Cgroup' + $ref: '#/components/schemas/nodes.stats___CgroupStats' timestamp: - type: number - nodes._common___Pool: + $ref: '#/components/schemas/_common___EpochTimeUnitMillis' + nodes.stats___OperatingSystemCpuStats: + type: object + properties: + percent: + $ref: '#/components/schemas/_common___PercentageNumber' + load_average: + type: object + additionalProperties: + type: number + format: double + nodes.stats___Pool: type: object properties: used: + description: Memory used by the heap. $ref: '#/components/schemas/_common___HumanReadableByteCount' used_in_bytes: + description: Memory, in bytes, used by the heap. $ref: '#/components/schemas/_common___ByteCount' max: + description: Maximum amount of memory available for use by the heap. $ref: '#/components/schemas/_common___HumanReadableByteCount' max_in_bytes: + description: Maximum amount of memory, in bytes, available for use by the heap. $ref: '#/components/schemas/_common___ByteCount' peak_used: + description: Largest amount of memory historically used by the heap. $ref: '#/components/schemas/_common___HumanReadableByteCount' peak_used_in_bytes: + description: Largest amount of memory, in bytes, historically used by the heap. $ref: '#/components/schemas/_common___ByteCount' peak_max: + description: Largest amount of memory historically used by the heap. $ref: '#/components/schemas/_common___HumanReadableByteCount' peak_max_in_bytes: + description: Largest amount of memory, in bytes, historically used by the heap. $ref: '#/components/schemas/_common___ByteCount' last_gc_stats: - $ref: '#/components/schemas/nodes._common___LastGcStats' - nodes._common___PressureMemory: + description: Most recent GC cycle stats for a particular memory pool. + $ref: '#/components/schemas/nodes.stats___LastGcStats' + nodes.stats___PressureMemory: type: object properties: all: $ref: '#/components/schemas/_common___HumanReadableByteCount' all_in_bytes: + description: Memory consumed, in bytes, by indexing requests in the coordinating, primary, or replica stage. $ref: '#/components/schemas/_common___ByteCount' combined_coordinating_and_primary: $ref: '#/components/schemas/_common___HumanReadableByteCount' combined_coordinating_and_primary_in_bytes: + description: |- + Memory consumed, in bytes, by indexing requests in the coordinating or primary stage. + This value is not the sum of coordinating and primary as a node can reuse the coordinating memory if the primary stage is executed locally. $ref: '#/components/schemas/_common___ByteCount' coordinating: $ref: '#/components/schemas/_common___HumanReadableByteCount' coordinating_in_bytes: + description: Memory consumed, in bytes, by indexing requests in the coordinating stage. $ref: '#/components/schemas/_common___ByteCount' primary: $ref: '#/components/schemas/_common___HumanReadableByteCount' primary_in_bytes: + description: Memory consumed, in bytes, by indexing requests in the primary stage. $ref: '#/components/schemas/_common___ByteCount' replica: $ref: '#/components/schemas/_common___HumanReadableByteCount' replica_in_bytes: + description: Memory consumed, in bytes, by indexing requests in the replica stage. $ref: '#/components/schemas/_common___ByteCount' coordinating_rejections: description: Number of indexing requests rejected in the coordinating stage. - type: number + type: integer + format: int64 primary_rejections: description: Number of indexing requests rejected in the primary stage. - type: number + type: integer + format: int64 replica_rejections: description: Number of indexing requests rejected in the replica stage. - type: number - nodes._common___Process: + type: integer + format: int64 + nodes.stats___Process: type: object properties: cpu: - $ref: '#/components/schemas/nodes._common___Cpu' + $ref: '#/components/schemas/nodes.stats___ProcessCpuStats' mem: - $ref: '#/components/schemas/nodes._common___MemoryStats' + $ref: '#/components/schemas/nodes.stats___ProcessMemoryStats' open_file_descriptors: description: Number of opened file descriptors associated with the current or `-1` if not supported. - type: number + type: integer + format: int64 max_file_descriptors: description: Maximum number of file descriptors allowed on the system, or `-1` if not supported. - type: number + type: integer + format: int64 timestamp: description: |- Last time the statistics were refreshed. Recorded in milliseconds since the Unix Epoch. - type: number - nodes._common___Processor: + $ref: '#/components/schemas/_common___EpochTimeUnitMillis' + nodes.stats___ProcessCpuStats: + type: object + properties: + percent: + $ref: '#/components/schemas/_common___PercentageNumber' + total: + $ref: '#/components/schemas/_common___Duration' + total_in_millis: + $ref: '#/components/schemas/_common___DurationValueUnitMillis' + required: + - percent + - total_in_millis + nodes.stats___ProcessMemoryStats: + type: object + properties: + total_virtual: + $ref: '#/components/schemas/_common___HumanReadableByteCount' + total_virtual_in_bytes: + $ref: '#/components/schemas/_common___ByteCount' + nodes.stats___Processor: type: object properties: count: description: Number of documents transformed by the processor. - type: number + type: integer + format: int64 current: description: Number of documents currently being transformed by the processor. - type: number + type: integer + format: int64 failed: description: Number of failed operations for the processor. - type: number + type: integer + format: int64 time: $ref: '#/components/schemas/_common___Duration' time_in_millis: $ref: '#/components/schemas/_common___DurationValueUnitMillis' - nodes._common___PublishedClusterStates: + nodes.stats___PublishedClusterStates: type: object properties: full_states: description: Number of published cluster states. - type: number + type: integer + format: int64 incompatible_diffs: description: Number of incompatible differences between published cluster states. - type: number + type: integer + format: int64 compatible_diffs: description: Number of compatible differences between published cluster states. - type: number - nodes._common___Recording: - type: object - properties: - name: - type: string - cumulative_execution_count: - type: number - cumulative_execution_time: - $ref: '#/components/schemas/_common___Duration' - cumulative_execution_time_millis: - $ref: '#/components/schemas/_common___DurationValueUnitMillis' - nodes._common___RemoteStoreStats: + type: integer + format: int64 + nodes.stats___RemoteStoreStats: type: object properties: last_successful_fetch_of_pinned_timestamps: - $ref: '#/components/schemas/_common___StringifiedEpochTimeUnitSeconds' - nodes._common___SampleType: - type: string - description: The type to sample. - enum: - - block - - cpu - - wait - nodes._common___ScriptCache: + description: Timestamp for the last successful fetch of pinned timestamps. + $ref: '#/components/schemas/_common___EpochTimeUnitSeconds' + nodes.stats___ScriptCacheStats: type: object properties: - cache_evictions: - description: Total number of times the script cache has evicted old data. - type: number - compilation_limit_triggered: - description: Total number of times the script compilation circuit breaker has limited inline script compilations. - type: number - compilations: - description: Total number of inline script compilations performed by the node. - type: number - context: - type: string - nodes._common___Scripting: + sum: + $ref: '#/components/schemas/nodes.stats___ScriptStats' + contexts: + type: array + items: + $ref: '#/components/schemas/nodes.stats___ScriptContextStats' + required: + - sum + nodes.stats___ScriptContextStats: + allOf: + - $ref: '#/components/schemas/nodes.stats___ScriptStatsBase' + - type: object + properties: + context: + type: string + required: + - context + nodes.stats___ScriptStats: + allOf: + - $ref: '#/components/schemas/nodes.stats___ScriptStatsBase' + - type: object + properties: {} + nodes.stats___ScriptStatsBase: type: object properties: cache_evictions: description: Total number of times the script cache has evicted old data. - type: number + type: integer + format: int64 compilations: description: Total number of inline script compilations performed by the node. - type: number - compilations_history: - description: Contains this recent history of script compilations. - type: object - additionalProperties: - type: number + type: integer + format: int64 compilation_limit_triggered: description: Total number of times the script compilation circuit breaker has limited inline script compilations. - type: number - contexts: - type: array - items: - $ref: '#/components/schemas/nodes._common___Context' - nodes._common___SerializedClusterState: - type: object - properties: - full_states: - $ref: '#/components/schemas/nodes._common___SerializedClusterStateDetail' - diffs: - $ref: '#/components/schemas/nodes._common___SerializedClusterStateDetail' - nodes._common___SerializedClusterStateDetail: - type: object - properties: - count: - type: number - uncompressed_size: - $ref: '#/components/schemas/_common___HumanReadableByteCount' - uncompressed_size_in_bytes: - $ref: '#/components/schemas/_common___ByteCount' - compressed_size: - $ref: '#/components/schemas/_common___HumanReadableByteCount' - compressed_size_in_bytes: - $ref: '#/components/schemas/_common___ByteCount' - nodes._common___ShardAdmissionControlStats: + type: integer + format: int64 + required: + - cache_evictions + - compilation_limit_triggered + - compilations + nodes.stats___ShardAdmissionControlStats: type: object properties: global_io_usage: - $ref: '#/components/schemas/nodes._common___UsageStats' + $ref: '#/components/schemas/nodes.stats___UsageStats' global_cpu_usage: - $ref: '#/components/schemas/nodes._common___UsageStats' - nodes._common___ShardCachesStats: + $ref: '#/components/schemas/nodes.stats___UsageStats' + nodes.stats___ShardCachesStats: type: object additionalProperties: - $ref: '#/components/schemas/nodes._common___ShardCacheStats' - nodes._common___ShardCacheStats: + $ref: '#/components/schemas/nodes.stats___ShardCacheStats' + nodes.stats___ShardCacheStats: type: object properties: size: @@ -52567,1165 +58775,611 @@ components: size_in_bytes: $ref: '#/components/schemas/_common___ByteCount' evictions: - type: number + type: integer + format: int64 hit_count: - type: number + type: integer + format: int64 miss_count: - type: number + type: integer + format: int64 item_count: - type: number + type: integer + format: int64 store_name: type: string - nodes._common___ShardClusterManagerThrottlingStats: + nodes.stats___ShardClusterManagerThrottlingStats: type: object properties: stats: - $ref: '#/components/schemas/nodes._common___ShardClusterManagerThrottlingStatsDetail' - nodes._common___ShardClusterManagerThrottlingStatsDetail: + $ref: '#/components/schemas/nodes.stats___ShardClusterManagerThrottlingStatsDetail' + nodes.stats___ShardClusterManagerThrottlingStatsDetail: type: object properties: total_throttled_tasks: - type: number + type: integer + format: int64 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: - $ref: '#/components/schemas/nodes._common___TotalRejectionsBreakup' - total_rejections_breakup_shadow_mode: - $ref: '#/components/schemas/nodes._common___TotalRejectionsBreakup' - 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___PercentageString' - memory_utilization_percent: - $ref: '#/components/schemas/_common___PercentageString' - io_usage_stats: - $ref: '#/components/schemas/nodes._common___ShardResourceUsageStatsIoUsageStats' - nodes._common___ShardResourceUsageStatsIoUsageStats: - type: object - properties: - max_io_utilization_percent: - $ref: '#/components/schemas/_common___PercentageString' - 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 - cancelled_task_percentage: - $ref: '#/components/schemas/_common___PercentageNumber' - current_cancellation_eligible_tasks_count: - type: number - nodes._common___ShardSearchBackpressureTaskResourceTrackerCpuUsageTrackerStats: - type: object - properties: - cancellation_count: - type: number - current_max: - $ref: '#/components/schemas/_common___Duration' - current_max_millis: - $ref: '#/components/schemas/_common___DurationValueUnitMillis' - current_avg: - $ref: '#/components/schemas/_common___Duration' - current_avg_millis: - $ref: '#/components/schemas/_common___DurationValueUnitMillis' - nodes._common___ShardSearchBackpressureTaskResourceTrackerElapsedTimeTrackerStats: - type: object - properties: - cancellation_count: - type: number - current_max: - $ref: '#/components/schemas/_common___Duration' - current_max_millis: - $ref: '#/components/schemas/_common___DurationValueUnitMillis' - current_avg: - $ref: '#/components/schemas/_common___Duration' - current_avg_millis: - $ref: '#/components/schemas/_common___DurationValueUnitMillis' - nodes._common___ShardSearchBackpressureTaskResourceTrackerHeapUsageTrackerStats: - type: object - properties: - cancellation_count: - type: number - current_max: - $ref: '#/components/schemas/_common___HumanReadableByteCount' - current_max_bytes: - $ref: '#/components/schemas/_common___ByteCount' - current_avg: - $ref: '#/components/schemas/_common___HumanReadableByteCount' - current_avg_bytes: - $ref: '#/components/schemas/_common___ByteCount' - rolling_avg: - $ref: '#/components/schemas/_common___HumanReadableByteCount' - rolling_avg_bytes: - $ref: '#/components/schemas/_common___ByteCount' - 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' - completion_count: - x-version-added: '3.0' - type: number - 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: - $ref: '#/components/schemas/_common___Duration' - 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: - adaptive_selection: - description: Statistics about adaptive replica selection. - type: object - additionalProperties: - $ref: '#/components/schemas/nodes._common___AdaptiveSelection' - breakers: - description: Statistics about the field data circuit breaker. - type: object additionalProperties: - $ref: '#/components/schemas/nodes._common___Breaker' - fs: - $ref: '#/components/schemas/nodes._common___FileSystem' - host: - $ref: '#/components/schemas/_common___Host' - http: - $ref: '#/components/schemas/nodes._common___Http' - ingest: - $ref: '#/components/schemas/nodes._common___Ingest' - ip: - description: IP address and port for the node. - oneOf: - - $ref: '#/components/schemas/_common___Ip' - - type: array - items: - $ref: '#/components/schemas/_common___Ip' - jvm: - $ref: '#/components/schemas/nodes._common___Jvm' - name: - $ref: '#/components/schemas/_common___Name' - os: - $ref: '#/components/schemas/nodes._common___OperatingSystem' - process: - $ref: '#/components/schemas/nodes._common___Process' - roles: - $ref: '#/components/schemas/_common___NodeRoles' - script: - $ref: '#/components/schemas/nodes._common___Scripting' - script_cache: - type: object - additionalProperties: - oneOf: - - $ref: '#/components/schemas/nodes._common___ScriptCache' - - type: array - items: - $ref: '#/components/schemas/nodes._common___ScriptCache' - thread_pool: - description: Statistics about each thread pool, including current size, queue and rejected tasks. - type: object - additionalProperties: - $ref: '#/components/schemas/nodes._common___ThreadCount' - timestamp: - type: number - transport: - $ref: '#/components/schemas/nodes._common___Transport' - transport_address: - $ref: '#/components/schemas/_common___TransportAddress' - attributes: - description: Contains a list of attributes for the node. - type: object - additionalProperties: - type: string - discovery: - $ref: '#/components/schemas/nodes._common___Discovery' - indexing_pressure: - $ref: '#/components/schemas/nodes._common___IndexingPressure' - indices: - $ref: '#/components/schemas/indices.stats___IndexShardStats' - 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' - remote_store: - $ref: '#/components/schemas/nodes._common___RemoteStoreStats' - 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: - active: - description: Number of active threads in the thread pool. - type: number - completed: - description: Number of tasks completed by the thread pool executor. - type: number - largest: - description: Highest number of active threads in the thread pool. - type: number - queue: - description: Number of tasks in queue for the thread pool. - type: number - rejected: - description: Number of tasks rejected by the thread pool executor. - type: number - threads: - description: Number of threads in the thread pool. - type: number - total_wait_time: - $ref: '#/components/schemas/_common___Duration' - total_wait_time_in_nanos: - description: | - The total amount of time that tasks spend waiting in the thread pool queue. - Currently, only `search`, `search_throttled`, and `index_searcher` thread pools support this metric. - type: number - nodes._common___TotalRejectionsBreakup: - type: object - properties: - node_limits: - type: number - no_successful_request_limits: - type: number - throughput_degradation_limits: - type: number - nodes._common___Transport: - type: object - properties: - inbound_handling_time_histogram: - description: The distribution of the time spent handling each inbound message on a transport thread, represented as a histogram. - type: array - items: - $ref: '#/components/schemas/nodes._common___TransportHistogram' - outbound_handling_time_histogram: - description: The distribution of the time spent sending each outbound transport message on a transport thread, represented as a histogram. - type: array - items: - $ref: '#/components/schemas/nodes._common___TransportHistogram' - rx_count: - description: Total number of RX (receive) packets received by the node during internal cluster communication. - type: number - rx_size: - $ref: '#/components/schemas/_common___HumanReadableByteCount' - rx_size_in_bytes: - $ref: '#/components/schemas/_common___ByteCount' - server_open: - description: Current number of inbound TCP connections used for internal communication between nodes. - type: number - tx_count: - description: Total number of TX (transmit) packets sent by the node during internal cluster communication. - type: number - tx_size: - $ref: '#/components/schemas/_common___HumanReadableByteCount' - tx_size_in_bytes: - $ref: '#/components/schemas/_common___ByteCount' - total_outbound_connections: - description: |- - The cumulative number of outbound transport connections that this node has opened since it started. - Each transport connection may comprise multiple TCP connections but is only counted once in this statistic. - Transport connections are typically long-lived so this statistic should remain constant in a stable cluster. - type: number - nodes._common___TransportHistogram: - type: object - properties: - count: - description: The number of times a transport thread took a period of time within the bounds of this bucket to handle an inbound message. - type: number - lt_millis: - description: |- - The exclusive upper bound of the bucket in milliseconds. - May be omitted on the last bucket if this bucket has no upper bound. - type: number - 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: - enabled: - oneOf: - - type: boolean - - type: string - required: - - enabled - nodes.info___Metric: - type: string - enum: - - _all - - aggregations - - http - - indices - - ingest - - jvm - - os - - plugins - - process - - search_pipelines - - settings - - thread_pool - - transport - nodes.info___NodeInfo: - type: object - properties: - attributes: - type: object - additionalProperties: - type: string - build_flavor: - type: string - build_hash: - description: Short hash of the last git commit in this release. - type: string - build_type: - type: string - host: - $ref: '#/components/schemas/_common___Host' - http: - $ref: '#/components/schemas/nodes.info___NodeInfoHttp' - ip: - $ref: '#/components/schemas/_common___Ip' - jvm: - $ref: '#/components/schemas/nodes.info___NodeJvmInfo' - name: - $ref: '#/components/schemas/_common___Name' - network: - $ref: '#/components/schemas/nodes.info___NodeInfoNetwork' - os: - $ref: '#/components/schemas/nodes.info___NodeOperatingSystemInfo' - plugins: - type: array - items: - $ref: '#/components/schemas/_common___PluginStats' - process: - $ref: '#/components/schemas/nodes.info___NodeProcessInfo' - roles: - $ref: '#/components/schemas/_common___NodeRoles' - settings: - $ref: '#/components/schemas/nodes.info___NodeInfoSettings' - thread_pool: - type: object - additionalProperties: - $ref: '#/components/schemas/nodes.info___NodeThreadPoolInfo' - total_indexing_buffer: - description: Total heap allowed to be used to hold recently indexed documents before they must be written to disk. This size is a shared pool across all shards on this node, and is controlled by Indexing Buffer settings. - type: number - total_indexing_buffer_in_bytes: - $ref: '#/components/schemas/_common___ByteCount' - transport: - $ref: '#/components/schemas/nodes.info___NodeInfoTransport' - transport_address: - $ref: '#/components/schemas/_common___TransportAddress' - version: - $ref: '#/components/schemas/_common___VersionString' - modules: - type: array - items: - $ref: '#/components/schemas/_common___PluginStats' - ingest: - $ref: '#/components/schemas/nodes.info___NodeInfoIngest' - aggregations: - type: object - additionalProperties: - $ref: '#/components/schemas/nodes.info___NodeInfoAggregation' - search_pipelines: - $ref: '#/components/schemas/nodes.info___NodeInfoSearchPipelines' - required: - - build_hash - - build_type - - name - - roles - - version - nodes.info___NodeInfoAction: - type: object - properties: - destructive_requires_name: - type: string - required: - - destructive_requires_name - nodes.info___NodeInfoAggregation: - type: object - properties: - types: - type: array - items: - type: string - required: - - types - nodes.info___NodeInfoBootstrap: - type: object - properties: - memory_lock: - type: string - required: - - memory_lock - nodes.info___NodeInfoClient: - type: object - properties: - type: - type: string + type: integer + format: int64 required: - - type - nodes.info___NodeInfoDiscovery: + - throttled_tasks_per_task_type + - total_throttled_tasks + nodes.stats___ShardIndexingPressurePerShardIndexingStats: type: object properties: - type: - type: string - seed_hosts: - type: string - nodes.info___NodeInfoHttp: + coordinating_time_in_millis: + $ref: '#/components/schemas/_common___DurationValueUnitMillis' + coordinating_count: + type: integer + format: int64 + primary_time_in_millis: + $ref: '#/components/schemas/_common___DurationValueUnitMillis' + primary_count: + type: integer + format: int64 + replica_time_in_millis: + $ref: '#/components/schemas/_common___DurationValueUnitMillis' + replica_count: + type: integer + format: int64 + required: + - coordinating_count + - coordinating_time_in_millis + - primary_count + - primary_time_in_millis + - replica_count + - replica_time_in_millis + nodes.stats___ShardIndexingPressurePerShardLastSuccessfulTimestamp: type: object properties: - bound_address: - type: array - items: - type: string - max_content_length: - $ref: '#/components/schemas/_common___HumanReadableByteCount' - max_content_length_in_bytes: - $ref: '#/components/schemas/_common___ByteCount' - publish_address: - type: string + coordinating_last_successful_request_timestamp_in_millis: + $ref: '#/components/schemas/_common___EpochTimeUnitMillis' + primary_last_successful_request_timestamp_in_millis: + $ref: '#/components/schemas/_common___EpochTimeUnitMillis' + replica_last_successful_request_timestamp_in_millis: + $ref: '#/components/schemas/_common___EpochTimeUnitMillis' required: - - bound_address - - max_content_length_in_bytes - - publish_address - nodes.info___NodeInfoIngest: + - coordinating_last_successful_request_timestamp_in_millis + - primary_last_successful_request_timestamp_in_millis + - replica_last_successful_request_timestamp_in_millis + nodes.stats___ShardIndexingPressurePerShardMemoryAllocationCurrentStats: type: object properties: - processors: - type: array - items: - $ref: '#/components/schemas/nodes.info___NodeInfoIngestProcessor' + current_coordinating_and_primary_bytes: + $ref: '#/components/schemas/_common___ByteCount' + current_replica_bytes: + $ref: '#/components/schemas/_common___ByteCount' required: - - processors - nodes.info___NodeInfoIngestDownloader: + - current_coordinating_and_primary_bytes + - current_replica_bytes + nodes.stats___ShardIndexingPressurePerShardMemoryAllocationLimitStats: type: object properties: - enabled: - type: string + current_coordinating_and_primary_limits_in_bytes: + $ref: '#/components/schemas/_common___ByteCount' + current_replica_limits_in_bytes: + $ref: '#/components/schemas/_common___ByteCount' required: - - enabled - nodes.info___NodeInfoIngestInfo: + - current_coordinating_and_primary_limits_in_bytes + - current_replica_limits_in_bytes + nodes.stats___ShardIndexingPressurePerShardMemoryAllocationStats: type: object properties: - downloader: - $ref: '#/components/schemas/nodes.info___NodeInfoIngestDownloader' + current: + $ref: '#/components/schemas/nodes.stats___ShardIndexingPressurePerShardMemoryAllocationCurrentStats' + limit: + $ref: '#/components/schemas/nodes.stats___ShardIndexingPressurePerShardMemoryAllocationLimitStats' required: - - downloader - nodes.info___NodeInfoIngestProcessor: + - current + - limit + nodes.stats___ShardIndexingPressurePerShardMemoryStats: type: object properties: - type: - type: string + current: + $ref: '#/components/schemas/nodes.stats___ShardIndexingPressurePerShardMemoryStatsDetails' + total: + $ref: '#/components/schemas/nodes.stats___ShardIndexingPressurePerShardMemoryStatsDetails' required: - - type - nodes.info___NodeInfoJvmMemory: + - current + - total + nodes.stats___ShardIndexingPressurePerShardMemoryStatsDetails: type: object properties: - direct_max: - $ref: '#/components/schemas/_common___HumanReadableByteCount' - direct_max_in_bytes: - $ref: '#/components/schemas/_common___ByteCount' - heap_init: - $ref: '#/components/schemas/_common___HumanReadableByteCount' - heap_init_in_bytes: - $ref: '#/components/schemas/_common___ByteCount' - heap_max: + coordinating: $ref: '#/components/schemas/_common___HumanReadableByteCount' - heap_max_in_bytes: + coordinating_in_bytes: $ref: '#/components/schemas/_common___ByteCount' - non_heap_init: + primary: $ref: '#/components/schemas/_common___HumanReadableByteCount' - non_heap_init_in_bytes: + primary_in_bytes: $ref: '#/components/schemas/_common___ByteCount' - non_heap_max: + replica: $ref: '#/components/schemas/_common___HumanReadableByteCount' - non_heap_max_in_bytes: + replica_in_bytes: $ref: '#/components/schemas/_common___ByteCount' required: - - direct_max_in_bytes - - heap_init_in_bytes - - heap_max_in_bytes - - non_heap_init_in_bytes - - non_heap_max_in_bytes - nodes.info___NodeInfoMemory: + - coordinating_in_bytes + - primary_in_bytes + - replica_in_bytes + nodes.stats___ShardIndexingPressurePerShardRejectionCoordinatingStats: type: object properties: - total: - $ref: '#/components/schemas/_common___HumanReadableByteCount' - total_in_bytes: - $ref: '#/components/schemas/_common___ByteCount' + coordinating_rejections: + type: integer + format: int64 + breakup: + $ref: '#/components/schemas/nodes.stats___ShardIndexingPressureRejectionsBreakupStats' + breakup_shadow_mode: + $ref: '#/components/schemas/nodes.stats___ShardIndexingPressureRejectionsBreakupStats' required: - - total - - total_in_bytes - nodes.info___NodeInfoNetwork: + - coordinating_rejections + nodes.stats___ShardIndexingPressurePerShardRejectionPrimaryStats: type: object properties: - primary_interface: - $ref: '#/components/schemas/nodes.info___NodeInfoNetworkInterface' - refresh_interval: - type: number + primary_rejections: + type: integer + format: int64 + breakup: + $ref: '#/components/schemas/nodes.stats___ShardIndexingPressureRejectionsBreakupStats' + breakup_shadow_mode: + $ref: '#/components/schemas/nodes.stats___ShardIndexingPressureRejectionsBreakupStats' required: - - primary_interface - - refresh_interval - nodes.info___NodeInfoNetworkInterface: + - primary_rejections + nodes.stats___ShardIndexingPressurePerShardRejectionReplicaStats: type: object properties: - address: - type: string - mac_address: - type: string - name: - $ref: '#/components/schemas/_common___Name' + replica_rejections: + type: integer + format: int64 + breakup: + $ref: '#/components/schemas/nodes.stats___ShardIndexingPressureRejectionsBreakupStats' + breakup_shadow_mode: + $ref: '#/components/schemas/nodes.stats___ShardIndexingPressureRejectionsBreakupStats' required: - - address - - mac_address - - name - nodes.info___NodeInfoOSCPU: + - replica_rejections + nodes.stats___ShardIndexingPressurePerShardRejectionStats: type: object properties: - cache_size: - $ref: '#/components/schemas/_common___HumanReadableByteCount' - cache_size_in_bytes: - $ref: '#/components/schemas/_common___ByteCount' - cores_per_socket: - type: number - mhz: - type: number - model: - type: string - total_cores: - type: number - total_sockets: - type: number - vendor: - type: string + coordinating: + $ref: '#/components/schemas/nodes.stats___ShardIndexingPressurePerShardRejectionCoordinatingStats' + primary: + $ref: '#/components/schemas/nodes.stats___ShardIndexingPressurePerShardRejectionPrimaryStats' + replica: + $ref: '#/components/schemas/nodes.stats___ShardIndexingPressurePerShardRejectionReplicaStats' required: - - cache_size - - cache_size_in_bytes - - cores_per_socket - - mhz - - model - - total_cores - - total_sockets - - vendor - nodes.info___NodeInfoPath: + - coordinating + - primary + - replica + nodes.stats___ShardIndexingPressurePerShardStats: type: object properties: - logs: - type: string - home: - type: string - repo: - type: array - items: - type: string - data: - type: array - items: - type: string + memory: + $ref: '#/components/schemas/nodes.stats___ShardIndexingPressurePerShardMemoryStats' + rejection: + $ref: '#/components/schemas/nodes.stats___ShardIndexingPressurePerShardRejectionStats' + last_successful_timestamp: + $ref: '#/components/schemas/nodes.stats___ShardIndexingPressurePerShardLastSuccessfulTimestamp' + indexing: + $ref: '#/components/schemas/nodes.stats___ShardIndexingPressurePerShardIndexingStats' + memory_allocation: + $ref: '#/components/schemas/nodes.stats___ShardIndexingPressurePerShardMemoryAllocationStats' required: - - home - - logs - nodes.info___NodeInfoRepositories: + - indexing + - last_successful_timestamp + - memory + - memory_allocation + - rejection + nodes.stats___ShardIndexingPressureRejectionsBreakupStats: type: object properties: - url: - $ref: '#/components/schemas/nodes.info___NodeInfoRepositoriesUrl' - required: - - url - nodes.info___NodeInfoRepositoriesUrl: + node_limits: + type: integer + format: int64 + no_successful_request_limits: + type: integer + format: int64 + throughput_degradation_limits: + type: integer + format: int64 + nodes.stats___ShardIndexingPressureStats: type: object properties: - allowed_urls: - type: string - required: - - allowed_urls - nodes.info___NodeInfoScript: + stats: + type: object + additionalProperties: + $ref: '#/components/schemas/nodes.stats___ShardIndexingPressurePerShardStats' + enabled: + type: boolean + enforced: + type: boolean + total_rejections_breakup: + $ref: '#/components/schemas/nodes.stats___ShardIndexingPressureRejectionsBreakupStats' + total_rejections_breakup_shadow_mode: + $ref: '#/components/schemas/nodes.stats___ShardIndexingPressureRejectionsBreakupStats' + nodes.stats___ShardRepositoriesStats: + type: array + nodes.stats___ShardResourceUsageStats: + type: object + additionalProperties: + $ref: '#/components/schemas/nodes.stats___ShardResourceUsageStatsDetail' + nodes.stats___ShardResourceUsageStatsDetail: type: object properties: - allowed_types: - type: string - disable_max_compilations_rate: - type: string - required: - - allowed_types - - disable_max_compilations_rate - nodes.info___NodeInfoSearch: + timestamp: + $ref: '#/components/schemas/_common___EpochTimeUnitMillis' + cpu_utilization_percent: + $ref: '#/components/schemas/_common___PercentageString' + memory_utilization_percent: + $ref: '#/components/schemas/_common___PercentageString' + io_usage_stats: + $ref: '#/components/schemas/nodes.stats___ShardResourceUsageStatsIoUsageStats' + nodes.stats___ShardResourceUsageStatsIoUsageStats: type: object properties: - remote: - $ref: '#/components/schemas/nodes.info___NodeInfoSearchRemote' - required: - - remote - nodes.info___NodeInfoSearchPipelines: + max_io_utilization_percent: + $ref: '#/components/schemas/_common___PercentageString' + nodes.stats___ShardSearchBackpressureMode: + type: string + enum: + - disabled + - enforced + - monitor_only + nodes.stats___ShardSearchBackpressureStats: 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: + search_task: + $ref: '#/components/schemas/nodes.stats___ShardSearchBackpressureTaskStats' + search_shard_task: + $ref: '#/components/schemas/nodes.stats___ShardSearchBackpressureTaskStats' + mode: + $ref: '#/components/schemas/nodes.stats___ShardSearchBackpressureMode' + nodes.stats___ShardSearchBackpressureTaskCancellationStats: type: object properties: - connect: - type: string - required: - - connect - nodes.info___NodeInfoSettings: + cancellation_count: + type: integer + format: int64 + cancellation_limit_reached_count: + type: integer + format: int64 + cancelled_task_percentage: + $ref: '#/components/schemas/_common___PercentageNumber' + current_cancellation_eligible_tasks_count: + type: integer + format: int64 + nodes.stats___ShardSearchBackpressureTaskResourceTrackerCpuUsageTrackerStats: type: object properties: - cluster: - $ref: '#/components/schemas/nodes.info___NodeInfoSettingsCluster' - node: - $ref: '#/components/schemas/nodes.info___NodeInfoSettingsNode' - path: - $ref: '#/components/schemas/nodes.info___NodeInfoPath' - repositories: - $ref: '#/components/schemas/nodes.info___NodeInfoRepositories' - discovery: - $ref: '#/components/schemas/nodes.info___NodeInfoDiscovery' - action: - $ref: '#/components/schemas/nodes.info___NodeInfoAction' - client: - $ref: '#/components/schemas/nodes.info___NodeInfoClient' - http: - $ref: '#/components/schemas/nodes.info___NodeInfoSettingsHttp' - bootstrap: - $ref: '#/components/schemas/nodes.info___NodeInfoBootstrap' - transport: - $ref: '#/components/schemas/nodes.info___NodeInfoSettingsTransport' - network: - $ref: '#/components/schemas/nodes.info___NodeInfoSettingsNetwork' - script: - $ref: '#/components/schemas/nodes.info___NodeInfoScript' - search: - $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 - - transport - nodes.info___NodeInfoSettingsCluster: + cancellation_count: + type: integer + format: int64 + current_max: + $ref: '#/components/schemas/_common___Duration' + current_max_millis: + $ref: '#/components/schemas/_common___DurationValueUnitMillis' + current_avg: + $ref: '#/components/schemas/_common___Duration' + current_avg_millis: + $ref: '#/components/schemas/_common___DurationValueUnitMillis' + nodes.stats___ShardSearchBackpressureTaskResourceTrackerElapsedTimeTrackerStats: type: object properties: - name: - $ref: '#/components/schemas/_common___Name' - routing: - $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 - nodes.info___NodeInfoSettingsClusterElection: + cancellation_count: + type: integer + format: int64 + current_max: + $ref: '#/components/schemas/_common___Duration' + current_max_millis: + $ref: '#/components/schemas/_common___DurationValueUnitMillis' + current_avg: + $ref: '#/components/schemas/_common___Duration' + current_avg_millis: + $ref: '#/components/schemas/_common___DurationValueUnitMillis' + nodes.stats___ShardSearchBackpressureTaskResourceTrackerHeapUsageTrackerStats: type: object properties: - strategy: - $ref: '#/components/schemas/_common___Name' - required: - - strategy - nodes.info___NodeInfoSettingsHttp: + cancellation_count: + type: integer + format: int64 + current_max: + $ref: '#/components/schemas/_common___HumanReadableByteCount' + current_max_bytes: + $ref: '#/components/schemas/_common___ByteCount' + current_avg: + $ref: '#/components/schemas/_common___HumanReadableByteCount' + current_avg_bytes: + $ref: '#/components/schemas/_common___ByteCount' + rolling_avg: + $ref: '#/components/schemas/_common___HumanReadableByteCount' + rolling_avg_bytes: + $ref: '#/components/schemas/_common___ByteCount' + nodes.stats___ShardSearchBackpressureTaskResourceTrackerStats: type: object properties: - type: - type: string - type.default: - type: string - compression: - oneOf: - - type: boolean - - type: string - port: - oneOf: - - type: number - - type: string - required: - - type - nodes.info___NodeInfoSettingsIndex: + heap_usage_tracker: + $ref: '#/components/schemas/nodes.stats___ShardSearchBackpressureTaskResourceTrackerHeapUsageTrackerStats' + elapsed_time_tracker: + $ref: '#/components/schemas/nodes.stats___ShardSearchBackpressureTaskResourceTrackerElapsedTimeTrackerStats' + cpu_usage_tracker: + $ref: '#/components/schemas/nodes.stats___ShardSearchBackpressureTaskResourceTrackerCpuUsageTrackerStats' + nodes.stats___ShardSearchBackpressureTaskStats: type: object properties: - store: - $ref: '#/components/schemas/nodes.info___NodeInfoSettingsIndexStore' - nodes.info___NodeInfoSettingsIndexHybrid: + resource_tracker_stats: + $ref: '#/components/schemas/nodes.stats___ShardSearchBackpressureTaskResourceTrackerStats' + cancellation_stats: + $ref: '#/components/schemas/nodes.stats___ShardSearchBackpressureTaskCancellationStats' + completion_count: + x-version-added: '3.0' + type: integer + format: int64 + nodes.stats___ShardSearchPipelineOperationStats: type: object properties: - mmap: - $ref: '#/components/schemas/nodes.info___NodeInfoSettingsIndexStoreMmap' - nodes.info___NodeInfoSettingsIndexStore: + count: + type: integer + format: int64 + time: + $ref: '#/components/schemas/_common___Duration' + time_in_millis: + $ref: '#/components/schemas/_common___DurationValueUnitMillis' + current: + type: integer + format: int64 + failed: + type: integer + format: int64 + nodes.stats___ShardSearchPipelinePerPipelineProcessorStats: type: object properties: - hybrid: - $ref: '#/components/schemas/nodes.info___NodeInfoSettingsIndexHybrid' - nodes.info___NodeInfoSettingsIndexStoreMmap: + type: + type: string + stats: + $ref: '#/components/schemas/nodes.stats___ShardSearchPipelineOperationStats' + nodes.stats___ShardSearchPipelinePerPipelineStats: type: object properties: - extensions: + request: + $ref: '#/components/schemas/nodes.stats___ShardSearchPipelineOperationStats' + response: + $ref: '#/components/schemas/nodes.stats___ShardSearchPipelineOperationStats' + request_processors: type: array items: - type: string - nodes.info___NodeInfoSettingsIngest: - type: object - properties: - attachment: - $ref: '#/components/schemas/nodes.info___NodeInfoIngestInfo' - append: - $ref: '#/components/schemas/nodes.info___NodeInfoIngestInfo' - csv: - $ref: '#/components/schemas/nodes.info___NodeInfoIngestInfo' - convert: - $ref: '#/components/schemas/nodes.info___NodeInfoIngestInfo' - date: - $ref: '#/components/schemas/nodes.info___NodeInfoIngestInfo' - date_index_name: - $ref: '#/components/schemas/nodes.info___NodeInfoIngestInfo' - dot_expander: - $ref: '#/components/schemas/nodes.info___NodeInfoIngestInfo' - enrich: - $ref: '#/components/schemas/nodes.info___NodeInfoIngestInfo' - fail: - $ref: '#/components/schemas/nodes.info___NodeInfoIngestInfo' - foreach: - $ref: '#/components/schemas/nodes.info___NodeInfoIngestInfo' - json: - $ref: '#/components/schemas/nodes.info___NodeInfoIngestInfo' - user_agent: - $ref: '#/components/schemas/nodes.info___NodeInfoIngestInfo' - kv: - $ref: '#/components/schemas/nodes.info___NodeInfoIngestInfo' - geoip: - $ref: '#/components/schemas/nodes.info___NodeInfoIngestInfo' - grok: - $ref: '#/components/schemas/nodes.info___NodeInfoIngestInfo' - gsub: - $ref: '#/components/schemas/nodes.info___NodeInfoIngestInfo' - join: - $ref: '#/components/schemas/nodes.info___NodeInfoIngestInfo' - lowercase: - $ref: '#/components/schemas/nodes.info___NodeInfoIngestInfo' - remove: - $ref: '#/components/schemas/nodes.info___NodeInfoIngestInfo' - rename: - $ref: '#/components/schemas/nodes.info___NodeInfoIngestInfo' - script: - $ref: '#/components/schemas/nodes.info___NodeInfoIngestInfo' - set: - $ref: '#/components/schemas/nodes.info___NodeInfoIngestInfo' - sort: - $ref: '#/components/schemas/nodes.info___NodeInfoIngestInfo' - split: - $ref: '#/components/schemas/nodes.info___NodeInfoIngestInfo' - trim: - $ref: '#/components/schemas/nodes.info___NodeInfoIngestInfo' - uppercase: - $ref: '#/components/schemas/nodes.info___NodeInfoIngestInfo' - urldecode: - $ref: '#/components/schemas/nodes.info___NodeInfoIngestInfo' - bytes: - $ref: '#/components/schemas/nodes.info___NodeInfoIngestInfo' - dissect: - $ref: '#/components/schemas/nodes.info___NodeInfoIngestInfo' - set_security_user: - $ref: '#/components/schemas/nodes.info___NodeInfoIngestInfo' - pipeline: - $ref: '#/components/schemas/nodes.info___NodeInfoIngestInfo' - drop: - $ref: '#/components/schemas/nodes.info___NodeInfoIngestInfo' - circle: - $ref: '#/components/schemas/nodes.info___NodeInfoIngestInfo' - inference: - $ref: '#/components/schemas/nodes.info___NodeInfoIngestInfo' - nodes.info___NodeInfoSettingsNetwork: + $ref: '#/components/schemas/nodes.stats___ShardSearchPipelinePerPipelineProcessorStats' + response_processors: + type: array + items: + type: object + propertyNames: + title: processor_name + type: string + additionalProperties: + $ref: '#/components/schemas/nodes.stats___ShardSearchPipelinePerPipelineProcessorStats' + minProperties: 1 + maxProperties: 1 + nodes.stats___ShardSearchPipelineStats: type: object properties: - host: - $ref: '#/components/schemas/_common___Host' - required: - - host - nodes.info___NodeInfoSettingsNode: + total_request: + $ref: '#/components/schemas/nodes.stats___ShardSearchPipelineOperationStats' + total_response: + $ref: '#/components/schemas/nodes.stats___ShardSearchPipelineOperationStats' + pipelines: + type: object + additionalProperties: + $ref: '#/components/schemas/nodes.stats___ShardSearchPipelinePerPipelineStats' + nodes.stats___ShardSegmentReplicationBackpressureStats: type: object - properties: - name: - $ref: '#/components/schemas/_common___Name' - attr: - $ref: '#/components/schemas/nodes.info___NodeInfoShardIndexingPressureEnabled' - max_local_storage_nodes: - type: string - required: - - attr - - name - nodes.info___NodeInfoSettingsPlugins: + properties: + total_rejected_requests: + type: integer + format: int64 + nodes.stats___ShardTaskCancellationStats: type: object - additionalProperties: - $ref: '#/components/schemas/_common___FieldValue' - nodes.info___NodeInfoSettingsTransport: + properties: + search_shard_task: + $ref: '#/components/schemas/nodes.stats___ShardTaskCancellationStatsDetail' + nodes.stats___ShardTaskCancellationStatsDetail: type: object properties: - type: - type: string - type.default: - type: string - required: - - type - nodes.info___NodeInfoShardIndexingPressureEnabled: + current_count_post_cancel: + type: integer + format: int64 + total_count_post_cancel: + type: integer + format: int64 + nodes.stats___ShardWeightedRoutingStats: type: object properties: - shard_indexing_pressure_enabled: - type: string - required: - - shard_indexing_pressure_enabled - nodes.info___NodeInfoTransport: + stats: + $ref: '#/components/schemas/nodes.stats___ShardWeightedRoutingStatsDetail' + nodes.stats___ShardWeightedRoutingStatsDetail: type: object properties: - bound_address: - type: array - items: - type: string - publish_address: - type: string - profiles: + fail_open_count: + type: integer + format: int32 + nodes.stats___Stats: + type: object + properties: + adaptive_selection: + description: Statistics about adaptive replica selection. + type: object + additionalProperties: + $ref: '#/components/schemas/nodes.stats___AdaptiveSelection' + breakers: + description: Statistics about the field data circuit breaker. + type: object + additionalProperties: + $ref: '#/components/schemas/nodes.stats___Breaker' + fs: + $ref: '#/components/schemas/nodes.stats___FileSystem' + host: + $ref: '#/components/schemas/_common___Host' + http: + $ref: '#/components/schemas/nodes.stats___Http' + ingest: + $ref: '#/components/schemas/nodes.stats___Ingest' + ip: + description: IP address and port for the node. + oneOf: + - $ref: '#/components/schemas/_common___Ip' + - type: array + items: + $ref: '#/components/schemas/_common___Ip' + jvm: + $ref: '#/components/schemas/nodes.stats___Jvm' + name: + $ref: '#/components/schemas/_common___Name' + os: + $ref: '#/components/schemas/nodes.stats___OperatingSystem' + process: + $ref: '#/components/schemas/nodes.stats___Process' + roles: + $ref: '#/components/schemas/_common___NodeRoles' + script: + $ref: '#/components/schemas/nodes.stats___ScriptStats' + script_cache: + $ref: '#/components/schemas/nodes.stats___ScriptCacheStats' + thread_pool: + description: Statistics about each thread pool, including current size, queue and rejected tasks. + type: object + additionalProperties: + $ref: '#/components/schemas/nodes.stats___ThreadCount' + timestamp: + $ref: '#/components/schemas/_common___EpochTimeUnitMillis' + transport: + $ref: '#/components/schemas/nodes.stats___Transport' + transport_address: + $ref: '#/components/schemas/_common___TransportAddress' + attributes: + description: Contains a list of attributes for the node. type: object additionalProperties: type: string - required: - - bound_address - - profiles - - publish_address - nodes.info___NodeJvmInfo: + discovery: + $ref: '#/components/schemas/nodes.stats___Discovery' + indexing_pressure: + $ref: '#/components/schemas/nodes.stats___IndexingPressure' + indices: + $ref: '#/components/schemas/nodes.stats___NodeIndicesStats' + shard_indexing_pressure: + $ref: '#/components/schemas/nodes.stats___ShardIndexingPressureStats' + search_backpressure: + $ref: '#/components/schemas/nodes.stats___ShardSearchBackpressureStats' + cluster_manager_throttling: + $ref: '#/components/schemas/nodes.stats___ShardClusterManagerThrottlingStats' + weighted_routing: + $ref: '#/components/schemas/nodes.stats___ShardWeightedRoutingStats' + task_cancellation: + $ref: '#/components/schemas/nodes.stats___ShardTaskCancellationStats' + resource_usage_stats: + $ref: '#/components/schemas/nodes.stats___ShardResourceUsageStats' + search_pipeline: + $ref: '#/components/schemas/nodes.stats___ShardSearchPipelineStats' + segment_replication_backpressure: + $ref: '#/components/schemas/nodes.stats___ShardSegmentReplicationBackpressureStats' + remote_store: + $ref: '#/components/schemas/nodes.stats___RemoteStoreStats' + repositories: + $ref: '#/components/schemas/nodes.stats___ShardRepositoriesStats' + admission_control: + $ref: '#/components/schemas/nodes.stats___ShardAdmissionControlStats' + caches: + $ref: '#/components/schemas/nodes.stats___ShardCachesStats' + nodes.stats___ThreadCount: type: object properties: - gc_collectors: - type: array - items: - type: string - mem: - $ref: '#/components/schemas/nodes.info___NodeInfoJvmMemory' - memory_pools: - type: array - items: - type: string - pid: - type: number - start_time_in_millis: - $ref: '#/components/schemas/_common___EpochTimeUnitMillis' - version: - $ref: '#/components/schemas/_common___VersionString' - vm_name: - $ref: '#/components/schemas/_common___Name' - vm_vendor: - type: string - vm_version: - $ref: '#/components/schemas/_common___VersionString' - bundled_jdk: - type: boolean - using_bundled_jdk: - type: - - boolean - - 'null' - using_compressed_ordinary_object_pointers: - oneOf: - - type: boolean - - type: string - input_arguments: - type: array - items: - type: string - required: - - bundled_jdk - - mem - - pid - - start_time_in_millis - nodes.info___NodeOperatingSystemInfo: + active: + description: Number of active threads in the thread pool. + type: integer + format: int64 + completed: + description: Number of tasks completed by the thread pool executor. + type: integer + format: int64 + largest: + description: Highest number of active threads in the thread pool. + type: integer + format: int64 + queue: + description: Number of tasks in queue for the thread pool. + type: integer + format: int64 + rejected: + description: Number of tasks rejected by the thread pool executor. + type: integer + format: int64 + threads: + description: Number of threads in the thread pool. + type: integer + format: int64 + total_wait_time: + description: | + The total amount of time that tasks spend waiting in the thread pool queue. + Currently, only `search`, `search_throttled`, and `index_searcher` thread pools support this metric. + $ref: '#/components/schemas/_common___Duration' + 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. + $ref: '#/components/schemas/_common___DurationValueUnitNanos' + nodes.stats___Transport: type: object properties: - arch: - description: 'Name of the JVM architecture (ex: amd64, x86)' - type: string - available_processors: - description: Number of processors available to the Java virtual machine - type: number - allocated_processors: - description: The number of processors actually used to calculate thread pool size. This number can be set with the node.processors setting of a node and defaults to the number of processors reported by the OS. - type: number - name: - $ref: '#/components/schemas/_common___Name' - pretty_name: - $ref: '#/components/schemas/_common___Name' - refresh_interval_in_millis: - $ref: '#/components/schemas/_common___DurationValueUnitMillis' - version: - $ref: '#/components/schemas/_common___VersionString' - cpu: - $ref: '#/components/schemas/nodes.info___NodeInfoOSCPU' - mem: - $ref: '#/components/schemas/nodes.info___NodeInfoMemory' - swap: - $ref: '#/components/schemas/nodes.info___NodeInfoMemory' - required: - - available_processors - - refresh_interval_in_millis - nodes.info___NodeProcessInfo: + rx_count: + description: Total number of RX (receive) packets received by the node during internal cluster communication. + type: integer + format: int64 + rx_size: + description: Size of RX packets received by the node during internal cluster communication. + $ref: '#/components/schemas/_common___HumanReadableByteCount' + rx_size_in_bytes: + description: Size, in bytes, of RX packets received by the node during internal cluster communication. + $ref: '#/components/schemas/_common___ByteCount' + server_open: + description: Current number of inbound TCP connections used for internal communication between nodes. + type: integer + format: int64 + tx_count: + description: Total number of TX (transmit) packets sent by the node during internal cluster communication. + type: integer + format: int64 + tx_size: + description: Size of TX packets sent by the node during internal cluster communication. + $ref: '#/components/schemas/_common___HumanReadableByteCount' + tx_size_in_bytes: + description: Size, in bytes, of TX packets sent by the node during internal cluster communication. + $ref: '#/components/schemas/_common___ByteCount' + total_outbound_connections: + description: |- + The cumulative number of outbound transport connections that this node has opened since it started. + Each transport connection may comprise multiple TCP connections but is only counted once in this statistic. + Transport connections are typically long-lived so this statistic should remain constant in a stable cluster. + type: integer + format: int64 + nodes.stats___TransportUsageStats: type: object properties: - id: - description: Process identifier (PID) - type: number - mlockall: - description: Indicates if the process address space has been successfully locked in memory - type: boolean - refresh_interval_in_millis: - $ref: '#/components/schemas/_common___DurationValueUnitMillis' - required: - - id - - mlockall - - refresh_interval_in_millis - nodes.info___NodeThreadPoolInfo: + rejection_count: + type: object + additionalProperties: + type: integer + format: int64 + nodes.stats___UsageStats: type: object properties: - core: - type: number - keep_alive: - $ref: '#/components/schemas/_common___Duration' - max: - type: number - queue_size: - type: number - size: - type: number - type: - type: string - required: - - queue_size - - type - nodes.info___ResponseBase: - allOf: - - $ref: '#/components/schemas/nodes._common___NodesResponseBase' - - type: object - properties: - cluster_name: - $ref: '#/components/schemas/_common___Name' - nodes: - type: object - additionalProperties: - $ref: '#/components/schemas/nodes.info___NodeInfo' - required: - - cluster_name - - nodes - nodes.reload_secure_settings___ResponseBase: - allOf: - - $ref: '#/components/schemas/nodes._common___NodesResponseBase' - - type: object - properties: - cluster_name: - $ref: '#/components/schemas/_common___Name' - nodes: - type: object - additionalProperties: - $ref: '#/components/schemas/nodes._common___NodeReloadResult' - required: - - cluster_name - - nodes - nodes.stats___IndexMetric: - type: string - enum: - - _all - - completion - - docs - - fielddata - - flush - - get - - indexing - - merge - - query_cache - - recovery - - refresh - - request_cache - - search - - segments - - store - - suggest - - 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 - - weighted_routing - nodes.stats___ResponseBase: - allOf: - - $ref: '#/components/schemas/nodes._common___NodesResponseBase' - - type: object - properties: - cluster_name: - $ref: '#/components/schemas/_common___Name' - nodes: - type: object - additionalProperties: - $ref: '#/components/schemas/nodes._common___Stats' - required: - - nodes + transport: + $ref: '#/components/schemas/nodes.stats___TransportUsageStats' nodes.usage___Metric: type: string enum: - _all + - aggregations - rest_actions nodes.usage___NodeUsage: type: object @@ -53733,34 +59387,18 @@ components: rest_actions: type: object additionalProperties: - type: number + type: integer + format: int64 since: $ref: '#/components/schemas/_common___EpochTimeUnitMillis' timestamp: $ref: '#/components/schemas/_common___EpochTimeUnitMillis' aggregations: type: object - additionalProperties: - type: object + additionalProperties: true required: - - aggregations - - rest_actions - since - timestamp - nodes.usage___ResponseBase: - allOf: - - $ref: '#/components/schemas/nodes._common___NodesResponseBase' - - type: object - properties: - cluster_name: - $ref: '#/components/schemas/_common___Name' - nodes: - type: object - additionalProperties: - $ref: '#/components/schemas/nodes.usage___NodeUsage' - required: - - cluster_name - - nodes notifications._common___Chime: type: object properties: @@ -54094,7 +59732,6 @@ components: $ref: '#/components/schemas/observability._common___SavedQuery' required: - objectId - - tenant observability._common___ObservabilityObjectList: type: object properties: @@ -54420,19 +60057,228 @@ components: successful: type: integer format: int32 - rollups._common___Continuous: + replication._common___AutoFollowStats: + type: object + properties: + name: + type: string + pattern: + type: string + num_success_start_replication: + type: number + num_failed_start_replication: + type: number + num_failed_leader_calls: + type: number + failed_indices: + type: array + items: + type: string + last_execution_time: + type: number + replication._common___AutoFollowStatus: + type: object + properties: + num_success_start_replication: + type: number + num_failed_start_replication: + type: number + num_failed_leader_calls: + type: number + failed_indices: + type: array + items: + type: string + autofollow_stats: + type: array + items: + $ref: '#/components/schemas/replication._common___AutoFollowStats' + replication._common___CreateReplicationRule: + type: object + properties: + leader_alias: + $ref: '#/components/schemas/_common___IndexAlias' + name: + type: string + pattern: + type: string + use_roles: + $ref: '#/components/schemas/replication._common___UseRoles' + replication._common___DeleteReplicationRule: + type: object + properties: + leader_alias: + $ref: '#/components/schemas/_common___IndexAlias' + name: + type: string + replication._common___FollowerStatus: type: object properties: - next_window_start_time: + num_syncing_indices: type: number - next_window_end_time: + num_bootstrapping_indices: type: number + num_paused_indices: + type: number + num_failed_indices: + type: number + num_shard_tasks: + type: number + num_index_tasks: + type: number + operations_written: + type: number + operations_read: + type: number + failed_read_requests: + type: number + throttled_read_requests: + type: number + failed_write_requests: + type: number + throttled_write_requests: + type: number + follower_checkpoint: + type: number + leader_checkpoint: + type: number + total_write_time_millis: + $ref: '#/components/schemas/_common___StringifiedEpochTimeUnitMillis' + index_stats: + type: object + additionalProperties: + $ref: '#/components/schemas/replication._common___IndexFollowerStatus' + replication._common___IndexFollowerStatus: + type: object + properties: + operations_written: + type: number + operations_read: + type: number + failed_read_requests: + type: number + throttled_read_requests: + type: number + failed_write_requests: + type: number + throttled_write_requests: + type: number + follower_checkpoint: + type: number + leader_checkpoint: + type: number + total_write_time_millis: + $ref: '#/components/schemas/_common___StringifiedEpochTimeUnitMillis' + replication._common___IndexSchema: + type: object + properties: + number_of_shards: + type: integer + number_of_replicas: + type: integer + replication._common___IndexStatus: + type: object + properties: + operations_read: + type: number + translog_size_bytes: + $ref: '#/components/schemas/_common___ByteCount' + operations_read_lucene: + type: number + operations_read_translog: + type: number + total_read_time_lucene_millis: + $ref: '#/components/schemas/_common___StringifiedEpochTimeUnitMillis' + total_read_time_translog_millis: + $ref: '#/components/schemas/_common___StringifiedEpochTimeUnitMillis' + bytes_read: + $ref: '#/components/schemas/_common___ByteCount' + replication._common___LeaderStatus: + type: object + properties: + num_replicated_indices: + type: number + operations_read: + type: number + translog_size_bytes: + $ref: '#/components/schemas/_common___ByteCount' + operations_read_lucene: + type: number + operations_read_translog: + type: number + total_read_time_lucene_millis: + $ref: '#/components/schemas/_common___StringifiedEpochTimeUnitMillis' + total_read_time_translog_millis: + $ref: '#/components/schemas/_common___StringifiedEpochTimeUnitMillis' + bytes_read: + $ref: '#/components/schemas/_common___ByteCount' + index_stats: + type: object + additionalProperties: + $ref: '#/components/schemas/replication._common___IndexStatus' + replication._common___Replication: + type: object + properties: + leader_alias: + $ref: '#/components/schemas/_common___IndexAlias' + leader_index: + $ref: '#/components/schemas/_common___IndexName' + use_roles: + $ref: '#/components/schemas/replication._common___UseRoles' + replication._common___SettingsBody: + type: object + properties: + index: + $ref: '#/components/schemas/replication._common___IndexSchema' + replication._common___Status: + type: object + properties: status: type: string - failure_reason: + enum: + - BOOTSTRAPPING + - PAUSED + - REPLICATION NOT IN PROGRESS + - RUNNING + - SYNCING + reason: + type: string + leader_alias: + $ref: '#/components/schemas/_common___IndexAlias' + leader_index: + $ref: '#/components/schemas/_common___IndexName' + follower_index: + $ref: '#/components/schemas/_common___IndexName' + syncing_details: + $ref: '#/components/schemas/replication._common___SyncingDetails' + replication._common___SyncingDetails: + type: object + properties: + leader_checkpoint: + type: integer + follower_checkpoint: + type: integer + seq_no: + $ref: '#/components/schemas/_common___SequenceNumber' + replication._common___UpdateSettings: + type: object + properties: + settings: + allOf: + - type: object + properties: + index.number_of_shards: + type: integer + index.number_of_replicas: + type: integer + - $ref: '#/components/schemas/replication._common___SettingsBody' + replication._common___UseRoles: + type: object + properties: + leader_cluster_role: + type: string + follower_cluster_role: type: string - stats: - $ref: '#/components/schemas/rollups._common___Stats' rollups._common___Cron: type: object properties: @@ -54453,6 +60299,10 @@ components: type: string target_field: type: string + format: + type: + - 'null' + - string rollups._common___DimensionsConfigItem: type: object properties: @@ -54467,17 +60317,18 @@ components: rollups._common___Explain: type: object properties: - rollup_id: - type: string - last_updated_time: - type: number - continuous: - $ref: '#/components/schemas/rollups._common___Continuous' + metadata_id: + type: + - 'null' + - string + rollup_metadata: + type: + - 'null' + - object rollups._common___ExplainEntities: type: object - properties: - item: - $ref: '#/components/schemas/rollups._common___Explain' + additionalProperties: + $ref: '#/components/schemas/rollups._common___Explain' rollups._common___HistogramDimension: type: object properties: @@ -54552,7 +60403,9 @@ components: target_index: type: string metadata_id: - type: string + type: + - 'null' + - string page_size: type: number delay: @@ -54574,11 +60427,14 @@ components: type: object properties: _id: - type: string - _seqNo: - type: number - _primaryTerm: - type: number + $ref: '#/components/schemas/_common___Id' + _seq_no: + $ref: '#/components/schemas/_common___SequenceNumber' + _primary_term: + type: integer + format: int64 + _version: + $ref: '#/components/schemas/_common___VersionNumber' rollup: $ref: '#/components/schemas/rollups._common___Rollup' rollups._common___Schedule: @@ -54586,19 +60442,6 @@ components: properties: interval: $ref: '#/components/schemas/rollups._common___Interval' - rollups._common___Stats: - type: object - properties: - pages_processed: - type: number - documents_processed: - type: number - rollups_indexed: - type: number - index_time_in_ms: - type: number - search_time_in_ms: - type: number rollups._common___TermsDimension: type: object properties: @@ -55105,7 +60948,7 @@ components: type: boolean requests: type: object - description: An object with APIs as key and array of http methods as values. + description: An object with APIs as key and array of HTTP methods as values. security._common___AuditConfig: type: object properties: @@ -55168,7 +61011,7 @@ components: properties: user: type: string - description: Stringified User object. + description: A User object as a string. user_name: type: string description: User's name. @@ -55214,7 +61057,7 @@ components: type: - 'null' - string - description: Logout url. + description: Logout URL. size_of_user: type: string description: Size of user in memory. @@ -55450,7 +61293,7 @@ components: description: The generated OBO token. durationSeconds: type: string - description: The duration of the token, defaulted to 300s. + description: The duration of the token. Default is `300s`. security._common___GetCertificates: type: object properties: @@ -55565,6 +61408,10 @@ components: required: - op - path + security._common___PatchOperations: + type: array + items: + $ref: '#/components/schemas/security._common___PatchOperation' security._common___PermissionsInfo: type: object properties: @@ -55576,7 +61423,7 @@ components: type: boolean disabled_endpoints: type: object - description: An object with disabled APIs as key and array of http methods as values. + description: An object with disabled APIs as key and array of HTTP methods as values. security._common___Role: type: object properties: @@ -55667,30 +61514,30 @@ components: type: - 'null' - string - description: Protocol for this ssl setup. + description: Protocol for this SSL setup. ssl_cipher: type: - 'null' - string - description: Cipher for this ssl setup. + description: Cipher for this SSL setup. ssl_openssl_available: type: boolean - description: A boolean to indicate if OpenSSL is available. + description: A Boolean to indicate if OpenSSL is available. ssl_openssl_version: type: - number - string - description: Version of openssl. + description: Version of OpenSSL. ssl_openssl_version_string: type: - 'null' - string - description: Full version string for openssl version. + description: Full version string for OpenSSL version. ssl_openssl_non_available_cause: type: - 'null' - string - description: Reason for openssl unavailability. + description: Reason for OpenSSL unavailability. ssl_openssl_supports_key_manager_factory: type: boolean description: Indicates where KMF is supported. @@ -55701,7 +61548,7 @@ components: type: - 'null' - string - description: Returns http provider's name. + description: Returns HTTP provider's name. ssl_provider_transport_server: type: string description: Returns transport server's name. @@ -55821,11 +61668,361 @@ components: type: boolean is_node_certificate_request: type: boolean + sm._common___BadRequestResponse: + type: object + properties: + error: + type: string + status: + type: integer + sm._common___CreateUpdatePolicyRequest: + type: object + properties: + description: + type: string + creation: + $ref: '#/components/schemas/sm._common___CreationConfig' + deletion: + $ref: '#/components/schemas/sm._common___DeletionConfig' + snapshot_config: + $ref: '#/components/schemas/sm._common___SnapshotConfig' + notification: + $ref: '#/components/schemas/sm._common___NotificationConfig' + enabled: + type: boolean + description: 'Whether the policy should be enabled at creation. Default: true' + required: + - creation + - snapshot_config + sm._common___CreationConfig: + type: object + properties: + schedule: + $ref: '#/components/schemas/sm._common___CronSchedule' + time_limit: + type: string + description: Maximum time for snapshot creation. + required: + - schedule + sm._common___CronExpression: + type: object + properties: + expression: + type: string + timezone: + type: string + required: + - expression + - timezone + sm._common___CronSchedule: + type: object + properties: + cron: + $ref: '#/components/schemas/sm._common___CronExpression' + sm._common___DeletePolicyResponse: + type: object + properties: + _index: + type: string + _id: + type: string + _version: + type: integer + result: + type: string + forced_refresh: + type: boolean + _shards: + $ref: '#/components/schemas/sm._common___ShardsInfo' + _seq_no: + type: integer + _primary_term: + type: integer + required: + - _id + - _index + - _primary_term + - _seq_no + - _shards + - _version + - forced_refresh + - result + sm._common___DeletionCondition: + type: object + properties: + max_age: + type: string + max_count: + type: integer + min_count: + type: integer + sm._common___DeletionConfig: + type: object + properties: + schedule: + $ref: '#/components/schemas/sm._common___CronSchedule' + condition: + $ref: '#/components/schemas/sm._common___DeletionCondition' + time_limit: + type: string + sm._common___ExecutionInfo: + type: object + properties: + message: + type: string + cause: + type: string + sm._common___ExecutionMetadata: + type: object + properties: + info: + $ref: '#/components/schemas/sm._common___ExecutionInfo' + sm._common___ExplainedPolicy: + type: object + properties: + name: + type: string + creation: + $ref: '#/components/schemas/sm._common___StateMetadata' + deletion: + $ref: '#/components/schemas/sm._common___StateMetadata' + policy_seq_no: + type: integer + policy_primary_term: + type: integer + enabled: + type: boolean + sm._common___GetPoliciesResponse: + type: object + properties: + total_policies: + type: integer + policies: + type: array + items: + $ref: '#/components/schemas/sm._common___ListedPolicy' + required: + - policies + - total_policies + sm._common___IntervalConfig: + type: object + properties: + start_time: + type: integer + period: + type: integer + unit: + type: string + enum: + - Days + - Hours + - Minutes + required: + - period + - start_time + - unit + sm._common___IntervalSchedule: + type: object + properties: + interval: + $ref: '#/components/schemas/sm._common___IntervalConfig' + sm._common___ListedPolicy: + type: object + properties: + _id: + type: string + _seq_no: + type: integer + _primary_term: + type: integer + sm_policy: + $ref: '#/components/schemas/sm._common___SMPolicy' + required: + - _id + - sm_policy + sm._common___NotFoundError: + type: object + properties: + root_cause: + type: array + items: + $ref: '#/components/schemas/sm._common___RootCause' + type: + type: string + reason: + type: string + required: + - reason + - type + sm._common___NotFoundResponse: + type: object + properties: + error: + $ref: '#/components/schemas/sm._common___NotFoundError' + status: + type: integer + required: + - error + - status + sm._common___NotificationChannel: + type: object + properties: + id: + type: string + required: + - id + sm._common___NotificationConditions: + type: object + properties: + creation: + type: boolean + default: true + deletion: + type: boolean + default: false + failure: + type: boolean + default: false + time_limit_exceeded: + type: boolean + default: false + sm._common___NotificationConfig: + type: object + properties: + channel: + $ref: '#/components/schemas/sm._common___NotificationChannel' + conditions: + $ref: '#/components/schemas/sm._common___NotificationConditions' + sm._common___PolicyExplanation: + type: object + properties: + policies: + type: array + items: + $ref: '#/components/schemas/sm._common___ExplainedPolicy' + sm._common___PolicyResponse: + type: object + properties: + _id: + type: string + _version: + type: integer + _seq_no: + type: integer + _primary_term: + type: integer + sm_policy: + $ref: '#/components/schemas/sm._common___SMPolicy' + required: + - _id + - _primary_term + - _seq_no + - _version + - sm_policy + sm._common___RetryMetadata: + type: object + properties: + count: + type: integer + sm._common___RootCause: + type: object + properties: + type: + type: string + reason: + type: string + sm._common___ShardsInfo: + type: object + properties: + total: + type: integer + successful: + type: integer + failed: + type: integer + sm._common___SMPolicy: + type: object + properties: + name: + type: string + description: + type: string + schema_version: + type: integer + creation: + $ref: '#/components/schemas/sm._common___CreationConfig' + deletion: + $ref: '#/components/schemas/sm._common___DeletionConfig' + description: Configuration for snapshot deletion, optional. + snapshot_config: + $ref: '#/components/schemas/sm._common___SnapshotConfig' + notification: + $ref: '#/components/schemas/sm._common___NotificationConfig' + schedule: + $ref: '#/components/schemas/sm._common___IntervalSchedule' + description: System-generated schedule metadata returned by the API. + enabled: + type: boolean + last_updated_time: + type: integer + enabled_time: + type: integer + required: + - creation + - description + - name + - snapshot_config + sm._common___SnapshotConfig: + type: object + properties: + date_format: + type: string + description: Default "yyyy-MM-dd'T'HH:mm:ss" + timezone: + type: string + description: Default UTC + indices: + type: string + description: Default "*" + repository: + type: string + ignore_unavailable: + type: boolean + description: Default false + include_global_state: + type: boolean + description: Default true + partial: + type: boolean + description: Default false + metadata: + type: object + additionalProperties: + type: string + required: + - repository + sm._common___StateMetadata: + type: object + properties: + current_state: + type: string + trigger: + $ref: '#/components/schemas/sm._common___TriggerMetadata' + latest_execution: + $ref: '#/components/schemas/sm._common___ExecutionMetadata' + retry: + $ref: '#/components/schemas/sm._common___RetryMetadata' + sm._common___TriggerMetadata: + type: object + properties: + time: + type: integer snapshot._common___FileCountSnapshotStats: type: object properties: file_count: - type: number + type: integer + format: int32 size_in_bytes: $ref: '#/components/schemas/_common___ByteCount' required: @@ -55849,79 +62046,15 @@ components: chunk_size: type: string compress: - oneOf: - - type: string - - type: boolean + $ref: '#/components/schemas/_common___StringifiedBoolean' concurrent_streams: - oneOf: - - type: string - - type: number + $ref: '#/components/schemas/_common___StringifiedInteger' location: type: string read_only: - oneOf: - - type: string - - type: boolean + $ref: '#/components/schemas/_common___StringifiedBoolean' required: - location - snapshot._common___ShardsStats: - type: object - properties: - done: - type: number - failed: - type: number - finalizing: - type: number - initializing: - type: number - started: - type: number - total: - type: number - required: - - done - - failed - - finalizing - - initializing - - started - - total - snapshot._common___ShardsStatsStage: - type: string - enum: - - DONE - - FAILURE - - FINALIZE - - INIT - - STARTED - snapshot._common___ShardsStatsSummary: - type: object - properties: - incremental: - $ref: '#/components/schemas/snapshot._common___ShardsStatsSummaryItem' - total: - $ref: '#/components/schemas/snapshot._common___ShardsStatsSummaryItem' - start_time_in_millis: - $ref: '#/components/schemas/_common___EpochTimeUnitMillis' - time: - $ref: '#/components/schemas/_common___Duration' - time_in_millis: - $ref: '#/components/schemas/_common___DurationValueUnitMillis' - required: - - incremental - - start_time_in_millis - - time_in_millis - - total - snapshot._common___ShardsStatsSummaryItem: - type: object - properties: - file_count: - type: number - size_in_bytes: - $ref: '#/components/schemas/_common___ByteCount' - required: - - file_count - - size_in_bytes snapshot._common___SnapshotIndexStats: type: object properties: @@ -55930,7 +62063,7 @@ components: additionalProperties: $ref: '#/components/schemas/snapshot._common___SnapshotShardsStatus' shards_stats: - $ref: '#/components/schemas/snapshot._common___ShardsStats' + $ref: '#/components/schemas/snapshot._common___SnapshotShardsStats' stats: $ref: '#/components/schemas/snapshot._common___SnapshotStats' required: @@ -56008,13 +62141,93 @@ components: - reason - shard_id - status + snapshot._common___SnapshotShardsStats: + type: object + properties: + done: + type: integer + format: int64 + failed: + type: integer + format: int64 + finalizing: + type: integer + format: int64 + initializing: + type: integer + format: int64 + started: + type: integer + format: int64 + total: + type: integer + format: int64 + required: + - done + - failed + - finalizing + - initializing + - started + - total + snapshot._common___SnapshotShardsStatsStage: + oneOf: + - type: string + const: DONE + description: Number of shards in the snapshot that were successfully stored in the repository. + - type: string + const: FAILURE + description: Number of shards in the snapshot that were not successfully stored in the repository. + - type: string + const: FINALIZE + description: Number of shards in the snapshot that are in the finalizing stage of being stored in the repository. + - type: string + const: INIT + description: Number of shards in the snapshot that are in the initializing stage of being stored in the repository. + - type: string + const: STARTED + description: Number of shards in the snapshot that are in the started stage of being stored in the repository. + snapshot._common___SnapshotShardsStatsSummary: + type: object + properties: + incremental: + $ref: '#/components/schemas/snapshot._common___SnapshotShardsStatsSummaryItem' + processed: + $ref: '#/components/schemas/snapshot._common___SnapshotShardsStatsSummaryItem' + total: + $ref: '#/components/schemas/snapshot._common___SnapshotShardsStatsSummaryItem' + start_time_in_millis: + $ref: '#/components/schemas/_common___EpochTimeUnitMillis' + time: + $ref: '#/components/schemas/_common___Duration' + time_in_millis: + $ref: '#/components/schemas/_common___DurationValueUnitMillis' + required: + - incremental + - start_time_in_millis + - time_in_millis + - total + snapshot._common___SnapshotShardsStatsSummaryItem: + type: object + properties: + file_count: + type: integer + format: int64 + size_in_bytes: + $ref: '#/components/schemas/_common___ByteCount' + required: + - file_count + - size_in_bytes snapshot._common___SnapshotShardsStatus: type: object properties: + node: + $ref: '#/components/schemas/_common___NodeId' + reason: + type: string stage: - $ref: '#/components/schemas/snapshot._common___ShardsStatsStage' + $ref: '#/components/schemas/snapshot._common___SnapshotShardsStatsStage' stats: - $ref: '#/components/schemas/snapshot._common___ShardsStatsSummary' + $ref: '#/components/schemas/snapshot._common___SnapshotShardsStatsSummary' required: - stage - stats @@ -56023,6 +62236,8 @@ components: properties: incremental: $ref: '#/components/schemas/snapshot._common___FileCountSnapshotStats' + processed: + $ref: '#/components/schemas/snapshot._common___FileCountSnapshotStats' start_time_in_millis: $ref: '#/components/schemas/_common___EpochTimeUnitMillis' time: @@ -56036,7 +62251,7 @@ components: - start_time_in_millis - time_in_millis - total - snapshot._common___Status: + snapshot._common___SnapshotStatus: type: object properties: include_global_state: @@ -56048,7 +62263,7 @@ components: repository: type: string shards_stats: - $ref: '#/components/schemas/snapshot._common___ShardsStats' + $ref: '#/components/schemas/snapshot._common___SnapshotShardsStats' snapshot: type: string state: @@ -56058,7 +62273,6 @@ components: uuid: $ref: '#/components/schemas/_common___Uuid' required: - - include_global_state - indices - repository - shards_stats @@ -56308,7 +62522,7 @@ components: - tasks tasks._common___TaskGroup: allOf: - - $ref: '#/components/schemas/tasks._common___TaskInfo' + - $ref: '#/components/schemas/tasks._common___TaskInfoBase' - type: object properties: children: @@ -56316,6 +62530,11 @@ components: items: $ref: '#/components/schemas/tasks._common___TaskGroup' tasks._common___TaskInfo: + allOf: + - $ref: '#/components/schemas/tasks._common___TaskInfoBase' + - type: object + properties: {} + tasks._common___TaskInfoBase: type: object properties: action: @@ -56324,6 +62543,8 @@ components: type: boolean cancellable: type: boolean + cancellation_time_millis: + $ref: '#/components/schemas/_common___EpochTimeUnitMillis' description: type: string headers: @@ -56347,6 +62568,8 @@ components: type: string parent_task_id: $ref: '#/components/schemas/_common___TaskId' + resource_stats: + $ref: '#/components/schemas/_common___ResourceStats' required: - action - cancellable @@ -56409,13 +62632,68 @@ components: type: string target_field: type: string + transforms._common___DeletedTransformResponse: + type: object + properties: + _type: + $ref: '#/components/schemas/_common___Type' + _index: + type: string + _id: + $ref: '#/components/schemas/_common___Id' + _version: + $ref: '#/components/schemas/_common___VersionNumber' + result: + type: string + forced_refresh: + type: boolean + _shards: + $ref: '#/components/schemas/_common___ShardStatistics' + _primary_term: + type: integer + format: int64 + _seq_no: + $ref: '#/components/schemas/_common___SequenceNumber' + status: + type: number + required: + - _id + - _index + - _primary_term + - _seq_no + - _shards + - _version + - forced_refresh + - result + - status + transforms._common___DeleteTransformResponseItem: + type: object + properties: + delete: + $ref: '#/components/schemas/transforms._common___DeletedTransformResponse' + transforms._common___DeleteTransformsResponse: + type: object + properties: + took: + type: integer + format: int64 + errors: + type: boolean + items: + type: array + items: + $ref: '#/components/schemas/transforms._common___DeleteTransformResponseItem' transforms._common___Explain: type: object properties: metadata_id: - type: string + type: + - 'null' + - string transform_metadata: - $ref: '#/components/schemas/transforms._common___TransformMetadata' + oneOf: + - $ref: '#/components/schemas/transforms._common___TransformMetadata' + - type: 'null' transforms._common___ExplainResponse: type: object additionalProperties: @@ -56453,32 +62731,6 @@ components: type: string interval: type: string - transforms._common___MetricsConfigItem: - type: object - properties: - source_field: - type: string - target_field: - type: string - metrics: - type: array - items: - $ref: '#/components/schemas/transforms._common___MetricsConfigMetrics' - transforms._common___MetricsConfigMetrics: - type: object - properties: - avg: - type: object - sum: - type: object - max: - type: object - min: - type: object - value_count: - type: object - minProperties: 1 - maxProperties: 1 transforms._common___Preview: type: object properties: @@ -56521,13 +62773,17 @@ components: schedule: $ref: '#/components/schemas/transforms._common___Schedule' metadata_id: - type: string + type: + - 'null' + - string updated_at: - type: string + type: number enabled: type: boolean enabled_at: - type: number + type: + - 'null' + - number description: type: string source_index: @@ -56547,20 +62803,9 @@ components: items: $ref: '#/components/schemas/transforms._common___GroupsConfigItem' aggregations: - type: array - items: - $ref: '#/components/schemas/transforms._common___MetricsConfigItem' - transforms._common___TransformEntity: - type: object - properties: - _id: - type: string - _seqNo: - type: number - _primaryTerm: - type: number - transform: - $ref: '#/components/schemas/transforms._common___Transform' + type: object + additionalProperties: + $ref: '#/components/schemas/transforms._common___GroupsConfigItem' transforms._common___TransformMetadata: type: object properties: @@ -56576,6 +62821,27 @@ components: type: string stats: $ref: '#/components/schemas/transforms._common___ExplainStats' + transforms._common___TransformRequest: + type: object + properties: + transform: + $ref: '#/components/schemas/transforms._common___Transform' + required: + - transform + transforms._common___TransformResponse: + type: object + properties: + _id: + $ref: '#/components/schemas/_common___Id' + _primary_term: + type: integer + format: int64 + _seq_no: + $ref: '#/components/schemas/_common___SequenceNumber' + _version: + $ref: '#/components/schemas/_common___VersionNumber' + transform: + $ref: '#/components/schemas/transforms._common___Transform' transforms._common___TransformsResponse: type: object properties: @@ -56584,7 +62850,7 @@ components: transforms: type: array items: - $ref: '#/components/schemas/transforms._common___TransformEntity' + $ref: '#/components/schemas/transforms._common___TransformResponse' wlm._common___QueryGroupCreate: type: object properties: @@ -56626,19 +62892,24 @@ components: type: object properties: _id: + description: The ID of the query group, which can be used to associate query requests with the group and enforce the group's resource limits. type: string name: + description: The name of the query group. type: string resiliency_mode: + description: The resiliency mode of the query group. type: string enum: - enforced - monitor - soft updated_at: + description: The time at which the query group was last updated. type: integer format: int64 resource_limits: + description: The resource limits for query requests in the query group. anyOf: - type: object properties: diff --git a/tests/tests_test_workflow/test_smoke_workflow/smoke_test/test_smoke_test_runner_opensearch.py b/tests/tests_test_workflow/test_smoke_workflow/smoke_test/test_smoke_test_runner_opensearch.py index b63b554c9b..7d5f5d7ee7 100644 --- a/tests/tests_test_workflow/test_smoke_workflow/smoke_test/test_smoke_test_runner_opensearch.py +++ b/tests/tests_test_workflow/test_smoke_workflow/smoke_test/test_smoke_test_runner_opensearch.py @@ -4,10 +4,10 @@ # The OpenSearch Contributors require contributions made to # this file be licensed under the Apache-2.0 license or a # compatible open source license. - +import os.path import unittest from pathlib import Path -from unittest.mock import MagicMock, Mock, call, patch +from unittest.mock import MagicMock, Mock, call, mock_open, patch import requests from openapi_core.exceptions import OpenAPIError @@ -94,3 +94,58 @@ def test_validate_response_swagger_with_invalid_response(self, mock_get: Mock, m # Validate that an OpenAPIError is raised for an invalid response with self.assertRaises(OpenAPIError): runner.validate_response_swagger(response) + + @patch("test_workflow.smoke_test.smoke_test_runner_opensearch.Spec") + @patch("test_workflow.smoke_test.smoke_test_runner.TestRecorder") + @patch("requests.get") + @patch("builtins.open", new_callable=mock_open) + def test_download_spec_success(self, mock_file: Mock, mock_get: Mock, mock_test_recorder: Mock, mock_spec: Mock) -> None: + mock_response = MagicMock() + mock_response.status_code = 200 + mock_response.content = "Mock OpenSearch API Spec Yaml content" + mock_get.return_value = mock_response + + runner = SmokeTestRunnerOpenSearch(MagicMock(), MagicMock()) + + mock_get.assert_called_once_with( + "https://github.com/opensearch-project/opensearch-api-specification/releases/download/main-latest/opensearch-openapi.yaml", + timeout=10 + ) + + mock_file.assert_any_call(runner.spec_download_path, "wb") + mock_file().write.assert_called_once_with("Mock OpenSearch API Spec Yaml content") + + self.assertTrue(runner.spec_path.endswith(os.path.join("smoke_tests_spec", "opensearch-openapi.yaml"))) + + @patch("test_workflow.smoke_test.smoke_test_runner_opensearch.Spec") + @patch("test_workflow.smoke_test.smoke_test_runner.TestRecorder") + @patch("requests.get") + @patch("builtins.open", new_callable=mock_open) + def test_download_spec_fail_local(self, mock_file: Mock, mock_get: Mock, mock_test_recorder: Mock, mock_spec: Mock) -> None: + # Mock request failure + mock_get.side_effect = requests.RequestException + + runner = SmokeTestRunnerOpenSearch(MagicMock(), MagicMock()) + + mock_get.assert_called_once() + + mock_file().write.assert_not_called() + + self.assertTrue(runner.spec_path.endswith(os.path.join("smoke_tests_spec", "opensearch-openapi-local.yaml"))) + + @patch("test_workflow.smoke_test.smoke_test_runner_opensearch.Spec") + @patch("test_workflow.smoke_test.smoke_test_runner.TestRecorder") + @patch("requests.get") + @patch("builtins.open", new_callable=mock_open) + def test_download_spec_https_fail(self, mock_file: Mock, mock_get: Mock, mock_test_recorder: Mock, mock_spec: Mock) -> None: + mock_response = MagicMock() + mock_response.status_code = 404 + mock_get.return_value = mock_response + + runner = SmokeTestRunnerOpenSearch(MagicMock(), MagicMock()) + + mock_get.assert_called_once() + + mock_file().write.assert_not_called() + + self.assertTrue(runner.spec_path.endswith(os.path.join("smoke_tests_spec", "opensearch-openapi-local.yaml")))