@elastic/schemas 0.4.3 → 0.4.5

package/src/es/json/snapshot.delete_repository.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"snapshot.delete_repository","type":"object","properties":{"name":{"$ref":"./_types.json#/$defs/_types__Names","description":"The ame of the snapshot repositories to unregister.\nWildcard (`*`) patterns are supported.","x-found-in":"path"},"master_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period to wait for the master node.\nIf the master node is not available before the timeout expires, the request fails and returns an error.\nTo indicate that the request should never timeout, set it to `-1`.","x-found-in":"query"},"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period to wait for a response from all relevant nodes in the cluster after updating the cluster metadata.\nIf no response is received before the timeout expires, the cluster metadata update still applies but the response will indicate that it was not completely acknowledged.\nTo indicate that the request should never timeout, set it to `-1`.","x-found-in":"query"}},"required":["name"],"description":"Delete snapshot repositories.\n\nWhen a repository is unregistered, Elasticsearch removes only the reference to the location where the repository is storing the snapshots.\nThe snapshots themselves are left untouched and in place."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"snapshot.delete_repository","type":"object","properties":{"master_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period to wait for the master node.\nIf the master node is not available before the timeout expires, the request fails and returns an error.\nTo indicate that the request should never timeout, set it to `-1`.","x-found-in":"query"},"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period to wait for a response from all relevant nodes in the cluster after updating the cluster metadata.\nIf no response is received before the timeout expires, the cluster metadata update still applies but the response will indicate that it was not completely acknowledged.\nTo indicate that the request should never timeout, set it to `-1`.","x-found-in":"query"},"repository":{"$ref":"./_types.json#/$defs/_types__Names","description":"The ame of the snapshot repositories to unregister.\nWildcard (`*`) patterns are supported.","x-found-in":"path"}},"required":["repository"],"description":"Delete snapshot repositories.\n\nWhen a repository is unregistered, Elasticsearch removes only the reference to the location where the repository is storing the snapshots.\nThe snapshots themselves are left untouched and in place."}

package/src/es/json/snapshot.get.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"snapshot.get","type":"object","properties":{"repository":{"type":"string","description":"A comma-separated list of snapshot repository names used to limit the request.\nWildcard (`*`) expressions are supported.","x-found-in":"path"},"snapshot":{"$ref":"./_types.json#/$defs/_types__Names","description":"A comma-separated list of snapshot names to retrieve\nWildcards (`*`) are supported.\n\n* To get information about all snapshots in a registered repository, use a wildcard (`*`) or `_all`.\n* To get information about any snapshots that are currently running, use `_current`.","x-found-in":"path"},"after":{"type":"string","description":"An offset identifier to start pagination from as returned by the next field in the response body.","x-found-in":"query"},"from_sort_value":{"type":"string","description":"The value of the current sort column at which to start retrieval.\nIt can be a string `snapshot-` or a repository name when sorting by snapshot or repository name.\nIt can be a millisecond time value or a number when sorting by `index-` or shard count.","x-found-in":"query"},"ignore_unavailable":{"type":"boolean","description":"If `false`, the request returns an error for any snapshots that are unavailable.","x-found-in":"query"},"index_details":{"type":"boolean","description":"If `true`, the response includes additional information about each index in the snapshot comprising the number of shards in the index, the total size of the index in bytes, and the maximum number of segments per shard in the index.\nThe default is `false`, meaning that this information is omitted.","x-found-in":"query"},"index_names":{"type":"boolean","description":"If `true`, the response includes the name of each index in each snapshot.","x-found-in":"query"},"include_repository":{"type":"boolean","description":"If `true`, the response includes the repository name in each snapshot.","x-found-in":"query"},"master_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.","x-found-in":"query"},"order":{"$ref":"./_types.json#/$defs/_types__SortOrder","description":"The sort order.\nValid values are `asc` for ascending and `desc` for descending order.\nThe default behavior is ascending order.","x-found-in":"query"},"offset":{"type":"number","description":"Numeric offset to start pagination from based on the snapshots matching this request. Using a non-zero value for this parameter is mutually exclusive with using the after parameter. Defaults to 0.","x-found-in":"query"},"size":{"type":"number","description":"The maximum number of snapshots to return.\nThe default is -1, which means to return all that match the request without limit.","x-found-in":"query"},"slm_policy_filter":{"type":"string","description":"Filter snapshots by a comma-separated list of snapshot lifecycle management (SLM) policy names that snapshots belong to.\n\nYou can use wildcards (`*`) and combinations of wildcards followed by exclude patterns starting with `-`.\nFor example, the pattern `*,-policy-a-\\*` will return all snapshots except for those that were created by an SLM policy with a name starting with `policy-a-`.\nNote that the wildcard pattern `*` matches all snapshots created by an SLM policy but not those snapshots that were not created by an SLM policy.\nTo include snapshots that were not created by an SLM policy, you can use the special pattern `_none` that will match all snapshots without an SLM policy.","x-found-in":"query"},"sort":{"$ref":"./snapshot._types.json#/$defs/snapshot._types__SnapshotSort","description":"The sort order for the result.\nThe default behavior is sorting by snapshot start time stamp.","x-found-in":"query"},"state":{"oneOf":[{"$ref":"./snapshot._types.json#/$defs/snapshot._types__SnapshotState"},{"type":"array","items":{"$ref":"./snapshot._types.json#/$defs/snapshot._types__SnapshotState"}}],"description":"Only return snapshots with a state found in the given comma-separated list of snapshot states.\nThe default is all snapshot states.","x-found-in":"query"},"verbose":{"type":"boolean","description":"If `true`, returns additional information about each snapshot such as the version of Elasticsearch which took the snapshot, the start and end times of the snapshot, and the number of shards snapshotted.\n\nNOTE: The parameters `size`, `order`, `after`, `from_sort_value`, `offset`, `slm_policy_filter`, and `sort` are not supported when you set `verbose=false` and the sort order for requests with `verbose=false` is undefined.","x-found-in":"query"}},"required":["repository","snapshot"],"description":"Get snapshot information.\n\nNOTE: The `after` parameter and `next` field enable you to iterate through snapshots with some consistency guarantees regarding concurrent creation or deletion of snapshots.\nIt is guaranteed that any snapshot that exists at the beginning of the iteration and is not concurrently deleted will be seen during the iteration.\nSnapshots concurrently created may be seen during an iteration."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"snapshot.get","type":"object","properties":{"after":{"type":"string","description":"An offset identifier to start pagination from as returned by the next field in the response body.","x-found-in":"query"},"from_sort_value":{"type":"string","description":"The value of the current sort column at which to start retrieval.\nIt can be a string `snapshot-` or a repository name when sorting by snapshot or repository name.\nIt can be a millisecond time value or a number when sorting by `index-` or shard count.","x-found-in":"query"},"ignore_unavailable":{"type":"boolean","description":"If `false`, the request returns an error for any snapshots that are unavailable.","x-found-in":"query"},"index_details":{"type":"boolean","description":"If `true`, the response includes additional information about each index in the snapshot comprising the number of shards in the index, the total size of the index in bytes, and the maximum number of segments per shard in the index.\nThe default is `false`, meaning that this information is omitted.","x-found-in":"query"},"index_names":{"type":"boolean","description":"If `true`, the response includes the name of each index in each snapshot.","x-found-in":"query"},"include_repository":{"type":"boolean","description":"If `true`, the response includes the repository name in each snapshot.","x-found-in":"query"},"master_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.","x-found-in":"query"},"order":{"$ref":"./_types.json#/$defs/_types__SortOrder","description":"The sort order.\nValid values are `asc` for ascending and `desc` for descending order.\nThe default behavior is ascending order.","x-found-in":"query"},"offset":{"type":"number","description":"Numeric offset to start pagination from based on the snapshots matching this request. Using a non-zero value for this parameter is mutually exclusive with using the after parameter. Defaults to 0.","x-found-in":"query"},"size":{"type":"number","description":"The maximum number of snapshots to return.\nThe default is -1, which means to return all that match the request without limit.","x-found-in":"query"},"slm_policy_filter":{"type":"string","description":"Filter snapshots by a comma-separated list of snapshot lifecycle management (SLM) policy names that snapshots belong to.\n\nYou can use wildcards (`*`) and combinations of wildcards followed by exclude patterns starting with `-`.\nFor example, the pattern `*,-policy-a-\\*` will return all snapshots except for those that were created by an SLM policy with a name starting with `policy-a-`.\nNote that the wildcard pattern `*` matches all snapshots created by an SLM policy but not those snapshots that were not created by an SLM policy.\nTo include snapshots that were not created by an SLM policy, you can use the special pattern `_none` that will match all snapshots without an SLM policy.","x-found-in":"query"},"sort":{"$ref":"./snapshot._types.json#/$defs/snapshot._types__SnapshotSort","description":"The sort order for the result.\nThe default behavior is sorting by snapshot start time stamp.","x-found-in":"query"},"state":{"anyOf":[{"$ref":"./snapshot._types.json#/$defs/snapshot._types__SnapshotState"},{"type":"array","items":{"$ref":"./snapshot._types.json#/$defs/snapshot._types__SnapshotState"}}],"description":"Only return snapshots with a state found in the given comma-separated list of snapshot states.\nThe default is all snapshot states.","x-found-in":"query"},"verbose":{"type":"boolean","description":"If `true`, returns additional information about each snapshot such as the version of Elasticsearch which took the snapshot, the start and end times of the snapshot, and the number of shards snapshotted.\n\nNOTE: The parameters `size`, `order`, `after`, `from_sort_value`, `offset`, `slm_policy_filter`, and `sort` are not supported when you set `verbose=false` and the sort order for requests with `verbose=false` is undefined.","x-found-in":"query"},"repository":{"type":"string","description":"A comma-separated list of snapshot repository names used to limit the request.\nWildcard (`*`) expressions are supported.","x-found-in":"path"},"snapshot":{"$ref":"./_types.json#/$defs/_types__Names","description":"A comma-separated list of snapshot names to retrieve\nWildcards (`*`) are supported.\n\n* To get information about all snapshots in a registered repository, use a wildcard (`*`) or `_all`.\n* To get information about any snapshots that are currently running, use `_current`.","x-found-in":"path"}},"required":["repository","snapshot"],"description":"Get snapshot information.\n\nNOTE: The `after` parameter and `next` field enable you to iterate through snapshots with some consistency guarantees regarding concurrent creation or deletion of snapshots.\nIt is guaranteed that any snapshot that exists at the beginning of the iteration and is not concurrently deleted will be seen during the iteration.\nSnapshots concurrently created may be seen during an iteration."}

package/src/es/json/snapshot.get_repository.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"snapshot.get_repository","type":"object","properties":{"name":{"$ref":"./_types.json#/$defs/_types__Names","description":"A comma-separated list of snapshot repository names used to limit the request.\nWildcard (`*`) expressions are supported including combining wildcards with exclude patterns starting with `-`.\n\nTo get information about all snapshot repositories registered in the cluster, omit this parameter or use `*` or `_all`.","x-found-in":"path"},"local":{"type":"boolean","description":"If `true`, the request gets information from the local node only.\nIf `false`, the request gets information from the master node.","x-found-in":"query"},"master_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period to wait for the master node.\nIf the master node is not available before the timeout expires, the request fails and returns an error.\nTo indicate that the request should never timeout, set it to `-1`.","x-found-in":"query"}},"description":"Get snapshot repository information."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"snapshot.get_repository","type":"object","properties":{"local":{"type":"boolean","description":"If `true`, the request gets information from the local node only.\nIf `false`, the request gets information from the master node.","x-found-in":"query"},"master_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period to wait for the master node.\nIf the master node is not available before the timeout expires, the request fails and returns an error.\nTo indicate that the request should never timeout, set it to `-1`.","x-found-in":"query"},"repository":{"$ref":"./_types.json#/$defs/_types__Names","description":"A comma-separated list of snapshot repository names used to limit the request.\nWildcard (`*`) expressions are supported including combining wildcards with exclude patterns starting with `-`.\n\nTo get information about all snapshot repositories registered in the cluster, omit this parameter or use `*` or `_all`.","x-found-in":"path"}},"description":"Get snapshot repository information."}

