@elastic/schemas 0.4.5 → 0.5.1

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

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"snapshot.delete","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 matching snapshots are all deleted.\nIf `false`, the request returns a response as soon as the deletes are scheduled.","x-found-in":"query"},"repository":{"type":"string","description":"The name of the repository to delete a snapshot from.","x-found-in":"path"},"snapshot":{"$ref":"./_types.json#/$defs/_types__Names","description":"A comma-separated list of snapshot names to delete.\nIt also accepts wildcards (`*`).","x-found-in":"path"}},"required":["repository","snapshot"],"description":"Delete snapshots."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"snapshot.delete","description":"Delete snapshots.","x-api":{"id":"snapshot.delete","name":"delete","namespace":"snapshot"},"x-method":"DELETE","x-path":"/_snapshot/{repository}/{snapshot}","x-urls":[{"path":"/_snapshot/{repository}/{snapshot}","methods":["DELETE"]}],"x-destructive":true,"x-availability":{"stack":{"stability":"stable"},"serverless":{"stability":"stable","visibility":"private"}},"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 matching snapshots are all deleted.\nIf `false`, the request returns a response as soon as the deletes are scheduled.","x-found-in":"query"},"repository":{"type":"string","description":"The name of the repository to delete a snapshot from.","x-found-in":"path"},"snapshot":{"$ref":"./_types.json#/$defs/_types__Names","description":"A comma-separated list of snapshot names to delete.\nIt also accepts wildcards (`*`).","x-found-in":"path"}},"required":["repository","snapshot"]}

