@elastic/schemas 0.5.1 → 0.6.0

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","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"]}
+{"$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","x-codegen-name":"name"},"error_trace":{"type":"boolean","description":"When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"filter_path":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"human":{"type":"boolean","description":"When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"pretty":{"type":"boolean","description":"If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.","x-found-in":"query","x-behavior":"CommonQueryParameters"}},"required":["repository"]}

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

@@ -1 +1 @@
-{"$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"]}
+{"$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"},"error_trace":{"type":"boolean","description":"When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"filter_path":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"human":{"type":"boolean","description":"When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"pretty":{"type":"boolean","description":"If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.","x-found-in":"query","x-behavior":"CommonQueryParameters"}},"required":["repository","snapshot"]}

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

@@ -1 +1 @@
-{"$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"}}}
+{"$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"},"error_trace":{"type":"boolean","description":"When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"filter_path":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"human":{"type":"boolean","description":"When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"pretty":{"type":"boolean","description":"If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.","x-found-in":"query","x-behavior":"CommonQueryParameters"}}}

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

@@ -1 +1 @@
-{"$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"]}
+{"$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","x-codegen-name":"name"},"error_trace":{"type":"boolean","description":"When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"filter_path":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"human":{"type":"boolean","description":"When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"pretty":{"type":"boolean","description":"If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.","x-found-in":"query","x-behavior":"CommonQueryParameters"}},"required":["repository"]}

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

@@ -1 +1 @@
-{"$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"]}
+{"$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"},"error_trace":{"type":"boolean","description":"When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"filter_path":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"human":{"type":"boolean","description":"When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"pretty":{"type":"boolean","description":"If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.","x-found-in":"query","x-behavior":"CommonQueryParameters"}},"required":["cursor"]}

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

@@ -1 +1 @@
-{"$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"]}
+{"$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"},"error_trace":{"type":"boolean","description":"When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"filter_path":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"human":{"type":"boolean","description":"When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"pretty":{"type":"boolean","description":"If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.","x-found-in":"query","x-behavior":"CommonQueryParameters"}},"required":["id"]}

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

@@ -1 +1 @@
-{"$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"]}
+{"$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"},"error_trace":{"type":"boolean","description":"When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"filter_path":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"human":{"type":"boolean","description":"When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"pretty":{"type":"boolean","description":"If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.","x-found-in":"query","x-behavior":"CommonQueryParameters"}},"required":["id"]}

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","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"]}
+{"$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"},"error_trace":{"type":"boolean","description":"When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"filter_path":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"human":{"type":"boolean","description":"When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"pretty":{"type":"boolean","description":"If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.","x-found-in":"query","x-behavior":"CommonQueryParameters"}},"required":["id"]}

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

@@ -1 +1 @@
-{"$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"}}}
+{"$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"},"error_trace":{"type":"boolean","description":"When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"filter_path":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"human":{"type":"boolean","description":"When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"pretty":{"type":"boolean","description":"If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.","x-found-in":"query","x-behavior":"CommonQueryParameters"}}}

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

@@ -1 +1 @@
-{"$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"]}
+{"$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"},"error_trace":{"type":"boolean","description":"When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"filter_path":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"human":{"type":"boolean","description":"When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"pretty":{"type":"boolean","description":"If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.","x-found-in":"query","x-behavior":"CommonQueryParameters"}},"required":["query"]}

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

@@ -1 +1 @@
-{"$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":{}}
+{"$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":{"error_trace":{"type":"boolean","description":"When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"filter_path":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"human":{"type":"boolean","description":"When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"pretty":{"type":"boolean","description":"If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.","x-found-in":"query","x-behavior":"CommonQueryParameters"}}}

package/src/es/json/streams._types.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","$defs":{"streams._types__StreamType":{"enum":["logs","logs_otel","logs_ecs"]}}}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","$defs":{"streams._types__StreamType":{"enum":["logs","logs.otel","logs.ecs"],"x-codegen-names":{"logs.otel":"logs_otel","logs.ecs":"logs_ecs"}}}}

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

@@ -1 +1 @@
-{"$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"]}
+{"$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"}},"x-response-type":["json","text"],"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"},"error_trace":{"type":"boolean","description":"When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"filter_path":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"human":{"type":"boolean","description":"When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"pretty":{"type":"boolean","description":"If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.","x-found-in":"query","x-behavior":"CommonQueryParameters"}},"required":["name"]}

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

@@ -1 +1 @@
-{"$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"]}
+{"$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"}},"x-response-type":["json","text"],"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"},"error_trace":{"type":"boolean","description":"When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"filter_path":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"human":{"type":"boolean","description":"When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"pretty":{"type":"boolean","description":"If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.","x-found-in":"query","x-behavior":"CommonQueryParameters"}},"required":["name"]}

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