package/src/es/json/snapshot.repository_analyze.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"snapshot.repository_analyze","type":"object","properties":{"name":{"type":"string","description":"The name of the repository.","x-found-in":"path"},"blob_count":{"type":"number","description":"The total number of blobs to write to the repository during the test.\nFor realistic experiments, set this parameter to at least `2000`.","x-found-in":"query"},"check_overwrite_protection":{"type":"boolean","description":"Whether to run the overwrite protection check.\nFor realistic experiments, leave this parameter unset.","x-found-in":"query"},"concurrency":{"type":"number","description":"The number of operations to run concurrently during the test.\nFor realistic experiments, leave this parameter unset.","x-found-in":"query"},"detailed":{"type":"boolean","description":"Indicates whether to return detailed results, including timing information for every operation performed during the analysis.\nIf false, it returns only a summary of the analysis.","x-found-in":"query"},"early_read_node_count":{"type":"number","description":"The number of nodes on which to perform an early read operation while writing each blob.\nEarly read operations are only rarely performed.\nFor realistic experiments, leave this parameter unset.","x-found-in":"query"},"max_blob_size":{"$ref":"./_types.json#/$defs/_types__ByteSize","description":"The maximum size of a blob to be written during the test.\nFor realistic experiments, set this parameter to at least `2gb`.","x-found-in":"query"},"max_total_data_size":{"$ref":"./_types.json#/$defs/_types__ByteSize","description":"An upper limit on the total size of all the blobs written during the test.\nFor realistic experiments, set this parameter to at least `1tb`.","x-found-in":"query"},"rare_action_probability":{"type":"number","description":"The probability of performing a rare action such as an early read, an overwrite, or an aborted write on each blob.\nFor realistic experiments, leave this parameter unset.","x-found-in":"query"},"rarely_abort_writes":{"type":"boolean","description":"Indicates whether to rarely cancel writes before they complete.\nFor realistic experiments, leave this parameter unset.","x-found-in":"query"},"read_node_count":{"type":"number","description":"The number of nodes on which to read a blob after writing.\nFor realistic experiments, leave this parameter unset.","x-found-in":"query"},"register_operation_count":{"type":"number","description":"The minimum number of linearizable register operations to perform in total.\nFor realistic experiments, set this parameter to at least `100`.","x-found-in":"query"},"seed":{"type":"number","description":"The seed for the pseudo-random number generator used to generate the list of operations performed during the test.\nTo repeat the same set of operations in multiple experiments, use the same seed in each experiment.\nNote that the operations are performed concurrently so might not always happen in the same order on each run.\nFor realistic experiments, leave this parameter unset.","x-found-in":"query"},"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period of time to wait for the test to complete.\nIf no response is received before the timeout expires, the test is cancelled and returns an error.\nFor realistic experiments, set this parameter sufficiently long to allow the test to complete.","x-found-in":"query"}},"required":["name"],"description":"Analyze a snapshot repository.\n\nPerforms operations on a snapshot repository in order to check for incorrect behaviour.\n\nThere are a large number of third-party storage systems available, not all of which are suitable for use as a snapshot repository by Elasticsearch.\nSome storage systems behave incorrectly, or perform poorly, especially when accessed concurrently by multiple clients as the nodes of an Elasticsearch cluster do.\nThis API performs a collection of read and write operations on your repository which are designed to detect incorrect behaviour and to measure the performance characteristics of your storage system.\n\nThe default values for the parameters are deliberately low to reduce the impact of running an analysis inadvertently and to provide a sensible starting point for your investigations.\nRun your first analysis with the default parameter values to check for simple problems.\nSome repositories may behave correctly when lightly loaded but incorrectly under production-like workloads.\nIf the first analysis is successful, run a sequence of increasingly large analyses until you encounter a failure or you reach a `blob_count` of at least `2000`, a `max_blob_size` of at least `2gb`, a `max_total_data_size` of at least `1tb`, and a `register_operation_count` of at least `100`.\nAlways specify a generous timeout, possibly `1h` or longer, to allow time for each analysis to run to completion.\nSome repositories may behave correctly when accessed by a small number of Elasticsearch nodes but incorrectly when accessed concurrently by a production-scale cluster.\nPerform the analyses using a multi-node cluster of a similar size to your production cluster so that it can detect any problems that only arise when the repository is accessed by many nodes at once.\n\nIf the analysis fails, Elasticsearch detected that your repository behaved unexpectedly.\nThis usually means you are using a third-party storage system with an incorrect or incompatible implementation of the API it claims to support.\nIf so, this storage system is not suitable for use as a snapshot repository.\nRepository analysis triggers conditions that occur only rarely when taking snapshots in a production system.\nSnapshotting to unsuitable storage may appear to work correctly most of the time despite repository analysis failures.\nHowever your snapshot data is at risk if you store it in a snapshot repository that does not reliably pass repository analysis.\nYou can demonstrate that the analysis failure is due to an incompatible storage implementation by verifying that Elasticsearch does not detect the same problem when analysing the reference implementation of the storage protocol you are using.\nFor instance, if you are using storage that offers an API which the supplier claims to be compatible with AWS S3, verify that repositories in AWS S3 do not fail repository analysis.\nThis allows you to demonstrate to your storage supplier that a repository analysis failure must only be caused by an incompatibility with AWS S3 and cannot be attributed to a problem in Elasticsearch.\nPlease do not report Elasticsearch issues involving third-party storage systems unless you can demonstrate that the same issue exists when analysing a repository that uses the reference implementation of the same storage protocol.\nYou will need to work with the supplier of your storage system to address the incompatibilities that Elasticsearch detects.\n\nThe analysis may also report a failure if your repository experienced a service disruption while the analysis was running.\nIn practice, occasional service disruptions are inevitable, but the analysis cannot itself distinguish such disruptions from incorrect behavior so must report all deviations from the expected behavior as failures.\nIf you are certain that you can ascribe an analysis failure to such a service disruption, wait for your service provider to resolve the disruption and then re-run the analysis.\nElasticsearch will be unable to create or restore snapshots during repository service disruptions, so you must ensure that these events occur only very rarely.\n\nIf the analysis is successful, the API returns details of the testing process, optionally including how long each operation took.\nYou can use this information to determine the performance of your storage system.\nIf any operation fails or returns an incorrect result, the API returns an error.\nIf the API returns an error, it may not have removed all the data it wrote to the repository.\nThe error will indicate the location of any leftover data and this path is also recorded in the Elasticsearch logs.\nYou should verify that this location has been cleaned up correctly.\nIf there is still leftover data at the specified location, you should manually remove it.\n\nIf the connection from your client to Elasticsearch is closed while the client is waiting for the result of the analysis, the test is cancelled.\nSome clients are configured to close their connection if no response is received within a certain timeout.\nAn analysis takes a long time to complete so you might need to relax any such client-side timeouts.\nOn cancellation the analysis attempts to clean up the data it was writing, but it may not be able to remove it all.\nThe path to the leftover data is recorded in the Elasticsearch logs.\nYou should verify that this location has been cleaned up correctly.\nIf there is still leftover data at the specified location, you should manually remove it.\n\nIf the analysis is successful then it detected no incorrect behaviour, but this does not mean that correct behaviour is guaranteed.\nThe analysis attempts to detect common bugs but it does not offer 100% coverage.\nAdditionally, it does not test the following:\n\n* Your repository must perform durable writes. Once a blob has been written it must remain in place until it is deleted, even after a power loss or similar disaster.\n* Your repository must not suffer from silent data corruption. Once a blob has been written, its contents must remain unchanged until it is deliberately modified or deleted.\n* Your repository must behave correctly even if connectivity from the cluster is disrupted. Reads and writes may fail in this case, but they must not return incorrect results.\n\nIMPORTANT: An analysis writes a substantial amount of data to your repository and then reads it back again.\nThis consumes bandwidth on the network between the cluster and the repository, and storage space and I/O bandwidth on the repository itself.\nYou must ensure this load does not affect other users of these systems.\nAnalyses respect the repository settings `max_snapshot_bytes_per_sec` and `max_restore_bytes_per_sec` if available and the cluster setting `indices.recovery.max_bytes_per_sec` which you can use to limit the bandwidth they consume.\n\nNOTE: This API is intended for exploratory use by humans.\nYou should expect the request parameters and the response format to vary in future versions.\nThe response exposes immplementation details of the analysis which may change from version to version.\n\nNOTE: Different versions of Elasticsearch may perform different checks for repository compatibility, with newer versions typically being stricter than older ones.\nA storage system that passes repository analysis with one version of Elasticsearch may fail with a different version.\nThis indicates it behaves incorrectly in ways that the former version did not detect.\nYou must work with the supplier of your storage system to address the incompatibilities detected by the repository analysis API in any version of Elasticsearch.\n\nNOTE: This API may not work correctly in a mixed-version cluster.\n\n*Implementation details*\n\nNOTE: This section of documentation describes how the repository analysis API works in this version of Elasticsearch, but you should expect the implementation to vary between versions.\nThe request parameters and response format depend on details of the implementation so may also be different in newer versions.\n\nThe analysis comprises a number of blob-level tasks, as set by the `blob_count` parameter and a number of compare-and-exchange operations on linearizable registers, as set by the `register_operation_count` parameter.\nThese tasks are distributed over the data and master-eligible nodes in the cluster for execution.\n\nFor most blob-level tasks, the executing node first writes a blob to the repository and then instructs some of the other nodes in the cluster to attempt to read the data it just wrote.\nThe size of the blob is chosen randomly, according to the `max_blob_size` and `max_total_data_size` parameters.\nIf any of these reads fails then the repository does not implement the necessary read-after-write semantics that Elasticsearch requires.\n\nFor some blob-level tasks, the executing node will instruct some of its peers to attempt to read the data before the writing process completes.\nThese reads are permitted to fail, but must not return partial data.\nIf any read returns partial data then the repository does not implement the necessary atomicity semantics that Elasticsearch requires.\n\nFor some blob-level tasks, the executing node will overwrite the blob while its peers are reading it.\nIn this case the data read may come from either the original or the overwritten blob, but the read operation must not return partial data or a mix of data from the two blobs.\nIf any of these reads returns partial data or a mix of the two blobs then the repository does not implement the necessary atomicity semantics that Elasticsearch requires for overwrites.\n\nThe executing node will use a variety of different methods to write the blob.\nFor instance, where applicable, it will use both single-part and multi-part uploads.\nSimilarly, the reading nodes will use a variety of different methods to read the data back again.\nFor instance they may read the entire blob from start to end or may read only a subset of the data.\n\nFor some blob-level tasks, the executing node will cancel the write before it is complete.\nIn this case, it still instructs some of the other nodes in the cluster to attempt to read the blob but all of these reads must fail to find the blob.\n\nLinearizable registers are special blobs that Elasticsearch manipulates using an atomic compare-and-exchange operation.\nThis operation ensures correct and strongly-consistent behavior even when the blob is accessed by multiple nodes at the same time.\nThe detailed implementation of the compare-and-exchange operation on linearizable registers varies by repository type.\nRepository analysis verifies that that uncontended compare-and-exchange operations on a linearizable register blob always succeed.\nRepository analysis also verifies that contended operations either succeed or report the contention but do not return incorrect results.\nIf an operation fails due to contention, Elasticsearch retries the operation until it succeeds.\nMost of the compare-and-exchange operations performed by repository analysis atomically increment a counter which is represented as an 8-byte blob.\nSome operations also verify the behavior on small blobs with sizes other than 8 bytes."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"snapshot.repository_analyze","type":"object","properties":{"blob_count":{"type":"number","description":"The total number of blobs to write to the repository during the test.\nFor realistic experiments, set this parameter to at least `2000`.","x-found-in":"query"},"check_overwrite_protection":{"type":"boolean","description":"Whether to run the overwrite protection check.\nFor realistic experiments, leave this parameter unset.","x-found-in":"query"},"concurrency":{"type":"number","description":"The number of operations to run concurrently during the test.\nFor realistic experiments, leave this parameter unset.","x-found-in":"query"},"detailed":{"type":"boolean","description":"Indicates whether to return detailed results, including timing information for every operation performed during the analysis.\nIf false, it returns only a summary of the analysis.","x-found-in":"query"},"early_read_node_count":{"type":"number","description":"The number of nodes on which to perform an early read operation while writing each blob.\nEarly read operations are only rarely performed.\nFor realistic experiments, leave this parameter unset.","x-found-in":"query"},"max_blob_size":{"$ref":"./_types.json#/$defs/_types__ByteSize","description":"The maximum size of a blob to be written during the test.\nFor realistic experiments, set this parameter to at least `2gb`.","x-found-in":"query"},"max_total_data_size":{"$ref":"./_types.json#/$defs/_types__ByteSize","description":"An upper limit on the total size of all the blobs written during the test.\nFor realistic experiments, set this parameter to at least `1tb`.","x-found-in":"query"},"rare_action_probability":{"type":"number","description":"The probability of performing a rare action such as an early read, an overwrite, or an aborted write on each blob.\nFor realistic experiments, leave this parameter unset.","x-found-in":"query"},"rarely_abort_writes":{"type":"boolean","description":"Indicates whether to rarely cancel writes before they complete.\nFor realistic experiments, leave this parameter unset.","x-found-in":"query"},"read_node_count":{"type":"number","description":"The number of nodes on which to read a blob after writing.\nFor realistic experiments, leave this parameter unset.","x-found-in":"query"},"register_operation_count":{"type":"number","description":"The minimum number of linearizable register operations to perform in total.\nFor realistic experiments, set this parameter to at least `100`.","x-found-in":"query"},"seed":{"type":"number","description":"The seed for the pseudo-random number generator used to generate the list of operations performed during the test.\nTo repeat the same set of operations in multiple experiments, use the same seed in each experiment.\nNote that the operations are performed concurrently so might not always happen in the same order on each run.\nFor realistic experiments, leave this parameter unset.","x-found-in":"query"},"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period of time to wait for the test to complete.\nIf no response is received before the timeout expires, the test is cancelled and returns an error.\nFor realistic experiments, set this parameter sufficiently long to allow the test to complete.","x-found-in":"query"},"repository":{"type":"string","description":"The name of the repository.","x-found-in":"path"}},"required":["repository"],"description":"Analyze a snapshot repository.\n\nPerforms operations on a snapshot repository in order to check for incorrect behaviour.\n\nThere are a large number of third-party storage systems available, not all of which are suitable for use as a snapshot repository by Elasticsearch.\nSome storage systems behave incorrectly, or perform poorly, especially when accessed concurrently by multiple clients as the nodes of an Elasticsearch cluster do.\nThis API performs a collection of read and write operations on your repository which are designed to detect incorrect behaviour and to measure the performance characteristics of your storage system.\n\nThe default values for the parameters are deliberately low to reduce the impact of running an analysis inadvertently and to provide a sensible starting point for your investigations.\nRun your first analysis with the default parameter values to check for simple problems.\nSome repositories may behave correctly when lightly loaded but incorrectly under production-like workloads.\nIf the first analysis is successful, run a sequence of increasingly large analyses until you encounter a failure or you reach a `blob_count` of at least `2000`, a `max_blob_size` of at least `2gb`, a `max_total_data_size` of at least `1tb`, and a `register_operation_count` of at least `100`.\nAlways specify a generous timeout, possibly `1h` or longer, to allow time for each analysis to run to completion.\nSome repositories may behave correctly when accessed by a small number of Elasticsearch nodes but incorrectly when accessed concurrently by a production-scale cluster.\nPerform the analyses using a multi-node cluster of a similar size to your production cluster so that it can detect any problems that only arise when the repository is accessed by many nodes at once.\n\nIf the analysis fails, Elasticsearch detected that your repository behaved unexpectedly.\nThis usually means you are using a third-party storage system with an incorrect or incompatible implementation of the API it claims to support.\nIf so, this storage system is not suitable for use as a snapshot repository.\nRepository analysis triggers conditions that occur only rarely when taking snapshots in a production system.\nSnapshotting to unsuitable storage may appear to work correctly most of the time despite repository analysis failures.\nHowever your snapshot data is at risk if you store it in a snapshot repository that does not reliably pass repository analysis.\nYou can demonstrate that the analysis failure is due to an incompatible storage implementation by verifying that Elasticsearch does not detect the same problem when analysing the reference implementation of the storage protocol you are using.\nFor instance, if you are using storage that offers an API which the supplier claims to be compatible with AWS S3, verify that repositories in AWS S3 do not fail repository analysis.\nThis allows you to demonstrate to your storage supplier that a repository analysis failure must only be caused by an incompatibility with AWS S3 and cannot be attributed to a problem in Elasticsearch.\nPlease do not report Elasticsearch issues involving third-party storage systems unless you can demonstrate that the same issue exists when analysing a repository that uses the reference implementation of the same storage protocol.\nYou will need to work with the supplier of your storage system to address the incompatibilities that Elasticsearch detects.\n\nThe analysis may also report a failure if your repository experienced a service disruption while the analysis was running.\nIn practice, occasional service disruptions are inevitable, but the analysis cannot itself distinguish such disruptions from incorrect behavior so must report all deviations from the expected behavior as failures.\nIf you are certain that you can ascribe an analysis failure to such a service disruption, wait for your service provider to resolve the disruption and then re-run the analysis.\nElasticsearch will be unable to create or restore snapshots during repository service disruptions, so you must ensure that these events occur only very rarely.\n\nIf the analysis is successful, the API returns details of the testing process, optionally including how long each operation took.\nYou can use this information to determine the performance of your storage system.\nIf any operation fails or returns an incorrect result, the API returns an error.\nIf the API returns an error, it may not have removed all the data it wrote to the repository.\nThe error will indicate the location of any leftover data and this path is also recorded in the Elasticsearch logs.\nYou should verify that this location has been cleaned up correctly.\nIf there is still leftover data at the specified location, you should manually remove it.\n\nIf the connection from your client to Elasticsearch is closed while the client is waiting for the result of the analysis, the test is cancelled.\nSome clients are configured to close their connection if no response is received within a certain timeout.\nAn analysis takes a long time to complete so you might need to relax any such client-side timeouts.\nOn cancellation the analysis attempts to clean up the data it was writing, but it may not be able to remove it all.\nThe path to the leftover data is recorded in the Elasticsearch logs.\nYou should verify that this location has been cleaned up correctly.\nIf there is still leftover data at the specified location, you should manually remove it.\n\nIf the analysis is successful then it detected no incorrect behaviour, but this does not mean that correct behaviour is guaranteed.\nThe analysis attempts to detect common bugs but it does not offer 100% coverage.\nAdditionally, it does not test the following:\n\n* Your repository must perform durable writes. Once a blob has been written it must remain in place until it is deleted, even after a power loss or similar disaster.\n* Your repository must not suffer from silent data corruption. Once a blob has been written, its contents must remain unchanged until it is deliberately modified or deleted.\n* Your repository must behave correctly even if connectivity from the cluster is disrupted. Reads and writes may fail in this case, but they must not return incorrect results.\n\nIMPORTANT: An analysis writes a substantial amount of data to your repository and then reads it back again.\nThis consumes bandwidth on the network between the cluster and the repository, and storage space and I/O bandwidth on the repository itself.\nYou must ensure this load does not affect other users of these systems.\nAnalyses respect the repository settings `max_snapshot_bytes_per_sec` and `max_restore_bytes_per_sec` if available and the cluster setting `indices.recovery.max_bytes_per_sec` which you can use to limit the bandwidth they consume.\n\nNOTE: This API is intended for exploratory use by humans.\nYou should expect the request parameters and the response format to vary in future versions.\nThe response exposes immplementation details of the analysis which may change from version to version.\n\nNOTE: Different versions of Elasticsearch may perform different checks for repository compatibility, with newer versions typically being stricter than older ones.\nA storage system that passes repository analysis with one version of Elasticsearch may fail with a different version.\nThis indicates it behaves incorrectly in ways that the former version did not detect.\nYou must work with the supplier of your storage system to address the incompatibilities detected by the repository analysis API in any version of Elasticsearch.\n\nNOTE: This API may not work correctly in a mixed-version cluster.\n\n*Implementation details*\n\nNOTE: This section of documentation describes how the repository analysis API works in this version of Elasticsearch, but you should expect the implementation to vary between versions.\nThe request parameters and response format depend on details of the implementation so may also be different in newer versions.\n\nThe analysis comprises a number of blob-level tasks, as set by the `blob_count` parameter and a number of compare-and-exchange operations on linearizable registers, as set by the `register_operation_count` parameter.\nThese tasks are distributed over the data and master-eligible nodes in the cluster for execution.\n\nFor most blob-level tasks, the executing node first writes a blob to the repository and then instructs some of the other nodes in the cluster to attempt to read the data it just wrote.\nThe size of the blob is chosen randomly, according to the `max_blob_size` and `max_total_data_size` parameters.\nIf any of these reads fails then the repository does not implement the necessary read-after-write semantics that Elasticsearch requires.\n\nFor some blob-level tasks, the executing node will instruct some of its peers to attempt to read the data before the writing process completes.\nThese reads are permitted to fail, but must not return partial data.\nIf any read returns partial data then the repository does not implement the necessary atomicity semantics that Elasticsearch requires.\n\nFor some blob-level tasks, the executing node will overwrite the blob while its peers are reading it.\nIn this case the data read may come from either the original or the overwritten blob, but the read operation must not return partial data or a mix of data from the two blobs.\nIf any of these reads returns partial data or a mix of the two blobs then the repository does not implement the necessary atomicity semantics that Elasticsearch requires for overwrites.\n\nThe executing node will use a variety of different methods to write the blob.\nFor instance, where applicable, it will use both single-part and multi-part uploads.\nSimilarly, the reading nodes will use a variety of different methods to read the data back again.\nFor instance they may read the entire blob from start to end or may read only a subset of the data.\n\nFor some blob-level tasks, the executing node will cancel the write before it is complete.\nIn this case, it still instructs some of the other nodes in the cluster to attempt to read the blob but all of these reads must fail to find the blob.\n\nLinearizable registers are special blobs that Elasticsearch manipulates using an atomic compare-and-exchange operation.\nThis operation ensures correct and strongly-consistent behavior even when the blob is accessed by multiple nodes at the same time.\nThe detailed implementation of the compare-and-exchange operation on linearizable registers varies by repository type.\nRepository analysis verifies that that uncontended compare-and-exchange operations on a linearizable register blob always succeed.\nRepository analysis also verifies that contended operations either succeed or report the contention but do not return incorrect results.\nIf an operation fails due to contention, Elasticsearch retries the operation until it succeeds.\nMost of the compare-and-exchange operations performed by repository analysis atomically increment a counter which is represented as an 8-byte blob.\nSome operations also verify the behavior on small blobs with sizes other than 8 bytes."}