package/src/es/json/snapshot.delete.response.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"snapshot.delete","$ref":"./_types.json#/$defs/_types__AcknowledgedResponseBase"}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"snapshot.delete","x-api":{"id":"snapshot.delete","name":"delete","namespace":"snapshot"},"$ref":"./_types.json#/$defs/_types__AcknowledgedResponseBase"}

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":{"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."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"snapshot.delete_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.","x-api":{"id":"snapshot.delete_repository","name":"delete-repository","namespace":"snapshot"},"x-method":"DELETE","x-path":"/_snapshot/{repository}","x-urls":[{"path":"/_snapshot/{repository}","methods":["DELETE"]}],"x-destructive":true,"x-availability":{"stack":{"stability":"stable"},"serverless":{"stability":"stable","visibility":"private"}},"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"]}

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

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"snapshot.delete_repository","$ref":"./_types.json#/$defs/_types__AcknowledgedResponseBase"}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"snapshot.delete_repository","x-api":{"id":"snapshot.delete_repository","name":"delete-repository","namespace":"snapshot"},"$ref":"./_types.json#/$defs/_types__AcknowledgedResponseBase"}

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":{"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."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"snapshot.get","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.","x-api":{"id":"snapshot.get","name":"get","namespace":"snapshot"},"x-method":"GET","x-path":"/_snapshot/{repository}/{snapshot}","x-urls":[{"path":"/_snapshot/{repository}/{snapshot}","methods":["GET"]}],"x-destructive":false,"x-availability":{"stack":{"stability":"stable"},"serverless":{"stability":"stable","visibility":"private"}},"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","x-availability":{"stack":{"since":"7.14.0"},"serverless":{}}},"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","x-availability":{"stack":{"since":"7.16.0"},"serverless":{}}},"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","x-availability":{"stack":{"since":"7.13.0"},"serverless":{}}},"index_names":{"type":"boolean","description":"If `true`, the response includes the name of each index in each snapshot.","x-found-in":"query","x-availability":{"stack":{"since":"8.3.0"},"serverless":{}}},"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","x-availability":{"stack":{"since":"7.14.0"},"serverless":{}}},"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","x-availability":{"stack":{"since":"7.15.0"},"serverless":{}}},"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","x-availability":{"stack":{"since":"7.14.0"},"serverless":{}}},"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","x-availability":{"stack":{"since":"7.16.0"},"serverless":{}}},"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","x-availability":{"stack":{"since":"7.14.0"},"serverless":{}}},"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","x-availability":{"stack":{"since":"9.1.0"},"serverless":{}}},"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"]}

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

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"snapshot.get","type":"object","properties":{"remaining":{"type":"number","description":"The number of remaining snapshots that were not returned due to size limits and that can be fetched by additional requests using the `next` field value."},"total":{"type":"number","description":"The total number of snapshots that match the request when ignoring the size limit or `after` query parameter."},"next":{"type":"string","description":"If the request contained a size limit and there might be more results, a `next` field will be added to the response.\nIt can be used as the `after` query parameter to fetch additional results."},"responses":{"type":"array","items":{"$ref":"./snapshot.get.json#/$defs/snapshot.get__SnapshotResponseItem"}},"snapshots":{"type":"array","items":{"$ref":"./snapshot._types.json#/$defs/snapshot._types__SnapshotInfo"}}},"required":["remaining","total"]}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"snapshot.get","x-api":{"id":"snapshot.get","name":"get","namespace":"snapshot"},"type":"object","properties":{"remaining":{"type":"number","description":"The number of remaining snapshots that were not returned due to size limits and that can be fetched by additional requests using the `next` field value.","x-availability":{"stack":{"since":"7.15.0"},"serverless":{}}},"total":{"type":"number","description":"The total number of snapshots that match the request when ignoring the size limit or `after` query parameter.","x-availability":{"stack":{"since":"7.15.0"},"serverless":{}}},"next":{"type":"string","description":"If the request contained a size limit and there might be more results, a `next` field will be added to the response.\nIt can be used as the `after` query parameter to fetch additional results."},"responses":{"type":"array","items":{"$ref":"./snapshot.get.json#/$defs/snapshot.get__SnapshotResponseItem"}},"snapshots":{"type":"array","items":{"$ref":"./snapshot._types.json#/$defs/snapshot._types__SnapshotInfo"}}},"required":["remaining","total"]}

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":{"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."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"snapshot.get_repository","description":"Get snapshot repository information.","x-api":{"id":"snapshot.get_repository","name":"get-repository","namespace":"snapshot"},"x-method":"GET","x-path":"/_snapshot/{repository}","x-urls":[{"path":"/_snapshot","methods":["GET"]},{"path":"/_snapshot/{repository}","methods":["GET"]}],"x-destructive":false,"x-availability":{"stack":{"stability":"stable"},"serverless":{"stability":"stable","visibility":"private"}},"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"}}}

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

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"snapshot.get_repository","type":"object","additionalProperties":{"$ref":"./snapshot._types.json#/$defs/snapshot._types__Repository"}}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"snapshot.get_repository","x-api":{"id":"snapshot.get_repository","name":"get-repository","namespace":"snapshot"},"type":"object","additionalProperties":{"$ref":"./snapshot._types.json#/$defs/snapshot._types__Repository"}}

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":{"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."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"snapshot.repository_analyze","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.","x-api":{"id":"snapshot.repository_analyze","name":"repository-analyze","namespace":"snapshot"},"x-method":"POST","x-path":"/_snapshot/{repository}/_analyze","x-urls":[{"path":"/_snapshot/{repository}/_analyze","methods":["POST"]}],"x-destructive":true,"x-availability":{"stack":{"since":"7.12.0","stability":"stable","visibility":"public"}},"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","x-availability":{"stack":{"since":"9.5.0"}}},"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"]}

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

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"snapshot.repository_analyze","type":"object","properties":{"blob_count":{"type":"number","description":"The number of blobs written to the repository during the test."},"blob_path":{"type":"string","description":"The path in the repository under which all the blobs were written during the test."},"concurrency":{"type":"number","description":"The number of write operations performed concurrently during the test."},"coordinating_node":{"$ref":"./snapshot.repository_analyze.json#/$defs/snapshot.repository_analyze__SnapshotNodeInfo","description":"The node that coordinated the analysis and performed the final cleanup."},"delete_elapsed":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The time it took to delete all the blobs in the container."},"delete_elapsed_nanos":{"description":"The time it took to delete all the blobs in the container, in nanoseconds."},"details":{"$ref":"./snapshot.repository_analyze.json#/$defs/snapshot.repository_analyze__DetailsInfo","description":"A description of every read and write operation performed during the test."},"early_read_node_count":{"type":"number","description":"The limit on the number of nodes on which early read operations were performed after writing each blob."},"issues_detected":{"type":"array","items":{"type":"string"},"description":"A list of correctness issues detected, which is empty if the API succeeded.\nIt is included to emphasize that a successful response does not guarantee correct behaviour in future."},"listing_elapsed":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The time it took to retrieve a list of all the blobs in the container."},"listing_elapsed_nanos":{"description":"The time it took to retrieve a list of all the blobs in the container, in nanoseconds."},"max_blob_size":{"$ref":"./_types.json#/$defs/_types__ByteSize","description":"The limit on the size of a blob written during the test."},"max_blob_size_bytes":{"type":"number","description":"The limit, in bytes, on the size of a blob written during the test."},"max_total_data_size":{"$ref":"./_types.json#/$defs/_types__ByteSize","description":"The limit on the total size of all blob written during the test."},"max_total_data_size_bytes":{"type":"number","description":"The limit, in bytes, on the total size of all blob written during the test."},"rare_action_probability":{"type":"number","description":"The probability of performing rare actions during the test."},"read_node_count":{"type":"number","description":"The limit on the number of nodes on which read operations were performed after writing each blob."},"repository":{"type":"string","description":"The name of the repository that was the subject of the analysis."},"seed":{"type":"number","description":"The seed for the pseudo-random number generator used to generate the operations used during the test."},"summary":{"$ref":"./snapshot.repository_analyze.json#/$defs/snapshot.repository_analyze__SummaryInfo","description":"A collection of statistics that summarize the results of the test."}},"required":["blob_count","blob_path","concurrency","coordinating_node","delete_elapsed","delete_elapsed_nanos","details","early_read_node_count","issues_detected","listing_elapsed","listing_elapsed_nanos","max_blob_size","max_blob_size_bytes","max_total_data_size","max_total_data_size_bytes","rare_action_probability","read_node_count","repository","seed","summary"]}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"snapshot.repository_analyze","x-api":{"id":"snapshot.repository_analyze","name":"repository-analyze","namespace":"snapshot"},"type":"object","properties":{"blob_count":{"type":"number","description":"The number of blobs written to the repository during the test."},"blob_path":{"type":"string","description":"The path in the repository under which all the blobs were written during the test."},"concurrency":{"type":"number","description":"The number of write operations performed concurrently during the test."},"coordinating_node":{"$ref":"./snapshot.repository_analyze.json#/$defs/snapshot.repository_analyze__SnapshotNodeInfo","description":"The node that coordinated the analysis and performed the final cleanup."},"delete_elapsed":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The time it took to delete all the blobs in the container."},"delete_elapsed_nanos":{"description":"The time it took to delete all the blobs in the container, in nanoseconds."},"details":{"$ref":"./snapshot.repository_analyze.json#/$defs/snapshot.repository_analyze__DetailsInfo","description":"A description of every read and write operation performed during the test."},"early_read_node_count":{"type":"number","description":"The limit on the number of nodes on which early read operations were performed after writing each blob."},"issues_detected":{"type":"array","items":{"type":"string"},"description":"A list of correctness issues detected, which is empty if the API succeeded.\nIt is included to emphasize that a successful response does not guarantee correct behaviour in future."},"listing_elapsed":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The time it took to retrieve a list of all the blobs in the container."},"listing_elapsed_nanos":{"description":"The time it took to retrieve a list of all the blobs in the container, in nanoseconds."},"max_blob_size":{"$ref":"./_types.json#/$defs/_types__ByteSize","description":"The limit on the size of a blob written during the test."},"max_blob_size_bytes":{"type":"number","description":"The limit, in bytes, on the size of a blob written during the test."},"max_total_data_size":{"$ref":"./_types.json#/$defs/_types__ByteSize","description":"The limit on the total size of all blob written during the test."},"max_total_data_size_bytes":{"type":"number","description":"The limit, in bytes, on the total size of all blob written during the test."},"rare_action_probability":{"type":"number","description":"The probability of performing rare actions during the test."},"read_node_count":{"type":"number","description":"The limit on the number of nodes on which read operations were performed after writing each blob."},"repository":{"type":"string","description":"The name of the repository that was the subject of the analysis."},"seed":{"type":"number","description":"The seed for the pseudo-random number generator used to generate the operations used during the test."},"summary":{"$ref":"./snapshot.repository_analyze.json#/$defs/snapshot.repository_analyze__SummaryInfo","description":"A collection of statistics that summarize the results of the test."}},"required":["blob_count","blob_path","concurrency","coordinating_node","delete_elapsed","delete_elapsed_nanos","details","early_read_node_count","issues_detected","listing_elapsed","listing_elapsed_nanos","max_blob_size","max_blob_size_bytes","max_total_data_size","max_total_data_size_bytes","rare_action_probability","read_node_count","repository","seed","summary"]}

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":{"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."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"snapshot.repository_verify_integrity","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.","x-api":{"id":"snapshot.repository_verify_integrity","name":"repository-verify-integrity","namespace":"snapshot"},"x-method":"POST","x-path":"/_snapshot/{repository}/_verify_integrity","x-urls":[{"path":"/_snapshot/{repository}/_verify_integrity","methods":["POST"]}],"x-destructive":true,"x-availability":{"stack":{"since":"8.16.0","stability":"experimental","visibility":"public"}},"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"]}

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

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"snapshot.repository_verify_integrity"}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"snapshot.repository_verify_integrity","x-api":{"id":"snapshot.repository_verify_integrity","name":"repository-verify-integrity","namespace":"snapshot"}}

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":{"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."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"snapshot.restore","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.","x-api":{"id":"snapshot.restore","name":"restore","namespace":"snapshot"},"x-method":"POST","x-path":"/_snapshot/{repository}/{snapshot}/_restore","x-urls":[{"path":"/_snapshot/{repository}/{snapshot}/_restore","methods":["POST"]}],"x-destructive":true,"x-availability":{"stack":{"stability":"stable"},"serverless":{"stability":"stable","visibility":"private"}},"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"]}

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

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"snapshot.restore","type":"object","properties":{"accepted":{"type":"boolean"},"snapshot":{"$ref":"./snapshot.restore.json#/$defs/snapshot.restore__SnapshotRestore"}}}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"snapshot.restore","x-api":{"id":"snapshot.restore","name":"restore","namespace":"snapshot"},"type":"object","properties":{"accepted":{"type":"boolean"},"snapshot":{"$ref":"./snapshot.restore.json#/$defs/snapshot.restore__SnapshotRestore"}}}

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":{"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."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"snapshot.status","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.","x-api":{"id":"snapshot.status","name":"status","namespace":"snapshot"},"x-method":"GET","x-path":"/_snapshot/{repository}/{snapshot}/_status","x-urls":[{"path":"/_snapshot/_status","methods":["GET"]},{"path":"/_snapshot/{repository}/_status","methods":["GET"]},{"path":"/_snapshot/{repository}/{snapshot}/_status","methods":["GET"]}],"x-destructive":false,"x-availability":{"stack":{"since":"7.8.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"private"}},"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"}}}

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

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"snapshot.status","type":"object","properties":{"snapshots":{"type":"array","items":{"$ref":"./snapshot._types.json#/$defs/snapshot._types__Status"}}},"required":["snapshots"]}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"snapshot.status","x-api":{"id":"snapshot.status","name":"status","namespace":"snapshot"},"type":"object","properties":{"snapshots":{"type":"array","items":{"$ref":"./snapshot._types.json#/$defs/snapshot._types__Status"}}},"required":["snapshots"]}

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":{"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."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"snapshot.verify_repository","description":"Verify a snapshot repository.\n\nCheck for common misconfigurations in a snapshot repository.","x-api":{"id":"snapshot.verify_repository","name":"verify-repository","namespace":"snapshot"},"x-method":"POST","x-path":"/_snapshot/{repository}/_verify","x-urls":[{"path":"/_snapshot/{repository}/_verify","methods":["POST"]}],"x-destructive":true,"x-availability":{"stack":{"stability":"stable"},"serverless":{"stability":"stable","visibility":"private"}},"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"]}

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

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"snapshot.verify_repository","type":"object","properties":{"nodes":{"type":"object","additionalProperties":{"$ref":"./snapshot.verify_repository.json#/$defs/snapshot.verify_repository__CompactNodeInfo"},"description":"Information about the nodes connected to the snapshot repository.\nThe key is the ID of the node."}},"required":["nodes"]}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"snapshot.verify_repository","x-api":{"id":"snapshot.verify_repository","name":"verify-repository","namespace":"snapshot"},"type":"object","properties":{"nodes":{"type":"object","additionalProperties":{"$ref":"./snapshot.verify_repository.json#/$defs/snapshot.verify_repository__CompactNodeInfo"},"description":"Information about the nodes connected to the snapshot repository.\nThe key is the ID of the node."}},"required":["nodes"]}

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

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"sql.clear_cursor","type":"object","properties":{"cursor":{"type":"string","description":"Cursor to clear.","x-found-in":"body"}},"required":["cursor"],"description":"Clear an SQL search cursor."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"sql.clear_cursor","description":"Clear an SQL search cursor.","x-api":{"id":"sql.clear_cursor","name":"clear-cursor","namespace":"sql"},"x-method":"POST","x-path":"/_sql/close","x-urls":[{"path":"/_sql/close","methods":["POST"]}],"x-destructive":true,"x-availability":{"stack":{"since":"6.3.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"public"}},"type":"object","properties":{"cursor":{"type":"string","description":"Cursor to clear.","x-found-in":"body"}},"required":["cursor"]}

package/src/es/json/sql.clear_cursor.response.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"sql.clear_cursor","type":"object","properties":{"succeeded":{"type":"boolean"}},"required":["succeeded"]}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"sql.clear_cursor","x-api":{"id":"sql.clear_cursor","name":"clear-cursor","namespace":"sql"},"type":"object","properties":{"succeeded":{"type":"boolean"}},"required":["succeeded"]}

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

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"sql.delete_async","type":"object","properties":{"id":{"type":"string","description":"The identifier for the search.","x-found-in":"path"}},"required":["id"],"description":"Delete an async SQL search.\n\nDelete an async SQL search or a stored synchronous SQL search.\nIf the search is still running, the API cancels it.\n\nIf the Elasticsearch security features are enabled, only the following users can use this API to delete a search:\n\n* Users with the `cancel_task` cluster privilege.\n* The user who first submitted the search."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"sql.delete_async","description":"Delete an async SQL search.\n\nDelete an async SQL search or a stored synchronous SQL search.\nIf the search is still running, the API cancels it.\n\nIf the Elasticsearch security features are enabled, only the following users can use this API to delete a search:\n\n* Users with the `cancel_task` cluster privilege.\n* The user who first submitted the search.","x-api":{"id":"sql.delete_async","name":"delete-async","namespace":"sql"},"x-method":"DELETE","x-path":"/_sql/async/delete/{id}","x-urls":[{"path":"/_sql/async/delete/{id}","methods":["DELETE"]}],"x-destructive":true,"x-availability":{"stack":{"since":"7.15.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"public"}},"type":"object","properties":{"id":{"type":"string","description":"The identifier for the search.","x-found-in":"path"}},"required":["id"]}

package/src/es/json/sql.delete_async.response.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"sql.delete_async","$ref":"./_types.json#/$defs/_types__AcknowledgedResponseBase"}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"sql.delete_async","x-api":{"id":"sql.delete_async","name":"delete-async","namespace":"sql"},"$ref":"./_types.json#/$defs/_types__AcknowledgedResponseBase"}

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":{"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."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"sql.get_async","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.","x-api":{"id":"sql.get_async","name":"get-async","namespace":"sql"},"x-method":"GET","x-path":"/_sql/async/{id}","x-urls":[{"path":"/_sql/async/{id}","methods":["GET"]}],"x-destructive":false,"x-availability":{"stack":{"since":"7.15.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"public"}},"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"]}

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

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"sql.get_async","type":"object","properties":{"id":{"type":"string","description":"Identifier for the search.\nThis value is returned only for async and saved synchronous searches.\nFor CSV, TSV, and TXT responses, this value is returned in the `Async-ID` HTTP header."},"is_running":{"type":"boolean","description":"If `true`, the search is still running.\nIf `false`, the search has finished.\nThis value is returned only for async and saved synchronous searches.\nFor CSV, TSV, and TXT responses, this value is returned in the `Async-partial` HTTP header."},"is_partial":{"type":"boolean","description":"If `true`, the response does not contain complete search results.\nIf `is_partial` is `true` and `is_running` is `true`, the search is still running.\nIf `is_partial` is `true` but `is_running` is `false`, the results are partial due to a failure or timeout.\nThis value is returned only for async and saved synchronous searches.\nFor CSV, TSV, and TXT responses, this value is returned in the `Async-partial` HTTP header."},"columns":{"type":"array","items":{"$ref":"./sql._types.json#/$defs/sql._types__Column"},"description":"Column headings for the search results. Each object is a column."},"cursor":{"type":"string","description":"The cursor for the next set of paginated results.\nFor CSV, TSV, and TXT responses, this value is returned in the `Cursor` HTTP header."},"rows":{"type":"array","items":{"$ref":"./sql._types.json#/$defs/sql._types__Row"},"description":"The values for the search results."}},"required":["id","is_running","is_partial","rows"]}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"sql.get_async","x-api":{"id":"sql.get_async","name":"get-async","namespace":"sql"},"type":"object","properties":{"id":{"type":"string","description":"Identifier for the search.\nThis value is returned only for async and saved synchronous searches.\nFor CSV, TSV, and TXT responses, this value is returned in the `Async-ID` HTTP header."},"is_running":{"type":"boolean","description":"If `true`, the search is still running.\nIf `false`, the search has finished.\nThis value is returned only for async and saved synchronous searches.\nFor CSV, TSV, and TXT responses, this value is returned in the `Async-partial` HTTP header."},"is_partial":{"type":"boolean","description":"If `true`, the response does not contain complete search results.\nIf `is_partial` is `true` and `is_running` is `true`, the search is still running.\nIf `is_partial` is `true` but `is_running` is `false`, the results are partial due to a failure or timeout.\nThis value is returned only for async and saved synchronous searches.\nFor CSV, TSV, and TXT responses, this value is returned in the `Async-partial` HTTP header."},"columns":{"type":"array","items":{"$ref":"./sql._types.json#/$defs/sql._types__Column"},"description":"Column headings for the search results. Each object is a column."},"cursor":{"type":"string","description":"The cursor for the next set of paginated results.\nFor CSV, TSV, and TXT responses, this value is returned in the `Cursor` HTTP header."},"rows":{"type":"array","items":{"$ref":"./sql._types.json#/$defs/sql._types__Row"},"description":"The values for the search results."}},"required":["id","is_running","is_partial","rows"]}

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

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"sql.get_async_status","type":"object","properties":{"id":{"type":"string","description":"The identifier for the search.","x-found-in":"path"}},"required":["id"],"description":"Get the async SQL search status.\n\nGet the current status of an async SQL search or a stored synchronous SQL search."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"sql.get_async_status","description":"Get the async SQL search status.\n\nGet the current status of an async SQL search or a stored synchronous SQL search.","x-api":{"id":"sql.get_async_status","name":"get-async-status","namespace":"sql"},"x-method":"GET","x-path":"/_sql/async/status/{id}","x-urls":[{"path":"/_sql/async/status/{id}","methods":["GET"]}],"x-destructive":false,"x-availability":{"stack":{"since":"7.15.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"public"}},"type":"object","properties":{"id":{"type":"string","description":"The identifier for the search.","x-found-in":"path"}},"required":["id"]}

package/src/es/json/sql.get_async_status.response.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"sql.get_async_status","type":"object","properties":{"expiration_time_in_millis":{"description":"The timestamp, in milliseconds since the Unix epoch, when Elasticsearch will delete the search and its results, even if the search is still running."},"id":{"type":"string","description":"The identifier for the search."},"is_running":{"type":"boolean","description":"If `true`, the search is still running.\nIf `false`, the search has finished."},"is_partial":{"type":"boolean","description":"If `true`, the response does not contain complete search results.\nIf `is_partial` is `true` and `is_running` is `true`, the search is still running.\nIf `is_partial` is `true` but `is_running` is `false`, the results are partial due to a failure or timeout."},"start_time_in_millis":{"description":"The timestamp, in milliseconds since the Unix epoch, when the search started.\nThe API returns this property only for running searches."},"completion_status":{"type":"number","description":"The HTTP status code for the search.\nThe API returns this property only for completed searches."}},"required":["expiration_time_in_millis","id","is_running","is_partial","start_time_in_millis"]}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"sql.get_async_status","x-api":{"id":"sql.get_async_status","name":"get-async-status","namespace":"sql"},"type":"object","properties":{"expiration_time_in_millis":{"description":"The timestamp, in milliseconds since the Unix epoch, when Elasticsearch will delete the search and its results, even if the search is still running."},"id":{"type":"string","description":"The identifier for the search."},"is_running":{"type":"boolean","description":"If `true`, the search is still running.\nIf `false`, the search has finished."},"is_partial":{"type":"boolean","description":"If `true`, the response does not contain complete search results.\nIf `is_partial` is `true` and `is_running` is `true`, the search is still running.\nIf `is_partial` is `true` but `is_running` is `false`, the results are partial due to a failure or timeout."},"start_time_in_millis":{"description":"The timestamp, in milliseconds since the Unix epoch, when the search started.\nThe API returns this property only for running searches."},"completion_status":{"type":"number","description":"The HTTP status code for the search.\nThe API returns this property only for completed searches."}},"required":["expiration_time_in_millis","id","is_running","is_partial","start_time_in_millis"]}

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

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"sql.query","type":"object","properties":{"format":{"$ref":"./sql.query.json#/$defs/sql.query__SqlFormat","description":"The format for the response.\nYou can also specify a format using the `Accept` HTTP header.\nIf you specify both this parameter and the `Accept` HTTP header, this parameter takes precedence.","x-found-in":"query"},"allow_partial_search_results":{"type":"boolean","description":"If `true`, the response has partial results when there are shard request timeouts or shard failures.\nIf `false`, the API returns an error with no partial results.","x-found-in":"body"},"catalog":{"type":"string","description":"The default catalog (cluster) for queries.\nIf unspecified, the queries execute on the data in the local cluster only.","x-found-in":"body"},"columnar":{"type":"boolean","description":"If `true`, the results are in a columnar fashion: one row represents all the values of a certain column from the current page of results.\nThe API supports this parameter only for CBOR, JSON, SMILE, and YAML responses.","x-found-in":"body"},"cursor":{"type":"string","description":"The cursor used to retrieve a set of paginated results.\nIf you specify a cursor, the API only uses the `columnar` and `time_zone` request body parameters.\nIt ignores other request body parameters.","x-found-in":"body"},"fetch_size":{"type":"number","description":"The maximum number of rows (or entries) to return in one response.","x-found-in":"body"},"field_multi_value_leniency":{"type":"boolean","description":"If `false`, the API returns an exception when encountering multiple values for a field.\nIf `true`, the API is lenient and returns the first value from the array with no guarantee of consistent results.","x-found-in":"body"},"filter":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__QueryContainer","description":"The Elasticsearch query DSL for additional filtering.","x-found-in":"body"},"index_using_frozen":{"type":"boolean","description":"If `true`, the search can run on frozen indices.","x-found-in":"body"},"keep_alive":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The retention period for an async or saved synchronous search.","x-found-in":"body"},"keep_on_completion":{"type":"boolean","description":"If `true`, Elasticsearch stores synchronous searches if you also specify the `wait_for_completion_timeout` parameter.\nIf `false`, Elasticsearch only stores async searches that don't finish before the `wait_for_completion_timeout`.","x-found-in":"body"},"page_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The minimum retention period for the scroll cursor.\nAfter this time period, a pagination request might fail because the scroll cursor is no longer available.\nSubsequent scroll requests prolong the lifetime of the scroll cursor by the duration of `page_timeout` in the scroll request.","x-found-in":"body"},"params":{"type":"array","items":{},"description":"The values for parameters in the query.","x-found-in":"body"},"query":{"type":"string","description":"The SQL query to run.","x-found-in":"body"},"request_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The timeout before the request fails.","x-found-in":"body"},"runtime_mappings":{"$ref":"./_types.mapping.json#/$defs/_types.mapping__RuntimeFields","description":"One or more runtime fields for the search request.\nThese fields take precedence over mapped fields with the same name.","x-found-in":"body"},"time_zone":{"type":"string","description":"The ISO-8601 time zone ID for the search.","x-found-in":"body"},"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.\nIf the search doesn't finish within this period, the search becomes async.\n\nTo save a synchronous search, you must specify this parameter and the `keep_on_completion` parameter.","x-found-in":"body"}},"description":"Get SQL search results.\n\nRun an SQL request."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"sql.query","description":"Get SQL search results.\n\nRun an SQL request.","x-api":{"id":"sql.query","name":"query","namespace":"sql"},"x-method":"POST","x-path":"/_sql","x-urls":[{"path":"/_sql","methods":["POST","GET"]}],"x-destructive":false,"x-availability":{"stack":{"since":"6.3.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"public"}},"type":"object","properties":{"format":{"$ref":"./sql.query.json#/$defs/sql.query__SqlFormat","description":"The format for the response.\nYou can also specify a format using the `Accept` HTTP header.\nIf you specify both this parameter and the `Accept` HTTP header, this parameter takes precedence.","x-found-in":"query"},"allow_partial_search_results":{"type":"boolean","description":"If `true`, the response has partial results when there are shard request timeouts or shard failures.\nIf `false`, the API returns an error with no partial results.","x-found-in":"body"},"catalog":{"type":"string","description":"The default catalog (cluster) for queries.\nIf unspecified, the queries execute on the data in the local cluster only.","x-found-in":"body"},"columnar":{"type":"boolean","description":"If `true`, the results are in a columnar fashion: one row represents all the values of a certain column from the current page of results.\nThe API supports this parameter only for CBOR, JSON, SMILE, and YAML responses.","x-found-in":"body"},"cursor":{"type":"string","description":"The cursor used to retrieve a set of paginated results.\nIf you specify a cursor, the API only uses the `columnar` and `time_zone` request body parameters.\nIt ignores other request body parameters.","x-found-in":"body"},"fetch_size":{"type":"number","description":"The maximum number of rows (or entries) to return in one response.","x-found-in":"body"},"field_multi_value_leniency":{"type":"boolean","description":"If `false`, the API returns an exception when encountering multiple values for a field.\nIf `true`, the API is lenient and returns the first value from the array with no guarantee of consistent results.","x-found-in":"body"},"filter":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__QueryContainer","description":"The Elasticsearch query DSL for additional filtering.","x-found-in":"body"},"index_using_frozen":{"type":"boolean","description":"If `true`, the search can run on frozen indices.","x-found-in":"body"},"keep_alive":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The retention period for an async or saved synchronous search.","x-found-in":"body"},"keep_on_completion":{"type":"boolean","description":"If `true`, Elasticsearch stores synchronous searches if you also specify the `wait_for_completion_timeout` parameter.\nIf `false`, Elasticsearch only stores async searches that don't finish before the `wait_for_completion_timeout`.","x-found-in":"body"},"page_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The minimum retention period for the scroll cursor.\nAfter this time period, a pagination request might fail because the scroll cursor is no longer available.\nSubsequent scroll requests prolong the lifetime of the scroll cursor by the duration of `page_timeout` in the scroll request.","x-found-in":"body"},"params":{"type":"array","items":{},"description":"The values for parameters in the query.","x-found-in":"body"},"query":{"type":"string","description":"The SQL query to run.","x-found-in":"body"},"request_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The timeout before the request fails.","x-found-in":"body"},"runtime_mappings":{"$ref":"./_types.mapping.json#/$defs/_types.mapping__RuntimeFields","description":"One or more runtime fields for the search request.\nThese fields take precedence over mapped fields with the same name.","x-found-in":"body"},"time_zone":{"type":"string","description":"The ISO-8601 time zone ID for the search.","x-found-in":"body"},"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.\nIf the search doesn't finish within this period, the search becomes async.\n\nTo save a synchronous search, you must specify this parameter and the `keep_on_completion` parameter.","x-found-in":"body"}}}

package/src/es/json/sql.query.response.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"sql.query","type":"object","properties":{"columns":{"type":"array","items":{"$ref":"./sql._types.json#/$defs/sql._types__Column"},"description":"Column headings for the search results. Each object is a column."},"cursor":{"type":"string","description":"The cursor for the next set of paginated results.\nFor CSV, TSV, and TXT responses, this value is returned in the `Cursor` HTTP header."},"id":{"type":"string","description":"The identifier for the search.\nThis value is returned only for async and saved synchronous searches.\nFor CSV, TSV, and TXT responses, this value is returned in the `Async-ID` HTTP header."},"is_running":{"type":"boolean","description":"If `true`, the search is still running.\nIf `false`, the search has finished.\nThis value is returned only for async and saved synchronous searches.\nFor CSV, TSV, and TXT responses, this value is returned in the `Async-partial` HTTP header."},"is_partial":{"type":"boolean","description":"If `true`, the response does not contain complete search results.\nIf `is_partial` is `true` and `is_running` is `true`, the search is still running.\nIf `is_partial` is `true` but `is_running` is `false`, the results are partial due to a failure or timeout.\nThis value is returned only for async and saved synchronous searches.\nFor CSV, TSV, and TXT responses, this value is returned in the `Async-partial` HTTP header."},"rows":{"type":"array","items":{"$ref":"./sql._types.json#/$defs/sql._types__Row"},"description":"The values for the search results."}},"required":["rows"]}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"sql.query","x-api":{"id":"sql.query","name":"query","namespace":"sql"},"type":"object","properties":{"columns":{"type":"array","items":{"$ref":"./sql._types.json#/$defs/sql._types__Column"},"description":"Column headings for the search results. Each object is a column."},"cursor":{"type":"string","description":"The cursor for the next set of paginated results.\nFor CSV, TSV, and TXT responses, this value is returned in the `Cursor` HTTP header."},"id":{"type":"string","description":"The identifier for the search.\nThis value is returned only for async and saved synchronous searches.\nFor CSV, TSV, and TXT responses, this value is returned in the `Async-ID` HTTP header."},"is_running":{"type":"boolean","description":"If `true`, the search is still running.\nIf `false`, the search has finished.\nThis value is returned only for async and saved synchronous searches.\nFor CSV, TSV, and TXT responses, this value is returned in the `Async-partial` HTTP header."},"is_partial":{"type":"boolean","description":"If `true`, the response does not contain complete search results.\nIf `is_partial` is `true` and `is_running` is `true`, the search is still running.\nIf `is_partial` is `true` but `is_running` is `false`, the results are partial due to a failure or timeout.\nThis value is returned only for async and saved synchronous searches.\nFor CSV, TSV, and TXT responses, this value is returned in the `Async-partial` HTTP header."},"rows":{"type":"array","items":{"$ref":"./sql._types.json#/$defs/sql._types__Row"},"description":"The values for the search results."}},"required":["rows"]}

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

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"sql.translate","type":"object","properties":{"fetch_size":{"type":"number","description":"The maximum number of rows (or entries) to return in one response.","x-found-in":"body"},"filter":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__QueryContainer","description":"The Elasticsearch query DSL for additional filtering.","x-found-in":"body"},"query":{"type":"string","description":"The SQL query to run.","x-found-in":"body"},"time_zone":{"type":"string","description":"The ISO-8601 time zone ID for the search.","x-found-in":"body"}},"required":["query"],"description":"Translate SQL into Elasticsearch queries.\n\nTranslate an SQL search into a search API request containing Query DSL.\nIt accepts the same request body parameters as the SQL search API, excluding `cursor`."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"sql.translate","description":"Translate SQL into Elasticsearch queries.\n\nTranslate an SQL search into a search API request containing Query DSL.\nIt accepts the same request body parameters as the SQL search API, excluding `cursor`.","x-api":{"id":"sql.translate","name":"translate","namespace":"sql"},"x-method":"POST","x-path":"/_sql/translate","x-urls":[{"path":"/_sql/translate","methods":["POST","GET"]}],"x-destructive":true,"x-availability":{"stack":{"since":"6.3.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"public"}},"type":"object","properties":{"fetch_size":{"type":"number","description":"The maximum number of rows (or entries) to return in one response.","x-found-in":"body"},"filter":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__QueryContainer","description":"The Elasticsearch query DSL for additional filtering.","x-found-in":"body"},"query":{"type":"string","description":"The SQL query to run.","x-found-in":"body"},"time_zone":{"type":"string","description":"The ISO-8601 time zone ID for the search.","x-found-in":"body"}},"required":["query"]}

package/src/es/json/sql.translate.response.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"sql.translate","type":"object","properties":{"aggregations":{"type":"object","additionalProperties":{"$ref":"./_types.aggregations.json#/$defs/_types.aggregations__AggregationContainer"}},"size":{"type":"number"},"_source":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__SourceConfig"},"fields":{"type":"array","items":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__FieldAndFormat"}},"query":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__QueryContainer"},"sort":{"$ref":"./_types.json#/$defs/_types__Sort"},"track_total_hits":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__TrackHits"}}}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"sql.translate","x-api":{"id":"sql.translate","name":"translate","namespace":"sql"},"type":"object","properties":{"aggregations":{"type":"object","additionalProperties":{"$ref":"./_types.aggregations.json#/$defs/_types.aggregations__AggregationContainer"}},"size":{"type":"number"},"_source":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__SourceConfig"},"fields":{"type":"array","items":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__FieldAndFormat"}},"query":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__QueryContainer"},"sort":{"$ref":"./_types.json#/$defs/_types__Sort"},"track_total_hits":{"$ref":"./_global.search._types.json#/$defs/_global.search._types__TrackHits"}}}

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

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ssl.certificates","type":"object","properties":{},"description":"Get SSL certificates.\n\nGet information about the X.509 certificates that are used to encrypt communications in the cluster.\nThe API returns a list that includes certificates from all TLS contexts including:\n\n- Settings for transport and HTTP interfaces\n- TLS settings that are used within authentication realms\n- TLS settings for remote monitoring exporters\n\nThe list includes certificates that are used for configuring trust, such as those configured in the `xpack.security.transport.ssl.truststore` and `xpack.security.transport.ssl.certificate_authorities` settings.\nIt also includes certificates that are used for configuring server identity, such as `xpack.security.http.ssl.keystore` and `xpack.security.http.ssl.certificate settings`.\n\nThe list does not include certificates that are sourced from the default SSL context of the Java Runtime Environment (JRE), even if those certificates are in use within Elasticsearch.\n\nNOTE: When a PKCS#11 token is configured as the truststore of the JRE, the API returns all the certificates that are included in the PKCS#11 token irrespective of whether these are used in the Elasticsearch TLS configuration.\n\nIf Elasticsearch is configured to use a keystore or truststore, the API output includes all certificates in that store, even though some of the certificates might not be in active use within the cluster."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ssl.certificates","description":"Get SSL certificates.\n\nGet information about the X.509 certificates that are used to encrypt communications in the cluster.\nThe API returns a list that includes certificates from all TLS contexts including:\n\n- Settings for transport and HTTP interfaces\n- TLS settings that are used within authentication realms\n- TLS settings for remote monitoring exporters\n\nThe list includes certificates that are used for configuring trust, such as those configured in the `xpack.security.transport.ssl.truststore` and `xpack.security.transport.ssl.certificate_authorities` settings.\nIt also includes certificates that are used for configuring server identity, such as `xpack.security.http.ssl.keystore` and `xpack.security.http.ssl.certificate settings`.\n\nThe list does not include certificates that are sourced from the default SSL context of the Java Runtime Environment (JRE), even if those certificates are in use within Elasticsearch.\n\nNOTE: When a PKCS#11 token is configured as the truststore of the JRE, the API returns all the certificates that are included in the PKCS#11 token irrespective of whether these are used in the Elasticsearch TLS configuration.\n\nIf Elasticsearch is configured to use a keystore or truststore, the API output includes all certificates in that store, even though some of the certificates might not be in active use within the cluster.","x-api":{"id":"ssl.certificates","name":"certificates","namespace":"ssl"},"x-method":"GET","x-path":"/_ssl/certificates","x-urls":[{"path":"/_ssl/certificates","methods":["GET"]}],"x-destructive":false,"x-availability":{"stack":{"since":"6.2.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"private"}},"type":"object","properties":{}}

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

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ssl.certificates","type":"array","items":{"$ref":"./ssl.certificates.json#/$defs/ssl.certificates__CertificateInformation"}}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ssl.certificates","x-api":{"id":"ssl.certificates","name":"certificates","namespace":"ssl"},"type":"array","items":{"$ref":"./ssl.certificates.json#/$defs/ssl.certificates__CertificateInformation"}}

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":{"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."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"streams.logs_disable","description":"Disable a named stream.\n\nTurn off the named stream feature for this cluster.","x-api":{"id":"streams.logs_disable","name":"logs-disable","namespace":"streams"},"x-method":"POST","x-path":"/_streams/{name}/_disable","x-urls":[{"path":"/_streams/{name}/_disable","methods":["POST"]}],"x-destructive":true,"x-availability":{"stack":{"since":"9.1.0","stability":"experimental","visibility":"public"}},"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"]}

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

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"streams.logs_disable","$ref":"./_types.json#/$defs/_types__AcknowledgedResponseBase"}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"streams.logs_disable","x-api":{"id":"streams.logs_disable","name":"logs-disable","namespace":"streams"},"$ref":"./_types.json#/$defs/_types__AcknowledgedResponseBase"}

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":{"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."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"streams.logs_enable","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.","x-api":{"id":"streams.logs_enable","name":"logs-enable","namespace":"streams"},"x-method":"POST","x-path":"/_streams/{name}/_enable","x-urls":[{"path":"/_streams/{name}/_enable","methods":["POST"]}],"x-destructive":true,"x-availability":{"stack":{"since":"9.1.0","stability":"experimental","visibility":"public"}},"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"]}

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

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"streams.logs_enable","$ref":"./_types.json#/$defs/_types__AcknowledgedResponseBase"}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"streams.logs_enable","x-api":{"id":"streams.logs_enable","name":"logs-enable","namespace":"streams"},"$ref":"./_types.json#/$defs/_types__AcknowledgedResponseBase"}

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

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"streams.status","type":"object","properties":{"master_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.","x-found-in":"query"}},"description":"Get the status of streams.\n\nGet the current status for all types of streams."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"streams.status","description":"Get the status of streams.\n\nGet the current status for all types of streams.","x-api":{"id":"streams.status","name":"status","namespace":"streams"},"x-method":"GET","x-path":"/_streams/status","x-urls":[{"path":"/_streams/status","methods":["GET"]}],"x-destructive":false,"x-availability":{"stack":{"since":"9.1.0","stability":"experimental","visibility":"public"}},"type":"object","properties":{"master_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.","x-found-in":"query"}}}

