diff --git a/src/ApiGenerator/opensearch-openapi.yaml b/src/ApiGenerator/opensearch-openapi.yaml index e7a7660fbc..b776cdbe24 100644 --- a/src/ApiGenerator/opensearch-openapi.yaml +++ b/src/ApiGenerator/opensearch-openapi.yaml @@ -449,7 +449,7 @@ paths: operationId: cat.aliases.0 x-operation-group: cat.aliases x-version-added: '1.0' - description: Shows information about currently configured aliases to indexes including filter and routing info. + 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: @@ -473,7 +473,7 @@ paths: operationId: cat.aliases.1 x-operation-group: cat.aliases x-version-added: '1.0' - description: Shows information about currently configured aliases to indexes including filter and routing info. + 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: @@ -576,7 +576,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 indexes. + 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: @@ -598,7 +598,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 indexes. + 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: @@ -694,7 +694,7 @@ paths: operationId: cat.indices.0 x-operation-group: cat.indices x-version-added: '1.0' - description: 'Returns information about indexes: 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: @@ -725,7 +725,7 @@ paths: operationId: cat.indices.1 x-operation-group: cat.indices x-version-added: '1.0' - description: 'Returns information about indexes: 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: @@ -813,7 +813,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: @@ -841,7 +841,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: @@ -867,7 +867,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: @@ -892,7 +892,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: @@ -915,7 +915,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: @@ -940,7 +940,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: @@ -967,7 +967,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: @@ -995,7 +995,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: @@ -1020,7 +1020,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: @@ -1054,7 +1056,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: @@ -1140,7 +1144,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: @@ -1167,7 +1171,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: @@ -1195,7 +1199,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: @@ -1205,6 +1209,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' @@ -1221,7 +1226,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: @@ -1232,6 +1237,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' @@ -1248,7 +1254,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: @@ -1275,7 +1281,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: @@ -1300,7 +1306,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: @@ -1328,7 +1334,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: @@ -1356,7 +1362,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: @@ -1383,7 +1389,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: @@ -1403,7 +1409,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: @@ -1424,7 +1430,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: @@ -1441,7 +1447,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: @@ -1459,7 +1465,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: @@ -1595,8 +1601,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: @@ -1742,7 +1748,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: @@ -1768,7 +1774,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: @@ -1795,7 +1801,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: @@ -1823,7 +1829,7 @@ 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: @@ -1842,7 +1848,7 @@ paths: operationId: cluster.stats.3 x-operation-group: cluster.stats x-version-added: '2.18' - 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: @@ -1864,7 +1870,7 @@ paths: operationId: cluster.stats.2 x-operation-group: cluster.stats x-version-added: '2.18' - 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: @@ -1885,7 +1891,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: @@ -1905,7 +1911,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: @@ -1922,7 +1928,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: @@ -1947,6 +1953,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' @@ -1988,6 +1995,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' @@ -2486,9 +2494,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' @@ -3640,7 +3646,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: @@ -3663,7 +3669,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: @@ -3680,7 +3686,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: @@ -3698,7 +3704,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: @@ -4629,10 +4635,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' @@ -4645,10 +4740,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' @@ -4660,6 +4789,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 @@ -4676,6 +4838,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 @@ -4691,6 +4886,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 @@ -4707,6 +5234,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 @@ -4736,10 +5296,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' @@ -4752,10 +5330,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' @@ -4768,10 +5380,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' @@ -4783,10 +5451,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' @@ -4798,10 +5499,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' @@ -4810,13 +5548,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' @@ -4831,6 +5802,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' @@ -4842,6 +5814,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 @@ -5065,8 +6068,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' @@ -5630,8 +6633,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' @@ -6521,6 +7524,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': @@ -7473,6 +8478,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 @@ -7672,6 +8820,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 @@ -7844,6 +8994,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' @@ -7864,7 +9015,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: @@ -8541,6 +9692,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 @@ -8606,6 +9759,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 @@ -9487,6 +10642,7 @@ paths: operationId: indices.get_upgrade.0 x-operation-group: indices.get_upgrade x-version-added: '1.0' + x-version-deprecated: '1.0' description: The `_upgrade` API is no longer useful and will be removed. externalDocs: url: https://opensearch.org/docs/latest @@ -9506,6 +10662,7 @@ paths: operationId: indices.upgrade.0 x-operation-group: indices.upgrade x-version-added: '1.0' + x-version-deprecated: '1.0' description: The `_upgrade` API is no longer useful and will be removed. externalDocs: url: https://opensearch.org/docs/latest @@ -12217,6 +13374,7 @@ paths: operationId: indices.get_upgrade.1 x-operation-group: indices.get_upgrade x-version-added: '1.0' + x-version-deprecated: '1.0' description: The `_upgrade` API is no longer useful and will be removed. externalDocs: url: https://opensearch.org/docs/latest @@ -12237,6 +13395,7 @@ paths: operationId: indices.upgrade.1 x-operation-group: indices.upgrade x-version-added: '1.0' + x-version-deprecated: '1.0' description: The `_upgrade` API is no longer useful and will be removed. externalDocs: url: https://opensearch.org/docs/latest @@ -12323,7 +13482,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: @@ -12348,7 +13507,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: @@ -12367,7 +13526,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: @@ -12386,7 +13545,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: @@ -12969,8 +14128,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' @@ -13883,6 +15042,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': @@ -14803,11 +15964,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 @@ -14824,25 +15981,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: @@ -15037,7 +16197,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' @@ -15045,118 +16204,117 @@ components: cat.aliases___query.expand_wildcards: in: query name: expand_wildcards - description: Whether to expand wildcard expression to concrete indexes 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 (for example, `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 (for example, `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 (for example, `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 (for example, `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' @@ -15164,55 +16322,55 @@ 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 (for example, `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 (for example, `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 cluster-manager node. + description: A timeout for connection to the cluster manager node. schema: $ref: '#/components/schemas/_common___Duration' x-version-deprecated: '2.0' @@ -15221,67 +16379,67 @@ components: 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 (for example, `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 (for example, `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 cluster-manager node. + description: A timeout for connection to the cluster manager node. schema: $ref: '#/components/schemas/_common___Duration' x-version-deprecated: '2.0' @@ -15290,22 +16448,22 @@ components: 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 @@ -15319,53 +16477,53 @@ components: cat.count___query.format: name: format in: query - description: A short version of the Accept header (for example, `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 (for example, `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: @@ -15374,98 +16532,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 (for example, `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 (for example, `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 (for example, `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 (for example, `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 @@ -15477,7 +16635,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 @@ -15485,16 +16643,16 @@ 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, indexes, 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 indexes, omit this parameter or use `*` or `_all`. required: true schema: @@ -15503,61 +16661,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 (for example, `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 (for example, `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 indexes. By default, the response includes indexes 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 @@ -15565,15 +16722,15 @@ 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 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-deprecated: '2.0' @@ -15582,7 +16739,7 @@ components: 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 @@ -15590,74 +16747,74 @@ 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 (for example, `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 (for example, `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 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-deprecated: '2.0' @@ -15666,67 +16823,67 @@ components: 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 (for example, `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 (for example, `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 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-deprecated: '2.0' @@ -15735,87 +16892,85 @@ components: 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 (for example, `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 (for example, `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 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-deprecated: '2.0' @@ -15824,73 +16979,73 @@ components: 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 (for example, `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 (for example, `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 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-deprecated: '2.0' @@ -15899,124 +17054,124 @@ components: 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 (for example, `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 (for example, `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 (for example, `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 (for example, `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 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-deprecated: '2.0' @@ -16025,22 +17180,22 @@ components: 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 @@ -16062,14 +17217,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 @@ -16077,110 +17232,114 @@ components: cat.recovery___query.format: name: format in: query - description: A short version of the Accept header (for example, `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 (for example, `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 (for example, `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 (for example, `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 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-deprecated: '2.0' @@ -16189,168 +17348,175 @@ components: 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 indexes expression resolves into no concrete indexes. (This includes `_all` string or when no indexes 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 indexes expression resolves into no concrete indexes. (This includes `_all` string or when no indexes 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 indexes 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 (for example, `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 (for example, `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 indexes 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 indexes 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 indexes 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 indexes 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 @@ -16365,47 +17531,47 @@ 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 (for example, `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 (for example, `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 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-deprecated: '2.0' @@ -16414,29 +17580,25 @@ components: 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, 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' @@ -16444,55 +17606,55 @@ 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 (for example, `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 (for example, `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 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-deprecated: '2.0' @@ -16501,28 +17663,27 @@ components: 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 @@ -16538,40 +17699,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 (for example, `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 (for example, `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 @@ -16579,41 +17740,52 @@ components: cat.snapshots___query.master_timeout: name: master_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-deprecated: '2.0' 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: @@ -16630,40 +17802,43 @@ components: cat.tasks___query.format: name: format in: query - description: A short version of the Accept header (for example, `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 (for example, `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 @@ -16674,28 +17849,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 @@ -16709,48 +17884,48 @@ 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 (for example, `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 (for example, `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 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-deprecated: '2.0' @@ -16759,22 +17934,22 @@ components: 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 @@ -16788,48 +17963,48 @@ 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 (for example, `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 (for example, `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 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-deprecated: '2.0' @@ -16838,13 +18013,13 @@ components: 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 @@ -16857,11 +18032,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 @@ -16876,7 +18051,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 @@ -16884,7 +18059,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 @@ -16893,8 +18068,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' @@ -16909,9 +18084,6 @@ components: cluster.delete_component_template___query.master_timeout: in: query name: master_timeout - 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' @@ -16921,9 +18093,6 @@ components: 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 @@ -16933,8 +18102,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: @@ -16945,7 +18114,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: @@ -16954,7 +18123,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' @@ -16962,8 +18130,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 cluster-manager 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 @@ -16971,10 +18139,6 @@ components: cluster.exists_component_template___query.master_timeout: in: query name: master_timeout - 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' @@ -16985,7 +18149,7 @@ components: 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: @@ -16994,16 +18158,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 cluster-manager 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 @@ -17011,9 +18182,6 @@ components: cluster.get_component_template___query.master_timeout: in: query name: master_timeout - 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' @@ -17023,22 +18191,21 @@ components: 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 @@ -17046,7 +18213,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 @@ -17054,9 +18221,6 @@ components: cluster.get_settings___query.master_timeout: in: query name: master_timeout - 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' @@ -17066,24 +18230,20 @@ components: 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, 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' @@ -17091,35 +18251,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 indexes 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, indexes 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 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 @@ -17127,7 +18285,6 @@ components: cluster.health___query.master_timeout: in: query name: master_timeout - 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' @@ -17137,42 +18294,40 @@ components: 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' @@ -17196,8 +18350,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 cluster-manager 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 @@ -17205,9 +18359,6 @@ components: cluster.pending_tasks___query.master_timeout: in: query name: master_timeout - 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' @@ -17218,8 +18369,8 @@ components: 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 @@ -17227,8 +18378,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 @@ -17238,7 +18389,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' @@ -17247,11 +18398,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 indexes 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' @@ -17259,14 +18410,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 @@ -17274,9 +18424,6 @@ components: cluster.put_component_template___query.master_timeout: in: query name: master_timeout - 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' @@ -17286,36 +18433,34 @@ components: 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 @@ -17323,7 +18468,6 @@ components: cluster.put_settings___query.master_timeout: in: query name: master_timeout - description: Explicit operation timeout for connection to cluster-manager node deprecated: true schema: $ref: '#/components/schemas/_common___Duration' @@ -17333,43 +18477,40 @@ components: 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 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' @@ -17390,21 +18531,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 indexes required: true schema: $ref: '#/components/schemas/_common___Indices' @@ -17412,7 +18551,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 @@ -17422,28 +18561,26 @@ components: cluster.state___query.allow_no_indices: in: query name: allow_no_indices - 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) + 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 indexes 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 @@ -17451,14 +18588,14 @@ components: cluster.state___query.ignore_unavailable: in: query name: ignore_unavailable - description: Whether specified concrete indexes 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 @@ -17466,7 +18603,6 @@ components: cluster.state___query.master_timeout: in: query name: master_timeout - description: Specify timeout for connection to cluster manager. deprecated: true schema: $ref: '#/components/schemas/_common___Duration' @@ -17490,7 +18626,7 @@ components: cluster.stats___path.index_metric: in: path name: index_metric - 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. + description: A comma-separated list of index metric groups, for example, `docs,store`. required: true schema: type: array @@ -17510,7 +18646,6 @@ components: 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' @@ -17518,7 +18653,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 @@ -17527,7 +18662,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: @@ -17593,10 +18728,6 @@ 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 @@ -17900,10 +19031,7 @@ components: 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: Set to `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 @@ -19931,7 +21059,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 @@ -20836,7 +21965,8 @@ 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 @@ -21074,10 +22204,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 @@ -21163,14 +22293,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 @@ -21178,19 +22300,6 @@ 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 @@ -21386,11 +22495,7 @@ 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 @@ -22265,12 +23370,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 @@ -22651,6 +23763,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 @@ -22663,6 +23800,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 @@ -22687,24 +23836,275 @@ 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 @@ -23651,6 +25051,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 @@ -24417,11 +25822,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 @@ -24821,6 +26222,103 @@ components: 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 @@ -25321,11 +26819,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 @@ -25381,11 +26875,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 @@ -25676,10 +27166,7 @@ components: 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: Set to `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 @@ -26163,12 +27650,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: @@ -26182,10 +27670,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 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 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' @@ -26195,7 +27682,7 @@ components: $ref: '#/components/schemas/_common___Metadata' required: - template - description: The template definition + description: The template definition. required: true cluster.put_settings: content: @@ -26209,7 +27696,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: @@ -26223,7 +27710,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' @@ -26381,8 +27868,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: @@ -26526,6 +28012,7 @@ components: content: application/json: schema: + title: settings $ref: '#/components/schemas/indices._common___IndexSettings' required: true indices.put_template: @@ -26543,11 +28030,7 @@ components: description: |- Array of wildcard expressions used to match the names of indexes during creation. - oneOf: - - type: string - - type: array - items: - type: string + $ref: '#/components/schemas/_common___StringOrStringArray' mappings: $ref: '#/components/schemas/_common.mapping___TypeMapping' order: @@ -26557,12 +28040,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 @@ -26589,8 +28072,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: @@ -26608,8 +28090,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: @@ -26652,6 +28133,7 @@ components: content: application/json: schema: + title: template $ref: '#/components/schemas/indices._common___IndexTemplate' indices.split: content: @@ -26766,64 +28248,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: - training_index: + 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: + 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 - compression_level: + description: The prompt template. + response: type: string - method: + description: The answer to the question. + origin: type: string - spaceType: + 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 + 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: - - 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: @@ -26834,24 +28495,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: @@ -26881,11 +28540,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: @@ -27081,16 +29122,15 @@ 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. @@ -27170,9 +29210,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: @@ -27184,6 +29221,11 @@ 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: @@ -27459,7 +29501,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: @@ -27549,6 +29591,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: @@ -27719,17 +29771,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: @@ -27894,7 +29941,7 @@ components: schema: type: array items: - $ref: '#/components/schemas/cat._common___CatPitSegmentsRecord' + $ref: '#/components/schemas/cat.segments___SegmentsRecord' description: '' cat.allocation___200: content: @@ -28051,7 +30098,7 @@ components: schema: type: array items: - $ref: '#/components/schemas/cat._common___CatPitSegmentsRecord' + $ref: '#/components/schemas/cat.segments___SegmentsRecord' description: '' cat.plugins___200: content: @@ -28095,7 +30142,7 @@ components: schema: type: array items: - $ref: '#/components/schemas/cat._common___CatSegmentReplicationRecord' + $ref: '#/components/schemas/cat.segment_replication___SegmentReplicationRecord' description: '' cat.segments___200: content: @@ -28178,6 +30225,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: @@ -28235,7 +30297,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: @@ -28388,34 +30451,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: @@ -28443,7 +30527,7 @@ components: pit_id: type: string _shards: - $ref: '#/components/schemas/_core._common___ShardStatistics' + $ref: '#/components/schemas/_common___ShardStatistics' creation_time: type: integer format: int64 @@ -28492,7 +30576,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: @@ -28520,7 +30604,7 @@ components: pits: type: array items: - $ref: '#/components/schemas/_core._common___DeletedPit' + $ref: '#/components/schemas/_core.pit___DeletedPit' description: '' delete_script___200: content: @@ -28837,7 +30921,7 @@ components: pits: type: array items: - $ref: '#/components/schemas/_core._common___PitDetail' + $ref: '#/components/schemas/_core.pit___PitDetail' description: '' get_script_context___200: content: @@ -28926,20 +31010,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: @@ -28964,37 +31047,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: @@ -29029,16 +31110,18 @@ components: $ref: '#/components/schemas/_common___ShardStatistics' backing_indices: description: Total number of backing indexes for the selected data streams. - type: number + 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. @@ -29201,6 +31284,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: @@ -29302,32 +31389,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: @@ -29362,18 +31448,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: @@ -29400,18 +31485,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: @@ -29438,6 +31522,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: @@ -29616,6 +31711,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: @@ -29624,8 +31723,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: @@ -29639,6 +31746,10 @@ components: - model_id description: '' knn.warmup___200: + content: + application/json: + schema: + $ref: '#/components/schemas/_common___ShardsOperationResponseBase' description: '' list.help___200: content: @@ -29767,6 +31878,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: @@ -29776,6 +31899,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: @@ -29788,6 +31958,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: @@ -29822,18 +32010,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: @@ -29849,6 +32212,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: @@ -29859,22 +32236,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: @@ -29908,25 +32403,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: @@ -30061,7 +32603,7 @@ components: observability.get_localstats___200: description: Retrieves content: - application/json: + text/plain: schema: type: string observability.get_object___200: @@ -30197,8 +32739,7 @@ components: $ref: '#/components/schemas/_core.rank_eval___RankEvalMetricDetail' failures: type: object - additionalProperties: - type: object + additionalProperties: true required: - details - failures @@ -30258,8 +32799,7 @@ components: properties: template_output: type: object - additionalProperties: - type: object + additionalProperties: true required: - template_output description: '' @@ -30330,6 +32870,10 @@ components: $ref: '#/components/schemas/_common___AcknowledgedResponseBase' description: '' rollups.delete___200: + content: + application/json: + schema: + $ref: '#/components/schemas/_common___WriteResponseBase' description: '' rollups.explain___200: content: @@ -30343,15 +32887,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: @@ -30360,7 +32912,10 @@ components: type: object properties: result: - type: object + oneOf: + - type: number + - type: string + - type: boolean required: - result description: '' @@ -30464,6 +33019,8 @@ components: $ref: '#/components/schemas/_core.search___Suggest' terminated_early: type: boolean + status: + type: number required: - _shards - hits @@ -30832,7 +33389,7 @@ components: content: application/json: schema: - $ref: '#/components/schemas/security._common___DistinguishedNames' + $ref: '#/components/schemas/security._common___DistinguishedNamesMap' security.get_distinguished_name___400: content: application/json: @@ -31256,6 +33813,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: @@ -31304,6 +33867,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: @@ -31393,7 +34034,7 @@ components: snapshots: type: array items: - $ref: '#/components/schemas/snapshot._common___Status' + $ref: '#/components/schemas/snapshot._common___SnapshotStatus' required: - snapshots description: '' @@ -31497,14 +34138,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: @@ -31516,7 +34162,7 @@ components: content: application/json: schema: - $ref: '#/components/schemas/transforms._common___TransformEntity' + $ref: '#/components/schemas/transforms._common___TransformResponse' description: '' transforms.preview___200: content: @@ -31528,7 +34174,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: @@ -31558,6 +34210,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: '' @@ -31769,19 +34425,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: @@ -31927,17 +34599,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: @@ -31945,13 +34634,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: @@ -31982,6 +34673,9 @@ components: _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' @@ -32051,6 +34745,7 @@ components: const: open 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 @@ -32063,7 +34758,8 @@ components: type: object properties: evictions: - type: number + type: integer + format: int64 memory_size: $ref: '#/components/schemas/_common___HumanReadableByteCount' memory_size_in_bytes: @@ -32098,29 +34794,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: @@ -32163,6 +34879,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: @@ -32180,12 +34900,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: @@ -32238,25 +34957,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 @@ -32266,41 +34994,33 @@ 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: (?:(-1)|(0)|\d+(\.\d+)?(b|kb|k|mb|m|gb|g|tb|t|pb|p)) @@ -32328,25 +35048,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: @@ -32374,6 +35100,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 @@ -32447,50 +35177,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: @@ -32506,6 +35192,7 @@ components: - lat - lon _common___Level: + description: Specifies the level of detail of the returned information. type: string enum: - cluster @@ -32515,21 +35202,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: @@ -32547,7 +35238,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 @@ -32569,17 +35261,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 @@ -32627,6 +35320,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 @@ -32676,7 +35370,8 @@ components: node: $ref: '#/components/schemas/_common___NodeName' shard: - type: number + type: integer + format: int32 index: $ref: '#/components/schemas/_common___IndexName' allocation_id: @@ -32693,8 +35388,6 @@ components: oneOf: - $ref: '#/components/schemas/_common___NodeId' - type: 'null' - relocation_failure_info: - $ref: '#/components/schemas/_common___RelocationFailureInfo' required: - index - primary @@ -32790,16 +35483,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: @@ -32843,16 +35526,20 @@ 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: @@ -32860,10 +35547,12 @@ components: $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 @@ -32872,11 +35561,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: @@ -32890,9 +35574,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: @@ -32913,15 +35599,18 @@ components: 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: @@ -32934,13 +35623,6 @@ 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. @@ -33018,13 +35700,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 @@ -33061,7 +35746,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: @@ -33107,7 +35793,6 @@ components: $ref: '#/components/schemas/_common___RemoteStoreUploadDownloadStats' required: - max_refresh_time_lag_in_millis - - pressure - refresh_size_lag - total_time_spent_in_millis - total_upload_size @@ -33115,15 +35800,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 @@ -33137,9 +35825,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: @@ -33167,11 +35886,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' @@ -33183,11 +35898,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: @@ -33275,10 +35985,12 @@ 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' @@ -33287,10 +35999,12 @@ components: $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: @@ -33298,13 +36012,16 @@ components: $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' @@ -33313,10 +36030,12 @@ components: $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' @@ -33325,10 +36044,12 @@ components: $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: @@ -33336,10 +36057,12 @@ components: $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' @@ -33348,9 +36071,11 @@ components: $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. @@ -33374,29 +36099,50 @@ 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: @@ -33423,7 +36169,7 @@ components: $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' @@ -33469,6 +36215,7 @@ components: remote_store: $ref: '#/components/schemas/_common___RemoteStoreStats' segment_replication: + x-version-added: 2.10.0 $ref: '#/components/schemas/_common___SegmentReplicationStats' required: - count @@ -33537,7 +36284,8 @@ components: field: $ref: '#/components/schemas/_common___Field' id: - $ref: '#/components/schemas/_common___Id' + type: integer + format: int32 max: type: integer format: int32 @@ -33547,28 +36295,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: @@ -33578,18 +36319,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: @@ -33699,6 +36466,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: @@ -33733,19 +36506,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: @@ -33772,9 +36569,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: @@ -33782,7 +36581,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: @@ -33802,6 +36602,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 @@ -33845,12 +36649,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 @@ -33863,9 +36669,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: @@ -34015,19 +36823,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' @@ -34096,14 +36901,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: @@ -34124,8 +36923,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: @@ -34142,16 +36939,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: @@ -34283,7 +37076,8 @@ components: properties: buckets: description: The target number of buckets. - type: number + type: integer + format: int32 field: $ref: '#/components/schemas/_common___Field' format: @@ -34300,8 +37094,7 @@ components: type: string params: type: object - additionalProperties: - type: object + additionalProperties: true script: $ref: '#/components/schemas/_common___Script' time_zone: @@ -34367,90 +37160,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' @@ -34538,17 +37252,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 @@ -34560,17 +37263,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 @@ -34593,17 +37285,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 @@ -34655,14 +37336,16 @@ 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: @@ -34671,11 +37354,14 @@ components: 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: @@ -34683,10 +37369,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: @@ -34767,16 +37455,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' @@ -34795,7 +37514,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: @@ -34808,62 +37528,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_tokensg`. 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' @@ -34892,10 +37556,12 @@ 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.' type: string @@ -34925,7 +37591,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. @@ -34935,32 +37602,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' @@ -34970,9 +37622,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: @@ -34985,28 +37637,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' @@ -35026,19 +37695,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' @@ -35069,17 +37725,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: @@ -35113,7 +37769,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 @@ -35156,12 +37812,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: @@ -35184,6 +37842,7 @@ components: properties: alpha: type: number + format: float _common.aggregations___EwmaMovingAverageAggregation: allOf: - $ref: '#/components/schemas/_common.aggregations___MovingAverageAggregationBase' @@ -35290,6 +37949,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' @@ -35302,13 +37962,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' @@ -35353,58 +38017,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: @@ -35443,7 +38055,8 @@ components: - type: object properties: count: - type: number + type: integer + format: int64 location: $ref: '#/components/schemas/_common___GeoLocation' _common.aggregations___GeoDistanceAggregate: @@ -35487,10 +38100,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' @@ -35500,41 +38115,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 and 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' @@ -35566,7 +38146,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 @@ -35601,10 +38182,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: @@ -35635,7 +38218,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' @@ -35664,23 +38248,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: @@ -35699,13 +38287,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' @@ -35725,14 +38322,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: @@ -35750,10 +38351,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' @@ -35827,54 +38431,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' @@ -35983,6 +38539,7 @@ components: type: object additionalProperties: type: number + format: double _common.aggregations___MatrixStatsAggregate: allOf: - $ref: '#/components/schemas/_common.aggregations___AggregateBase' @@ -36059,13 +38616,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: @@ -36089,12 +38647,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' @@ -36107,7 +38659,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: @@ -36132,9 +38684,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' @@ -36147,10 +38701,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' @@ -36158,12 +38714,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: @@ -36211,15 +38769,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' @@ -36229,15 +38778,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' @@ -36256,15 +38796,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' @@ -36377,7 +38908,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: @@ -36392,24 +38923,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 @@ -36496,12 +39031,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: @@ -36536,6 +39069,7 @@ components: type: array items: type: number + format: double hdr: $ref: '#/components/schemas/_common.aggregations___HdrMethod' tdigest: @@ -36554,6 +39088,7 @@ components: type: array items: type: number + format: double _common.aggregations___PipelineAggregationBase: allOf: - $ref: '#/components/schemas/_common.aggregations___BucketPathAggregation' @@ -36581,7 +39116,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 @@ -36623,14 +39159,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: @@ -36665,7 +39203,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' @@ -36688,7 +39227,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: @@ -36727,8 +39267,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: @@ -36740,7 +39279,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' @@ -36819,7 +39359,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: @@ -36830,15 +39371,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' @@ -36877,7 +39421,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: @@ -36888,15 +39433,18 @@ components: description: |- Regulates the certainty a shard has if the values should actually be added to the candidate list or not with respect to the `min_doc_count`. Values will only be considered if their local shard frequency within the set is higher than the `shard_min_doc_count`. - type: number + 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: @@ -37152,7 +39700,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' @@ -37223,9 +39772,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: @@ -37241,13 +39791,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: @@ -37271,26 +39823,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 @@ -37326,7 +39885,8 @@ components: type: boolean from: description: Starting document offset. - type: number + type: integer + format: int32 highlight: $ref: '#/components/schemas/_core.search___Highlight' script_fields: @@ -37336,7 +39896,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: @@ -37391,7 +39952,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: @@ -37480,17 +40042,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' @@ -37534,6 +40099,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: @@ -39039,11 +41605,7 @@ components: 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: @@ -39687,6 +42249,55 @@ components: type: boolean required: - enabled + _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' @@ -40650,25 +43261,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' @@ -40784,17 +43398,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: @@ -40895,33 +43512,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' @@ -41061,6 +43678,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' @@ -41241,22 +43867,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: @@ -41265,6 +43928,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: @@ -41276,140 +43941,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' @@ -41585,28 +44262,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' @@ -41642,7 +44315,9 @@ components: type: string enum: - and + - AND - or + - OR _common.query_dsl___ParentIdQuery: allOf: - $ref: '#/components/schemas/_common.query_dsl___QueryBase' @@ -41662,12 +44337,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: @@ -41725,22 +44398,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: @@ -41764,6 +44440,8 @@ components: common: deprecated: true type: object + propertyNames: + $ref: '#/components/schemas/_common___Field' additionalProperties: $ref: '#/components/schemas/_common.query_dsl___CommonTermsQuery' minProperties: 1 @@ -41783,6 +44461,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 @@ -41799,26 +44479,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. 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: @@ -41829,6 +44519,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 @@ -41838,6 +44530,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 @@ -41847,6 +44541,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 @@ -41858,7 +44554,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: @@ -41868,6 +44570,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 @@ -41877,6 +44581,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 @@ -41886,12 +44592,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: @@ -41915,6 +44621,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 @@ -41926,43 +44634,33 @@ components: 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 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: description: Returns documents that contain one or more exact terms in a provided field. - $ref: '#/components/schemas/_common.query_dsl___TermsQueryField' + $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 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 @@ -42057,6 +44755,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: @@ -42144,44 +44847,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' @@ -42232,8 +44923,11 @@ components: - 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' + 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' @@ -42428,14 +45122,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' @@ -42449,20 +45146,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: @@ -42473,22 +45173,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' @@ -42504,22 +45206,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: @@ -42529,18 +45215,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' @@ -42550,36 +45224,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' @@ -42622,46 +45285,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: @@ -42857,7 +45480,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: @@ -43007,7 +45634,9 @@ 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 @@ -43204,7 +45833,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: @@ -43242,7 +45870,8 @@ components: _version: $ref: '#/components/schemas/_common___VersionNumber' took: - type: number + type: integer + format: int64 found: type: boolean term_vectors: @@ -43251,9 +45880,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: @@ -43263,7 +45912,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 @@ -43277,6 +45927,9 @@ components: $ref: '#/components/schemas/_common___IndexName' _score: type: number + format: double + _type: + $ref: '#/components/schemas/_common___Type' required: - _id - _index @@ -43287,10 +45940,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: @@ -43311,13 +45962,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 @@ -43333,8 +45986,7 @@ components: type: object additionalProperties: type: object - additionalProperties: - type: object + additionalProperties: true required: - hits - metric_details @@ -43355,7 +46007,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: @@ -43377,7 +46030,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' @@ -43388,7 +46042,8 @@ components: query: $ref: '#/components/schemas/_common.query_dsl___QueryContainer' size: - type: number + type: integer + format: int32 required: - query _core.rank_eval___RankEvalRequestItem: @@ -43408,8 +46063,7 @@ components: params: description: The search template parameters. type: object - additionalProperties: - type: object + additionalProperties: true required: - id - ratings @@ -43439,19 +46093,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: @@ -43464,13 +46123,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 @@ -43490,12 +46152,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: @@ -43566,7 +46233,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: @@ -43588,7 +46256,6 @@ components: required: - document - index - - query _core.search_shards___ShardStoreIndex: type: object properties: @@ -43773,11 +46440,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: @@ -43957,6 +46627,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 @@ -43968,11 +46641,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: @@ -44052,9 +46725,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: @@ -44077,8 +46747,7 @@ components: $ref: '#/components/schemas/_core.explain___Explanation' fields: type: object - additionalProperties: - type: object + additionalProperties: true highlight: type: object additionalProperties: @@ -44182,7 +46851,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 @@ -44477,10 +47146,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: @@ -44488,15 +47153,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' @@ -44585,11 +47255,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 @@ -44601,48 +47274,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. 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. Words shorter than this value will be ignored. Default is 0. - type: number + 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: @@ -44655,19 +47339,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: @@ -44867,90 +47553,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: @@ -46279,6 +48881,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: @@ -46799,7 +49454,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: @@ -47085,7 +49740,8 @@ components: transport_address: $ref: '#/components/schemas/_common___TransportAddress' weight_ranking: - type: number + type: integer + format: int32 required: - attributes - id @@ -47153,7 +49809,8 @@ components: transport_address: $ref: '#/components/schemas/_common___TransportAddress' weight_ranking: - type: number + type: integer + format: int32 required: - deciders - node_attributes @@ -47182,7 +49839,8 @@ components: path: type: string total: - type: number + type: integer + format: int64 shards: type: array items: @@ -47204,7 +49862,8 @@ components: details: type: string failed_allocation_attempts: - type: number + type: integer + format: int32 delayed: type: boolean allocation_status: @@ -47248,26 +49907,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: @@ -47282,7 +49949,8 @@ 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 cluster-manager node has been discovered. type: boolean @@ -47297,22 +49965,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: @@ -47324,7 +49998,8 @@ components: 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 @@ -47345,17 +50020,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: @@ -47363,7 +50044,8 @@ components: status: $ref: '#/components/schemas/_common___HealthStatus' unassigned_shards: - type: number + type: integer + format: int32 required: - active_primary_shards - active_shards @@ -47384,17 +50066,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 @@ -47410,7 +50096,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. @@ -47454,9 +50141,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 @@ -47476,9 +50165,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: @@ -47499,14 +50190,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 @@ -47514,7 +50239,8 @@ components: index: $ref: '#/components/schemas/_common___IndexName' shard: - type: number + type: integer + format: int32 node: type: string accept_data_loss: @@ -47531,7 +50257,8 @@ components: index: $ref: '#/components/schemas/_common___IndexName' shard: - type: number + type: integer + format: int32 node: type: string required: @@ -47544,7 +50271,8 @@ components: index: $ref: '#/components/schemas/_common___IndexName' shard: - type: number + type: integer + format: int32 node: type: string allow_primary: @@ -47559,7 +50287,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 @@ -47621,7 +50350,8 @@ components: node: $ref: '#/components/schemas/_common___NodeName' shard: - type: number + type: integer + format: int32 from_node: $ref: '#/components/schemas/_common___NodeName' to_node: @@ -47743,7 +50473,8 @@ components: $ref: '#/components/schemas/_common___CompletionStats' count: description: Total number of indexes with shards assigned to selected nodes. - type: number + type: integer + format: int64 docs: $ref: '#/components/schemas/_common___DocStats' fielddata: @@ -47770,21 +50501,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 @@ -47794,7 +50531,8 @@ components: type: object properties: number_of_pipelines: - type: number + type: integer + format: int32 processor_stats: type: object additionalProperties: @@ -47813,7 +50551,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 @@ -47850,7 +50589,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 @@ -47879,12 +50619,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 @@ -47892,39 +50634,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 @@ -47936,23 +50694,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. @@ -47967,6 +50731,7 @@ 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. @@ -47981,7 +50746,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 @@ -47989,7 +50755,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: @@ -48016,7 +50783,8 @@ components: type: string count: description: Number of selected nodes using the architecture. - type: number + type: integer + format: int32 required: - arch - count @@ -48025,7 +50793,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: @@ -48036,7 +50805,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: @@ -48069,17 +50839,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 @@ -48088,11 +50861,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: @@ -48108,12 +50884,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 @@ -48125,22 +50904,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 indexes 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 + type: integer + format: int32 required: - count - index_count @@ -48153,17 +50922,6 @@ components: type: array items: $ref: '#/components/schemas/cluster.stats___FieldTypes' - total_field_count: - description: Total number of fields in all non-system indexes. - type: number - total_deduplicated_field_count: - description: Total number of fields in all non-system indexes, accounting for mapping deduplication. - type: number - total_deduplicated_mapping_size: - $ref: '#/components/schemas/_common___HumanReadableByteCount' - total_deduplicated_mapping_size_in_bytes: - description: Total size of all mappings, in bytes, after deduplication and compression. - $ref: '#/components/schemas/_common___ByteCount' required: - field_types cluster.stats___IndexingPressure: @@ -48228,9 +50986,11 @@ components: 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: @@ -48259,7 +51019,8 @@ components: 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 @@ -48305,29 +51066,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 - - status - - timestamp cluster.weighted_routing___Weights: allOf: - $ref: '#/components/schemas/cluster.weighted_routing___WeightsBase' @@ -48965,7 +51703,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 @@ -48989,7 +51728,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 @@ -49021,6 +51760,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: @@ -49082,6 +51842,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: @@ -49220,11 +51993,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: @@ -50041,11 +52810,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: @@ -50081,6 +52850,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: @@ -50133,13 +52918,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: @@ -50168,17 +52957,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: @@ -50193,11 +52987,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: @@ -50230,26 +53020,6 @@ components: $ref: '#/components/schemas/_common___ShardFailure' required: - failures - indices.data_streams_stats___DataStreamsStatsItem: - type: object - properties: - backing_indices: - description: Current number of backing indexes 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: - 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.get_alias___IndexAliases: type: object properties: @@ -50307,11 +53077,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 @@ -50352,11 +53124,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 @@ -50455,7 +53230,8 @@ components: type: object properties: id: - type: number + type: integer + format: int32 index: $ref: '#/components/schemas/indices.recovery___RecoveryIndexStatus' primary: @@ -50504,11 +53280,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: @@ -50584,9 +53363,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: @@ -50604,9 +53385,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: @@ -50676,11 +53459,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: @@ -50708,6 +53493,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: @@ -50726,6 +53514,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: @@ -50735,13 +53537,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: @@ -50767,7 +53562,6 @@ components: $ref: '#/components/schemas/indices._common___IndexSettings' required: - aliases - - mappings - settings indices.stats___AllIndicesStats: type: object @@ -50780,6 +53574,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 @@ -50877,11 +53676,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: @@ -50907,7 +53708,8 @@ components: average_size_in_bytes: $ref: '#/components/schemas/_common___ByteCount' count: - type: number + type: integer + format: int64 required: - description - size_in_bytes @@ -50919,7 +53721,8 @@ components: retaining_seq_no: $ref: '#/components/schemas/_common___SequenceNumber' timestamp: - type: number + type: integer + format: int64 source: type: string required: @@ -50944,7 +53747,8 @@ components: type: object properties: primary_term: - type: number + type: integer + format: int64 version: $ref: '#/components/schemas/_common___VersionNumber' leases: @@ -50983,9 +53787,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: @@ -51093,8 +53899,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 @@ -51115,7 +53920,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: @@ -51156,6 +53962,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: @@ -51206,7 +54013,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: @@ -51333,38 +54139,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' @@ -51469,61 +54243,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' @@ -51702,8 +54421,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: @@ -51754,8 +54471,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 @@ -51815,7 +54530,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: @@ -51836,7 +54550,7 @@ components: type: string enum: - geo_shape - - shape + - xy_shape ingest._common___SortProcessor: allOf: - $ref: '#/components/schemas/ingest._common___ProcessorBase' @@ -51883,9 +54597,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 @@ -51974,7 +54688,6 @@ components: $ref: '#/components/schemas/_common___IndexName' _source: description: JSON body for the document. - type: object required: - _source ingest.simulate___DocumentSimulation: @@ -52665,12 +55378,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. @@ -52678,6 +55522,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: @@ -52695,6 +55569,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: @@ -52712,45 +55659,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: @@ -52770,6 +55904,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: @@ -52777,11 +55948,140 @@ components: type: string parameters: $ref: '#/components/schemas/ml._common___Parameters' + ml._common___Match: + type: object + description: Match query. + properties: + description: + type: string + description: The description. + additionalProperties: true + ml._common___MatchAllQuery: + type: object + description: The match all query. + properties: {} ml._common___Memory: type: object properties: type: type: string + 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: @@ -52798,6 +56098,11 @@ components: framework_type: type: string description: The framework type. + ml._common___ModelFormat: + type: string + enum: + - ONNX + - TORCH_SCRIPT ml._common___ModelGroup: type: object properties: @@ -52810,9 +56115,15 @@ components: 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 @@ -52836,34 +56147,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: @@ -52871,15 +56546,16 @@ components: hits: type: array items: - $ref: '#/components/schemas/ml._common___SearchModelsHitsHit' + $ref: '#/components/schemas/ml._common___SearchHitsHit' max_score: - type: number - format: float + type: + - 'null' + - number description: The maximum score. required: - hits - total - ml._common___SearchModelsHitsHit: + ml._common___SearchHitsHit: type: object properties: _version: @@ -52894,28 +56570,31 @@ components: _id: $ref: '#/components/schemas/_common___Id' _score: - type: number - format: float + type: + - 'null' + - number description: The score. _source: $ref: '#/components/schemas/ml._common___Source' model_id: $ref: '#/components/schemas/_common___Name' + sort: + type: array + items: + type: number + format: float + description: The sort values. required: - _score - ml._common___SearchModelsQuery: - type: object - properties: - query: - type: object - description: The query. - size: - type: integer - description: The number of models to return. - required: - - query - - size + 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: @@ -52927,9 +56606,139 @@ components: _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: @@ -52971,6 +56780,7 @@ components: - PARTIALLY_DEPLOYED - REGISTERED - REGISTERING + - UNDEPLOYED model_content_size_in_bytes: type: integer format: int64 @@ -52984,8 +56794,7 @@ components: model_config: $ref: '#/components/schemas/ml._common___ModelConfig' model_format: - type: string - description: The model format. + $ref: '#/components/schemas/ml._common___ModelFormat' model_task_type: type: string description: The model task type. @@ -52993,6 +56802,10 @@ components: 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 @@ -53002,8 +56815,7 @@ components: format: int64 description: The auto redeploy retry times. name: - type: string - description: The model name. + $ref: '#/components/schemas/_common___Name' connector_id: type: string description: The connector ID. @@ -53027,6 +56839,150 @@ components: 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: @@ -53038,19 +56994,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: @@ -53067,6 +57031,43 @@ components: type: string required: - state + 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: + $ref: '#/components/schemas/ml._common___OwnerNameKeyword' + owner.name.keyword: + $ref: '#/components/schemas/ml._common___OwnerNameKeyword' + type: + $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: @@ -53076,7 +57077,56 @@ components: 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: @@ -53090,2090 +57140,2235 @@ 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: - 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 - 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: - description: Cumulative size in bytes of all requests from this client. + 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: - description: Total amount of disk space available to this Java virtual machine on this file store. + direct_max: $ref: '#/components/schemas/_common___HumanReadableByteCount' - available_in_bytes: - description: Total number of bytes available to this Java virtual machine on this file store. + direct_max_in_bytes: $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. + heap_init: $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. + 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: - description: Total amount of unallocated disk space in the file store. + non_heap_max: $ref: '#/components/schemas/_common___HumanReadableByteCount' - free_in_bytes: - description: Total number of unallocated bytes in the file store. + 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: - 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._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 cluster manager. - Omitted if the node is not cluster-manager-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: - description: Percentage of free memory. - $ref: '#/components/schemas/_common___PercentageNumber' - used_percent: - description: Percentage of used memory. - $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: - 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. + cache_size: $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. + 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: - memory: - $ref: '#/components/schemas/nodes._common___IndexingPressureMemory' - nodes._common___IndexingPressureMemory: + url: + $ref: '#/components/schemas/nodes.info___NodeInfoRepositoriesUrl' + required: + - url + nodes.info___NodeInfoRepositoriesUrl: 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' - total: - $ref: '#/components/schemas/nodes._common___PressureMemory' - nodes._common___Ingest: + allowed_urls: + type: string + required: + - allowed_urls + nodes.info___NodeInfoScript: type: object properties: - pipelines: - description: Contains statistics about ingest pipelines for the node. - type: object - additionalProperties: - $ref: '#/components/schemas/nodes._common___IngestTotal' - total: - $ref: '#/components/schemas/nodes._common___IngestTotal' - nodes._common___IngestTotal: + allowed_types: + type: string + disable_max_compilations_rate: + type: string + required: + - allowed_types + - disable_max_compilations_rate + nodes.info___NodeInfoSearch: type: object properties: - count: - description: Total number of documents ingested during the lifetime of this node. - type: number - current: - description: Total number of documents currently being ingested. - type: number - failed: - description: Total number of failed ingest operations during the lifetime of this node. - type: number - processors: - description: Total number of ingest processors. + remote: + $ref: '#/components/schemas/nodes.info___NodeInfoSearchRemote' + required: + - remote + nodes.info___NodeInfoSearchPipelines: + type: object + properties: + response_processors: type: array items: - type: object - additionalProperties: - $ref: '#/components/schemas/nodes._common___KeyedProcessor' - time: - $ref: '#/components/schemas/_common___Duration' - time_in_millis: - $ref: '#/components/schemas/_common___DurationValueUnitMillis' - nodes._common___IoStatDevice: + $ref: '#/components/schemas/nodes.info___NodeInfoIngestProcessor' + request_processors: + type: array + items: + $ref: '#/components/schemas/nodes.info___NodeInfoIngestProcessor' + nodes.info___NodeInfoSearchRemote: type: object properties: - device_name: - description: The Linux device name. + connect: type: string - operations: - description: The total number of read and write operations for the device completed since starting OpenSearch. - type: number - read_kilobytes: - description: The total number of kilobytes read for the device since starting OpenSearch. - type: number - read_operations: - description: The total number of read operations for the device completed since starting OpenSearch. - type: number - write_kilobytes: - description: The total number of kilobytes written for the device since starting OpenSearch. - type: number - write_operations: - description: The total number of write operations for the device completed since starting OpenSearch. - type: number - read_time: - type: number - write_time: - type: number - queue_size: - type: number - io_time_in_millis: - $ref: '#/components/schemas/_common___DurationValueUnitMillis' - nodes._common___IoStats: + required: + - connect + nodes.info___NodeInfoSettings: type: object properties: - devices: - description: |- - Array of disk metrics for each device that is backing an OpenSearch data path. - These disk metrics are probed periodically and averages between the last probe and the current probe are computed. - type: array - items: - $ref: '#/components/schemas/nodes._common___IoStatDevice' - total: - $ref: '#/components/schemas/nodes._common___IoStatDevice' - nodes._common___Jvm: + 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: - buffer_pools: - description: Contains statistics about JVM buffer pools for the node. - type: object - additionalProperties: - $ref: '#/components/schemas/nodes._common___NodeBufferPool' - classes: - $ref: '#/components/schemas/nodes._common___JvmClasses' - gc: - $ref: '#/components/schemas/nodes._common___GarbageCollector' - mem: - $ref: '#/components/schemas/nodes._common___JvmMemoryStats' - threads: - $ref: '#/components/schemas/nodes._common___JvmThreads' - timestamp: - description: Last time JVM statistics were refreshed. - type: number - uptime: - description: |- - Human-readable JVM uptime. - Only returned if the `human` query parameter is `true`. - type: string - uptime_in_millis: - description: JVM uptime in milliseconds. - type: number - nodes._common___JvmClasses: + 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: - current_loaded_count: - description: Number of classes currently loaded by JVM. - type: number - total_loaded_count: - description: Total number of classes loaded since the JVM started. - type: number - total_unloaded_count: - description: Total number of classes unloaded since the JVM started. - type: number - nodes._common___JvmMemoryStats: + strategy: + $ref: '#/components/schemas/_common___Name' + required: + - strategy + nodes.info___NodeInfoSettingsDeprecationIndexing: 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: + enabled: + $ref: '#/components/schemas/_common___StringifiedBoolean' + required: + - enabled + nodes.info___NodeInfoSettingsHttp: type: object properties: - count: - description: Number of active threads in use by JVM. - type: number - peak_count: - description: Highest number of threads used by JVM. - type: number - nodes._common___KeyedProcessor: + 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: - stats: - $ref: '#/components/schemas/nodes._common___Processor' - type: + default: type: string - nodes._common___LastGcStats: + nodes.info___NodeInfoSettingsIndex: type: object properties: - used: - $ref: '#/components/schemas/_common___HumanReadableByteCount' - used_in_bytes: - $ref: '#/components/schemas/_common___ByteCount' - max: - $ref: '#/components/schemas/_common___HumanReadableByteCount' - max_in_bytes: - $ref: '#/components/schemas/_common___ByteCount' - usage_percent: - $ref: '#/components/schemas/_common___PercentageNumber' - nodes._common___MemoryStats: + store: + $ref: '#/components/schemas/nodes.info___NodeInfoSettingsIndexStore' + nodes.info___NodeInfoSettingsIndexHybrid: type: object properties: - adjusted_total_in_bytes: - description: |- - If the amount of physical memory has been overridden using the `es`.`total_memory_bytes` system property then this reports the overridden value in bytes. - Otherwise it reports the same value as `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: + mmap: + $ref: '#/components/schemas/nodes.info___NodeInfoSettingsIndexStoreMmap' + nodes.info___NodeInfoSettingsIndexStore: type: object properties: - count: - description: Number of buffer pools. - type: number - 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: + 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' - reload_exception: - $ref: '#/components/schemas/_common___ErrorCause' + attr: + type: object + additionalProperties: true + max_local_storage_nodes: + type: string required: - name - nodes._common___NodeReloadResult: - oneOf: - - $ref: '#/components/schemas/nodes._common___Stats' - - $ref: '#/components/schemas/nodes._common___NodeReloadError' - nodes._common___NodesResponseBase: + nodes.info___NodeInfoSettingsPlugins: type: object - properties: - _nodes: - $ref: '#/components/schemas/_common___NodeStatistics' - nodes._common___OperatingSystem: + additionalProperties: true + nodes.info___NodeInfoSettingsTransport: type: object properties: - cpu: - $ref: '#/components/schemas/nodes._common___Cpu' - mem: - $ref: '#/components/schemas/nodes._common___ExtendedMemoryStats' - swap: - $ref: '#/components/schemas/nodes._common___MemoryStats' - cgroup: - $ref: '#/components/schemas/nodes._common___Cgroup' - timestamp: - type: number - nodes._common___Pool: + 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: - 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: - description: Most recent GC cycle stats for a particular memory pool. - $ref: '#/components/schemas/nodes._common___LastGcStats' - nodes._common___PressureMemory: + default: + type: string + nodes.info___NodeInfoTransport: 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 - primary_rejections: - description: Number of indexing requests rejected in the primary stage. - type: number - replica_rejections: - description: Number of indexing requests rejected in the replica stage. - type: number - nodes._common___Process: + 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: - cpu: - $ref: '#/components/schemas/nodes._common___Cpu' + gc_collectors: + type: array + items: + type: string mem: - $ref: '#/components/schemas/nodes._common___MemoryStats' - open_file_descriptors: - description: Number of opened file descriptors associated with the current or `-1` if not supported. - type: number - max_file_descriptors: - description: Maximum number of file descriptors allowed on the system, or `-1` if not supported. - type: number - timestamp: - description: |- - Last time the statistics were refreshed. - Recorded in milliseconds since the Unix Epoch. - type: number - nodes._common___Processor: + $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: - count: - description: Number of documents transformed by the processor. - type: number - current: - description: Number of documents currently being transformed by the processor. - type: number - failed: - description: Number of failed operations for the processor. - type: number - time: + 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' - time_in_millis: + refresh_interval_in_millis: $ref: '#/components/schemas/_common___DurationValueUnitMillis' - nodes._common___PublishedClusterStates: - type: object - properties: - full_states: - description: Number of published cluster states. - type: number - incompatible_diffs: - description: Number of incompatible differences between published cluster states. - type: number - compatible_diffs: - description: Number of compatible differences between published cluster states. - type: number - nodes._common___Recording: + 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: - name: - type: string - cumulative_execution_count: - type: number - cumulative_execution_time: + 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' - cumulative_execution_time_millis: + refresh_interval_in_millis: $ref: '#/components/schemas/_common___DurationValueUnitMillis' - nodes._common___RemoteStoreStats: - type: object - properties: - last_successful_fetch_of_pinned_timestamps: - description: Timestamp for the 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: + required: + - id + - mlockall + - refresh_interval_in_millis + nodes.info___NodeThreadPoolInfo: 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: + 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 - nodes._common___Scripting: + 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: - cache_evictions: - description: Total number of times the script cache has evicted old data. - type: number - 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 - 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: + 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: - full_states: - $ref: '#/components/schemas/nodes._common___SerializedClusterStateDetail' - diffs: - $ref: '#/components/schemas/nodes._common___SerializedClusterStateDetail' - nodes._common___SerializedClusterStateDetail: + 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: - count: - type: number - uncompressed_size: + estimated_size: + description: Estimated memory used for the operation. $ref: '#/components/schemas/_common___HumanReadableByteCount' - uncompressed_size_in_bytes: + estimated_size_in_bytes: + description: Estimated memory used, in bytes, for the operation. $ref: '#/components/schemas/_common___ByteCount' - compressed_size: + limit_size: + description: Memory limit for the circuit breaker. $ref: '#/components/schemas/_common___HumanReadableByteCount' - compressed_size_in_bytes: + limit_size_in_bytes: + description: Memory limit, in bytes, for the circuit breaker. $ref: '#/components/schemas/_common___ByteCount' - nodes._common___ShardAdmissionControlStats: - type: object - properties: - global_io_usage: - $ref: '#/components/schemas/nodes._common___UsageStats' - global_cpu_usage: - $ref: '#/components/schemas/nodes._common___UsageStats' - nodes._common___ShardCachesStats: - type: object - additionalProperties: - $ref: '#/components/schemas/nodes._common___ShardCacheStats' - nodes._common___ShardCacheStats: + 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: - size: - $ref: '#/components/schemas/_common___HumanReadableByteCount' - size_in_bytes: - $ref: '#/components/schemas/_common___ByteCount' - evictions: - type: number - hit_count: - type: number - miss_count: - type: number - item_count: - type: number - store_name: + control_group: + description: The `cpuacct` control group to which the OpenSearch process belongs. type: string - nodes._common___ShardClusterManagerThrottlingStats: + usage_nanos: + $ref: '#/components/schemas/_common___DurationValueUnitNanos' + nodes.stats___CgroupCpuStat: type: object properties: - stats: - $ref: '#/components/schemas/nodes._common___ShardClusterManagerThrottlingStatsDetail' - nodes._common___ShardClusterManagerThrottlingStatsDetail: + 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: - total_throttled_tasks: - type: number - throttled_tasks_per_task_type: - type: object - nodes._common___ShardIndexingPressureStats: + 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: - 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: + 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 - additionalProperties: - $ref: '#/components/schemas/nodes._common___ShardResourceUsageStatsDetail' - nodes._common___ShardResourceUsageStatsDetail: + properties: + cpuacct: + $ref: '#/components/schemas/nodes.stats___CgroupCpuAcctStats' + cpu: + $ref: '#/components/schemas/nodes.stats___CgroupCpuStats' + memory: + $ref: '#/components/schemas/nodes.stats___CgroupMemoryStats' + nodes.stats___ClusterStateOverallStats: 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: + 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: - max_io_utilization_percent: - $ref: '#/components/schemas/_common___PercentageString' - nodes._common___ShardSearchBackpressureMode: - type: string - enum: - - disabled - - enforced - - monitor_only - nodes._common___ShardSearchBackpressureStats: + 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: - 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: + overall: + $ref: '#/components/schemas/nodes.stats___ClusterStateOverallStats' + nodes.stats___DataPathStats: 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: + 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: - 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: + 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: - 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: + 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: - cancellation_count: - type: number - current_max: + 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' - current_max_bytes: + 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' - current_avg: + free: + description: Total unallocated disk space in all file stores. $ref: '#/components/schemas/_common___HumanReadableByteCount' - current_avg_bytes: + free_in_bytes: + description: Total number of unallocated bytes in all file stores. $ref: '#/components/schemas/_common___ByteCount' - rolling_avg: + total: + description: Total size of all file stores. $ref: '#/components/schemas/_common___HumanReadableByteCount' - rolling_avg_bytes: + 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._common___ShardSearchBackpressureTaskResourceTrackerStats: + nodes.stats___GarbageCollector: 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: + 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: - 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: + 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.stats___PressureMemory' + total: + $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: - total_request: - $ref: '#/components/schemas/nodes._common___ShardSearchPipelineTotalStats' - total_response: - $ref: '#/components/schemas/nodes._common___ShardSearchPipelineTotalStats' pipelines: + description: Contains statistics about ingest pipelines for the node. type: object - nodes._common___ShardSearchPipelineTotalStats: + additionalProperties: + $ref: '#/components/schemas/nodes.stats___IngestTotal' + total: + $ref: '#/components/schemas/nodes.stats___IngestTotal' + nodes.stats___IngestTotal: type: object properties: count: - type: number + description: Total number of documents ingested during the lifetime of this node. + type: integer + format: int64 + current: + description: Total number of documents currently being ingested. + type: integer + format: int64 + failed: + description: Total number of failed ingest operations during the lifetime of this node. + type: integer + format: int64 + processors: + description: Total number of ingest processors. + type: array + items: + type: object + additionalProperties: + $ref: '#/components/schemas/nodes.stats___KeyedProcessor' 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: + nodes.stats___IoStatDevice: + type: object + properties: + device_name: + description: The Linux device name. + type: string + operations: + description: The total number of read and write operations for the device completed since starting OpenSearch. + type: integer + format: int64 + read_kilobytes: + description: The total number of kilobytes read for the device since starting OpenSearch. + type: integer + format: int64 + read_operations: + description: The total number of read operations for the device completed since starting OpenSearch. + type: integer + format: int64 + write_kilobytes: + description: The total number of kilobytes written for the device since starting OpenSearch. + type: integer + format: int64 + write_operations: + description: The total number of write operations for the device completed since starting OpenSearch. + type: integer + format: int64 + read_time: + type: integer + format: int64 + write_time: + type: integer + format: int64 + queue_size: + type: integer + format: int64 + io_time_in_millis: + $ref: '#/components/schemas/_common___DurationValueUnitMillis' + nodes.stats___IoStats: type: object properties: - fail_open_count: - type: number - nodes._common___Stats: + devices: + description: |- + Array of disk metrics for each device that is backing an OpenSearch data path. + These disk metrics are probed periodically and averages between the last probe and the current probe are computed. + type: array + items: + $ref: '#/components/schemas/nodes.stats___IoStatDevice' + total: + $ref: '#/components/schemas/nodes.stats___IoStatDevice' + nodes.stats___Jvm: 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. + buffer_pools: + description: Contains statistics about JVM buffer pools 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 + $ref: '#/components/schemas/nodes.stats___NodeBufferPool' + classes: + $ref: '#/components/schemas/nodes.stats___JvmClasses' + gc: + $ref: '#/components/schemas/nodes.stats___GarbageCollector' + mem: + $ref: '#/components/schemas/nodes.stats___JvmMemoryStats' threads: - description: Number of threads in the thread pool. - type: number - 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/nodes.stats___JvmThreads' + timestamp: + description: Last time JVM statistics were refreshed. + $ref: '#/components/schemas/_common___EpochTimeUnitMillis' + uptime: + description: |- + Human-readable JVM uptime. + Only returned if the `human` query parameter is `true`. $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: + uptime_in_millis: + description: JVM uptime in milliseconds. + $ref: '#/components/schemas/_common___DurationValueUnitMillis' + nodes.stats___JvmClasses: type: object properties: - node_limits: - type: number - no_successful_request_limits: - type: number - throughput_degradation_limits: - type: number - nodes._common___Transport: + current_loaded_count: + description: Number of classes currently loaded by JVM. + type: integer + format: int64 + total_loaded_count: + description: Total number of classes loaded since the JVM started. + type: integer + format: int64 + total_unloaded_count: + description: Total number of classes unloaded since the JVM started. + type: integer + format: int64 + nodes.stats___JvmMemoryStats: 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: - description: Size of RX packets received by the node during internal cluster communication. + heap_used: + description: Memory currently in use by the heap. $ref: '#/components/schemas/_common___HumanReadableByteCount' - rx_size_in_bytes: - description: Size, in bytes, of RX packets received by the node during internal cluster communication. + heap_used_in_bytes: + description: Memory, in bytes, currently in use by the heap. $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: - description: Size of TX packets sent by the node during internal cluster communication. + 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' - tx_size_in_bytes: - description: Size, in bytes, of TX packets sent by the node during internal cluster communication. + heap_committed_in_bytes: + description: Amount of memory, in bytes, available for use by the heap. $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: + 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.stats___Pool' + nodes.stats___JvmThreads: 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: + description: Number of active threads in use by JVM. + type: integer + format: int64 + peak_count: + description: Highest number of threads used by JVM. + type: integer + format: int64 + nodes.stats___KeyedProcessor: type: object properties: - rejection_count: - type: object - nodes._common___UsageStats: + stats: + $ref: '#/components/schemas/nodes.stats___Processor' + type: + type: string + nodes.stats___LastGcStats: type: object properties: - transport: - $ref: '#/components/schemas/nodes._common___TransportUsageStats' - nodes.info___DeprecationIndexing: + used: + $ref: '#/components/schemas/_common___HumanReadableByteCount' + used_in_bytes: + $ref: '#/components/schemas/_common___ByteCount' + max: + $ref: '#/components/schemas/_common___HumanReadableByteCount' + max_in_bytes: + $ref: '#/components/schemas/_common___ByteCount' + usage_percent: + $ref: '#/components/schemas/_common___PercentageNumber' + nodes.stats___MemoryStats: + allOf: + - $ref: '#/components/schemas/nodes.stats___MemoryStatsBase' + - type: object + properties: {} + nodes.stats___MemoryStatsBase: type: object properties: - enabled: - oneOf: - - type: boolean - - type: string - required: - - enabled - nodes.info___Metric: + 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.stats___Metric: type: string enum: - _all - - aggregations + - adaptive_selection + - admission_control + - breaker + - caches + - cluster_manager_throttling + - discovery + - file_cache + - fs - http + - indexing_pressure - indices - ingest - jvm - os - - plugins - process - - search_pipelines - - settings + - repositories + - resource_usage_stats + - script + - script_cache + - search_backpressure + - search_pipeline + - segment_replication_backpressure + - shard_indexing_pressure + - task_cancellation - thread_pool - transport - nodes.info___NodeInfo: + - weighted_routing + nodes.stats___NodeBufferPool: 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: + count: + description: Number of buffer pools. + 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' - 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: + 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.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.stats___OperatingSystemCpuStats' + mem: + $ref: '#/components/schemas/nodes.stats___ExtendedMemoryStats' + swap: + $ref: '#/components/schemas/nodes.stats___MemoryStats' + cgroup: + $ref: '#/components/schemas/nodes.stats___CgroupStats' + timestamp: + $ref: '#/components/schemas/_common___EpochTimeUnitMillis' + nodes.stats___OperatingSystemCpuStats: + type: object + properties: + percent: + $ref: '#/components/schemas/_common___PercentageNumber' + load_average: 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: 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: + 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: integer + format: int64 + primary_rejections: + description: Number of indexing requests rejected in the primary stage. + type: integer + format: int64 + replica_rejections: + description: Number of indexing requests rejected in the replica stage. + type: integer + format: int64 + nodes.stats___Process: + type: object + properties: + cpu: + $ref: '#/components/schemas/nodes.stats___ProcessCpuStats' + mem: + $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: integer + format: int64 + max_file_descriptors: + description: Maximum number of file descriptors allowed on the system, or `-1` if not supported. + type: integer + format: int64 + timestamp: + description: |- + Last time the statistics were refreshed. + Recorded in milliseconds since the Unix Epoch. + $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: - destructive_requires_name: - type: string - required: - - destructive_requires_name - nodes.info___NodeInfoAggregation: + total_virtual: + $ref: '#/components/schemas/_common___HumanReadableByteCount' + total_virtual_in_bytes: + $ref: '#/components/schemas/_common___ByteCount' + nodes.stats___Processor: type: object properties: - types: + count: + description: Number of documents transformed by the processor. + type: integer + format: int64 + current: + description: Number of documents currently being transformed by the processor. + type: integer + format: int64 + failed: + description: Number of failed operations for the processor. + type: integer + format: int64 + time: + $ref: '#/components/schemas/_common___Duration' + time_in_millis: + $ref: '#/components/schemas/_common___DurationValueUnitMillis' + nodes.stats___PublishedClusterStates: + type: object + properties: + full_states: + description: Number of published cluster states. + type: integer + format: int64 + incompatible_diffs: + description: Number of incompatible differences between published cluster states. + type: integer + format: int64 + compatible_diffs: + description: Number of compatible differences between published cluster states. + type: integer + format: int64 + nodes.stats___RemoteStoreStats: + type: object + properties: + last_successful_fetch_of_pinned_timestamps: + description: Timestamp for the last successful fetch of pinned timestamps. + $ref: '#/components/schemas/_common___EpochTimeUnitSeconds' + nodes.stats___ScriptCacheStats: + type: object + properties: + sum: + $ref: '#/components/schemas/nodes.stats___ScriptStats' + contexts: type: array items: - type: string + $ref: '#/components/schemas/nodes.stats___ScriptContextStats' required: - - types - nodes.info___NodeInfoBootstrap: + - 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: - memory_lock: - type: string + cache_evictions: + description: Total number of times the script cache has evicted old data. + type: integer + format: int64 + compilations: + description: Total number of inline script compilations performed by the node. + type: integer + format: int64 + compilation_limit_triggered: + description: Total number of times the script compilation circuit breaker has limited inline script compilations. + type: integer + format: int64 required: - - memory_lock - nodes.info___NodeInfoClient: + - cache_evictions + - compilation_limit_triggered + - compilations + nodes.stats___ShardAdmissionControlStats: type: object properties: - type: - type: string - required: - - type - nodes.info___NodeInfoDiscovery: + global_io_usage: + $ref: '#/components/schemas/nodes.stats___UsageStats' + global_cpu_usage: + $ref: '#/components/schemas/nodes.stats___UsageStats' + nodes.stats___ShardCachesStats: type: object - properties: - type: - type: string - seed_hosts: - type: string - nodes.info___NodeInfoHttp: + additionalProperties: + $ref: '#/components/schemas/nodes.stats___ShardCacheStats' + nodes.stats___ShardCacheStats: type: object properties: - bound_address: - type: array - items: - type: string - max_content_length: + size: $ref: '#/components/schemas/_common___HumanReadableByteCount' - max_content_length_in_bytes: + size_in_bytes: $ref: '#/components/schemas/_common___ByteCount' - publish_address: + evictions: + type: integer + format: int64 + hit_count: + type: integer + format: int64 + miss_count: + type: integer + format: int64 + item_count: + type: integer + format: int64 + store_name: type: string - required: - - bound_address - - max_content_length_in_bytes - - publish_address - nodes.info___NodeInfoIngest: + nodes.stats___ShardClusterManagerThrottlingStats: type: object properties: - processors: - type: array - items: - $ref: '#/components/schemas/nodes.info___NodeInfoIngestProcessor' - required: - - processors - nodes.info___NodeInfoIngestDownloader: + stats: + $ref: '#/components/schemas/nodes.stats___ShardClusterManagerThrottlingStatsDetail' + nodes.stats___ShardClusterManagerThrottlingStatsDetail: type: object properties: - enabled: - type: string + total_throttled_tasks: + type: integer + format: int64 + throttled_tasks_per_task_type: + type: object + additionalProperties: + type: integer + format: int64 required: - - enabled - nodes.info___NodeInfoIngestInfo: + - throttled_tasks_per_task_type + - total_throttled_tasks + nodes.stats___ShardIndexingPressurePerShardIndexingStats: type: object properties: - downloader: - $ref: '#/components/schemas/nodes.info___NodeInfoIngestDownloader' + 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: - - downloader - nodes.info___NodeInfoIngestProcessor: + - coordinating_count + - coordinating_time_in_millis + - primary_count + - primary_time_in_millis + - replica_count + - replica_time_in_millis + nodes.stats___ShardIndexingPressurePerShardLastSuccessfulTimestamp: type: object properties: - type: - 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: - - type - nodes.info___NodeInfoJvmMemory: + - 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: - 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: - $ref: '#/components/schemas/_common___HumanReadableByteCount' - heap_max_in_bytes: - $ref: '#/components/schemas/_common___ByteCount' - non_heap_init: - $ref: '#/components/schemas/_common___HumanReadableByteCount' - non_heap_init_in_bytes: + current_coordinating_and_primary_bytes: $ref: '#/components/schemas/_common___ByteCount' - non_heap_max: - $ref: '#/components/schemas/_common___HumanReadableByteCount' - non_heap_max_in_bytes: + current_replica_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: + - current_coordinating_and_primary_bytes + - current_replica_bytes + nodes.stats___ShardIndexingPressurePerShardMemoryAllocationLimitStats: type: object properties: - total: - $ref: '#/components/schemas/_common___HumanReadableByteCount' - total_in_bytes: + current_coordinating_and_primary_limits_in_bytes: + $ref: '#/components/schemas/_common___ByteCount' + current_replica_limits_in_bytes: $ref: '#/components/schemas/_common___ByteCount' required: - - total - - total_in_bytes - nodes.info___NodeInfoNetwork: + - current_coordinating_and_primary_limits_in_bytes + - current_replica_limits_in_bytes + nodes.stats___ShardIndexingPressurePerShardMemoryAllocationStats: type: object properties: - primary_interface: - $ref: '#/components/schemas/nodes.info___NodeInfoNetworkInterface' - refresh_interval: - type: number + current: + $ref: '#/components/schemas/nodes.stats___ShardIndexingPressurePerShardMemoryAllocationCurrentStats' + limit: + $ref: '#/components/schemas/nodes.stats___ShardIndexingPressurePerShardMemoryAllocationLimitStats' required: - - primary_interface - - refresh_interval - nodes.info___NodeInfoNetworkInterface: + - current + - limit + nodes.stats___ShardIndexingPressurePerShardMemoryStats: type: object properties: - address: - type: string - mac_address: - type: string - name: - $ref: '#/components/schemas/_common___Name' + current: + $ref: '#/components/schemas/nodes.stats___ShardIndexingPressurePerShardMemoryStatsDetails' + total: + $ref: '#/components/schemas/nodes.stats___ShardIndexingPressurePerShardMemoryStatsDetails' required: - - address - - mac_address - - name - nodes.info___NodeInfoOSCPU: + - current + - total + nodes.stats___ShardIndexingPressurePerShardMemoryStatsDetails: type: object properties: - cache_size: + coordinating: $ref: '#/components/schemas/_common___HumanReadableByteCount' - cache_size_in_bytes: + coordinating_in_bytes: + $ref: '#/components/schemas/_common___ByteCount' + primary: + $ref: '#/components/schemas/_common___HumanReadableByteCount' + primary_in_bytes: + $ref: '#/components/schemas/_common___ByteCount' + replica: + $ref: '#/components/schemas/_common___HumanReadableByteCount' + replica_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 required: - - cache_size - - cache_size_in_bytes - - cores_per_socket - - mhz - - model - - total_cores - - total_sockets - - vendor - nodes.info___NodeInfoPath: + - coordinating_in_bytes + - primary_in_bytes + - replica_in_bytes + nodes.stats___ShardIndexingPressurePerShardRejectionCoordinatingStats: type: object properties: - logs: - type: string - home: - type: string - repo: - type: array - items: - type: string - data: - type: array - items: - type: string + coordinating_rejections: + type: integer + format: int64 + breakup: + $ref: '#/components/schemas/nodes.stats___ShardIndexingPressureRejectionsBreakupStats' + breakup_shadow_mode: + $ref: '#/components/schemas/nodes.stats___ShardIndexingPressureRejectionsBreakupStats' required: - - home - - logs - nodes.info___NodeInfoRepositories: + - coordinating_rejections + nodes.stats___ShardIndexingPressurePerShardRejectionPrimaryStats: type: object properties: - url: - $ref: '#/components/schemas/nodes.info___NodeInfoRepositoriesUrl' + primary_rejections: + type: integer + format: int64 + breakup: + $ref: '#/components/schemas/nodes.stats___ShardIndexingPressureRejectionsBreakupStats' + breakup_shadow_mode: + $ref: '#/components/schemas/nodes.stats___ShardIndexingPressureRejectionsBreakupStats' required: - - url - nodes.info___NodeInfoRepositoriesUrl: + - primary_rejections + nodes.stats___ShardIndexingPressurePerShardRejectionReplicaStats: type: object properties: - allowed_urls: - type: string + replica_rejections: + type: integer + format: int64 + breakup: + $ref: '#/components/schemas/nodes.stats___ShardIndexingPressureRejectionsBreakupStats' + breakup_shadow_mode: + $ref: '#/components/schemas/nodes.stats___ShardIndexingPressureRejectionsBreakupStats' required: - - allowed_urls - nodes.info___NodeInfoScript: + - replica_rejections + nodes.stats___ShardIndexingPressurePerShardRejectionStats: type: object properties: - allowed_types: - type: string - disable_max_compilations_rate: - type: string + coordinating: + $ref: '#/components/schemas/nodes.stats___ShardIndexingPressurePerShardRejectionCoordinatingStats' + primary: + $ref: '#/components/schemas/nodes.stats___ShardIndexingPressurePerShardRejectionPrimaryStats' + replica: + $ref: '#/components/schemas/nodes.stats___ShardIndexingPressurePerShardRejectionReplicaStats' required: - - allowed_types - - disable_max_compilations_rate - nodes.info___NodeInfoSearch: + - coordinating + - primary + - replica + nodes.stats___ShardIndexingPressurePerShardStats: type: object properties: - remote: - $ref: '#/components/schemas/nodes.info___NodeInfoSearchRemote' + 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: - - remote - nodes.info___NodeInfoSearchPipelines: + - indexing + - last_successful_timestamp + - memory + - memory_allocation + - rejection + nodes.stats___ShardIndexingPressureRejectionsBreakupStats: 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: + 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: - connect: - type: string - required: - - connect - nodes.info___NodeInfoSettings: + 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: - 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: + 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: - 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: + 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: - strategy: - $ref: '#/components/schemas/_common___Name' - required: - - strategy - nodes.info___NodeInfoSettingsHttp: + 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: - type: - type: string - type.default: - type: string - compression: - oneOf: - - type: boolean - - type: string - port: - oneOf: - - type: number - - type: string - required: - - type - nodes.info___NodeInfoSettingsIndex: + 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: - store: - $ref: '#/components/schemas/nodes.info___NodeInfoSettingsIndexStore' - nodes.info___NodeInfoSettingsIndexHybrid: + 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: - mmap: - $ref: '#/components/schemas/nodes.info___NodeInfoSettingsIndexStoreMmap' - nodes.info___NodeInfoSettingsIndexStore: + 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: + 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: + 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: + 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: + 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: + $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: - 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: + 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: - host: - $ref: '#/components/schemas/_common___Host' - required: - - host - nodes.info___NodeInfoSettingsNode: + total_rejected_requests: + type: integer + format: int64 + nodes.stats___ShardTaskCancellationStats: 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: + search_shard_task: + $ref: '#/components/schemas/nodes.stats___ShardTaskCancellationStatsDetail' + nodes.stats___ShardTaskCancellationStatsDetail: type: object - additionalProperties: - $ref: '#/components/schemas/_common___FieldValue' - nodes.info___NodeInfoSettingsTransport: + properties: + current_count_post_cancel: + type: integer + format: int64 + total_count_post_cancel: + type: integer + format: int64 + nodes.stats___ShardWeightedRoutingStats: type: object properties: - type: - type: string - type.default: - type: string - required: - - type - nodes.info___NodeInfoShardIndexingPressureEnabled: + stats: + $ref: '#/components/schemas/nodes.stats___ShardWeightedRoutingStatsDetail' + nodes.stats___ShardWeightedRoutingStatsDetail: type: object properties: - shard_indexing_pressure_enabled: - type: string - required: - - shard_indexing_pressure_enabled - nodes.info___NodeInfoTransport: + fail_open_count: + type: integer + format: int32 + nodes.stats___Stats: type: object properties: - bound_address: - type: array - items: - type: string - publish_address: - type: string - profiles: + 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 @@ -55181,34 +59376,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: @@ -55542,7 +59721,6 @@ components: $ref: '#/components/schemas/observability._common___SavedQuery' required: - objectId - - tenant observability._common___ObservabilityObjectList: type: object properties: @@ -56090,19 +60268,6 @@ components: type: string follower_cluster_role: type: string - rollups._common___Continuous: - type: object - properties: - next_window_start_time: - type: number - next_window_end_time: - type: number - status: - type: string - failure_reason: - type: string - stats: - $ref: '#/components/schemas/rollups._common___Stats' rollups._common___Cron: type: object properties: @@ -56123,6 +60288,10 @@ components: type: string target_field: type: string + format: + type: + - 'null' + - string rollups._common___DimensionsConfigItem: type: object properties: @@ -56137,17 +60306,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: @@ -56222,7 +60392,9 @@ components: target_index: type: string metadata_id: - type: string + type: + - 'null' + - string page_size: type: number delay: @@ -56244,11 +60416,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: @@ -56256,19 +60431,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: @@ -57235,6 +61397,10 @@ components: required: - op - path + security._common___PatchOperations: + type: array + items: + $ref: '#/components/schemas/security._common___PatchOperation' security._common___PermissionsInfo: type: object properties: @@ -57491,11 +61657,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: @@ -57519,79 +62035,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: @@ -57600,7 +62052,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: @@ -57678,13 +62130,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 @@ -57693,6 +62225,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: @@ -57706,7 +62240,7 @@ components: - start_time_in_millis - time_in_millis - total - snapshot._common___Status: + snapshot._common___SnapshotStatus: type: object properties: include_global_state: @@ -57718,7 +62252,7 @@ components: repository: type: string shards_stats: - $ref: '#/components/schemas/snapshot._common___ShardsStats' + $ref: '#/components/schemas/snapshot._common___SnapshotShardsStats' snapshot: type: string state: @@ -57728,7 +62262,6 @@ components: uuid: $ref: '#/components/schemas/_common___Uuid' required: - - include_global_state - indices - repository - shards_stats @@ -57999,6 +62532,8 @@ components: type: boolean cancellable: type: boolean + cancellation_time_millis: + $ref: '#/components/schemas/_common___EpochTimeUnitMillis' description: type: string headers: @@ -58022,6 +62557,8 @@ components: type: string parent_task_id: $ref: '#/components/schemas/_common___TaskId' + resource_stats: + $ref: '#/components/schemas/_common___ResourceStats' required: - action - cancellable @@ -58084,13 +62621,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: @@ -58128,32 +62720,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: @@ -58196,13 +62762,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: @@ -58222,20 +62792,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: @@ -58251,6 +62810,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: @@ -58259,7 +62839,7 @@ components: transforms: type: array items: - $ref: '#/components/schemas/transforms._common___TransformEntity' + $ref: '#/components/schemas/transforms._common___TransformResponse' wlm._common___QueryGroupCreate: type: object properties: diff --git a/src/OpenSearch.Client/_Generated/Descriptors.Cat.cs b/src/OpenSearch.Client/_Generated/Descriptors.Cat.cs index 6198e73b9c..52009df73b 100644 --- a/src/OpenSearch.Client/_Generated/Descriptors.Cat.cs +++ b/src/OpenSearch.Client/_Generated/Descriptors.Cat.cs @@ -80,32 +80,32 @@ public CatAliasesDescriptor(Names name) // values part of the url path Names ICatAliasesRequest.Name => Self.RouteValues.Get("name"); - /// A comma-separated list of aliases to retrieve. Supports wildcards (`*`). To retrieve all aliases, omit this parameter or use `*` or `_all`. + /// public CatAliasesDescriptor Name(Names name) => Assign(name, (a, v) => a.RouteValues.Optional("name", v)); // Request parameters - /// Whether to expand wildcard expression to concrete indexes that are open, closed or both. + /// TODO public CatAliasesDescriptor ExpandWildcards(ExpandWildcards? expandwildcards) => Qs("expand_wildcards", expandwildcards); - /// A short version of the Accept header (for example, `json`, `yaml`). + /// A short version of the `Accept` header, such as `json` or `yaml`. public CatAliasesDescriptor Format(string format) => Qs("format", format); - /// Comma-separated list of column names to display. + /// A comma-separated list of column names to display. public CatAliasesDescriptor Headers(params string[] headers) => Qs("h", headers); - /// Return help information. + /// Returns help information. public CatAliasesDescriptor Help(bool? help = true) => Qs("help", help); - /// Return local information, do not retrieve the state from cluster-manager node. + /// Whether to return information from the local node only instead of from the cluster manager node. public CatAliasesDescriptor Local(bool? local = true) => Qs("local", local); - /// Comma-separated list of column names or column aliases to sort by. + /// A comma-separated list of column names or column aliases to sort by. public CatAliasesDescriptor SortByColumns(params string[] sortbycolumns) => Qs("s", sortbycolumns); - /// Verbose mode. Display column headers. + /// Enables verbose mode, which displays column headers. public CatAliasesDescriptor Verbose(bool? verbose = true) => Qs("v", verbose); } @@ -122,23 +122,23 @@ public partial class CatAllPitSegmentsDescriptor // values part of the url path // Request parameters - /// The unit in which to display byte values. + /// The units used to display byte values. public CatAllPitSegmentsDescriptor Bytes(ByteUnit? bytes) => Qs("bytes", bytes); - /// A short version of the Accept header (for example, `json`, `yaml`). + /// A short version of the `Accept` header, such as `json` or `yaml`. public CatAllPitSegmentsDescriptor Format(string format) => Qs("format", format); - /// Comma-separated list of column names to display. + /// A comma-separated list of column names to display. public CatAllPitSegmentsDescriptor Headers(params string[] headers) => Qs("h", headers); - /// Return help information. + /// Returns help information. public CatAllPitSegmentsDescriptor Help(bool? help = true) => Qs("help", help); - /// Comma-separated list of column names or column aliases to sort by. + /// A comma-separated list of column names or column aliases to sort by. public CatAllPitSegmentsDescriptor SortByColumns(params string[] sortbycolumns) => Qs("s", sortbycolumns); - /// Verbose mode. Display column headers. + /// Enables verbose mode, which displays column headers. public CatAllPitSegmentsDescriptor Verbose(bool? verbose = true) => Qs("v", verbose); } @@ -165,43 +165,43 @@ public CatAllocationDescriptor(NodeIds nodeId) // values part of the url path NodeIds ICatAllocationRequest.NodeId => Self.RouteValues.Get("node_id"); - /// Comma-separated list of node identifiers or names used to limit the returned information. + /// A comma-separated list of node IDs or names used to limit the returned information. public CatAllocationDescriptor NodeId(NodeIds nodeId) => Assign(nodeId, (a, v) => a.RouteValues.Optional("node_id", v)); // Request parameters - /// The unit used to display byte values. + /// The units used to display byte values. public CatAllocationDescriptor Bytes(ByteUnit? bytes) => Qs("bytes", bytes); - /// Operation timeout for connection to cluster-manager node. + /// A timeout for connection to the cluster manager node. /// Supported by OpenSearch servers of version 2.0.0 or greater. public CatAllocationDescriptor ClusterManagerTimeout(Time clustermanagertimeout) => Qs("cluster_manager_timeout", clustermanagertimeout); - /// A short version of the Accept header (for example, `json`, `yaml`). + /// A short version of the HTTP `Accept` header, such as `json` or `yaml`. public CatAllocationDescriptor Format(string format) => Qs("format", format); - /// Comma-separated list of column names to display. + /// A comma-separated list of column names to display. public CatAllocationDescriptor Headers(params string[] headers) => Qs("h", headers); - /// Return help information. + /// Returns help information. public CatAllocationDescriptor Help(bool? help = true) => Qs("help", help); - /// Return local information, do not retrieve the state from cluster-manager node. + /// Returns local information but does not retrieve the state from cluster-manager node. public CatAllocationDescriptor Local(bool? local = true) => Qs("local", local); - /// Operation timeout for connection to cluster-manager node. + /// A timeout for connection to the cluster manager node. [Obsolete( "Deprecated as of: 2.0.0, reason: To promote inclusive language, use `cluster_manager_timeout` instead." )] public CatAllocationDescriptor MasterTimeout(Time mastertimeout) => Qs("master_timeout", mastertimeout); - /// Comma-separated list of column names or column aliases to sort by. + /// A comma-separated list of column names or column aliases to sort by. public CatAllocationDescriptor SortByColumns(params string[] sortbycolumns) => Qs("s", sortbycolumns); - /// Verbose mode. Display column headers. + /// Enables verbose mode, which displays column headers. public CatAllocationDescriptor Verbose(bool? verbose = true) => Qs("v", verbose); } @@ -218,35 +218,35 @@ public partial class CatClusterManagerDescriptor // values part of the url path // Request parameters - /// Operation timeout for connection to cluster-manager node. + /// A timeout for connection to the cluster manager node. /// Supported by OpenSearch servers of version 2.0.0 or greater. public CatClusterManagerDescriptor ClusterManagerTimeout(Time clustermanagertimeout) => Qs("cluster_manager_timeout", clustermanagertimeout); - /// A short version of the Accept header (for example, `json`, `yaml`). + /// A short version of the HTTP `Accept` header, such as `json` or `yaml`. public CatClusterManagerDescriptor Format(string format) => Qs("format", format); - /// Comma-separated list of column names to display. + /// A comma-separated list of column names to display. public CatClusterManagerDescriptor Headers(params string[] headers) => Qs("h", headers); - /// Return help information. + /// Returns help information. public CatClusterManagerDescriptor Help(bool? help = true) => Qs("help", help); - /// Return local information, do not retrieve the state from cluster-manager node. + /// Returns local information but does not retrieve the state from the cluster manager node. public CatClusterManagerDescriptor Local(bool? local = true) => Qs("local", local); - /// Operation timeout for connection to cluster-manager node. + /// A timeout for connection to the cluster manager node. [Obsolete( "Deprecated as of: 2.0.0, reason: To promote inclusive language, use `cluster_manager_timeout` instead." )] public CatClusterManagerDescriptor MasterTimeout(Time mastertimeout) => Qs("master_timeout", mastertimeout); - /// Comma-separated list of column names or column aliases to sort by. + /// A comma-separated list of column names or column aliases to sort by. public CatClusterManagerDescriptor SortByColumns(params string[] sortbycolumns) => Qs("s", sortbycolumns); - /// Verbose mode. Display column headers. + /// Enables verbose mode, which displays column headers. public CatClusterManagerDescriptor Verbose(bool? verbose = true) => Qs("v", verbose); } @@ -282,20 +282,20 @@ public CatCountDescriptor Index() public CatCountDescriptor AllIndices() => Index(Indices.All); // Request parameters - /// A short version of the Accept header (for example, `json`, `yaml`). + /// A short version of the `Accept` header, such as `json` or `yaml`. public CatCountDescriptor Format(string format) => Qs("format", format); - /// Comma-separated list of column names to display. + /// A comma-separated list of column names to display. public CatCountDescriptor Headers(params string[] headers) => Qs("h", headers); - /// Return help information. + /// Returns help information. public CatCountDescriptor Help(bool? help = true) => Qs("help", help); - /// Comma-separated list of column names or column aliases to sort by. + /// A comma-separated list of column names or column aliases to sort by. public CatCountDescriptor SortByColumns(params string[] sortbycolumns) => Qs("s", sortbycolumns); - /// Verbose mode. Display column headers. + /// Enables verbose mode, which displays column headers. public CatCountDescriptor Verbose(bool? verbose = true) => Qs("v", verbose); } @@ -322,32 +322,32 @@ public CatFielddataDescriptor(Fields fields) // values part of the url path Fields ICatFielddataRequest.Fields => Self.RouteValues.Get("fields"); - /// Comma-separated list of fields used to limit returned information. To retrieve all fields, omit this parameter. + /// A comma-separated list of fields used to limit the amount of returned information. To retrieve all fields, omit this parameter. public CatFielddataDescriptor Fields(Fields fields) => Assign(fields, (a, v) => a.RouteValues.Optional("fields", v)); - /// Comma-separated list of fields used to limit returned information. To retrieve all fields, omit this parameter. + /// A comma-separated list of fields used to limit the amount of returned information. To retrieve all fields, omit this parameter. public CatFielddataDescriptor Fields(params Expression>[] fields) => Assign(fields, (a, v) => a.RouteValues.Optional("fields", (Fields)v)); // Request parameters - /// The unit used to display byte values. + /// The units used to display byte values. public CatFielddataDescriptor Bytes(ByteUnit? bytes) => Qs("bytes", bytes); - /// A short version of the Accept header (for example, `json`, `yaml`). + /// A short version of the `Accept` header, such as `json` or `yaml`. public CatFielddataDescriptor Format(string format) => Qs("format", format); - /// Comma-separated list of column names to display. + /// A comma-separated list of column names to display. public CatFielddataDescriptor Headers(params string[] headers) => Qs("h", headers); - /// Return help information. + /// Returns help information. public CatFielddataDescriptor Help(bool? help = true) => Qs("help", help); - /// Comma-separated list of column names or column aliases to sort by. + /// A comma-separated list of column names or column aliases to sort by. public CatFielddataDescriptor SortByColumns(params string[] sortbycolumns) => Qs("s", sortbycolumns); - /// Verbose mode. Display column headers. + /// Enables verbose mode, which displays column headers. public CatFielddataDescriptor Verbose(bool? verbose = true) => Qs("v", verbose); } @@ -360,24 +360,24 @@ public partial class CatHealthDescriptor // values part of the url path // Request parameters - /// A short version of the Accept header (for example, `json`, `yaml`). + /// A short version of the `Accept` header, such as `json` or `yaml`. public CatHealthDescriptor Format(string format) => Qs("format", format); - /// Comma-separated list of column names to display. + /// A comma-separated list of column names to display. public CatHealthDescriptor Headers(params string[] headers) => Qs("h", headers); - /// Return help information. + /// Returns help information. public CatHealthDescriptor Help(bool? help = true) => Qs("help", help); - /// If `true`, returns `HH:MM:SS` and Unix epoch timestamps. + /// When `true`, returns `HH:MM:SS` and Unix epoch timestamps. public CatHealthDescriptor IncludeTimestamp(bool? includetimestamp = true) => Qs("ts", includetimestamp); - /// Comma-separated list of column names or column aliases to sort by. + /// A comma-separated list of column names or column aliases to sort by. public CatHealthDescriptor SortByColumns(params string[] sortbycolumns) => Qs("s", sortbycolumns); - /// Verbose mode. Display column headers. + /// Enables verbose mode, which displays column headers. public CatHealthDescriptor Verbose(bool? verbose = true) => Qs("v", verbose); } @@ -414,7 +414,7 @@ public CatIndicesDescriptor(Indices index) // values part of the url path Indices ICatIndicesRequest.Index => Self.RouteValues.Get("index"); - /// 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`. + /// 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`. public CatIndicesDescriptor Index(Indices index) => Assign(index, (a, v) => a.RouteValues.Optional("index", v)); @@ -427,52 +427,52 @@ public CatIndicesDescriptor Index() public CatIndicesDescriptor AllIndices() => Index(Indices.All); // Request parameters - /// The unit used to display byte values. + /// The units used to display byte values. public CatIndicesDescriptor Bytes(ByteUnit? bytes) => Qs("bytes", bytes); - /// Operation timeout for connection to cluster-manager node. + /// The amount of time allowed to establish a connection to the cluster manager node. /// Supported by OpenSearch servers of version 2.0.0 or greater. public CatIndicesDescriptor ClusterManagerTimeout(Time clustermanagertimeout) => Qs("cluster_manager_timeout", clustermanagertimeout); - /// The type of index that wildcard patterns can match. + /// TODO public CatIndicesDescriptor ExpandWildcards(ExpandWildcards? expandwildcards) => Qs("expand_wildcards", expandwildcards); - /// A short version of the Accept header (for example, `json`, `yaml`). + /// A short version of the `Accept` header, such as `json` or `yaml`. public CatIndicesDescriptor Format(string format) => Qs("format", format); - /// Comma-separated list of column names to display. + /// A comma-separated list of column names to display. public CatIndicesDescriptor Headers(params string[] headers) => Qs("h", headers); - /// The health status used to limit returned indexes. By default, the response includes indexes of any health status. + /// Limits indexes based on their health status. Supported values are `green`, `yellow`, and `red`. public CatIndicesDescriptor Health(HealthStatus? health) => Qs("health", health); - /// Return help information. + /// Returns help information. public CatIndicesDescriptor Help(bool? help = true) => Qs("help", help); - /// If `true`, the response includes information from segments that are not loaded into memory. + /// Whether to include information from segments not loaded into memory. public CatIndicesDescriptor IncludeUnloadedSegments(bool? includeunloadedsegments = true) => Qs("include_unloaded_segments", includeunloadedsegments); - /// Return local information, do not retrieve the state from cluster-manager node. + /// Returns local information but does not retrieve the state from the cluster manager node. public CatIndicesDescriptor Local(bool? local = true) => Qs("local", local); - /// Operation timeout for connection to cluster-manager node. + /// The amount of time allowed to establish a connection to the cluster manager node. [Obsolete( "Deprecated as of: 2.0.0, reason: To promote inclusive language, use `cluster_manager_timeout` instead." )] public CatIndicesDescriptor MasterTimeout(Time mastertimeout) => Qs("master_timeout", mastertimeout); - /// If `true`, the response only includes information from primary shards. + /// When `true`, returns information only from the primary shards. public CatIndicesDescriptor Pri(bool? pri = true) => Qs("pri", pri); - /// Comma-separated list of column names or column aliases to sort by. + /// A comma-separated list of column names or column aliases to sort by. public CatIndicesDescriptor SortByColumns(params string[] sortbycolumns) => Qs("s", sortbycolumns); - /// Verbose mode. Display column headers. + /// Enables verbose mode, which displays column headers. public CatIndicesDescriptor Verbose(bool? verbose = true) => Qs("v", verbose); } @@ -485,35 +485,35 @@ public partial class CatMasterDescriptor // values part of the url path // Request parameters - /// Operation timeout for connection to cluster-manager node. + /// The amount of time allowed to establish a connection to the cluster manager node. /// Supported by OpenSearch servers of version 2.0.0 or greater. public CatMasterDescriptor ClusterManagerTimeout(Time clustermanagertimeout) => Qs("cluster_manager_timeout", clustermanagertimeout); - /// A short version of the Accept header (for example, `json`, `yaml`). + /// A short version of the `Accept` header, such as `json` or `yaml`. public CatMasterDescriptor Format(string format) => Qs("format", format); - /// Comma-separated list of column names to display. + /// A comma-separated list of column names to display. public CatMasterDescriptor Headers(params string[] headers) => Qs("h", headers); - /// Return help information. + /// Returns help information. public CatMasterDescriptor Help(bool? help = true) => Qs("help", help); - /// Return local information, do not retrieve the state from cluster-manager node. + /// Returns local information but does not retrieve the state from the cluster manager node. public CatMasterDescriptor Local(bool? local = true) => Qs("local", local); - /// Operation timeout for connection to cluster-manager node. + /// The amount of time allowed to establish a connection to the cluster manager node. [Obsolete( "Deprecated as of: 2.0.0, reason: To promote inclusive language, use `cluster_manager_timeout` instead." )] public CatMasterDescriptor MasterTimeout(Time mastertimeout) => Qs("master_timeout", mastertimeout); - /// Comma-separated list of column names or column aliases to sort by. + /// A comma-separated list of column names or column aliases to sort by. public CatMasterDescriptor SortByColumns(params string[] sortbycolumns) => Qs("s", sortbycolumns); - /// Verbose mode. Display column headers. + /// Enables verbose mode, which displays column headers. public CatMasterDescriptor Verbose(bool? verbose = true) => Qs("v", verbose); } @@ -530,35 +530,35 @@ public partial class CatNodeAttributesDescriptor // values part of the url path // Request parameters - /// Operation timeout for connection to cluster-manager node. + /// The amount of time allowed to establish a connection to the cluster manager node. /// Supported by OpenSearch servers of version 2.0.0 or greater. public CatNodeAttributesDescriptor ClusterManagerTimeout(Time clustermanagertimeout) => Qs("cluster_manager_timeout", clustermanagertimeout); - /// A short version of the Accept header (for example, `json`, `yaml`). + /// A short version of the `Accept` header, such as `json` or `yaml`. public CatNodeAttributesDescriptor Format(string format) => Qs("format", format); - /// Comma-separated list of column names to display. + /// A comma-separated list of column names to display. public CatNodeAttributesDescriptor Headers(params string[] headers) => Qs("h", headers); - /// Return help information. + /// Returns help information. public CatNodeAttributesDescriptor Help(bool? help = true) => Qs("help", help); - /// Return local information, do not retrieve the state from cluster-manager node. + /// Returns local information but does not retrieve the state from the cluster manager node. public CatNodeAttributesDescriptor Local(bool? local = true) => Qs("local", local); - /// Operation timeout for connection to cluster-manager node. + /// The amount of time allowed to establish a connection to the cluster manager node. [Obsolete( "Deprecated as of: 2.0.0, reason: To promote inclusive language, use `cluster_manager_timeout` instead." )] public CatNodeAttributesDescriptor MasterTimeout(Time mastertimeout) => Qs("master_timeout", mastertimeout); - /// Comma-separated list of column names or column aliases to sort by. + /// A comma-separated list of column names or column aliases to sort by. public CatNodeAttributesDescriptor SortByColumns(params string[] sortbycolumns) => Qs("s", sortbycolumns); - /// Verbose mode. Display column headers. + /// Enables verbose mode, which displays column headers. public CatNodeAttributesDescriptor Verbose(bool? verbose = true) => Qs("v", verbose); } @@ -571,44 +571,44 @@ public partial class CatNodesDescriptor // values part of the url path // Request parameters - /// The unit used to display byte values. + /// The units used to display byte values. public CatNodesDescriptor Bytes(ByteUnit? bytes) => Qs("bytes", bytes); - /// Operation timeout for connection to cluster-manager node. + /// The amount of time allowed to establish a connection to the cluster manager node. /// Supported by OpenSearch servers of version 2.0.0 or greater. public CatNodesDescriptor ClusterManagerTimeout(Time clustermanagertimeout) => Qs("cluster_manager_timeout", clustermanagertimeout); - /// A short version of the Accept header (for example, `json`, `yaml`). + /// A short version of the `Accept` header, such as `json` or `yaml`. public CatNodesDescriptor Format(string format) => Qs("format", format); - /// If `true`, return the full node ID. If `false`, return the shortened node ID. + /// When `true`, returns the full node ID. When `false`, returns the shortened node ID. public CatNodesDescriptor FullId(bool? fullid = true) => Qs("full_id", fullid); - /// Comma-separated list of column names to display. + /// A comma-separated list of column names to display. public CatNodesDescriptor Headers(params string[] headers) => Qs("h", headers); - /// Return help information. + /// Returns help information. public CatNodesDescriptor Help(bool? help = true) => Qs("help", help); - /// Return local information, do not retrieve the state from cluster-manager node. + /// Returns local information but does not retrieve the state from the cluster manager node. [Obsolete( "Deprecated as of: 1.0.0, reason: This parameter does not cause this API to act locally." )] public CatNodesDescriptor Local(bool? local = true) => Qs("local", local); - /// Operation timeout for connection to cluster-manager node. + /// The amount of time allowed to establish a connection to the cluster manager node. [Obsolete( "Deprecated as of: 2.0.0, reason: To promote inclusive language, use `cluster_manager_timeout` instead." )] public CatNodesDescriptor MasterTimeout(Time mastertimeout) => Qs("master_timeout", mastertimeout); - /// Comma-separated list of column names or column aliases to sort by. + /// A comma-separated list of column names or column aliases to sort by. public CatNodesDescriptor SortByColumns(params string[] sortbycolumns) => Qs("s", sortbycolumns); - /// Verbose mode. Display column headers. + /// Enables verbose mode, which displays column headers. public CatNodesDescriptor Verbose(bool? verbose = true) => Qs("v", verbose); } @@ -625,35 +625,35 @@ public partial class CatPendingTasksDescriptor // values part of the url path // Request parameters - /// Operation timeout for connection to cluster-manager node. + /// The amount of time allowed to establish a connection to the cluster manager node. /// Supported by OpenSearch servers of version 2.0.0 or greater. public CatPendingTasksDescriptor ClusterManagerTimeout(Time clustermanagertimeout) => Qs("cluster_manager_timeout", clustermanagertimeout); - /// A short version of the Accept header (for example, `json`, `yaml`). + /// A short version of the `Accept` header, such as `json` or `yaml`. public CatPendingTasksDescriptor Format(string format) => Qs("format", format); - /// Comma-separated list of column names to display. + /// A comma-separated list of column names to display. public CatPendingTasksDescriptor Headers(params string[] headers) => Qs("h", headers); - /// Return help information. + /// Returns help information. public CatPendingTasksDescriptor Help(bool? help = true) => Qs("help", help); - /// Return local information, do not retrieve the state from cluster-manager node. + /// Returns local information but does not retrieve the state from the cluster manager node. public CatPendingTasksDescriptor Local(bool? local = true) => Qs("local", local); - /// Operation timeout for connection to cluster-manager node. + /// The amount of time allowed to establish a connection to the cluster manager node. [Obsolete( "Deprecated as of: 2.0.0, reason: To promote inclusive language, use `cluster_manager_timeout` instead." )] public CatPendingTasksDescriptor MasterTimeout(Time mastertimeout) => Qs("master_timeout", mastertimeout); - /// Comma-separated list of column names or column aliases to sort by. + /// A comma-separated list of column names or column aliases to sort by. public CatPendingTasksDescriptor SortByColumns(params string[] sortbycolumns) => Qs("s", sortbycolumns); - /// Verbose mode. Display column headers. + /// Enables verbose mode, which displays column headers. public CatPendingTasksDescriptor Verbose(bool? verbose = true) => Qs("v", verbose); } @@ -670,23 +670,23 @@ public partial class CatPitSegmentsDescriptor // values part of the url path // Request parameters - /// The unit in which to display byte values. + /// The units used to display byte values. public CatPitSegmentsDescriptor Bytes(ByteUnit? bytes) => Qs("bytes", bytes); - /// A short version of the Accept header (for example, `json`, `yaml`). + /// A short version of the `Accept` header, such as `json` or `yaml`. public CatPitSegmentsDescriptor Format(string format) => Qs("format", format); - /// Comma-separated list of column names to display. + /// A comma-separated list of column names to display. public CatPitSegmentsDescriptor Headers(params string[] headers) => Qs("h", headers); - /// Return help information. + /// Returns help information. public CatPitSegmentsDescriptor Help(bool? help = true) => Qs("help", help); - /// Comma-separated list of column names or column aliases to sort by. + /// A comma-separated list of column names or column aliases to sort by. public CatPitSegmentsDescriptor SortByColumns(params string[] sortbycolumns) => Qs("s", sortbycolumns); - /// Verbose mode. Display column headers. + /// Enables verbose mode, which displays column headers. public CatPitSegmentsDescriptor Verbose(bool? verbose = true) => Qs("v", verbose); } @@ -703,35 +703,35 @@ public partial class CatPluginsDescriptor // values part of the url path // Request parameters - /// Operation timeout for connection to cluster-manager node. + /// The amount of time allowed to establish a connection to the cluster manager node. /// Supported by OpenSearch servers of version 2.0.0 or greater. public CatPluginsDescriptor ClusterManagerTimeout(Time clustermanagertimeout) => Qs("cluster_manager_timeout", clustermanagertimeout); - /// A short version of the Accept header (for example, `json`, `yaml`). + /// A short version of the `Accept` header, such as `json` or `yaml`. public CatPluginsDescriptor Format(string format) => Qs("format", format); - /// Comma-separated list of column names to display. + /// A comma-separated list of column names to display. public CatPluginsDescriptor Headers(params string[] headers) => Qs("h", headers); - /// Return help information. + /// Returns help information. public CatPluginsDescriptor Help(bool? help = true) => Qs("help", help); - /// Return local information, do not retrieve the state from cluster-manager node. + /// Returns local information but does not retrieve the state from the cluster manager node. public CatPluginsDescriptor Local(bool? local = true) => Qs("local", local); - /// Operation timeout for connection to cluster-manager node. + /// The amount of time allowed to establish a connection to the cluster manager node. [Obsolete( "Deprecated as of: 2.0.0, reason: To promote inclusive language, use `cluster_manager_timeout` instead." )] public CatPluginsDescriptor MasterTimeout(Time mastertimeout) => Qs("master_timeout", mastertimeout); - /// Comma-separated list of column names or column aliases to sort by. + /// A comma-separated list of column names or column aliases to sort by. public CatPluginsDescriptor SortByColumns(params string[] sortbycolumns) => Qs("s", sortbycolumns); - /// Verbose mode. Display column headers. + /// Enables verbose mode, which displays column headers. public CatPluginsDescriptor Verbose(bool? verbose = true) => Qs("v", verbose); } @@ -775,26 +775,26 @@ public CatRecoveryDescriptor Index() public CatRecoveryDescriptor ActiveOnly(bool? activeonly = true) => Qs("active_only", activeonly); - /// The unit used to display byte values. + /// The units used to display byte values. public CatRecoveryDescriptor Bytes(ByteUnit? bytes) => Qs("bytes", bytes); - /// If `true`, the response includes detailed information about shard recoveries. + /// When `true`, includes detailed information about shard recoveries. public CatRecoveryDescriptor Detailed(bool? detailed = true) => Qs("detailed", detailed); - /// A short version of the Accept header (for example, `json`, `yaml`). + /// A short version of the `Accept` header, such as `json` or `yaml`. public CatRecoveryDescriptor Format(string format) => Qs("format", format); - /// Comma-separated list of column names to display. + /// A comma-separated list of column names to display. public CatRecoveryDescriptor Headers(params string[] headers) => Qs("h", headers); - /// Return help information. + /// Returns help information. public CatRecoveryDescriptor Help(bool? help = true) => Qs("help", help); - /// Comma-separated list of column names or column aliases to sort by. + /// A comma-separated list of column names or column aliases to sort by. public CatRecoveryDescriptor SortByColumns(params string[] sortbycolumns) => Qs("s", sortbycolumns); - /// Verbose mode. Display column headers. + /// Enables verbose mode, which displays column headers. public CatRecoveryDescriptor Verbose(bool? verbose = true) => Qs("v", verbose); } @@ -811,35 +811,35 @@ public partial class CatRepositoriesDescriptor // values part of the url path // Request parameters - /// Operation timeout for connection to cluster-manager node. + /// The amount of time allowed to establish a connection to the cluster manager node. /// Supported by OpenSearch servers of version 2.0.0 or greater. public CatRepositoriesDescriptor ClusterManagerTimeout(Time clustermanagertimeout) => Qs("cluster_manager_timeout", clustermanagertimeout); - /// A short version of the Accept header (for example, `json`, `yaml`). + /// A short version of the `Accept` header, such as `json` or `yaml`. public CatRepositoriesDescriptor Format(string format) => Qs("format", format); - /// Comma-separated list of column names to display. + /// A comma-separated list of column names to display. public CatRepositoriesDescriptor Headers(params string[] headers) => Qs("h", headers); - /// Return help information. + /// Returns help information. public CatRepositoriesDescriptor Help(bool? help = true) => Qs("help", help); - /// Return local information, do not retrieve the state from cluster-manager node. + /// Returns local information but does not retrieve the state from the cluster manager node. public CatRepositoriesDescriptor Local(bool? local = true) => Qs("local", local); - /// Operation timeout for connection to cluster-manager node. + /// The amount of time allowed to establish a connection to the cluster manager node. [Obsolete( "Deprecated as of: 2.0.0, reason: To promote inclusive language, use `cluster_manager_timeout` instead." )] public CatRepositoriesDescriptor MasterTimeout(Time mastertimeout) => Qs("master_timeout", mastertimeout); - /// Comma-separated list of column names or column aliases to sort by. + /// A comma-separated list of column names or column aliases to sort by. public CatRepositoriesDescriptor SortByColumns(params string[] sortbycolumns) => Qs("s", sortbycolumns); - /// Verbose mode. Display column headers. + /// Enables verbose mode, which displays column headers. public CatRepositoriesDescriptor Verbose(bool? verbose = true) => Qs("v", verbose); } @@ -866,7 +866,7 @@ public CatSegmentReplicationDescriptor(Indices index) // values part of the url path Indices ICatSegmentReplicationRequest.Index => Self.RouteValues.Get("index"); - /// Comma-separated list or wildcard expression of index names to limit the returned information. + /// 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`. public CatSegmentReplicationDescriptor Index(Indices index) => Assign(index, (a, v) => a.RouteValues.Optional("index", v)); @@ -879,58 +879,58 @@ public CatSegmentReplicationDescriptor Index() public CatSegmentReplicationDescriptor AllIndices() => Index(Indices.All); // Request parameters - /// If `true`, the response only includes ongoing segment replication events. + /// When `true`, the response only includes ongoing segment replication events. public CatSegmentReplicationDescriptor ActiveOnly(bool? activeonly = true) => Qs("active_only", activeonly); - /// Whether to ignore if a wildcard indexes expression resolves into no concrete indexes. (This includes `_all` string or when no indexes have been specified). + /// 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. public CatSegmentReplicationDescriptor AllowNoIndices(bool? allownoindices = true) => Qs("allow_no_indices", allownoindices); - /// The unit in which to display byte values. + /// The units used to display byte values. public CatSegmentReplicationDescriptor Bytes(ByteUnit? bytes) => Qs("bytes", bytes); - /// If `true`, the response only includes latest completed segment replication events. + /// When `true`, the response only includes the last-completed segment replication events. public CatSegmentReplicationDescriptor CompletedOnly(bool? completedonly = true) => Qs("completed_only", completedonly); - /// If `true`, the response includes detailed information about segment replications. + /// When `true`, the response includes additional metrics for each stage of a segment replication event. public CatSegmentReplicationDescriptor Detailed(bool? detailed = true) => Qs("detailed", detailed); - /// Whether to expand wildcard expression to concrete indexes that are open, closed or both. + /// TODO public CatSegmentReplicationDescriptor ExpandWildcards(ExpandWildcards? expandwildcards) => Qs("expand_wildcards", expandwildcards); - /// A short version of the Accept header (for example, `json`, `yaml`). + /// A short version of the `Accept` header, such as `json` or `yaml`. public CatSegmentReplicationDescriptor Format(string format) => Qs("format", format); - /// Comma-separated list of column names to display. + /// A comma-separated list of column names to display. public CatSegmentReplicationDescriptor Headers(params string[] headers) => Qs("h", headers); - /// Return help information. + /// Returns help information. public CatSegmentReplicationDescriptor Help(bool? help = true) => Qs("help", help); - /// Whether specified concrete, expanded or aliased indexes should be ignored when throttled. + /// Whether specified concrete, expanded, or aliased indexes should be ignored when throttled. public CatSegmentReplicationDescriptor IgnoreThrottled(bool? ignorethrottled = true) => Qs("ignore_throttled", ignorethrottled); - /// Whether specified concrete indexes should be ignored when unavailable (missing or closed). + /// Whether the specified concrete indexes should be ignored when missing or closed. public CatSegmentReplicationDescriptor IgnoreUnavailable(bool? ignoreunavailable = true) => Qs("ignore_unavailable", ignoreunavailable); - /// Comma-separated list of shards to display. + /// A comma-separated list of shards to display. public CatSegmentReplicationDescriptor Shards(params string[] shards) => Qs("shards", shards); - /// Comma-separated list of column names or column aliases to sort by. + /// A comma-separated list of column names or column aliases to sort by. public CatSegmentReplicationDescriptor SortByColumns(params string[] sortbycolumns) => Qs("s", sortbycolumns); - /// Operation timeout. + /// The operation timeout. public CatSegmentReplicationDescriptor Timeout(Time timeout) => Qs("timeout", timeout); - /// Verbose mode. Display column headers. + /// Enables verbose mode, which displays column headers. public CatSegmentReplicationDescriptor Verbose(bool? verbose = true) => Qs("v", verbose); } @@ -970,35 +970,35 @@ public CatSegmentsDescriptor Index() public CatSegmentsDescriptor AllIndices() => Index(Indices.All); // Request parameters - /// The unit used to display byte values. + /// The units used to display byte values. public CatSegmentsDescriptor Bytes(ByteUnit? bytes) => Qs("bytes", bytes); - /// Operation timeout for connection to cluster-manager node. + /// The amount of time allowed to establish a connection to the cluster manager node. /// Supported by OpenSearch servers of version 2.0.0 or greater. public CatSegmentsDescriptor ClusterManagerTimeout(Time clustermanagertimeout) => Qs("cluster_manager_timeout", clustermanagertimeout); - /// A short version of the Accept header (for example, `json`, `yaml`). + /// A short version of the `Accept` header, such as `json` or `yaml`. public CatSegmentsDescriptor Format(string format) => Qs("format", format); - /// Comma-separated list of column names to display. + /// A comma-separated list of column names to display. public CatSegmentsDescriptor Headers(params string[] headers) => Qs("h", headers); - /// Return help information. + /// Returns help information. public CatSegmentsDescriptor Help(bool? help = true) => Qs("help", help); - /// Operation timeout for connection to cluster-manager node. + /// The amount of time allowed to establish a connection to the cluster manager node. [Obsolete( "Deprecated as of: 2.0.0, reason: To promote inclusive language, use `cluster_manager_timeout` instead." )] public CatSegmentsDescriptor MasterTimeout(Time mastertimeout) => Qs("master_timeout", mastertimeout); - /// Comma-separated list of column names or column aliases to sort by. + /// A comma-separated list of column names or column aliases to sort by. public CatSegmentsDescriptor SortByColumns(params string[] sortbycolumns) => Qs("s", sortbycolumns); - /// Verbose mode. Display column headers. + /// Enables verbose mode, which displays column headers. public CatSegmentsDescriptor Verbose(bool? verbose = true) => Qs("v", verbose); } @@ -1021,7 +1021,7 @@ public CatShardsDescriptor(Indices index) // values part of the url path Indices ICatShardsRequest.Index => Self.RouteValues.Get("index"); - /// 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`. + /// public CatShardsDescriptor Index(Indices index) => Assign(index, (a, v) => a.RouteValues.Optional("index", v)); @@ -1034,38 +1034,38 @@ public CatShardsDescriptor Index() public CatShardsDescriptor AllIndices() => Index(Indices.All); // Request parameters - /// The unit used to display byte values. + /// The units used to display byte values. public CatShardsDescriptor Bytes(ByteUnit? bytes) => Qs("bytes", bytes); - /// Operation timeout for connection to cluster-manager node. + /// The amount of time allowed to establish a connection to the cluster manager node. /// Supported by OpenSearch servers of version 2.0.0 or greater. public CatShardsDescriptor ClusterManagerTimeout(Time clustermanagertimeout) => Qs("cluster_manager_timeout", clustermanagertimeout); - /// A short version of the Accept header (for example, `json`, `yaml`). + /// A short version of the `Accept` header, such as `json` or `yaml`. public CatShardsDescriptor Format(string format) => Qs("format", format); - /// Comma-separated list of column names to display. + /// A comma-separated list of column names to display. public CatShardsDescriptor Headers(params string[] headers) => Qs("h", headers); - /// Return help information. + /// Returns help information. public CatShardsDescriptor Help(bool? help = true) => Qs("help", help); - /// Return local information, do not retrieve the state from cluster-manager node. + /// Returns local information but does not retrieve the state from the cluster manager node. public CatShardsDescriptor Local(bool? local = true) => Qs("local", local); - /// Operation timeout for connection to cluster-manager node. + /// The amount of time allowed to establish a connection to the cluster manager node. [Obsolete( "Deprecated as of: 2.0.0, reason: To promote inclusive language, use `cluster_manager_timeout` instead." )] public CatShardsDescriptor MasterTimeout(Time mastertimeout) => Qs("master_timeout", mastertimeout); - /// Comma-separated list of column names or column aliases to sort by. + /// A comma-separated list of column names or column aliases to sort by. public CatShardsDescriptor SortByColumns(params string[] sortbycolumns) => Qs("s", sortbycolumns); - /// Verbose mode. Display column headers. + /// Enables verbose mode, which displays column headers. public CatShardsDescriptor Verbose(bool? verbose = true) => Qs("v", verbose); } @@ -1097,36 +1097,36 @@ public CatSnapshotsDescriptor RepositoryName(Names repository) => Assign(repository, (a, v) => a.RouteValues.Optional("repository", v)); // Request parameters - /// Operation timeout for connection to cluster-manager node. + /// The amount of time allowed to establish a connection to the cluster manager node. /// Supported by OpenSearch servers of version 2.0.0 or greater. public CatSnapshotsDescriptor ClusterManagerTimeout(Time clustermanagertimeout) => Qs("cluster_manager_timeout", clustermanagertimeout); - /// A short version of the Accept header (for example, `json`, `yaml`). + /// A short version of the `Accept` header, such as `json` or `yaml`. public CatSnapshotsDescriptor Format(string format) => Qs("format", format); - /// Comma-separated list of column names to display. + /// A comma-separated list of column names to display. public CatSnapshotsDescriptor Headers(params string[] headers) => Qs("h", headers); - /// Return help information. + /// Returns help information. public CatSnapshotsDescriptor Help(bool? help = true) => Qs("help", help); - /// If `true`, the response does not include information from unavailable snapshots. + /// When `true`, the response does not include information from unavailable snapshots. public CatSnapshotsDescriptor IgnoreUnavailable(bool? ignoreunavailable = true) => Qs("ignore_unavailable", ignoreunavailable); - /// Operation timeout for connection to cluster-manager node. + /// The amount of time allowed to establish a connection to the cluster manager node. [Obsolete( "Deprecated as of: 2.0.0, reason: To promote inclusive language, use `cluster_manager_timeout` instead." )] public CatSnapshotsDescriptor MasterTimeout(Time mastertimeout) => Qs("master_timeout", mastertimeout); - /// Comma-separated list of column names or column aliases to sort by. + /// A comma-separated list of column names or column aliases to sort by. public CatSnapshotsDescriptor SortByColumns(params string[] sortbycolumns) => Qs("s", sortbycolumns); - /// Verbose mode. Display column headers. + /// Enables verbose mode, which displays column headers. public CatSnapshotsDescriptor Verbose(bool? verbose = true) => Qs("v", verbose); } @@ -1139,33 +1139,33 @@ public partial class CatTasksDescriptor // values part of the url path // Request parameters - /// The task action names, which are used to limit the response. + /// The task action names used to limit the response. public CatTasksDescriptor Actions(params string[] actions) => Qs("actions", actions); /// If `true`, the response includes detailed information about shard recoveries. public CatTasksDescriptor Detailed(bool? detailed = true) => Qs("detailed", detailed); - /// A short version of the Accept header (for example, `json`, `yaml`). + /// A short version of the `Accept` header, such as `json` or `yaml`. public CatTasksDescriptor Format(string format) => Qs("format", format); - /// Comma-separated list of column names to display. + /// A comma-separated list of column names to display. public CatTasksDescriptor Headers(params string[] headers) => Qs("h", headers); - /// Return help information. + /// Returns help information. public CatTasksDescriptor Help(bool? help = true) => Qs("help", help); - /// 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. + /// 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. public CatTasksDescriptor Nodes(params string[] nodes) => Qs("nodes", nodes); /// The parent task identifier, which is used to limit the response. public CatTasksDescriptor ParentTaskId(string parenttaskid) => Qs("parent_task_id", parenttaskid); - /// Comma-separated list of column names or column aliases to sort by. + /// A comma-separated list of column names or column aliases to sort by. public CatTasksDescriptor SortByColumns(params string[] sortbycolumns) => Qs("s", sortbycolumns); - /// Verbose mode. Display column headers. + /// Enables verbose mode, which displays column headers. public CatTasksDescriptor Verbose(bool? verbose = true) => Qs("v", verbose); } @@ -1197,35 +1197,35 @@ public CatTemplatesDescriptor Name(Name name) => Assign(name, (a, v) => a.RouteValues.Optional("name", v)); // Request parameters - /// Operation timeout for connection to cluster-manager node. + /// The amount of time allowed to establish a connection to the cluster manager node. /// Supported by OpenSearch servers of version 2.0.0 or greater. public CatTemplatesDescriptor ClusterManagerTimeout(Time clustermanagertimeout) => Qs("cluster_manager_timeout", clustermanagertimeout); - /// A short version of the Accept header (for example, `json`, `yaml`). + /// A short version of the `Accept` header, such as `json` or `yaml`. public CatTemplatesDescriptor Format(string format) => Qs("format", format); - /// Comma-separated list of column names to display. + /// A comma-separated list of column names to display. public CatTemplatesDescriptor Headers(params string[] headers) => Qs("h", headers); - /// Return help information. + /// Returns help information. public CatTemplatesDescriptor Help(bool? help = true) => Qs("help", help); - /// Return local information, do not retrieve the state from cluster-manager node. + /// Returns local information but does not retrieve the state from the cluster manager node. public CatTemplatesDescriptor Local(bool? local = true) => Qs("local", local); - /// Operation timeout for connection to cluster-manager node. + /// The amount of time allowed to establish a connection to the cluster manager node. [Obsolete( "Deprecated as of: 2.0.0, reason: To promote inclusive language, use `cluster_manager_timeout` instead." )] public CatTemplatesDescriptor MasterTimeout(Time mastertimeout) => Qs("master_timeout", mastertimeout); - /// Comma-separated list of column names or column aliases to sort by. + /// A comma-separated list of column names or column aliases to sort by. public CatTemplatesDescriptor SortByColumns(params string[] sortbycolumns) => Qs("s", sortbycolumns); - /// Verbose mode. Display column headers. + /// Enables verbose mode, which displays column headers. public CatTemplatesDescriptor Verbose(bool? verbose = true) => Qs("v", verbose); } @@ -1258,24 +1258,24 @@ public CatThreadPoolDescriptor ThreadPoolPatterns(Names threadPoolPatterns) => Assign(threadPoolPatterns, (a, v) => a.RouteValues.Optional("thread_pool_patterns", v)); // Request parameters - /// Operation timeout for connection to cluster-manager node. + /// A timeout for connection to the cluster manager node. /// Supported by OpenSearch servers of version 2.0.0 or greater. public CatThreadPoolDescriptor ClusterManagerTimeout(Time clustermanagertimeout) => Qs("cluster_manager_timeout", clustermanagertimeout); - /// A short version of the Accept header (for example, `json`, `yaml`). + /// A short version of the `Accept` header, such as `json` or `yaml`. public CatThreadPoolDescriptor Format(string format) => Qs("format", format); - /// Comma-separated list of column names to display. + /// A comma-separated list of column names to display. public CatThreadPoolDescriptor Headers(params string[] headers) => Qs("h", headers); - /// Return help information. + /// Returns help information. public CatThreadPoolDescriptor Help(bool? help = true) => Qs("help", help); - /// Return local information, do not retrieve the state from cluster-manager node. + /// Returns local information but does not retrieve the state from the cluster manager node. public CatThreadPoolDescriptor Local(bool? local = true) => Qs("local", local); - /// Operation timeout for connection to cluster-manager node. + /// The amount of time allowed to establish a connection to the cluster manager node. [Obsolete( "Deprecated as of: 2.0.0, reason: To promote inclusive language, use `cluster_manager_timeout` instead." )] @@ -1285,11 +1285,11 @@ public CatThreadPoolDescriptor MasterTimeout(Time mastertimeout) => /// The multiplier in which to display values. public CatThreadPoolDescriptor Size(long? size) => Qs("size", size); - /// Comma-separated list of column names or column aliases to sort by. + /// A comma-separated list of column names or column aliases to sort by. public CatThreadPoolDescriptor SortByColumns(params string[] sortbycolumns) => Qs("s", sortbycolumns); - /// Verbose mode. Display column headers. + /// Enables verbose mode, which displays column headers. public CatThreadPoolDescriptor Verbose(bool? verbose = true) => Qs("v", verbose); } } diff --git a/src/OpenSearch.Client/_Generated/Descriptors.Cluster.cs b/src/OpenSearch.Client/_Generated/Descriptors.Cluster.cs index 037774c1e9..109e217e46 100644 --- a/src/OpenSearch.Client/_Generated/Descriptors.Cluster.cs +++ b/src/OpenSearch.Client/_Generated/Descriptors.Cluster.cs @@ -70,11 +70,11 @@ public partial class ClusterAllocationExplainDescriptor // values part of the url path // Request parameters - /// If `true`, returns information about disk usage and shard sizes. + /// When `true`, returns information about disk usage and shard sizes. public ClusterAllocationExplainDescriptor IncludeDiskInfo(bool? includediskinfo = true) => Qs("include_disk_info", includediskinfo); - /// If `true`, returns YES decisions in explanation. + /// When `true`, returns any `YES` decisions in the allocation explanation. public ClusterAllocationExplainDescriptor IncludeYesDecisions( bool? includeyesdecisions = true ) => Qs("include_yes_decisions", includeyesdecisions); @@ -111,14 +111,14 @@ public DeleteComponentTemplateDescriptor ClusterManagerTimeout( Time clustermanagertimeout ) => Qs("cluster_manager_timeout", clustermanagertimeout); - /// 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. + /// TODO [Obsolete( "Deprecated as of: 2.0.0, reason: To promote inclusive language, use `cluster_manager_timeout` instead." )] public DeleteComponentTemplateDescriptor MasterTimeout(Time mastertimeout) => Qs("master_timeout", mastertimeout); - /// Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. + /// TODO public DeleteComponentTemplateDescriptor Timeout(Time timeout) => Qs("timeout", timeout); } @@ -135,7 +135,7 @@ public partial class DeleteVotingConfigExclusionsDescriptor // values part of the url path // Request parameters - /// 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 voting configuration exclusions list is cleared even if some excluded nodes are still in the cluster. + /// Specifies whether to wait for all excluded nodes to be removed from the cluster before clearing the voting configuration exclusions list. 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. public DeleteVotingConfigExclusionsDescriptor WaitForRemoval(bool? waitforremoval = true) => Qs("wait_for_removal", waitforremoval); } @@ -165,16 +165,16 @@ protected ComponentTemplateExistsDescriptor() Name IComponentTemplateExistsRequest.Name => Self.RouteValues.Get("name"); // Request parameters - /// Operation timeout for connection to cluster-manager node. + /// TODO /// Supported by OpenSearch servers of version 2.0.0 or greater. public ComponentTemplateExistsDescriptor ClusterManagerTimeout( Time clustermanagertimeout ) => Qs("cluster_manager_timeout", clustermanagertimeout); - /// If `true`, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the cluster-manager node. + /// When `true`, the request retrieves information from the local node only. When `false, information is retrieved from the cluster manager node. public ComponentTemplateExistsDescriptor Local(bool? local = true) => Qs("local", local); - /// 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. + /// TODO [Obsolete( "Deprecated as of: 2.0.0, reason: To promote inclusive language, use `cluster_manager_timeout` instead." )] @@ -205,20 +205,24 @@ public GetComponentTemplateDescriptor(Name name) // values part of the url path Name IGetComponentTemplateRequest.Name => Self.RouteValues.Get("name"); - /// Name of the component template to retrieve. Wildcard (`*`) expressions are supported. + /// The name of the component template to retrieve. Wildcard (`*`) expressions are supported. public GetComponentTemplateDescriptor Name(Name name) => Assign(name, (a, v) => a.RouteValues.Optional("name", v)); // Request parameters - /// Operation timeout for connection to cluster-manager node. + /// TODO /// Supported by OpenSearch servers of version 2.0.0 or greater. public GetComponentTemplateDescriptor ClusterManagerTimeout(Time clustermanagertimeout) => Qs("cluster_manager_timeout", clustermanagertimeout); - /// If `true`, the request retrieves information from the local node only. If `false`, information is retrieved from the cluster-manager node. + /// If `true`, returns settings in flat format. + public GetComponentTemplateDescriptor FlatSettings(bool? flatsettings = true) => + Qs("flat_settings", flatsettings); + + /// When `true`, the request retrieves information from the local node only. When `false`, information is retrieved from the cluster manager node. public GetComponentTemplateDescriptor Local(bool? local = true) => Qs("local", local); - /// 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. + /// TODO [Obsolete( "Deprecated as of: 2.0.0, reason: To promote inclusive language, use `cluster_manager_timeout` instead." )] @@ -239,27 +243,27 @@ public partial class ClusterGetSettingsDescriptor // values part of the url path // Request parameters - /// Operation timeout for connection to cluster-manager node. + /// TODO /// Supported by OpenSearch servers of version 2.0.0 or greater. public ClusterGetSettingsDescriptor ClusterManagerTimeout(Time clustermanagertimeout) => Qs("cluster_manager_timeout", clustermanagertimeout); - /// If `true`, returns settings in flat format. + /// When `true`, returns cluster settings in a flat format. public ClusterGetSettingsDescriptor FlatSettings(bool? flatsettings = true) => Qs("flat_settings", flatsettings); - /// If `true`, returns default cluster settings from the local node. + /// When `true`, returns default cluster settings from the local node. public ClusterGetSettingsDescriptor IncludeDefaults(bool? includedefaults = true) => Qs("include_defaults", includedefaults); - /// 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. + /// TODO [Obsolete( "Deprecated as of: 2.0.0, reason: To promote inclusive language, use `cluster_manager_timeout` instead." )] public ClusterGetSettingsDescriptor MasterTimeout(Time mastertimeout) => Qs("master_timeout", mastertimeout); - /// Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. + /// TODO public ClusterGetSettingsDescriptor Timeout(Time timeout) => Qs("timeout", timeout); } @@ -286,7 +290,7 @@ public ClusterHealthDescriptor(Indices index) // values part of the url path Indices IClusterHealthRequest.Index => Self.RouteValues.Get("index"); - /// 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 `*`. + /// public ClusterHealthDescriptor Index(Indices index) => Assign(index, (a, v) => a.RouteValues.Optional("index", v)); @@ -299,58 +303,58 @@ public ClusterHealthDescriptor Index() public ClusterHealthDescriptor AllIndices() => Index(Indices.All); // Request parameters - /// The awareness attribute for which the health is required. + /// 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`. public ClusterHealthDescriptor AwarenessAttribute(string awarenessattribute) => Qs("awareness_attribute", awarenessattribute); - /// Operation timeout for connection to cluster-manager node. + /// TODO /// Supported by OpenSearch servers of version 2.0.0 or greater. public ClusterHealthDescriptor ClusterManagerTimeout(Time clustermanagertimeout) => Qs("cluster_manager_timeout", clustermanagertimeout); - /// Whether to expand wildcard expression to concrete indexes that are open, closed or both. + /// TODO public ClusterHealthDescriptor ExpandWildcards(ExpandWildcards? expandwildcards) => Qs("expand_wildcards", expandwildcards); - /// Can be one of cluster, indexes or shards. Controls the details level of the health information returned. + /// TODO public ClusterHealthDescriptor Level(ClusterHealthLevel? level) => Qs("level", level); - /// If `true`, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the cluster-manager node. + /// Whether to return information from the local node only instead of from the cluster manager node. public ClusterHealthDescriptor Local(bool? local = true) => Qs("local", local); - /// 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. + /// TODO [Obsolete( "Deprecated as of: 2.0.0, reason: To promote inclusive language, use `cluster_manager_timeout` instead." )] public ClusterHealthDescriptor MasterTimeout(Time mastertimeout) => Qs("master_timeout", mastertimeout); - /// Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. + /// TODO public ClusterHealthDescriptor Timeout(Time timeout) => Qs("timeout", timeout); - /// 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. + /// TODO public ClusterHealthDescriptor WaitForActiveShards(string waitforactiveshards) => Qs("wait_for_active_shards", waitforactiveshards); - /// Can be one of immediate, urgent, high, normal, low, languid. Wait until all currently queued events with the given priority are processed. + /// TODO public ClusterHealthDescriptor WaitForEvents(WaitForEvents? waitforevents) => Qs("wait_for_events", waitforevents); - /// The request waits until the specified number N of nodes is available. It also accepts >=N, <=N, >N and <N. Alternatively, it is possible to use ge(N), le(N), gt(N) and lt(N) notation. + /// Waits until the specified number of nodes (`N`) is available. Accepts `>=N`, `<=N`, `>N`, and `<N`. You can also use `ge(N)`, `le(N)`, `gt(N)`, and `lt(N)` notation. public ClusterHealthDescriptor WaitForNodes(string waitfornodes) => Qs("wait_for_nodes", waitfornodes); - /// 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. + /// Whether to wait until there are no initializing shards in the cluster. public ClusterHealthDescriptor WaitForNoInitializingShards( bool? waitfornoinitializingshards = true ) => Qs("wait_for_no_initializing_shards", waitfornoinitializingshards); - /// 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. + /// Whether to wait until there are no relocating shards in the cluster. public ClusterHealthDescriptor WaitForNoRelocatingShards( bool? waitfornorelocatingshards = true ) => Qs("wait_for_no_relocating_shards", waitfornorelocatingshards); - /// One of green, yellow or red. Will wait (until the timeout provided) until the status of the cluster changes to the one provided or better, i.e. green > yellow > red. By default, will not wait for any status. + /// Waits until the cluster health reaches the specified status or better. public ClusterHealthDescriptor WaitForStatus(HealthStatus? waitforstatus) => Qs("wait_for_status", waitforstatus); } @@ -368,15 +372,15 @@ public partial class ClusterPendingTasksDescriptor // values part of the url path // Request parameters - /// Operation timeout for connection to cluster-manager node. + /// TODO /// Supported by OpenSearch servers of version 2.0.0 or greater. public ClusterPendingTasksDescriptor ClusterManagerTimeout(Time clustermanagertimeout) => Qs("cluster_manager_timeout", clustermanagertimeout); - /// If `true`, the request retrieves information from the local node only. If `false`, information is retrieved from the cluster-manager node. + /// When `true`, the request retrieves information from the local node only. When `false`, information is retrieved from the cluster manager node. public ClusterPendingTasksDescriptor Local(bool? local = true) => Qs("local", local); - /// 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. + /// TODO [Obsolete( "Deprecated as of: 2.0.0, reason: To promote inclusive language, use `cluster_manager_timeout` instead." )] @@ -397,15 +401,15 @@ public partial class PostVotingConfigExclusionsDescriptor // values part of the url path // Request parameters - /// 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`. public PostVotingConfigExclusionsDescriptor NodeIds(params string[] nodeids) => Qs("node_ids", nodeids); - /// 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`. public PostVotingConfigExclusionsDescriptor NodeNames(params string[] nodenames) => Qs("node_names", nodenames); - /// 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 is satisfied, the request fails and returns an error. + /// When adding a voting configuration exclusion, the API waits for the specified nodes to be excluded from the voting configuration before returning a response. If the timeout expires before the appropriate condition is satisfied, the request fails and returns an error. public PostVotingConfigExclusionsDescriptor Timeout(Time timeout) => Qs("timeout", timeout); } @@ -434,22 +438,22 @@ protected PutComponentTemplateDescriptor() Name IPutComponentTemplateRequest.Name => Self.RouteValues.Get("name"); // Request parameters - /// Operation timeout for connection to cluster-manager node. + /// TODO /// Supported by OpenSearch servers of version 2.0.0 or greater. public PutComponentTemplateDescriptor ClusterManagerTimeout(Time clustermanagertimeout) => Qs("cluster_manager_timeout", clustermanagertimeout); - /// If `true`, this request cannot replace or update existing component templates. + /// When `true`, this request cannot replace or update existing component templates. public PutComponentTemplateDescriptor Create(bool? create = true) => Qs("create", create); - /// 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. + /// TODO [Obsolete( "Deprecated as of: 2.0.0, reason: To promote inclusive language, use `cluster_manager_timeout` instead." )] public PutComponentTemplateDescriptor MasterTimeout(Time mastertimeout) => Qs("master_timeout", mastertimeout); - /// Operation timeout. + /// TODO public PutComponentTemplateDescriptor Timeout(Time timeout) => Qs("timeout", timeout); } @@ -466,23 +470,23 @@ public partial class ClusterPutSettingsDescriptor // values part of the url path // Request parameters - /// Operation timeout for connection to cluster-manager node. + /// TODO /// Supported by OpenSearch servers of version 2.0.0 or greater. public ClusterPutSettingsDescriptor ClusterManagerTimeout(Time clustermanagertimeout) => Qs("cluster_manager_timeout", clustermanagertimeout); - /// Return settings in flat format. + /// Returns settings in a flat format. public ClusterPutSettingsDescriptor FlatSettings(bool? flatsettings = true) => Qs("flat_settings", flatsettings); - /// Explicit operation timeout for connection to cluster-manager node. + /// TODO [Obsolete( "Deprecated as of: 2.0.0, reason: To promote inclusive language, use `cluster_manager_timeout` instead." )] public ClusterPutSettingsDescriptor MasterTimeout(Time mastertimeout) => Qs("master_timeout", mastertimeout); - /// Explicit operation timeout. + /// TODO public ClusterPutSettingsDescriptor Timeout(Time timeout) => Qs("timeout", timeout); } @@ -513,18 +517,18 @@ public partial class ClusterRerouteDescriptor // values part of the url path // Request parameters - /// Operation timeout for connection to cluster-manager node. + /// TODO /// Supported by OpenSearch servers of version 2.0.0 or greater. public ClusterRerouteDescriptor ClusterManagerTimeout(Time clustermanagertimeout) => Qs("cluster_manager_timeout", clustermanagertimeout); - /// If `true`, then the request simulates the operation only and returns the resulting state. + /// When `true`, the request simulates the operation and returns the resulting state. public ClusterRerouteDescriptor DryRun(bool? dryrun = true) => Qs("dry_run", dryrun); - /// If `true`, then the response contains an explanation of why the commands can or cannot be executed. + /// When `true`, the response contains an explanation of why certain commands can or cannot be executed. public ClusterRerouteDescriptor Explain(bool? explain = true) => Qs("explain", explain); - /// 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. + /// TODO [Obsolete( "Deprecated as of: 2.0.0, reason: To promote inclusive language, use `cluster_manager_timeout` instead." )] @@ -535,11 +539,11 @@ public ClusterRerouteDescriptor MasterTimeout(Time mastertimeout) => public ClusterRerouteDescriptor Metric(ClusterRerouteMetric? metric) => Qs("metric", metric); - /// If `true`, then retries allocation of shards that are blocked due to too many subsequent allocation failures. + /// When `true`, retries shard allocation if it was blocked because of too many subsequent failures. public ClusterRerouteDescriptor RetryFailed(bool? retryfailed = true) => Qs("retry_failed", retryfailed); - /// Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. + /// TODO public ClusterRerouteDescriptor Timeout(Time timeout) => Qs("timeout", timeout); } @@ -573,7 +577,7 @@ public ClusterStateDescriptor(Metrics metric, Indices index) Indices IClusterStateRequest.Index => Self.RouteValues.Get("index"); Metrics IClusterStateRequest.Metric => Self.RouteValues.Get("metric"); - /// A comma-separated list of index names; use the special string `_all` or Indices.All to perform the operation on all indexes. + /// public ClusterStateDescriptor Index(Indices index) => Assign(index, (a, v) => a.RouteValues.Optional("index", v)); @@ -585,36 +589,36 @@ public ClusterStateDescriptor Index() /// A shortcut into calling Index(Indices.All) public ClusterStateDescriptor AllIndices() => Index(Indices.All); - /// Limit the information returned to the specified metrics. + /// Limits the information returned to only the specified metrics. public ClusterStateDescriptor Metric(Metrics metric) => Assign(metric, (a, v) => a.RouteValues.Optional("metric", v)); // Request parameters - /// Whether to ignore if a wildcard indexes expression resolves into no concrete indexes. (This includes `_all` string or when no indexes have been specified). + /// 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. public ClusterStateDescriptor AllowNoIndices(bool? allownoindices = true) => Qs("allow_no_indices", allownoindices); - /// Operation timeout for connection to cluster-manager node. + /// TODO /// Supported by OpenSearch servers of version 2.0.0 or greater. public ClusterStateDescriptor ClusterManagerTimeout(Time clustermanagertimeout) => Qs("cluster_manager_timeout", clustermanagertimeout); - /// Whether to expand wildcard expression to concrete indexes that are open, closed or both. + /// TODO public ClusterStateDescriptor ExpandWildcards(ExpandWildcards? expandwildcards) => Qs("expand_wildcards", expandwildcards); - /// Return settings in flat format. + /// Returns settings in a flat format. public ClusterStateDescriptor FlatSettings(bool? flatsettings = true) => Qs("flat_settings", flatsettings); - /// Whether specified concrete indexes should be ignored when unavailable (missing or closed). + /// Whether the specified concrete indexes should be ignored when unavailable (missing or closed). public ClusterStateDescriptor IgnoreUnavailable(bool? ignoreunavailable = true) => Qs("ignore_unavailable", ignoreunavailable); - /// Return local information, do not retrieve the state from cluster-manager node. + /// Whether to return information from the local node only instead of from the cluster manager node. public ClusterStateDescriptor Local(bool? local = true) => Qs("local", local); - /// Specify timeout for connection to cluster manager. + /// TODO [Obsolete( "Deprecated as of: 2.0.0, reason: To promote inclusive language, use `cluster_manager_timeout` instead." )] @@ -673,7 +677,7 @@ public ClusterStatsDescriptor(NodeIds nodeId) Metrics IClusterStatsRequest.Metric => Self.RouteValues.Get("metric"); NodeIds IClusterStatsRequest.NodeId => Self.RouteValues.Get("node_id"); - /// Limit the information returned for indexes metric to the specific index metrics. It can be used only if indexes (or all) metric is specified. + /// A comma-separated list of index metric groups, for example, `docs,store`. public ClusterStatsDescriptor IndexMetric(IndexMetrics indexMetric) => Assign(indexMetric, (a, v) => a.RouteValues.Optional("index_metric", v)); @@ -681,16 +685,16 @@ public ClusterStatsDescriptor IndexMetric(IndexMetrics indexMetric) => public ClusterStatsDescriptor Metric(Metrics metric) => Assign(metric, (a, v) => a.RouteValues.Optional("metric", v)); - /// Comma-separated list of node filters used to limit returned information. Defaults to all nodes in the cluster. + /// public ClusterStatsDescriptor NodeId(NodeIds nodeId) => Assign(nodeId, (a, v) => a.RouteValues.Optional("node_id", v)); // Request parameters - /// If `true`, returns settings in flat format. + /// When `true`, returns settings in a flat format. public ClusterStatsDescriptor FlatSettings(bool? flatsettings = true) => Qs("flat_settings", flatsettings); - /// Period to wait for each node to respond. If a node does not respond before its timeout expires, the response does not include its stats. However, timed out nodes are included in the response's `_nodes.failed` property. Defaults to no timeout. + /// 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. public ClusterStatsDescriptor Timeout(Time timeout) => Qs("timeout", timeout); } } diff --git a/src/OpenSearch.Client/_Generated/Descriptors.NoNamespace.cs b/src/OpenSearch.Client/_Generated/Descriptors.NoNamespace.cs index 040206197b..30cc86fe09 100644 --- a/src/OpenSearch.Client/_Generated/Descriptors.NoNamespace.cs +++ b/src/OpenSearch.Client/_Generated/Descriptors.NoNamespace.cs @@ -203,7 +203,7 @@ public CountDescriptor DefaultOperator(DefaultOperator? defaultoperat /// Field to use as default where no field prefix is given in the query string. This parameter can only be used when the `q` query string parameter is specified. public CountDescriptor Df(string df) => Qs("df", df); - /// 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`. + /// TODO public CountDescriptor ExpandWildcards(ExpandWildcards? expandwildcards) => Qs("expand_wildcards", expandwildcards); @@ -1840,6 +1840,10 @@ public partial class ReindexOnServerDescriptor public ReindexOnServerDescriptor RequestsPerSecond(long? requestspersecond) => Qs("requests_per_second", requestspersecond); + /// TODO + public ReindexOnServerDescriptor RequireAlias(bool? requirealias = true) => + Qs("require_alias", requirealias); + /// Specifies how long a consistent view of the index should be maintained for scrolled search. public ReindexOnServerDescriptor Scroll(Time scroll) => Qs("scroll", scroll); diff --git a/src/OpenSearch.Client/_Generated/Requests.Cat.cs b/src/OpenSearch.Client/_Generated/Requests.Cat.cs index 31500a099d..1836018f5a 100644 --- a/src/OpenSearch.Client/_Generated/Requests.Cat.cs +++ b/src/OpenSearch.Client/_Generated/Requests.Cat.cs @@ -87,14 +87,14 @@ public CatAliasesRequest(Names name) Names ICatAliasesRequest.Name => Self.RouteValues.Get("name"); // Request parameters - /// Whether to expand wildcard expression to concrete indexes that are open, closed or both. + /// TODO public ExpandWildcards? ExpandWildcards { get => Q("expand_wildcards"); set => Q("expand_wildcards", value); } - /// A short version of the Accept header (for example, `json`, `yaml`). + /// A short version of the `Accept` header, such as `json` or `yaml`. public string Format { get => Q("format"); @@ -105,35 +105,35 @@ public string Format } } - /// Comma-separated list of column names to display. + /// A comma-separated list of column names to display. public string[] Headers { get => Q("h"); set => Q("h", value); } - /// Return help information. + /// Returns help information. public bool? Help { get => Q("help"); set => Q("help", value); } - /// Return local information, do not retrieve the state from cluster-manager node. + /// Whether to return information from the local node only instead of from the cluster manager node. public bool? Local { get => Q("local"); set => Q("local", value); } - /// Comma-separated list of column names or column aliases to sort by. + /// A comma-separated list of column names or column aliases to sort by. public string[] SortByColumns { get => Q("s"); set => Q("s", value); } - /// Verbose mode. Display column headers. + /// Enables verbose mode, which displays column headers. public bool? Verbose { get => Q("v"); @@ -156,14 +156,14 @@ public partial class CatAllPitSegmentsRequest // values part of the url path // Request parameters - /// The unit in which to display byte values. + /// The units used to display byte values. public ByteUnit? Bytes { get => Q("bytes"); set => Q("bytes", value); } - /// A short version of the Accept header (for example, `json`, `yaml`). + /// A short version of the `Accept` header, such as `json` or `yaml`. public string Format { get => Q("format"); @@ -174,28 +174,28 @@ public string Format } } - /// Comma-separated list of column names to display. + /// A comma-separated list of column names to display. public string[] Headers { get => Q("h"); set => Q("h", value); } - /// Return help information. + /// Returns help information. public bool? Help { get => Q("help"); set => Q("help", value); } - /// Comma-separated list of column names or column aliases to sort by. + /// A comma-separated list of column names or column aliases to sort by. public string[] SortByColumns { get => Q("s"); set => Q("s", value); } - /// Verbose mode. Display column headers. + /// Enables verbose mode, which displays column headers. public bool? Verbose { get => Q("v"); @@ -232,14 +232,14 @@ public CatAllocationRequest(NodeIds nodeId) NodeIds ICatAllocationRequest.NodeId => Self.RouteValues.Get("node_id"); // Request parameters - /// The unit used to display byte values. + /// The units used to display byte values. public ByteUnit? Bytes { get => Q("bytes"); set => Q("bytes", value); } - /// Operation timeout for connection to cluster-manager node. + /// A timeout for connection to the cluster manager node. /// Supported by OpenSearch servers of version 2.0.0 or greater. public Time ClusterManagerTimeout { @@ -247,7 +247,7 @@ public Time ClusterManagerTimeout set => Q("cluster_manager_timeout", value); } - /// A short version of the Accept header (for example, `json`, `yaml`). + /// A short version of the HTTP `Accept` header, such as `json` or `yaml`. public string Format { get => Q("format"); @@ -258,28 +258,28 @@ public string Format } } - /// Comma-separated list of column names to display. + /// A comma-separated list of column names to display. public string[] Headers { get => Q("h"); set => Q("h", value); } - /// Return help information. + /// Returns help information. public bool? Help { get => Q("help"); set => Q("help", value); } - /// Return local information, do not retrieve the state from cluster-manager node. + /// Returns local information but does not retrieve the state from cluster-manager node. public bool? Local { get => Q("local"); set => Q("local", value); } - /// Operation timeout for connection to cluster-manager node. + /// A timeout for connection to the cluster manager node. [Obsolete( "Deprecated as of: 2.0.0, reason: To promote inclusive language, use `cluster_manager_timeout` instead." )] @@ -289,14 +289,14 @@ public Time MasterTimeout set => Q("master_timeout", value); } - /// Comma-separated list of column names or column aliases to sort by. + /// A comma-separated list of column names or column aliases to sort by. public string[] SortByColumns { get => Q("s"); set => Q("s", value); } - /// Verbose mode. Display column headers. + /// Enables verbose mode, which displays column headers. public bool? Verbose { get => Q("v"); @@ -319,7 +319,7 @@ public partial class CatClusterManagerRequest // values part of the url path // Request parameters - /// Operation timeout for connection to cluster-manager node. + /// A timeout for connection to the cluster manager node. /// Supported by OpenSearch servers of version 2.0.0 or greater. public Time ClusterManagerTimeout { @@ -327,7 +327,7 @@ public Time ClusterManagerTimeout set => Q("cluster_manager_timeout", value); } - /// A short version of the Accept header (for example, `json`, `yaml`). + /// A short version of the HTTP `Accept` header, such as `json` or `yaml`. public string Format { get => Q("format"); @@ -338,28 +338,28 @@ public string Format } } - /// Comma-separated list of column names to display. + /// A comma-separated list of column names to display. public string[] Headers { get => Q("h"); set => Q("h", value); } - /// Return help information. + /// Returns help information. public bool? Help { get => Q("help"); set => Q("help", value); } - /// Return local information, do not retrieve the state from cluster-manager node. + /// Returns local information but does not retrieve the state from the cluster manager node. public bool? Local { get => Q("local"); set => Q("local", value); } - /// Operation timeout for connection to cluster-manager node. + /// A timeout for connection to the cluster manager node. [Obsolete( "Deprecated as of: 2.0.0, reason: To promote inclusive language, use `cluster_manager_timeout` instead." )] @@ -369,14 +369,14 @@ public Time MasterTimeout set => Q("master_timeout", value); } - /// Comma-separated list of column names or column aliases to sort by. + /// A comma-separated list of column names or column aliases to sort by. public string[] SortByColumns { get => Q("s"); set => Q("s", value); } - /// Verbose mode. Display column headers. + /// Enables verbose mode, which displays column headers. public bool? Verbose { get => Q("v"); @@ -413,7 +413,7 @@ public CatCountRequest(Indices index) Indices ICatCountRequest.Index => Self.RouteValues.Get("index"); // Request parameters - /// A short version of the Accept header (for example, `json`, `yaml`). + /// A short version of the `Accept` header, such as `json` or `yaml`. public string Format { get => Q("format"); @@ -424,28 +424,28 @@ public string Format } } - /// Comma-separated list of column names to display. + /// A comma-separated list of column names to display. public string[] Headers { get => Q("h"); set => Q("h", value); } - /// Return help information. + /// Returns help information. public bool? Help { get => Q("help"); set => Q("help", value); } - /// Comma-separated list of column names or column aliases to sort by. + /// A comma-separated list of column names or column aliases to sort by. public string[] SortByColumns { get => Q("s"); set => Q("s", value); } - /// Verbose mode. Display column headers. + /// Enables verbose mode, which displays column headers. public bool? Verbose { get => Q("v"); @@ -482,14 +482,14 @@ public CatFielddataRequest(Fields fields) Fields ICatFielddataRequest.Fields => Self.RouteValues.Get("fields"); // Request parameters - /// The unit used to display byte values. + /// The units used to display byte values. public ByteUnit? Bytes { get => Q("bytes"); set => Q("bytes", value); } - /// A short version of the Accept header (for example, `json`, `yaml`). + /// A short version of the `Accept` header, such as `json` or `yaml`. public string Format { get => Q("format"); @@ -500,28 +500,28 @@ public string Format } } - /// Comma-separated list of column names to display. + /// A comma-separated list of column names to display. public string[] Headers { get => Q("h"); set => Q("h", value); } - /// Return help information. + /// Returns help information. public bool? Help { get => Q("help"); set => Q("help", value); } - /// Comma-separated list of column names or column aliases to sort by. + /// A comma-separated list of column names or column aliases to sort by. public string[] SortByColumns { get => Q("s"); set => Q("s", value); } - /// Verbose mode. Display column headers. + /// Enables verbose mode, which displays column headers. public bool? Verbose { get => Q("v"); @@ -543,7 +543,7 @@ public partial class CatHealthRequest // values part of the url path // Request parameters - /// A short version of the Accept header (for example, `json`, `yaml`). + /// A short version of the `Accept` header, such as `json` or `yaml`. public string Format { get => Q("format"); @@ -554,35 +554,35 @@ public string Format } } - /// Comma-separated list of column names to display. + /// A comma-separated list of column names to display. public string[] Headers { get => Q("h"); set => Q("h", value); } - /// Return help information. + /// Returns help information. public bool? Help { get => Q("help"); set => Q("help", value); } - /// If `true`, returns `HH:MM:SS` and Unix epoch timestamps. + /// When `true`, returns `HH:MM:SS` and Unix epoch timestamps. public bool? IncludeTimestamp { get => Q("ts"); set => Q("ts", value); } - /// Comma-separated list of column names or column aliases to sort by. + /// A comma-separated list of column names or column aliases to sort by. public string[] SortByColumns { get => Q("s"); set => Q("s", value); } - /// Verbose mode. Display column headers. + /// Enables verbose mode, which displays column headers. public bool? Verbose { get => Q("v"); @@ -634,14 +634,14 @@ public CatIndicesRequest(Indices index) Indices ICatIndicesRequest.Index => Self.RouteValues.Get("index"); // Request parameters - /// The unit used to display byte values. + /// The units used to display byte values. public ByteUnit? Bytes { get => Q("bytes"); set => Q("bytes", value); } - /// Operation timeout for connection to cluster-manager node. + /// The amount of time allowed to establish a connection to the cluster manager node. /// Supported by OpenSearch servers of version 2.0.0 or greater. public Time ClusterManagerTimeout { @@ -649,14 +649,14 @@ public Time ClusterManagerTimeout set => Q("cluster_manager_timeout", value); } - /// The type of index that wildcard patterns can match. + /// TODO public ExpandWildcards? ExpandWildcards { get => Q("expand_wildcards"); set => Q("expand_wildcards", value); } - /// A short version of the Accept header (for example, `json`, `yaml`). + /// A short version of the `Accept` header, such as `json` or `yaml`. public string Format { get => Q("format"); @@ -667,42 +667,42 @@ public string Format } } - /// Comma-separated list of column names to display. + /// A comma-separated list of column names to display. public string[] Headers { get => Q("h"); set => Q("h", value); } - /// The health status used to limit returned indexes. By default, the response includes indexes of any health status. + /// Limits indexes based on their health status. Supported values are `green`, `yellow`, and `red`. public HealthStatus? Health { get => Q("health"); set => Q("health", value); } - /// Return help information. + /// Returns help information. public bool? Help { get => Q("help"); set => Q("help", value); } - /// If `true`, the response includes information from segments that are not loaded into memory. + /// Whether to include information from segments not loaded into memory. public bool? IncludeUnloadedSegments { get => Q("include_unloaded_segments"); set => Q("include_unloaded_segments", value); } - /// Return local information, do not retrieve the state from cluster-manager node. + /// Returns local information but does not retrieve the state from the cluster manager node. public bool? Local { get => Q("local"); set => Q("local", value); } - /// Operation timeout for connection to cluster-manager node. + /// The amount of time allowed to establish a connection to the cluster manager node. [Obsolete( "Deprecated as of: 2.0.0, reason: To promote inclusive language, use `cluster_manager_timeout` instead." )] @@ -712,21 +712,21 @@ public Time MasterTimeout set => Q("master_timeout", value); } - /// If `true`, the response only includes information from primary shards. + /// When `true`, returns information only from the primary shards. public bool? Pri { get => Q("pri"); set => Q("pri", value); } - /// Comma-separated list of column names or column aliases to sort by. + /// A comma-separated list of column names or column aliases to sort by. public string[] SortByColumns { get => Q("s"); set => Q("s", value); } - /// Verbose mode. Display column headers. + /// Enables verbose mode, which displays column headers. public bool? Verbose { get => Q("v"); @@ -748,7 +748,7 @@ public partial class CatMasterRequest // values part of the url path // Request parameters - /// Operation timeout for connection to cluster-manager node. + /// The amount of time allowed to establish a connection to the cluster manager node. /// Supported by OpenSearch servers of version 2.0.0 or greater. public Time ClusterManagerTimeout { @@ -756,7 +756,7 @@ public Time ClusterManagerTimeout set => Q("cluster_manager_timeout", value); } - /// A short version of the Accept header (for example, `json`, `yaml`). + /// A short version of the `Accept` header, such as `json` or `yaml`. public string Format { get => Q("format"); @@ -767,28 +767,28 @@ public string Format } } - /// Comma-separated list of column names to display. + /// A comma-separated list of column names to display. public string[] Headers { get => Q("h"); set => Q("h", value); } - /// Return help information. + /// Returns help information. public bool? Help { get => Q("help"); set => Q("help", value); } - /// Return local information, do not retrieve the state from cluster-manager node. + /// Returns local information but does not retrieve the state from the cluster manager node. public bool? Local { get => Q("local"); set => Q("local", value); } - /// Operation timeout for connection to cluster-manager node. + /// The amount of time allowed to establish a connection to the cluster manager node. [Obsolete( "Deprecated as of: 2.0.0, reason: To promote inclusive language, use `cluster_manager_timeout` instead." )] @@ -798,14 +798,14 @@ public Time MasterTimeout set => Q("master_timeout", value); } - /// Comma-separated list of column names or column aliases to sort by. + /// A comma-separated list of column names or column aliases to sort by. public string[] SortByColumns { get => Q("s"); set => Q("s", value); } - /// Verbose mode. Display column headers. + /// Enables verbose mode, which displays column headers. public bool? Verbose { get => Q("v"); @@ -828,7 +828,7 @@ public partial class CatNodeAttributesRequest // values part of the url path // Request parameters - /// Operation timeout for connection to cluster-manager node. + /// The amount of time allowed to establish a connection to the cluster manager node. /// Supported by OpenSearch servers of version 2.0.0 or greater. public Time ClusterManagerTimeout { @@ -836,7 +836,7 @@ public Time ClusterManagerTimeout set => Q("cluster_manager_timeout", value); } - /// A short version of the Accept header (for example, `json`, `yaml`). + /// A short version of the `Accept` header, such as `json` or `yaml`. public string Format { get => Q("format"); @@ -847,28 +847,28 @@ public string Format } } - /// Comma-separated list of column names to display. + /// A comma-separated list of column names to display. public string[] Headers { get => Q("h"); set => Q("h", value); } - /// Return help information. + /// Returns help information. public bool? Help { get => Q("help"); set => Q("help", value); } - /// Return local information, do not retrieve the state from cluster-manager node. + /// Returns local information but does not retrieve the state from the cluster manager node. public bool? Local { get => Q("local"); set => Q("local", value); } - /// Operation timeout for connection to cluster-manager node. + /// The amount of time allowed to establish a connection to the cluster manager node. [Obsolete( "Deprecated as of: 2.0.0, reason: To promote inclusive language, use `cluster_manager_timeout` instead." )] @@ -878,14 +878,14 @@ public Time MasterTimeout set => Q("master_timeout", value); } - /// Comma-separated list of column names or column aliases to sort by. + /// A comma-separated list of column names or column aliases to sort by. public string[] SortByColumns { get => Q("s"); set => Q("s", value); } - /// Verbose mode. Display column headers. + /// Enables verbose mode, which displays column headers. public bool? Verbose { get => Q("v"); @@ -907,14 +907,14 @@ public partial class CatNodesRequest // values part of the url path // Request parameters - /// The unit used to display byte values. + /// The units used to display byte values. public ByteUnit? Bytes { get => Q("bytes"); set => Q("bytes", value); } - /// Operation timeout for connection to cluster-manager node. + /// The amount of time allowed to establish a connection to the cluster manager node. /// Supported by OpenSearch servers of version 2.0.0 or greater. public Time ClusterManagerTimeout { @@ -922,7 +922,7 @@ public Time ClusterManagerTimeout set => Q("cluster_manager_timeout", value); } - /// A short version of the Accept header (for example, `json`, `yaml`). + /// A short version of the `Accept` header, such as `json` or `yaml`. public string Format { get => Q("format"); @@ -933,28 +933,28 @@ public string Format } } - /// If `true`, return the full node ID. If `false`, return the shortened node ID. + /// When `true`, returns the full node ID. When `false`, returns the shortened node ID. public bool? FullId { get => Q("full_id"); set => Q("full_id", value); } - /// Comma-separated list of column names to display. + /// A comma-separated list of column names to display. public string[] Headers { get => Q("h"); set => Q("h", value); } - /// Return help information. + /// Returns help information. public bool? Help { get => Q("help"); set => Q("help", value); } - /// Return local information, do not retrieve the state from cluster-manager node. + /// Returns local information but does not retrieve the state from the cluster manager node. [Obsolete( "Deprecated as of: 1.0.0, reason: This parameter does not cause this API to act locally." )] @@ -964,7 +964,7 @@ public bool? Local set => Q("local", value); } - /// Operation timeout for connection to cluster-manager node. + /// The amount of time allowed to establish a connection to the cluster manager node. [Obsolete( "Deprecated as of: 2.0.0, reason: To promote inclusive language, use `cluster_manager_timeout` instead." )] @@ -974,14 +974,14 @@ public Time MasterTimeout set => Q("master_timeout", value); } - /// Comma-separated list of column names or column aliases to sort by. + /// A comma-separated list of column names or column aliases to sort by. public string[] SortByColumns { get => Q("s"); set => Q("s", value); } - /// Verbose mode. Display column headers. + /// Enables verbose mode, which displays column headers. public bool? Verbose { get => Q("v"); @@ -1004,7 +1004,7 @@ public partial class CatPendingTasksRequest // values part of the url path // Request parameters - /// Operation timeout for connection to cluster-manager node. + /// The amount of time allowed to establish a connection to the cluster manager node. /// Supported by OpenSearch servers of version 2.0.0 or greater. public Time ClusterManagerTimeout { @@ -1012,7 +1012,7 @@ public Time ClusterManagerTimeout set => Q("cluster_manager_timeout", value); } - /// A short version of the Accept header (for example, `json`, `yaml`). + /// A short version of the `Accept` header, such as `json` or `yaml`. public string Format { get => Q("format"); @@ -1023,28 +1023,28 @@ public string Format } } - /// Comma-separated list of column names to display. + /// A comma-separated list of column names to display. public string[] Headers { get => Q("h"); set => Q("h", value); } - /// Return help information. + /// Returns help information. public bool? Help { get => Q("help"); set => Q("help", value); } - /// Return local information, do not retrieve the state from cluster-manager node. + /// Returns local information but does not retrieve the state from the cluster manager node. public bool? Local { get => Q("local"); set => Q("local", value); } - /// Operation timeout for connection to cluster-manager node. + /// The amount of time allowed to establish a connection to the cluster manager node. [Obsolete( "Deprecated as of: 2.0.0, reason: To promote inclusive language, use `cluster_manager_timeout` instead." )] @@ -1054,14 +1054,14 @@ public Time MasterTimeout set => Q("master_timeout", value); } - /// Comma-separated list of column names or column aliases to sort by. + /// A comma-separated list of column names or column aliases to sort by. public string[] SortByColumns { get => Q("s"); set => Q("s", value); } - /// Verbose mode. Display column headers. + /// Enables verbose mode, which displays column headers. public bool? Verbose { get => Q("v"); @@ -1083,14 +1083,14 @@ public partial class CatPitSegmentsRequest // values part of the url path // Request parameters - /// The unit in which to display byte values. + /// The units used to display byte values. public ByteUnit? Bytes { get => Q("bytes"); set => Q("bytes", value); } - /// A short version of the Accept header (for example, `json`, `yaml`). + /// A short version of the `Accept` header, such as `json` or `yaml`. public string Format { get => Q("format"); @@ -1101,28 +1101,28 @@ public string Format } } - /// Comma-separated list of column names to display. + /// A comma-separated list of column names to display. public string[] Headers { get => Q("h"); set => Q("h", value); } - /// Return help information. + /// Returns help information. public bool? Help { get => Q("help"); set => Q("help", value); } - /// Comma-separated list of column names or column aliases to sort by. + /// A comma-separated list of column names or column aliases to sort by. public string[] SortByColumns { get => Q("s"); set => Q("s", value); } - /// Verbose mode. Display column headers. + /// Enables verbose mode, which displays column headers. public bool? Verbose { get => Q("v"); @@ -1144,7 +1144,7 @@ public partial class CatPluginsRequest // values part of the url path // Request parameters - /// Operation timeout for connection to cluster-manager node. + /// The amount of time allowed to establish a connection to the cluster manager node. /// Supported by OpenSearch servers of version 2.0.0 or greater. public Time ClusterManagerTimeout { @@ -1152,7 +1152,7 @@ public Time ClusterManagerTimeout set => Q("cluster_manager_timeout", value); } - /// A short version of the Accept header (for example, `json`, `yaml`). + /// A short version of the `Accept` header, such as `json` or `yaml`. public string Format { get => Q("format"); @@ -1163,28 +1163,28 @@ public string Format } } - /// Comma-separated list of column names to display. + /// A comma-separated list of column names to display. public string[] Headers { get => Q("h"); set => Q("h", value); } - /// Return help information. + /// Returns help information. public bool? Help { get => Q("help"); set => Q("help", value); } - /// Return local information, do not retrieve the state from cluster-manager node. + /// Returns local information but does not retrieve the state from the cluster manager node. public bool? Local { get => Q("local"); set => Q("local", value); } - /// Operation timeout for connection to cluster-manager node. + /// The amount of time allowed to establish a connection to the cluster manager node. [Obsolete( "Deprecated as of: 2.0.0, reason: To promote inclusive language, use `cluster_manager_timeout` instead." )] @@ -1194,14 +1194,14 @@ public Time MasterTimeout set => Q("master_timeout", value); } - /// Comma-separated list of column names or column aliases to sort by. + /// A comma-separated list of column names or column aliases to sort by. public string[] SortByColumns { get => Q("s"); set => Q("s", value); } - /// Verbose mode. Display column headers. + /// Enables verbose mode, which displays column headers. public bool? Verbose { get => Q("v"); @@ -1245,21 +1245,21 @@ public bool? ActiveOnly set => Q("active_only", value); } - /// The unit used to display byte values. + /// The units used to display byte values. public ByteUnit? Bytes { get => Q("bytes"); set => Q("bytes", value); } - /// If `true`, the response includes detailed information about shard recoveries. + /// When `true`, includes detailed information about shard recoveries. public bool? Detailed { get => Q("detailed"); set => Q("detailed", value); } - /// A short version of the Accept header (for example, `json`, `yaml`). + /// A short version of the `Accept` header, such as `json` or `yaml`. public string Format { get => Q("format"); @@ -1270,28 +1270,28 @@ public string Format } } - /// Comma-separated list of column names to display. + /// A comma-separated list of column names to display. public string[] Headers { get => Q("h"); set => Q("h", value); } - /// Return help information. + /// Returns help information. public bool? Help { get => Q("help"); set => Q("help", value); } - /// Comma-separated list of column names or column aliases to sort by. + /// A comma-separated list of column names or column aliases to sort by. public string[] SortByColumns { get => Q("s"); set => Q("s", value); } - /// Verbose mode. Display column headers. + /// Enables verbose mode, which displays column headers. public bool? Verbose { get => Q("v"); @@ -1314,7 +1314,7 @@ public partial class CatRepositoriesRequest // values part of the url path // Request parameters - /// Operation timeout for connection to cluster-manager node. + /// The amount of time allowed to establish a connection to the cluster manager node. /// Supported by OpenSearch servers of version 2.0.0 or greater. public Time ClusterManagerTimeout { @@ -1322,7 +1322,7 @@ public Time ClusterManagerTimeout set => Q("cluster_manager_timeout", value); } - /// A short version of the Accept header (for example, `json`, `yaml`). + /// A short version of the `Accept` header, such as `json` or `yaml`. public string Format { get => Q("format"); @@ -1333,28 +1333,28 @@ public string Format } } - /// Comma-separated list of column names to display. + /// A comma-separated list of column names to display. public string[] Headers { get => Q("h"); set => Q("h", value); } - /// Return help information. + /// Returns help information. public bool? Help { get => Q("help"); set => Q("help", value); } - /// Return local information, do not retrieve the state from cluster-manager node. + /// Returns local information but does not retrieve the state from the cluster manager node. public bool? Local { get => Q("local"); set => Q("local", value); } - /// Operation timeout for connection to cluster-manager node. + /// The amount of time allowed to establish a connection to the cluster manager node. [Obsolete( "Deprecated as of: 2.0.0, reason: To promote inclusive language, use `cluster_manager_timeout` instead." )] @@ -1364,14 +1364,14 @@ public Time MasterTimeout set => Q("master_timeout", value); } - /// Comma-separated list of column names or column aliases to sort by. + /// A comma-separated list of column names or column aliases to sort by. public string[] SortByColumns { get => Q("s"); set => Q("s", value); } - /// Verbose mode. Display column headers. + /// Enables verbose mode, which displays column headers. public bool? Verbose { get => Q("v"); @@ -1409,7 +1409,7 @@ public CatSegmentReplicationRequest(Indices index) Indices ICatSegmentReplicationRequest.Index => Self.RouteValues.Get("index"); // Request parameters - /// If `true`, the response only includes ongoing segment replication events. + /// When `true`, the response only includes ongoing segment replication events. public bool? ActiveOnly { get => Q("active_only"); @@ -1417,8 +1417,8 @@ public bool? ActiveOnly } /// - /// Whether to ignore if a wildcard indexes expression resolves into no concrete indexes. (This includes `_all` string or when no indexes have - /// been specified). + /// 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. /// public bool? AllowNoIndices { @@ -1426,35 +1426,35 @@ public bool? AllowNoIndices set => Q("allow_no_indices", value); } - /// The unit in which to display byte values. + /// The units used to display byte values. public ByteUnit? Bytes { get => Q("bytes"); set => Q("bytes", value); } - /// If `true`, the response only includes latest completed segment replication events. + /// When `true`, the response only includes the last-completed segment replication events. public bool? CompletedOnly { get => Q("completed_only"); set => Q("completed_only", value); } - /// If `true`, the response includes detailed information about segment replications. + /// When `true`, the response includes additional metrics for each stage of a segment replication event. public bool? Detailed { get => Q("detailed"); set => Q("detailed", value); } - /// Whether to expand wildcard expression to concrete indexes that are open, closed or both. + /// TODO public ExpandWildcards? ExpandWildcards { get => Q("expand_wildcards"); set => Q("expand_wildcards", value); } - /// A short version of the Accept header (for example, `json`, `yaml`). + /// A short version of the `Accept` header, such as `json` or `yaml`. public string Format { get => Q("format"); @@ -1465,56 +1465,56 @@ public string Format } } - /// Comma-separated list of column names to display. + /// A comma-separated list of column names to display. public string[] Headers { get => Q("h"); set => Q("h", value); } - /// Return help information. + /// Returns help information. public bool? Help { get => Q("help"); set => Q("help", value); } - /// Whether specified concrete, expanded or aliased indexes should be ignored when throttled. + /// Whether specified concrete, expanded, or aliased indexes should be ignored when throttled. public bool? IgnoreThrottled { get => Q("ignore_throttled"); set => Q("ignore_throttled", value); } - /// Whether specified concrete indexes should be ignored when unavailable (missing or closed). + /// Whether the specified concrete indexes should be ignored when missing or closed. public bool? IgnoreUnavailable { get => Q("ignore_unavailable"); set => Q("ignore_unavailable", value); } - /// Comma-separated list of shards to display. + /// A comma-separated list of shards to display. public string[] Shards { get => Q("shards"); set => Q("shards", value); } - /// Comma-separated list of column names or column aliases to sort by. + /// A comma-separated list of column names or column aliases to sort by. public string[] SortByColumns { get => Q("s"); set => Q("s", value); } - /// Operation timeout. + /// The operation timeout. public Time Timeout { get => Q