package/src/es/json/snapshot.repository_verify_integrity.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"snapshot.repository_verify_integrity","type":"object","properties":{"name":{"$ref":"./_types.json#/$defs/_types__Names","description":"The name of the snapshot repository.","x-found-in":"path"},"blob_thread_pool_concurrency":{"type":"number","description":"If `verify_blob_contents` is `true`, this parameter specifies how many blobs to verify at once.","x-found-in":"query"},"index_snapshot_verification_concurrency":{"type":"number","description":"The maximum number of index snapshots to verify concurrently within each index verification.","x-found-in":"query"},"index_verification_concurrency":{"type":"number","description":"The number of indices to verify concurrently.\nThe default behavior is to use the entire `snapshot_meta` thread pool.","x-found-in":"query"},"max_bytes_per_sec":{"type":"string","description":"If `verify_blob_contents` is `true`, this parameter specifies the maximum amount of data that Elasticsearch will read from the repository every second.","x-found-in":"query"},"max_failed_shard_snapshots":{"type":"number","description":"The number of shard snapshot failures to track during integrity verification, in order to avoid excessive resource usage.\nIf your repository contains more than this number of shard snapshot failures, the verification will fail.","x-found-in":"query"},"meta_thread_pool_concurrency":{"type":"number","description":"The maximum number of snapshot metadata operations to run concurrently.\nThe default behavior is to use at most half of the `snapshot_meta` thread pool at once.","x-found-in":"query"},"snapshot_verification_concurrency":{"type":"number","description":"The number of snapshots to verify concurrently.\nThe default behavior is to use at most half of the `snapshot_meta` thread pool at once.","x-found-in":"query"},"verify_blob_contents":{"type":"boolean","description":"Indicates whether to verify the checksum of every data blob in the repository.\nIf this feature is enabled, Elasticsearch will read the entire repository contents, which may be extremely slow and expensive.","x-found-in":"query"}},"required":["name"],"description":"Verify the repository integrity.\n\nVerify the integrity of the contents of a snapshot repository.\n\nThis API enables you to perform a comprehensive check of the contents of a repository, looking for any anomalies in its data or metadata which might prevent you from restoring snapshots from the repository or which might cause future snapshot create or delete operations to fail.\n\nIf you suspect the integrity of the contents of one of your snapshot repositories, cease all write activity to this repository immediately, set its `read_only` option to `true`, and use this API to verify its integrity.\nUntil you do so:\n\n* It may not be possible to restore some snapshots from this repository.\n* Searchable snapshots may report errors when searched or may have unassigned shards.\n* Taking snapshots into this repository may fail or may appear to succeed but have created a snapshot which cannot be restored.\n* Deleting snapshots from this repository may fail or may appear to succeed but leave the underlying data on disk.\n* Continuing to write to the repository while it is in an invalid state may causing additional damage to its contents.\n\nIf the API finds any problems with the integrity of the contents of your repository, Elasticsearch will not be able to repair the damage.\nThe only way to bring the repository back into a fully working state after its contents have been damaged is by restoring its contents from a repository backup which was taken before the damage occurred.\nYou must also identify what caused the damage and take action to prevent it from happening again.\n\nIf you cannot restore a repository backup, register a new repository and use this for all future snapshot operations.\nIn some cases it may be possible to recover some of the contents of a damaged repository, either by restoring as many of its snapshots as needed and taking new snapshots of the restored data, or by using the reindex API to copy data from any searchable snapshots mounted from the damaged repository.\n\nAvoid all operations which write to the repository while the verify repository integrity API is running.\nIf something changes the repository contents while an integrity verification is running then Elasticsearch may incorrectly report having detected some anomalies in its contents due to the concurrent writes.\nIt may also incorrectly fail to report some anomalies that the concurrent writes prevented it from detecting.\n\nNOTE: This API is intended for exploratory use by humans. You should expect the request parameters and the response format to vary in future versions.\n\nNOTE: This API may not work correctly in a mixed-version cluster.\n\nThe default values for the parameters of this API are designed to limit the impact of the integrity verification on other activities in your cluster.\nFor instance, by default it will only use at most half of the `snapshot_meta` threads to verify the integrity of each snapshot, allowing other snapshot operations to use the other half of this thread pool.\nIf you modify these parameters to speed up the verification process, you risk disrupting other snapshot-related operations in your cluster.\nFor large repositories, consider setting up a separate single-node Elasticsearch cluster just for running the integrity verification API.\n\nThe response exposes implementation details of the analysis which may change from version to version.\nThe response body format is therefore not considered stable and may be different in newer versions."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"snapshot.repository_verify_integrity","type":"object","properties":{"blob_thread_pool_concurrency":{"type":"number","description":"If `verify_blob_contents` is `true`, this parameter specifies how many blobs to verify at once.","x-found-in":"query"},"index_snapshot_verification_concurrency":{"type":"number","description":"The maximum number of index snapshots to verify concurrently within each index verification.","x-found-in":"query"},"index_verification_concurrency":{"type":"number","description":"The number of indices to verify concurrently.\nThe default behavior is to use the entire `snapshot_meta` thread pool.","x-found-in":"query"},"max_bytes_per_sec":{"type":"string","description":"If `verify_blob_contents` is `true`, this parameter specifies the maximum amount of data that Elasticsearch will read from the repository every second.","x-found-in":"query"},"max_failed_shard_snapshots":{"type":"number","description":"The number of shard snapshot failures to track during integrity verification, in order to avoid excessive resource usage.\nIf your repository contains more than this number of shard snapshot failures, the verification will fail.","x-found-in":"query"},"meta_thread_pool_concurrency":{"type":"number","description":"The maximum number of snapshot metadata operations to run concurrently.\nThe default behavior is to use at most half of the `snapshot_meta` thread pool at once.","x-found-in":"query"},"snapshot_verification_concurrency":{"type":"number","description":"The number of snapshots to verify concurrently.\nThe default behavior is to use at most half of the `snapshot_meta` thread pool at once.","x-found-in":"query"},"verify_blob_contents":{"type":"boolean","description":"Indicates whether to verify the checksum of every data blob in the repository.\nIf this feature is enabled, Elasticsearch will read the entire repository contents, which may be extremely slow and expensive.","x-found-in":"query"},"repository":{"$ref":"./_types.json#/$defs/_types__Names","description":"The name of the snapshot repository.","x-found-in":"path"}},"required":["repository"],"description":"Verify the repository integrity.\n\nVerify the integrity of the contents of a snapshot repository.\n\nThis API enables you to perform a comprehensive check of the contents of a repository, looking for any anomalies in its data or metadata which might prevent you from restoring snapshots from the repository or which might cause future snapshot create or delete operations to fail.\n\nIf you suspect the integrity of the contents of one of your snapshot repositories, cease all write activity to this repository immediately, set its `read_only` option to `true`, and use this API to verify its integrity.\nUntil you do so:\n\n* It may not be possible to restore some snapshots from this repository.\n* Searchable snapshots may report errors when searched or may have unassigned shards.\n* Taking snapshots into this repository may fail or may appear to succeed but have created a snapshot which cannot be restored.\n* Deleting snapshots from this repository may fail or may appear to succeed but leave the underlying data on disk.\n* Continuing to write to the repository while it is in an invalid state may causing additional damage to its contents.\n\nIf the API finds any problems with the integrity of the contents of your repository, Elasticsearch will not be able to repair the damage.\nThe only way to bring the repository back into a fully working state after its contents have been damaged is by restoring its contents from a repository backup which was taken before the damage occurred.\nYou must also identify what caused the damage and take action to prevent it from happening again.\n\nIf you cannot restore a repository backup, register a new repository and use this for all future snapshot operations.\nIn some cases it may be possible to recover some of the contents of a damaged repository, either by restoring as many of its snapshots as needed and taking new snapshots of the restored data, or by using the reindex API to copy data from any searchable snapshots mounted from the damaged repository.\n\nAvoid all operations which write to the repository while the verify repository integrity API is running.\nIf something changes the repository contents while an integrity verification is running then Elasticsearch may incorrectly report having detected some anomalies in its contents due to the concurrent writes.\nIt may also incorrectly fail to report some anomalies that the concurrent writes prevented it from detecting.\n\nNOTE: This API is intended for exploratory use by humans. You should expect the request parameters and the response format to vary in future versions.\n\nNOTE: This API may not work correctly in a mixed-version cluster.\n\nThe default values for the parameters of this API are designed to limit the impact of the integrity verification on other activities in your cluster.\nFor instance, by default it will only use at most half of the `snapshot_meta` threads to verify the integrity of each snapshot, allowing other snapshot operations to use the other half of this thread pool.\nIf you modify these parameters to speed up the verification process, you risk disrupting other snapshot-related operations in your cluster.\nFor large repositories, consider setting up a separate single-node Elasticsearch cluster just for running the integrity verification API.\n\nThe response exposes implementation details of the analysis which may change from version to version.\nThe response body format is therefore not considered stable and may be different in newer versions."}

package/src/es/json/snapshot.restore.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"snapshot.restore","type":"object","properties":{"repository":{"type":"string","description":"The name of the repository to restore a snapshot from.","x-found-in":"path"},"snapshot":{"type":"string","description":"The name of the snapshot to restore.","x-found-in":"path"},"master_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period to wait for the master node.\nIf the master node is not available before the timeout expires, the request fails and returns an error.\nTo indicate that the request should never timeout, set it to `-1`.","x-found-in":"query"},"wait_for_completion":{"type":"boolean","description":"If `true`, the request returns a response when the restore operation completes.\nThe operation is complete when it finishes all attempts to recover primary shards for restored indices.\nThis applies even if one or more of the recovery attempts fail.\n\nIf `false`, the request returns a response when the restore operation initializes.","x-found-in":"query"},"feature_states":{"type":"array","items":{"type":"string"},"description":"The feature states to restore.\nIf `include_global_state` is `true`, the request restores all feature states in the snapshot by default.\nIf `include_global_state` is `false`, the request restores no feature states by default.\nNote that specifying an empty array will result in the default behavior.\nTo restore no feature states, regardless of the `include_global_state` value, specify an array containing only the value `none` (`[\"none\"]`).","x-found-in":"body"},"ignore_index_settings":{"type":"array","items":{"type":"string"},"description":"The index settings to not restore from the snapshot.\nYou can't use this option to ignore `index.number_of_shards`.\n\nFor data streams, this option applies only to restored backing indices.\nNew backing indices are configured using the data stream's matching index template.","x-found-in":"body"},"ignore_unavailable":{"type":"boolean","description":"If `true`, the request ignores any index or data stream in indices that's missing from the snapshot.\nIf `false`, the request returns an error for any missing index or data stream.","x-found-in":"body"},"include_aliases":{"type":"boolean","description":"If `true`, the request restores aliases for any restored data streams and indices.\nIf `false`, the request doesn’t restore aliases.","x-found-in":"body"},"include_global_state":{"type":"boolean","description":"If `true`, restore the cluster state. The cluster state includes:\n\n* Persistent cluster settings\n* Index templates\n* Legacy index templates\n* Ingest pipelines\n* Index lifecycle management (ILM) policies\n* Stored scripts\n* For snapshots taken after 7.12.0, feature states\n\nIf `include_global_state` is `true`, the restore operation merges the legacy index templates in your cluster with the templates contained in the snapshot, replacing any existing ones whose name matches one in the snapshot.\nIt completely removes all persistent settings, non-legacy index templates, ingest pipelines, and ILM lifecycle policies that exist in your cluster and replaces them with the corresponding items from the snapshot.\n\nUse the `feature_states` parameter to configure how feature states are restored.\n\nIf `include_global_state` is `true` and a snapshot was created without a global state then the restore request will fail.","x-found-in":"body"},"index_settings":{"$ref":"./indices._types.json#/$defs/indices._types__IndexSettings","description":"Index settings to add or change in restored indices, including backing indices.\nYou can't use this option to change `index.number_of_shards`.\n\nFor data streams, this option applies only to restored backing indices.\nNew backing indices are configured using the data stream's matching index template.","x-found-in":"body"},"indices":{"$ref":"./_types.json#/$defs/_types__Indices","description":"A comma-separated list of indices and data streams to restore.\nIt supports a multi-target syntax.\nThe default behavior is all regular indices and regular data streams in the snapshot.\n\nYou can't use this parameter to restore system indices or system data streams.\nUse `feature_states` instead.","x-found-in":"body"},"partial":{"type":"boolean","description":"If `false`, the entire restore operation will fail if one or more indices included in the snapshot do not have all primary shards available.\n\nIf true, it allows restoring a partial snapshot of indices with unavailable shards.\nOnly shards that were successfully included in the snapshot will be restored.\nAll missing shards will be recreated as empty.","x-found-in":"body"},"rename_pattern":{"type":"string","description":"A rename pattern to apply to restored data streams and indices.\nData streams and indices matching the rename pattern will be renamed according to `rename_replacement`.\n\nThe rename pattern is applied as defined by the regular expression that supports referencing the original text, according to the `appendReplacement` logic.","x-found-in":"body"},"rename_replacement":{"type":"string","description":"The rename replacement string that is used with the `rename_pattern`.","x-found-in":"body"}},"required":["repository","snapshot"],"description":"Restore a snapshot.\n\nRestore a snapshot of a cluster or data streams and indices.\n\nYou can restore a snapshot only to a running cluster with an elected master node.\nThe snapshot repository must be registered and available to the cluster.\nThe snapshot and cluster versions must be compatible.\n\nTo restore a snapshot, the cluster's global metadata must be writable. Ensure there are't any cluster blocks that prevent writes. The restore operation ignores index blocks.\n\nBefore you restore a data stream, ensure the cluster contains a matching index template with data streams enabled. To check, use the index management feature in Kibana or the get index template API:\n\n```\nGET _index_template/*?filter_path=index_templates.name,index_templates.index_template.index_patterns,index_templates.index_template.data_stream\n```\n\nIf no such template exists, you can create one or restore a cluster state that contains one. Without a matching index template, a data stream can't roll over or create backing indices.\n\nIf your snapshot contains data from App Search or Workplace Search, you must restore the Enterprise Search encryption key before you restore the snapshot."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"snapshot.restore","type":"object","properties":{"master_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period to wait for the master node.\nIf the master node is not available before the timeout expires, the request fails and returns an error.\nTo indicate that the request should never timeout, set it to `-1`.","x-found-in":"query"},"wait_for_completion":{"type":"boolean","description":"If `true`, the request returns a response when the restore operation completes.\nThe operation is complete when it finishes all attempts to recover primary shards for restored indices.\nThis applies even if one or more of the recovery attempts fail.\n\nIf `false`, the request returns a response when the restore operation initializes.","x-found-in":"query"},"feature_states":{"type":"array","items":{"type":"string"},"description":"The feature states to restore.\nIf `include_global_state` is `true`, the request restores all feature states in the snapshot by default.\nIf `include_global_state` is `false`, the request restores no feature states by default.\nNote that specifying an empty array will result in the default behavior.\nTo restore no feature states, regardless of the `include_global_state` value, specify an array containing only the value `none` (`[\"none\"]`).","x-found-in":"body"},"ignore_index_settings":{"type":"array","items":{"type":"string"},"description":"The index settings to not restore from the snapshot.\nYou can't use this option to ignore `index.number_of_shards`.\n\nFor data streams, this option applies only to restored backing indices.\nNew backing indices are configured using the data stream's matching index template.","x-found-in":"body"},"ignore_unavailable":{"type":"boolean","description":"If `true`, the request ignores any index or data stream in indices that's missing from the snapshot.\nIf `false`, the request returns an error for any missing index or data stream.","x-found-in":"body"},"include_aliases":{"type":"boolean","description":"If `true`, the request restores aliases for any restored data streams and indices.\nIf `false`, the request doesn’t restore aliases.","x-found-in":"body"},"include_global_state":{"type":"boolean","description":"If `true`, restore the cluster state. The cluster state includes:\n\n* Persistent cluster settings\n* Index templates\n* Legacy index templates\n* Ingest pipelines\n* Index lifecycle management (ILM) policies\n* Stored scripts\n* For snapshots taken after 7.12.0, feature states\n\nIf `include_global_state` is `true`, the restore operation merges the legacy index templates in your cluster with the templates contained in the snapshot, replacing any existing ones whose name matches one in the snapshot.\nIt completely removes all persistent settings, non-legacy index templates, ingest pipelines, and ILM lifecycle policies that exist in your cluster and replaces them with the corresponding items from the snapshot.\n\nUse the `feature_states` parameter to configure how feature states are restored.\n\nIf `include_global_state` is `true` and a snapshot was created without a global state then the restore request will fail.","x-found-in":"body"},"index_settings":{"$ref":"./indices._types.json#/$defs/indices._types__IndexSettings","description":"Index settings to add or change in restored indices, including backing indices.\nYou can't use this option to change `index.number_of_shards`.\n\nFor data streams, this option applies only to restored backing indices.\nNew backing indices are configured using the data stream's matching index template.","x-found-in":"body"},"indices":{"$ref":"./_types.json#/$defs/_types__Indices","description":"A comma-separated list of indices and data streams to restore.\nIt supports a multi-target syntax.\nThe default behavior is all regular indices and regular data streams in the snapshot.\n\nYou can't use this parameter to restore system indices or system data streams.\nUse `feature_states` instead.","x-found-in":"body"},"partial":{"type":"boolean","description":"If `false`, the entire restore operation will fail if one or more indices included in the snapshot do not have all primary shards available.\n\nIf true, it allows restoring a partial snapshot of indices with unavailable shards.\nOnly shards that were successfully included in the snapshot will be restored.\nAll missing shards will be recreated as empty.","x-found-in":"body"},"rename_pattern":{"type":"string","description":"A rename pattern to apply to restored data streams and indices.\nData streams and indices matching the rename pattern will be renamed according to `rename_replacement`.\n\nThe rename pattern is applied as defined by the regular expression that supports referencing the original text, according to the `appendReplacement` logic.","x-found-in":"body"},"rename_replacement":{"type":"string","description":"The rename replacement string that is used with the `rename_pattern`.","x-found-in":"body"},"repository":{"type":"string","description":"The name of the repository to restore a snapshot from.","x-found-in":"path"},"snapshot":{"type":"string","description":"The name of the snapshot to restore.","x-found-in":"path"}},"required":["repository","snapshot"],"description":"Restore a snapshot.\n\nRestore a snapshot of a cluster or data streams and indices.\n\nYou can restore a snapshot only to a running cluster with an elected master node.\nThe snapshot repository must be registered and available to the cluster.\nThe snapshot and cluster versions must be compatible.\n\nTo restore a snapshot, the cluster's global metadata must be writable. Ensure there are't any cluster blocks that prevent writes. The restore operation ignores index blocks.\n\nBefore you restore a data stream, ensure the cluster contains a matching index template with data streams enabled. To check, use the index management feature in Kibana or the get index template API:\n\n```\nGET _index_template/*?filter_path=index_templates.name,index_templates.index_template.index_patterns,index_templates.index_template.data_stream\n```\n\nIf no such template exists, you can create one or restore a cluster state that contains one. Without a matching index template, a data stream can't roll over or create backing indices.\n\nIf your snapshot contains data from App Search or Workplace Search, you must restore the Enterprise Search encryption key before you restore the snapshot."}