package/src/es/json/streams.status.response.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"streams.status","type":"object","properties":{"logs":{"$ref":"./streams.status.json#/$defs/streams.status__StreamStatus"},"logs.otel":{"$ref":"./streams.status.json#/$defs/streams.status__StreamStatus"},"logs.ecs":{"$ref":"./streams.status.json#/$defs/streams.status__StreamStatus"}},"required":["logs","logs.otel","logs.ecs"]}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"streams.status","x-api":{"id":"streams.status","name":"status","namespace":"streams"},"type":"object","properties":{"logs":{"$ref":"./streams.status.json#/$defs/streams.status__StreamStatus"},"logs.otel":{"$ref":"./streams.status.json#/$defs/streams.status__StreamStatus"},"logs.ecs":{"$ref":"./streams.status.json#/$defs/streams.status__StreamStatus"}},"required":["logs","logs.otel","logs.ecs"]}

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

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"synonyms.delete_synonym","type":"object","properties":{"id":{"type":"string","description":"The synonyms set identifier to delete.","x-found-in":"path"}},"required":["id"],"description":"Delete a synonym set.\n\nYou can only delete a synonyms set that is not in use by any index analyzer.\n\nSynonyms sets can be used in synonym graph token filters and synonym token filters.\nThese synonym filters can be used as part of search analyzers.\n\nAnalyzers need to be loaded when an index is restored (such as when a node starts, or the index becomes open).\nEven if the analyzer is not used on any field mapping, it still needs to be loaded on the index recovery phase.\n\nIf any analyzers cannot be loaded, the index becomes unavailable and the cluster status becomes red or yellow as index shards are not available.\nTo prevent that, synonyms sets that are used in analyzers can't be deleted.\nA delete request in this case will return a 400 response code.\n\nTo remove a synonyms set, you must first remove all indices that contain analyzers using it.\nYou can migrate an index by creating a new index that does not contain the token filter with the synonyms set, and use the reindex API in order to copy over the index data.\nOnce finished, you can delete the index.\nWhen the synonyms set is not used in analyzers, you will be able to delete it."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"synonyms.delete_synonym","description":"Delete a synonym set.\n\nYou can only delete a synonyms set that is not in use by any index analyzer.\n\nSynonyms sets can be used in synonym graph token filters and synonym token filters.\nThese synonym filters can be used as part of search analyzers.\n\nAnalyzers need to be loaded when an index is restored (such as when a node starts, or the index becomes open).\nEven if the analyzer is not used on any field mapping, it still needs to be loaded on the index recovery phase.\n\nIf any analyzers cannot be loaded, the index becomes unavailable and the cluster status becomes red or yellow as index shards are not available.\nTo prevent that, synonyms sets that are used in analyzers can't be deleted.\nA delete request in this case will return a 400 response code.\n\nTo remove a synonyms set, you must first remove all indices that contain analyzers using it.\nYou can migrate an index by creating a new index that does not contain the token filter with the synonyms set, and use the reindex API in order to copy over the index data.\nOnce finished, you can delete the index.\nWhen the synonyms set is not used in analyzers, you will be able to delete it.","x-api":{"id":"synonyms.delete_synonym","name":"delete-synonym","namespace":"synonyms"},"x-method":"DELETE","x-path":"/_synonyms/{id}","x-urls":[{"path":"/_synonyms/{id}","methods":["DELETE"]}],"x-destructive":true,"x-availability":{"stack":{"since":"8.10.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"public"}},"type":"object","properties":{"id":{"type":"string","description":"The synonyms set identifier to delete.","x-found-in":"path"}},"required":["id"]}

package/src/es/json/synonyms.delete_synonym.response.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"synonyms.delete_synonym","$ref":"./_types.json#/$defs/_types__AcknowledgedResponseBase"}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"synonyms.delete_synonym","x-api":{"id":"synonyms.delete_synonym","name":"delete-synonym","namespace":"synonyms"},"$ref":"./_types.json#/$defs/_types__AcknowledgedResponseBase"}

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":{"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."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"synonyms.delete_synonym_rule","description":"Delete a synonym rule.\n\nDelete a synonym rule from a synonym set.","x-api":{"id":"synonyms.delete_synonym_rule","name":"delete-synonym-rule","namespace":"synonyms"},"x-method":"DELETE","x-path":"/_synonyms/{set_id}/{rule_id}","x-urls":[{"path":"/_synonyms/{set_id}/{rule_id}","methods":["DELETE"]}],"x-destructive":true,"x-availability":{"stack":{"since":"8.10.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"public"}},"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","x-availability":{"stack":{"since":"9.1.0"}}},"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"]}