@@ -1 +1 @@
-{"$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"}}}
+{"$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"},"error_trace":{"type":"boolean","description":"When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"filter_path":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"human":{"type":"boolean","description":"When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"pretty":{"type":"boolean","description":"If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.","x-found-in":"query","x-behavior":"CommonQueryParameters"}}}

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

@@ -1 +1 @@
-{"$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"]}
+{"$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"},"error_trace":{"type":"boolean","description":"When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"filter_path":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"human":{"type":"boolean","description":"When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"pretty":{"type":"boolean","description":"If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.","x-found-in":"query","x-behavior":"CommonQueryParameters"}},"required":["id"]}

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","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"]}
+{"$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"},"error_trace":{"type":"boolean","description":"When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"filter_path":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"human":{"type":"boolean","description":"When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"pretty":{"type":"boolean","description":"If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.","x-found-in":"query","x-behavior":"CommonQueryParameters"}},"required":["set_id","rule_id"]}

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

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"synonyms.get_synonym","description":"Get a synonym set.","x-api":{"id":"synonyms.get_synonym","name":"get-synonym","namespace":"synonyms"},"x-method":"GET","x-path":"/_synonyms/{id}","x-urls":[{"path":"/_synonyms/{id}","methods":["GET"]}],"x-destructive":false,"x-availability":{"stack":{"since":"8.10.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"public"}},"type":"object","properties":{"from":{"type":"number","description":"The starting offset for synonym rules to retrieve.","x-found-in":"query"},"size":{"type":"number","description":"The max number of synonym rules to retrieve.","x-found-in":"query"},"search_after":{"type":"string","description":"The synonym rule ID to use as a cursor for pagination.\nThe next page of results will start after this rule ID.\nThis parameter cannot be used with `from`.","x-found-in":"query","x-availability":{"stack":{"since":"9.5.0"},"serverless":{}}},"id":{"type":"string","description":"The synonyms set identifier to retrieve.","x-found-in":"path"}},"required":["id"]}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"synonyms.get_synonym","description":"Get a synonym set.","x-api":{"id":"synonyms.get_synonym","name":"get-synonym","namespace":"synonyms"},"x-method":"GET","x-path":"/_synonyms/{id}","x-urls":[{"path":"/_synonyms/{id}","methods":["GET"]}],"x-destructive":false,"x-availability":{"stack":{"since":"8.10.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"public"}},"type":"object","properties":{"from":{"type":"number","description":"The starting offset for synonym rules to retrieve.","x-found-in":"query"},"size":{"type":"number","description":"The max number of synonym rules to retrieve.","x-found-in":"query"},"search_after":{"type":"string","description":"The synonym rule ID to use as a cursor for pagination.\nThe next page of results will start after this rule ID.\nThis parameter cannot be used with `from`.","x-found-in":"query","x-availability":{"stack":{"since":"9.5.0"},"serverless":{}}},"id":{"type":"string","description":"The synonyms set identifier to retrieve.","x-found-in":"path"},"error_trace":{"type":"boolean","description":"When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"filter_path":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"human":{"type":"boolean","description":"When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"pretty":{"type":"boolean","description":"If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.","x-found-in":"query","x-behavior":"CommonQueryParameters"}},"required":["id"]}

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

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"synonyms.get_synonym_rule","description":"Get a synonym rule.\n\nGet a synonym rule from a synonym set.","x-api":{"id":"synonyms.get_synonym_rule","name":"get-synonym-rule","namespace":"synonyms"},"x-method":"GET","x-path":"/_synonyms/{set_id}/{rule_id}","x-urls":[{"path":"/_synonyms/{set_id}/{rule_id}","methods":["GET"]}],"x-destructive":false,"x-availability":{"stack":{"since":"8.10.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"public"}},"type":"object","properties":{"set_id":{"type":"string","description":"The ID of the synonym set to retrieve the synonym rule from.","x-found-in":"path"},"rule_id":{"type":"string","description":"The ID of the synonym rule to retrieve.","x-found-in":"path"}},"required":["set_id","rule_id"]}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"synonyms.get_synonym_rule","description":"Get a synonym rule.\n\nGet a synonym rule from a synonym set.","x-api":{"id":"synonyms.get_synonym_rule","name":"get-synonym-rule","namespace":"synonyms"},"x-method":"GET","x-path":"/_synonyms/{set_id}/{rule_id}","x-urls":[{"path":"/_synonyms/{set_id}/{rule_id}","methods":["GET"]}],"x-destructive":false,"x-availability":{"stack":{"since":"8.10.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"public"}},"type":"object","properties":{"set_id":{"type":"string","description":"The ID of the synonym set to retrieve the synonym rule from.","x-found-in":"path"},"rule_id":{"type":"string","description":"The ID of the synonym rule to retrieve.","x-found-in":"path"},"error_trace":{"type":"boolean","description":"When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"filter_path":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"human":{"type":"boolean","description":"When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"pretty":{"type":"boolean","description":"If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.","x-found-in":"query","x-behavior":"CommonQueryParameters"}},"required":["set_id","rule_id"]}

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

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"synonyms.get_synonyms_sets","description":"Get all synonym sets.\n\nGet a summary of all defined synonym sets.","x-api":{"id":"synonyms.get_synonyms_sets","name":"get-synonyms-sets","namespace":"synonyms"},"x-method":"GET","x-path":"/_synonyms","x-urls":[{"path":"/_synonyms","methods":["GET"]}],"x-destructive":false,"x-availability":{"stack":{"since":"8.10.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"public"}},"type":"object","properties":{"from":{"type":"number","description":"The starting offset for synonyms sets to retrieve.","x-found-in":"query"},"size":{"type":"number","description":"The maximum number of synonyms sets to retrieve.","x-found-in":"query"}}}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"synonyms.get_synonyms_sets","description":"Get all synonym sets.\n\nGet a summary of all defined synonym sets.","x-api":{"id":"synonyms.get_synonyms_sets","name":"get-synonyms-sets","namespace":"synonyms"},"x-method":"GET","x-path":"/_synonyms","x-urls":[{"path":"/_synonyms","methods":["GET"]}],"x-destructive":false,"x-availability":{"stack":{"since":"8.10.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"public"}},"type":"object","properties":{"from":{"type":"number","description":"The starting offset for synonyms sets to retrieve.","x-found-in":"query"},"size":{"type":"number","description":"The maximum number of synonyms sets to retrieve.","x-found-in":"query"},"error_trace":{"type":"boolean","description":"When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"filter_path":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"human":{"type":"boolean","description":"When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"pretty":{"type":"boolean","description":"If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.","x-found-in":"query","x-behavior":"CommonQueryParameters"}}}

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

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"synonyms.put_synonym","description":"Create or update a synonym set.\n\nSynonym sets are limited to a maximum of 100,000 synonym rules per set by default.\nThis limit is configurable using the `synonyms.max_synonym_rules` cluster setting.\n\nWhen an existing synonyms set is updated, the search analyzers that use the synonyms set are reloaded automatically for all indices.\nThis is equivalent to invoking the reload search analyzers API for all indices that use the synonyms set.\n\nFor practical examples of how to create or update a synonyms set, refer to the External documentation.","x-api":{"id":"synonyms.put_synonym","name":"put-synonym","namespace":"synonyms"},"x-method":"PUT","x-path":"/_synonyms/{id}","x-urls":[{"path":"/_synonyms/{id}","methods":["PUT"]}],"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 new synonyms set and wait for the new synonyms to be available before returning.\nIf `false`, analyzers will not be reloaded with the new synonym set","x-found-in":"query","x-availability":{"stack":{"since":"9.1.0"}}},"append":{"type":"boolean","description":"If `true`, the provided synonym rules are appended to the existing set, with matching IDs overwriting existing rules.\nIf `false`, the entire synonyms set is replaced with the new synonym rules definitions.","x-found-in":"query","x-availability":{"stack":{"since":"9.5.0"},"serverless":{}}},"synonyms_set":{"anyOf":[{"$ref":"./synonyms._types.json#/$defs/synonyms._types__SynonymRule"},{"type":"array","items":{"$ref":"./synonyms._types.json#/$defs/synonyms._types__SynonymRule"}}],"description":"The synonym rules definitions for the synonyms set.","x-found-in":"body"},"id":{"type":"string","description":"The ID of the synonyms set to be created or updated.","x-found-in":"path"}},"required":["id","synonyms_set"]}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"synonyms.put_synonym","description":"Create or update a synonym set.\n\nSynonym sets are limited to a maximum of 100,000 synonym rules per set by default.\nThis limit is configurable using the `synonyms.max_synonym_rules` cluster setting.\n\nWhen an existing synonyms set is updated, the search analyzers that use the synonyms set are reloaded automatically for all indices.\nThis is equivalent to invoking the reload search analyzers API for all indices that use the synonyms set.\n\nFor practical examples of how to create or update a synonyms set, refer to the External documentation.","x-api":{"id":"synonyms.put_synonym","name":"put-synonym","namespace":"synonyms"},"x-method":"PUT","x-path":"/_synonyms/{id}","x-urls":[{"path":"/_synonyms/{id}","methods":["PUT"]}],"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 new synonyms set and wait for the new synonyms to be available before returning.\nIf `false`, analyzers will not be reloaded with the new synonym set","x-found-in":"query","x-availability":{"stack":{"since":"9.1.0"}}},"append":{"type":"boolean","description":"If `true`, the provided synonym rules are appended to the existing set, with matching IDs overwriting existing rules.\nIf `false`, the entire synonyms set is replaced with the new synonym rules definitions.","x-found-in":"query","x-availability":{"stack":{"since":"9.5.0"},"serverless":{}}},"synonyms_set":{"anyOf":[{"$ref":"./synonyms._types.json#/$defs/synonyms._types__SynonymRule"},{"type":"array","items":{"$ref":"./synonyms._types.json#/$defs/synonyms._types__SynonymRule"}}],"description":"The synonym rules definitions for the synonyms set.","x-found-in":"body"},"id":{"type":"string","description":"The ID of the synonyms set to be created or updated.","x-found-in":"path"},"error_trace":{"type":"boolean","description":"When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"filter_path":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"human":{"type":"boolean","description":"When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"pretty":{"type":"boolean","description":"If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.","x-found-in":"query","x-behavior":"CommonQueryParameters"}},"required":["id","synonyms_set"]}

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

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"synonyms.put_synonym_rule","description":"Create or update a synonym rule.\n\nCreate or update a synonym rule in a synonym set.\n\nIf any of the synonym rules included is invalid, the API returns an error.\n\nWhen you update a synonym rule, all analyzers using the synonyms set will be reloaded automatically to reflect the new rule.","x-api":{"id":"synonyms.put_synonym_rule","name":"put-synonym-rule","namespace":"synonyms"},"x-method":"PUT","x-path":"/_synonyms/{set_id}/{rule_id}","x-urls":[{"path":"/_synonyms/{set_id}/{rule_id}","methods":["PUT"]}],"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 new synonym rule and wait for the new synonyms to be available before returning.\nIf `false`, analyzers will not be reloaded with the new synonym rule","x-found-in":"query","x-availability":{"stack":{"since":"9.1.0"}}},"synonyms":{"type":"string","description":"The synonym rule information definition, which must be in Solr format.","x-found-in":"body"},"set_id":{"type":"string","description":"The ID of the synonym set.","x-found-in":"path"},"rule_id":{"type":"string","description":"The ID of the synonym rule to be updated or created.","x-found-in":"path"}},"required":["set_id","rule_id","synonyms"]}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"synonyms.put_synonym_rule","description":"Create or update a synonym rule.\n\nCreate or update a synonym rule in a synonym set.\n\nIf any of the synonym rules included is invalid, the API returns an error.\n\nWhen you update a synonym rule, all analyzers using the synonyms set will be reloaded automatically to reflect the new rule.","x-api":{"id":"synonyms.put_synonym_rule","name":"put-synonym-rule","namespace":"synonyms"},"x-method":"PUT","x-path":"/_synonyms/{set_id}/{rule_id}","x-urls":[{"path":"/_synonyms/{set_id}/{rule_id}","methods":["PUT"]}],"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 new synonym rule and wait for the new synonyms to be available before returning.\nIf `false`, analyzers will not be reloaded with the new synonym rule","x-found-in":"query","x-availability":{"stack":{"since":"9.1.0"}}},"synonyms":{"type":"string","description":"The synonym rule information definition, which must be in Solr format.","x-found-in":"body"},"set_id":{"type":"string","description":"The ID of the synonym set.","x-found-in":"path"},"rule_id":{"type":"string","description":"The ID of the synonym rule to be updated or created.","x-found-in":"path"},"error_trace":{"type":"boolean","description":"When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"filter_path":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"human":{"type":"boolean","description":"When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"pretty":{"type":"boolean","description":"If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.","x-found-in":"query","x-behavior":"CommonQueryParameters"}},"required":["set_id","rule_id","synonyms"]}

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

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"tasks.cancel","description":"Cancel a task.\n\nWARNING: The task management API is new and should still be considered a beta feature.\nThe API may change in ways that are not backwards compatible.\n\nA task may continue to run for some time after it has been cancelled because it may not be able to safely stop its current activity straight away.\nIt is also possible that Elasticsearch must complete its work on other tasks before it can process the cancellation.\nThe get task information API will continue to list these cancelled tasks until they complete.\nThe cancelled flag in the response indicates that the cancellation command has been processed and the task will stop as soon as possible.\n\nTo troubleshoot why a cancelled task does not complete promptly, use the get task information API with the `?detailed` parameter to identify the other tasks the system is running.\nYou can also use the node hot threads API to obtain detailed information about the work the system is doing instead of completing the cancelled task.\n\nFor relocatable tasks, this API transparently follows the task across graceful shutdown relocations,\nso callers can keep using the original task ID. The returned task reports its `original_task_id` and `original_start_time_in_millis`\nif it is continuing work from an earlier task.","x-api":{"id":"tasks.cancel","name":"cancel","namespace":"tasks"},"x-method":"POST","x-path":"/_tasks/{task_id}/_cancel","x-urls":[{"path":"/_tasks/_cancel","methods":["POST"]},{"path":"/_tasks/{task_id}/_cancel","methods":["POST"]}],"x-destructive":true,"x-availability":{"stack":{"since":"2.3.0","stability":"experimental"},"serverless":{"stability":"experimental","visibility":"private"}},"type":"object","properties":{"actions":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"A comma-separated list or wildcard expression of actions that is used to limit the request.","x-found-in":"query"},"nodes":{"type":"array","items":{"type":"string"},"description":"A comma-separated list of node IDs or names that is used to limit the request.","x-found-in":"query"},"parent_task_id":{"type":"string","description":"A parent task ID that is used to limit the tasks.","x-found-in":"query"},"wait_for_completion":{"type":"boolean","description":"If true, the request blocks until all found tasks are complete.","x-found-in":"query"},"task_id":{"type":"string","description":"The task identifier.","x-found-in":"path"}}}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"tasks.cancel","description":"Cancel a task.\n\nWARNING: The task management API is new and should still be considered a beta feature.\nThe API may change in ways that are not backwards compatible.\n\nA task may continue to run for some time after it has been cancelled because it may not be able to safely stop its current activity straight away.\nIt is also possible that Elasticsearch must complete its work on other tasks before it can process the cancellation.\nThe get task information API will continue to list these cancelled tasks until they complete.\nThe cancelled flag in the response indicates that the cancellation command has been processed and the task will stop as soon as possible.\n\nTo troubleshoot why a cancelled task does not complete promptly, use the get task information API with the `?detailed` parameter to identify the other tasks the system is running.\nYou can also use the node hot threads API to obtain detailed information about the work the system is doing instead of completing the cancelled task.\n\nFor relocatable tasks, this API transparently follows the task across graceful shutdown relocations,\nso callers can keep using the original task ID. The returned task reports its `original_task_id` and `original_start_time_in_millis`\nif it is continuing work from an earlier task.","x-api":{"id":"tasks.cancel","name":"cancel","namespace":"tasks"},"x-method":"POST","x-path":"/_tasks/{task_id}/_cancel","x-urls":[{"path":"/_tasks/_cancel","methods":["POST"]},{"path":"/_tasks/{task_id}/_cancel","methods":["POST"]}],"x-destructive":true,"x-availability":{"stack":{"since":"2.3.0","stability":"experimental"},"serverless":{"stability":"experimental","visibility":"private"}},"type":"object","properties":{"actions":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"A comma-separated list or wildcard expression of actions that is used to limit the request.","x-found-in":"query"},"nodes":{"type":"array","items":{"type":"string"},"description":"A comma-separated list of node IDs or names that is used to limit the request.","x-found-in":"query"},"parent_task_id":{"type":"string","description":"A parent task ID that is used to limit the tasks.","x-found-in":"query"},"wait_for_completion":{"type":"boolean","description":"If true, the request blocks until all found tasks are complete.","x-found-in":"query"},"task_id":{"type":"string","description":"The task identifier.","x-found-in":"path"},"error_trace":{"type":"boolean","description":"When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"filter_path":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"human":{"type":"boolean","description":"When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"pretty":{"type":"boolean","description":"If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.","x-found-in":"query","x-behavior":"CommonQueryParameters"}}}

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

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"tasks.get","description":"Get task information.\n\nGet information about a task currently running in the cluster.\n\nWARNING: The task management API is new and should still be considered a beta feature.\nThe API may change in ways that are not backwards compatible.\n\nIf the task identifier is not found, a 404 response code indicates that there are no resources that match the request.\n\nFor relocatable tasks, this API transparently follows the task across graceful shutdown relocations,\nso callers can keep using the original task ID. The returned task reports its `original_task_id` and `original_start_time_in_millis`\nif it is continuing work from an earlier task.","x-api":{"id":"tasks.get","name":"get","namespace":"tasks"},"x-method":"GET","x-path":"/_tasks/{task_id}","x-urls":[{"path":"/_tasks/{task_id}","methods":["GET"]}],"x-destructive":false,"x-availability":{"stack":{"since":"5.0.0","stability":"experimental"},"serverless":{"stability":"experimental","visibility":"public"}},"type":"object","properties":{"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.","x-found-in":"query"},"wait_for_completion":{"type":"boolean","description":"If `true`, the request blocks until the task has completed.","x-found-in":"query"},"task_id":{"type":"string","description":"The task identifier.","x-found-in":"path"}},"required":["task_id"]}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"tasks.get","description":"Get task information.\n\nGet information about a task currently running in the cluster.\n\nWARNING: The task management API is new and should still be considered a beta feature.\nThe API may change in ways that are not backwards compatible.\n\nIf the task identifier is not found, a 404 response code indicates that there are no resources that match the request.\n\nFor relocatable tasks, this API transparently follows the task across graceful shutdown relocations,\nso callers can keep using the original task ID. The returned task reports its `original_task_id` and `original_start_time_in_millis`\nif it is continuing work from an earlier task.","x-api":{"id":"tasks.get","name":"get","namespace":"tasks"},"x-method":"GET","x-path":"/_tasks/{task_id}","x-urls":[{"path":"/_tasks/{task_id}","methods":["GET"]}],"x-destructive":false,"x-availability":{"stack":{"since":"5.0.0","stability":"experimental"},"serverless":{"stability":"experimental","visibility":"public"}},"type":"object","properties":{"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.","x-found-in":"query"},"wait_for_completion":{"type":"boolean","description":"If `true`, the request blocks until the task has completed.","x-found-in":"query"},"task_id":{"type":"string","description":"The task identifier.","x-found-in":"path"},"error_trace":{"type":"boolean","description":"When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"filter_path":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"human":{"type":"boolean","description":"When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"pretty":{"type":"boolean","description":"If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.","x-found-in":"query","x-behavior":"CommonQueryParameters"}},"required":["task_id"]}

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

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"tasks.list","description":"Get all tasks.\n\nGet information about the tasks currently running on one or more nodes in the cluster.\n\nWARNING: The task management API is new and should still be considered a beta feature.\nThe API may change in ways that are not backwards compatible.\n\nFor relocatable tasks, this API transparently follows the task across graceful shutdown relocations,\nso callers can keep using the original task ID. The returned task reports its `original_task_id` and `original_start_time_in_millis`\nif it is continuing work from an earlier task.\n\n**Identifying running tasks**\n\nThe `X-Opaque-Id header`, when provided on the HTTP request header, is going to be returned as a header in the response as well as in the headers field for in the task information.\nThis enables you to track certain calls or associate certain tasks with the client that started them.\nFor example:\n\n```\ncurl -i -H \"X-Opaque-Id: 123456\" \"http://localhost:9200/_tasks?group_by=parents\"\n```\n\nThe API returns the following result:\n\n```\nHTTP/1.1 200 OK\nX-Opaque-Id: 123456\ncontent-type: application/json; charset=UTF-8\ncontent-length: 831\n\n{\n  \"tasks\" : {\n    \"u5lcZHqcQhu-rUoFaqDphA:45\" : {\n      \"node\" : \"u5lcZHqcQhu-rUoFaqDphA\",\n      \"id\" : 45,\n      \"type\" : \"transport\",\n      \"action\" : \"cluster:monitor/tasks/lists\",\n      \"start_time_in_millis\" : 1513823752749,\n      \"running_time_in_nanos\" : 293139,\n      \"cancellable\" : false,\n      \"headers\" : {\n        \"X-Opaque-Id\" : \"123456\"\n      },\n      \"children\" : [\n        {\n          \"node\" : \"u5lcZHqcQhu-rUoFaqDphA\",\n          \"id\" : 46,\n          \"type\" : \"direct\",\n          \"action\" : \"cluster:monitor/tasks/lists[n]\",\n          \"start_time_in_millis\" : 1513823752750,\n          \"running_time_in_nanos\" : 92133,\n          \"cancellable\" : false,\n          \"parent_task_id\" : \"u5lcZHqcQhu-rUoFaqDphA:45\",\n          \"headers\" : {\n            \"X-Opaque-Id\" : \"123456\"\n          }\n        }\n      ]\n    }\n  }\n }\n```\nIn this example, `X-Opaque-Id: 123456` is the ID as a part of the response header.\nThe `X-Opaque-Id` in the task `headers` is the ID for the task that was initiated by the REST request.\nThe `X-Opaque-Id` in the children `headers` is the child task of the task that was initiated by the REST request.","x-api":{"id":"tasks.list","name":"list","namespace":"tasks"},"x-method":"GET","x-path":"/_tasks","x-urls":[{"path":"/_tasks","methods":["GET"]}],"x-destructive":false,"x-availability":{"stack":{"since":"2.3.0","stability":"experimental"},"serverless":{"stability":"experimental","visibility":"private"}},"type":"object","properties":{"actions":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"A comma-separated list or wildcard expression of actions used to limit the request.\nFor example, you can use `cluser:*` to retrieve all cluster-related tasks.","x-found-in":"query"},"detailed":{"type":"boolean","description":"If `true`, the response includes detailed information about the running tasks.\nThis information is useful to distinguish tasks from each other but is more costly to run.","x-found-in":"query"},"group_by":{"$ref":"./tasks._types.json#/$defs/tasks._types__GroupBy","description":"A key that is used to group tasks in the response.\nThe task lists can be grouped either by nodes or by parent tasks.","x-found-in":"query"},"nodes":{"$ref":"./_types.json#/$defs/_types__NodeIds","description":"A comma-separated list of node IDs or names that is used to limit the returned information.","x-found-in":"query"},"parent_task_id":{"type":"string","description":"A parent task identifier that is used to limit returned information.\nTo return all tasks, omit this parameter or use a value of `-1`.\nIf the parent task is not found, the API does not return a 404 response code.","x-found-in":"query"},"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period to wait for each node to respond.\nIf a node does not respond before its timeout expires, the response does not include its information.\nHowever, timed out nodes are included in the `node_failures` property.","x-found-in":"query"},"wait_for_completion":{"type":"boolean","description":"If `true`, the request blocks until the operation is complete.","x-found-in":"query"}}}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"tasks.list","description":"Get all tasks.\n\nGet information about the tasks currently running on one or more nodes in the cluster.\n\nWARNING: The task management API is new and should still be considered a beta feature.\nThe API may change in ways that are not backwards compatible.\n\nFor relocatable tasks, this API transparently follows the task across graceful shutdown relocations,\nso callers can keep using the original task ID. The returned task reports its `original_task_id` and `original_start_time_in_millis`\nif it is continuing work from an earlier task.\n\n**Identifying running tasks**\n\nThe `X-Opaque-Id header`, when provided on the HTTP request header, is going to be returned as a header in the response as well as in the headers field for in the task information.\nThis enables you to track certain calls or associate certain tasks with the client that started them.\nFor example:\n\n```\ncurl -i -H \"X-Opaque-Id: 123456\" \"http://localhost:9200/_tasks?group_by=parents\"\n```\n\nThe API returns the following result:\n\n```\nHTTP/1.1 200 OK\nX-Opaque-Id: 123456\ncontent-type: application/json; charset=UTF-8\ncontent-length: 831\n\n{\n  \"tasks\" : {\n    \"u5lcZHqcQhu-rUoFaqDphA:45\" : {\n      \"node\" : \"u5lcZHqcQhu-rUoFaqDphA\",\n      \"id\" : 45,\n      \"type\" : \"transport\",\n      \"action\" : \"cluster:monitor/tasks/lists\",\n      \"start_time_in_millis\" : 1513823752749,\n      \"running_time_in_nanos\" : 293139,\n      \"cancellable\" : false,\n      \"headers\" : {\n        \"X-Opaque-Id\" : \"123456\"\n      },\n      \"children\" : [\n        {\n          \"node\" : \"u5lcZHqcQhu-rUoFaqDphA\",\n          \"id\" : 46,\n          \"type\" : \"direct\",\n          \"action\" : \"cluster:monitor/tasks/lists[n]\",\n          \"start_time_in_millis\" : 1513823752750,\n          \"running_time_in_nanos\" : 92133,\n          \"cancellable\" : false,\n          \"parent_task_id\" : \"u5lcZHqcQhu-rUoFaqDphA:45\",\n          \"headers\" : {\n            \"X-Opaque-Id\" : \"123456\"\n          }\n        }\n      ]\n    }\n  }\n }\n```\nIn this example, `X-Opaque-Id: 123456` is the ID as a part of the response header.\nThe `X-Opaque-Id` in the task `headers` is the ID for the task that was initiated by the REST request.\nThe `X-Opaque-Id` in the children `headers` is the child task of the task that was initiated by the REST request.","x-api":{"id":"tasks.list","name":"list","namespace":"tasks"},"x-method":"GET","x-path":"/_tasks","x-urls":[{"path":"/_tasks","methods":["GET"]}],"x-destructive":false,"x-availability":{"stack":{"since":"2.3.0","stability":"experimental"},"serverless":{"stability":"experimental","visibility":"private"}},"type":"object","properties":{"actions":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"A comma-separated list or wildcard expression of actions used to limit the request.\nFor example, you can use `cluser:*` to retrieve all cluster-related tasks.","x-found-in":"query"},"detailed":{"type":"boolean","description":"If `true`, the response includes detailed information about the running tasks.\nThis information is useful to distinguish tasks from each other but is more costly to run.","x-found-in":"query"},"group_by":{"$ref":"./tasks._types.json#/$defs/tasks._types__GroupBy","description":"A key that is used to group tasks in the response.\nThe task lists can be grouped either by nodes or by parent tasks.","x-found-in":"query"},"nodes":{"$ref":"./_types.json#/$defs/_types__NodeIds","description":"A comma-separated list of node IDs or names that is used to limit the returned information.","x-found-in":"query"},"parent_task_id":{"type":"string","description":"A parent task identifier that is used to limit returned information.\nTo return all tasks, omit this parameter or use a value of `-1`.\nIf the parent task is not found, the API does not return a 404 response code.","x-found-in":"query"},"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period to wait for each node to respond.\nIf a node does not respond before its timeout expires, the response does not include its information.\nHowever, timed out nodes are included in the `node_failures` property.","x-found-in":"query"},"wait_for_completion":{"type":"boolean","description":"If `true`, the request blocks until the operation is complete.","x-found-in":"query"},"error_trace":{"type":"boolean","description":"When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"filter_path":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"human":{"type":"boolean","description":"When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"pretty":{"type":"boolean","description":"If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.","x-found-in":"query","x-behavior":"CommonQueryParameters"}}}

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

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"terms_enum","description":"Get terms in an index.\n\nDiscover terms that match a partial string in an index.\nThis API is designed for low-latency look-ups used in auto-complete scenarios.\n\n> info\n> The terms enum API may return terms from deleted documents. Deleted documents are initially only marked as deleted. It is not until their segments are merged that documents are actually deleted. Until that happens, the terms enum API will return terms from these documents.","x-api":{"id":"terms_enum","name":"terms-enum","namespace":null},"x-method":"GET","x-path":"/{index}/_terms_enum","x-urls":[{"path":"/{index}/_terms_enum","methods":["GET","POST"]}],"x-destructive":false,"x-availability":{"stack":{"since":"7.14.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"public"}},"type":"object","properties":{"field":{"type":"string","description":"The string to match at the start of indexed terms. If not provided, all terms in the field are considered.","x-found-in":"body"},"size":{"type":"number","description":"The number of matching terms to return.","x-found-in":"body"},"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The maximum length of time to spend collecting results.\nIf the timeout is exceeded the `complete` flag set to `false` in the response and the results may be partial or empty.","x-found-in":"body"},"case_insensitive":{"type":"boolean","description":"When `true`, the provided search string is matched against index terms without case sensitivity.","x-found-in":"body"},"index_filter":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__QueryContainer","description":"Filter an index shard if the provided query rewrites to `match_none`.","x-found-in":"body"},"string":{"type":"string","description":"The string to match at the start of indexed terms.\nIf it is not provided, all terms in the field are considered.\n\n> info\n> The prefix string cannot be larger than the largest possible keyword value, which is Lucene's term byte-length limit of 32766.","x-found-in":"body"},"search_after":{"type":"string","description":"The string after which terms in the index should be returned.\nIt allows for a form of pagination if the last result from one request is passed as the `search_after` parameter for a subsequent request.","x-found-in":"body"},"index":{"$ref":"./_types.json#/$defs/_types__Indices","description":"A comma-separated list of data streams, indices, and index aliases to search.\nWildcard (`*`) expressions are supported.\nTo search all data streams or indices, omit this parameter or use `*`  or `_all`.","x-found-in":"path"}},"required":["index","field"]}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"terms_enum","description":"Get terms in an index.\n\nDiscover terms that match a partial string in an index.\nThis API is designed for low-latency look-ups used in auto-complete scenarios.\n\n> info\n> The terms enum API may return terms from deleted documents. Deleted documents are initially only marked as deleted. It is not until their segments are merged that documents are actually deleted. Until that happens, the terms enum API will return terms from these documents.","x-api":{"id":"terms_enum","name":"terms-enum","namespace":null},"x-method":"GET","x-path":"/{index}/_terms_enum","x-urls":[{"path":"/{index}/_terms_enum","methods":["GET","POST"]}],"x-destructive":false,"x-availability":{"stack":{"since":"7.14.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"public"}},"type":"object","properties":{"field":{"type":"string","description":"The string to match at the start of indexed terms. If not provided, all terms in the field are considered.","x-found-in":"body"},"size":{"type":"number","description":"The number of matching terms to return.","x-found-in":"body"},"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The maximum length of time to spend collecting results.\nIf the timeout is exceeded the `complete` flag set to `false` in the response and the results may be partial or empty.","x-found-in":"body"},"case_insensitive":{"type":"boolean","description":"When `true`, the provided search string is matched against index terms without case sensitivity.","x-found-in":"body"},"index_filter":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__QueryContainer","description":"Filter an index shard if the provided query rewrites to `match_none`.","x-found-in":"body"},"string":{"type":"string","description":"The string to match at the start of indexed terms.\nIf it is not provided, all terms in the field are considered.\n\n> info\n> The prefix string cannot be larger than the largest possible keyword value, which is Lucene's term byte-length limit of 32766.","x-found-in":"body"},"search_after":{"type":"string","description":"The string after which terms in the index should be returned.\nIt allows for a form of pagination if the last result from one request is passed as the `search_after` parameter for a subsequent request.","x-found-in":"body"},"index":{"$ref":"./_types.json#/$defs/_types__Indices","description":"A comma-separated list of data streams, indices, and index aliases to search.\nWildcard (`*`) expressions are supported.\nTo search all data streams or indices, omit this parameter or use `*`  or `_all`.","x-found-in":"path"},"error_trace":{"type":"boolean","description":"When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"filter_path":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"human":{"type":"boolean","description":"When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.","x-found-in":"query","x-behavior":"CommonQueryParameters"},"pretty":{"type":"boolean","description":"If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.","x-found-in":"query","x-behavior":"CommonQueryParameters"}},"required":["index","field"]}

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

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