package/src/es/json/snapshot.status.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"snapshot.status","type":"object","properties":{"repository":{"type":"string","description":"The snapshot repository name used to limit the request.\nIt supports wildcards (`*`) if `<snapshot>` isn't specified.","x-found-in":"path"},"snapshot":{"$ref":"./_types.json#/$defs/_types__Names","description":"A comma-separated list of snapshots to retrieve status for.\nThe default is currently running snapshots.\nWildcards (`*`) are not supported.","x-found-in":"path"},"ignore_unavailable":{"type":"boolean","description":"If `false`, the request returns an error for any snapshots that are unavailable.\nIf `true`, the request ignores snapshots that are unavailable, such as those that are corrupted or temporarily cannot be returned.","x-found-in":"query"},"master_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period to wait for the master node.\nIf the master node is not available before the timeout expires, the request fails and returns an error.\nTo indicate that the request should never timeout, set it to `-1`.","x-found-in":"query"}},"description":"Get the snapshot status.\n\nGet a detailed description of the current state for each shard participating in the snapshot.\n\nNote that this API should be used only to obtain detailed shard-level information for ongoing snapshots.\nIf this detail is not needed or you want to obtain information about one or more existing snapshots, use the get snapshot API.\n\nIf you omit the `<snapshot>` request path parameter, the request retrieves information only for currently running snapshots.\nThis usage is preferred.\nIf needed, you can specify `<repository>` and `<snapshot>` to retrieve information for specific snapshots, even if they're not currently running.\n\nNote that the stats will not be available for any shard snapshots in an ongoing snapshot completed by a node that (even momentarily) left the cluster.\nLoading the stats from the repository is an expensive operation (see the WARNING below).\nTherefore the stats values for such shards will be -1 even though the \"stage\" value will be \"DONE\", in order to minimize latency.\nA \"description\" field will be present for a shard snapshot completed by a departed node explaining why the shard snapshot's stats results are invalid.\nConsequently, the total stats for the index will be less than expected due to the missing values from these shards.\n\nWARNING: Using the API to return the status of any snapshots other than currently running snapshots can be expensive.\nThe API requires a read from the repository for each shard in each snapshot.\nFor example, if you have 100 snapshots with 1,000 shards each, an API request that includes all snapshots will require 100,000 reads (100 snapshots x 1,000 shards).\n\nDepending on the latency of your storage, such requests can take an extremely long time to return results.\nThese requests can also tax machine resources and, when using cloud storage, incur high processing costs."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"snapshot.status","type":"object","properties":{"ignore_unavailable":{"type":"boolean","description":"If `false`, the request returns an error for any snapshots that are unavailable.\nIf `true`, the request ignores snapshots that are unavailable, such as those that are corrupted or temporarily cannot be returned.","x-found-in":"query"},"master_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period to wait for the master node.\nIf the master node is not available before the timeout expires, the request fails and returns an error.\nTo indicate that the request should never timeout, set it to `-1`.","x-found-in":"query"},"repository":{"type":"string","description":"The snapshot repository name used to limit the request.\nIt supports wildcards (`*`) if `<snapshot>` isn't specified.","x-found-in":"path"},"snapshot":{"$ref":"./_types.json#/$defs/_types__Names","description":"A comma-separated list of snapshots to retrieve status for.\nThe default is currently running snapshots.\nWildcards (`*`) are not supported.","x-found-in":"path"}},"description":"Get the snapshot status.\n\nGet a detailed description of the current state for each shard participating in the snapshot.\n\nNote that this API should be used only to obtain detailed shard-level information for ongoing snapshots.\nIf this detail is not needed or you want to obtain information about one or more existing snapshots, use the get snapshot API.\n\nIf you omit the `<snapshot>` request path parameter, the request retrieves information only for currently running snapshots.\nThis usage is preferred.\nIf needed, you can specify `<repository>` and `<snapshot>` to retrieve information for specific snapshots, even if they're not currently running.\n\nNote that the stats will not be available for any shard snapshots in an ongoing snapshot completed by a node that (even momentarily) left the cluster.\nLoading the stats from the repository is an expensive operation (see the WARNING below).\nTherefore the stats values for such shards will be -1 even though the \"stage\" value will be \"DONE\", in order to minimize latency.\nA \"description\" field will be present for a shard snapshot completed by a departed node explaining why the shard snapshot's stats results are invalid.\nConsequently, the total stats for the index will be less than expected due to the missing values from these shards.\n\nWARNING: Using the API to return the status of any snapshots other than currently running snapshots can be expensive.\nThe API requires a read from the repository for each shard in each snapshot.\nFor example, if you have 100 snapshots with 1,000 shards each, an API request that includes all snapshots will require 100,000 reads (100 snapshots x 1,000 shards).\n\nDepending on the latency of your storage, such requests can take an extremely long time to return results.\nThese requests can also tax machine resources and, when using cloud storage, incur high processing costs."}

package/src/es/json/snapshot.verify_repository.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"snapshot.verify_repository","type":"object","properties":{"name":{"type":"string","description":"The name of the snapshot repository to verify.","x-found-in":"path"},"master_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period to wait for the master node.\nIf the master node is not available before the timeout expires, the request fails and returns an error.\nTo indicate that the request should never timeout, set it to `-1`.","x-found-in":"query"},"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period to wait for a response from all relevant nodes in the cluster after updating the cluster metadata.\nIf no response is received before the timeout expires, the cluster metadata update still applies but the response will indicate that it was not completely acknowledged.\nTo indicate that the request should never timeout, set it to `-1`.","x-found-in":"query"}},"required":["name"],"description":"Verify a snapshot repository.\n\nCheck for common misconfigurations in a snapshot repository."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"snapshot.verify_repository","type":"object","properties":{"master_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period to wait for the master node.\nIf the master node is not available before the timeout expires, the request fails and returns an error.\nTo indicate that the request should never timeout, set it to `-1`.","x-found-in":"query"},"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period to wait for a response from all relevant nodes in the cluster after updating the cluster metadata.\nIf no response is received before the timeout expires, the cluster metadata update still applies but the response will indicate that it was not completely acknowledged.\nTo indicate that the request should never timeout, set it to `-1`.","x-found-in":"query"},"repository":{"type":"string","description":"The name of the snapshot repository to verify.","x-found-in":"path"}},"required":["repository"],"description":"Verify a snapshot repository.\n\nCheck for common misconfigurations in a snapshot repository."}

package/src/es/json/sql.get_async.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"sql.get_async","type":"object","properties":{"id":{"type":"string","description":"The identifier for the search.","x-found-in":"path"},"delimiter":{"type":"string","description":"The separator for CSV results.\nThe API supports this parameter only for CSV responses.","x-found-in":"query"},"format":{"type":"string","description":"The format for the response.\nYou must specify a format using this parameter or the `Accept` HTTP header.\nIf you specify both, the API uses this parameter.","x-found-in":"query"},"keep_alive":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The retention period for the search and its results.\nIt defaults to the `keep_alive` period for the original SQL search.","x-found-in":"query"},"wait_for_completion_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period to wait for complete results.\nIt defaults to no timeout, meaning the request waits for complete search results.","x-found-in":"query"}},"required":["id"],"description":"Get async SQL search results.\n\nGet the current status and available results for an async SQL search or stored synchronous SQL search.\n\nIf the Elasticsearch security features are enabled, only the user who first submitted the SQL search can retrieve the search using this API."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"sql.get_async","type":"object","properties":{"delimiter":{"type":"string","description":"The separator for CSV results.\nThe API supports this parameter only for CSV responses.","x-found-in":"query"},"format":{"type":"string","description":"The format for the response.\nYou must specify a format using this parameter or the `Accept` HTTP header.\nIf you specify both, the API uses this parameter.","x-found-in":"query"},"keep_alive":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The retention period for the search and its results.\nIt defaults to the `keep_alive` period for the original SQL search.","x-found-in":"query"},"wait_for_completion_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period to wait for complete results.\nIt defaults to no timeout, meaning the request waits for complete search results.","x-found-in":"query"},"id":{"type":"string","description":"The identifier for the search.","x-found-in":"path"}},"required":["id"],"description":"Get async SQL search results.\n\nGet the current status and available results for an async SQL search or stored synchronous SQL search.\n\nIf the Elasticsearch security features are enabled, only the user who first submitted the SQL search can retrieve the search using this API."}

package/src/es/json/ssl.certificates.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","$defs":{"ssl.certificates__CertificateInformation":{"type":"object","properties":{"alias":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"If the path refers to a container file (a jks keystore, or a PKCS#12 file), it is the alias of the certificate.\nOtherwise, it is null."},"expiry":{"$ref":"./_types.json#/$defs/_types__DateTime","description":"The ISO formatted date of the certificate's expiry (not-after) date."},"format":{"type":"string","description":"The format of the file.\nValid values include `jks`, `PKCS12`, and `PEM`."},"has_private_key":{"type":"boolean","description":"Indicates whether Elasticsearch has access to the private key for this certificate."},"issuer":{"type":"string","description":"The Distinguished Name of the certificate's issuer."},"path":{"type":"string","description":"The path to the certificate, as configured in the `elasticsearch.yml` file."},"serial_number":{"type":"string","description":"The hexadecimal representation of the certificate's serial number."},"subject_dn":{"type":"string","description":"The Distinguished Name of the certificate's subject."}},"required":["alias","expiry","format","has_private_key","path","serial_number","subject_dn"]}}}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","$defs":{"ssl.certificates__CertificateInformation":{"type":"object","properties":{"alias":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"If the path refers to a container file (a jks keystore, or a PKCS#12 file), it is the alias of the certificate.\nOtherwise, it is null."},"expiry":{"$ref":"./_types.json#/$defs/_types__DateTime","description":"The ISO formatted date of the certificate's expiry (not-after) date."},"format":{"type":"string","description":"The format of the file.\nValid values include `jks`, `PKCS12`, and `PEM`."},"has_private_key":{"type":"boolean","description":"Indicates whether Elasticsearch has access to the private key for this certificate."},"issuer":{"type":"string","description":"The Distinguished Name of the certificate's issuer."},"path":{"type":"string","description":"The path to the certificate, as configured in the `elasticsearch.yml` file."},"serial_number":{"type":"string","description":"The hexadecimal representation of the certificate's serial number."},"subject_dn":{"type":"string","description":"The Distinguished Name of the certificate's subject."}},"required":["alias","expiry","format","has_private_key","path","serial_number","subject_dn"]}}}

package/src/es/json/streams.logs_disable.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"streams.logs_disable","type":"object","properties":{"name":{"$ref":"./streams._types.json#/$defs/streams._types__StreamType","description":"The stream type to disable.","x-found-in":"path"},"master_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.","x-found-in":"query"},"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.","x-found-in":"query"}},"required":["name"],"description":"Disable a named stream.\n\nTurn off the named stream feature for this cluster."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"streams.logs_disable","type":"object","properties":{"master_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.","x-found-in":"query"},"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.","x-found-in":"query"},"name":{"$ref":"./streams._types.json#/$defs/streams._types__StreamType","description":"The stream type to disable.","x-found-in":"path"}},"required":["name"],"description":"Disable a named stream.\n\nTurn off the named stream feature for this cluster."}

package/src/es/json/streams.logs_enable.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"streams.logs_enable","type":"object","properties":{"name":{"$ref":"./streams._types.json#/$defs/streams._types__StreamType","description":"The stream type to enable.","x-found-in":"path"},"master_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.","x-found-in":"query"},"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.","x-found-in":"query"}},"required":["name"],"description":"Enable a named stream.\n\nTurn on the named stream feature for this cluster.\n\nNOTE: To protect existing data, this feature can be turned on only if the cluster does not have\nexisting indices or data streams that match the pattern `<name>|<name>.*` for the enabled stream\ntype name. If those indices or data streams exist, a `409 - Conflict` response and error is\nreturned."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"streams.logs_enable","type":"object","properties":{"master_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.","x-found-in":"query"},"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.","x-found-in":"query"},"name":{"$ref":"./streams._types.json#/$defs/streams._types__StreamType","description":"The stream type to enable.","x-found-in":"path"}},"required":["name"],"description":"Enable a named stream.\n\nTurn on the named stream feature for this cluster.\n\nNOTE: To protect existing data, this feature can be turned on only if the cluster does not have\nexisting indices or data streams that match the pattern `<name>|<name>.*` for the enabled stream\ntype name. If those indices or data streams exist, a `409 - Conflict` response and error is\nreturned."}

package/src/es/json/synonyms.delete_synonym_rule.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"synonyms.delete_synonym_rule","type":"object","properties":{"set_id":{"type":"string","description":"The ID of the synonym set to update.","x-found-in":"path"},"rule_id":{"type":"string","description":"The ID of the synonym rule to delete.","x-found-in":"path"},"refresh":{"type":"boolean","description":"If `true`, the request will refresh the analyzers with the deleted synonym rule and wait for the new synonyms to be available before returning.\nIf `false`, analyzers will not be reloaded with the deleted synonym rule","x-found-in":"query"}},"required":["set_id","rule_id"],"description":"Delete a synonym rule.\n\nDelete a synonym rule from a synonym set."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"synonyms.delete_synonym_rule","type":"object","properties":{"refresh":{"type":"boolean","description":"If `true`, the request will refresh the analyzers with the deleted synonym rule and wait for the new synonyms to be available before returning.\nIf `false`, analyzers will not be reloaded with the deleted synonym rule","x-found-in":"query"},"set_id":{"type":"string","description":"The ID of the synonym set to update.","x-found-in":"path"},"rule_id":{"type":"string","description":"The ID of the synonym rule to delete.","x-found-in":"path"}},"required":["set_id","rule_id"],"description":"Delete a synonym rule.\n\nDelete a synonym rule from a synonym set."}

package/src/es/json/synonyms.get_synonym.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"synonyms.get_synonym","type":"object","properties":{"id":{"type":"string","description":"The synonyms set identifier to retrieve.","x-found-in":"path"},"from":{"type":"number","description":"The starting offset for synonym rules to retrieve.","x-found-in":"query"},"size":{"type":"number","description":"The max number of synonym rules to retrieve.","x-found-in":"query"},"search_after":{"type":"string","description":"The synonym rule ID to use as a cursor for pagination.\nThe next page of results will start after this rule ID.\nThis parameter cannot be used with `from`.","x-found-in":"query"}},"required":["id"],"description":"Get a synonym set."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"synonyms.get_synonym","type":"object","properties":{"from":{"type":"number","description":"The starting offset for synonym rules to retrieve.","x-found-in":"query"},"size":{"type":"number","description":"The max number of synonym rules to retrieve.","x-found-in":"query"},"search_after":{"type":"string","description":"The synonym rule ID to use as a cursor for pagination.\nThe next page of results will start after this rule ID.\nThis parameter cannot be used with `from`.","x-found-in":"query"},"id":{"type":"string","description":"The synonyms set identifier to retrieve.","x-found-in":"path"}},"required":["id"],"description":"Get a synonym set."}

package/src/es/json/synonyms.put_synonym.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"synonyms.put_synonym","type":"object","properties":{"id":{"type":"string","description":"The ID of the synonyms set to be created or updated.","x-found-in":"path"},"refresh":{"type":"boolean","description":"If `true`, the request will refresh the analyzers with the new synonyms set and wait for the new synonyms to be available before returning.\nIf `false`, analyzers will not be reloaded with the new synonym set","x-found-in":"query"},"append":{"type":"boolean","description":"If `true`, the provided synonym rules are appended to the existing set, with matching IDs overwriting existing rules.\nIf `false`, the entire synonyms set is replaced with the new synonym rules definitions.","x-found-in":"query"},"synonyms_set":{"oneOf":[{"$ref":"./synonyms._types.json#/$defs/synonyms._types__SynonymRule"},{"type":"array","items":{"$ref":"./synonyms._types.json#/$defs/synonyms._types__SynonymRule"}}],"description":"The synonym rules definitions for the synonyms set.","x-found-in":"body"}},"required":["id","synonyms_set"],"description":"Create or update a synonym set.\n\nSynonym sets are limited to a maximum of 100,000 synonym rules per set by default.\nThis limit is configurable using the `synonyms.max_synonym_rules` cluster setting.\n\nWhen an existing synonyms set is updated, the search analyzers that use the synonyms set are reloaded automatically for all indices.\nThis is equivalent to invoking the reload search analyzers API for all indices that use the synonyms set.\n\nFor practical examples of how to create or update a synonyms set, refer to the External documentation."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"synonyms.put_synonym","type":"object","properties":{"refresh":{"type":"boolean","description":"If `true`, the request will refresh the analyzers with the new synonyms set and wait for the new synonyms to be available before returning.\nIf `false`, analyzers will not be reloaded with the new synonym set","x-found-in":"query"},"append":{"type":"boolean","description":"If `true`, the provided synonym rules are appended to the existing set, with matching IDs overwriting existing rules.\nIf `false`, the entire synonyms set is replaced with the new synonym rules definitions.","x-found-in":"query"},"synonyms_set":{"anyOf":[{"$ref":"./synonyms._types.json#/$defs/synonyms._types__SynonymRule"},{"type":"array","items":{"$ref":"./synonyms._types.json#/$defs/synonyms._types__SynonymRule"}}],"description":"The synonym rules definitions for the synonyms set.","x-found-in":"body"},"id":{"type":"string","description":"The ID of the synonyms set to be created or updated.","x-found-in":"path"}},"required":["id","synonyms_set"],"description":"Create or update a synonym set.\n\nSynonym sets are limited to a maximum of 100,000 synonym rules per set by default.\nThis limit is configurable using the `synonyms.max_synonym_rules` cluster setting.\n\nWhen an existing synonyms set is updated, the search analyzers that use the synonyms set are reloaded automatically for all indices.\nThis is equivalent to invoking the reload search analyzers API for all indices that use the synonyms set.\n\nFor practical examples of how to create or update a synonyms set, refer to the External documentation."}

package/src/es/json/synonyms.put_synonym_rule.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"synonyms.put_synonym_rule","type":"object","properties":{"set_id":{"type":"string","description":"The ID of the synonym set.","x-found-in":"path"},"rule_id":{"type":"string","description":"The ID of the synonym rule to be updated or created.","x-found-in":"path"},"refresh":{"type":"boolean","description":"If `true`, the request will refresh the analyzers with the new synonym rule and wait for the new synonyms to be available before returning.\nIf `false`, analyzers will not be reloaded with the new synonym rule","x-found-in":"query"},"synonyms":{"type":"string","description":"The synonym rule information definition, which must be in Solr format.","x-found-in":"body"}},"required":["set_id","rule_id","synonyms"],"description":"Create or update a synonym rule.\n\nCreate or update a synonym rule in a synonym set.\n\nIf any of the synonym rules included is invalid, the API returns an error.\n\nWhen you update a synonym rule, all analyzers using the synonyms set will be reloaded automatically to reflect the new rule."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"synonyms.put_synonym_rule","type":"object","properties":{"refresh":{"type":"boolean","description":"If `true`, the request will refresh the analyzers with the new synonym rule and wait for the new synonyms to be available before returning.\nIf `false`, analyzers will not be reloaded with the new synonym rule","x-found-in":"query"},"synonyms":{"type":"string","description":"The synonym rule information definition, which must be in Solr format.","x-found-in":"body"},"set_id":{"type":"string","description":"The ID of the synonym set.","x-found-in":"path"},"rule_id":{"type":"string","description":"The ID of the synonym rule to be updated or created.","x-found-in":"path"}},"required":["set_id","rule_id","synonyms"],"description":"Create or update a synonym rule.\n\nCreate or update a synonym rule in a synonym set.\n\nIf any of the synonym rules included is invalid, the API returns an error.\n\nWhen you update a synonym rule, all analyzers using the synonyms set will be reloaded automatically to reflect the new rule."}

package/src/es/json/tasks._types.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","$defs":{"tasks._types__TaskListResponseBase":{"type":"object","properties":{"node_failures":{"type":"array","items":{"$ref":"./_types.json#/$defs/_types__ErrorCause"}},"task_failures":{"type":"array","items":{"$ref":"./_types.json#/$defs/_types__TaskFailure"}},"nodes":{"type":"object","additionalProperties":{"$ref":"./tasks._types.json#/$defs/tasks._types__NodeTasks"},"description":"Task information grouped by node, if `group_by` was set to `node` (the default)."},"tasks":{"$ref":"./tasks._types.json#/$defs/tasks._types__TaskInfos","description":"Either a flat list of tasks if `group_by` was set to `none`, or grouped by parents if\n`group_by` was set to `parents`."}}},"tasks._types__NodeTasks":{"type":"object","properties":{"name":{"type":"string"},"transport_address":{"type":"string"},"host":{"type":"string"},"ip":{"type":"string"},"roles":{"type":"array","items":{"type":"string"}},"attributes":{"type":"object","additionalProperties":{"type":"string"}},"tasks":{"type":"object","additionalProperties":{"$ref":"./tasks._types.json#/$defs/tasks._types__TaskInfo"}}},"required":["tasks"]},"tasks._types__TaskInfo":{"type":"object","properties":{"action":{"type":"string"},"cancelled":{"type":"boolean"},"cancellable":{"type":"boolean"},"description":{"type":"string","description":"Human readable text that identifies the particular request that the task is performing.\nFor example, it might identify the search request being performed by a search task.\nOther kinds of tasks have different descriptions, like `_reindex` which has the source and the destination, or `_bulk` which just has the number of requests and the destination indices.\nMany requests will have only an empty description because more detailed information about the request is not easily available or particularly helpful in identifying the request."},"headers":{"type":"object","additionalProperties":{"type":"string"}},"id":{"type":"number"},"node":{"type":"string"},"running_time":{"$ref":"./_types.json#/$defs/_types__Duration"},"running_time_in_nanos":{},"start_time_in_millis":{},"status":{"description":"The internal status of the task, which varies from task to task.\nThe format also varies.\nWhile the goal is to keep the status for a particular task consistent from version to version, this is not always possible because sometimes the implementation changes.\nFields might be removed from the status for a particular request so any parsing you do of the status might break in minor releases."},"type":{"type":"string"},"parent_task_id":{"type":"string"},"original_task_id":{"type":"string","description":"The task ID of the original task. Only present when the task is continuing the work of an earlier task that was running on a node which has since shut down (i.e. a relocatable task).\nFor tasks that have not been relocated this is always equal to the task's own ID and is omitted from the response."},"original_start_time_in_millis":{"description":"The time at which the original task started, in milliseconds since the Unix epoch. Only present together with `original_task_id`."},"original_start_time":{"type":"string","description":"The time at which the original task started, as an ISO 8601 formatted string. Only present together with `original_task_id` and when the request includes the `?human=true` query parameter."}},"required":["action","cancellable","headers","id","node","running_time_in_nanos","start_time_in_millis","type"]},"tasks._types__TaskInfos":{"oneOf":[{"type":"array","items":{"$ref":"./tasks._types.json#/$defs/tasks._types__TaskInfo"}},{"type":"object","additionalProperties":{"$ref":"./tasks._types.json#/$defs/tasks._types__ParentTaskInfo"}}]},"tasks._types__ParentTaskInfo":{"type":"object","properties":{"action":{"type":"string"},"cancelled":{"type":"boolean"},"cancellable":{"type":"boolean"},"description":{"type":"string","description":"Human readable text that identifies the particular request that the task is performing.\nFor example, it might identify the search request being performed by a search task.\nOther kinds of tasks have different descriptions, like `_reindex` which has the source and the destination, or `_bulk` which just has the number of requests and the destination indices.\nMany requests will have only an empty description because more detailed information about the request is not easily available or particularly helpful in identifying the request."},"headers":{"type":"object","additionalProperties":{"type":"string"}},"id":{"type":"number"},"node":{"type":"string"},"running_time":{"$ref":"./_types.json#/$defs/_types__Duration"},"running_time_in_nanos":{},"start_time_in_millis":{},"status":{"description":"The internal status of the task, which varies from task to task.\nThe format also varies.\nWhile the goal is to keep the status for a particular task consistent from version to version, this is not always possible because sometimes the implementation changes.\nFields might be removed from the status for a particular request so any parsing you do of the status might break in minor releases."},"type":{"type":"string"},"parent_task_id":{"type":"string"},"original_task_id":{"type":"string","description":"The task ID of the original task. Only present when the task is continuing the work of an earlier task that was running on a node which has since shut down (i.e. a relocatable task).\nFor tasks that have not been relocated this is always equal to the task's own ID and is omitted from the response."},"original_start_time_in_millis":{"description":"The time at which the original task started, in milliseconds since the Unix epoch. Only present together with `original_task_id`."},"original_start_time":{"type":"string","description":"The time at which the original task started, as an ISO 8601 formatted string. Only present together with `original_task_id` and when the request includes the `?human=true` query parameter."},"children":{"type":"array","items":{"$ref":"./tasks._types.json#/$defs/tasks._types__TaskInfo"}}},"required":["action","cancellable","headers","id","node","running_time_in_nanos","start_time_in_millis","type"]},"tasks._types__GroupBy":{"enum":["nodes","parents","none"]}}}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","$defs":{"tasks._types__TaskListResponseBase":{"type":"object","properties":{"node_failures":{"type":"array","items":{"$ref":"./_types.json#/$defs/_types__ErrorCause"}},"task_failures":{"type":"array","items":{"$ref":"./_types.json#/$defs/_types__TaskFailure"}},"nodes":{"type":"object","additionalProperties":{"$ref":"./tasks._types.json#/$defs/tasks._types__NodeTasks"},"description":"Task information grouped by node, if `group_by` was set to `node` (the default)."},"tasks":{"$ref":"./tasks._types.json#/$defs/tasks._types__TaskInfos","description":"Either a flat list of tasks if `group_by` was set to `none`, or grouped by parents if\n`group_by` was set to `parents`."}}},"tasks._types__NodeTasks":{"type":"object","properties":{"name":{"type":"string"},"transport_address":{"type":"string"},"host":{"type":"string"},"ip":{"type":"string"},"roles":{"type":"array","items":{"type":"string"}},"attributes":{"type":"object","additionalProperties":{"type":"string"}},"tasks":{"type":"object","additionalProperties":{"$ref":"./tasks._types.json#/$defs/tasks._types__TaskInfo"}}},"required":["tasks"]},"tasks._types__TaskInfo":{"type":"object","properties":{"action":{"type":"string"},"cancelled":{"type":"boolean"},"cancellable":{"type":"boolean"},"description":{"type":"string","description":"Human readable text that identifies the particular request that the task is performing.\nFor example, it might identify the search request being performed by a search task.\nOther kinds of tasks have different descriptions, like `_reindex` which has the source and the destination, or `_bulk` which just has the number of requests and the destination indices.\nMany requests will have only an empty description because more detailed information about the request is not easily available or particularly helpful in identifying the request."},"headers":{"type":"object","additionalProperties":{"type":"string"}},"id":{"type":"number"},"node":{"type":"string"},"running_time":{"$ref":"./_types.json#/$defs/_types__Duration"},"running_time_in_nanos":{},"start_time_in_millis":{},"status":{"description":"The internal status of the task, which varies from task to task.\nThe format also varies.\nWhile the goal is to keep the status for a particular task consistent from version to version, this is not always possible because sometimes the implementation changes.\nFields might be removed from the status for a particular request so any parsing you do of the status might break in minor releases."},"type":{"type":"string"},"parent_task_id":{"type":"string"},"original_task_id":{"type":"string","description":"The task ID of the original task. Only present when the task is continuing the work of an earlier task that was running on a node which has since shut down (i.e. a relocatable task).\nFor tasks that have not been relocated this is always equal to the task's own ID and is omitted from the response."},"original_start_time_in_millis":{"description":"The time at which the original task started, in milliseconds since the Unix epoch. Only present together with `original_task_id`."},"original_start_time":{"type":"string","description":"The time at which the original task started, as an ISO 8601 formatted string. Only present together with `original_task_id` and when the request includes the `?human=true` query parameter."}},"required":["action","cancellable","headers","id","node","running_time_in_nanos","start_time_in_millis","type"]},"tasks._types__TaskInfos":{"anyOf":[{"type":"array","items":{"$ref":"./tasks._types.json#/$defs/tasks._types__TaskInfo"}},{"type":"object","additionalProperties":{"$ref":"./tasks._types.json#/$defs/tasks._types__ParentTaskInfo"}}]},"tasks._types__ParentTaskInfo":{"type":"object","properties":{"action":{"type":"string"},"cancelled":{"type":"boolean"},"cancellable":{"type":"boolean"},"description":{"type":"string","description":"Human readable text that identifies the particular request that the task is performing.\nFor example, it might identify the search request being performed by a search task.\nOther kinds of tasks have different descriptions, like `_reindex` which has the source and the destination, or `_bulk` which just has the number of requests and the destination indices.\nMany requests will have only an empty description because more detailed information about the request is not easily available or particularly helpful in identifying the request."},"headers":{"type":"object","additionalProperties":{"type":"string"}},"id":{"type":"number"},"node":{"type":"string"},"running_time":{"$ref":"./_types.json#/$defs/_types__Duration"},"running_time_in_nanos":{},"start_time_in_millis":{},"status":{"description":"The internal status of the task, which varies from task to task.\nThe format also varies.\nWhile the goal is to keep the status for a particular task consistent from version to version, this is not always possible because sometimes the implementation changes.\nFields might be removed from the status for a particular request so any parsing you do of the status might break in minor releases."},"type":{"type":"string"},"parent_task_id":{"type":"string"},"original_task_id":{"type":"string","description":"The task ID of the original task. Only present when the task is continuing the work of an earlier task that was running on a node which has since shut down (i.e. a relocatable task).\nFor tasks that have not been relocated this is always equal to the task's own ID and is omitted from the response."},"original_start_time_in_millis":{"description":"The time at which the original task started, in milliseconds since the Unix epoch. Only present together with `original_task_id`."},"original_start_time":{"type":"string","description":"The time at which the original task started, as an ISO 8601 formatted string. Only present together with `original_task_id` and when the request includes the `?human=true` query parameter."},"children":{"type":"array","items":{"$ref":"./tasks._types.json#/$defs/tasks._types__TaskInfo"}}},"required":["action","cancellable","headers","id","node","running_time_in_nanos","start_time_in_millis","type"]},"tasks._types__GroupBy":{"enum":["nodes","parents","none"]}}}

package/src/es/json/tasks.cancel.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"tasks.cancel","type":"object","properties":{"task_id":{"type":"string","description":"The task identifier.","x-found-in":"path"},"actions":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"A comma-separated list or wildcard expression of actions that is used to limit the request.","x-found-in":"query"},"nodes":{"type":"array","items":{"type":"string"},"description":"A comma-separated list of node IDs or names that is used to limit the request.","x-found-in":"query"},"parent_task_id":{"type":"string","description":"A parent task ID that is used to limit the tasks.","x-found-in":"query"},"wait_for_completion":{"type":"boolean","description":"If true, the request blocks until all found tasks are complete.","x-found-in":"query"}},"description":"Cancel a task.\n\nWARNING: The task management API is new and should still be considered a beta feature.\nThe API may change in ways that are not backwards compatible.\n\nA task may continue to run for some time after it has been cancelled because it may not be able to safely stop its current activity straight away.\nIt is also possible that Elasticsearch must complete its work on other tasks before it can process the cancellation.\nThe get task information API will continue to list these cancelled tasks until they complete.\nThe cancelled flag in the response indicates that the cancellation command has been processed and the task will stop as soon as possible.\n\nTo troubleshoot why a cancelled task does not complete promptly, use the get task information API with the `?detailed` parameter to identify the other tasks the system is running.\nYou can also use the node hot threads API to obtain detailed information about the work the system is doing instead of completing the cancelled task.\n\nFor relocatable tasks, this API transparently follows the task across graceful shutdown relocations,\nso callers can keep using the original task ID. The returned task reports its `original_task_id` and `original_start_time_in_millis`\nif it is continuing work from an earlier task."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"tasks.cancel","type":"object","properties":{"actions":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"A comma-separated list or wildcard expression of actions that is used to limit the request.","x-found-in":"query"},"nodes":{"type":"array","items":{"type":"string"},"description":"A comma-separated list of node IDs or names that is used to limit the request.","x-found-in":"query"},"parent_task_id":{"type":"string","description":"A parent task ID that is used to limit the tasks.","x-found-in":"query"},"wait_for_completion":{"type":"boolean","description":"If true, the request blocks until all found tasks are complete.","x-found-in":"query"},"task_id":{"type":"string","description":"The task identifier.","x-found-in":"path"}},"description":"Cancel a task.\n\nWARNING: The task management API is new and should still be considered a beta feature.\nThe API may change in ways that are not backwards compatible.\n\nA task may continue to run for some time after it has been cancelled because it may not be able to safely stop its current activity straight away.\nIt is also possible that Elasticsearch must complete its work on other tasks before it can process the cancellation.\nThe get task information API will continue to list these cancelled tasks until they complete.\nThe cancelled flag in the response indicates that the cancellation command has been processed and the task will stop as soon as possible.\n\nTo troubleshoot why a cancelled task does not complete promptly, use the get task information API with the `?detailed` parameter to identify the other tasks the system is running.\nYou can also use the node hot threads API to obtain detailed information about the work the system is doing instead of completing the cancelled task.\n\nFor relocatable tasks, this API transparently follows the task across graceful shutdown relocations,\nso callers can keep using the original task ID. The returned task reports its `original_task_id` and `original_start_time_in_millis`\nif it is continuing work from an earlier task."}

package/src/es/json/tasks.get.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"tasks.get","type":"object","properties":{"task_id":{"type":"string","description":"The task identifier.","x-found-in":"path"},"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.","x-found-in":"query"},"wait_for_completion":{"type":"boolean","description":"If `true`, the request blocks until the task has completed.","x-found-in":"query"}},"required":["task_id"],"description":"Get task information.\n\nGet information about a task currently running in the cluster.\n\nWARNING: The task management API is new and should still be considered a beta feature.\nThe API may change in ways that are not backwards compatible.\n\nIf the task identifier is not found, a 404 response code indicates that there are no resources that match the request.\n\nFor relocatable tasks, this API transparently follows the task across graceful shutdown relocations,\nso callers can keep using the original task ID. The returned task reports its `original_task_id` and `original_start_time_in_millis`\nif it is continuing work from an earlier task."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"tasks.get","type":"object","properties":{"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.","x-found-in":"query"},"wait_for_completion":{"type":"boolean","description":"If `true`, the request blocks until the task has completed.","x-found-in":"query"},"task_id":{"type":"string","description":"The task identifier.","x-found-in":"path"}},"required":["task_id"],"description":"Get task information.\n\nGet information about a task currently running in the cluster.\n\nWARNING: The task management API is new and should still be considered a beta feature.\nThe API may change in ways that are not backwards compatible.\n\nIf the task identifier is not found, a 404 response code indicates that there are no resources that match the request.\n\nFor relocatable tasks, this API transparently follows the task across graceful shutdown relocations,\nso callers can keep using the original task ID. The returned task reports its `original_task_id` and `original_start_time_in_millis`\nif it is continuing work from an earlier task."}

package/src/es/json/tasks.list.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"tasks.list","type":"object","properties":{"actions":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"A comma-separated list or wildcard expression of actions used to limit the request.\nFor example, you can use `cluser:*` to retrieve all cluster-related tasks.","x-found-in":"query"},"detailed":{"type":"boolean","description":"If `true`, the response includes detailed information about the running tasks.\nThis information is useful to distinguish tasks from each other but is more costly to run.","x-found-in":"query"},"group_by":{"$ref":"./tasks._types.json#/$defs/tasks._types__GroupBy","description":"A key that is used to group tasks in the response.\nThe task lists can be grouped either by nodes or by parent tasks.","x-found-in":"query"},"nodes":{"$ref":"./_types.json#/$defs/_types__NodeIds","description":"A comma-separated list of node IDs or names that is used to limit the returned information.","x-found-in":"query"},"parent_task_id":{"type":"string","description":"A parent task identifier that is used to limit returned information.\nTo return all tasks, omit this parameter or use a value of `-1`.\nIf the parent task is not found, the API does not return a 404 response code.","x-found-in":"query"},"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period to wait for each node to respond.\nIf a node does not respond before its timeout expires, the response does not include its information.\nHowever, timed out nodes are included in the `node_failures` property.","x-found-in":"query"},"wait_for_completion":{"type":"boolean","description":"If `true`, the request blocks until the operation is complete.","x-found-in":"query"}},"description":"Get all tasks.\n\nGet information about the tasks currently running on one or more nodes in the cluster.\n\nWARNING: The task management API is new and should still be considered a beta feature.\nThe API may change in ways that are not backwards compatible.\n\nFor relocatable tasks, this API transparently follows the task across graceful shutdown relocations,\nso callers can keep using the original task ID. The returned task reports its `original_task_id` and `original_start_time_in_millis`\nif it is continuing work from an earlier task.\n\n**Identifying running tasks**\n\nThe `X-Opaque-Id header`, when provided on the HTTP request header, is going to be returned as a header in the response as well as in the headers field for in the task information.\nThis enables you to track certain calls or associate certain tasks with the client that started them.\nFor example:\n\n```\ncurl -i -H \"X-Opaque-Id: 123456\" \"http://localhost:9200/_tasks?group_by=parents\"\n```\n\nThe API returns the following result:\n\n```\nHTTP/1.1 200 OK\nX-Opaque-Id: 123456\ncontent-type: application/json; charset=UTF-8\ncontent-length: 831\n\n{\n  \"tasks\" : {\n    \"u5lcZHqcQhu-rUoFaqDphA:45\" : {\n      \"node\" : \"u5lcZHqcQhu-rUoFaqDphA\",\n      \"id\" : 45,\n      \"type\" : \"transport\",\n      \"action\" : \"cluster:monitor/tasks/lists\",\n      \"start_time_in_millis\" : 1513823752749,\n      \"running_time_in_nanos\" : 293139,\n      \"cancellable\" : false,\n      \"headers\" : {\n        \"X-Opaque-Id\" : \"123456\"\n      },\n      \"children\" : [\n        {\n          \"node\" : \"u5lcZHqcQhu-rUoFaqDphA\",\n          \"id\" : 46,\n          \"type\" : \"direct\",\n          \"action\" : \"cluster:monitor/tasks/lists[n]\",\n          \"start_time_in_millis\" : 1513823752750,\n          \"running_time_in_nanos\" : 92133,\n          \"cancellable\" : false,\n          \"parent_task_id\" : \"u5lcZHqcQhu-rUoFaqDphA:45\",\n          \"headers\" : {\n            \"X-Opaque-Id\" : \"123456\"\n          }\n        }\n      ]\n    }\n  }\n }\n```\nIn this example, `X-Opaque-Id: 123456` is the ID as a part of the response header.\nThe `X-Opaque-Id` in the task `headers` is the ID for the task that was initiated by the REST request.\nThe `X-Opaque-Id` in the children `headers` is the child task of the task that was initiated by the REST request."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"tasks.list","type":"object","properties":{"actions":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"A comma-separated list or wildcard expression of actions used to limit the request.\nFor example, you can use `cluser:*` to retrieve all cluster-related tasks.","x-found-in":"query"},"detailed":{"type":"boolean","description":"If `true`, the response includes detailed information about the running tasks.\nThis information is useful to distinguish tasks from each other but is more costly to run.","x-found-in":"query"},"group_by":{"$ref":"./tasks._types.json#/$defs/tasks._types__GroupBy","description":"A key that is used to group tasks in the response.\nThe task lists can be grouped either by nodes or by parent tasks.","x-found-in":"query"},"nodes":{"$ref":"./_types.json#/$defs/_types__NodeIds","description":"A comma-separated list of node IDs or names that is used to limit the returned information.","x-found-in":"query"},"parent_task_id":{"type":"string","description":"A parent task identifier that is used to limit returned information.\nTo return all tasks, omit this parameter or use a value of `-1`.\nIf the parent task is not found, the API does not return a 404 response code.","x-found-in":"query"},"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period to wait for each node to respond.\nIf a node does not respond before its timeout expires, the response does not include its information.\nHowever, timed out nodes are included in the `node_failures` property.","x-found-in":"query"},"wait_for_completion":{"type":"boolean","description":"If `true`, the request blocks until the operation is complete.","x-found-in":"query"}},"description":"Get all tasks.\n\nGet information about the tasks currently running on one or more nodes in the cluster.\n\nWARNING: The task management API is new and should still be considered a beta feature.\nThe API may change in ways that are not backwards compatible.\n\nFor relocatable tasks, this API transparently follows the task across graceful shutdown relocations,\nso callers can keep using the original task ID. The returned task reports its `original_task_id` and `original_start_time_in_millis`\nif it is continuing work from an earlier task.\n\n**Identifying running tasks**\n\nThe `X-Opaque-Id header`, when provided on the HTTP request header, is going to be returned as a header in the response as well as in the headers field for in the task information.\nThis enables you to track certain calls or associate certain tasks with the client that started them.\nFor example:\n\n```\ncurl -i -H \"X-Opaque-Id: 123456\" \"http://localhost:9200/_tasks?group_by=parents\"\n```\n\nThe API returns the following result:\n\n```\nHTTP/1.1 200 OK\nX-Opaque-Id: 123456\ncontent-type: application/json; charset=UTF-8\ncontent-length: 831\n\n{\n  \"tasks\" : {\n    \"u5lcZHqcQhu-rUoFaqDphA:45\" : {\n      \"node\" : \"u5lcZHqcQhu-rUoFaqDphA\",\n      \"id\" : 45,\n      \"type\" : \"transport\",\n      \"action\" : \"cluster:monitor/tasks/lists\",\n      \"start_time_in_millis\" : 1513823752749,\n      \"running_time_in_nanos\" : 293139,\n      \"cancellable\" : false,\n      \"headers\" : {\n        \"X-Opaque-Id\" : \"123456\"\n      },\n      \"children\" : [\n        {\n          \"node\" : \"u5lcZHqcQhu-rUoFaqDphA\",\n          \"id\" : 46,\n          \"type\" : \"direct\",\n          \"action\" : \"cluster:monitor/tasks/lists[n]\",\n          \"start_time_in_millis\" : 1513823752750,\n          \"running_time_in_nanos\" : 92133,\n          \"cancellable\" : false,\n          \"parent_task_id\" : \"u5lcZHqcQhu-rUoFaqDphA:45\",\n          \"headers\" : {\n            \"X-Opaque-Id\" : \"123456\"\n          }\n        }\n      ]\n    }\n  }\n }\n```\nIn this example, `X-Opaque-Id: 123456` is the ID as a part of the response header.\nThe `X-Opaque-Id` in the task `headers` is the ID for the task that was initiated by the REST request.\nThe `X-Opaque-Id` in the children `headers` is the child task of the task that was initiated by the REST request."}

package/src/es/json/terms_enum.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"terms_enum","type":"object","properties":{"index":{"$ref":"./_types.json#/$defs/_types__Indices","description":"A comma-separated list of data streams, indices, and index aliases to search.\nWildcard (`*`) expressions are supported.\nTo search all data streams or indices, omit this parameter or use `*`  or `_all`.","x-found-in":"path"},"field":{"type":"string","description":"The string to match at the start of indexed terms. If not provided, all terms in the field are considered.","x-found-in":"body"},"size":{"type":"number","description":"The number of matching terms to return.","x-found-in":"body"},"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The maximum length of time to spend collecting results.\nIf the timeout is exceeded the `complete` flag set to `false` in the response and the results may be partial or empty.","x-found-in":"body"},"case_insensitive":{"type":"boolean","description":"When `true`, the provided search string is matched against index terms without case sensitivity.","x-found-in":"body"},"index_filter":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__QueryContainer","description":"Filter an index shard if the provided query rewrites to `match_none`.","x-found-in":"body"},"string":{"type":"string","description":"The string to match at the start of indexed terms.\nIf it is not provided, all terms in the field are considered.\n\n> info\n> The prefix string cannot be larger than the largest possible keyword value, which is Lucene's term byte-length limit of 32766.","x-found-in":"body"},"search_after":{"type":"string","description":"The string after which terms in the index should be returned.\nIt allows for a form of pagination if the last result from one request is passed as the `search_after` parameter for a subsequent request.","x-found-in":"body"}},"required":["index","field"],"description":"Get terms in an index.\n\nDiscover terms that match a partial string in an index.\nThis API is designed for low-latency look-ups used in auto-complete scenarios.\n\n> info\n> The terms enum API may return terms from deleted documents. Deleted documents are initially only marked as deleted. It is not until their segments are merged that documents are actually deleted. Until that happens, the terms enum API will return terms from these documents."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"terms_enum","type":"object","properties":{"field":{"type":"string","description":"The string to match at the start of indexed terms. If not provided, all terms in the field are considered.","x-found-in":"body"},"size":{"type":"number","description":"The number of matching terms to return.","x-found-in":"body"},"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The maximum length of time to spend collecting results.\nIf the timeout is exceeded the `complete` flag set to `false` in the response and the results may be partial or empty.","x-found-in":"body"},"case_insensitive":{"type":"boolean","description":"When `true`, the provided search string is matched against index terms without case sensitivity.","x-found-in":"body"},"index_filter":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__QueryContainer","description":"Filter an index shard if the provided query rewrites to `match_none`.","x-found-in":"body"},"string":{"type":"string","description":"The string to match at the start of indexed terms.\nIf it is not provided, all terms in the field are considered.\n\n> info\n> The prefix string cannot be larger than the largest possible keyword value, which is Lucene's term byte-length limit of 32766.","x-found-in":"body"},"search_after":{"type":"string","description":"The string after which terms in the index should be returned.\nIt allows for a form of pagination if the last result from one request is passed as the `search_after` parameter for a subsequent request.","x-found-in":"body"},"index":{"$ref":"./_types.json#/$defs/_types__Indices","description":"A comma-separated list of data streams, indices, and index aliases to search.\nWildcard (`*`) expressions are supported.\nTo search all data streams or indices, omit this parameter or use `*`  or `_all`.","x-found-in":"path"}},"required":["index","field"],"description":"Get terms in an index.\n\nDiscover terms that match a partial string in an index.\nThis API is designed for low-latency look-ups used in auto-complete scenarios.\n\n> info\n> The terms enum API may return terms from deleted documents. Deleted documents are initially only marked as deleted. It is not until their segments are merged that documents are actually deleted. Until that happens, the terms enum API will return terms from these documents."}

package/src/es/json/termvectors.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"termvectors","type":"object","properties":{"index":{"type":"string","description":"The name of the index that contains the document.","x-found-in":"path"},"id":{"type":"string","description":"A unique identifier for the document.","x-found-in":"path"},"fields":{"type":"array","items":{"type":"string","description":"Path to field or array of paths. Some API's support wildcards in the path to select multiple fields."},"description":"A list of fields to include in the statistics.\nIt is used as the default list unless a specific field list is provided in the `completion_fields` or `fielddata_fields` parameters.","x-found-in":"body"},"field_statistics":{"type":"boolean","description":"If `true`, the response includes:\n\n* The document count (how many documents contain this field).\n* The sum of document frequencies (the sum of document frequencies for all terms in this field).\n* The sum of total term frequencies (the sum of total term frequencies of each term in this field).","x-found-in":"body"},"offsets":{"type":"boolean","description":"If `true`, the response includes term offsets.","x-found-in":"body"},"payloads":{"type":"boolean","description":"If `true`, the response includes term payloads.","x-found-in":"body"},"positions":{"type":"boolean","description":"If `true`, the response includes term positions.","x-found-in":"body"},"preference":{"type":"string","description":"The node or shard the operation should be performed on.\nIt is random by default.","x-found-in":"query"},"realtime":{"type":"boolean","description":"If true, the request is real-time as opposed to near-real-time.","x-found-in":"query"},"routing":{"$ref":"./_types.json#/$defs/_types__Routing","description":"A custom value that is used to route operations to a specific shard.","x-found-in":"body"},"term_statistics":{"type":"boolean","description":"If `true`, the response includes:\n\n* The total term frequency (how often a term occurs in all documents).\n* The document frequency (the number of documents containing the current term).\n\nBy default these values are not returned since term statistics can have a serious performance impact.","x-found-in":"body"},"version":{"type":"number","description":"If `true`, returns the document version as part of a hit.","x-found-in":"body"},"version_type":{"$ref":"./_types.json#/$defs/_types__VersionType","description":"The version type.","x-found-in":"body"},"doc":{"description":"An artificial document (a document not present in the index) for which you want to retrieve term vectors.","x-found-in":"body"},"filter":{"$ref":"./_global.termvectors.json#/$defs/_global.termvectors__Filter","description":"Filter terms based on their tf-idf scores.\nThis could be useful in order find out a good characteristic vector of a document.\nThis feature works in a similar manner to the second phase of the More Like This Query.","x-found-in":"body"},"per_field_analyzer":{"type":"object","additionalProperties":{"type":"string"},"description":"Override the default per-field analyzer.\nThis is useful in order to generate term vectors in any fashion, especially when using artificial documents.\nWhen providing an analyzer for a field that already stores term vectors, the term vectors will be regenerated.","x-found-in":"body"}},"required":["index"],"description":"Get term vector information.\n\nGet information and statistics about terms in the fields of a particular document.\n\nYou can retrieve term vectors for documents stored in the index or for artificial documents passed in the body of the request.\nYou can specify the fields you are interested in through the `fields` parameter or by adding the fields to the request body.\nFor example:\n\n```\nGET /my-index-000001/_termvectors/1?fields=message\n```\n\nFields can be specified using wildcards, similar to the multi match query.\n\nTerm vectors are real-time by default, not near real-time.\nThis can be changed by setting `realtime` parameter to `false`.\n\nYou can request three types of values: _term information_, _term statistics_, and _field statistics_.\nBy default, all term information and field statistics are returned for all fields but term statistics are excluded.\n\n**Term information**\n\n* term frequency in the field (always returned)\n* term positions (`positions: true`)\n* start and end offsets (`offsets: true`)\n* term payloads (`payloads: true`), as base64 encoded bytes\n\nIf the requested information wasn't stored in the index, it will be computed on the fly if possible.\nAdditionally, term vectors could be computed for documents not even existing in the index, but instead provided by the user.\n\n> warn\n> Start and end offsets assume UTF-16 encoding is being used. If you want to use these offsets in order to get the original text that produced this token, you should make sure that the string you are taking a sub-string of is also encoded using UTF-16.\n\n**Behaviour**\n\nThe term and field statistics are not accurate.\nDeleted documents are not taken into account.\nThe information is only retrieved for the shard the requested document resides in.\nThe term and field statistics are therefore only useful as relative measures whereas the absolute numbers have no meaning in this context.\nBy default, when requesting term vectors of artificial documents, a shard to get the statistics from is randomly selected.\nUse `routing` only to hit a particular shard.\nRefer to the linked documentation for detailed examples of how to use this API."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"termvectors","type":"object","properties":{"fields":{"type":"array","items":{"type":"string","description":"Path to field or array of paths. Some API's support wildcards in the path to select multiple fields."},"description":"A list of fields to include in the statistics.\nIt is used as the default list unless a specific field list is provided in the `completion_fields` or `fielddata_fields` parameters.","x-found-in":"body"},"field_statistics":{"type":"boolean","description":"If `true`, the response includes:\n\n* The document count (how many documents contain this field).\n* The sum of document frequencies (the sum of document frequencies for all terms in this field).\n* The sum of total term frequencies (the sum of total term frequencies of each term in this field).","x-found-in":"body"},"offsets":{"type":"boolean","description":"If `true`, the response includes term offsets.","x-found-in":"body"},"payloads":{"type":"boolean","description":"If `true`, the response includes term payloads.","x-found-in":"body"},"positions":{"type":"boolean","description":"If `true`, the response includes term positions.","x-found-in":"body"},"preference":{"type":"string","description":"The node or shard the operation should be performed on.\nIt is random by default.","x-found-in":"query"},"realtime":{"type":"boolean","description":"If true, the request is real-time as opposed to near-real-time.","x-found-in":"query"},"routing":{"$ref":"./_types.json#/$defs/_types__Routing","description":"A custom value that is used to route operations to a specific shard.","x-found-in":"body"},"term_statistics":{"type":"boolean","description":"If `true`, the response includes:\n\n* The total term frequency (how often a term occurs in all documents).\n* The document frequency (the number of documents containing the current term).\n\nBy default these values are not returned since term statistics can have a serious performance impact.","x-found-in":"body"},"version":{"type":"number","description":"If `true`, returns the document version as part of a hit.","x-found-in":"body"},"version_type":{"$ref":"./_types.json#/$defs/_types__VersionType","description":"The version type.","x-found-in":"body"},"doc":{"description":"An artificial document (a document not present in the index) for which you want to retrieve term vectors.","x-found-in":"body"},"filter":{"$ref":"./_global.termvectors.json#/$defs/_global.termvectors__Filter","description":"Filter terms based on their tf-idf scores.\nThis could be useful in order find out a good characteristic vector of a document.\nThis feature works in a similar manner to the second phase of the More Like This Query.","x-found-in":"body"},"per_field_analyzer":{"type":"object","additionalProperties":{"type":"string"},"description":"Override the default per-field analyzer.\nThis is useful in order to generate term vectors in any fashion, especially when using artificial documents.\nWhen providing an analyzer for a field that already stores term vectors, the term vectors will be regenerated.","x-found-in":"body"},"index":{"type":"string","description":"The name of the index that contains the document.","x-found-in":"path"},"id":{"type":"string","description":"A unique identifier for the document.","x-found-in":"path"}},"required":["index"],"description":"Get term vector information.\n\nGet information and statistics about terms in the fields of a particular document.\n\nYou can retrieve term vectors for documents stored in the index or for artificial documents passed in the body of the request.\nYou can specify the fields you are interested in through the `fields` parameter or by adding the fields to the request body.\nFor example:\n\n```\nGET /my-index-000001/_termvectors/1?fields=message\n```\n\nFields can be specified using wildcards, similar to the multi match query.\n\nTerm vectors are real-time by default, not near real-time.\nThis can be changed by setting `realtime` parameter to `false`.\n\nYou can request three types of values: _term information_, _term statistics_, and _field statistics_.\nBy default, all term information and field statistics are returned for all fields but term statistics are excluded.\n\n**Term information**\n\n* term frequency in the field (always returned)\n* term positions (`positions: true`)\n* start and end offsets (`offsets: true`)\n* term payloads (`payloads: true`), as base64 encoded bytes\n\nIf the requested information wasn't stored in the index, it will be computed on the fly if possible.\nAdditionally, term vectors could be computed for documents not even existing in the index, but instead provided by the user.\n\n> warn\n> Start and end offsets assume UTF-16 encoding is being used. If you want to use these offsets in order to get the original text that produced this token, you should make sure that the string you are taking a sub-string of is also encoded using UTF-16.\n\n**Behaviour**\n\nThe term and field statistics are not accurate.\nDeleted documents are not taken into account.\nThe information is only retrieved for the shard the requested document resides in.\nThe term and field statistics are therefore only useful as relative measures whereas the absolute numbers have no meaning in this context.\nBy default, when requesting term vectors of artificial documents, a shard to get the statistics from is randomly selected.\nUse `routing` only to hit a particular shard.\nRefer to the linked documentation for detailed examples of how to use this API."}

package/src/es/json/text_structure.find_field_structure.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"text_structure.find_field_structure","type":"object","properties":{"column_names":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"If `format` is set to `delimited`, you can specify the column names in a comma-separated list.\nIf this parameter is not specified, the structure finder uses the column names from the header row of the text.\nIf the text does not have a header row, columns are named \"column1\", \"column2\", \"column3\", for example.","x-found-in":"query"},"delimiter":{"type":"string","description":"If you have set `format` to `delimited`, you can specify the character used to delimit the values in each row.\nOnly a single character is supported; the delimiter cannot have multiple characters.\nBy default, the API considers the following possibilities: comma, tab, semi-colon, and pipe (`|`).\nIn this default scenario, all rows must have the same number of fields for the delimited format to be detected.\nIf you specify a delimiter, up to 10% of the rows can have a different number of columns than the first row.","x-found-in":"query"},"documents_to_sample":{"type":"number","description":"The number of documents to include in the structural analysis.\nThe minimum value is 2.","x-found-in":"query"},"ecs_compatibility":{"$ref":"./text_structure._types.json#/$defs/text_structure._types__EcsCompatibilityType","description":"The mode of compatibility with ECS compliant Grok patterns.\nUse this parameter to specify whether to use ECS Grok patterns instead of legacy ones when the structure finder creates a Grok pattern.\nThis setting primarily has an impact when a whole message Grok pattern such as `%{CATALINALOG}` matches the input.\nIf the structure finder identifies a common structure but has no idea of the meaning then generic field names such as `path`, `ipaddress`, `field1`, and `field2` are used in the `grok_pattern` output.\nThe intention in that situation is that a user who knows the meanings will rename the fields before using them.","x-found-in":"query"},"explain":{"type":"boolean","description":"If `true`, the response includes a field named `explanation`, which is an array of strings that indicate how the structure finder produced its result.","x-found-in":"query"},"field":{"type":"string","description":"The field that should be analyzed.","x-found-in":"query"},"format":{"$ref":"./text_structure._types.json#/$defs/text_structure._types__FormatType","description":"The high level structure of the text.\nBy default, the API chooses the format.\nIn this default scenario, all rows must have the same number of fields for a delimited format to be detected.\nIf the format is set to delimited and the delimiter is not set, however, the API tolerates up to 5% of rows that have a different number of columns than the first row.","x-found-in":"query"},"grok_pattern":{"type":"string","description":"If the format is `semi_structured_text`, you can specify a Grok pattern that is used to extract fields from every message in the text.\nThe name of the timestamp field in the Grok pattern must match what is specified in the `timestamp_field` parameter.\nIf that parameter is not specified, the name of the timestamp field in the Grok pattern must match \"timestamp\".\nIf `grok_pattern` is not specified, the structure finder creates a Grok pattern.","x-found-in":"query"},"index":{"type":"string","description":"The name of the index that contains the analyzed field.","x-found-in":"query"},"quote":{"type":"string","description":"If the format is `delimited`, you can specify the character used to quote the values in each row if they contain newlines or the delimiter character.\nOnly a single character is supported.\nIf this parameter is not specified, the default value is a double quote (`\"`).\nIf your delimited text format does not use quoting, a workaround is to set this argument to a character that does not appear anywhere in the sample.","x-found-in":"query"},"should_trim_fields":{"type":"boolean","description":"If the format is `delimited`, you can specify whether values between delimiters should have whitespace trimmed from them.\nIf this parameter is not specified and the delimiter is pipe (`|`), the default value is true.\nOtherwise, the default value is `false`.","x-found-in":"query"},"should_parse_recursively":{"type":"boolean","description":"If the format is `ndjson`, you can specify whether to parse nested JSON objects recursively.\nThe nested objects are parsed to a maximum depth equal to the default value of the `index.mapping.depth.limit` setting.\nAnything beyond that depth is parsed as an `object` type field.\nFor formats other than `ndjson`, this parameter is ignored.","x-found-in":"query"},"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The maximum amount of time that the structure analysis can take.\nIf the analysis is still running when the timeout expires, it will be stopped.","x-found-in":"query"},"timestamp_field":{"type":"string","description":"The name of the field that contains the primary timestamp of each record in the text.\nIn particular, if the text was ingested into an index, this is the field that would be used to populate the `@timestamp` field.\n\nIf the format is `semi_structured_text`, this field must match the name of the appropriate extraction in the `grok_pattern`.\nTherefore, for semi-structured text, it is best not to specify this parameter unless `grok_pattern` is also specified.\n\nFor structured text, if you specify this parameter, the field must exist within the text.\n\nIf this parameter is not specified, the structure finder makes a decision about which field (if any) is the primary timestamp field.\nFor structured text, it is not compulsory to have a timestamp in the text.","x-found-in":"query"},"timestamp_format":{"type":"string","description":"The Java time format of the timestamp field in the text.\nOnly a subset of Java time format letter groups are supported:\n\n* `a`\n* `d`\n* `dd`\n* `EEE`\n* `EEEE`\n* `H`\n* `HH`\n* `h`\n* `M`\n* `MM`\n* `MMM`\n* `MMMM`\n* `mm`\n* `ss`\n* `XX`\n* `XXX`\n* `yy`\n* `yyyy`\n* `zzz`\n\nAdditionally `S` letter groups (fractional seconds) of length one to nine are supported providing they occur after `ss` and are separated from the `ss` by a period (`.`), comma (`,`), or colon (`:`).\nSpacing and punctuation is also permitted with the exception a question mark (`?`), newline, and carriage return, together with literal text enclosed in single quotes.\nFor example, `MM/dd HH.mm.ss,SSSSSS 'in' yyyy` is a valid override format.\n\nOne valuable use case for this parameter is when the format is semi-structured text, there are multiple timestamp formats in the text, and you know which format corresponds to the primary timestamp, but you do not want to specify the full `grok_pattern`.\nAnother is when the timestamp format is one that the structure finder does not consider by default.\n\nIf this parameter is not specified, the structure finder chooses the best format from a built-in set.\n\nIf the special value `null` is specified, the structure finder will not look for a primary timestamp in the text.\nWhen the format is semi-structured text, this will result in the structure finder treating the text as single-line messages.","x-found-in":"query"}},"required":["field","index"],"description":"Find the structure of a text field.\n\nFind the structure of a text field in an Elasticsearch index.\n\nThis API provides a starting point for extracting further information from log messages already ingested into Elasticsearch.\nFor example, if you have ingested data into a very simple index that has just `@timestamp` and message fields, you can use this API to see what common structure exists in the message field.\n\nThe response from the API contains:\n\n* Sample messages.\n* Statistics that reveal the most common values for all fields detected within the text and basic numeric statistics for numeric fields.\n* Information about the structure of the text, which is useful when you write ingest configurations to index it or similarly formatted text.\n* Appropriate mappings for an Elasticsearch index, which you could use to ingest the text.\n\nAll this information can be calculated by the structure finder with no guidance.\nHowever, you can optionally override some of the decisions about the text structure by specifying one or more query parameters.\n\nIf the structure finder produces unexpected results, specify the `explain` query parameter and an explanation will appear in the response.\nIt helps determine why the returned structure was chosen."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"text_structure.find_field_structure","type":"object","properties":{"column_names":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"If `format` is set to `delimited`, you can specify the column names in a comma-separated list.\nIf this parameter is not specified, the structure finder uses the column names from the header row of the text.\nIf the text does not have a header row, columns are named \"column1\", \"column2\", \"column3\", for example.","x-found-in":"query"},"delimiter":{"type":"string","description":"If you have set `format` to `delimited`, you can specify the character used to delimit the values in each row.\nOnly a single character is supported; the delimiter cannot have multiple characters.\nBy default, the API considers the following possibilities: comma, tab, semi-colon, and pipe (`|`).\nIn this default scenario, all rows must have the same number of fields for the delimited format to be detected.\nIf you specify a delimiter, up to 10% of the rows can have a different number of columns than the first row.","x-found-in":"query"},"documents_to_sample":{"type":"number","description":"The number of documents to include in the structural analysis.\nThe minimum value is 2.","x-found-in":"query"},"ecs_compatibility":{"$ref":"./text_structure._types.json#/$defs/text_structure._types__EcsCompatibilityType","description":"The mode of compatibility with ECS compliant Grok patterns.\nUse this parameter to specify whether to use ECS Grok patterns instead of legacy ones when the structure finder creates a Grok pattern.\nThis setting primarily has an impact when a whole message Grok pattern such as `%{CATALINALOG}` matches the input.\nIf the structure finder identifies a common structure but has no idea of the meaning then generic field names such as `path`, `ipaddress`, `field1`, and `field2` are used in the `grok_pattern` output.\nThe intention in that situation is that a user who knows the meanings will rename the fields before using them.","x-found-in":"query"},"explain":{"type":"boolean","description":"If `true`, the response includes a field named `explanation`, which is an array of strings that indicate how the structure finder produced its result.","x-found-in":"query"},"field":{"type":"string","description":"The field that should be analyzed.","x-found-in":"query"},"format":{"$ref":"./text_structure._types.json#/$defs/text_structure._types__FormatType","description":"The high level structure of the text.\nBy default, the API chooses the format.\nIn this default scenario, all rows must have the same number of fields for a delimited format to be detected.\nIf the format is set to delimited and the delimiter is not set, however, the API tolerates up to 5% of rows that have a different number of columns than the first row.","x-found-in":"query"},"grok_pattern":{"type":"string","description":"If the format is `semi_structured_text`, you can specify a Grok pattern that is used to extract fields from every message in the text.\nThe name of the timestamp field in the Grok pattern must match what is specified in the `timestamp_field` parameter.\nIf that parameter is not specified, the name of the timestamp field in the Grok pattern must match \"timestamp\".\nIf `grok_pattern` is not specified, the structure finder creates a Grok pattern.","x-found-in":"query"},"index":{"type":"string","description":"The name of the index that contains the analyzed field.","x-found-in":"query"},"quote":{"type":"string","description":"If the format is `delimited`, you can specify the character used to quote the values in each row if they contain newlines or the delimiter character.\nOnly a single character is supported.\nIf this parameter is not specified, the default value is a double quote (`\"`).\nIf your delimited text format does not use quoting, a workaround is to set this argument to a character that does not appear anywhere in the sample.","x-found-in":"query"},"should_trim_fields":{"type":"boolean","description":"If the format is `delimited`, you can specify whether values between delimiters should have whitespace trimmed from them.\nIf this parameter is not specified and the delimiter is pipe (`|`), the default value is true.\nOtherwise, the default value is `false`.","x-found-in":"query"},"should_parse_recursively":{"type":"boolean","description":"If the format is `ndjson`, you can specify whether to parse nested JSON objects recursively.\nThe nested objects are parsed to a maximum depth equal to the default value of the `index.mapping.depth.limit` setting.\nAnything beyond that depth is parsed as an `object` type field.\nFor formats other than `ndjson`, this parameter is ignored.","x-found-in":"query"},"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The maximum amount of time that the structure analysis can take.\nIf the analysis is still running when the timeout expires, it will be stopped.","x-found-in":"query"},"timestamp_field":{"type":"string","description":"The name of the field that contains the primary timestamp of each record in the text.\nIn particular, if the text was ingested into an index, this is the field that would be used to populate the `@timestamp` field.\n\nIf the format is `semi_structured_text`, this field must match the name of the appropriate extraction in the `grok_pattern`.\nTherefore, for semi-structured text, it is best not to specify this parameter unless `grok_pattern` is also specified.\n\nFor structured text, if you specify this parameter, the field must exist within the text.\n\nIf this parameter is not specified, the structure finder makes a decision about which field (if any) is the primary timestamp field.\nFor structured text, it is not compulsory to have a timestamp in the text.","x-found-in":"query"},"timestamp_format":{"type":"string","description":"The Java time format of the timestamp field in the text.\nOnly a subset of Java time format letter groups are supported:\n\n* `a`\n* `d`\n* `dd`\n* `EEE`\n* `EEEE`\n* `H`\n* `HH`\n* `h`\n* `M`\n* `MM`\n* `MMM`\n* `MMMM`\n* `mm`\n* `ss`\n* `XX`\n* `XXX`\n* `yy`\n* `yyyy`\n* `zzz`\n\nAdditionally `S` letter groups (fractional seconds) of length one to nine are supported providing they occur after `ss` and are separated from the `ss` by a period (`.`), comma (`,`), or colon (`:`).\nSpacing and punctuation is also permitted with the exception a question mark (`?`), newline, and carriage return, together with literal text enclosed in single quotes.\nFor example, `MM/dd HH.mm.ss,SSSSSS 'in' yyyy` is a valid override format.\n\nOne valuable use case for this parameter is when the format is semi-structured text, there are multiple timestamp formats in the text, and you know which format corresponds to the primary timestamp, but you do not want to specify the full `grok_pattern`.\nAnother is when the timestamp format is one that the structure finder does not consider by default.\n\nIf this parameter is not specified, the structure finder chooses the best format from a built-in set.\n\nIf the special value `null` is specified, the structure finder will not look for a primary timestamp in the text.\nWhen the format is semi-structured text, this will result in the structure finder treating the text as single-line messages.","x-found-in":"query"}},"required":["field","index"],"description":"Find the structure of a text field.\n\nFind the structure of a text field in an Elasticsearch index.\n\nThis API provides a starting point for extracting further information from log messages already ingested into Elasticsearch.\nFor example, if you have ingested data into a very simple index that has just `@timestamp` and message fields, you can use this API to see what common structure exists in the message field.\n\nThe response from the API contains:\n\n* Sample messages.\n* Statistics that reveal the most common values for all fields detected within the text and basic numeric statistics for numeric fields.\n* Information about the structure of the text, which is useful when you write ingest configurations to index it or similarly formatted text.\n* Appropriate mappings for an Elasticsearch index, which you could use to ingest the text.\n\nAll this information can be calculated by the structure finder with no guidance.\nHowever, you can optionally override some of the decisions about the text structure by specifying one or more query parameters.\n\nIf the structure finder produces unexpected results, specify the `explain` query parameter and an explanation will appear in the response.\nIt helps determine why the returned structure was chosen."}

package/src/es/json/text_structure.find_message_structure.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"text_structure.find_message_structure","type":"object","properties":{"column_names":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"If the format is `delimited`, you can specify the column names in a comma-separated list.\nIf this parameter is not specified, the structure finder uses the column names from the header row of the text.\nIf the text does not have a header role, columns are named \"column1\", \"column2\", \"column3\", for example.","x-found-in":"query"},"delimiter":{"type":"string","description":"If you the format is `delimited`, you can specify the character used to delimit the values in each row.\nOnly a single character is supported; the delimiter cannot have multiple characters.\nBy default, the API considers the following possibilities: comma, tab, semi-colon, and pipe (`|`).\nIn this default scenario, all rows must have the same number of fields for the delimited format to be detected.\nIf you specify a delimiter, up to 10% of the rows can have a different number of columns than the first row.","x-found-in":"query"},"ecs_compatibility":{"$ref":"./text_structure._types.json#/$defs/text_structure._types__EcsCompatibilityType","description":"The mode of compatibility with ECS compliant Grok patterns.\nUse this parameter to specify whether to use ECS Grok patterns instead of legacy ones when the structure finder creates a Grok pattern.\nThis setting primarily has an impact when a whole message Grok pattern such as `%{CATALINALOG}` matches the input.\nIf the structure finder identifies a common structure but has no idea of meaning then generic field names such as `path`, `ipaddress`, `field1`, and `field2` are used in the `grok_pattern` output, with the intention that a user who knows the meanings rename these fields before using it.","x-found-in":"query"},"explain":{"type":"boolean","description":"If this parameter is set to true, the response includes a field named `explanation`, which is an array of strings that indicate how the structure finder produced its result.","x-found-in":"query"},"format":{"$ref":"./text_structure._types.json#/$defs/text_structure._types__FormatType","description":"The high level structure of the text.\nBy default, the API chooses the format.\nIn this default scenario, all rows must have the same number of fields for a delimited format to be detected.\nIf the format is `delimited` and the delimiter is not set, however, the API tolerates up to 5% of rows that have a different number of columns than the first row.","x-found-in":"query"},"grok_pattern":{"type":"string","description":"If the format is `semi_structured_text`, you can specify a Grok pattern that is used to extract fields from every message in the text.\nThe name of the timestamp field in the Grok pattern must match what is specified in the `timestamp_field` parameter.\nIf that parameter is not specified, the name of the timestamp field in the Grok pattern must match \"timestamp\".\nIf `grok_pattern` is not specified, the structure finder creates a Grok pattern.","x-found-in":"query"},"quote":{"type":"string","description":"If the format is `delimited`, you can specify the character used to quote the values in each row if they contain newlines or the delimiter character.\nOnly a single character is supported.\nIf this parameter is not specified, the default value is a double quote (`\"`).\nIf your delimited text format does not use quoting, a workaround is to set this argument to a character that does not appear anywhere in the sample.","x-found-in":"query"},"should_trim_fields":{"type":"boolean","description":"If the format is `delimited`, you can specify whether values between delimiters should have whitespace trimmed from them.\nIf this parameter is not specified and the delimiter is pipe (`|`), the default value is true.\nOtherwise, the default value is `false`.","x-found-in":"query"},"should_parse_recursively":{"type":"boolean","description":"If the format is `ndjson`, you can specify whether to parse nested JSON objects recursively.\nThe nested objects are parsed to a maximum depth equal to the default value of the `index.mapping.depth.limit` setting.\nAnything beyond that depth is parsed as an `object` type field.\nFor formats other than `ndjson`, this parameter is ignored.","x-found-in":"query"},"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The maximum amount of time that the structure analysis can take.\nIf the analysis is still running when the timeout expires, it will be stopped.","x-found-in":"query"},"timestamp_field":{"type":"string","description":"The name of the field that contains the primary timestamp of each record in the text.\nIn particular, if the text was ingested into an index, this is the field that would be used to populate the `@timestamp` field.\n\nIf the format is `semi_structured_text`, this field must match the name of the appropriate extraction in the `grok_pattern`.\nTherefore, for semi-structured text, it is best not to specify this parameter unless `grok_pattern` is also specified.\n\nFor structured text, if you specify this parameter, the field must exist within the text.\n\nIf this parameter is not specified, the structure finder makes a decision about which field (if any) is the primary timestamp field.\nFor structured text, it is not compulsory to have a timestamp in the text.","x-found-in":"query"},"timestamp_format":{"type":"string","description":"The Java time format of the timestamp field in the text.\nOnly a subset of Java time format letter groups are supported:\n\n* `a`\n* `d`\n* `dd`\n* `EEE`\n* `EEEE`\n* `H`\n* `HH`\n* `h`\n* `M`\n* `MM`\n* `MMM`\n* `MMMM`\n* `mm`\n* `ss`\n* `XX`\n* `XXX`\n* `yy`\n* `yyyy`\n* `zzz`\n\nAdditionally `S` letter groups (fractional seconds) of length one to nine are supported providing they occur after `ss` and are separated from the `ss` by a period (`.`), comma (`,`), or colon (`:`).\nSpacing and punctuation is also permitted with the exception a question mark (`?`), newline, and carriage return, together with literal text enclosed in single quotes.\nFor example, `MM/dd HH.mm.ss,SSSSSS 'in' yyyy` is a valid override format.\n\nOne valuable use case for this parameter is when the format is semi-structured text, there are multiple timestamp formats in the text, and you know which format corresponds to the primary timestamp, but you do not want to specify the full `grok_pattern`.\nAnother is when the timestamp format is one that the structure finder does not consider by default.\n\nIf this parameter is not specified, the structure finder chooses the best format from a built-in set.\n\nIf the special value `null` is specified, the structure finder will not look for a primary timestamp in the text.\nWhen the format is semi-structured text, this will result in the structure finder treating the text as single-line messages.","x-found-in":"query"},"messages":{"type":"array","items":{"type":"string"},"description":"The list of messages you want to analyze.","x-found-in":"body"}},"required":["messages"],"description":"Find the structure of text messages.\n\nFind the structure of a list of text messages.\nThe messages must contain data that is suitable to be ingested into Elasticsearch.\n\nThis API provides a starting point for ingesting data into Elasticsearch in a format that is suitable for subsequent use with other Elastic Stack functionality.\nUse this API rather than the find text structure API if your input text has already been split up into separate messages by some other process.\n\nThe response from the API contains:\n\n* Sample messages.\n* Statistics that reveal the most common values for all fields detected within the text and basic numeric statistics for numeric fields.\n* Information about the structure of the text, which is useful when you write ingest configurations to index it or similarly formatted text.\nAppropriate mappings for an Elasticsearch index, which you could use to ingest the text.\n\nAll this information can be calculated by the structure finder with no guidance.\nHowever, you can optionally override some of the decisions about the text structure by specifying one or more query parameters.\n\nIf the structure finder produces unexpected results, specify the `explain` query parameter and an explanation will appear in the response.\nIt helps determine why the returned structure was chosen."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"text_structure.find_message_structure","type":"object","properties":{"column_names":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"If the format is `delimited`, you can specify the column names in a comma-separated list.\nIf this parameter is not specified, the structure finder uses the column names from the header row of the text.\nIf the text does not have a header role, columns are named \"column1\", \"column2\", \"column3\", for example.","x-found-in":"query"},"delimiter":{"type":"string","description":"If you the format is `delimited`, you can specify the character used to delimit the values in each row.\nOnly a single character is supported; the delimiter cannot have multiple characters.\nBy default, the API considers the following possibilities: comma, tab, semi-colon, and pipe (`|`).\nIn this default scenario, all rows must have the same number of fields for the delimited format to be detected.\nIf you specify a delimiter, up to 10% of the rows can have a different number of columns than the first row.","x-found-in":"query"},"ecs_compatibility":{"$ref":"./text_structure._types.json#/$defs/text_structure._types__EcsCompatibilityType","description":"The mode of compatibility with ECS compliant Grok patterns.\nUse this parameter to specify whether to use ECS Grok patterns instead of legacy ones when the structure finder creates a Grok pattern.\nThis setting primarily has an impact when a whole message Grok pattern such as `%{CATALINALOG}` matches the input.\nIf the structure finder identifies a common structure but has no idea of meaning then generic field names such as `path`, `ipaddress`, `field1`, and `field2` are used in the `grok_pattern` output, with the intention that a user who knows the meanings rename these fields before using it.","x-found-in":"query"},"explain":{"type":"boolean","description":"If this parameter is set to true, the response includes a field named `explanation`, which is an array of strings that indicate how the structure finder produced its result.","x-found-in":"query"},"format":{"$ref":"./text_structure._types.json#/$defs/text_structure._types__FormatType","description":"The high level structure of the text.\nBy default, the API chooses the format.\nIn this default scenario, all rows must have the same number of fields for a delimited format to be detected.\nIf the format is `delimited` and the delimiter is not set, however, the API tolerates up to 5% of rows that have a different number of columns than the first row.","x-found-in":"query"},"grok_pattern":{"type":"string","description":"If the format is `semi_structured_text`, you can specify a Grok pattern that is used to extract fields from every message in the text.\nThe name of the timestamp field in the Grok pattern must match what is specified in the `timestamp_field` parameter.\nIf that parameter is not specified, the name of the timestamp field in the Grok pattern must match \"timestamp\".\nIf `grok_pattern` is not specified, the structure finder creates a Grok pattern.","x-found-in":"query"},"quote":{"type":"string","description":"If the format is `delimited`, you can specify the character used to quote the values in each row if they contain newlines or the delimiter character.\nOnly a single character is supported.\nIf this parameter is not specified, the default value is a double quote (`\"`).\nIf your delimited text format does not use quoting, a workaround is to set this argument to a character that does not appear anywhere in the sample.","x-found-in":"query"},"should_trim_fields":{"type":"boolean","description":"If the format is `delimited`, you can specify whether values between delimiters should have whitespace trimmed from them.\nIf this parameter is not specified and the delimiter is pipe (`|`), the default value is true.\nOtherwise, the default value is `false`.","x-found-in":"query"},"should_parse_recursively":{"type":"boolean","description":"If the format is `ndjson`, you can specify whether to parse nested JSON objects recursively.\nThe nested objects are parsed to a maximum depth equal to the default value of the `index.mapping.depth.limit` setting.\nAnything beyond that depth is parsed as an `object` type field.\nFor formats other than `ndjson`, this parameter is ignored.","x-found-in":"query"},"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The maximum amount of time that the structure analysis can take.\nIf the analysis is still running when the timeout expires, it will be stopped.","x-found-in":"query"},"timestamp_field":{"type":"string","description":"The name of the field that contains the primary timestamp of each record in the text.\nIn particular, if the text was ingested into an index, this is the field that would be used to populate the `@timestamp` field.\n\nIf the format is `semi_structured_text`, this field must match the name of the appropriate extraction in the `grok_pattern`.\nTherefore, for semi-structured text, it is best not to specify this parameter unless `grok_pattern` is also specified.\n\nFor structured text, if you specify this parameter, the field must exist within the text.\n\nIf this parameter is not specified, the structure finder makes a decision about which field (if any) is the primary timestamp field.\nFor structured text, it is not compulsory to have a timestamp in the text.","x-found-in":"query"},"timestamp_format":{"type":"string","description":"The Java time format of the timestamp field in the text.\nOnly a subset of Java time format letter groups are supported:\n\n* `a`\n* `d`\n* `dd`\n* `EEE`\n* `EEEE`\n* `H`\n* `HH`\n* `h`\n* `M`\n* `MM`\n* `MMM`\n* `MMMM`\n* `mm`\n* `ss`\n* `XX`\n* `XXX`\n* `yy`\n* `yyyy`\n* `zzz`\n\nAdditionally `S` letter groups (fractional seconds) of length one to nine are supported providing they occur after `ss` and are separated from the `ss` by a period (`.`), comma (`,`), or colon (`:`).\nSpacing and punctuation is also permitted with the exception a question mark (`?`), newline, and carriage return, together with literal text enclosed in single quotes.\nFor example, `MM/dd HH.mm.ss,SSSSSS 'in' yyyy` is a valid override format.\n\nOne valuable use case for this parameter is when the format is semi-structured text, there are multiple timestamp formats in the text, and you know which format corresponds to the primary timestamp, but you do not want to specify the full `grok_pattern`.\nAnother is when the timestamp format is one that the structure finder does not consider by default.\n\nIf this parameter is not specified, the structure finder chooses the best format from a built-in set.\n\nIf the special value `null` is specified, the structure finder will not look for a primary timestamp in the text.\nWhen the format is semi-structured text, this will result in the structure finder treating the text as single-line messages.","x-found-in":"query"},"messages":{"type":"array","items":{"type":"string"},"description":"The list of messages you want to analyze.","x-found-in":"body"}},"required":["messages"],"description":"Find the structure of text messages.\n\nFind the structure of a list of text messages.\nThe messages must contain data that is suitable to be ingested into Elasticsearch.\n\nThis API provides a starting point for ingesting data into Elasticsearch in a format that is suitable for subsequent use with other Elastic Stack functionality.\nUse this API rather than the find text structure API if your input text has already been split up into separate messages by some other process.\n\nThe response from the API contains:\n\n* Sample messages.\n* Statistics that reveal the most common values for all fields detected within the text and basic numeric statistics for numeric fields.\n* Information about the structure of the text, which is useful when you write ingest configurations to index it or similarly formatted text.\nAppropriate mappings for an Elasticsearch index, which you could use to ingest the text.\n\nAll this information can be calculated by the structure finder with no guidance.\nHowever, you can optionally override some of the decisions about the text structure by specifying one or more query parameters.\n\nIf the structure finder produces unexpected results, specify the `explain` query parameter and an explanation will appear in the response.\nIt helps determine why the returned structure was chosen."}